Allow for nested properties in list form when using \override.
[lilypond.git] / tex / texinfo.tex
blob434a90f5ae7e52fc1fa97ed856270fdaaff7c58f
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{2008-11-07.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,
10 % 2007, 2008 Free 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 3 of the
15 % License, or (at 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 program. If not, see <http://www.gnu.org/licenses/>.
25 % As a special exception, when this file is read by TeX when processing
26 % a Texinfo source document, you may use the result without
27 % restriction. (This has been our intent since Texinfo was invented.)
29 % Please try the latest version of texinfo.tex before submitting bug
30 % reports; you can get the latest version from:
31 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
32 % ftp://tug.org/tex/texinfo.tex
33 % (and all CTAN mirrors, see http://www.ctan.org).
34 % The texinfo.tex in any given distribution could well be out
35 % of date, so if that's what you're using, please check.
37 % Send bug reports to bug-texinfo@gnu.org. Please include including a
38 % complete document in each bug report with which we can reproduce the
39 % problem. Patches are, of course, greatly appreciated.
41 % To process a Texinfo manual with TeX, it's most reliable to use the
42 % texi2dvi shell script that comes with the distribution. For a simple
43 % manual foo.texi, however, you can get away with this:
44 % tex foo.texi
45 % texindex foo.??
46 % tex foo.texi
47 % tex foo.texi
48 % dvips foo.dvi -o # or whatever; this makes foo.ps.
49 % The extra TeX runs get the cross-reference information correct.
50 % Sometimes one run after texindex suffices, and sometimes you need more
51 % than two; texi2dvi does it as many times as necessary.
53 % It is possible to adapt texinfo.tex for other languages, to some
54 % extent. You can get the existing language-specific files from the
55 % full Texinfo distribution.
57 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60 \message{Loading texinfo [version \texinfoversion]:}
62 % If in a .fmt file, print the version number
63 % and turn on active characters that we couldn't do earlier because
64 % they might have appeared in the input file name.
65 \everyjob{\message{[Texinfo version \texinfoversion]}%
66 \catcode`+=\active \catcode`\_=\active}
69 \chardef\other=12
71 % We never want plain's \outer definition of \+ in Texinfo.
72 % For @tex, we can use \tabalign.
73 \let\+ = \relax
75 % Save some plain tex macros whose names we will redefine.
76 \let\ptexb=\b
77 \let\ptexbullet=\bullet
78 \let\ptexc=\c
79 \let\ptexcomma=\,
80 \let\ptexdot=\.
81 \let\ptexdots=\dots
82 \let\ptexend=\end
83 \let\ptexequiv=\equiv
84 \let\ptexexclam=\!
85 \let\ptexfootnote=\footnote
86 \let\ptexgtr=>
87 \let\ptexhat=^
88 \let\ptexi=\i
89 \let\ptexindent=\indent
90 \let\ptexinsert=\insert
91 \let\ptexlbrace=\{
92 \let\ptexless=<
93 \let\ptexnewwrite\newwrite
94 \let\ptexnoindent=\noindent
95 \let\ptexplus=+
96 \let\ptexrbrace=\}
97 \let\ptexslash=\/
98 \let\ptexstar=\*
99 \let\ptext=\t
100 \let\ptextop=\top
102 % If this character appears in an error message or help string, it
103 % starts a new line in the output.
104 \newlinechar = `^^J
106 % Use TeX 3.0's \inputlineno to get the line number, for better error
107 % messages, but if we're using an old version of TeX, don't do anything.
109 \ifx\inputlineno\thisisundefined
110 \let\linenumber = \empty % Pre-3.0.
111 \else
112 \def\linenumber{l.\the\inputlineno:\space}
115 % Set up fixed words for English if not already set.
116 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
117 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
118 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
119 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
120 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
121 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
122 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
123 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
124 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
125 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
126 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
127 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
128 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
129 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
130 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
131 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
132 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
133 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
134 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
136 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
137 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
138 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
139 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
140 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
141 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
142 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
143 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
144 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
145 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
146 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
147 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
149 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
150 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
151 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
152 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
153 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
155 % Since the category of space is not known, we have to be careful.
156 \chardef\spacecat = 10
157 \def\spaceisspace{\catcode`\ =\spacecat}
159 % sometimes characters are active, so we need control sequences.
160 \chardef\colonChar = `\:
161 \chardef\commaChar = `\,
162 \chardef\dashChar = `\-
163 \chardef\dotChar = `\.
164 \chardef\exclamChar= `\!
165 \chardef\lquoteChar= `\`
166 \chardef\questChar = `\?
167 \chardef\rquoteChar= `\'
168 \chardef\semiChar = `\;
169 \chardef\underChar = `\_
171 % Ignore a token.
173 \def\gobble#1{}
175 % The following is used inside several \edef's.
176 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
178 % Hyphenation fixes.
179 \hyphenation{
180 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
181 ap-pen-dix bit-map bit-maps
182 data-base data-bases eshell fall-ing half-way long-est man-u-script
183 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
184 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
185 spell-ing spell-ings
186 stand-alone strong-est time-stamp time-stamps which-ever white-space
187 wide-spread wrap-around
190 % Margin to add to right of even pages, to left of odd pages.
191 \newdimen\bindingoffset
192 \newdimen\normaloffset
193 \newdimen\pagewidth \newdimen\pageheight
195 % For a final copy, take out the rectangles
196 % that mark overfull boxes (in case you have decided
197 % that the text looks ok even though it passes the margin).
199 \def\finalout{\overfullrule=0pt}
201 % @| inserts a changebar to the left of the current line. It should
202 % surround any changed text. This approach does *not* work if the
203 % change spans more than two lines of output. To handle that, we would
204 % have adopt a much more difficult approach (putting marks into the main
205 % vertical list for the beginning and end of each change).
207 \def\|{%
208 % \vadjust can only be used in horizontal mode.
209 \leavevmode
211 % Append this vertical mode material after the current line in the output.
212 \vadjust{%
213 % We want to insert a rule with the height and depth of the current
214 % leading; that is exactly what \strutbox is supposed to record.
215 \vskip-\baselineskip
217 % \vadjust-items are inserted at the left edge of the type. So
218 % the \llap here moves out into the left-hand margin.
219 \llap{%
221 % For a thicker or thinner bar, change the `1pt'.
222 \vrule height\baselineskip width1pt
224 % This is the space between the bar and the text.
225 \hskip 12pt
230 % Sometimes it is convenient to have everything in the transcript file
231 % and nothing on the terminal. We don't just call \tracingall here,
232 % since that produces some useless output on the terminal. We also make
233 % some effort to order the tracing commands to reduce output in the log
234 % file; cf. trace.sty in LaTeX.
236 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
237 \def\loggingall{%
238 \tracingstats2
239 \tracingpages1
240 \tracinglostchars2 % 2 gives us more in etex
241 \tracingparagraphs1
242 \tracingoutput1
243 \tracingmacros2
244 \tracingrestores1
245 \showboxbreadth\maxdimen \showboxdepth\maxdimen
246 \ifx\eTeXversion\undefined\else % etex gives us more logging
247 \tracingscantokens1
248 \tracingifs1
249 \tracinggroups1
250 \tracingnesting2
251 \tracingassigns1
253 \tracingcommands3 % 3 gives us more in etex
254 \errorcontextlines16
257 % add check for \lastpenalty to plain's definitions. If the last thing
258 % we did was a \nobreak, we don't want to insert more space.
260 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
261 \removelastskip\penalty-50\smallskip\fi\fi}
262 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
263 \removelastskip\penalty-100\medskip\fi\fi}
264 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
265 \removelastskip\penalty-200\bigskip\fi\fi}
267 % For @cropmarks command.
268 % Do @cropmarks to get crop marks.
270 \newif\ifcropmarks
271 \let\cropmarks = \cropmarkstrue
273 % Dimensions to add cropmarks at corners.
274 % Added by P. A. MacKay, 12 Nov. 1986
276 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
277 \newdimen\cornerlong \cornerlong=1pc
278 \newdimen\cornerthick \cornerthick=.3pt
279 \newdimen\topandbottommargin \topandbottommargin=.75in
281 % Output a mark which sets \thischapter, \thissection and \thiscolor.
282 % We dump everything together because we only have one kind of mark.
283 % This works because we only use \botmark / \topmark, not \firstmark.
285 % A mark contains a subexpression of the \ifcase ... \fi construct.
286 % \get*marks macros below extract the needed part using \ifcase.
288 % Another complication is to let the user choose whether \thischapter
289 % (\thissection) refers to the chapter (section) in effect at the top
290 % of a page, or that at the bottom of a page. The solution is
291 % described on page 260 of The TeXbook. It involves outputting two
292 % marks for the sectioning macros, one before the section break, and
293 % one after. I won't pretend I can describe this better than DEK...
294 \def\domark{%
295 \toks0=\expandafter{\lastchapterdefs}%
296 \toks2=\expandafter{\lastsectiondefs}%
297 \toks4=\expandafter{\prevchapterdefs}%
298 \toks6=\expandafter{\prevsectiondefs}%
299 \toks8=\expandafter{\lastcolordefs}%
300 \mark{%
301 \the\toks0 \the\toks2
302 \noexpand\or \the\toks4 \the\toks6
303 \noexpand\else \the\toks8
306 % \topmark doesn't work for the very first chapter (after the title
307 % page or the contents), so we use \firstmark there -- this gets us
308 % the mark with the chapter defs, unless the user sneaks in, e.g.,
309 % @setcolor (or @url, or @link, etc.) between @contents and the very
310 % first @chapter.
311 \def\gettopheadingmarks{%
312 \ifcase0\topmark\fi
313 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
315 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
316 \def\getcolormarks{\ifcase2\topmark\fi}
318 % Avoid "undefined control sequence" errors.
319 \def\lastchapterdefs{}
320 \def\lastsectiondefs{}
321 \def\prevchapterdefs{}
322 \def\prevsectiondefs{}
323 \def\lastcolordefs{}
325 % Main output routine.
326 \chardef\PAGE = 255
327 \output = {\onepageout{\pagecontents\PAGE}}
329 \newbox\headlinebox
330 \newbox\footlinebox
332 % \onepageout takes a vbox as an argument. Note that \pagecontents
333 % does insertions, but you have to call it yourself.
334 \def\onepageout#1{%
335 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
337 \ifodd\pageno \advance\hoffset by \bindingoffset
338 \else \advance\hoffset by -\bindingoffset\fi
340 % Do this outside of the \shipout so @code etc. will be expanded in
341 % the headline as they should be, not taken literally (outputting ''code).
342 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
343 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
344 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
345 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
348 % Have to do this stuff outside the \shipout because we want it to
349 % take effect in \write's, yet the group defined by the \vbox ends
350 % before the \shipout runs.
352 \indexdummies % don't expand commands in the output.
353 \normalturnoffactive % \ in index entries must not stay \, e.g., if
354 % the page break happens to be in the middle of an example.
355 % We don't want .vr (or whatever) entries like this:
356 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
357 % "\acronym" won't work when it's read back in;
358 % it needs to be
359 % {\code {{\tt \backslashcurfont }acronym}
360 \shipout\vbox{%
361 % Do this early so pdf references go to the beginning of the page.
362 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
364 \ifcropmarks \vbox to \outervsize\bgroup
365 \hsize = \outerhsize
366 \vskip-\topandbottommargin
367 \vtop to0pt{%
368 \line{\ewtop\hfil\ewtop}%
369 \nointerlineskip
370 \line{%
371 \vbox{\moveleft\cornerthick\nstop}%
372 \hfill
373 \vbox{\moveright\cornerthick\nstop}%
375 \vss}%
376 \vskip\topandbottommargin
377 \line\bgroup
378 \hfil % center the page within the outer (page) hsize.
379 \ifodd\pageno\hskip\bindingoffset\fi
380 \vbox\bgroup
383 \unvbox\headlinebox
384 \pagebody{#1}%
385 \ifdim\ht\footlinebox > 0pt
386 % Only leave this space if the footline is nonempty.
387 % (We lessened \vsize for it in \oddfootingyyy.)
388 % The \baselineskip=24pt in plain's \makefootline has no effect.
389 \vskip 24pt
390 \unvbox\footlinebox
393 \ifcropmarks
394 \egroup % end of \vbox\bgroup
395 \hfil\egroup % end of (centering) \line\bgroup
396 \vskip\topandbottommargin plus1fill minus1fill
397 \boxmaxdepth = \cornerthick
398 \vbox to0pt{\vss
399 \line{%
400 \vbox{\moveleft\cornerthick\nsbot}%
401 \hfill
402 \vbox{\moveright\cornerthick\nsbot}%
404 \nointerlineskip
405 \line{\ewbot\hfil\ewbot}%
407 \egroup % \vbox from first cropmarks clause
409 }% end of \shipout\vbox
410 }% end of group with \indexdummies
411 \advancepageno
412 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
415 \newinsert\margin \dimen\margin=\maxdimen
417 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
418 {\catcode`\@ =11
419 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
420 % marginal hacks, juha@viisa.uucp (Juha Takala)
421 \ifvoid\margin\else % marginal info is present
422 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
423 \dimen@=\dp#1\relax \unvbox#1\relax
424 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
425 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
428 % Here are the rules for the cropmarks. Note that they are
429 % offset so that the space between them is truly \outerhsize or \outervsize
430 % (P. A. MacKay, 12 November, 1986)
432 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
433 \def\nstop{\vbox
434 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
435 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
436 \def\nsbot{\vbox
437 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
439 % Parse an argument, then pass it to #1. The argument is the rest of
440 % the input line (except we remove a trailing comment). #1 should be a
441 % macro which expects an ordinary undelimited TeX argument.
443 \def\parsearg{\parseargusing{}}
444 \def\parseargusing#1#2{%
445 \def\argtorun{#2}%
446 \begingroup
447 \obeylines
448 \spaceisspace
450 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
453 {\obeylines %
454 \gdef\parseargline#1^^M{%
455 \endgroup % End of the group started in \parsearg.
456 \argremovecomment #1\comment\ArgTerm%
460 % First remove any @comment, then any @c comment.
461 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
462 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
464 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
466 % \argremovec might leave us with trailing space, e.g.,
467 % @end itemize @c foo
468 % This space token undergoes the same procedure and is eventually removed
469 % by \finishparsearg.
471 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
472 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
473 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
474 \def\temp{#3}%
475 \ifx\temp\empty
476 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
477 \let\temp\finishparsearg
478 \else
479 \let\temp\argcheckspaces
481 % Put the space token in:
482 \temp#1 #3\ArgTerm
485 % If a _delimited_ argument is enclosed in braces, they get stripped; so
486 % to get _exactly_ the rest of the line, we had to prevent such situation.
487 % We prepended an \empty token at the very beginning and we expand it now,
488 % just before passing the control to \argtorun.
489 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
490 % either the null string, or it ends with \^^M---thus there is no danger
491 % that a pair of braces would be stripped.
493 % But first, we have to remove the trailing space token.
495 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
497 % \parseargdef\foo{...}
498 % is roughly equivalent to
499 % \def\foo{\parsearg\Xfoo}
500 % \def\Xfoo#1{...}
502 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
503 % favourite TeX trick. --kasal, 16nov03
505 \def\parseargdef#1{%
506 \expandafter \doparseargdef \csname\string#1\endcsname #1%
508 \def\doparseargdef#1#2{%
509 \def#2{\parsearg#1}%
510 \def#1##1%
513 % Several utility definitions with active space:
515 \obeyspaces
516 \gdef\obeyedspace{ }
518 % Make each space character in the input produce a normal interword
519 % space in the output. Don't allow a line break at this space, as this
520 % is used only in environments like @example, where each line of input
521 % should produce a line of output anyway.
523 \gdef\sepspaces{\obeyspaces\let =\tie}
525 % If an index command is used in an @example environment, any spaces
526 % therein should become regular spaces in the raw index file, not the
527 % expansion of \tie (\leavevmode \penalty \@M \ ).
528 \gdef\unsepspaces{\let =\space}
532 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
534 % Define the framework for environments in texinfo.tex. It's used like this:
536 % \envdef\foo{...}
537 % \def\Efoo{...}
539 % It's the responsibility of \envdef to insert \begingroup before the
540 % actual body; @end closes the group after calling \Efoo. \envdef also
541 % defines \thisenv, so the current environment is known; @end checks
542 % whether the environment name matches. The \checkenv macro can also be
543 % used to check whether the current environment is the one expected.
545 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
546 % are not treated as environments; they don't open a group. (The
547 % implementation of @end takes care not to call \endgroup in this
548 % special case.)
551 % At run-time, environments start with this:
552 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
553 % initialize
554 \let\thisenv\empty
556 % ... but they get defined via ``\envdef\foo{...}'':
557 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
558 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
560 % Check whether we're in the right environment:
561 \def\checkenv#1{%
562 \def\temp{#1}%
563 \ifx\thisenv\temp
564 \else
565 \badenverr
569 % Environment mismatch, #1 expected:
570 \def\badenverr{%
571 \errhelp = \EMsimple
572 \errmessage{This command can appear only \inenvironment\temp,
573 not \inenvironment\thisenv}%
575 \def\inenvironment#1{%
576 \ifx#1\empty
577 out of any environment%
578 \else
579 in environment \expandafter\string#1%
583 % @end foo executes the definition of \Efoo.
584 % But first, it executes a specialized version of \checkenv
586 \parseargdef\end{%
587 \if 1\csname iscond.#1\endcsname
588 \else
589 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
590 \expandafter\checkenv\csname#1\endcsname
591 \csname E#1\endcsname
592 \endgroup
596 \newhelp\EMsimple{Press RETURN to continue.}
599 %% Simple single-character @ commands
601 % @@ prints an @
602 % Kludge this until the fonts are right (grr).
603 \def\@{{\tt\char64}}
605 % This is turned off because it was never documented
606 % and you can use @w{...} around a quote to suppress ligatures.
607 %% Define @` and @' to be the same as ` and '
608 %% but suppressing ligatures.
609 %\def\`{{`}}
610 %\def\'{{'}}
612 % Used to generate quoted braces.
613 \def\mylbrace {{\tt\char123}}
614 \def\myrbrace {{\tt\char125}}
615 \let\{=\mylbrace
616 \let\}=\myrbrace
617 \begingroup
618 % Definitions to produce \{ and \} commands for indices,
619 % and @{ and @} for the aux/toc files.
620 \catcode`\{ = \other \catcode`\} = \other
621 \catcode`\[ = 1 \catcode`\] = 2
622 \catcode`\! = 0 \catcode`\\ = \other
623 !gdef!lbracecmd[\{]%
624 !gdef!rbracecmd[\}]%
625 !gdef!lbraceatcmd[@{]%
626 !gdef!rbraceatcmd[@}]%
627 !endgroup
629 % @comma{} to avoid , parsing problems.
630 \let\comma = ,
632 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
633 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
634 \let\, = \c
635 \let\dotaccent = \.
636 \def\ringaccent#1{{\accent23 #1}}
637 \let\tieaccent = \t
638 \let\ubaraccent = \b
639 \let\udotaccent = \d
641 % Other special characters: @questiondown @exclamdown @ordf @ordm
642 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
643 \def\questiondown{?`}
644 \def\exclamdown{!`}
645 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
646 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
648 % Dotless i and dotless j, used for accents.
649 \def\imacro{i}
650 \def\jmacro{j}
651 \def\dotless#1{%
652 \def\temp{#1}%
653 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
654 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
655 \else \errmessage{@dotless can be used only with i or j}%
656 \fi\fi
659 % The \TeX{} logo, as in plain, but resetting the spacing so that a
660 % period following counts as ending a sentence. (Idea found in latex.)
662 \edef\TeX{\TeX \spacefactor=1000 }
664 % @LaTeX{} logo. Not quite the same results as the definition in
665 % latex.ltx, since we use a different font for the raised A; it's most
666 % convenient for us to use an explicitly smaller font, rather than using
667 % the \scriptstyle font (since we don't reset \scriptstyle and
668 % \scriptscriptstyle).
670 \def\LaTeX{%
671 L\kern-.36em
672 {\setbox0=\hbox{T}%
673 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
674 \kern-.15em
675 \TeX
678 % Be sure we're in horizontal mode when doing a tie, since we make space
679 % equivalent to this in @example-like environments. Otherwise, a space
680 % at the beginning of a line will start with \penalty -- and
681 % since \penalty is valid in vertical mode, we'd end up putting the
682 % penalty on the vertical list instead of in the new paragraph.
683 {\catcode`@ = 11
684 % Avoid using \@M directly, because that causes trouble
685 % if the definition is written into an index file.
686 \global\let\tiepenalty = \@M
687 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
690 % @: forces normal size whitespace following.
691 \def\:{\spacefactor=1000 }
693 % @* forces a line break.
694 \def\*{\hfil\break\hbox{}\ignorespaces}
696 % @/ allows a line break.
697 \let\/=\allowbreak
699 % @. is an end-of-sentence period.
700 \def\.{.\spacefactor=\endofsentencespacefactor\space}
702 % @! is an end-of-sentence bang.
703 \def\!{!\spacefactor=\endofsentencespacefactor\space}
705 % @? is an end-of-sentence query.
706 \def\?{?\spacefactor=\endofsentencespacefactor\space}
708 % @frenchspacing on|off says whether to put extra space after punctuation.
710 \def\onword{on}
711 \def\offword{off}
713 \parseargdef\frenchspacing{%
714 \def\temp{#1}%
715 \ifx\temp\onword \plainfrenchspacing
716 \else\ifx\temp\offword \plainnonfrenchspacing
717 \else
718 \errhelp = \EMsimple
719 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
720 \fi\fi
723 % @w prevents a word break. Without the \leavevmode, @w at the
724 % beginning of a paragraph, when TeX is still in vertical mode, would
725 % produce a whole line of output instead of starting the paragraph.
726 \def\w#1{\leavevmode\hbox{#1}}
728 % @group ... @end group forces ... to be all on one page, by enclosing
729 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
730 % to keep its height that of a normal line. According to the rules for
731 % \topskip (p.114 of the TeXbook), the glue inserted is
732 % max (\topskip - \ht (first item), 0). If that height is large,
733 % therefore, no glue is inserted, and the space between the headline and
734 % the text is small, which looks bad.
736 % Another complication is that the group might be very large. This can
737 % cause the glue on the previous page to be unduly stretched, because it
738 % does not have much material. In this case, it's better to add an
739 % explicit \vfill so that the extra space is at the bottom. The
740 % threshold for doing this is if the group is more than \vfilllimit
741 % percent of a page (\vfilllimit can be changed inside of @tex).
743 \newbox\groupbox
744 \def\vfilllimit{0.7}
746 \envdef\group{%
747 \ifnum\catcode`\^^M=\active \else
748 \errhelp = \groupinvalidhelp
749 \errmessage{@group invalid in context where filling is enabled}%
751 \startsavinginserts
753 \setbox\groupbox = \vtop\bgroup
754 % Do @comment since we are called inside an environment such as
755 % @example, where each end-of-line in the input causes an
756 % end-of-line in the output. We don't want the end-of-line after
757 % the `@group' to put extra space in the output. Since @group
758 % should appear on a line by itself (according to the Texinfo
759 % manual), we don't worry about eating any user text.
760 \comment
763 % The \vtop produces a box with normal height and large depth; thus, TeX puts
764 % \baselineskip glue before it, and (when the next line of text is done)
765 % \lineskip glue after it. Thus, space below is not quite equal to space
766 % above. But it's pretty close.
767 \def\Egroup{%
768 % To get correct interline space between the last line of the group
769 % and the first line afterwards, we have to propagate \prevdepth.
770 \endgraf % Not \par, as it may have been set to \lisppar.
771 \global\dimen1 = \prevdepth
772 \egroup % End the \vtop.
773 % \dimen0 is the vertical size of the group's box.
774 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
775 % \dimen2 is how much space is left on the page (more or less).
776 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
777 % if the group doesn't fit on the current page, and it's a big big
778 % group, force a page break.
779 \ifdim \dimen0 > \dimen2
780 \ifdim \pagetotal < \vfilllimit\pageheight
781 \page
784 \box\groupbox
785 \prevdepth = \dimen1
786 \checkinserts
789 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
790 % message, so this ends up printing `@group can only ...'.
792 \newhelp\groupinvalidhelp{%
793 group can only be used in environments such as @example,^^J%
794 where each line of input produces a line of output.}
796 % @need space-in-mils
797 % forces a page break if there is not space-in-mils remaining.
799 \newdimen\mil \mil=0.001in
801 % Old definition--didn't work.
802 %\parseargdef\need{\par %
803 %% This method tries to make TeX break the page naturally
804 %% if the depth of the box does not fit.
805 %{\baselineskip=0pt%
806 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
807 %\prevdepth=-1000pt
810 \parseargdef\need{%
811 % Ensure vertical mode, so we don't make a big box in the middle of a
812 % paragraph.
813 \par
815 % If the @need value is less than one line space, it's useless.
816 \dimen0 = #1\mil
817 \dimen2 = \ht\strutbox
818 \advance\dimen2 by \dp\strutbox
819 \ifdim\dimen0 > \dimen2
821 % Do a \strut just to make the height of this box be normal, so the
822 % normal leading is inserted relative to the preceding line.
823 % And a page break here is fine.
824 \vtop to #1\mil{\strut\vfil}%
826 % TeX does not even consider page breaks if a penalty added to the
827 % main vertical list is 10000 or more. But in order to see if the
828 % empty box we just added fits on the page, we must make it consider
829 % page breaks. On the other hand, we don't want to actually break the
830 % page after the empty box. So we use a penalty of 9999.
832 % There is an extremely small chance that TeX will actually break the
833 % page at this \penalty, if there are no other feasible breakpoints in
834 % sight. (If the user is using lots of big @group commands, which
835 % almost-but-not-quite fill up a page, TeX will have a hard time doing
836 % good page breaking, for example.) However, I could not construct an
837 % example where a page broke at this \penalty; if it happens in a real
838 % document, then we can reconsider our strategy.
839 \penalty9999
841 % Back up by the size of the box, whether we did a page break or not.
842 \kern -#1\mil
844 % Do not allow a page break right after this kern.
845 \nobreak
849 % @br forces paragraph break (and is undocumented).
851 \let\br = \par
853 % @page forces the start of a new page.
855 \def\page{\par\vfill\supereject}
857 % @exdent text....
858 % outputs text on separate line in roman font, starting at standard page margin
860 % This records the amount of indent in the innermost environment.
861 % That's how much \exdent should take out.
862 \newskip\exdentamount
864 % This defn is used inside fill environments such as @defun.
865 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
867 % This defn is used inside nofill environments such as @example.
868 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
869 \leftline{\hskip\leftskip{\rm#1}}}}
871 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
872 % paragraph. For more general purposes, use the \margin insertion
873 % class. WHICH is `l' or `r'.
875 \newskip\inmarginspacing \inmarginspacing=1cm
876 \def\strutdepth{\dp\strutbox}
878 \def\doinmargin#1#2{\strut\vadjust{%
879 \nobreak
880 \kern-\strutdepth
881 \vtop to \strutdepth{%
882 \baselineskip=\strutdepth
883 \vss
884 % if you have multiple lines of stuff to put here, you'll need to
885 % make the vbox yourself of the appropriate size.
886 \ifx#1l%
887 \llap{\ignorespaces #2\hskip\inmarginspacing}%
888 \else
889 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
891 \null
894 \def\inleftmargin{\doinmargin l}
895 \def\inrightmargin{\doinmargin r}
897 % @inmargin{TEXT [, RIGHT-TEXT]}
898 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
899 % else use TEXT for both).
901 \def\inmargin#1{\parseinmargin #1,,\finish}
902 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
903 \setbox0 = \hbox{\ignorespaces #2}%
904 \ifdim\wd0 > 0pt
905 \def\lefttext{#1}% have both texts
906 \def\righttext{#2}%
907 \else
908 \def\lefttext{#1}% have only one text
909 \def\righttext{#1}%
912 \ifodd\pageno
913 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
914 \else
915 \def\temp{\inleftmargin\lefttext}%
917 \temp
920 % @include FILE -- \input text of FILE.
922 \def\include{\parseargusing\filenamecatcodes\includezzz}
923 \def\includezzz#1{%
924 \pushthisfilestack
925 \def\thisfile{#1}%
927 \makevalueexpandable % we want to expand any @value in FILE.
928 \turnoffactive % and allow special characters in the expansion
929 \indexnofonts % Allow `@@' and other weird things in file names.
930 \edef\temp{\noexpand\input #1 }%
932 % This trickery is to read FILE outside of a group, in case it makes
933 % definitions, etc.
934 \expandafter
935 }\temp
936 \popthisfilestack
938 \def\filenamecatcodes{%
939 \catcode`\\=\other
940 \catcode`~=\other
941 \catcode`^=\other
942 \catcode`_=\other
943 \catcode`|=\other
944 \catcode`<=\other
945 \catcode`>=\other
946 \catcode`+=\other
947 \catcode`-=\other
950 \def\pushthisfilestack{%
951 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
953 \def\pushthisfilestackX{%
954 \expandafter\pushthisfilestackY\thisfile\StackTerm
956 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
957 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
960 \def\popthisfilestack{\errthisfilestackempty}
961 \def\errthisfilestackempty{\errmessage{Internal error:
962 the stack of filenames is empty.}}
964 \def\thisfile{}
966 % @center line
967 % outputs that line, centered.
969 \parseargdef\center{%
970 \ifhmode
971 \let\next\centerH
972 \else
973 \let\next\centerV
975 \next{\hfil \ignorespaces#1\unskip \hfil}%
977 \def\centerH#1{%
979 \hfil\break
980 \advance\hsize by -\leftskip
981 \advance\hsize by -\rightskip
982 \line{#1}%
983 \break
986 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
988 % @sp n outputs n lines of vertical space
990 \parseargdef\sp{\vskip #1\baselineskip}
992 % @comment ...line which is ignored...
993 % @c is the same as @comment
994 % @ignore ... @end ignore is another way to write a comment
996 \def\comment{\begingroup \catcode`\^^M=\other%
997 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
998 \commentxxx}
999 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
1001 \let\c=\comment
1003 % @paragraphindent NCHARS
1004 % We'll use ems for NCHARS, close enough.
1005 % NCHARS can also be the word `asis' or `none'.
1006 % We cannot feasibly implement @paragraphindent asis, though.
1008 \def\asisword{asis} % no translation, these are keywords
1009 \def\noneword{none}
1011 \parseargdef\paragraphindent{%
1012 \def\temp{#1}%
1013 \ifx\temp\asisword
1014 \else
1015 \ifx\temp\noneword
1016 \defaultparindent = 0pt
1017 \else
1018 \defaultparindent = #1em
1021 \parindent = \defaultparindent
1024 % @exampleindent NCHARS
1025 % We'll use ems for NCHARS like @paragraphindent.
1026 % It seems @exampleindent asis isn't necessary, but
1027 % I preserve it to make it similar to @paragraphindent.
1028 \parseargdef\exampleindent{%
1029 \def\temp{#1}%
1030 \ifx\temp\asisword
1031 \else
1032 \ifx\temp\noneword
1033 \lispnarrowing = 0pt
1034 \else
1035 \lispnarrowing = #1em
1040 % @firstparagraphindent WORD
1041 % If WORD is `none', then suppress indentation of the first paragraph
1042 % after a section heading. If WORD is `insert', then do indent at such
1043 % paragraphs.
1045 % The paragraph indentation is suppressed or not by calling
1046 % \suppressfirstparagraphindent, which the sectioning commands do.
1047 % We switch the definition of this back and forth according to WORD.
1048 % By default, we suppress indentation.
1050 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1051 \def\insertword{insert}
1053 \parseargdef\firstparagraphindent{%
1054 \def\temp{#1}%
1055 \ifx\temp\noneword
1056 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1057 \else\ifx\temp\insertword
1058 \let\suppressfirstparagraphindent = \relax
1059 \else
1060 \errhelp = \EMsimple
1061 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1062 \fi\fi
1065 % Here is how we actually suppress indentation. Redefine \everypar to
1066 % \kern backwards by \parindent, and then reset itself to empty.
1068 % We also make \indent itself not actually do anything until the next
1069 % paragraph.
1071 \gdef\dosuppressfirstparagraphindent{%
1072 \gdef\indent{%
1073 \restorefirstparagraphindent
1074 \indent
1076 \gdef\noindent{%
1077 \restorefirstparagraphindent
1078 \noindent
1080 \global\everypar = {%
1081 \kern -\parindent
1082 \restorefirstparagraphindent
1086 \gdef\restorefirstparagraphindent{%
1087 \global \let \indent = \ptexindent
1088 \global \let \noindent = \ptexnoindent
1089 \global \everypar = {}%
1093 % @asis just yields its argument. Used with @table, for example.
1095 \def\asis#1{#1}
1097 % @math outputs its argument in math mode.
1099 % One complication: _ usually means subscripts, but it could also mean
1100 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1101 % _ active, and distinguish by seeing if the current family is \slfam,
1102 % which is what @var uses.
1104 \catcode`\_ = \active
1105 \gdef\mathunderscore{%
1106 \catcode`\_=\active
1107 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1110 % Another complication: we want \\ (and @\) to output a \ character.
1111 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1112 % this is not advertised and we don't care. Texinfo does not
1113 % otherwise define @\.
1115 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1116 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1118 \def\math{%
1119 \tex
1120 \mathunderscore
1121 \let\\ = \mathbackslash
1122 \mathactive
1123 % make the texinfo accent commands work in math mode
1124 \let\"=\ddot
1125 \let\'=\acute
1126 \let\==\bar
1127 \let\^=\hat
1128 \let\`=\grave
1129 \let\u=\breve
1130 \let\v=\check
1131 \let\~=\tilde
1132 \let\dotaccent=\dot
1133 $\finishmath
1135 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1137 % Some active characters (such as <) are spaced differently in math.
1138 % We have to reset their definitions in case the @math was an argument
1139 % to a command which sets the catcodes (such as @item or @section).
1142 \catcode`^ = \active
1143 \catcode`< = \active
1144 \catcode`> = \active
1145 \catcode`+ = \active
1146 \gdef\mathactive{%
1147 \let^ = \ptexhat
1148 \let< = \ptexless
1149 \let> = \ptexgtr
1150 \let+ = \ptexplus
1154 % Some math mode symbols.
1155 \def\bullet{$\ptexbullet$}
1156 \def\geq{\ifmmode \ge\else $\ge$\fi}
1157 \def\leq{\ifmmode \le\else $\le$\fi}
1158 \def\minus{\ifmmode -\else $-$\fi}
1160 % @dots{} outputs an ellipsis using the current font.
1161 % We do .5em per period so that it has the same spacing in the cm
1162 % typewriter fonts as three actual period characters; on the other hand,
1163 % in other typewriter fonts three periods are wider than 1.5em. So do
1164 % whichever is larger.
1166 \def\dots{%
1167 \leavevmode
1168 \setbox0=\hbox{...}% get width of three periods
1169 \ifdim\wd0 > 1.5em
1170 \dimen0 = \wd0
1171 \else
1172 \dimen0 = 1.5em
1174 \hbox to \dimen0{%
1175 \hskip 0pt plus.25fil
1176 .\hskip 0pt plus1fil
1177 .\hskip 0pt plus1fil
1178 .\hskip 0pt plus.5fil
1182 % @enddots{} is an end-of-sentence ellipsis.
1184 \def\enddots{%
1185 \dots
1186 \spacefactor=\endofsentencespacefactor
1189 % @comma{} is so commas can be inserted into text without messing up
1190 % Texinfo's parsing.
1192 \let\comma = ,
1194 % @refill is a no-op.
1195 \let\refill=\relax
1197 % If working on a large document in chapters, it is convenient to
1198 % be able to disable indexing, cross-referencing, and contents, for test runs.
1199 % This is done with @novalidate (before @setfilename).
1201 \newif\iflinks \linkstrue % by default we want the aux files.
1202 \let\novalidate = \linksfalse
1204 % @setfilename is done at the beginning of every texinfo file.
1205 % So open here the files we need to have open while reading the input.
1206 % This makes it possible to make a .fmt file for texinfo.
1207 \def\setfilename{%
1208 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1209 \iflinks
1210 \tryauxfile
1211 % Open the new aux file. TeX will close it automatically at exit.
1212 \immediate\openout\auxfile=\jobname.aux
1213 \fi % \openindices needs to do some work in any case.
1214 \openindices
1215 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1217 % If texinfo.cnf is present on the system, read it.
1218 % Useful for site-wide @afourpaper, etc.
1219 \openin 1 texinfo.cnf
1220 \ifeof 1 \else \input texinfo.cnf \fi
1221 \closein 1
1223 \comment % Ignore the actual filename.
1226 % Called from \setfilename.
1228 \def\openindices{%
1229 \newindex{cp}%
1230 \newcodeindex{fn}%
1231 \newcodeindex{vr}%
1232 \newcodeindex{tp}%
1233 \newcodeindex{ky}%
1234 \newcodeindex{pg}%
1237 % @bye.
1238 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1241 \message{pdf,}
1242 % adobe `portable' document format
1243 \newcount\tempnum
1244 \newcount\lnkcount
1245 \newtoks\filename
1246 \newcount\filenamelength
1247 \newcount\pgn
1248 \newtoks\toksA
1249 \newtoks\toksB
1250 \newtoks\toksC
1251 \newtoks\toksD
1252 \newbox\boxA
1253 \newcount\countA
1254 \newif\ifpdf
1255 \newif\ifpdfmakepagedest
1257 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1258 % can be set). So we test for \relax and 0 as well as \undefined,
1259 % borrowed from ifpdf.sty.
1260 \ifx\pdfoutput\undefined
1261 \else
1262 \ifx\pdfoutput\relax
1263 \else
1264 \ifcase\pdfoutput
1265 \else
1266 \pdftrue
1271 % PDF uses PostScript string constants for the names of xref targets,
1272 % for display in the outlines, and in other places. Thus, we have to
1273 % double any backslashes. Otherwise, a name like "\node" will be
1274 % interpreted as a newline (\n), followed by o, d, e. Not good.
1275 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1276 % (and related messages, the final outcome is that it is up to the TeX
1277 % user to double the backslashes and otherwise make the string valid, so
1278 % that's what we do).
1280 % double active backslashes.
1282 {\catcode`\@=0 \catcode`\\=\active
1283 @gdef@activebackslashdouble{%
1284 @catcode`@\=@active
1285 @let\=@doublebackslash}
1288 % To handle parens, we must adopt a different approach, since parens are
1289 % not active characters. hyperref.dtx (which has the same problem as
1290 % us) handles it with this amazing macro to replace tokens, with minor
1291 % changes for Texinfo. It is included here under the GPL by permission
1292 % from the author, Heiko Oberdiek.
1294 % #1 is the tokens to replace.
1295 % #2 is the replacement.
1296 % #3 is the control sequence with the string.
1298 \def\HyPsdSubst#1#2#3{%
1299 \def\HyPsdReplace##1#1##2\END{%
1300 ##1%
1301 \ifx\\##2\\%
1302 \else
1304 \HyReturnAfterFi{%
1305 \HyPsdReplace##2\END
1309 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1311 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1313 % #1 is a control sequence in which to do the replacements.
1314 \def\backslashparens#1{%
1315 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1316 % \lastnode when called from \setref -> \pdfmkdest.
1317 \HyPsdSubst{(}{\realbackslash(}{#1}%
1318 \HyPsdSubst{)}{\realbackslash)}{#1}%
1321 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1322 with PDF output, and none of those formats could be found. (.eps cannot
1323 be supported due to the design of the PDF format; use regular TeX (DVI
1324 output) for that.)}
1326 \ifpdf
1328 % Color manipulation macros based on pdfcolor.tex.
1329 \def\cmykDarkRed{0.28 1 1 0.35}
1330 \def\cmykBlack{0 0 0 1}
1332 \def\pdfsetcolor#1{\pdfliteral{#1 k}}
1333 % Set color, and create a mark which defines \thiscolor accordingly,
1334 % so that \makeheadline knows which color to restore.
1335 \def\setcolor#1{%
1336 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1337 \domark
1338 \pdfsetcolor{#1}%
1341 \def\maincolor{\cmykBlack}
1342 \pdfsetcolor{\maincolor}
1343 \edef\thiscolor{\maincolor}
1344 \def\lastcolordefs{}
1346 \def\makefootline{%
1347 \baselineskip24pt
1348 \line{\pdfsetcolor{\maincolor}\the\footline}%
1351 \def\makeheadline{%
1352 \vbox to 0pt{%
1353 \vskip-22.5pt
1354 \line{%
1355 \vbox to8.5pt{}%
1356 % Extract \thiscolor definition from the marks.
1357 \getcolormarks
1358 % Typeset the headline with \maincolor, then restore the color.
1359 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1361 \vss
1363 \nointerlineskip
1367 \pdfcatalog{/PageMode /UseOutlines}
1369 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1370 \def\dopdfimage#1#2#3{%
1371 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1372 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1374 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1375 % others). Let's try in that order.
1376 \let\pdfimgext=\empty
1377 \begingroup
1378 \openin 1 #1.png \ifeof 1
1379 \openin 1 #1.jpg \ifeof 1
1380 \openin 1 #1.jpeg \ifeof 1
1381 \openin 1 #1.JPG \ifeof 1
1382 \openin 1 #1.pdf \ifeof 1
1383 \openin 1 #1.PDF \ifeof 1
1384 \errhelp = \nopdfimagehelp
1385 \errmessage{Could not find image file #1 for pdf}%
1386 \else \gdef\pdfimgext{PDF}%
1388 \else \gdef\pdfimgext{pdf}%
1390 \else \gdef\pdfimgext{JPG}%
1392 \else \gdef\pdfimgext{jpeg}%
1394 \else \gdef\pdfimgext{jpg}%
1396 \else \gdef\pdfimgext{png}%
1398 \closein 1
1399 \endgroup
1401 % without \immediate, ancient pdftex seg faults when the same image is
1402 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1403 \ifnum\pdftexversion < 14
1404 \immediate\pdfimage
1405 \else
1406 \immediate\pdfximage
1408 \ifdim \wd0 >0pt width \imagewidth \fi
1409 \ifdim \wd2 >0pt height \imageheight \fi
1410 \ifnum\pdftexversion<13
1411 #1.\pdfimgext
1412 \else
1413 {#1.\pdfimgext}%
1415 \ifnum\pdftexversion < 14 \else
1416 \pdfrefximage \pdflastximage
1417 \fi}
1419 \def\pdfmkdest#1{{%
1420 % We have to set dummies so commands such as @code, and characters
1421 % such as \, aren't expanded when present in a section title.
1422 \indexnofonts
1423 \turnoffactive
1424 \activebackslashdouble
1425 \makevalueexpandable
1426 \def\pdfdestname{#1}%
1427 \backslashparens\pdfdestname
1428 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1431 % used to mark target names; must be expandable.
1432 \def\pdfmkpgn#1{#1}
1434 % by default, use a color that is dark enough to print on paper as
1435 % nearly black, but still distinguishable for online viewing.
1436 \def\urlcolor{\cmykDarkRed}
1437 \def\linkcolor{\cmykDarkRed}
1438 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1440 % Adding outlines to PDF; macros for calculating structure of outlines
1441 % come from Petr Olsak
1442 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1443 \else \csname#1\endcsname \fi}
1444 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1445 \advance\tempnum by 1
1446 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1448 % #1 is the section text, which is what will be displayed in the
1449 % outline by the pdf viewer. #2 is the pdf expression for the number
1450 % of subentries (or empty, for subsubsections). #3 is the node text,
1451 % which might be empty if this toc entry had no corresponding node.
1452 % #4 is the page number
1454 \def\dopdfoutline#1#2#3#4{%
1455 % Generate a link to the node text if that exists; else, use the
1456 % page number. We could generate a destination for the section
1457 % text in the case where a section has no node, but it doesn't
1458 % seem worth the trouble, since most documents are normally structured.
1459 \def\pdfoutlinedest{#3}%
1460 \ifx\pdfoutlinedest\empty
1461 \def\pdfoutlinedest{#4}%
1462 \else
1463 % Doubled backslashes in the name.
1464 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1465 \backslashparens\pdfoutlinedest}%
1468 % Also double the backslashes in the display string.
1469 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1470 \backslashparens\pdfoutlinetext}%
1472 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1475 \def\pdfmakeoutlines{%
1476 \begingroup
1477 % Thanh's hack / proper braces in bookmarks
1478 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1479 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1481 % Read toc silently, to get counts of subentries for \pdfoutline.
1482 \def\numchapentry##1##2##3##4{%
1483 \def\thischapnum{##2}%
1484 \def\thissecnum{0}%
1485 \def\thissubsecnum{0}%
1487 \def\numsecentry##1##2##3##4{%
1488 \advancenumber{chap\thischapnum}%
1489 \def\thissecnum{##2}%
1490 \def\thissubsecnum{0}%
1492 \def\numsubsecentry##1##2##3##4{%
1493 \advancenumber{sec\thissecnum}%
1494 \def\thissubsecnum{##2}%
1496 \def\numsubsubsecentry##1##2##3##4{%
1497 \advancenumber{subsec\thissubsecnum}%
1499 \def\thischapnum{0}%
1500 \def\thissecnum{0}%
1501 \def\thissubsecnum{0}%
1503 % use \def rather than \let here because we redefine \chapentry et
1504 % al. a second time, below.
1505 \def\appentry{\numchapentry}%
1506 \def\appsecentry{\numsecentry}%
1507 \def\appsubsecentry{\numsubsecentry}%
1508 \def\appsubsubsecentry{\numsubsubsecentry}%
1509 \def\unnchapentry{\numchapentry}%
1510 \def\unnsecentry{\numsecentry}%
1511 \def\unnsubsecentry{\numsubsecentry}%
1512 \def\unnsubsubsecentry{\numsubsubsecentry}%
1513 \readdatafile{toc}%
1515 % Read toc second time, this time actually producing the outlines.
1516 % The `-' means take the \expnumber as the absolute number of
1517 % subentries, which we calculated on our first read of the .toc above.
1519 % We use the node names as the destinations.
1520 \def\numchapentry##1##2##3##4{%
1521 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1522 \def\numsecentry##1##2##3##4{%
1523 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1524 \def\numsubsecentry##1##2##3##4{%
1525 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1526 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1527 \dopdfoutline{##1}{}{##3}{##4}}%
1529 % PDF outlines are displayed using system fonts, instead of
1530 % document fonts. Therefore we cannot use special characters,
1531 % since the encoding is unknown. For example, the eogonek from
1532 % Latin 2 (0xea) gets translated to a | character. Info from
1533 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1535 % xx to do this right, we have to translate 8-bit characters to
1536 % their "best" equivalent, based on the @documentencoding. Right
1537 % now, I guess we'll just let the pdf reader have its way.
1538 \indexnofonts
1539 \setupdatafile
1540 \catcode`\\=\active \otherbackslash
1541 \input \tocreadfilename
1542 \endgroup
1545 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1546 \ifx\PP\D\let\nextsp\relax
1547 \else\let\nextsp\skipspaces
1548 \ifx\p\space\else\addtokens{\filename}{\PP}%
1549 \advance\filenamelength by 1
1552 \nextsp}
1553 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1554 \ifnum\pdftexversion < 14
1555 \let \startlink \pdfannotlink
1556 \else
1557 \let \startlink \pdfstartlink
1559 % make a live url in pdf output.
1560 \def\pdfurl#1{%
1561 \begingroup
1562 % it seems we really need yet another set of dummies; have not
1563 % tried to figure out what each command should do in the context
1564 % of @url. for now, just make @/ a no-op, that's the only one
1565 % people have actually reported a problem with.
1567 \normalturnoffactive
1568 \def\@{@}%
1569 \let\/=\empty
1570 \makevalueexpandable
1571 \leavevmode\setcolor{\urlcolor}%
1572 \startlink attr{/Border [0 0 0]}%
1573 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1574 \endgroup}
1575 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1576 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1577 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1578 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1579 \def\maketoks{%
1580 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1581 \ifx\first0\adn0
1582 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1583 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1584 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1585 \else
1586 \ifnum0=\countA\else\makelink\fi
1587 \ifx\first.\let\next=\done\else
1588 \let\next=\maketoks
1589 \addtokens{\toksB}{\the\toksD}
1590 \ifx\first,\addtokens{\toksB}{\space}\fi
1592 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1593 \next}
1594 \def\makelink{\addtokens{\toksB}%
1595 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1596 \def\pdflink#1{%
1597 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1598 \setcolor{\linkcolor}#1\endlink}
1599 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1600 \else
1601 \let\pdfmkdest = \gobble
1602 \let\pdfurl = \gobble
1603 \let\endlink = \relax
1604 \let\setcolor = \gobble
1605 \let\pdfsetcolor = \gobble
1606 \let\pdfmakeoutlines = \relax
1607 \fi % \ifx\pdfoutput
1610 \message{fonts,}
1612 % Change the current font style to #1, remembering it in \curfontstyle.
1613 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1614 % italics, not bold italics.
1616 \def\setfontstyle#1{%
1617 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1618 \csname ten#1\endcsname % change the current font
1621 % Select #1 fonts with the current style.
1623 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1625 \def\rm{\fam=0 \setfontstyle{rm}}
1626 \def\it{\fam=\itfam \setfontstyle{it}}
1627 \def\sl{\fam=\slfam \setfontstyle{sl}}
1628 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1629 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1631 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1632 % So we set up a \sf.
1633 \newfam\sffam
1634 \def\sf{\fam=\sffam \setfontstyle{sf}}
1635 \let\li = \sf % Sometimes we call it \li, not \sf.
1637 % We don't need math for this font style.
1638 \def\ttsl{\setfontstyle{ttsl}}
1641 % Default leading.
1642 \newdimen\textleading \textleading = 13.2pt
1644 % Set the baselineskip to #1, and the lineskip and strut size
1645 % correspondingly. There is no deep meaning behind these magic numbers
1646 % used as factors; they just match (closely enough) what Knuth defined.
1648 \def\lineskipfactor{.08333}
1649 \def\strutheightpercent{.70833}
1650 \def\strutdepthpercent {.29167}
1652 % can get a sort of poor man's double spacing by redefining this.
1653 \def\baselinefactor{1}
1655 \def\setleading#1{%
1656 \dimen0 = #1\relax
1657 \normalbaselineskip = \baselinefactor\dimen0
1658 \normallineskip = \lineskipfactor\normalbaselineskip
1659 \normalbaselines
1660 \setbox\strutbox =\hbox{%
1661 \vrule width0pt height\strutheightpercent\baselineskip
1662 depth \strutdepthpercent \baselineskip
1666 % PDF CMaps. See also LaTeX's t1.cmap.
1668 % do nothing with this by default.
1669 \expandafter\let\csname cmapOT1\endcsname\gobble
1670 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1671 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1673 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1674 % (\pdffontattr was introduced many years ago, but people still run
1675 % older pdftex's; it's easy to conditionalize, so we do.)
1676 \ifpdf \ifx\pdffontattr\undefined \else
1677 \begingroup
1678 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1679 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1680 %%DocumentNeededResources: ProcSet (CIDInit)
1681 %%IncludeResource: ProcSet (CIDInit)
1682 %%BeginResource: CMap (TeX-OT1-0)
1683 %%Title: (TeX-OT1-0 TeX OT1 0)
1684 %%Version: 1.000
1685 %%EndComments
1686 /CIDInit /ProcSet findresource begin
1687 12 dict begin
1688 begincmap
1689 /CIDSystemInfo
1690 << /Registry (TeX)
1691 /Ordering (OT1)
1692 /Supplement 0
1693 >> def
1694 /CMapName /TeX-OT1-0 def
1695 /CMapType 2 def
1696 1 begincodespacerange
1697 <00> <7F>
1698 endcodespacerange
1699 8 beginbfrange
1700 <00> <01> <0393>
1701 <09> <0A> <03A8>
1702 <23> <26> <0023>
1703 <28> <3B> <0028>
1704 <3F> <5B> <003F>
1705 <5D> <5E> <005D>
1706 <61> <7A> <0061>
1707 <7B> <7C> <2013>
1708 endbfrange
1709 40 beginbfchar
1710 <02> <0398>
1711 <03> <039B>
1712 <04> <039E>
1713 <05> <03A0>
1714 <06> <03A3>
1715 <07> <03D2>
1716 <08> <03A6>
1717 <0B> <00660066>
1718 <0C> <00660069>
1719 <0D> <0066006C>
1720 <0E> <006600660069>
1721 <0F> <00660066006C>
1722 <10> <0131>
1723 <11> <0237>
1724 <12> <0060>
1725 <13> <00B4>
1726 <14> <02C7>
1727 <15> <02D8>
1728 <16> <00AF>
1729 <17> <02DA>
1730 <18> <00B8>
1731 <19> <00DF>
1732 <1A> <00E6>
1733 <1B> <0153>
1734 <1C> <00F8>
1735 <1D> <00C6>
1736 <1E> <0152>
1737 <1F> <00D8>
1738 <21> <0021>
1739 <22> <201D>
1740 <27> <2019>
1741 <3C> <00A1>
1742 <3D> <003D>
1743 <3E> <00BF>
1744 <5C> <201C>
1745 <5F> <02D9>
1746 <60> <2018>
1747 <7D> <02DD>
1748 <7E> <007E>
1749 <7F> <00A8>
1750 endbfchar
1751 endcmap
1752 CMapName currentdict /CMap defineresource pop
1755 %%EndResource
1756 %%EOF
1757 }\endgroup
1758 \expandafter\edef\csname cmapOT1\endcsname#1{%
1759 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1762 % \cmapOT1IT
1763 \begingroup
1764 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1765 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1766 %%DocumentNeededResources: ProcSet (CIDInit)
1767 %%IncludeResource: ProcSet (CIDInit)
1768 %%BeginResource: CMap (TeX-OT1IT-0)
1769 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1770 %%Version: 1.000
1771 %%EndComments
1772 /CIDInit /ProcSet findresource begin
1773 12 dict begin
1774 begincmap
1775 /CIDSystemInfo
1776 << /Registry (TeX)
1777 /Ordering (OT1IT)
1778 /Supplement 0
1779 >> def
1780 /CMapName /TeX-OT1IT-0 def
1781 /CMapType 2 def
1782 1 begincodespacerange
1783 <00> <7F>
1784 endcodespacerange
1785 8 beginbfrange
1786 <00> <01> <0393>
1787 <09> <0A> <03A8>
1788 <25> <26> <0025>
1789 <28> <3B> <0028>
1790 <3F> <5B> <003F>
1791 <5D> <5E> <005D>
1792 <61> <7A> <0061>
1793 <7B> <7C> <2013>
1794 endbfrange
1795 42 beginbfchar
1796 <02> <0398>
1797 <03> <039B>
1798 <04> <039E>
1799 <05> <03A0>
1800 <06> <03A3>
1801 <07> <03D2>
1802 <08> <03A6>
1803 <0B> <00660066>
1804 <0C> <00660069>
1805 <0D> <0066006C>
1806 <0E> <006600660069>
1807 <0F> <00660066006C>
1808 <10> <0131>
1809 <11> <0237>
1810 <12> <0060>
1811 <13> <00B4>
1812 <14> <02C7>
1813 <15> <02D8>
1814 <16> <00AF>
1815 <17> <02DA>
1816 <18> <00B8>
1817 <19> <00DF>
1818 <1A> <00E6>
1819 <1B> <0153>
1820 <1C> <00F8>
1821 <1D> <00C6>
1822 <1E> <0152>
1823 <1F> <00D8>
1824 <21> <0021>
1825 <22> <201D>
1826 <23> <0023>
1827 <24> <00A3>
1828 <27> <2019>
1829 <3C> <00A1>
1830 <3D> <003D>
1831 <3E> <00BF>
1832 <5C> <201C>
1833 <5F> <02D9>
1834 <60> <2018>
1835 <7D> <02DD>
1836 <7E> <007E>
1837 <7F> <00A8>
1838 endbfchar
1839 endcmap
1840 CMapName currentdict /CMap defineresource pop
1843 %%EndResource
1844 %%EOF
1845 }\endgroup
1846 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1847 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1850 % \cmapOT1TT
1851 \begingroup
1852 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1853 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1854 %%DocumentNeededResources: ProcSet (CIDInit)
1855 %%IncludeResource: ProcSet (CIDInit)
1856 %%BeginResource: CMap (TeX-OT1TT-0)
1857 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1858 %%Version: 1.000
1859 %%EndComments
1860 /CIDInit /ProcSet findresource begin
1861 12 dict begin
1862 begincmap
1863 /CIDSystemInfo
1864 << /Registry (TeX)
1865 /Ordering (OT1TT)
1866 /Supplement 0
1867 >> def
1868 /CMapName /TeX-OT1TT-0 def
1869 /CMapType 2 def
1870 1 begincodespacerange
1871 <00> <7F>
1872 endcodespacerange
1873 5 beginbfrange
1874 <00> <01> <0393>
1875 <09> <0A> <03A8>
1876 <21> <26> <0021>
1877 <28> <5F> <0028>
1878 <61> <7E> <0061>
1879 endbfrange
1880 32 beginbfchar
1881 <02> <0398>
1882 <03> <039B>
1883 <04> <039E>
1884 <05> <03A0>
1885 <06> <03A3>
1886 <07> <03D2>
1887 <08> <03A6>
1888 <0B> <2191>
1889 <0C> <2193>
1890 <0D> <0027>
1891 <0E> <00A1>
1892 <0F> <00BF>
1893 <10> <0131>
1894 <11> <0237>
1895 <12> <0060>
1896 <13> <00B4>
1897 <14> <02C7>
1898 <15> <02D8>
1899 <16> <00AF>
1900 <17> <02DA>
1901 <18> <00B8>
1902 <19> <00DF>
1903 <1A> <00E6>
1904 <1B> <0153>
1905 <1C> <00F8>
1906 <1D> <00C6>
1907 <1E> <0152>
1908 <1F> <00D8>
1909 <20> <2423>
1910 <27> <2019>
1911 <60> <2018>
1912 <7F> <00A8>
1913 endbfchar
1914 endcmap
1915 CMapName currentdict /CMap defineresource pop
1918 %%EndResource
1919 %%EOF
1920 }\endgroup
1921 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1922 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1924 \fi\fi
1927 % Set the font macro #1 to the font named #2, adding on the
1928 % specified font prefix (normally `cm').
1929 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1930 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1931 % empty to omit).
1932 \def\setfont#1#2#3#4#5{%
1933 \font#1=\fontprefix#2#3 scaled #4
1934 \csname cmap#5\endcsname#1%
1936 % This is what gets called when #5 of \setfont is empty.
1937 \let\cmap\gobble
1938 % emacs-page end of cmaps
1940 % Use cm as the default font prefix.
1941 % To specify the font prefix, you must define \fontprefix
1942 % before you read in texinfo.tex.
1943 \ifx\fontprefix\undefined
1944 \def\fontprefix{cm}
1946 % Support font families that don't use the same naming scheme as CM.
1947 \def\rmshape{r}
1948 \def\rmbshape{bx} %where the normal face is bold
1949 \def\bfshape{b}
1950 \def\bxshape{bx}
1951 \def\ttshape{tt}
1952 \def\ttbshape{tt}
1953 \def\ttslshape{sltt}
1954 \def\itshape{ti}
1955 \def\itbshape{bxti}
1956 \def\slshape{sl}
1957 \def\slbshape{bxsl}
1958 \def\sfshape{ss}
1959 \def\sfbshape{ss}
1960 \def\scshape{csc}
1961 \def\scbshape{csc}
1963 % Definitions for a main text size of 11pt. This is the default in
1964 % Texinfo.
1966 \def\definetextfontsizexi{%
1967 % Text fonts (11.2pt, magstep1).
1968 \def\textnominalsize{11pt}
1969 \edef\mainmagstep{\magstephalf}
1970 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1971 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1972 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1973 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1974 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1975 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1976 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1977 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1978 \font\texti=cmmi10 scaled \mainmagstep
1979 \font\textsy=cmsy10 scaled \mainmagstep
1980 \def\textecsize{1095}
1982 % A few fonts for @defun names and args.
1983 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1984 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1985 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1986 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1988 % Fonts for indices, footnotes, small examples (9pt).
1989 \def\smallnominalsize{9pt}
1990 \setfont\smallrm\rmshape{9}{1000}{OT1}
1991 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1992 \setfont\smallbf\bfshape{10}{900}{OT1}
1993 \setfont\smallit\itshape{9}{1000}{OT1IT}
1994 \setfont\smallsl\slshape{9}{1000}{OT1}
1995 \setfont\smallsf\sfshape{9}{1000}{OT1}
1996 \setfont\smallsc\scshape{10}{900}{OT1}
1997 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1998 \font\smalli=cmmi9
1999 \font\smallsy=cmsy9
2000 \def\smallecsize{0900}
2002 % Fonts for small examples (8pt).
2003 \def\smallernominalsize{8pt}
2004 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2005 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2006 \setfont\smallerbf\bfshape{10}{800}{OT1}
2007 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2008 \setfont\smallersl\slshape{8}{1000}{OT1}
2009 \setfont\smallersf\sfshape{8}{1000}{OT1}
2010 \setfont\smallersc\scshape{10}{800}{OT1}
2011 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2012 \font\smalleri=cmmi8
2013 \font\smallersy=cmsy8
2014 \def\smallerecsize{0800}
2016 % Fonts for title page (20.4pt):
2017 \def\titlenominalsize{20pt}
2018 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2019 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2020 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2021 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2022 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2023 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2024 \let\titlebf=\titlerm
2025 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2026 \font\titlei=cmmi12 scaled \magstep3
2027 \font\titlesy=cmsy10 scaled \magstep4
2028 \def\authorrm{\secrm}
2029 \def\authortt{\sectt}
2030 \def\titleecsize{2074}
2032 % Chapter (and unnumbered) fonts (17.28pt).
2033 \def\chapnominalsize{17pt}
2034 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
2035 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
2036 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
2037 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
2038 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2039 \setfont\chapsf\sfbshape{17}{1000}{OT1}
2040 \let\chapbf=\chaprm
2041 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
2042 \font\chapi=cmmi12 scaled \magstep2
2043 \font\chapsy=cmsy10 scaled \magstep3
2044 \def\chapecsize{1728}
2046 % Section fonts (14.4pt).
2047 \def\secnominalsize{14pt}
2048 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
2049 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
2050 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
2051 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
2052 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2053 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
2054 \let\secbf\secrm
2055 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
2056 \font\seci=cmmi12 scaled \magstep1
2057 \font\secsy=cmsy10 scaled \magstep2
2058 \def\sececsize{1440}
2060 % Subsection fonts (13.15pt).
2061 \def\ssecnominalsize{13pt}
2062 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
2063 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
2064 \setfont\ssecsl\slbshape{10}{1315}{OT1}
2065 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
2066 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2067 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
2068 \let\ssecbf\ssecrm
2069 \setfont\ssecsc\scbshape{10}{1315}{OT1}
2070 \font\sseci=cmmi12 scaled \magstephalf
2071 \font\ssecsy=cmsy10 scaled 1315
2072 \def\ssececsize{1200}
2074 % Reduced fonts for @acro in text (10pt).
2075 \def\reducednominalsize{10pt}
2076 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2077 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2078 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2079 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2080 \setfont\reducedsl\slshape{10}{1000}{OT1}
2081 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2082 \setfont\reducedsc\scshape{10}{1000}{OT1}
2083 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2084 \font\reducedi=cmmi10
2085 \font\reducedsy=cmsy10
2086 \def\reducedecsize{1000}
2088 % reset the current fonts
2089 \textfonts
2091 } % end of 11pt text font size definitions
2094 % Definitions to make the main text be 10pt Computer Modern, with
2095 % section, chapter, etc., sizes following suit. This is for the GNU
2096 % Press printing of the Emacs 22 manual. Maybe other manuals in the
2097 % future. Used with @smallbook, which sets the leading to 12pt.
2099 \def\definetextfontsizex{%
2100 % Text fonts (10pt).
2101 \def\textnominalsize{10pt}
2102 \edef\mainmagstep{1000}
2103 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2104 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2105 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2106 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2107 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2108 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2109 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2110 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2111 \font\texti=cmmi10 scaled \mainmagstep
2112 \font\textsy=cmsy10 scaled \mainmagstep
2113 \def\textecsize{1000}
2115 % A few fonts for @defun names and args.
2116 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2117 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2118 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2119 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2121 % Fonts for indices, footnotes, small examples (9pt).
2122 \def\smallnominalsize{9pt}
2123 \setfont\smallrm\rmshape{9}{1000}{OT1}
2124 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2125 \setfont\smallbf\bfshape{10}{900}{OT1}
2126 \setfont\smallit\itshape{9}{1000}{OT1IT}
2127 \setfont\smallsl\slshape{9}{1000}{OT1}
2128 \setfont\smallsf\sfshape{9}{1000}{OT1}
2129 \setfont\smallsc\scshape{10}{900}{OT1}
2130 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2131 \font\smalli=cmmi9
2132 \font\smallsy=cmsy9
2133 \def\smallecsize{0900}
2135 % Fonts for small examples (8pt).
2136 \def\smallernominalsize{8pt}
2137 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2138 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2139 \setfont\smallerbf\bfshape{10}{800}{OT1}
2140 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2141 \setfont\smallersl\slshape{8}{1000}{OT1}
2142 \setfont\smallersf\sfshape{8}{1000}{OT1}
2143 \setfont\smallersc\scshape{10}{800}{OT1}
2144 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2145 \font\smalleri=cmmi8
2146 \font\smallersy=cmsy8
2147 \def\smallerecsize{0800}
2149 % Fonts for title page (20.4pt):
2150 \def\titlenominalsize{20pt}
2151 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2152 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2153 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2154 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2155 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2156 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2157 \let\titlebf=\titlerm
2158 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2159 \font\titlei=cmmi12 scaled \magstep3
2160 \font\titlesy=cmsy10 scaled \magstep4
2161 \def\authorrm{\secrm}
2162 \def\authortt{\sectt}
2163 \def\titleecsize{2074}
2165 % Chapter fonts (14.4pt).
2166 \def\chapnominalsize{14pt}
2167 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2168 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2169 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2170 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2171 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2172 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2173 \let\chapbf\chaprm
2174 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2175 \font\chapi=cmmi12 scaled \magstep1
2176 \font\chapsy=cmsy10 scaled \magstep2
2177 \def\chapecsize{1440}
2179 % Section fonts (12pt).
2180 \def\secnominalsize{12pt}
2181 \setfont\secrm\rmbshape{12}{1000}{OT1}
2182 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2183 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2184 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2185 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2186 \setfont\secsf\sfbshape{12}{1000}{OT1}
2187 \let\secbf\secrm
2188 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2189 \font\seci=cmmi12
2190 \font\secsy=cmsy10 scaled \magstep1
2191 \def\sececsize{1200}
2193 % Subsection fonts (10pt).
2194 \def\ssecnominalsize{10pt}
2195 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2196 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2197 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2198 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2199 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2200 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2201 \let\ssecbf\ssecrm
2202 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2203 \font\sseci=cmmi10
2204 \font\ssecsy=cmsy10
2205 \def\ssececsize{1000}
2207 % Reduced fonts for @acro in text (9pt).
2208 \def\reducednominalsize{9pt}
2209 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2210 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2211 \setfont\reducedbf\bfshape{10}{900}{OT1}
2212 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2213 \setfont\reducedsl\slshape{9}{1000}{OT1}
2214 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2215 \setfont\reducedsc\scshape{10}{900}{OT1}
2216 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2217 \font\reducedi=cmmi9
2218 \font\reducedsy=cmsy9
2219 \def\reducedecsize{0900}
2221 % reduce space between paragraphs
2222 \divide\parskip by 2
2224 % reset the current fonts
2225 \textfonts
2227 } % end of 10pt text font size definitions
2230 % We provide the user-level command
2231 % @fonttextsize 10
2232 % (or 11) to redefine the text font size. pt is assumed.
2234 \def\xword{10}
2235 \def\xiword{11}
2237 \parseargdef\fonttextsize{%
2238 \def\textsizearg{#1}%
2239 \wlog{doing @fonttextsize \textsizearg}%
2241 % Set \globaldefs so that documents can use this inside @tex, since
2242 % makeinfo 4.8 does not support it, but we need it nonetheless.
2244 \begingroup \globaldefs=1
2245 \ifx\textsizearg\xword \definetextfontsizex
2246 \else \ifx\textsizearg\xiword \definetextfontsizexi
2247 \else
2248 \errhelp=\EMsimple
2249 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2250 \fi\fi
2251 \endgroup
2255 % In order for the font changes to affect most math symbols and letters,
2256 % we have to define the \textfont of the standard families. Since
2257 % texinfo doesn't allow for producing subscripts and superscripts except
2258 % in the main text, we don't bother to reset \scriptfont and
2259 % \scriptscriptfont (which would also require loading a lot more fonts).
2261 \def\resetmathfonts{%
2262 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2263 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2264 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2267 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2268 % of just \STYLE. We do this because \STYLE needs to also set the
2269 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2270 % \tenSTYLE to set the current font.
2272 % Each font-changing command also sets the names \lsize (one size lower)
2273 % and \lllsize (three sizes lower). These relative commands are used in
2274 % the LaTeX logo and acronyms.
2276 % This all needs generalizing, badly.
2278 \def\textfonts{%
2279 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2280 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2281 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2282 \let\tenttsl=\textttsl
2283 \def\curfontsize{text}%
2284 \def\lsize{reduced}\def\lllsize{smaller}%
2285 \resetmathfonts \setleading{\textleading}}
2286 \def\titlefonts{%
2287 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2288 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2289 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2290 \let\tenttsl=\titlettsl
2291 \def\curfontsize{title}%
2292 \def\lsize{chap}\def\lllsize{subsec}%
2293 \resetmathfonts \setleading{25pt}}
2294 \def\titlefont#1{{\titlefonts\rm #1}}
2295 \def\chapfonts{%
2296 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2297 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2298 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2299 \let\tenttsl=\chapttsl
2300 \def\curfontsize{chap}%
2301 \def\lsize{sec}\def\lllsize{text}%
2302 \resetmathfonts \setleading{19pt}}
2303 \def\secfonts{%
2304 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2305 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2306 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2307 \let\tenttsl=\secttsl
2308 \def\curfontsize{sec}%
2309 \def\lsize{subsec}\def\lllsize{reduced}%
2310 \resetmathfonts \setleading{16pt}}
2311 \def\subsecfonts{%
2312 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2313 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2314 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2315 \let\tenttsl=\ssecttsl
2316 \def\curfontsize{ssec}%
2317 \def\lsize{text}\def\lllsize{small}%
2318 \resetmathfonts \setleading{15pt}}
2319 \let\subsubsecfonts = \subsecfonts
2320 \def\reducedfonts{%
2321 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2322 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2323 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2324 \let\tenttsl=\reducedttsl
2325 \def\curfontsize{reduced}%
2326 \def\lsize{small}\def\lllsize{smaller}%
2327 \resetmathfonts \setleading{10.5pt}}
2328 \def\smallfonts{%
2329 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2330 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2331 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2332 \let\tenttsl=\smallttsl
2333 \def\curfontsize{small}%
2334 \def\lsize{smaller}\def\lllsize{smaller}%
2335 \resetmathfonts \setleading{10.5pt}}
2336 \def\smallerfonts{%
2337 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2338 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2339 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2340 \let\tenttsl=\smallerttsl
2341 \def\curfontsize{smaller}%
2342 \def\lsize{smaller}\def\lllsize{smaller}%
2343 \resetmathfonts \setleading{9.5pt}}
2345 % Set the fonts to use with the @small... environments.
2346 \let\smallexamplefonts = \smallfonts
2348 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2349 % can fit this many characters:
2350 % 8.5x11=86 smallbook=72 a4=90 a5=69
2351 % If we use \scriptfonts (8pt), then we can fit this many characters:
2352 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2353 % For me, subjectively, the few extra characters that fit aren't worth
2354 % the additional smallness of 8pt. So I'm making the default 9pt.
2356 % By the way, for comparison, here's what fits with @example (10pt):
2357 % 8.5x11=71 smallbook=60 a4=75 a5=58
2359 % I wish the USA used A4 paper.
2360 % --karl, 24jan03.
2363 % Set up the default fonts, so we can use them for creating boxes.
2365 \definetextfontsizexi
2367 % Define these so they can be easily changed for other fonts.
2368 \def\angleleft{$\langle$}
2369 \def\angleright{$\rangle$}
2371 % Count depth in font-changes, for error checks
2372 \newcount\fontdepth \fontdepth=0
2374 % Fonts for short table of contents.
2375 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2376 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2377 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2378 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2380 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
2381 %% serif) and @ii for TeX italic
2383 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
2384 % unless the following character is such as not to need one.
2385 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
2386 \ptexslash\fi\fi\fi}
2387 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
2388 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
2390 % like \smartslanted except unconditionally uses \ttsl.
2391 % @var is set to this for defun arguments.
2392 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
2394 % like \smartslanted except unconditionally use \sl. We never want
2395 % ttsl for book titles, do we?
2396 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
2398 \let\i=\smartitalic
2399 \let\slanted=\smartslanted
2400 \let\var=\smartslanted
2401 \let\dfn=\smartslanted
2402 \let\emph=\smartitalic
2404 % @b, explicit bold.
2405 \def\b#1{{\bf #1}}
2406 \let\strong=\b
2408 % @sansserif, explicit sans.
2409 \def\sansserif#1{{\sf #1}}
2411 % We can't just use \exhyphenpenalty, because that only has effect at
2412 % the end of a paragraph. Restore normal hyphenation at the end of the
2413 % group within which \nohyphenation is presumably called.
2415 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2416 \def\restorehyphenation{\hyphenchar\font = `- }
2418 % Set sfcode to normal for the chars that usually have another value.
2419 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2420 % sometimes \x has an active definition that messes things up.
2422 \catcode`@=11
2423 \def\plainfrenchspacing{%
2424 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2425 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2426 \def\endofsentencespacefactor{1000}% for @. and friends
2428 \def\plainnonfrenchspacing{%
2429 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2430 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2431 \def\endofsentencespacefactor{3000}% for @. and friends
2433 \catcode`@=\other
2434 \def\endofsentencespacefactor{3000}% default
2436 \def\t#1{%
2437 {\tt \rawbackslash \plainfrenchspacing #1}%
2438 \null
2440 \def\samp#1{`\tclose{#1}'\null}
2441 \setfont\keyrm\rmshape{8}{1000}{OT1}
2442 \font\keysy=cmsy9
2443 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2444 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2445 \vbox{\hrule\kern-0.4pt
2446 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2447 \kern-0.4pt\hrule}%
2448 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2449 \def\key #1{{\nohyphenation \uppercase{#1}}\null}
2450 % The old definition, with no lozenge:
2451 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
2452 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2454 % @file, @option are the same as @samp.
2455 \let\file=\samp
2456 \let\option=\samp
2458 % @code is a modification of @t,
2459 % which makes spaces the same size as normal in the surrounding text.
2460 \def\tclose#1{%
2462 % Change normal interword space to be same as for the current font.
2463 \spaceskip = \fontdimen2\font
2465 % Switch to typewriter.
2468 % But `\ ' produces the large typewriter interword space.
2469 \def\ {{\spaceskip = 0pt{} }}%
2471 % Turn off hyphenation.
2472 \nohyphenation
2474 \rawbackslash
2475 \plainfrenchspacing
2478 \null
2481 % We *must* turn on hyphenation at `-' and `_' in @code.
2482 % Otherwise, it is too hard to avoid overfull hboxes
2483 % in the Emacs manual, the Library manual, etc.
2485 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2486 % both hyphenation at - and hyphenation within words.
2487 % We must therefore turn them both off (\tclose does that)
2488 % and arrange explicitly to hyphenate at a dash.
2489 % -- rms.
2491 \catcode`\-=\active \catcode`\_=\active
2492 \catcode`\'=\active \catcode`\`=\active
2493 \global\let'=\rq \global\let`=\lq % default definitions
2495 \global\def\code{\begingroup
2496 \catcode\rquoteChar=\active \catcode\lquoteChar=\active
2497 \let'\codequoteright \let`\codequoteleft
2499 \catcode\dashChar=\active \catcode\underChar=\active
2500 \ifallowcodebreaks
2501 \let-\codedash
2502 \let_\codeunder
2503 \else
2504 \let-\realdash
2505 \let_\realunder
2507 \codex
2511 \def\realdash{-}
2512 \def\codedash{-\discretionary{}{}{}}
2513 \def\codeunder{%
2514 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2515 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2516 % will therefore expand the active definition of _, which is us
2517 % (inside @code that is), therefore an endless loop.
2518 \ifusingtt{\ifmmode
2519 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2520 \else\normalunderscore \fi
2521 \discretionary{}{}{}}%
2522 {\_}%
2524 \def\codex #1{\tclose{#1}\endgroup}
2526 % An additional complication: the above will allow breaks after, e.g.,
2527 % each of the four underscores in __typeof__. This is undesirable in
2528 % some manuals, especially if they don't have long identifiers in
2529 % general. @allowcodebreaks provides a way to control this.
2531 \newif\ifallowcodebreaks \allowcodebreakstrue
2533 \def\keywordtrue{true}
2534 \def\keywordfalse{false}
2536 \parseargdef\allowcodebreaks{%
2537 \def\txiarg{#1}%
2538 \ifx\txiarg\keywordtrue
2539 \allowcodebreakstrue
2540 \else\ifx\txiarg\keywordfalse
2541 \allowcodebreaksfalse
2542 \else
2543 \errhelp = \EMsimple
2544 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2545 \fi\fi
2548 % @kbd is like @code, except that if the argument is just one @key command,
2549 % then @kbd has no effect.
2551 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2552 % `example' (@kbd uses ttsl only inside of @example and friends),
2553 % or `code' (@kbd uses normal tty font always).
2554 \parseargdef\kbdinputstyle{%
2555 \def\txiarg{#1}%
2556 \ifx\txiarg\worddistinct
2557 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2558 \else\ifx\txiarg\wordexample
2559 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2560 \else\ifx\txiarg\wordcode
2561 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2562 \else
2563 \errhelp = \EMsimple
2564 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2565 \fi\fi\fi
2567 \def\worddistinct{distinct}
2568 \def\wordexample{example}
2569 \def\wordcode{code}
2571 % Default is `distinct.'
2572 \kbdinputstyle distinct
2574 \def\xkey{\key}
2575 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2576 \ifx\one\xkey\ifx\threex\three \key{#2}%
2577 \else{\tclose{\kbdfont\look}}\fi
2578 \else{\tclose{\kbdfont\look}}\fi}
2580 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2581 \let\indicateurl=\code
2582 \let\env=\code
2583 \let\command=\code
2585 % @clicksequence{File @click{} Open ...}
2586 \def\clicksequence#1{\begingroup #1\endgroup}
2588 % @clickstyle @arrow (by default)
2589 \parseargdef\clickstyle{\def\click{#1}}
2590 \def\click{\arrow}
2592 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2593 % second argument specifying the text to display and an optional third
2594 % arg as text to display instead of (rather than in addition to) the url
2595 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2596 % a hypertex \special here.
2598 \def\uref#1{\douref #1,,,\finish}
2599 \def\douref#1,#2,#3,#4\finish{\begingroup
2600 \unsepspaces
2601 \pdfurl{#1}%
2602 \setbox0 = \hbox{\ignorespaces #3}%
2603 \ifdim\wd0 > 0pt
2604 \unhbox0 % third arg given, show only that
2605 \else
2606 \setbox0 = \hbox{\ignorespaces #2}%
2607 \ifdim\wd0 > 0pt
2608 \ifpdf
2609 \unhbox0 % PDF: 2nd arg given, show only it
2610 \else
2611 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2613 \else
2614 \code{#1}% only url given, so show it
2617 \endlink
2618 \endgroup}
2620 % @url synonym for @uref, since that's how everyone uses it.
2622 \let\url=\uref
2624 % rms does not like angle brackets --karl, 17may97.
2625 % So now @email is just like @uref, unless we are pdf.
2627 %\def\email#1{\angleleft{\tt #1}\angleright}
2628 \ifpdf
2629 \def\email#1{\doemail#1,,\finish}
2630 \def\doemail#1,#2,#3\finish{\begingroup
2631 \unsepspaces
2632 \pdfurl{mailto:#1}%
2633 \setbox0 = \hbox{\ignorespaces #2}%
2634 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2635 \endlink
2636 \endgroup}
2637 \else
2638 \let\email=\uref
2641 % Check if we are currently using a typewriter font. Since all the
2642 % Computer Modern typewriter fonts have zero interword stretch (and
2643 % shrink), and it is reasonable to expect all typewriter fonts to have
2644 % this property, we can check that font parameter.
2646 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2648 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2649 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2651 \def\dmn#1{\thinspace #1}
2653 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2655 % @l was never documented to mean ``switch to the Lisp font'',
2656 % and it is not used as such in any manual I can find. We need it for
2657 % Polish suppressed-l. --karl, 22sep96.
2658 %\def\l#1{{\li #1}\null}
2660 % Explicit font changes: @r, @sc, undocumented @ii.
2661 \def\r#1{{\rm #1}} % roman font
2662 \def\sc#1{{\smallcaps#1}} % smallcaps font
2663 \def\ii#1{{\it #1}} % italic font
2665 % @acronym for "FBI", "NATO", and the like.
2666 % We print this one point size smaller, since it's intended for
2667 % all-uppercase.
2669 \def\acronym#1{\doacronym #1,,\finish}
2670 \def\doacronym#1,#2,#3\finish{%
2671 {\selectfonts\lsize #1}%
2672 \def\temp{#2}%
2673 \ifx\temp\empty \else
2674 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2678 % @abbr for "Comput. J." and the like.
2679 % No font change, but don't do end-of-sentence spacing.
2681 \def\abbr#1{\doabbr #1,,\finish}
2682 \def\doabbr#1,#2,#3\finish{%
2683 {\plainfrenchspacing #1}%
2684 \def\temp{#2}%
2685 \ifx\temp\empty \else
2686 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2690 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2692 \def\pounds{{\it\$}}
2694 % @euro{} comes from a separate font, depending on the current style.
2695 % We use the free feym* fonts from the eurosym package by Henrik
2696 % Theiling, which support regular, slanted, bold and bold slanted (and
2697 % "outlined" (blackboard board, sort of) versions, which we don't need).
2698 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2700 % Although only regular is the truly official Euro symbol, we ignore
2701 % that. The Euro is designed to be slightly taller than the regular
2702 % font height.
2704 % feymr - regular
2705 % feymo - slanted
2706 % feybr - bold
2707 % feybo - bold slanted
2709 % There is no good (free) typewriter version, to my knowledge.
2710 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2711 % Hmm.
2713 % Also doesn't work in math. Do we need to do math with euro symbols?
2714 % Hope not.
2717 \def\euro{{\eurofont e}}
2718 \def\eurofont{%
2719 % We set the font at each command, rather than predefining it in
2720 % \textfonts and the other font-switching commands, so that
2721 % installations which never need the symbol don't have to have the
2722 % font installed.
2724 % There is only one designed size (nominal 10pt), so we always scale
2725 % that to the current nominal size.
2727 % By the way, simply using "at 1em" works for cmr10 and the like, but
2728 % does not work for cmbx10 and other extended/shrunken fonts.
2730 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2732 \ifx\curfontstyle\bfstylename
2733 % bold:
2734 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2735 \else
2736 % regular:
2737 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2739 \thiseurofont
2742 % Hacks for glyphs from the EC fonts similar to \euro. We don't
2743 % use \let for the aliases, because sometimes we redefine the original
2744 % macro, and the alias should reflect the redefinition.
2745 \def\guillemetleft{{\ecfont \char"13}}
2746 \def\guillemotleft{\guillemetleft}
2747 \def\guillemetright{{\ecfont \char"14}}
2748 \def\guillemotright{\guillemetright}
2749 \def\guilsinglleft{{\ecfont \char"0E}}
2750 \def\guilsinglright{{\ecfont \char"0F}}
2751 \def\quotedblbase{{\ecfont \char"12}}
2752 \def\quotesinglbase{{\ecfont \char"0D}}
2754 % This positioning is not perfect (see the ogonek LaTeX package), but
2755 % we have the precomposed glyphs for the most common cases.
2756 % ogonek is also used with other letters in Lithuanian (IOU), but using
2757 % the precomposed glyphs for those is not so easy since they aren't in
2758 % the same EC font.
2759 \def\ogonek#1{{\ecfont \setbox0=\hbox{#1}\ifdim\ht0=1ex\accent"0C #1%
2760 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}\fi}}
2761 \def\Aogonek{{\ecfont \char"81}}
2762 \def\Eogonek{{\ecfont \char"86}}
2763 \def\aogonek{{\ecfont \char"A1}}
2764 \def\eogonek{{\ecfont \char"A6}}
2766 \def\ecfont{%
2767 % We can't distinguish serif/sans and italic/slanted, but this
2768 % is used for crude hacks anyway (like adding French and German
2769 % quotes to documents typeset with CM, where we lose kerning), so
2770 % hopefully nobody will notice/care.
2771 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
2772 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
2773 \ifx\curfontstyle\bfstylename
2774 % bold:
2775 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
2776 \else
2777 % regular:
2778 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
2780 \thisecfont
2783 % @registeredsymbol - R in a circle. The font for the R should really
2784 % be smaller yet, but lllsize is the best we can do for now.
2785 % Adapted from the plain.tex definition of \copyright.
2787 \def\registeredsymbol{%
2788 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2789 \hfil\crcr\Orb}}%
2793 % @textdegree - the normal degrees sign.
2795 \def\textdegree{$^\circ$}
2797 % Laurent Siebenmann reports \Orb undefined with:
2798 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2799 % so we'll define it if necessary.
2801 \ifx\Orb\undefined
2802 \def\Orb{\mathhexbox20D}
2805 % Quotes.
2806 \chardef\quotedblleft="5C
2807 \chardef\quotedblright=`\"
2808 \chardef\quoteleft=`\`
2809 \chardef\quoteright=`\'
2812 \message{page headings,}
2814 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2815 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2817 % First the title page. Must do @settitle before @titlepage.
2818 \newif\ifseenauthor
2819 \newif\iffinishedtitlepage
2821 % Do an implicit @contents or @shortcontents after @end titlepage if the
2822 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2824 \newif\ifsetcontentsaftertitlepage
2825 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2826 \newif\ifsetshortcontentsaftertitlepage
2827 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2829 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2830 \endgroup\page\hbox{}\page}
2832 \envdef\titlepage{%
2833 % Open one extra group, as we want to close it in the middle of \Etitlepage.
2834 \begingroup
2835 \parindent=0pt \textfonts
2836 % Leave some space at the very top of the page.
2837 \vglue\titlepagetopglue
2838 % No rule at page bottom unless we print one at the top with @title.
2839 \finishedtitlepagetrue
2841 % Most title ``pages'' are actually two pages long, with space
2842 % at the top of the second. We don't want the ragged left on the second.
2843 \let\oldpage = \page
2844 \def\page{%
2845 \iffinishedtitlepage\else
2846 \finishtitlepage
2848 \let\page = \oldpage
2849 \page
2850 \null
2854 \def\Etitlepage{%
2855 \iffinishedtitlepage\else
2856 \finishtitlepage
2858 % It is important to do the page break before ending the group,
2859 % because the headline and footline are only empty inside the group.
2860 % If we use the new definition of \page, we always get a blank page
2861 % after the title page, which we certainly don't want.
2862 \oldpage
2863 \endgroup
2865 % Need this before the \...aftertitlepage checks so that if they are
2866 % in effect the toc pages will come out with page numbers.
2867 \HEADINGSon
2869 % If they want short, they certainly want long too.
2870 \ifsetshortcontentsaftertitlepage
2871 \shortcontents
2872 \contents
2873 \global\let\shortcontents = \relax
2874 \global\let\contents = \relax
2877 \ifsetcontentsaftertitlepage
2878 \contents
2879 \global\let\contents = \relax
2880 \global\let\shortcontents = \relax
2884 \def\finishtitlepage{%
2885 \vskip4pt \hrule height 2pt width \hsize
2886 \vskip\titlepagebottomglue
2887 \finishedtitlepagetrue
2890 %%% Macros to be used within @titlepage:
2892 \let\subtitlerm=\tenrm
2893 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2895 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2896 \let\tt=\authortt}
2898 \parseargdef\title{%
2899 \checkenv\titlepage
2900 \leftline{\titlefonts\rm #1}
2901 % print a rule at the page bottom also.
2902 \finishedtitlepagefalse
2903 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2906 \parseargdef\subtitle{%
2907 \checkenv\titlepage
2908 {\subtitlefont \rightline{#1}}%
2911 % @author should come last, but may come many times.
2912 % It can also be used inside @quotation.
2914 \parseargdef\author{%
2915 \def\temp{\quotation}%
2916 \ifx\thisenv\temp
2917 \def\quotationauthor{#1}% printed in \Equotation.
2918 \else
2919 \checkenv\titlepage
2920 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2921 {\authorfont \leftline{#1}}%
2926 %%% Set up page headings and footings.
2928 \let\thispage=\folio
2930 \newtoks\evenheadline % headline on even pages
2931 \newtoks\oddheadline % headline on odd pages
2932 \newtoks\evenfootline % footline on even pages
2933 \newtoks\oddfootline % footline on odd pages
2935 % Now make TeX use those variables
2936 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2937 \else \the\evenheadline \fi}}
2938 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2939 \else \the\evenfootline \fi}\HEADINGShook}
2940 \let\HEADINGShook=\relax
2942 % Commands to set those variables.
2943 % For example, this is what @headings on does
2944 % @evenheading @thistitle|@thispage|@thischapter
2945 % @oddheading @thischapter|@thispage|@thistitle
2946 % @evenfooting @thisfile||
2947 % @oddfooting ||@thisfile
2950 \def\evenheading{\parsearg\evenheadingxxx}
2951 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2952 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2953 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2955 \def\oddheading{\parsearg\oddheadingxxx}
2956 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2957 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2958 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2960 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2962 \def\evenfooting{\parsearg\evenfootingxxx}
2963 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2964 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2965 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2967 \def\oddfooting{\parsearg\oddfootingxxx}
2968 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2969 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2970 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2972 % Leave some space for the footline. Hopefully ok to assume
2973 % @evenfooting will not be used by itself.
2974 \global\advance\pageheight by -12pt
2975 \global\advance\vsize by -12pt
2978 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2980 % @evenheadingmarks top \thischapter <- chapter at the top of a page
2981 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
2983 % The same set of arguments for:
2985 % @oddheadingmarks
2986 % @evenfootingmarks
2987 % @oddfootingmarks
2988 % @everyheadingmarks
2989 % @everyfootingmarks
2991 \def\evenheadingmarks{\headingmarks{even}{heading}}
2992 \def\oddheadingmarks{\headingmarks{odd}{heading}}
2993 \def\evenfootingmarks{\headingmarks{even}{footing}}
2994 \def\oddfootingmarks{\headingmarks{odd}{footing}}
2995 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
2996 \headingmarks{odd}{heading}{#1} }
2997 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
2998 \headingmarks{odd}{footing}{#1} }
2999 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3000 \def\headingmarks#1#2#3 {%
3001 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3002 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3005 \everyheadingmarks bottom
3006 \everyfootingmarks bottom
3008 % @headings double turns headings on for double-sided printing.
3009 % @headings single turns headings on for single-sided printing.
3010 % @headings off turns them off.
3011 % @headings on same as @headings double, retained for compatibility.
3012 % @headings after turns on double-sided headings after this page.
3013 % @headings doubleafter turns on double-sided headings after this page.
3014 % @headings singleafter turns on single-sided headings after this page.
3015 % By default, they are off at the start of a document,
3016 % and turned `on' after @end titlepage.
3018 \def\headings #1 {\csname HEADINGS#1\endcsname}
3020 \def\HEADINGSoff{%
3021 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
3022 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
3023 \HEADINGSoff
3024 % When we turn headings on, set the page number to 1.
3025 % For double-sided printing, put current file name in lower left corner,
3026 % chapter name on inside top of right hand pages, document
3027 % title on inside top of left hand pages, and page numbers on outside top
3028 % edge of all pages.
3029 \def\HEADINGSdouble{%
3030 \global\pageno=1
3031 \global\evenfootline={\hfil}
3032 \global\oddfootline={\hfil}
3033 \global\evenheadline={\line{\folio\hfil\thistitle}}
3034 \global\oddheadline={\line{\thischapter\hfil\folio}}
3035 \global\let\contentsalignmacro = \chapoddpage
3037 \let\contentsalignmacro = \chappager
3039 % For single-sided printing, chapter title goes across top left of page,
3040 % page number on top right.
3041 \def\HEADINGSsingle{%
3042 \global\pageno=1
3043 \global\evenfootline={\hfil}
3044 \global\oddfootline={\hfil}
3045 \global\evenheadline={\line{\thischapter\hfil\folio}}
3046 \global\oddheadline={\line{\thischapter\hfil\folio}}
3047 \global\let\contentsalignmacro = \chappager
3049 \def\HEADINGSon{\HEADINGSdouble}
3051 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3052 \let\HEADINGSdoubleafter=\HEADINGSafter
3053 \def\HEADINGSdoublex{%
3054 \global\evenfootline={\hfil}
3055 \global\oddfootline={\hfil}
3056 \global\evenheadline={\line{\folio\hfil\thistitle}}
3057 \global\oddheadline={\line{\thischapter\hfil\folio}}
3058 \global\let\contentsalignmacro = \chapoddpage
3061 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3062 \def\HEADINGSsinglex{%
3063 \global\evenfootline={\hfil}
3064 \global\oddfootline={\hfil}
3065 \global\evenheadline={\line{\thischapter\hfil\folio}}
3066 \global\oddheadline={\line{\thischapter\hfil\folio}}
3067 \global\let\contentsalignmacro = \chappager
3070 % Subroutines used in generating headings
3071 % This produces Day Month Year style of output.
3072 % Only define if not already defined, in case a txi-??.tex file has set
3073 % up a different format (e.g., txi-cs.tex does this).
3074 \ifx\today\undefined
3075 \def\today{%
3076 \number\day\space
3077 \ifcase\month
3078 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3079 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3080 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3082 \space\number\year}
3085 % @settitle line... specifies the title of the document, for headings.
3086 % It generates no output of its own.
3087 \def\thistitle{\putwordNoTitle}
3088 \def\settitle{\parsearg{\gdef\thistitle}}
3091 \message{tables,}
3092 % Tables -- @table, @ftable, @vtable, @item(x).
3094 % default indentation of table text
3095 \newdimen\tableindent \tableindent=.8in
3096 % default indentation of @itemize and @enumerate text
3097 \newdimen\itemindent \itemindent=.3in
3098 % margin between end of table item and start of table text.
3099 \newdimen\itemmargin \itemmargin=.1in
3101 % used internally for \itemindent minus \itemmargin
3102 \newdimen\itemmax
3104 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3105 % these defs.
3106 % They also define \itemindex
3107 % to index the item name in whatever manner is desired (perhaps none).
3109 \newif\ifitemxneedsnegativevskip
3111 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3113 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3114 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3116 \def\itemzzz #1{\begingroup %
3117 \advance\hsize by -\rightskip
3118 \advance\hsize by -\tableindent
3119 \setbox0=\hbox{\itemindicate{#1}}%
3120 \itemindex{#1}%
3121 \nobreak % This prevents a break before @itemx.
3123 % If the item text does not fit in the space we have, put it on a line
3124 % by itself, and do not allow a page break either before or after that
3125 % line. We do not start a paragraph here because then if the next
3126 % command is, e.g., @kindex, the whatsit would get put into the
3127 % horizontal list on a line by itself, resulting in extra blank space.
3128 \ifdim \wd0>\itemmax
3130 % Make this a paragraph so we get the \parskip glue and wrapping,
3131 % but leave it ragged-right.
3132 \begingroup
3133 \advance\leftskip by-\tableindent
3134 \advance\hsize by\tableindent
3135 \advance\rightskip by0pt plus1fil
3136 \leavevmode\unhbox0\par
3137 \endgroup
3139 % We're going to be starting a paragraph, but we don't want the
3140 % \parskip glue -- logically it's part of the @item we just started.
3141 \nobreak \vskip-\parskip
3143 % Stop a page break at the \parskip glue coming up. However, if
3144 % what follows is an environment such as @example, there will be no
3145 % \parskip glue; then the negative vskip we just inserted would
3146 % cause the example and the item to crash together. So we use this
3147 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3148 % \parskip glue after all. Section titles are handled this way also.
3150 \penalty 10001
3151 \endgroup
3152 \itemxneedsnegativevskipfalse
3153 \else
3154 % The item text fits into the space. Start a paragraph, so that the
3155 % following text (if any) will end up on the same line.
3156 \noindent
3157 % Do this with kerns and \unhbox so that if there is a footnote in
3158 % the item text, it can migrate to the main vertical list and
3159 % eventually be printed.
3160 \nobreak\kern-\tableindent
3161 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3162 \unhbox0
3163 \nobreak\kern\dimen0
3164 \endgroup
3165 \itemxneedsnegativevskiptrue
3169 \def\item{\errmessage{@item while not in a list environment}}
3170 \def\itemx{\errmessage{@itemx while not in a list environment}}
3172 % @table, @ftable, @vtable.
3173 \envdef\table{%
3174 \let\itemindex\gobble
3175 \tablecheck{table}%
3177 \envdef\ftable{%
3178 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3179 \tablecheck{ftable}%
3181 \envdef\vtable{%
3182 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3183 \tablecheck{vtable}%
3185 \def\tablecheck#1{%
3186 \ifnum \the\catcode`\^^M=\active
3187 \endgroup
3188 \errmessage{This command won't work in this context; perhaps the problem is
3189 that we are \inenvironment\thisenv}%
3190 \def\next{\doignore{#1}}%
3191 \else
3192 \let\next\tablex
3194 \next
3196 \def\tablex#1{%
3197 \def\itemindicate{#1}%
3198 \parsearg\tabley
3200 \def\tabley#1{%
3202 \makevalueexpandable
3203 \edef\temp{\noexpand\tablez #1\space\space\space}%
3204 \expandafter
3205 }\temp \endtablez
3207 \def\tablez #1 #2 #3 #4\endtablez{%
3208 \aboveenvbreak
3209 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3210 \ifnum 0#2>0 \tableindent=#2\mil \fi
3211 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3212 \itemmax=\tableindent
3213 \advance \itemmax by -\itemmargin
3214 \advance \leftskip by \tableindent
3215 \exdentamount=\tableindent
3216 \parindent = 0pt
3217 \parskip = \smallskipamount
3218 \ifdim \parskip=0pt \parskip=2pt \fi
3219 \let\item = \internalBitem
3220 \let\itemx = \internalBitemx
3222 \def\Etable{\endgraf\afterenvbreak}
3223 \let\Eftable\Etable
3224 \let\Evtable\Etable
3225 \let\Eitemize\Etable
3226 \let\Eenumerate\Etable
3228 % This is the counter used by @enumerate, which is really @itemize
3230 \newcount \itemno
3232 \envdef\itemize{\parsearg\doitemize}
3234 \def\doitemize#1{%
3235 \aboveenvbreak
3236 \itemmax=\itemindent
3237 \advance\itemmax by -\itemmargin
3238 \advance\leftskip by \itemindent
3239 \exdentamount=\itemindent
3240 \parindent=0pt
3241 \parskip=\smallskipamount
3242 \ifdim\parskip=0pt \parskip=2pt \fi
3243 \def\itemcontents{#1}%
3244 % @itemize with no arg is equivalent to @itemize @bullet.
3245 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3246 \let\item=\itemizeitem
3249 % Definition of @item while inside @itemize and @enumerate.
3251 \def\itemizeitem{%
3252 \advance\itemno by 1 % for enumerations
3253 {\let\par=\endgraf \smallbreak}% reasonable place to break
3255 % If the document has an @itemize directly after a section title, a
3256 % \nobreak will be last on the list, and \sectionheading will have
3257 % done a \vskip-\parskip. In that case, we don't want to zero
3258 % parskip, or the item text will crash with the heading. On the
3259 % other hand, when there is normal text preceding the item (as there
3260 % usually is), we do want to zero parskip, or there would be too much
3261 % space. In that case, we won't have a \nobreak before. At least
3262 % that's the theory.
3263 \ifnum\lastpenalty<10000 \parskip=0in \fi
3264 \noindent
3265 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3266 \vadjust{\penalty 1200}}% not good to break after first line of item.
3267 \flushcr
3270 % \splitoff TOKENS\endmark defines \first to be the first token in
3271 % TOKENS, and \rest to be the remainder.
3273 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3275 % Allow an optional argument of an uppercase letter, lowercase letter,
3276 % or number, to specify the first label in the enumerated list. No
3277 % argument is the same as `1'.
3279 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3280 \def\enumeratey #1 #2\endenumeratey{%
3281 % If we were given no argument, pretend we were given `1'.
3282 \def\thearg{#1}%
3283 \ifx\thearg\empty \def\thearg{1}\fi
3285 % Detect if the argument is a single token. If so, it might be a
3286 % letter. Otherwise, the only valid thing it can be is a number.
3287 % (We will always have one token, because of the test we just made.
3288 % This is a good thing, since \splitoff doesn't work given nothing at
3289 % all -- the first parameter is undelimited.)
3290 \expandafter\splitoff\thearg\endmark
3291 \ifx\rest\empty
3292 % Only one token in the argument. It could still be anything.
3293 % A ``lowercase letter'' is one whose \lccode is nonzero.
3294 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3295 % not equal to itself.
3296 % Otherwise, we assume it's a number.
3298 % We need the \relax at the end of the \ifnum lines to stop TeX from
3299 % continuing to look for a <number>.
3301 \ifnum\lccode\expandafter`\thearg=0\relax
3302 \numericenumerate % a number (we hope)
3303 \else
3304 % It's a letter.
3305 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3306 \lowercaseenumerate % lowercase letter
3307 \else
3308 \uppercaseenumerate % uppercase letter
3311 \else
3312 % Multiple tokens in the argument. We hope it's a number.
3313 \numericenumerate
3317 % An @enumerate whose labels are integers. The starting integer is
3318 % given in \thearg.
3320 \def\numericenumerate{%
3321 \itemno = \thearg
3322 \startenumeration{\the\itemno}%
3325 % The starting (lowercase) letter is in \thearg.
3326 \def\lowercaseenumerate{%
3327 \itemno = \expandafter`\thearg
3328 \startenumeration{%
3329 % Be sure we're not beyond the end of the alphabet.
3330 \ifnum\itemno=0
3331 \errmessage{No more lowercase letters in @enumerate; get a bigger
3332 alphabet}%
3334 \char\lccode\itemno
3338 % The starting (uppercase) letter is in \thearg.
3339 \def\uppercaseenumerate{%
3340 \itemno = \expandafter`\thearg
3341 \startenumeration{%
3342 % Be sure we're not beyond the end of the alphabet.
3343 \ifnum\itemno=0
3344 \errmessage{No more uppercase letters in @enumerate; get a bigger
3345 alphabet}
3347 \char\uccode\itemno
3351 % Call \doitemize, adding a period to the first argument and supplying the
3352 % common last two arguments. Also subtract one from the initial value in
3353 % \itemno, since @item increments \itemno.
3355 \def\startenumeration#1{%
3356 \advance\itemno by -1
3357 \doitemize{#1.}\flushcr
3360 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3361 % to @enumerate.
3363 \def\alphaenumerate{\enumerate{a}}
3364 \def\capsenumerate{\enumerate{A}}
3365 \def\Ealphaenumerate{\Eenumerate}
3366 \def\Ecapsenumerate{\Eenumerate}
3369 % @multitable macros
3370 % Amy Hendrickson, 8/18/94, 3/6/96
3372 % @multitable ... @end multitable will make as many columns as desired.
3373 % Contents of each column will wrap at width given in preamble. Width
3374 % can be specified either with sample text given in a template line,
3375 % or in percent of \hsize, the current width of text on page.
3377 % Table can continue over pages but will only break between lines.
3379 % To make preamble:
3381 % Either define widths of columns in terms of percent of \hsize:
3382 % @multitable @columnfractions .25 .3 .45
3383 % @item ...
3385 % Numbers following @columnfractions are the percent of the total
3386 % current hsize to be used for each column. You may use as many
3387 % columns as desired.
3390 % Or use a template:
3391 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3392 % @item ...
3393 % using the widest term desired in each column.
3395 % Each new table line starts with @item, each subsequent new column
3396 % starts with @tab. Empty columns may be produced by supplying @tab's
3397 % with nothing between them for as many times as empty columns are needed,
3398 % ie, @tab@tab@tab will produce two empty columns.
3400 % @item, @tab do not need to be on their own lines, but it will not hurt
3401 % if they are.
3403 % Sample multitable:
3405 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3406 % @item first col stuff @tab second col stuff @tab third col
3407 % @item
3408 % first col stuff
3409 % @tab
3410 % second col stuff
3411 % @tab
3412 % third col
3413 % @item first col stuff @tab second col stuff
3414 % @tab Many paragraphs of text may be used in any column.
3416 % They will wrap at the width determined by the template.
3417 % @item@tab@tab This will be in third column.
3418 % @end multitable
3420 % Default dimensions may be reset by user.
3421 % @multitableparskip is vertical space between paragraphs in table.
3422 % @multitableparindent is paragraph indent in table.
3423 % @multitablecolmargin is horizontal space to be left between columns.
3424 % @multitablelinespace is space to leave between table items, baseline
3425 % to baseline.
3426 % 0pt means it depends on current normal line spacing.
3428 \newskip\multitableparskip
3429 \newskip\multitableparindent
3430 \newdimen\multitablecolspace
3431 \newskip\multitablelinespace
3432 \multitableparskip=0pt
3433 \multitableparindent=6pt
3434 \multitablecolspace=12pt
3435 \multitablelinespace=0pt
3437 % Macros used to set up halign preamble:
3439 \let\endsetuptable\relax
3440 \def\xendsetuptable{\endsetuptable}
3441 \let\columnfractions\relax
3442 \def\xcolumnfractions{\columnfractions}
3443 \newif\ifsetpercent
3445 % #1 is the @columnfraction, usually a decimal number like .5, but might
3446 % be just 1. We just use it, whatever it is.
3448 \def\pickupwholefraction#1 {%
3449 \global\advance\colcount by 1
3450 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3451 \setuptable
3454 \newcount\colcount
3455 \def\setuptable#1{%
3456 \def\firstarg{#1}%
3457 \ifx\firstarg\xendsetuptable
3458 \let\go = \relax
3459 \else
3460 \ifx\firstarg\xcolumnfractions
3461 \global\setpercenttrue
3462 \else
3463 \ifsetpercent
3464 \let\go\pickupwholefraction
3465 \else
3466 \global\advance\colcount by 1
3467 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3468 % separator; typically that is always in the input, anyway.
3469 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3472 \ifx\go\pickupwholefraction
3473 % Put the argument back for the \pickupwholefraction call, so
3474 % we'll always have a period there to be parsed.
3475 \def\go{\pickupwholefraction#1}%
3476 \else
3477 \let\go = \setuptable
3478 \fi%
3483 % multitable-only commands.
3485 % @headitem starts a heading row, which we typeset in bold.
3486 % Assignments have to be global since we are inside the implicit group
3487 % of an alignment entry. Note that \everycr resets \everytab.
3488 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
3490 % A \tab used to include \hskip1sp. But then the space in a template
3491 % line is not enough. That is bad. So let's go back to just `&' until
3492 % we encounter the problem it was intended to solve again.
3493 % --karl, nathan@acm.org, 20apr99.
3494 \def\tab{\checkenv\multitable &\the\everytab}%
3496 % @multitable ... @end multitable definitions:
3498 \newtoks\everytab % insert after every tab.
3500 \envdef\multitable{%
3501 \vskip\parskip
3502 \startsavinginserts
3504 % @item within a multitable starts a normal row.
3505 % We use \def instead of \let so that if one of the multitable entries
3506 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3507 % \endtemplate) expanding \doitemize.
3508 \def\item{\crcr}%
3510 \tolerance=9500
3511 \hbadness=9500
3512 \setmultitablespacing
3513 \parskip=\multitableparskip
3514 \parindent=\multitableparindent
3515 \overfullrule=0pt
3516 \global\colcount=0
3518 \everycr = {%
3519 \noalign{%
3520 \global\everytab={}%
3521 \global\colcount=0 % Reset the column counter.
3522 % Check for saved footnotes, etc.
3523 \checkinserts
3524 % Keeps underfull box messages off when table breaks over pages.
3525 %\filbreak
3526 % Maybe so, but it also creates really weird page breaks when the
3527 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3528 % problem manifests itself, so it can be fixed for real --karl.
3532 \parsearg\domultitable
3534 \def\domultitable#1{%
3535 % To parse everything between @multitable and @item:
3536 \setuptable#1 \endsetuptable
3538 % This preamble sets up a generic column definition, which will
3539 % be used as many times as user calls for columns.
3540 % \vtop will set a single line and will also let text wrap and
3541 % continue for many paragraphs if desired.
3542 \halign\bgroup &%
3543 \global\advance\colcount by 1
3544 \multistrut
3545 \vtop{%
3546 % Use the current \colcount to find the correct column width:
3547 \hsize=\expandafter\csname col\the\colcount\endcsname
3549 % In order to keep entries from bumping into each other
3550 % we will add a \leftskip of \multitablecolspace to all columns after
3551 % the first one.
3553 % If a template has been used, we will add \multitablecolspace
3554 % to the width of each template entry.
3556 % If the user has set preamble in terms of percent of \hsize we will
3557 % use that dimension as the width of the column, and the \leftskip
3558 % will keep entries from bumping into each other. Table will start at
3559 % left margin and final column will justify at right margin.
3561 % Make sure we don't inherit \rightskip from the outer environment.
3562 \rightskip=0pt
3563 \ifnum\colcount=1
3564 % The first column will be indented with the surrounding text.
3565 \advance\hsize by\leftskip
3566 \else
3567 \ifsetpercent \else
3568 % If user has not set preamble in terms of percent of \hsize
3569 % we will advance \hsize by \multitablecolspace.
3570 \advance\hsize by \multitablecolspace
3572 % In either case we will make \leftskip=\multitablecolspace:
3573 \leftskip=\multitablecolspace
3575 % Ignoring space at the beginning and end avoids an occasional spurious
3576 % blank line, when TeX decides to break the line at the space before the
3577 % box from the multistrut, so the strut ends up on a line by itself.
3578 % For example:
3579 % @multitable @columnfractions .11 .89
3580 % @item @code{#}
3581 % @tab Legal holiday which is valid in major parts of the whole country.
3582 % Is automatically provided with highlighting sequences respectively
3583 % marking characters.
3584 \noindent\ignorespaces##\unskip\multistrut
3585 }\cr
3587 \def\Emultitable{%
3588 \crcr
3589 \egroup % end the \halign
3590 \global\setpercentfalse
3593 \def\setmultitablespacing{%
3594 \def\multistrut{\strut}% just use the standard line spacing
3596 % Compute \multitablelinespace (if not defined by user) for use in
3597 % \multitableparskip calculation. We used define \multistrut based on
3598 % this, but (ironically) that caused the spacing to be off.
3599 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3600 \ifdim\multitablelinespace=0pt
3601 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3602 \global\advance\multitablelinespace by-\ht0
3604 %% Test to see if parskip is larger than space between lines of
3605 %% table. If not, do nothing.
3606 %% If so, set to same dimension as multitablelinespace.
3607 \ifdim\multitableparskip>\multitablelinespace
3608 \global\multitableparskip=\multitablelinespace
3609 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3610 %% than skip between lines in the table.
3611 \fi%
3612 \ifdim\multitableparskip=0pt
3613 \global\multitableparskip=\multitablelinespace
3614 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3615 %% than skip between lines in the table.
3616 \fi}
3619 \message{conditionals,}
3621 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3622 % @ifnotxml always succeed. They currently do nothing; we don't
3623 % attempt to check whether the conditionals are properly nested. But we
3624 % have to remember that they are conditionals, so that @end doesn't
3625 % attempt to close an environment group.
3627 \def\makecond#1{%
3628 \expandafter\let\csname #1\endcsname = \relax
3629 \expandafter\let\csname iscond.#1\endcsname = 1
3631 \makecond{iftex}
3632 \makecond{ifnotdocbook}
3633 \makecond{ifnothtml}
3634 \makecond{ifnotinfo}
3635 \makecond{ifnotplaintext}
3636 \makecond{ifnotxml}
3638 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3640 \def\direntry{\doignore{direntry}}
3641 \def\documentdescription{\doignore{documentdescription}}
3642 \def\docbook{\doignore{docbook}}
3643 \def\html{\doignore{html}}
3644 \def\ifdocbook{\doignore{ifdocbook}}
3645 \def\ifhtml{\doignore{ifhtml}}
3646 \def\ifinfo{\doignore{ifinfo}}
3647 \def\ifnottex{\doignore{ifnottex}}
3648 \def\ifplaintext{\doignore{ifplaintext}}
3649 \def\ifxml{\doignore{ifxml}}
3650 \def\ignore{\doignore{ignore}}
3651 \def\menu{\doignore{menu}}
3652 \def\xml{\doignore{xml}}
3654 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3656 % A count to remember the depth of nesting.
3657 \newcount\doignorecount
3659 \def\doignore#1{\begingroup
3660 % Scan in ``verbatim'' mode:
3661 \obeylines
3662 \catcode`\@ = \other
3663 \catcode`\{ = \other
3664 \catcode`\} = \other
3666 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3667 \spaceisspace
3669 % Count number of #1's that we've seen.
3670 \doignorecount = 0
3672 % Swallow text until we reach the matching `@end #1'.
3673 \dodoignore{#1}%
3676 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3677 \obeylines %
3679 \gdef\dodoignore#1{%
3680 % #1 contains the command name as a string, e.g., `ifinfo'.
3682 % Define a command to find the next `@end #1'.
3683 \long\def\doignoretext##1^^M@end #1{%
3684 \doignoretextyyy##1^^M@#1\_STOP_}%
3686 % And this command to find another #1 command, at the beginning of a
3687 % line. (Otherwise, we would consider a line `@c @ifset', for
3688 % example, to count as an @ifset for nesting.)
3689 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3691 % And now expand that command.
3692 \doignoretext ^^M%
3696 \def\doignoreyyy#1{%
3697 \def\temp{#1}%
3698 \ifx\temp\empty % Nothing found.
3699 \let\next\doignoretextzzz
3700 \else % Found a nested condition, ...
3701 \advance\doignorecount by 1
3702 \let\next\doignoretextyyy % ..., look for another.
3703 % If we're here, #1 ends with ^^M\ifinfo (for example).
3705 \next #1% the token \_STOP_ is present just after this macro.
3708 % We have to swallow the remaining "\_STOP_".
3710 \def\doignoretextzzz#1{%
3711 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3712 \let\next\enddoignore
3713 \else % Still inside a nested condition.
3714 \advance\doignorecount by -1
3715 \let\next\doignoretext % Look for the next @end.
3717 \next
3720 % Finish off ignored text.
3721 { \obeylines%
3722 % Ignore anything after the last `@end #1'; this matters in verbatim
3723 % environments, where otherwise the newline after an ignored conditional
3724 % would result in a blank line in the output.
3725 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3729 % @set VAR sets the variable VAR to an empty value.
3730 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3732 % Since we want to separate VAR from REST-OF-LINE (which might be
3733 % empty), we can't just use \parsearg; we have to insert a space of our
3734 % own to delimit the rest of the line, and then take it out again if we
3735 % didn't need it.
3736 % We rely on the fact that \parsearg sets \catcode`\ =10.
3738 \parseargdef\set{\setyyy#1 \endsetyyy}
3739 \def\setyyy#1 #2\endsetyyy{%
3741 \makevalueexpandable
3742 \def\temp{#2}%
3743 \edef\next{\gdef\makecsname{SET#1}}%
3744 \ifx\temp\empty
3745 \next{}%
3746 \else
3747 \setzzz#2\endsetzzz
3751 % Remove the trailing space \setxxx inserted.
3752 \def\setzzz#1 \endsetzzz{\next{#1}}
3754 % @clear VAR clears (i.e., unsets) the variable VAR.
3756 \parseargdef\clear{%
3758 \makevalueexpandable
3759 \global\expandafter\let\csname SET#1\endcsname=\relax
3763 % @value{foo} gets the text saved in variable foo.
3764 \def\value{\begingroup\makevalueexpandable\valuexxx}
3765 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3767 \catcode`\- = \active \catcode`\_ = \active
3769 \gdef\makevalueexpandable{%
3770 \let\value = \expandablevalue
3771 % We don't want these characters active, ...
3772 \catcode`\-=\other \catcode`\_=\other
3773 % ..., but we might end up with active ones in the argument if
3774 % we're called from @code, as @code{@value{foo-bar_}}, though.
3775 % So \let them to their normal equivalents.
3776 \let-\realdash \let_\normalunderscore
3780 % We have this subroutine so that we can handle at least some @value's
3781 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3782 % The command has to be fully expandable (if the variable is set), since
3783 % the result winds up in the index file. This means that if the
3784 % variable's value contains other Texinfo commands, it's almost certain
3785 % it will fail (although perhaps we could fix that with sufficient work
3786 % to do a one-level expansion on the result, instead of complete).
3788 \def\expandablevalue#1{%
3789 \expandafter\ifx\csname SET#1\endcsname\relax
3790 {[No value for ``#1'']}%
3791 \message{Variable `#1', used in @value, is not set.}%
3792 \else
3793 \csname SET#1\endcsname
3797 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3798 % with @set.
3800 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3802 \makecond{ifset}
3803 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3804 \def\doifset#1#2{%
3806 \makevalueexpandable
3807 \let\next=\empty
3808 \expandafter\ifx\csname SET#2\endcsname\relax
3809 #1% If not set, redefine \next.
3811 \expandafter
3812 }\next
3814 \def\ifsetfail{\doignore{ifset}}
3816 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3817 % defined with @set, or has been undefined with @clear.
3819 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3820 % above code: if the variable is not set, do nothing, if it is set,
3821 % then redefine \next to \ifclearfail.
3823 \makecond{ifclear}
3824 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3825 \def\ifclearfail{\doignore{ifclear}}
3827 % @dircategory CATEGORY -- specify a category of the dir file
3828 % which this file should belong to. Ignore this in TeX.
3829 \let\dircategory=\comment
3831 % @defininfoenclose.
3832 \let\definfoenclose=\comment
3835 \message{indexing,}
3836 % Index generation facilities
3838 % Define \newwrite to be identical to plain tex's \newwrite
3839 % except not \outer, so it can be used within macros and \if's.
3840 \edef\newwrite{\makecsname{ptexnewwrite}}
3842 % \newindex {foo} defines an index named foo.
3843 % It automatically defines \fooindex such that
3844 % \fooindex ...rest of line... puts an entry in the index foo.
3845 % It also defines \fooindfile to be the number of the output channel for
3846 % the file that accumulates this index. The file's extension is foo.
3847 % The name of an index should be no more than 2 characters long
3848 % for the sake of vms.
3850 \def\newindex#1{%
3851 \iflinks
3852 \expandafter\newwrite \csname#1indfile\endcsname
3853 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3855 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3856 \noexpand\doindex{#1}}
3859 % @defindex foo == \newindex{foo}
3861 \def\defindex{\parsearg\newindex}
3863 % Define @defcodeindex, like @defindex except put all entries in @code.
3865 \def\defcodeindex{\parsearg\newcodeindex}
3867 \def\newcodeindex#1{%
3868 \iflinks
3869 \expandafter\newwrite \csname#1indfile\endcsname
3870 \openout \csname#1indfile\endcsname \jobname.#1
3872 \expandafter\xdef\csname#1index\endcsname{%
3873 \noexpand\docodeindex{#1}}%
3877 % @synindex foo bar makes index foo feed into index bar.
3878 % Do this instead of @defindex foo if you don't want it as a separate index.
3880 % @syncodeindex foo bar similar, but put all entries made for index foo
3881 % inside @code.
3883 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3884 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3886 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3887 % #3 the target index (bar).
3888 \def\dosynindex#1#2#3{%
3889 % Only do \closeout if we haven't already done it, else we'll end up
3890 % closing the target index.
3891 \expandafter \ifx\csname donesynindex#2\endcsname \relax
3892 % The \closeout helps reduce unnecessary open files; the limit on the
3893 % Acorn RISC OS is a mere 16 files.
3894 \expandafter\closeout\csname#2indfile\endcsname
3895 \expandafter\let\csname donesynindex#2\endcsname = 1
3897 % redefine \fooindfile:
3898 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3899 \expandafter\let\csname#2indfile\endcsname=\temp
3900 % redefine \fooindex:
3901 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3904 % Define \doindex, the driver for all \fooindex macros.
3905 % Argument #1 is generated by the calling \fooindex macro,
3906 % and it is "foo", the name of the index.
3908 % \doindex just uses \parsearg; it calls \doind for the actual work.
3909 % This is because \doind is more useful to call from other macros.
3911 % There is also \dosubind {index}{topic}{subtopic}
3912 % which makes an entry in a two-level index such as the operation index.
3914 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3915 \def\singleindexer #1{\doind{\indexname}{#1}}
3917 % like the previous two, but they put @code around the argument.
3918 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3919 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3921 % Take care of Texinfo commands that can appear in an index entry.
3922 % Since there are some commands we want to expand, and others we don't,
3923 % we have to laboriously prevent expansion for those that we don't.
3925 \def\indexdummies{%
3926 \escapechar = `\\ % use backslash in output files.
3927 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3928 \def\ {\realbackslash\space }%
3930 % Need these in case \tex is in effect and \{ is a \delimiter again.
3931 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3932 % braces and backslashes are used only as delimiters.
3933 \let\{ = \mylbrace
3934 \let\} = \myrbrace
3936 % I don't entirely understand this, but when an index entry is
3937 % generated from a macro call, the \endinput which \scanmacro inserts
3938 % causes processing to be prematurely terminated. This is,
3939 % apparently, because \indexsorttmp is fully expanded, and \endinput
3940 % is an expandable command. The redefinition below makes \endinput
3941 % disappear altogether for that purpose -- although logging shows that
3942 % processing continues to some further point. On the other hand, it
3943 % seems \endinput does not hurt in the printed index arg, since that
3944 % is still getting written without apparent harm.
3946 % Sample source (mac-idx3.tex, reported by Graham Percival to
3947 % help-texinfo, 22may06):
3948 % @macro funindex {WORD}
3949 % @findex xyz
3950 % @end macro
3951 % ...
3952 % @funindex commtest
3954 % The above is not enough to reproduce the bug, but it gives the flavor.
3956 % Sample whatsit resulting:
3957 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
3959 % So:
3960 \let\endinput = \empty
3962 % Do the redefinitions.
3963 \commondummies
3966 % For the aux and toc files, @ is the escape character. So we want to
3967 % redefine everything using @ as the escape character (instead of
3968 % \realbackslash, still used for index files). When everything uses @,
3969 % this will be simpler.
3971 \def\atdummies{%
3972 \def\@{@@}%
3973 \def\ {@ }%
3974 \let\{ = \lbraceatcmd
3975 \let\} = \rbraceatcmd
3977 % Do the redefinitions.
3978 \commondummies
3979 \otherbackslash
3982 % Called from \indexdummies and \atdummies.
3984 \def\commondummies{%
3986 % \definedummyword defines \#1 as \string\#1\space, thus effectively
3987 % preventing its expansion. This is used only for control% words,
3988 % not control letters, because the \space would be incorrect for
3989 % control characters, but is needed to separate the control word
3990 % from whatever follows.
3992 % For control letters, we have \definedummyletter, which omits the
3993 % space.
3995 % These can be used both for control words that take an argument and
3996 % those that do not. If it is followed by {arg} in the input, then
3997 % that will dutifully get written to the index (or wherever).
3999 \def\definedummyword ##1{\def##1{\string##1\space}}%
4000 \def\definedummyletter##1{\def##1{\string##1}}%
4001 \let\definedummyaccent\definedummyletter
4003 \commondummiesnofonts
4005 \definedummyletter\_%
4007 % Non-English letters.
4008 \definedummyword\AA
4009 \definedummyword\AE
4010 \definedummyword\L
4011 \definedummyword\OE
4012 \definedummyword\O
4013 \definedummyword\aa
4014 \definedummyword\ae
4015 \definedummyword\l
4016 \definedummyword\oe
4017 \definedummyword\o
4018 \definedummyword\ss
4019 \definedummyword\exclamdown
4020 \definedummyword\questiondown
4021 \definedummyword\ordf
4022 \definedummyword\ordm
4024 % Although these internal commands shouldn't show up, sometimes they do.
4025 \definedummyword\bf
4026 \definedummyword\gtr
4027 \definedummyword\hat
4028 \definedummyword\less
4029 \definedummyword\sf
4030 \definedummyword\sl
4031 \definedummyword\tclose
4032 \definedummyword\tt
4034 \definedummyword\LaTeX
4035 \definedummyword\TeX
4037 % Assorted special characters.
4038 \definedummyword\bullet
4039 \definedummyword\comma
4040 \definedummyword\copyright
4041 \definedummyword\registeredsymbol
4042 \definedummyword\dots
4043 \definedummyword\enddots
4044 \definedummyword\equiv
4045 \definedummyword\error
4046 \definedummyword\euro
4047 \definedummyword\guillemetleft
4048 \definedummyword\guillemetright
4049 \definedummyword\guilsinglleft
4050 \definedummyword\guilsinglright
4051 \definedummyword\expansion
4052 \definedummyword\minus
4053 \definedummyword\pounds
4054 \definedummyword\point
4055 \definedummyword\print
4056 \definedummyword\quotedblbase
4057 \definedummyword\quotedblleft
4058 \definedummyword\quotedblright
4059 \definedummyword\quoteleft
4060 \definedummyword\quoteright
4061 \definedummyword\quotesinglbase
4062 \definedummyword\result
4063 \definedummyword\textdegree
4065 % We want to disable all macros so that they are not expanded by \write.
4066 \macrolist
4068 \normalturnoffactive
4070 % Handle some cases of @value -- where it does not contain any
4071 % (non-fully-expandable) commands.
4072 \makevalueexpandable
4075 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4077 \def\commondummiesnofonts{%
4078 % Control letters and accents.
4079 \definedummyletter\!%
4080 \definedummyaccent\"%
4081 \definedummyaccent\'%
4082 \definedummyletter\*%
4083 \definedummyaccent\,%
4084 \definedummyletter\.%
4085 \definedummyletter\/%
4086 \definedummyletter\:%
4087 \definedummyaccent\=%
4088 \definedummyletter\?%
4089 \definedummyaccent\^%
4090 \definedummyaccent\`%
4091 \definedummyaccent\~%
4092 \definedummyword\u
4093 \definedummyword\v
4094 \definedummyword\H
4095 \definedummyword\dotaccent
4096 \definedummyword\ringaccent
4097 \definedummyword\tieaccent
4098 \definedummyword\ubaraccent
4099 \definedummyword\udotaccent
4100 \definedummyword\dotless
4102 % Texinfo font commands.
4103 \definedummyword\b
4104 \definedummyword\i
4105 \definedummyword\r
4106 \definedummyword\sc
4107 \definedummyword\t
4109 % Commands that take arguments.
4110 \definedummyword\acronym
4111 \definedummyword\cite
4112 \definedummyword\code
4113 \definedummyword\command
4114 \definedummyword\dfn
4115 \definedummyword\emph
4116 \definedummyword\env
4117 \definedummyword\file
4118 \definedummyword\kbd
4119 \definedummyword\key
4120 \definedummyword\math
4121 \definedummyword\option
4122 \definedummyword\pxref
4123 \definedummyword\ref
4124 \definedummyword\samp
4125 \definedummyword\strong
4126 \definedummyword\tie
4127 \definedummyword\uref
4128 \definedummyword\url
4129 \definedummyword\var
4130 \definedummyword\verb
4131 \definedummyword\w
4132 \definedummyword\xref
4135 % \indexnofonts is used when outputting the strings to sort the index
4136 % by, and when constructing control sequence names. It eliminates all
4137 % control sequences and just writes whatever the best ASCII sort string
4138 % would be for a given command (usually its argument).
4140 \def\indexnofonts{%
4141 % Accent commands should become @asis.
4142 \def\definedummyaccent##1{\let##1\asis}%
4143 % We can just ignore other control letters.
4144 \def\definedummyletter##1{\let##1\empty}%
4145 % Hopefully, all control words can become @asis.
4146 \let\definedummyword\definedummyaccent
4148 \commondummiesnofonts
4150 % Don't no-op \tt, since it isn't a user-level command
4151 % and is used in the definitions of the active chars like <, >, |, etc.
4152 % Likewise with the other plain tex font commands.
4153 %\let\tt=\asis
4155 \def\ { }%
4156 \def\@{@}%
4157 % how to handle braces?
4158 \def\_{\normalunderscore}%
4160 % Non-English letters.
4161 \def\AA{AA}%
4162 \def\AE{AE}%
4163 \def\L{L}%
4164 \def\OE{OE}%
4165 \def\O{O}%
4166 \def\aa{aa}%
4167 \def\ae{ae}%
4168 \def\l{l}%
4169 \def\oe{oe}%
4170 \def\o{o}%
4171 \def\ss{ss}%
4172 \def\exclamdown{!}%
4173 \def\questiondown{?}%
4174 \def\ordf{a}%
4175 \def\ordm{o}%
4177 \def\LaTeX{LaTeX}%
4178 \def\TeX{TeX}%
4180 % Assorted special characters.
4181 % (The following {} will end up in the sort string, but that's ok.)
4182 \def\bullet{bullet}%
4183 \def\comma{,}%
4184 \def\copyright{copyright}%
4185 \def\registeredsymbol{R}%
4186 \def\dots{...}%
4187 \def\enddots{...}%
4188 \def\equiv{==}%
4189 \def\error{error}%
4190 \def\euro{euro}%
4191 \def\guillemetleft{<<}%
4192 \def\guillemetright{>>}%
4193 \def\guilsinglleft{<}%
4194 \def\guilsinglright{>}%
4195 \def\expansion{==>}%
4196 \def\minus{-}%
4197 \def\pounds{pounds}%
4198 \def\point{.}%
4199 \def\print{-|}%
4200 \def\quotedblbase{"}%
4201 \def\quotedblleft{"}%
4202 \def\quotedblright{"}%
4203 \def\quoteleft{`}%
4204 \def\quoteright{'}%
4205 \def\quotesinglbase{,}%
4206 \def\result{=>}%
4207 \def\textdegree{degrees}%
4209 % We need to get rid of all macros, leaving only the arguments (if present).
4210 % Of course this is not nearly correct, but it is the best we can do for now.
4211 % makeinfo does not expand macros in the argument to @deffn, which ends up
4212 % writing an index entry, and texindex isn't prepared for an index sort entry
4213 % that starts with \.
4215 % Since macro invocations are followed by braces, we can just redefine them
4216 % to take a single TeX argument. The case of a macro invocation that
4217 % goes to end-of-line is not handled.
4219 \macrolist
4222 \let\indexbackslash=0 %overridden during \printindex.
4223 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4225 % Most index entries go through here, but \dosubind is the general case.
4226 % #1 is the index name, #2 is the entry text.
4227 \def\doind#1#2{\dosubind{#1}{#2}{}}
4229 % Workhorse for all \fooindexes.
4230 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4231 % empty if called from \doind, as we usually are (the main exception
4232 % is with most defuns, which call us directly).
4234 \def\dosubind#1#2#3{%
4235 \iflinks
4237 % Store the main index entry text (including the third arg).
4238 \toks0 = {#2}%
4239 % If third arg is present, precede it with a space.
4240 \def\thirdarg{#3}%
4241 \ifx\thirdarg\empty \else
4242 \toks0 = \expandafter{\the\toks0 \space #3}%
4245 \edef\writeto{\csname#1indfile\endcsname}%
4247 \safewhatsit\dosubindwrite
4252 % Write the entry in \toks0 to the index file:
4254 \def\dosubindwrite{%
4255 % Put the index entry in the margin if desired.
4256 \ifx\SETmarginindex\relax\else
4257 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4260 % Remember, we are within a group.
4261 \indexdummies % Must do this here, since \bf, etc expand at this stage
4262 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4263 % so it will be output as is; and it will print as backslash.
4265 % Process the index entry with all font commands turned off, to
4266 % get the string to sort by.
4267 {\indexnofonts
4268 \edef\temp{\the\toks0}% need full expansion
4269 \xdef\indexsorttmp{\temp}%
4272 % Set up the complete index entry, with both the sort key and
4273 % the original text, including any font commands. We write
4274 % three arguments to \entry to the .?? file (four in the
4275 % subentry case), texindex reduces to two when writing the .??s
4276 % sorted result.
4277 \edef\temp{%
4278 \write\writeto{%
4279 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4281 \temp
4284 % Take care of unwanted page breaks/skips around a whatsit:
4286 % If a skip is the last thing on the list now, preserve it
4287 % by backing up by \lastskip, doing the \write, then inserting
4288 % the skip again. Otherwise, the whatsit generated by the
4289 % \write or \pdfdest will make \lastskip zero. The result is that
4290 % sequences like this:
4291 % @end defun
4292 % @tindex whatever
4293 % @defun ...
4294 % will have extra space inserted, because the \medbreak in the
4295 % start of the @defun won't see the skip inserted by the @end of
4296 % the previous defun.
4298 % But don't do any of this if we're not in vertical mode. We
4299 % don't want to do a \vskip and prematurely end a paragraph.
4301 % Avoid page breaks due to these extra skips, too.
4303 % But wait, there is a catch there:
4304 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4305 % sufficient for this purpose, as it ignores stretch and shrink parts
4306 % of the skip. The only way seems to be to check the textual
4307 % representation of the skip.
4309 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4310 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4312 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4314 \newskip\whatsitskip
4315 \newcount\whatsitpenalty
4317 % ..., ready, GO:
4319 \def\safewhatsit#1{%
4320 \ifhmode
4322 \else
4323 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4324 \whatsitskip = \lastskip
4325 \edef\lastskipmacro{\the\lastskip}%
4326 \whatsitpenalty = \lastpenalty
4328 % If \lastskip is nonzero, that means the last item was a
4329 % skip. And since a skip is discardable, that means this
4330 % -\whatsitskip glue we're inserting is preceded by a
4331 % non-discardable item, therefore it is not a potential
4332 % breakpoint, therefore no \nobreak needed.
4333 \ifx\lastskipmacro\zeroskipmacro
4334 \else
4335 \vskip-\whatsitskip
4340 \ifx\lastskipmacro\zeroskipmacro
4341 % If \lastskip was zero, perhaps the last item was a penalty, and
4342 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4343 % to re-insert the same penalty (values >10000 are used for various
4344 % signals); since we just inserted a non-discardable item, any
4345 % following glue (such as a \parskip) would be a breakpoint. For example:
4347 % @deffn deffn-whatever
4348 % @vindex index-whatever
4349 % Description.
4350 % would allow a break between the index-whatever whatsit
4351 % and the "Description." paragraph.
4352 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4353 \else
4354 % On the other hand, if we had a nonzero \lastskip,
4355 % this make-up glue would be preceded by a non-discardable item
4356 % (the whatsit from the \write), so we must insert a \nobreak.
4357 \nobreak\vskip\whatsitskip
4362 % The index entry written in the file actually looks like
4363 % \entry {sortstring}{page}{topic}
4364 % or
4365 % \entry {sortstring}{page}{topic}{subtopic}
4366 % The texindex program reads in these files and writes files
4367 % containing these kinds of lines:
4368 % \initial {c}
4369 % before the first topic whose initial is c
4370 % \entry {topic}{pagelist}
4371 % for a topic that is used without subtopics
4372 % \primary {topic}
4373 % for the beginning of a topic that is used with subtopics
4374 % \secondary {subtopic}{pagelist}
4375 % for each subtopic.
4377 % Define the user-accessible indexing commands
4378 % @findex, @vindex, @kindex, @cindex.
4380 \def\findex {\fnindex}
4381 \def\kindex {\kyindex}
4382 \def\cindex {\cpindex}
4383 \def\vindex {\vrindex}
4384 \def\tindex {\tpindex}
4385 \def\pindex {\pgindex}
4387 \def\cindexsub {\begingroup\obeylines\cindexsub}
4388 {\obeylines %
4389 \gdef\cindexsub "#1" #2^^M{\endgroup %
4390 \dosubind{cp}{#2}{#1}}}
4392 % Define the macros used in formatting output of the sorted index material.
4394 % @printindex causes a particular index (the ??s file) to get printed.
4395 % It does not print any chapter heading (usually an @unnumbered).
4397 \parseargdef\printindex{\begingroup
4398 \dobreak \chapheadingskip{10000}%
4400 \smallfonts \rm
4401 \tolerance = 9500
4402 \plainfrenchspacing
4403 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4405 % See if the index file exists and is nonempty.
4406 % Change catcode of @ here so that if the index file contains
4407 % \initial {@}
4408 % as its first line, TeX doesn't complain about mismatched braces
4409 % (because it thinks @} is a control sequence).
4410 \catcode`\@ = 11
4411 \openin 1 \jobname.#1s
4412 \ifeof 1
4413 % \enddoublecolumns gets confused if there is no text in the index,
4414 % and it loses the chapter title and the aux file entries for the
4415 % index. The easiest way to prevent this problem is to make sure
4416 % there is some text.
4417 \putwordIndexNonexistent
4418 \else
4420 % If the index file exists but is empty, then \openin leaves \ifeof
4421 % false. We have to make TeX try to read something from the file, so
4422 % it can discover if there is anything in it.
4423 \read 1 to \temp
4424 \ifeof 1
4425 \putwordIndexIsEmpty
4426 \else
4427 % Index files are almost Texinfo source, but we use \ as the escape
4428 % character. It would be better to use @, but that's too big a change
4429 % to make right now.
4430 \def\indexbackslash{\backslashcurfont}%
4431 \catcode`\\ = 0
4432 \escapechar = `\\
4433 \begindoublecolumns
4434 \input \jobname.#1s
4435 \enddoublecolumns
4438 \closein 1
4439 \endgroup}
4441 % These macros are used by the sorted index file itself.
4442 % Change them to control the appearance of the index.
4444 \def\initial#1{{%
4445 % Some minor font changes for the special characters.
4446 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4448 % Remove any glue we may have, we'll be inserting our own.
4449 \removelastskip
4451 % We like breaks before the index initials, so insert a bonus.
4452 \nobreak
4453 \vskip 0pt plus 3\baselineskip
4454 \penalty 0
4455 \vskip 0pt plus -3\baselineskip
4457 % Typeset the initial. Making this add up to a whole number of
4458 % baselineskips increases the chance of the dots lining up from column
4459 % to column. It still won't often be perfect, because of the stretch
4460 % we need before each entry, but it's better.
4462 % No shrink because it confuses \balancecolumns.
4463 \vskip 1.67\baselineskip plus .5\baselineskip
4464 \leftline{\secbf #1}%
4465 % Do our best not to break after the initial.
4466 \nobreak
4467 \vskip .33\baselineskip plus .1\baselineskip
4470 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4471 % then page number (#2) flushed to the right margin. It is used for index
4472 % and table of contents entries. The paragraph is indented by \leftskip.
4474 % A straightforward implementation would start like this:
4475 % \def\entry#1#2{...
4476 % But this freezes the catcodes in the argument, and can cause problems to
4477 % @code, which sets - active. This problem was fixed by a kludge---
4478 % ``-'' was active throughout whole index, but this isn't really right.
4480 % The right solution is to prevent \entry from swallowing the whole text.
4481 % --kasal, 21nov03
4482 \def\entry{%
4483 \begingroup
4485 % Start a new paragraph if necessary, so our assignments below can't
4486 % affect previous text.
4487 \par
4489 % Do not fill out the last line with white space.
4490 \parfillskip = 0in
4492 % No extra space above this paragraph.
4493 \parskip = 0in
4495 % Do not prefer a separate line ending with a hyphen to fewer lines.
4496 \finalhyphendemerits = 0
4498 % \hangindent is only relevant when the entry text and page number
4499 % don't both fit on one line. In that case, bob suggests starting the
4500 % dots pretty far over on the line. Unfortunately, a large
4501 % indentation looks wrong when the entry text itself is broken across
4502 % lines. So we use a small indentation and put up with long leaders.
4504 % \hangafter is reset to 1 (which is the value we want) at the start
4505 % of each paragraph, so we need not do anything with that.
4506 \hangindent = 2em
4508 % When the entry text needs to be broken, just fill out the first line
4509 % with blank space.
4510 \rightskip = 0pt plus1fil
4512 % A bit of stretch before each entry for the benefit of balancing
4513 % columns.
4514 \vskip 0pt plus1pt
4516 % Swallow the left brace of the text (first parameter):
4517 \afterassignment\doentry
4518 \let\temp =
4520 \def\doentry{%
4521 \bgroup % Instead of the swallowed brace.
4522 \noindent
4523 \aftergroup\finishentry
4524 % And now comes the text of the entry.
4526 \def\finishentry#1{%
4527 % #1 is the page number.
4529 % The following is kludged to not output a line of dots in the index if
4530 % there are no page numbers. The next person who breaks this will be
4531 % cursed by a Unix daemon.
4532 \setbox\boxA = \hbox{#1}%
4533 \ifdim\wd\boxA = 0pt
4535 \else
4537 % If we must, put the page number on a line of its own, and fill out
4538 % this line with blank space. (The \hfil is overwhelmed with the
4539 % fill leaders glue in \indexdotfill if the page number does fit.)
4540 \hfil\penalty50
4541 \null\nobreak\indexdotfill % Have leaders before the page number.
4543 % The `\ ' here is removed by the implicit \unskip that TeX does as
4544 % part of (the primitive) \par. Without it, a spurious underfull
4545 % \hbox ensues.
4546 \ifpdf
4547 \pdfgettoks#1.%
4548 \ \the\toksA
4549 \else
4550 \ #1%
4553 \par
4554 \endgroup
4557 % Like plain.tex's \dotfill, except uses up at least 1 em.
4558 \def\indexdotfill{\cleaders
4559 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4561 \def\primary #1{\line{#1\hfil}}
4563 \newskip\secondaryindent \secondaryindent=0.5cm
4564 \def\secondary#1#2{{%
4565 \parfillskip=0in
4566 \parskip=0in
4567 \hangindent=1in
4568 \hangafter=1
4569 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4570 \ifpdf
4571 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4572 \else
4575 \par
4578 % Define two-column mode, which we use to typeset indexes.
4579 % Adapted from the TeXbook, page 416, which is to say,
4580 % the manmac.tex format used to print the TeXbook itself.
4581 \catcode`\@=11
4583 \newbox\partialpage
4584 \newdimen\doublecolumnhsize
4586 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4587 % Grab any single-column material above us.
4588 \output = {%
4590 % Here is a possibility not foreseen in manmac: if we accumulate a
4591 % whole lot of material, we might end up calling this \output
4592 % routine twice in a row (see the doublecol-lose test, which is
4593 % essentially a couple of indexes with @setchapternewpage off). In
4594 % that case we just ship out what is in \partialpage with the normal
4595 % output routine. Generally, \partialpage will be empty when this
4596 % runs and this will be a no-op. See the indexspread.tex test case.
4597 \ifvoid\partialpage \else
4598 \onepageout{\pagecontents\partialpage}%
4601 \global\setbox\partialpage = \vbox{%
4602 % Unvbox the main output page.
4603 \unvbox\PAGE
4604 \kern-\topskip \kern\baselineskip
4607 \eject % run that output routine to set \partialpage
4609 % Use the double-column output routine for subsequent pages.
4610 \output = {\doublecolumnout}%
4612 % Change the page size parameters. We could do this once outside this
4613 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4614 % format, but then we repeat the same computation. Repeating a couple
4615 % of assignments once per index is clearly meaningless for the
4616 % execution time, so we may as well do it in one place.
4618 % First we halve the line length, less a little for the gutter between
4619 % the columns. We compute the gutter based on the line length, so it
4620 % changes automatically with the paper format. The magic constant
4621 % below is chosen so that the gutter has the same value (well, +-<1pt)
4622 % as it did when we hard-coded it.
4624 % We put the result in a separate register, \doublecolumhsize, so we
4625 % can restore it in \pagesofar, after \hsize itself has (potentially)
4626 % been clobbered.
4628 \doublecolumnhsize = \hsize
4629 \advance\doublecolumnhsize by -.04154\hsize
4630 \divide\doublecolumnhsize by 2
4631 \hsize = \doublecolumnhsize
4633 % Double the \vsize as well. (We don't need a separate register here,
4634 % since nobody clobbers \vsize.)
4635 \vsize = 2\vsize
4638 % The double-column output routine for all double-column pages except
4639 % the last.
4641 \def\doublecolumnout{%
4642 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4643 % Get the available space for the double columns -- the normal
4644 % (undoubled) page height minus any material left over from the
4645 % previous page.
4646 \dimen@ = \vsize
4647 \divide\dimen@ by 2
4648 \advance\dimen@ by -\ht\partialpage
4650 % box0 will be the left-hand column, box2 the right.
4651 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4652 \onepageout\pagesofar
4653 \unvbox255
4654 \penalty\outputpenalty
4657 % Re-output the contents of the output page -- any previous material,
4658 % followed by the two boxes we just split, in box0 and box2.
4659 \def\pagesofar{%
4660 \unvbox\partialpage
4662 \hsize = \doublecolumnhsize
4663 \wd0=\hsize \wd2=\hsize
4664 \hbox to\pagewidth{\box0\hfil\box2}%
4667 % All done with double columns.
4668 \def\enddoublecolumns{%
4669 % The following penalty ensures that the page builder is exercised
4670 % _before_ we change the output routine. This is necessary in the
4671 % following situation:
4673 % The last section of the index consists only of a single entry.
4674 % Before this section, \pagetotal is less than \pagegoal, so no
4675 % break occurs before the last section starts. However, the last
4676 % section, consisting of \initial and the single \entry, does not
4677 % fit on the page and has to be broken off. Without the following
4678 % penalty the page builder will not be exercised until \eject
4679 % below, and by that time we'll already have changed the output
4680 % routine to the \balancecolumns version, so the next-to-last
4681 % double-column page will be processed with \balancecolumns, which
4682 % is wrong: The two columns will go to the main vertical list, with
4683 % the broken-off section in the recent contributions. As soon as
4684 % the output routine finishes, TeX starts reconsidering the page
4685 % break. The two columns and the broken-off section both fit on the
4686 % page, because the two columns now take up only half of the page
4687 % goal. When TeX sees \eject from below which follows the final
4688 % section, it invokes the new output routine that we've set after
4689 % \balancecolumns below; \onepageout will try to fit the two columns
4690 % and the final section into the vbox of \pageheight (see
4691 % \pagebody), causing an overfull box.
4693 % Note that glue won't work here, because glue does not exercise the
4694 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4695 \penalty0
4697 \output = {%
4698 % Split the last of the double-column material. Leave it on the
4699 % current page, no automatic page break.
4700 \balancecolumns
4702 % If we end up splitting too much material for the current page,
4703 % though, there will be another page break right after this \output
4704 % invocation ends. Having called \balancecolumns once, we do not
4705 % want to call it again. Therefore, reset \output to its normal
4706 % definition right away. (We hope \balancecolumns will never be
4707 % called on to balance too much material, but if it is, this makes
4708 % the output somewhat more palatable.)
4709 \global\output = {\onepageout{\pagecontents\PAGE}}%
4711 \eject
4712 \endgroup % started in \begindoublecolumns
4714 % \pagegoal was set to the doubled \vsize above, since we restarted
4715 % the current page. We're now back to normal single-column
4716 % typesetting, so reset \pagegoal to the normal \vsize (after the
4717 % \endgroup where \vsize got restored).
4718 \pagegoal = \vsize
4721 % Called at the end of the double column material.
4722 \def\balancecolumns{%
4723 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4724 \dimen@ = \ht0
4725 \advance\dimen@ by \topskip
4726 \advance\dimen@ by-\baselineskip
4727 \divide\dimen@ by 2 % target to split to
4728 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4729 \splittopskip = \topskip
4730 % Loop until we get a decent breakpoint.
4732 \vbadness = 10000
4733 \loop
4734 \global\setbox3 = \copy0
4735 \global\setbox1 = \vsplit3 to \dimen@
4736 \ifdim\ht3>\dimen@
4737 \global\advance\dimen@ by 1pt
4738 \repeat
4740 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4741 \setbox0=\vbox to\dimen@{\unvbox1}%
4742 \setbox2=\vbox to\dimen@{\unvbox3}%
4744 \pagesofar
4746 \catcode`\@ = \other
4749 \message{sectioning,}
4750 % Chapters, sections, etc.
4752 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4753 % sections so that we can refer to them unambiguously in the pdf
4754 % outlines by their "section number". We avoid collisions with chapter
4755 % numbers by starting them at 10000. (If a document ever has 10000
4756 % chapters, we're in trouble anyway, I'm sure.)
4757 \newcount\unnumberedno \unnumberedno = 10000
4758 \newcount\chapno
4759 \newcount\secno \secno=0
4760 \newcount\subsecno \subsecno=0
4761 \newcount\subsubsecno \subsubsecno=0
4763 % This counter is funny since it counts through charcodes of letters A, B, ...
4764 \newcount\appendixno \appendixno = `\@
4766 % \def\appendixletter{\char\the\appendixno}
4767 % We do the following ugly conditional instead of the above simple
4768 % construct for the sake of pdftex, which needs the actual
4769 % letter in the expansion, not just typeset.
4771 \def\appendixletter{%
4772 \ifnum\appendixno=`A A%
4773 \else\ifnum\appendixno=`B B%
4774 \else\ifnum\appendixno=`C C%
4775 \else\ifnum\appendixno=`D D%
4776 \else\ifnum\appendixno=`E E%
4777 \else\ifnum\appendixno=`F F%
4778 \else\ifnum\appendixno=`G G%
4779 \else\ifnum\appendixno=`H H%
4780 \else\ifnum\appendixno=`I I%
4781 \else\ifnum\appendixno=`J J%
4782 \else\ifnum\appendixno=`K K%
4783 \else\ifnum\appendixno=`L L%
4784 \else\ifnum\appendixno=`M M%
4785 \else\ifnum\appendixno=`N N%
4786 \else\ifnum\appendixno=`O O%
4787 \else\ifnum\appendixno=`P P%
4788 \else\ifnum\appendixno=`Q Q%
4789 \else\ifnum\appendixno=`R R%
4790 \else\ifnum\appendixno=`S S%
4791 \else\ifnum\appendixno=`T T%
4792 \else\ifnum\appendixno=`U U%
4793 \else\ifnum\appendixno=`V V%
4794 \else\ifnum\appendixno=`W W%
4795 \else\ifnum\appendixno=`X X%
4796 \else\ifnum\appendixno=`Y Y%
4797 \else\ifnum\appendixno=`Z Z%
4798 % The \the is necessary, despite appearances, because \appendixletter is
4799 % expanded while writing the .toc file. \char\appendixno is not
4800 % expandable, thus it is written literally, thus all appendixes come out
4801 % with the same letter (or @) in the toc without it.
4802 \else\char\the\appendixno
4803 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4804 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4806 % Each @chapter defines these (using marks) as the number+name, number
4807 % and name of the chapter. Page headings and footings can use
4808 % these. @section does likewise.
4809 \def\thischapter{}
4810 \def\thischapternum{}
4811 \def\thischaptername{}
4812 \def\thissection{}
4813 \def\thissectionnum{}
4814 \def\thissectionname{}
4816 \newcount\absseclevel % used to calculate proper heading level
4817 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4819 % @raisesections: treat @section as chapter, @subsection as section, etc.
4820 \def\raisesections{\global\advance\secbase by -1}
4821 \let\up=\raisesections % original BFox name
4823 % @lowersections: treat @chapter as section, @section as subsection, etc.
4824 \def\lowersections{\global\advance\secbase by 1}
4825 \let\down=\lowersections % original BFox name
4827 % we only have subsub.
4828 \chardef\maxseclevel = 3
4830 % A numbered section within an unnumbered changes to unnumbered too.
4831 % To achive this, remember the "biggest" unnum. sec. we are currently in:
4832 \chardef\unmlevel = \maxseclevel
4834 % Trace whether the current chapter is an appendix or not:
4835 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4836 \def\chapheadtype{N}
4838 % Choose a heading macro
4839 % #1 is heading type
4840 % #2 is heading level
4841 % #3 is text for heading
4842 \def\genhead#1#2#3{%
4843 % Compute the abs. sec. level:
4844 \absseclevel=#2
4845 \advance\absseclevel by \secbase
4846 % Make sure \absseclevel doesn't fall outside the range:
4847 \ifnum \absseclevel < 0
4848 \absseclevel = 0
4849 \else
4850 \ifnum \absseclevel > 3
4851 \absseclevel = 3
4854 % The heading type:
4855 \def\headtype{#1}%
4856 \if \headtype U%
4857 \ifnum \absseclevel < \unmlevel
4858 \chardef\unmlevel = \absseclevel
4860 \else
4861 % Check for appendix sections:
4862 \ifnum \absseclevel = 0
4863 \edef\chapheadtype{\headtype}%
4864 \else
4865 \if \headtype A\if \chapheadtype N%
4866 \errmessage{@appendix... within a non-appendix chapter}%
4867 \fi\fi
4869 % Check for numbered within unnumbered:
4870 \ifnum \absseclevel > \unmlevel
4871 \def\headtype{U}%
4872 \else
4873 \chardef\unmlevel = 3
4876 % Now print the heading:
4877 \if \headtype U%
4878 \ifcase\absseclevel
4879 \unnumberedzzz{#3}%
4880 \or \unnumberedseczzz{#3}%
4881 \or \unnumberedsubseczzz{#3}%
4882 \or \unnumberedsubsubseczzz{#3}%
4884 \else
4885 \if \headtype A%
4886 \ifcase\absseclevel
4887 \appendixzzz{#3}%
4888 \or \appendixsectionzzz{#3}%
4889 \or \appendixsubseczzz{#3}%
4890 \or \appendixsubsubseczzz{#3}%
4892 \else
4893 \ifcase\absseclevel
4894 \chapterzzz{#3}%
4895 \or \seczzz{#3}%
4896 \or \numberedsubseczzz{#3}%
4897 \or \numberedsubsubseczzz{#3}%
4901 \suppressfirstparagraphindent
4904 % an interface:
4905 \def\numhead{\genhead N}
4906 \def\apphead{\genhead A}
4907 \def\unnmhead{\genhead U}
4909 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4910 % all lower-level sectioning counters to zero.
4912 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4913 % (e.g., figures), q.v. By default (before any chapter), that is empty.
4914 \let\chaplevelprefix = \empty
4916 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4917 \def\chapterzzz#1{%
4918 % section resetting is \global in case the chapter is in a group, such
4919 % as an @include file.
4920 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4921 \global\advance\chapno by 1
4923 % Used for \float.
4924 \gdef\chaplevelprefix{\the\chapno.}%
4925 \resetallfloatnos
4927 \message{\putwordChapter\space \the\chapno}%
4929 % Write the actual heading.
4930 \chapmacro{#1}{Ynumbered}{\the\chapno}%
4932 % So @section and the like are numbered underneath this chapter.
4933 \global\let\section = \numberedsec
4934 \global\let\subsection = \numberedsubsec
4935 \global\let\subsubsection = \numberedsubsubsec
4938 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4939 \def\appendixzzz#1{%
4940 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4941 \global\advance\appendixno by 1
4942 \gdef\chaplevelprefix{\appendixletter.}%
4943 \resetallfloatnos
4945 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4946 \message{\appendixnum}%
4948 \chapmacro{#1}{Yappendix}{\appendixletter}%
4950 \global\let\section = \appendixsec
4951 \global\let\subsection = \appendixsubsec
4952 \global\let\subsubsection = \appendixsubsubsec
4955 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4956 \def\unnumberedzzz#1{%
4957 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4958 \global\advance\unnumberedno by 1
4960 % Since an unnumbered has no number, no prefix for figures.
4961 \global\let\chaplevelprefix = \empty
4962 \resetallfloatnos
4964 % This used to be simply \message{#1}, but TeX fully expands the
4965 % argument to \message. Therefore, if #1 contained @-commands, TeX
4966 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4967 % expanded @cite (which turns out to cause errors because \cite is meant
4968 % to be executed, not expanded).
4970 % Anyway, we don't want the fully-expanded definition of @cite to appear
4971 % as a result of the \message, we just want `@cite' itself. We use
4972 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4973 % simply yielding the contents of <toks register>. (We also do this for
4974 % the toc entries.)
4975 \toks0 = {#1}%
4976 \message{(\the\toks0)}%
4978 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4980 \global\let\section = \unnumberedsec
4981 \global\let\subsection = \unnumberedsubsec
4982 \global\let\subsubsection = \unnumberedsubsubsec
4985 % @centerchap is like @unnumbered, but the heading is centered.
4986 \outer\parseargdef\centerchap{%
4987 % Well, we could do the following in a group, but that would break
4988 % an assumption that \chapmacro is called at the outermost level.
4989 % Thus we are safer this way: --kasal, 24feb04
4990 \let\centerparametersmaybe = \centerparameters
4991 \unnmhead0{#1}%
4992 \let\centerparametersmaybe = \relax
4995 % @top is like @unnumbered.
4996 \let\top\unnumbered
4998 % Sections.
4999 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5000 \def\seczzz#1{%
5001 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5002 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5005 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
5006 \def\appendixsectionzzz#1{%
5007 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5008 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5010 \let\appendixsec\appendixsection
5012 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
5013 \def\unnumberedseczzz#1{%
5014 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5015 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5018 % Subsections.
5019 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
5020 \def\numberedsubseczzz#1{%
5021 \global\subsubsecno=0 \global\advance\subsecno by 1
5022 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5025 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
5026 \def\appendixsubseczzz#1{%
5027 \global\subsubsecno=0 \global\advance\subsecno by 1
5028 \sectionheading{#1}{subsec}{Yappendix}%
5029 {\appendixletter.\the\secno.\the\subsecno}%
5032 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
5033 \def\unnumberedsubseczzz#1{%
5034 \global\subsubsecno=0 \global\advance\subsecno by 1
5035 \sectionheading{#1}{subsec}{Ynothing}%
5036 {\the\unnumberedno.\the\secno.\the\subsecno}%
5039 % Subsubsections.
5040 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
5041 \def\numberedsubsubseczzz#1{%
5042 \global\advance\subsubsecno by 1
5043 \sectionheading{#1}{subsubsec}{Ynumbered}%
5044 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5047 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
5048 \def\appendixsubsubseczzz#1{%
5049 \global\advance\subsubsecno by 1
5050 \sectionheading{#1}{subsubsec}{Yappendix}%
5051 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5054 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
5055 \def\unnumberedsubsubseczzz#1{%
5056 \global\advance\subsubsecno by 1
5057 \sectionheading{#1}{subsubsec}{Ynothing}%
5058 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5061 % These macros control what the section commands do, according
5062 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5063 % Define them by default for a numbered chapter.
5064 \let\section = \numberedsec
5065 \let\subsection = \numberedsubsec
5066 \let\subsubsection = \numberedsubsubsec
5068 % Define @majorheading, @heading and @subheading
5070 % NOTE on use of \vbox for chapter headings, section headings, and such:
5071 % 1) We use \vbox rather than the earlier \line to permit
5072 % overlong headings to fold.
5073 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5074 % heading is obnoxious; this forbids it.
5075 % 3) Likewise, headings look best if no \parindent is used, and
5076 % if justification is not attempted. Hence \raggedright.
5079 \def\majorheading{%
5080 {\advance\chapheadingskip by 10pt \chapbreak }%
5081 \parsearg\chapheadingzzz
5084 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5085 \def\chapheadingzzz#1{%
5086 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5087 \parindent=0pt\raggedright
5088 \rm #1\hfill}}%
5089 \bigskip \par\penalty 200\relax
5090 \suppressfirstparagraphindent
5093 % @heading, @subheading, @subsubheading.
5094 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5095 \suppressfirstparagraphindent}
5096 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5097 \suppressfirstparagraphindent}
5098 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5099 \suppressfirstparagraphindent}
5101 % These macros generate a chapter, section, etc. heading only
5102 % (including whitespace, linebreaking, etc. around it),
5103 % given all the information in convenient, parsed form.
5105 %%% Args are the skip and penalty (usually negative)
5106 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5108 %%% Define plain chapter starts, and page on/off switching for it
5109 % Parameter controlling skip before chapter headings (if needed)
5111 \newskip\chapheadingskip
5113 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5114 \def\chappager{\par\vfill\supereject}
5115 % Because \domark is called before \chapoddpage, the filler page will
5116 % get the headings for the next chapter, which is wrong. But we don't
5117 % care -- we just disable all headings on the filler page.
5118 \def\chapoddpage{%
5119 \chappager
5120 \ifodd\pageno \else
5121 \begingroup
5122 \evenheadline={\hfil}\evenfootline={\hfil}%
5123 \oddheadline={\hfil}\oddfootline={\hfil}%
5124 \hbox to 0pt{}%
5125 \chappager
5126 \endgroup
5130 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5132 \def\CHAPPAGoff{%
5133 \global\let\contentsalignmacro = \chappager
5134 \global\let\pchapsepmacro=\chapbreak
5135 \global\let\pagealignmacro=\chappager}
5137 \def\CHAPPAGon{%
5138 \global\let\contentsalignmacro = \chappager
5139 \global\let\pchapsepmacro=\chappager
5140 \global\let\pagealignmacro=\chappager
5141 \global\def\HEADINGSon{\HEADINGSsingle}}
5143 \def\CHAPPAGodd{%
5144 \global\let\contentsalignmacro = \chapoddpage
5145 \global\let\pchapsepmacro=\chapoddpage
5146 \global\let\pagealignmacro=\chapoddpage
5147 \global\def\HEADINGSon{\HEADINGSdouble}}
5149 \CHAPPAGon
5151 % Chapter opening.
5153 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5154 % Yappendix, Yomitfromtoc), #3 the chapter number.
5156 % To test against our argument.
5157 \def\Ynothingkeyword{Ynothing}
5158 \def\Yomitfromtockeyword{Yomitfromtoc}
5159 \def\Yappendixkeyword{Yappendix}
5161 \def\chapmacro#1#2#3{%
5162 % Insert the first mark before the heading break (see notes for \domark).
5163 \let\prevchapterdefs=\lastchapterdefs
5164 \let\prevsectiondefs=\lastsectiondefs
5165 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5166 \gdef\thissection{}}%
5168 \def\temptype{#2}%
5169 \ifx\temptype\Ynothingkeyword
5170 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5171 \gdef\thischapter{\thischaptername}}%
5172 \else\ifx\temptype\Yomitfromtockeyword
5173 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5174 \gdef\thischapter{}}%
5175 \else\ifx\temptype\Yappendixkeyword
5176 \toks0={#1}%
5177 \xdef\lastchapterdefs{%
5178 \gdef\noexpand\thischaptername{\the\toks0}%
5179 \gdef\noexpand\thischapternum{\appendixletter}%
5180 \gdef\noexpand\thischapter{\putwordAppendix{} \noexpand\thischapternum:
5181 \noexpand\thischaptername}%
5183 \else
5184 \toks0={#1}%
5185 \xdef\lastchapterdefs{%
5186 \gdef\noexpand\thischaptername{\the\toks0}%
5187 \gdef\noexpand\thischapternum{\the\chapno}%
5188 \gdef\noexpand\thischapter{\putwordChapter{} \noexpand\thischapternum:
5189 \noexpand\thischaptername}%
5191 \fi\fi\fi
5193 % Output the mark. Pass it through \safewhatsit, to take care of
5194 % the preceding space.
5195 \safewhatsit\domark
5197 % Insert the chapter heading break.
5198 \pchapsepmacro
5200 % Now the second mark, after the heading break. No break points
5201 % between here and the heading.
5202 \let\prevchapterdefs=\lastchapterdefs
5203 \let\prevsectiondefs=\lastsectiondefs
5204 \domark
5207 \chapfonts \rm
5209 % Have to define \lastsection before calling \donoderef, because the
5210 % xref code eventually uses it. On the other hand, it has to be called
5211 % after \pchapsepmacro, or the headline will change too soon.
5212 \gdef\lastsection{#1}%
5214 % Only insert the separating space if we have a chapter/appendix
5215 % number, and don't print the unnumbered ``number''.
5216 \ifx\temptype\Ynothingkeyword
5217 \setbox0 = \hbox{}%
5218 \def\toctype{unnchap}%
5219 \else\ifx\temptype\Yomitfromtockeyword
5220 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5221 \def\toctype{omit}%
5222 \else\ifx\temptype\Yappendixkeyword
5223 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5224 \def\toctype{app}%
5225 \else
5226 \setbox0 = \hbox{#3\enspace}%
5227 \def\toctype{numchap}%
5228 \fi\fi\fi
5230 % Write the toc entry for this chapter. Must come before the
5231 % \donoderef, because we include the current node name in the toc
5232 % entry, and \donoderef resets it to empty.
5233 \writetocentry{\toctype}{#1}{#3}%
5235 % For pdftex, we have to write out the node definition (aka, make
5236 % the pdfdest) after any page break, but before the actual text has
5237 % been typeset. If the destination for the pdf outline is after the
5238 % text, then jumping from the outline may wind up with the text not
5239 % being visible, for instance under high magnification.
5240 \donoderef{#2}%
5242 % Typeset the actual heading.
5243 \nobreak % Avoid page breaks at the interline glue.
5244 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
5245 \hangindent=\wd0 \centerparametersmaybe
5246 \unhbox0 #1\par}%
5248 \nobreak\bigskip % no page break after a chapter title
5249 \nobreak
5252 % @centerchap -- centered and unnumbered.
5253 \let\centerparametersmaybe = \relax
5254 \def\centerparameters{%
5255 \advance\rightskip by 3\rightskip
5256 \leftskip = \rightskip
5257 \parfillskip = 0pt
5261 % I don't think this chapter style is supported any more, so I'm not
5262 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5264 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5266 \def\unnchfopen #1{%
5267 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5268 \parindent=0pt\raggedright
5269 \rm #1\hfill}}\bigskip \par\nobreak
5271 \def\chfopen #1#2{\chapoddpage {\chapfonts
5272 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5273 \par\penalty 5000 %
5275 \def\centerchfopen #1{%
5276 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5277 \parindent=0pt
5278 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
5280 \def\CHAPFopen{%
5281 \global\let\chapmacro=\chfopen
5282 \global\let\centerchapmacro=\centerchfopen}
5285 % Section titles. These macros combine the section number parts and
5286 % call the generic \sectionheading to do the printing.
5288 \newskip\secheadingskip
5289 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5291 % Subsection titles.
5292 \newskip\subsecheadingskip
5293 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5295 % Subsubsection titles.
5296 \def\subsubsecheadingskip{\subsecheadingskip}
5297 \def\subsubsecheadingbreak{\subsecheadingbreak}
5300 % Print any size, any type, section title.
5302 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5303 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5304 % section number.
5306 \def\seckeyword{sec}
5308 \def\sectionheading#1#2#3#4{%
5310 % Switch to the right set of fonts.
5311 \csname #2fonts\endcsname \rm
5313 \def\sectionlevel{#2}%
5314 \def\temptype{#3}%
5316 % Insert first mark before the heading break (see notes for \domark).
5317 \let\prevsectiondefs=\lastsectiondefs
5318 \ifx\temptype\Ynothingkeyword
5319 \ifx\sectionlevel\seckeyword
5320 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5321 \gdef\thissection{\thissectionname}}%
5323 \else\ifx\temptype\Yomitfromtockeyword
5324 % Don't redefine \thissection.
5325 \else\ifx\temptype\Yappendixkeyword
5326 \ifx\sectionlevel\seckeyword
5327 \toks0={#1}%
5328 \xdef\lastsectiondefs{%
5329 \gdef\noexpand\thissectionname{\the\toks0}%
5330 \gdef\noexpand\thissectionnum{#4}%
5331 \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5332 \noexpand\thissectionname}%
5335 \else
5336 \ifx\sectionlevel\seckeyword
5337 \toks0={#1}%
5338 \xdef\lastsectiondefs{%
5339 \gdef\noexpand\thissectionname{\the\toks0}%
5340 \gdef\noexpand\thissectionnum{#4}%
5341 \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5342 \noexpand\thissectionname}%
5345 \fi\fi\fi
5347 % Output the mark. Pass it through \safewhatsit, to take care of
5348 % the preceding space.
5349 \safewhatsit\domark
5351 % Insert space above the heading.
5352 \csname #2headingbreak\endcsname
5354 % Now the second mark, after the heading break. No break points
5355 % between here and the heading.
5356 \let\prevsectiondefs=\lastsectiondefs
5357 \domark
5359 % Only insert the space after the number if we have a section number.
5360 \ifx\temptype\Ynothingkeyword
5361 \setbox0 = \hbox{}%
5362 \def\toctype{unn}%
5363 \gdef\lastsection{#1}%
5364 \else\ifx\temptype\Yomitfromtockeyword
5365 % for @headings -- no section number, don't include in toc,
5366 % and don't redefine \lastsection.
5367 \setbox0 = \hbox{}%
5368 \def\toctype{omit}%
5369 \let\sectionlevel=\empty
5370 \else\ifx\temptype\Yappendixkeyword
5371 \setbox0 = \hbox{#4\enspace}%
5372 \def\toctype{app}%
5373 \gdef\lastsection{#1}%
5374 \else
5375 \setbox0 = \hbox{#4\enspace}%
5376 \def\toctype{num}%
5377 \gdef\lastsection{#1}%
5378 \fi\fi\fi
5380 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5381 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5383 % Write the node reference (= pdf destination for pdftex).
5384 % Again, see comments in \chapmacro.
5385 \donoderef{#3}%
5387 % Interline glue will be inserted when the vbox is completed.
5388 % That glue will be a valid breakpoint for the page, since it'll be
5389 % preceded by a whatsit (usually from the \donoderef, or from the
5390 % \writetocentry if there was no node). We don't want to allow that
5391 % break, since then the whatsits could end up on page n while the
5392 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5393 \nobreak
5395 % Output the actual section heading.
5396 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
5397 \hangindent=\wd0 % zero if no section number
5398 \unhbox0 #1}%
5400 % Add extra space after the heading -- half of whatever came above it.
5401 % Don't allow stretch, though.
5402 \kern .5 \csname #2headingskip\endcsname
5404 % Do not let the kern be a potential breakpoint, as it would be if it
5405 % was followed by glue.
5406 \nobreak
5408 % We'll almost certainly start a paragraph next, so don't let that
5409 % glue accumulate. (Not a breakpoint because it's preceded by a
5410 % discardable item.)
5411 \vskip-\parskip
5413 % This is purely so the last item on the list is a known \penalty >
5414 % 10000. This is so \startdefun can avoid allowing breakpoints after
5415 % section headings. Otherwise, it would insert a valid breakpoint between:
5417 % @section sec-whatever
5418 % @deffn def-whatever
5419 \penalty 10001
5423 \message{toc,}
5424 % Table of contents.
5425 \newwrite\tocfile
5427 % Write an entry to the toc file, opening it if necessary.
5428 % Called from @chapter, etc.
5430 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5431 % We append the current node name (if any) and page number as additional
5432 % arguments for the \{chap,sec,...}entry macros which will eventually
5433 % read this. The node name is used in the pdf outlines as the
5434 % destination to jump to.
5436 % We open the .toc file for writing here instead of at @setfilename (or
5437 % any other fixed time) so that @contents can be anywhere in the document.
5438 % But if #1 is `omit', then we don't do anything. This is used for the
5439 % table of contents chapter openings themselves.
5441 \newif\iftocfileopened
5442 \def\omitkeyword{omit}%
5444 \def\writetocentry#1#2#3{%
5445 \edef\writetoctype{#1}%
5446 \ifx\writetoctype\omitkeyword \else
5447 \iftocfileopened\else
5448 \immediate\openout\tocfile = \jobname.toc
5449 \global\tocfileopenedtrue
5452 \iflinks
5453 {\atdummies
5454 \edef\temp{%
5455 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5456 \temp
5461 % Tell \shipout to create a pdf destination on each page, if we're
5462 % writing pdf. These are used in the table of contents. We can't
5463 % just write one on every page because the title pages are numbered
5464 % 1 and 2 (the page numbers aren't printed), and so are the first
5465 % two pages of the document. Thus, we'd have two destinations named
5466 % `1', and two named `2'.
5467 \ifpdf \global\pdfmakepagedesttrue \fi
5471 % These characters do not print properly in the Computer Modern roman
5472 % fonts, so we must take special care. This is more or less redundant
5473 % with the Texinfo input format setup at the end of this file.
5475 \def\activecatcodes{%
5476 \catcode`\"=\active
5477 \catcode`\$=\active
5478 \catcode`\<=\active
5479 \catcode`\>=\active
5480 \catcode`\\=\active
5481 \catcode`\^=\active
5482 \catcode`\_=\active
5483 \catcode`\|=\active
5484 \catcode`\~=\active
5488 % Read the toc file, which is essentially Texinfo input.
5489 \def\readtocfile{%
5490 \setupdatafile
5491 \activecatcodes
5492 \input \tocreadfilename
5495 \newskip\contentsrightmargin \contentsrightmargin=1in
5496 \newcount\savepageno
5497 \newcount\lastnegativepageno \lastnegativepageno = -1
5499 % Prepare to read what we've written to \tocfile.
5501 \def\startcontents#1{%
5502 % If @setchapternewpage on, and @headings double, the contents should
5503 % start on an odd page, unlike chapters. Thus, we maintain
5504 % \contentsalignmacro in parallel with \pagealignmacro.
5505 % From: Torbjorn Granlund <tege@matematik.su.se>
5506 \contentsalignmacro
5507 \immediate\closeout\tocfile
5509 % Don't need to put `Contents' or `Short Contents' in the headline.
5510 % It is abundantly clear what they are.
5511 \chapmacro{#1}{Yomitfromtoc}{}%
5513 \savepageno = \pageno
5514 \begingroup % Set up to handle contents files properly.
5515 \raggedbottom % Worry more about breakpoints than the bottom.
5516 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5518 % Roman numerals for page numbers.
5519 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5522 % redefined for the two-volume lispref. We always output on
5523 % \jobname.toc even if this is redefined.
5525 \def\tocreadfilename{\jobname.toc}
5527 % Normal (long) toc.
5529 \def\contents{%
5530 \startcontents{\putwordTOC}%
5531 \openin 1 \tocreadfilename\space
5532 \ifeof 1 \else
5533 \readtocfile
5535 \vfill \eject
5536 \contentsalignmacro % in case @setchapternewpage odd is in effect
5537 \ifeof 1 \else
5538 \pdfmakeoutlines
5540 \closein 1
5541 \endgroup
5542 \lastnegativepageno = \pageno
5543 \global\pageno = \savepageno
5546 % And just the chapters.
5547 \def\summarycontents{%
5548 \startcontents{\putwordShortTOC}%
5550 \let\numchapentry = \shortchapentry
5551 \let\appentry = \shortchapentry
5552 \let\unnchapentry = \shortunnchapentry
5553 % We want a true roman here for the page numbers.
5554 \secfonts
5555 \let\rm=\shortcontrm \let\bf=\shortcontbf
5556 \let\sl=\shortcontsl \let\tt=\shortconttt
5558 \hyphenpenalty = 10000
5559 \advance\baselineskip by 1pt % Open it up a little.
5560 \def\numsecentry##1##2##3##4{}
5561 \let\appsecentry = \numsecentry
5562 \let\unnsecentry = \numsecentry
5563 \let\numsubsecentry = \numsecentry
5564 \let\appsubsecentry = \numsecentry
5565 \let\unnsubsecentry = \numsecentry
5566 \let\numsubsubsecentry = \numsecentry
5567 \let\appsubsubsecentry = \numsecentry
5568 \let\unnsubsubsecentry = \numsecentry
5569 \openin 1 \tocreadfilename\space
5570 \ifeof 1 \else
5571 \readtocfile
5573 \closein 1
5574 \vfill \eject
5575 \contentsalignmacro % in case @setchapternewpage odd is in effect
5576 \endgroup
5577 \lastnegativepageno = \pageno
5578 \global\pageno = \savepageno
5580 \let\shortcontents = \summarycontents
5582 % Typeset the label for a chapter or appendix for the short contents.
5583 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
5585 \def\shortchaplabel#1{%
5586 % This space should be enough, since a single number is .5em, and the
5587 % widest letter (M) is 1em, at least in the Computer Modern fonts.
5588 % But use \hss just in case.
5589 % (This space doesn't include the extra space that gets added after
5590 % the label; that gets put in by \shortchapentry above.)
5592 % We'd like to right-justify chapter numbers, but that looks strange
5593 % with appendix letters. And right-justifying numbers and
5594 % left-justifying letters looks strange when there is less than 10
5595 % chapters. Have to read the whole toc once to know how many chapters
5596 % there are before deciding ...
5597 \hbox to 1em{#1\hss}%
5600 % These macros generate individual entries in the table of contents.
5601 % The first argument is the chapter or section name.
5602 % The last argument is the page number.
5603 % The arguments in between are the chapter number, section number, ...
5605 % Chapters, in the main contents.
5606 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5608 % Chapters, in the short toc.
5609 % See comments in \dochapentry re vbox and related settings.
5610 \def\shortchapentry#1#2#3#4{%
5611 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5614 % Appendices, in the main contents.
5615 % Need the word Appendix, and a fixed-size box.
5617 \def\appendixbox#1{%
5618 % We use M since it's probably the widest letter.
5619 \setbox0 = \hbox{\putwordAppendix{} M}%
5620 \hbox to \wd0{\putwordAppendix{} #1\hss}}
5622 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5624 % Unnumbered chapters.
5625 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5626 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5628 % Sections.
5629 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5630 \let\appsecentry=\numsecentry
5631 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5633 % Subsections.
5634 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5635 \let\appsubsecentry=\numsubsecentry
5636 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5638 % And subsubsections.
5639 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5640 \let\appsubsubsecentry=\numsubsubsecentry
5641 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5643 % This parameter controls the indentation of the various levels.
5644 % Same as \defaultparindent.
5645 \newdimen\tocindent \tocindent = 15pt
5647 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5648 % page number.
5650 % If the toc has to be broken over pages, we want it to be at chapters
5651 % if at all possible; hence the \penalty.
5652 \def\dochapentry#1#2{%
5653 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5654 \begingroup
5655 \chapentryfonts
5656 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5657 \endgroup
5658 \nobreak\vskip .25\baselineskip plus.1\baselineskip
5661 \def\dosecentry#1#2{\begingroup
5662 \secentryfonts \leftskip=\tocindent
5663 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5664 \endgroup}
5666 \def\dosubsecentry#1#2{\begingroup
5667 \subsecentryfonts \leftskip=2\tocindent
5668 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5669 \endgroup}
5671 \def\dosubsubsecentry#1#2{\begingroup
5672 \subsubsecentryfonts \leftskip=3\tocindent
5673 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5674 \endgroup}
5676 % We use the same \entry macro as for the index entries.
5677 \let\tocentry = \entry
5679 % Space between chapter (or whatever) number and the title.
5680 \def\labelspace{\hskip1em \relax}
5682 \def\dopageno#1{{\rm #1}}
5683 \def\doshortpageno#1{{\rm #1}}
5685 \def\chapentryfonts{\secfonts \rm}
5686 \def\secentryfonts{\textfonts}
5687 \def\subsecentryfonts{\textfonts}
5688 \def\subsubsecentryfonts{\textfonts}
5691 \message{environments,}
5692 % @foo ... @end foo.
5694 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
5696 % Since these characters are used in examples, they should be an even number of
5697 % \tt widths. Each \tt character is 1en, so two makes it 1em.
5699 \def\point{$\star$}
5700 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
5701 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
5702 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
5703 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
5704 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
5706 % The @error{} command.
5707 % Adapted from the TeXbook's \boxit.
5709 \newbox\errorbox
5711 {\tentt \global\dimen0 = 3em}% Width of the box.
5712 \dimen2 = .55pt % Thickness of rules
5713 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
5714 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
5716 \setbox\errorbox=\hbox to \dimen0{\hfil
5717 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
5718 \advance\hsize by -2\dimen2 % Rules.
5719 \vbox{%
5720 \hrule height\dimen2
5721 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
5722 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
5723 \kern3pt\vrule width\dimen2}% Space to right.
5724 \hrule height\dimen2}
5725 \hfil}
5727 \def\error{\leavevmode\lower.7ex\copy\errorbox}
5729 % @tex ... @end tex escapes into raw Tex temporarily.
5730 % One exception: @ is still an escape character, so that @end tex works.
5731 % But \@ or @@ will get a plain tex @ character.
5733 \envdef\tex{%
5734 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5735 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5736 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5737 \catcode `\%=14
5738 \catcode `\+=\other
5739 \catcode `\"=\other
5740 \catcode `\|=\other
5741 \catcode `\<=\other
5742 \catcode `\>=\other
5743 \escapechar=`\\
5745 \let\b=\ptexb
5746 \let\bullet=\ptexbullet
5747 \let\c=\ptexc
5748 \let\,=\ptexcomma
5749 \let\.=\ptexdot
5750 \let\dots=\ptexdots
5751 \let\equiv=\ptexequiv
5752 \let\!=\ptexexclam
5753 \let\i=\ptexi
5754 \let\indent=\ptexindent
5755 \let\noindent=\ptexnoindent
5756 \let\{=\ptexlbrace
5757 \let\+=\tabalign
5758 \let\}=\ptexrbrace
5759 \let\/=\ptexslash
5760 \let\*=\ptexstar
5761 \let\t=\ptext
5762 \expandafter \let\csname top\endcsname=\ptextop % outer
5763 \let\frenchspacing=\plainfrenchspacing
5765 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5766 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5767 \def\@{@}%
5769 % There is no need to define \Etex.
5771 % Define @lisp ... @end lisp.
5772 % @lisp environment forms a group so it can rebind things,
5773 % including the definition of @end lisp (which normally is erroneous).
5775 % Amount to narrow the margins by for @lisp.
5776 \newskip\lispnarrowing \lispnarrowing=0.4in
5778 % This is the definition that ^^M gets inside @lisp, @example, and other
5779 % such environments. \null is better than a space, since it doesn't
5780 % have any width.
5781 \def\lisppar{\null\endgraf}
5783 % This space is always present above and below environments.
5784 \newskip\envskipamount \envskipamount = 0pt
5786 % Make spacing and below environment symmetrical. We use \parskip here
5787 % to help in doing that, since in @example-like environments \parskip
5788 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
5789 % start of the next paragraph will insert \parskip.
5791 \def\aboveenvbreak{{%
5792 % =10000 instead of <10000 because of a special case in \itemzzz and
5793 % \sectionheading, q.v.
5794 \ifnum \lastpenalty=10000 \else
5795 \advance\envskipamount by \parskip
5796 \endgraf
5797 \ifdim\lastskip<\envskipamount
5798 \removelastskip
5799 % it's not a good place to break if the last penalty was \nobreak
5800 % or better ...
5801 \ifnum\lastpenalty<10000 \penalty-50 \fi
5802 \vskip\envskipamount
5807 \let\afterenvbreak = \aboveenvbreak
5809 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
5810 % also clear it, so that its embedded environments do the narrowing again.
5811 \let\nonarrowing=\relax
5813 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
5814 % environment contents.
5815 \font\circle=lcircle10
5816 \newdimen\circthick
5817 \newdimen\cartouter\newdimen\cartinner
5818 \newskip\normbskip\newskip\normpskip\newskip\normlskip
5819 \circthick=\fontdimen8\circle
5821 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
5822 \def\ctr{{\hskip 6pt\circle\char'010}}
5823 \def\cbl{{\circle\char'012\hskip -6pt}}
5824 \def\cbr{{\hskip 6pt\circle\char'011}}
5825 \def\carttop{\hbox to \cartouter{\hskip\lskip
5826 \ctl\leaders\hrule height\circthick\hfil\ctr
5827 \hskip\rskip}}
5828 \def\cartbot{\hbox to \cartouter{\hskip\lskip
5829 \cbl\leaders\hrule height\circthick\hfil\cbr
5830 \hskip\rskip}}
5832 \newskip\lskip\newskip\rskip
5834 \envdef\cartouche{%
5835 \ifhmode\par\fi % can't be in the midst of a paragraph.
5836 \startsavinginserts
5837 \lskip=\leftskip \rskip=\rightskip
5838 \leftskip=0pt\rightskip=0pt % we want these *outside*.
5839 \cartinner=\hsize \advance\cartinner by-\lskip
5840 \advance\cartinner by-\rskip
5841 \cartouter=\hsize
5842 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
5843 % side, and for 6pt waste from
5844 % each corner char, and rule thickness
5845 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
5846 % Flag to tell @lisp, etc., not to narrow margin.
5847 \let\nonarrowing = t%
5848 \vbox\bgroup
5849 \baselineskip=0pt\parskip=0pt\lineskip=0pt
5850 \carttop
5851 \hbox\bgroup
5852 \hskip\lskip
5853 \vrule\kern3pt
5854 \vbox\bgroup
5855 \kern3pt
5856 \hsize=\cartinner
5857 \baselineskip=\normbskip
5858 \lineskip=\normlskip
5859 \parskip=\normpskip
5860 \vskip -\parskip
5861 \comment % For explanation, see the end of \def\group.
5863 \def\Ecartouche{%
5864 \ifhmode\par\fi
5865 \kern3pt
5866 \egroup
5867 \kern3pt\vrule
5868 \hskip\rskip
5869 \egroup
5870 \cartbot
5871 \egroup
5872 \checkinserts
5876 % This macro is called at the beginning of all the @example variants,
5877 % inside a group.
5878 \def\nonfillstart{%
5879 \aboveenvbreak
5880 \hfuzz = 12pt % Don't be fussy
5881 \sepspaces % Make spaces be word-separators rather than space tokens.
5882 \let\par = \lisppar % don't ignore blank lines
5883 \obeylines % each line of input is a line of output
5884 \parskip = 0pt
5885 \parindent = 0pt
5886 \emergencystretch = 0pt % don't try to avoid overfull boxes
5887 \ifx\nonarrowing\relax
5888 \advance \leftskip by \lispnarrowing
5889 \exdentamount=\lispnarrowing
5890 \else
5891 \let\nonarrowing = \relax
5893 \let\exdent=\nofillexdent
5896 % If you want all examples etc. small: @set dispenvsize small.
5897 % If you want even small examples the full size: @set dispenvsize nosmall.
5898 % This affects the following displayed environments:
5899 % @example, @display, @format, @lisp
5901 \def\smallword{small}
5902 \def\nosmallword{nosmall}
5903 \let\SETdispenvsize\relax
5904 \def\setnormaldispenv{%
5905 \ifx\SETdispenvsize\smallword
5906 % end paragraph for sake of leading, in case document has no blank
5907 % line. This is redundant with what happens in \aboveenvbreak, but
5908 % we need to do it before changing the fonts, and it's inconvenient
5909 % to change the fonts afterward.
5910 \ifnum \lastpenalty=10000 \else \endgraf \fi
5911 \smallexamplefonts \rm
5914 \def\setsmalldispenv{%
5915 \ifx\SETdispenvsize\nosmallword
5916 \else
5917 \ifnum \lastpenalty=10000 \else \endgraf \fi
5918 \smallexamplefonts \rm
5922 % We often define two environments, @foo and @smallfoo.
5923 % Let's do it by one command:
5924 \def\makedispenv #1#2{
5925 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5926 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5927 \expandafter\let\csname E#1\endcsname \afterenvbreak
5928 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5931 % Define two synonyms:
5932 \def\maketwodispenvs #1#2#3{
5933 \makedispenv{#1}{#3}
5934 \makedispenv{#2}{#3}
5937 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5939 % @smallexample and @smalllisp: use smaller fonts.
5940 % Originally contributed by Pavel@xerox.
5942 \maketwodispenvs {lisp}{example}{%
5943 \nonfillstart
5944 \tt\quoteexpand
5945 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
5946 \gobble % eat return
5948 % @display/@smalldisplay: same as @lisp except keep current font.
5950 \makedispenv {display}{%
5951 \nonfillstart
5952 \gobble
5955 % @format/@smallformat: same as @display except don't narrow margins.
5957 \makedispenv{format}{%
5958 \let\nonarrowing = t%
5959 \nonfillstart
5960 \gobble
5963 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
5964 \envdef\flushleft{%
5965 \let\nonarrowing = t%
5966 \nonfillstart
5967 \gobble
5969 \let\Eflushleft = \afterenvbreak
5971 % @flushright.
5973 \envdef\flushright{%
5974 \let\nonarrowing = t%
5975 \nonfillstart
5976 \advance\leftskip by 0pt plus 1fill
5977 \gobble
5979 \let\Eflushright = \afterenvbreak
5982 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
5983 % and narrows the margins. We keep \parskip nonzero in general, since
5984 % we're doing normal filling. So, when using \aboveenvbreak and
5985 % \afterenvbreak, temporarily make \parskip 0.
5987 \def\quotationstart{%
5988 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
5989 \parindent=0pt
5991 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
5992 \ifx\nonarrowing\relax
5993 \advance\leftskip by \lispnarrowing
5994 \advance\rightskip by \lispnarrowing
5995 \exdentamount = \lispnarrowing
5996 \else
5997 \let\nonarrowing = \relax
5999 \parsearg\quotationlabel
6002 \envdef\quotation{%
6003 \setnormaldispenv
6004 \quotationstart
6007 \envdef\smallquotation{%
6008 \setsmalldispenv
6009 \quotationstart
6011 \let\Esmallquotation = \Equotation
6013 % We have retained a nonzero parskip for the environment, since we're
6014 % doing normal filling.
6016 \def\Equotation{%
6017 \par
6018 \ifx\quotationauthor\undefined\else
6019 % indent a bit.
6020 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6022 {\parskip=0pt \afterenvbreak}%
6025 % If we're given an argument, typeset it in bold with a colon after.
6026 \def\quotationlabel#1{%
6027 \def\temp{#1}%
6028 \ifx\temp\empty \else
6029 {\bf #1: }%
6034 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6035 % If we want to allow any <char> as delimiter,
6036 % we need the curly braces so that makeinfo sees the @verb command, eg:
6037 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6039 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6041 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6042 % active too. Otherwise, they get lost as the first character on a
6043 % verbatim line.
6044 \def\dospecials{%
6045 \do\ \do\\\do\{\do\}\do\$\do\&%
6046 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6047 \do\<\do\>\do\|\do\@\do+\do\"%
6050 % [Knuth] p. 380
6051 \def\uncatcodespecials{%
6052 \def\do##1{\catcode`##1=\other}\dospecials}
6054 % Setup for the @verb command.
6056 % Eight spaces for a tab
6057 \begingroup
6058 \catcode`\^^I=\active
6059 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6060 \endgroup
6062 \def\setupverb{%
6063 \tt % easiest (and conventionally used) font for verbatim
6064 \def\par{\leavevmode\endgraf}%
6065 \catcode`\`=\active
6066 \tabeightspaces
6067 % Respect line breaks,
6068 % print special symbols as themselves, and
6069 % make each space count
6070 % must do in this order:
6071 \obeylines \uncatcodespecials \sepspaces
6074 % Setup for the @verbatim environment
6076 % Real tab expansion
6077 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6079 \def\starttabbox{\setbox0=\hbox\bgroup}
6081 % Allow an option to not replace quotes with a regular directed right
6082 % quote/apostrophe (char 0x27), but instead use the undirected quote
6083 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
6084 % the default, but it works for pasting with more pdf viewers (at least
6085 % evince), the lilypond developers report. xpdf does work with the
6086 % regular 0x27.
6088 \def\codequoteright{%
6089 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
6090 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
6092 \else \char'15 \fi
6093 \else \char'15 \fi
6096 % and a similar option for the left quote char vs. a grave accent.
6097 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
6098 % the code environments to do likewise.
6100 \def\codequoteleft{%
6101 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
6102 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
6103 \relax`% the \relax disables the `! and `? ligatures
6104 \else \char'22 \fi
6105 \else \char'22 \fi
6108 \begingroup
6109 \catcode`\^^I=\active
6110 \gdef\tabexpand{%
6111 \catcode`\^^I=\active
6112 \def^^I{\leavevmode\egroup
6113 \dimen0=\wd0 % the width so far, or since the previous tab
6114 \divide\dimen0 by\tabw
6115 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
6116 \advance\dimen0 by\tabw % advance to next multiple of \tabw
6117 \wd0=\dimen0 \box0 \starttabbox
6120 \catcode`\'=\active
6121 \gdef\rquoteexpand{\catcode\rquoteChar=\active \def'{\codequoteright}}%
6123 \catcode`\`=\active
6124 \gdef\lquoteexpand{\catcode\lquoteChar=\active \def`{\codequoteleft}}%
6126 \gdef\quoteexpand{\rquoteexpand \lquoteexpand}%
6127 \endgroup
6129 % start the verbatim environment.
6130 \def\setupverbatim{%
6131 \let\nonarrowing = t%
6132 \nonfillstart
6133 % Easiest (and conventionally used) font for verbatim
6135 \def\par{\leavevmode\egroup\box0\endgraf}%
6136 \catcode`\`=\active
6137 \tabexpand
6138 \quoteexpand
6139 % Respect line breaks,
6140 % print special symbols as themselves, and
6141 % make each space count
6142 % must do in this order:
6143 \obeylines \uncatcodespecials \sepspaces
6144 \everypar{\starttabbox}%
6147 % Do the @verb magic: verbatim text is quoted by unique
6148 % delimiter characters. Before first delimiter expect a
6149 % right brace, after last delimiter expect closing brace:
6151 % \def\doverb'{'<char>#1<char>'}'{#1}
6153 % [Knuth] p. 382; only eat outer {}
6154 \begingroup
6155 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6156 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6157 \endgroup
6159 \def\verb{\begingroup\setupverb\doverb}
6162 % Do the @verbatim magic: define the macro \doverbatim so that
6163 % the (first) argument ends when '@end verbatim' is reached, ie:
6165 % \def\doverbatim#1@end verbatim{#1}
6167 % For Texinfo it's a lot easier than for LaTeX,
6168 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6169 % we need not redefine '\', '{' and '}'.
6171 % Inspired by LaTeX's verbatim command set [latex.ltx]
6173 \begingroup
6174 \catcode`\ =\active
6175 \obeylines %
6176 % ignore everything up to the first ^^M, that's the newline at the end
6177 % of the @verbatim input line itself. Otherwise we get an extra blank
6178 % line in the output.
6179 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6180 % We really want {...\end verbatim} in the body of the macro, but
6181 % without the active space; thus we have to use \xdef and \gobble.
6182 \endgroup
6184 \envdef\verbatim{%
6185 \setupverbatim\doverbatim
6187 \let\Everbatim = \afterenvbreak
6190 % @verbatiminclude FILE - insert text of file in verbatim environment.
6192 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6194 \def\doverbatiminclude#1{%
6196 \makevalueexpandable
6197 \setupverbatim
6198 \indexnofonts % Allow `@@' and other weird things in file names.
6199 \input #1
6200 \afterenvbreak
6204 % @copying ... @end copying.
6205 % Save the text away for @insertcopying later.
6207 % We save the uninterpreted tokens, rather than creating a box.
6208 % Saving the text in a box would be much easier, but then all the
6209 % typesetting commands (@smallbook, font changes, etc.) have to be done
6210 % beforehand -- and a) we want @copying to be done first in the source
6211 % file; b) letting users define the frontmatter in as flexible order as
6212 % possible is very desirable.
6214 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6215 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6217 \def\insertcopying{%
6218 \begingroup
6219 \parindent = 0pt % paragraph indentation looks wrong on title page
6220 \scanexp\copyingtext
6221 \endgroup
6225 \message{defuns,}
6226 % @defun etc.
6228 \newskip\defbodyindent \defbodyindent=.4in
6229 \newskip\defargsindent \defargsindent=50pt
6230 \newskip\deflastargmargin \deflastargmargin=18pt
6231 \newcount\defunpenalty
6233 % Start the processing of @deffn:
6234 \def\startdefun{%
6235 \ifnum\lastpenalty<10000
6236 \medbreak
6237 \defunpenalty=10003 % Will keep this @deffn together with the
6238 % following @def command, see below.
6239 \else
6240 % If there are two @def commands in a row, we'll have a \nobreak,
6241 % which is there to keep the function description together with its
6242 % header. But if there's nothing but headers, we need to allow a
6243 % break somewhere. Check specifically for penalty 10002, inserted
6244 % by \printdefunline, instead of 10000, since the sectioning
6245 % commands also insert a nobreak penalty, and we don't want to allow
6246 % a break between a section heading and a defun.
6248 % As a minor refinement, we avoid "club" headers by signalling
6249 % with penalty of 10003 after the very first @deffn in the
6250 % sequence (see above), and penalty of 10002 after any following
6251 % @def command.
6252 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6254 % Similarly, after a section heading, do not allow a break.
6255 % But do insert the glue.
6256 \medskip % preceded by discardable penalty, so not a breakpoint
6259 \parindent=0in
6260 \advance\leftskip by \defbodyindent
6261 \exdentamount=\defbodyindent
6264 \def\dodefunx#1{%
6265 % First, check whether we are in the right environment:
6266 \checkenv#1%
6268 % As above, allow line break if we have multiple x headers in a row.
6269 % It's not a great place, though.
6270 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6272 % And now, it's time to reuse the body of the original defun:
6273 \expandafter\gobbledefun#1%
6275 \def\gobbledefun#1\startdefun{}
6277 % \printdefunline \deffnheader{text}
6279 \def\printdefunline#1#2{%
6280 \begingroup
6281 % call \deffnheader:
6282 #1#2 \endheader
6283 % common ending:
6284 \interlinepenalty = 10000
6285 \advance\rightskip by 0pt plus 1fil
6286 \endgraf
6287 \nobreak\vskip -\parskip
6288 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6289 % Some of the @defun-type tags do not enable magic parentheses,
6290 % rendering the following check redundant. But we don't optimize.
6291 \checkparencounts
6292 \endgroup
6295 \def\Edefun{\endgraf\medbreak}
6297 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6298 % the only thing remaining is to define \deffnheader.
6300 \def\makedefun#1{%
6301 \expandafter\let\csname E#1\endcsname = \Edefun
6302 \edef\temp{\noexpand\domakedefun
6303 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6304 \temp
6307 % \domakedefun \deffn \deffnx \deffnheader
6309 % Define \deffn and \deffnx, without parameters.
6310 % \deffnheader has to be defined explicitly.
6312 \def\domakedefun#1#2#3{%
6313 \envdef#1{%
6314 \startdefun
6315 \parseargusing\activeparens{\printdefunline#3}%
6317 \def#2{\dodefunx#1}%
6318 \def#3%
6321 %%% Untyped functions:
6323 % @deffn category name args
6324 \makedefun{deffn}{\deffngeneral{}}
6326 % @deffn category class name args
6327 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6329 % \defopon {category on}class name args
6330 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6332 % \deffngeneral {subind}category name args
6334 \def\deffngeneral#1#2 #3 #4\endheader{%
6335 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6336 \dosubind{fn}{\code{#3}}{#1}%
6337 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6340 %%% Typed functions:
6342 % @deftypefn category type name args
6343 \makedefun{deftypefn}{\deftypefngeneral{}}
6345 % @deftypeop category class type name args
6346 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6348 % \deftypeopon {category on}class type name args
6349 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6351 % \deftypefngeneral {subind}category type name args
6353 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6354 \dosubind{fn}{\code{#4}}{#1}%
6355 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6358 %%% Typed variables:
6360 % @deftypevr category type var args
6361 \makedefun{deftypevr}{\deftypecvgeneral{}}
6363 % @deftypecv category class type var args
6364 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6366 % \deftypecvof {category of}class type var args
6367 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6369 % \deftypecvgeneral {subind}category type var args
6371 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6372 \dosubind{vr}{\code{#4}}{#1}%
6373 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6376 %%% Untyped variables:
6378 % @defvr category var args
6379 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6381 % @defcv category class var args
6382 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6384 % \defcvof {category of}class var args
6385 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6387 %%% Type:
6388 % @deftp category name args
6389 \makedefun{deftp}#1 #2 #3\endheader{%
6390 \doind{tp}{\code{#2}}%
6391 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6394 % Remaining @defun-like shortcuts:
6395 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6396 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6397 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6398 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6399 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6400 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6401 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6402 \makedefun{defmethod}{\defopon\putwordMethodon}
6403 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6404 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6405 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6407 % \defname, which formats the name of the @def (not the args).
6408 % #1 is the category, such as "Function".
6409 % #2 is the return type, if any.
6410 % #3 is the function name.
6412 % We are followed by (but not passed) the arguments, if any.
6414 \def\defname#1#2#3{%
6415 % Get the values of \leftskip and \rightskip as they were outside the @def...
6416 \advance\leftskip by -\defbodyindent
6418 % How we'll format the type name. Putting it in brackets helps
6419 % distinguish it from the body text that may end up on the next line
6420 % just below it.
6421 \def\temp{#1}%
6422 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6424 % Figure out line sizes for the paragraph shape.
6425 % The first line needs space for \box0; but if \rightskip is nonzero,
6426 % we need only space for the part of \box0 which exceeds it:
6427 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6428 % The continuations:
6429 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6430 % (plain.tex says that \dimen1 should be used only as global.)
6431 \parshape 2 0in \dimen0 \defargsindent \dimen2
6433 % Put the type name to the right margin.
6434 \noindent
6435 \hbox to 0pt{%
6436 \hfil\box0 \kern-\hsize
6437 % \hsize has to be shortened this way:
6438 \kern\leftskip
6439 % Intentionally do not respect \rightskip, since we need the space.
6442 % Allow all lines to be underfull without complaint:
6443 \tolerance=10000 \hbadness=10000
6444 \exdentamount=\defbodyindent
6446 % defun fonts. We use typewriter by default (used to be bold) because:
6447 % . we're printing identifiers, they should be in tt in principle.
6448 % . in languages with many accents, such as Czech or French, it's
6449 % common to leave accents off identifiers. The result looks ok in
6450 % tt, but exceedingly strange in rm.
6451 % . we don't want -- and --- to be treated as ligatures.
6452 % . this still does not fix the ?` and !` ligatures, but so far no
6453 % one has made identifiers using them :).
6454 \df \tt
6455 \def\temp{#2}% return value type
6456 \ifx\temp\empty\else \tclose{\temp} \fi
6457 #3% output function name
6459 {\rm\enskip}% hskip 0.5 em of \tenrm
6461 \boldbrax
6462 % arguments will be output next, if any.
6465 % Print arguments in slanted roman (not ttsl), inconsistently with using
6466 % tt for the name. This is because literal text is sometimes needed in
6467 % the argument list (groff manual), and ttsl and tt are not very
6468 % distinguishable. Prevent hyphenation at `-' chars.
6470 \def\defunargs#1{%
6471 % use sl by default (not ttsl),
6472 % tt for the names.
6473 \df \sl \hyphenchar\font=0
6475 % On the other hand, if an argument has two dashes (for instance), we
6476 % want a way to get ttsl. Let's try @var for that.
6477 \let\var=\ttslanted
6479 \sl\hyphenchar\font=45
6482 % We want ()&[] to print specially on the defun line.
6484 \def\activeparens{%
6485 \catcode`\(=\active \catcode`\)=\active
6486 \catcode`\[=\active \catcode`\]=\active
6487 \catcode`\&=\active
6490 % Make control sequences which act like normal parenthesis chars.
6491 \let\lparen = ( \let\rparen = )
6493 % Be sure that we always have a definition for `(', etc. For example,
6494 % if the fn name has parens in it, \boldbrax will not be in effect yet,
6495 % so TeX would otherwise complain about undefined control sequence.
6497 \activeparens
6498 \global\let(=\lparen \global\let)=\rparen
6499 \global\let[=\lbrack \global\let]=\rbrack
6500 \global\let& = \&
6502 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
6503 \gdef\magicamp{\let&=\amprm}
6506 \newcount\parencount
6508 % If we encounter &foo, then turn on ()-hacking afterwards
6509 \newif\ifampseen
6510 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
6512 \def\parenfont{%
6513 \ifampseen
6514 % At the first level, print parens in roman,
6515 % otherwise use the default font.
6516 \ifnum \parencount=1 \rm \fi
6517 \else
6518 % The \sf parens (in \boldbrax) actually are a little bolder than
6519 % the contained text. This is especially needed for [ and ] .
6523 \def\infirstlevel#1{%
6524 \ifampseen
6525 \ifnum\parencount=1
6530 \def\bfafterword#1 {#1 \bf}
6532 \def\opnr{%
6533 \global\advance\parencount by 1
6534 {\parenfont(}%
6535 \infirstlevel \bfafterword
6537 \def\clnr{%
6538 {\parenfont)}%
6539 \infirstlevel \sl
6540 \global\advance\parencount by -1
6543 \newcount\brackcount
6544 \def\lbrb{%
6545 \global\advance\brackcount by 1
6546 {\bf[}%
6548 \def\rbrb{%
6549 {\bf]}%
6550 \global\advance\brackcount by -1
6553 \def\checkparencounts{%
6554 \ifnum\parencount=0 \else \badparencount \fi
6555 \ifnum\brackcount=0 \else \badbrackcount \fi
6557 % these should not use \errmessage; the glibc manual, at least, actually
6558 % has such constructs (when documenting function pointers).
6559 \def\badparencount{%
6560 \message{Warning: unbalanced parentheses in @def...}%
6561 \global\parencount=0
6563 \def\badbrackcount{%
6564 \message{Warning: unbalanced square brackets in @def...}%
6565 \global\brackcount=0
6569 \message{macros,}
6570 % @macro.
6572 % To do this right we need a feature of e-TeX, \scantokens,
6573 % which we arrange to emulate with a temporary file in ordinary TeX.
6574 \ifx\eTeXversion\undefined
6575 \newwrite\macscribble
6576 \def\scantokens#1{%
6577 \toks0={#1}%
6578 \immediate\openout\macscribble=\jobname.tmp
6579 \immediate\write\macscribble{\the\toks0}%
6580 \immediate\closeout\macscribble
6581 \input \jobname.tmp
6585 \def\scanmacro#1{%
6586 \begingroup
6587 \newlinechar`\^^M
6588 \let\xeatspaces\eatspaces
6589 % Undo catcode changes of \startcontents and \doprintindex
6590 % When called from @insertcopying or (short)caption, we need active
6591 % backslash to get it printed correctly. Previously, we had
6592 % \catcode`\\=\other instead. We'll see whether a problem appears
6593 % with macro expansion. --kasal, 19aug04
6594 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6595 % ... and \example
6596 \spaceisspace
6598 % Append \endinput to make sure that TeX does not see the ending newline.
6599 % I've verified that it is necessary both for e-TeX and for ordinary TeX
6600 % --kasal, 29nov03
6601 \scantokens{#1\endinput}%
6602 \endgroup
6605 \def\scanexp#1{%
6606 \edef\temp{\noexpand\scanmacro{#1}}%
6607 \temp
6610 \newcount\paramno % Count of parameters
6611 \newtoks\macname % Macro name
6612 \newif\ifrecursive % Is it recursive?
6614 % List of all defined macros in the form
6615 % \definedummyword\macro1\definedummyword\macro2...
6616 % Currently is also contains all @aliases; the list can be split
6617 % if there is a need.
6618 \def\macrolist{}
6620 % Add the macro to \macrolist
6621 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6622 \def\addtomacrolistxxx#1{%
6623 \toks0 = \expandafter{\macrolist\definedummyword#1}%
6624 \xdef\macrolist{\the\toks0}%
6627 % Utility routines.
6628 % This does \let #1 = #2, with \csnames; that is,
6629 % \let \csname#1\endcsname = \csname#2\endcsname
6630 % (except of course we have to play expansion games).
6632 \def\cslet#1#2{%
6633 \expandafter\let
6634 \csname#1\expandafter\endcsname
6635 \csname#2\endcsname
6638 % Trim leading and trailing spaces off a string.
6639 % Concepts from aro-bend problem 15 (see CTAN).
6640 {\catcode`\@=11
6641 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6642 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6643 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6644 \def\unbrace#1{#1}
6645 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6648 % Trim a single trailing ^^M off a string.
6649 {\catcode`\^^M=\other \catcode`\Q=3%
6650 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6651 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6652 \gdef\eatcrb#1Q#2Q{#1}%
6655 % Macro bodies are absorbed as an argument in a context where
6656 % all characters are catcode 10, 11 or 12, except \ which is active
6657 % (as in normal texinfo). It is necessary to change the definition of \.
6659 % Non-ASCII encodings make 8-bit characters active, so un-activate
6660 % them to avoid their expansion. Must do this non-globally, to
6661 % confine the change to the current group.
6663 % It's necessary to have hard CRs when the macro is executed. This is
6664 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
6665 % body, and then making it the \newlinechar in \scanmacro.
6667 \def\scanctxt{%
6668 \catcode`\"=\other
6669 \catcode`\+=\other
6670 \catcode`\<=\other
6671 \catcode`\>=\other
6672 \catcode`\@=\other
6673 \catcode`\^=\other
6674 \catcode`\_=\other
6675 \catcode`\|=\other
6676 \catcode`\~=\other
6677 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
6680 \def\scanargctxt{%
6681 \scanctxt
6682 \catcode`\\=\other
6683 \catcode`\^^M=\other
6686 \def\macrobodyctxt{%
6687 \scanctxt
6688 \catcode`\{=\other
6689 \catcode`\}=\other
6690 \catcode`\^^M=\other
6691 \usembodybackslash
6694 \def\macroargctxt{%
6695 \scanctxt
6696 \catcode`\\=\other
6699 % \mbodybackslash is the definition of \ in @macro bodies.
6700 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6701 % where N is the macro parameter number.
6702 % We define \csname macarg.\endcsname to be \realbackslash, so
6703 % \\ in macro replacement text gets you a backslash.
6705 {\catcode`@=0 @catcode`@\=@active
6706 @gdef@usembodybackslash{@let\=@mbodybackslash}
6707 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6709 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6711 \def\macro{\recursivefalse\parsearg\macroxxx}
6712 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6714 \def\macroxxx#1{%
6715 \getargs{#1}% now \macname is the macname and \argl the arglist
6716 \ifx\argl\empty % no arguments
6717 \paramno=0%
6718 \else
6719 \expandafter\parsemargdef \argl;%
6721 \if1\csname ismacro.\the\macname\endcsname
6722 \message{Warning: redefining \the\macname}%
6723 \else
6724 \expandafter\ifx\csname \the\macname\endcsname \relax
6725 \else \errmessage{Macro name \the\macname\space already defined}\fi
6726 \global\cslet{macsave.\the\macname}{\the\macname}%
6727 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6728 \addtomacrolist{\the\macname}%
6730 \begingroup \macrobodyctxt
6731 \ifrecursive \expandafter\parsermacbody
6732 \else \expandafter\parsemacbody
6733 \fi}
6735 \parseargdef\unmacro{%
6736 \if1\csname ismacro.#1\endcsname
6737 \global\cslet{#1}{macsave.#1}%
6738 \global\expandafter\let \csname ismacro.#1\endcsname=0%
6739 % Remove the macro name from \macrolist:
6740 \begingroup
6741 \expandafter\let\csname#1\endcsname \relax
6742 \let\definedummyword\unmacrodo
6743 \xdef\macrolist{\macrolist}%
6744 \endgroup
6745 \else
6746 \errmessage{Macro #1 not defined}%
6750 % Called by \do from \dounmacro on each macro. The idea is to omit any
6751 % macro definitions that have been changed to \relax.
6753 \def\unmacrodo#1{%
6754 \ifx #1\relax
6755 % remove this
6756 \else
6757 \noexpand\definedummyword \noexpand#1%
6761 % This makes use of the obscure feature that if the last token of a
6762 % <parameter list> is #, then the preceding argument is delimited by
6763 % an opening brace, and that opening brace is not consumed.
6764 \def\getargs#1{\getargsxxx#1{}}
6765 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
6766 \def\getmacname #1 #2\relax{\macname={#1}}
6767 \def\getmacargs#1{\def\argl{#1}}
6769 % Parse the optional {params} list. Set up \paramno and \paramlist
6770 % so \defmacro knows what to do. Define \macarg.blah for each blah
6771 % in the params list, to be ##N where N is the position in that list.
6772 % That gets used by \mbodybackslash (above).
6774 % We need to get `macro parameter char #' into several definitions.
6775 % The technique used is stolen from LaTeX: let \hash be something
6776 % unexpandable, insert that wherever you need a #, and then redefine
6777 % it to # just before using the token list produced.
6779 % The same technique is used to protect \eatspaces till just before
6780 % the macro is used.
6782 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
6783 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
6784 \def\parsemargdefxxx#1,{%
6785 \if#1;\let\next=\relax
6786 \else \let\next=\parsemargdefxxx
6787 \advance\paramno by 1%
6788 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
6789 {\xeatspaces{\hash\the\paramno}}%
6790 \edef\paramlist{\paramlist\hash\the\paramno,}%
6791 \fi\next}
6793 % These two commands read recursive and nonrecursive macro bodies.
6794 % (They're different since rec and nonrec macros end differently.)
6796 \long\def\parsemacbody#1@end macro%
6797 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6798 \long\def\parsermacbody#1@end rmacro%
6799 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6801 % This defines the macro itself. There are six cases: recursive and
6802 % nonrecursive macros of zero, one, and many arguments.
6803 % Much magic with \expandafter here.
6804 % \xdef is used so that macro definitions will survive the file
6805 % they're defined in; @include reads the file inside a group.
6806 \def\defmacro{%
6807 \let\hash=##% convert placeholders to macro parameter chars
6808 \ifrecursive
6809 \ifcase\paramno
6811 \expandafter\xdef\csname\the\macname\endcsname{%
6812 \noexpand\scanmacro{\temp}}%
6813 \or % 1
6814 \expandafter\xdef\csname\the\macname\endcsname{%
6815 \bgroup\noexpand\macroargctxt
6816 \noexpand\braceorline
6817 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6818 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6819 \egroup\noexpand\scanmacro{\temp}}%
6820 \else % many
6821 \expandafter\xdef\csname\the\macname\endcsname{%
6822 \bgroup\noexpand\macroargctxt
6823 \noexpand\csname\the\macname xx\endcsname}%
6824 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6825 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6826 \expandafter\expandafter
6827 \expandafter\xdef
6828 \expandafter\expandafter
6829 \csname\the\macname xxx\endcsname
6830 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
6832 \else
6833 \ifcase\paramno
6835 \expandafter\xdef\csname\the\macname\endcsname{%
6836 \noexpand\norecurse{\the\macname}%
6837 \noexpand\scanmacro{\temp}\egroup}%
6838 \or % 1
6839 \expandafter\xdef\csname\the\macname\endcsname{%
6840 \bgroup\noexpand\macroargctxt
6841 \noexpand\braceorline
6842 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6843 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6844 \egroup
6845 \noexpand\norecurse{\the\macname}%
6846 \noexpand\scanmacro{\temp}\egroup}%
6847 \else % many
6848 \expandafter\xdef\csname\the\macname\endcsname{%
6849 \bgroup\noexpand\macroargctxt
6850 \expandafter\noexpand\csname\the\macname xx\endcsname}%
6851 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6852 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6853 \expandafter\expandafter
6854 \expandafter\xdef
6855 \expandafter\expandafter
6856 \csname\the\macname xxx\endcsname
6857 \paramlist{%
6858 \egroup
6859 \noexpand\norecurse{\the\macname}%
6860 \noexpand\scanmacro{\temp}\egroup}%
6862 \fi}
6864 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
6866 % \braceorline decides whether the next nonwhitespace character is a
6867 % {. If so it reads up to the closing }, if not, it reads the whole
6868 % line. Whatever was read is then fed to the next control sequence
6869 % as an argument (by \parsebrace or \parsearg)
6870 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
6871 \def\braceorlinexxx{%
6872 \ifx\nchar\bgroup\else
6873 \expandafter\parsearg
6874 \fi \macnamexxx}
6877 % @alias.
6878 % We need some trickery to remove the optional spaces around the equal
6879 % sign. Just make them active and then expand them all to nothing.
6880 \def\alias{\parseargusing\obeyspaces\aliasxxx}
6881 \def\aliasxxx #1{\aliasyyy#1\relax}
6882 \def\aliasyyy #1=#2\relax{%
6884 \expandafter\let\obeyedspace=\empty
6885 \addtomacrolist{#1}%
6886 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
6888 \next
6892 \message{cross references,}
6894 \newwrite\auxfile
6895 \newif\ifhavexrefs % True if xref values are known.
6896 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
6898 % @inforef is relatively simple.
6899 \def\inforef #1{\inforefzzz #1,,,,**}
6900 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
6901 node \samp{\ignorespaces#1{}}}
6903 % @node's only job in TeX is to define \lastnode, which is used in
6904 % cross-references. The @node line might or might not have commas, and
6905 % might or might not have spaces before the first comma, like:
6906 % @node foo , bar , ...
6907 % We don't want such trailing spaces in the node name.
6909 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
6911 % also remove a trailing comma, in case of something like this:
6912 % @node Help-Cross, , , Cross-refs
6913 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
6914 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
6916 \let\nwnode=\node
6917 \let\lastnode=\empty
6919 % Write a cross-reference definition for the current node. #1 is the
6920 % type (Ynumbered, Yappendix, Ynothing).
6922 \def\donoderef#1{%
6923 \ifx\lastnode\empty\else
6924 \setref{\lastnode}{#1}%
6925 \global\let\lastnode=\empty
6929 % @anchor{NAME} -- define xref target at arbitrary point.
6931 \newcount\savesfregister
6933 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
6934 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
6935 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
6937 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
6938 % anchor), which consists of three parts:
6939 % 1) NAME-title - the current sectioning name taken from \lastsection,
6940 % or the anchor name.
6941 % 2) NAME-snt - section number and type, passed as the SNT arg, or
6942 % empty for anchors.
6943 % 3) NAME-pg - the page number.
6945 % This is called from \donoderef, \anchor, and \dofloat. In the case of
6946 % floats, there is an additional part, which is not written here:
6947 % 4) NAME-lof - the text as it should appear in a @listoffloats.
6949 \def\setref#1#2{%
6950 \pdfmkdest{#1}%
6951 \iflinks
6953 \atdummies % preserve commands, but don't expand them
6954 \edef\writexrdef##1##2{%
6955 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6956 ##1}{##2}}% these are parameters of \writexrdef
6958 \toks0 = \expandafter{\lastsection}%
6959 \immediate \writexrdef{title}{\the\toks0 }%
6960 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6961 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout
6966 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
6967 % the node name, #2 the name of the Info cross-reference, #3 the printed
6968 % node name, #4 the name of the Info file, #5 the name of the printed
6969 % manual. All but the node name can be omitted.
6971 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
6972 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
6973 \def\ref#1{\xrefX[#1,,,,,,,]}
6974 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
6975 \unsepspaces
6976 \def\printedmanual{\ignorespaces #5}%
6977 \def\printedrefname{\ignorespaces #3}%
6978 \setbox1=\hbox{\printedmanual\unskip}%
6979 \setbox0=\hbox{\printedrefname\unskip}%
6980 \ifdim \wd0 = 0pt
6981 % No printed node name was explicitly given.
6982 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
6983 % Use the node name inside the square brackets.
6984 \def\printedrefname{\ignorespaces #1}%
6985 \else
6986 % Use the actual chapter/section title appear inside
6987 % the square brackets. Use the real section title if we have it.
6988 \ifdim \wd1 > 0pt
6989 % It is in another manual, so we don't have it.
6990 \def\printedrefname{\ignorespaces #1}%
6991 \else
6992 \ifhavexrefs
6993 % We know the real title if we have the xref values.
6994 \def\printedrefname{\refx{#1-title}{}}%
6995 \else
6996 % Otherwise just copy the Info node name.
6997 \def\printedrefname{\ignorespaces #1}%
6998 \fi%
7003 % Make link in pdf output.
7004 \ifpdf
7005 {\indexnofonts
7006 \turnoffactive
7007 % This expands tokens, so do it after making catcode changes, so _
7008 % etc. don't get their TeX definitions.
7009 \getfilename{#4}%
7011 % See comments at \activebackslashdouble.
7012 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
7013 \backslashparens\pdfxrefdest}%
7015 \leavevmode
7016 \startlink attr{/Border [0 0 0]}%
7017 \ifnum\filenamelength>0
7018 goto file{\the\filename.pdf} name{\pdfxrefdest}%
7019 \else
7020 goto name{\pdfmkpgn{\pdfxrefdest}}%
7023 \setcolor{\linkcolor}%
7026 % Float references are printed completely differently: "Figure 1.2"
7027 % instead of "[somenode], p.3". We distinguish them by the
7028 % LABEL-title being set to a magic string.
7030 % Have to otherify everything special to allow the \csname to
7031 % include an _ in the xref name, etc.
7032 \indexnofonts
7033 \turnoffactive
7034 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7035 \csname XR#1-title\endcsname
7037 \iffloat\Xthisreftitle
7038 % If the user specified the print name (third arg) to the ref,
7039 % print it instead of our usual "Figure 1.2".
7040 \ifdim\wd0 = 0pt
7041 \refx{#1-snt}{}%
7042 \else
7043 \printedrefname
7046 % if the user also gave the printed manual name (fifth arg), append
7047 % "in MANUALNAME".
7048 \ifdim \wd1 > 0pt
7049 \space \putwordin{} \cite{\printedmanual}%
7051 \else
7052 % node/anchor (non-float) references.
7054 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7055 % insert empty discretionaries after hyphens, which means that it will
7056 % not find a line break at a hyphen in a node names. Since some manuals
7057 % are best written with fairly long node names, containing hyphens, this
7058 % is a loss. Therefore, we give the text of the node name again, so it
7059 % is as if TeX is seeing it for the first time.
7060 \ifdim \wd1 > 0pt
7061 \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7062 \else
7063 % _ (for example) has to be the character _ for the purposes of the
7064 % control sequence corresponding to the node, but it has to expand
7065 % into the usual \leavevmode...\vrule stuff for purposes of
7066 % printing. So we \turnoffactive for the \refx-snt, back on for the
7067 % printing, back off for the \refx-pg.
7068 {\turnoffactive
7069 % Only output a following space if the -snt ref is nonempty; for
7070 % @unnumbered and @anchor, it won't be.
7071 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7072 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7074 % output the `[mynode]' via a macro so it can be overridden.
7075 \xrefprintnodename\printedrefname
7077 % But we always want a comma and a space:
7078 ,\space
7080 % output the `page 3'.
7081 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7084 \endlink
7085 \endgroup}
7087 % This macro is called from \xrefX for the `[nodename]' part of xref
7088 % output. It's a separate macro only so it can be changed more easily,
7089 % since square brackets don't work well in some documents. Particularly
7090 % one that Bob is working on :).
7092 \def\xrefprintnodename#1{[#1]}
7094 % Things referred to by \setref.
7096 \def\Ynothing{}
7097 \def\Yomitfromtoc{}
7098 \def\Ynumbered{%
7099 \ifnum\secno=0
7100 \putwordChapter@tie \the\chapno
7101 \else \ifnum\subsecno=0
7102 \putwordSection@tie \the\chapno.\the\secno
7103 \else \ifnum\subsubsecno=0
7104 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7105 \else
7106 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7107 \fi\fi\fi
7109 \def\Yappendix{%
7110 \ifnum\secno=0
7111 \putwordAppendix@tie @char\the\appendixno{}%
7112 \else \ifnum\subsecno=0
7113 \putwordSection@tie @char\the\appendixno.\the\secno
7114 \else \ifnum\subsubsecno=0
7115 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7116 \else
7117 \putwordSection@tie
7118 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7119 \fi\fi\fi
7122 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7123 % If its value is nonempty, SUFFIX is output afterward.
7125 \def\refx#1#2{%
7127 \indexnofonts
7128 \otherbackslash
7129 \expandafter\global\expandafter\let\expandafter\thisrefX
7130 \csname XR#1\endcsname
7132 \ifx\thisrefX\relax
7133 % If not defined, say something at least.
7134 \angleleft un\-de\-fined\angleright
7135 \iflinks
7136 \ifhavexrefs
7137 \message{\linenumber Undefined cross reference `#1'.}%
7138 \else
7139 \ifwarnedxrefs\else
7140 \global\warnedxrefstrue
7141 \message{Cross reference values unknown; you must run TeX again.}%
7145 \else
7146 % It's defined, so just use it.
7147 \thisrefX
7149 #2% Output the suffix in any case.
7152 % This is the macro invoked by entries in the aux file. Usually it's
7153 % just a \def (we prepend XR to the control sequence name to avoid
7154 % collisions). But if this is a float type, we have more work to do.
7156 \def\xrdef#1#2{%
7157 {% The node name might contain 8-bit characters, which in our current
7158 % implementation are changed to commands like @'e. Don't let these
7159 % mess up the control sequence name.
7160 \indexnofonts
7161 \turnoffactive
7162 \xdef\safexrefname{#1}%
7165 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7167 % Was that xref control sequence that we just defined for a float?
7168 \expandafter\iffloat\csname XR\safexrefname\endcsname
7169 % it was a float, and we have the (safe) float type in \iffloattype.
7170 \expandafter\let\expandafter\floatlist
7171 \csname floatlist\iffloattype\endcsname
7173 % Is this the first time we've seen this float type?
7174 \expandafter\ifx\floatlist\relax
7175 \toks0 = {\do}% yes, so just \do
7176 \else
7177 % had it before, so preserve previous elements in list.
7178 \toks0 = \expandafter{\floatlist\do}%
7181 % Remember this xref in the control sequence \floatlistFLOATTYPE,
7182 % for later use in \listoffloats.
7183 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
7184 {\safexrefname}}%
7188 % Read the last existing aux file, if any. No error if none exists.
7190 \def\tryauxfile{%
7191 \openin 1 \jobname.aux
7192 \ifeof 1 \else
7193 \readdatafile{aux}%
7194 \global\havexrefstrue
7196 \closein 1
7199 \def\setupdatafile{%
7200 \catcode`\^^@=\other
7201 \catcode`\^^A=\other
7202 \catcode`\^^B=\other
7203 \catcode`\^^C=\other
7204 \catcode`\^^D=\other
7205 \catcode`\^^E=\other
7206 \catcode`\^^F=\other
7207 \catcode`\^^G=\other
7208 \catcode`\^^H=\other
7209 \catcode`\^^K=\other
7210 \catcode`\^^L=\other
7211 \catcode`\^^N=\other
7212 \catcode`\^^P=\other
7213 \catcode`\^^Q=\other
7214 \catcode`\^^R=\other
7215 \catcode`\^^S=\other
7216 \catcode`\^^T=\other
7217 \catcode`\^^U=\other
7218 \catcode`\^^V=\other
7219 \catcode`\^^W=\other
7220 \catcode`\^^X=\other
7221 \catcode`\^^Z=\other
7222 \catcode`\^^[=\other
7223 \catcode`\^^\=\other
7224 \catcode`\^^]=\other
7225 \catcode`\^^^=\other
7226 \catcode`\^^_=\other
7227 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
7228 % in xref tags, i.e., node names. But since ^^e4 notation isn't
7229 % supported in the main text, it doesn't seem desirable. Furthermore,
7230 % that is not enough: for node names that actually contain a ^
7231 % character, we would end up writing a line like this: 'xrdef {'hat
7232 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
7233 % argument, and \hat is not an expandable control sequence. It could
7234 % all be worked out, but why? Either we support ^^ or we don't.
7236 % The other change necessary for this was to define \auxhat:
7237 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
7238 % and then to call \auxhat in \setq.
7240 \catcode`\^=\other
7242 % Special characters. Should be turned off anyway, but...
7243 \catcode`\~=\other
7244 \catcode`\[=\other
7245 \catcode`\]=\other
7246 \catcode`\"=\other
7247 \catcode`\_=\other
7248 \catcode`\|=\other
7249 \catcode`\<=\other
7250 \catcode`\>=\other
7251 \catcode`\$=\other
7252 \catcode`\#=\other
7253 \catcode`\&=\other
7254 \catcode`\%=\other
7255 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
7257 % This is to support \ in node names and titles, since the \
7258 % characters end up in a \csname. It's easier than
7259 % leaving it active and making its active definition an actual \
7260 % character. What I don't understand is why it works in the *value*
7261 % of the xrdef. Seems like it should be a catcode12 \, and that
7262 % should not typeset properly. But it works, so I'm moving on for
7263 % now. --karl, 15jan04.
7264 \catcode`\\=\other
7266 % Make the characters 128-255 be printing characters.
7268 \count1=128
7269 \def\loop{%
7270 \catcode\count1=\other
7271 \advance\count1 by 1
7272 \ifnum \count1<256 \loop \fi
7276 % @ is our escape character in .aux files, and we need braces.
7277 \catcode`\{=1
7278 \catcode`\}=2
7279 \catcode`\@=0
7282 \def\readdatafile#1{%
7283 \begingroup
7284 \setupdatafile
7285 \input\jobname.#1
7286 \endgroup}
7289 \message{insertions,}
7290 % including footnotes.
7292 \newcount \footnoteno
7294 % The trailing space in the following definition for supereject is
7295 % vital for proper filling; pages come out unaligned when you do a
7296 % pagealignmacro call if that space before the closing brace is
7297 % removed. (Generally, numeric constants should always be followed by a
7298 % space to prevent strange expansion errors.)
7299 \def\supereject{\par\penalty -20000\footnoteno =0 }
7301 % @footnotestyle is meaningful for info output only.
7302 \let\footnotestyle=\comment
7304 {\catcode `\@=11
7306 % Auto-number footnotes. Otherwise like plain.
7307 \gdef\footnote{%
7308 \let\indent=\ptexindent
7309 \let\noindent=\ptexnoindent
7310 \global\advance\footnoteno by \@ne
7311 \edef\thisfootno{$^{\the\footnoteno}$}%
7313 % In case the footnote comes at the end of a sentence, preserve the
7314 % extra spacing after we do the footnote number.
7315 \let\@sf\empty
7316 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
7318 % Remove inadvertent blank space before typesetting the footnote number.
7319 \unskip
7320 \thisfootno\@sf
7321 \dofootnote
7324 % Don't bother with the trickery in plain.tex to not require the
7325 % footnote text as a parameter. Our footnotes don't need to be so general.
7327 % Oh yes, they do; otherwise, @ifset (and anything else that uses
7328 % \parseargline) fails inside footnotes because the tokens are fixed when
7329 % the footnote is read. --karl, 16nov96.
7331 \gdef\dofootnote{%
7332 \insert\footins\bgroup
7333 % We want to typeset this text as a normal paragraph, even if the
7334 % footnote reference occurs in (for example) a display environment.
7335 % So reset some parameters.
7336 \hsize=\pagewidth
7337 \interlinepenalty\interfootnotelinepenalty
7338 \splittopskip\ht\strutbox % top baseline for broken footnotes
7339 \splitmaxdepth\dp\strutbox
7340 \floatingpenalty\@MM
7341 \leftskip\z@skip
7342 \rightskip\z@skip
7343 \spaceskip\z@skip
7344 \xspaceskip\z@skip
7345 \parindent\defaultparindent
7347 \smallfonts \rm
7349 % Because we use hanging indentation in footnotes, a @noindent appears
7350 % to exdent this text, so make it be a no-op. makeinfo does not use
7351 % hanging indentation so @noindent can still be needed within footnote
7352 % text after an @example or the like (not that this is good style).
7353 \let\noindent = \relax
7355 % Hang the footnote text off the number. Use \everypar in case the
7356 % footnote extends for more than one paragraph.
7357 \everypar = {\hang}%
7358 \textindent{\thisfootno}%
7360 % Don't crash into the line above the footnote text. Since this
7361 % expands into a box, it must come within the paragraph, lest it
7362 % provide a place where TeX can split the footnote.
7363 \footstrut
7364 \futurelet\next\fo@t
7366 }%end \catcode `\@=11
7368 % In case a @footnote appears in a vbox, save the footnote text and create
7369 % the real \insert just after the vbox finished. Otherwise, the insertion
7370 % would be lost.
7371 % Similarly, if a @footnote appears inside an alignment, save the footnote
7372 % text to a box and make the \insert when a row of the table is finished.
7373 % And the same can be done for other insert classes. --kasal, 16nov03.
7375 % Replace the \insert primitive by a cheating macro.
7376 % Deeper inside, just make sure that the saved insertions are not spilled
7377 % out prematurely.
7379 \def\startsavinginserts{%
7380 \ifx \insert\ptexinsert
7381 \let\insert\saveinsert
7382 \else
7383 \let\checkinserts\relax
7387 % This \insert replacement works for both \insert\footins{foo} and
7388 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
7390 \def\saveinsert#1{%
7391 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
7392 \afterassignment\next
7393 % swallow the left brace
7394 \let\temp =
7396 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
7397 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
7399 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
7401 \def\placesaveins#1{%
7402 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
7403 {\box#1}%
7406 % eat @SAVE -- beware, all of them have catcode \other:
7408 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
7409 \gdef\gobblesave @SAVE{}
7412 % initialization:
7413 \def\newsaveins #1{%
7414 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
7415 \next
7417 \def\newsaveinsX #1{%
7418 \csname newbox\endcsname #1%
7419 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7420 \checksaveins #1}%
7423 % initialize:
7424 \let\checkinserts\empty
7425 \newsaveins\footins
7426 \newsaveins\margin
7429 % @image. We use the macros from epsf.tex to support this.
7430 % If epsf.tex is not installed and @image is used, we complain.
7432 % Check for and read epsf.tex up front. If we read it only at @image
7433 % time, we might be inside a group, and then its definitions would get
7434 % undone and the next image would fail.
7435 \openin 1 = epsf.tex
7436 \ifeof 1 \else
7437 % Do not bother showing banner with epsf.tex v2.7k (available in
7438 % doc/epsf.tex and on ctan).
7439 \def\epsfannounce{\toks0 = }%
7440 \input epsf.tex
7442 \closein 1
7444 % We will only complain once about lack of epsf.tex.
7445 \newif\ifwarnednoepsf
7446 \newhelp\noepsfhelp{epsf.tex must be installed for images to
7447 work. It is also included in the Texinfo distribution, or you can get
7448 it from ftp://tug.org/tex/epsf.tex.}
7450 \def\image#1{%
7451 \ifx\epsfbox\undefined
7452 \ifwarnednoepsf \else
7453 \errhelp = \noepsfhelp
7454 \errmessage{epsf.tex not found, images will be ignored}%
7455 \global\warnednoepsftrue
7457 \else
7458 \imagexxx #1,,,,,\finish
7462 % Arguments to @image:
7463 % #1 is (mandatory) image filename; we tack on .eps extension.
7464 % #2 is (optional) width, #3 is (optional) height.
7465 % #4 is (ignored optional) html alt text.
7466 % #5 is (ignored optional) extension.
7467 % #6 is just the usual extra ignored arg for parsing this stuff.
7468 \newif\ifimagevmode
7469 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7470 \catcode`\^^M = 5 % in case we're inside an example
7471 \normalturnoffactive % allow _ et al. in names
7472 % If the image is by itself, center it.
7473 \ifvmode
7474 \imagevmodetrue
7475 \nobreak\medskip
7476 % Usually we'll have text after the image which will insert
7477 % \parskip glue, so insert it here too to equalize the space
7478 % above and below.
7479 \nobreak\vskip\parskip
7480 \nobreak
7483 % Leave vertical mode so that indentation from an enclosing
7484 % environment such as @quotation is respected. On the other hand, if
7485 % it's at the top level, we don't want the normal paragraph indentation.
7486 \noindent
7488 % Output the image.
7489 \ifpdf
7490 \dopdfimage{#1}{#2}{#3}%
7491 \else
7492 % \epsfbox itself resets \epsf?size at each figure.
7493 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
7494 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7495 \epsfbox{#1.eps}%
7498 \ifimagevmode \medskip \fi % space after the standalone image
7499 \endgroup}
7502 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7503 % etc. We don't actually implement floating yet, we always include the
7504 % float "here". But it seemed the best name for the future.
7506 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7508 % There may be a space before second and/or third parameter; delete it.
7509 \def\eatcommaspace#1, {#1,}
7511 % #1 is the optional FLOATTYPE, the text label for this float, typically
7512 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
7513 % this float will not be numbered and cannot be referred to.
7515 % #2 is the optional xref label. Also must be present for the float to
7516 % be referable.
7518 % #3 is the optional positioning argument; for now, it is ignored. It
7519 % will somehow specify the positions allowed to float to (here, top, bottom).
7521 % We keep a separate counter for each FLOATTYPE, which we reset at each
7522 % chapter-level command.
7523 \let\resetallfloatnos=\empty
7525 \def\dofloat#1,#2,#3,#4\finish{%
7526 \let\thiscaption=\empty
7527 \let\thisshortcaption=\empty
7529 % don't lose footnotes inside @float.
7531 % BEWARE: when the floats start float, we have to issue warning whenever an
7532 % insert appears inside a float which could possibly float. --kasal, 26may04
7534 \startsavinginserts
7536 % We can't be used inside a paragraph.
7537 \par
7539 \vtop\bgroup
7540 \def\floattype{#1}%
7541 \def\floatlabel{#2}%
7542 \def\floatloc{#3}% we do nothing with this yet.
7544 \ifx\floattype\empty
7545 \let\safefloattype=\empty
7546 \else
7548 % the floattype might have accents or other special characters,
7549 % but we need to use it in a control sequence name.
7550 \indexnofonts
7551 \turnoffactive
7552 \xdef\safefloattype{\floattype}%
7556 % If label is given but no type, we handle that as the empty type.
7557 \ifx\floatlabel\empty \else
7558 % We want each FLOATTYPE to be numbered separately (Figure 1,
7559 % Table 1, Figure 2, ...). (And if no label, no number.)
7561 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7562 \global\advance\floatno by 1
7565 % This magic value for \lastsection is output by \setref as the
7566 % XREFLABEL-title value. \xrefX uses it to distinguish float
7567 % labels (which have a completely different output format) from
7568 % node and anchor labels. And \xrdef uses it to construct the
7569 % lists of floats.
7571 \edef\lastsection{\floatmagic=\safefloattype}%
7572 \setref{\floatlabel}{Yfloat}%
7576 % start with \parskip glue, I guess.
7577 \vskip\parskip
7579 % Don't suppress indentation if a float happens to start a section.
7580 \restorefirstparagraphindent
7583 % we have these possibilities:
7584 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7585 % @float Foo,lbl & no caption: Foo 1.1
7586 % @float Foo & @caption{Cap}: Foo: Cap
7587 % @float Foo & no caption: Foo
7588 % @float ,lbl & Caption{Cap}: 1.1: Cap
7589 % @float ,lbl & no caption: 1.1
7590 % @float & @caption{Cap}: Cap
7591 % @float & no caption:
7593 \def\Efloat{%
7594 \let\floatident = \empty
7596 % In all cases, if we have a float type, it comes first.
7597 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7599 % If we have an xref label, the number comes next.
7600 \ifx\floatlabel\empty \else
7601 \ifx\floattype\empty \else % if also had float type, need tie first.
7602 \appendtomacro\floatident{\tie}%
7604 % the number.
7605 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
7608 % Start the printed caption with what we've constructed in
7609 % \floatident, but keep it separate; we need \floatident again.
7610 \let\captionline = \floatident
7612 \ifx\thiscaption\empty \else
7613 \ifx\floatident\empty \else
7614 \appendtomacro\captionline{: }% had ident, so need a colon between
7617 % caption text.
7618 \appendtomacro\captionline{\scanexp\thiscaption}%
7621 % If we have anything to print, print it, with space before.
7622 % Eventually this needs to become an \insert.
7623 \ifx\captionline\empty \else
7624 \vskip.5\parskip
7625 \captionline
7627 % Space below caption.
7628 \vskip\parskip
7631 % If have an xref label, write the list of floats info. Do this
7632 % after the caption, to avoid chance of it being a breakpoint.
7633 \ifx\floatlabel\empty \else
7634 % Write the text that goes in the lof to the aux file as
7635 % \floatlabel-lof. Besides \floatident, we include the short
7636 % caption if specified, else the full caption if specified, else nothing.
7638 \atdummies
7640 % since we read the caption text in the macro world, where ^^M
7641 % is turned into a normal character, we have to scan it back, so
7642 % we don't write the literal three characters "^^M" into the aux file.
7643 \scanexp{%
7644 \xdef\noexpand\gtemp{%
7645 \ifx\thisshortcaption\empty
7646 \thiscaption
7647 \else
7648 \thisshortcaption
7652 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7653 \ifx\gtemp\empty \else : \gtemp \fi}}%
7656 \egroup % end of \vtop
7658 % place the captured inserts
7660 % BEWARE: when the floats start floating, we have to issue warning
7661 % whenever an insert appears inside a float which could possibly
7662 % float. --kasal, 26may04
7664 \checkinserts
7667 % Append the tokens #2 to the definition of macro #1, not expanding either.
7669 \def\appendtomacro#1#2{%
7670 \expandafter\def\expandafter#1\expandafter{#1#2}%
7673 % @caption, @shortcaption
7675 \def\caption{\docaption\thiscaption}
7676 \def\shortcaption{\docaption\thisshortcaption}
7677 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7678 \def\defcaption#1#2{\egroup \def#1{#2}}
7680 % The parameter is the control sequence identifying the counter we are
7681 % going to use. Create it if it doesn't exist and assign it to \floatno.
7682 \def\getfloatno#1{%
7683 \ifx#1\relax
7684 % Haven't seen this figure type before.
7685 \csname newcount\endcsname #1%
7687 % Remember to reset this floatno at the next chap.
7688 \expandafter\gdef\expandafter\resetallfloatnos
7689 \expandafter{\resetallfloatnos #1=0 }%
7691 \let\floatno#1%
7694 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
7695 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
7696 % first read the @float command.
7698 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7700 % Magic string used for the XREFLABEL-title value, so \xrefX can
7701 % distinguish floats from other xref types.
7702 \def\floatmagic{!!float!!}
7704 % #1 is the control sequence we are passed; we expand into a conditional
7705 % which is true if #1 represents a float ref. That is, the magic
7706 % \lastsection value which we \setref above.
7708 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7710 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
7711 % (safe) float type for this float. We set \iffloattype to #2.
7713 \def\doiffloat#1=#2=#3\finish{%
7714 \def\temp{#1}%
7715 \def\iffloattype{#2}%
7716 \ifx\temp\floatmagic
7719 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7721 \parseargdef\listoffloats{%
7722 \def\floattype{#1}% floattype
7724 % the floattype might have accents or other special characters,
7725 % but we need to use it in a control sequence name.
7726 \indexnofonts
7727 \turnoffactive
7728 \xdef\safefloattype{\floattype}%
7731 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7732 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7733 \ifhavexrefs
7734 % if the user said @listoffloats foo but never @float foo.
7735 \message{\linenumber No `\safefloattype' floats to list.}%
7737 \else
7738 \begingroup
7739 \leftskip=\tocindent % indent these entries like a toc
7740 \let\do=\listoffloatsdo
7741 \csname floatlist\safefloattype\endcsname
7742 \endgroup
7746 % This is called on each entry in a list of floats. We're passed the
7747 % xref label, in the form LABEL-title, which is how we save it in the
7748 % aux file. We strip off the -title and look up \XRLABEL-lof, which
7749 % has the text we're supposed to typeset here.
7751 % Figures without xref labels will not be included in the list (since
7752 % they won't appear in the aux file).
7754 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7755 \def\listoffloatsdoentry#1-title\finish{{%
7756 % Can't fully expand XR#1-lof because it can contain anything. Just
7757 % pass the control sequence. On the other hand, XR#1-pg is just the
7758 % page number, and we want to fully expand that so we can get a link
7759 % in pdf output.
7760 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
7762 % use the same \entry macro we use to generate the TOC and index.
7763 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7764 \writeentry
7768 \message{localization,}
7770 % For single-language documents, @documentlanguage is usually given very
7771 % early, just after @documentencoding. Single argument is the language
7772 % (de) or locale (de_DE) abbreviation.
7775 \catcode`\_ = \active
7776 \globaldefs=1
7777 \parseargdef\documentlanguage{\begingroup
7778 \let_=\normalunderscore % normal _ character for filenames
7779 \tex % read txi-??.tex file in plain TeX.
7780 % Read the file by the name they passed if it exists.
7781 \openin 1 txi-#1.tex
7782 \ifeof 1
7783 \documentlanguagetrywithoutunderscore{#1_\finish}%
7784 \else
7785 \globaldefs = 1 % everything in the txi-LL files needs to persist
7786 \input txi-#1.tex
7788 \closein 1
7789 \endgroup % end raw TeX
7790 \endgroup}
7793 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
7794 % try txi-de.tex.
7796 \def\documentlanguagetrywithoutunderscore#1_#2\finish{%
7797 \openin 1 txi-#1.tex
7798 \ifeof 1
7799 \errhelp = \nolanghelp
7800 \errmessage{Cannot read language file txi-#1.tex}%
7801 \else
7802 \input txi-#1.tex
7804 \closein 1
7807 \newhelp\nolanghelp{The given language definition file cannot be found or
7808 is empty. Maybe you need to install it? Putting it in the current
7809 directory should work if nowhere else does.}
7811 % This macro is called from txi-??.tex files; the first argument is the
7812 % \language name to set (without the "\lang@" prefix), the second and
7813 % third args are \{left,right}hyphenmin.
7815 % The language names to pass are determined when the format is built.
7816 % See the etex.log file created at that time, e.g.,
7817 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
7819 % With TeX Live 2008, etex now includes hyphenation patterns for all
7820 % available languages. This means we can support hyphenation in
7821 % Texinfo, at least to some extent. (This still doesn't solve the
7822 % accented characters problem.)
7824 \catcode`@=11
7825 \def\txisetlanguage#1#2#3{%
7826 % do not set the language if the name is undefined in the current TeX.
7827 \expandafter\ifx\csname lang@#1\endcsname \relax
7828 \message{no patterns for #1}%
7829 \else
7830 \global\language = \csname lang@#1\endcsname
7832 % but there is no harm in adjusting the hyphenmin values regardless.
7833 \global\lefthyphenmin = #2\relax
7834 \global\righthyphenmin = #3\relax
7837 % Helpers for encodings.
7838 % Set the catcode of characters 128 through 255 to the specified number.
7840 \def\setnonasciicharscatcode#1{%
7841 \count255=128
7842 \loop\ifnum\count255<256
7843 \global\catcode\count255=#1\relax
7844 \advance\count255 by 1
7845 \repeat
7848 \def\setnonasciicharscatcodenonglobal#1{%
7849 \count255=128
7850 \loop\ifnum\count255<256
7851 \catcode\count255=#1\relax
7852 \advance\count255 by 1
7853 \repeat
7856 % @documentencoding sets the definition of non-ASCII characters
7857 % according to the specified encoding.
7859 \parseargdef\documentencoding{%
7860 % Encoding being declared for the document.
7861 \def\declaredencoding{\csname #1.enc\endcsname}%
7863 % Supported encodings: names converted to tokens in order to be able
7864 % to compare them with \ifx.
7865 \def\ascii{\csname US-ASCII.enc\endcsname}%
7866 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
7867 \def\latone{\csname ISO-8859-1.enc\endcsname}%
7868 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
7869 \def\utfeight{\csname UTF-8.enc\endcsname}%
7871 \ifx \declaredencoding \ascii
7872 \asciichardefs
7874 \else \ifx \declaredencoding \lattwo
7875 \setnonasciicharscatcode\active
7876 \lattwochardefs
7878 \else \ifx \declaredencoding \latone
7879 \setnonasciicharscatcode\active
7880 \latonechardefs
7882 \else \ifx \declaredencoding \latnine
7883 \setnonasciicharscatcode\active
7884 \latninechardefs
7886 \else \ifx \declaredencoding \utfeight
7887 \setnonasciicharscatcode\active
7888 \utfeightchardefs
7890 \else
7891 \message{Unknown document encoding #1, ignoring.}%
7893 \fi % utfeight
7894 \fi % latnine
7895 \fi % latone
7896 \fi % lattwo
7897 \fi % ascii
7900 % A message to be logged when using a character that isn't available
7901 % the default font encoding (OT1).
7903 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
7905 % Take account of \c (plain) vs. \, (Texinfo) difference.
7906 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
7908 % First, make active non-ASCII characters in order for them to be
7909 % correctly categorized when TeX reads the replacement text of
7910 % macros containing the character definitions.
7911 \setnonasciicharscatcode\active
7913 % Latin1 (ISO-8859-1) character definitions.
7914 \def\latonechardefs{%
7915 \gdef^^a0{~}
7916 \gdef^^a1{\exclamdown}
7917 \gdef^^a2{\missingcharmsg{CENT SIGN}}
7918 \gdef^^a3{{\pounds}}
7919 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7920 \gdef^^a5{\missingcharmsg{YEN SIGN}}
7921 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
7922 \gdef^^a7{\S}
7923 \gdef^^a8{\"{}}
7924 \gdef^^a9{\copyright}
7925 \gdef^^aa{\ordf}
7926 \gdef^^ab{\missingcharmsg{LEFT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7927 \gdef^^ac{$\lnot$}
7928 \gdef^^ad{\-}
7929 \gdef^^ae{\registeredsymbol}
7930 \gdef^^af{\={}}
7932 \gdef^^b0{\textdegree}
7933 \gdef^^b1{$\pm$}
7934 \gdef^^b2{$^2$}
7935 \gdef^^b3{$^3$}
7936 \gdef^^b4{\'{}}
7937 \gdef^^b5{$\mu$}
7938 \gdef^^b6{\P}
7940 \gdef^^b7{$^.$}
7941 \gdef^^b8{\cedilla\ }
7942 \gdef^^b9{$^1$}
7943 \gdef^^ba{\ordm}
7945 \gdef^^bb{\missingcharmsg{RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7946 \gdef^^bc{$1\over4$}
7947 \gdef^^bd{$1\over2$}
7948 \gdef^^be{$3\over4$}
7949 \gdef^^bf{\questiondown}
7951 \gdef^^c0{\`A}
7952 \gdef^^c1{\'A}
7953 \gdef^^c2{\^A}
7954 \gdef^^c3{\~A}
7955 \gdef^^c4{\"A}
7956 \gdef^^c5{\ringaccent A}
7957 \gdef^^c6{\AE}
7958 \gdef^^c7{\cedilla C}
7959 \gdef^^c8{\`E}
7960 \gdef^^c9{\'E}
7961 \gdef^^ca{\^E}
7962 \gdef^^cb{\"E}
7963 \gdef^^cc{\`I}
7964 \gdef^^cd{\'I}
7965 \gdef^^ce{\^I}
7966 \gdef^^cf{\"I}
7968 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER ETH}}
7969 \gdef^^d1{\~N}
7970 \gdef^^d2{\`O}
7971 \gdef^^d3{\'O}
7972 \gdef^^d4{\^O}
7973 \gdef^^d5{\~O}
7974 \gdef^^d6{\"O}
7975 \gdef^^d7{$\times$}
7976 \gdef^^d8{\O}
7977 \gdef^^d9{\`U}
7978 \gdef^^da{\'U}
7979 \gdef^^db{\^U}
7980 \gdef^^dc{\"U}
7981 \gdef^^dd{\'Y}
7982 \gdef^^de{\missingcharmsg{LATIN CAPITAL LETTER THORN}}
7983 \gdef^^df{\ss}
7985 \gdef^^e0{\`a}
7986 \gdef^^e1{\'a}
7987 \gdef^^e2{\^a}
7988 \gdef^^e3{\~a}
7989 \gdef^^e4{\"a}
7990 \gdef^^e5{\ringaccent a}
7991 \gdef^^e6{\ae}
7992 \gdef^^e7{\cedilla c}
7993 \gdef^^e8{\`e}
7994 \gdef^^e9{\'e}
7995 \gdef^^ea{\^e}
7996 \gdef^^eb{\"e}
7997 \gdef^^ec{\`{\dotless i}}
7998 \gdef^^ed{\'{\dotless i}}
7999 \gdef^^ee{\^{\dotless i}}
8000 \gdef^^ef{\"{\dotless i}}
8002 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER ETH}}
8003 \gdef^^f1{\~n}
8004 \gdef^^f2{\`o}
8005 \gdef^^f3{\'o}
8006 \gdef^^f4{\^o}
8007 \gdef^^f5{\~o}
8008 \gdef^^f6{\"o}
8009 \gdef^^f7{$\div$}
8010 \gdef^^f8{\o}
8011 \gdef^^f9{\`u}
8012 \gdef^^fa{\'u}
8013 \gdef^^fb{\^u}
8014 \gdef^^fc{\"u}
8015 \gdef^^fd{\'y}
8016 \gdef^^fe{\missingcharmsg{LATIN SMALL LETTER THORN}}
8017 \gdef^^ff{\"y}
8020 % Latin9 (ISO-8859-15) encoding character definitions.
8021 \def\latninechardefs{%
8022 % Encoding is almost identical to Latin1.
8023 \latonechardefs
8025 \gdef^^a4{\euro}
8026 \gdef^^a6{\v S}
8027 \gdef^^a8{\v s}
8028 \gdef^^b4{\v Z}
8029 \gdef^^b8{\v z}
8030 \gdef^^bc{\OE}
8031 \gdef^^bd{\oe}
8032 \gdef^^be{\"Y}
8035 % Latin2 (ISO-8859-2) character definitions.
8036 \def\lattwochardefs{%
8037 \gdef^^a0{~}
8038 \gdef^^a1{\Aogonek}
8039 \gdef^^a2{\u{}}
8040 \gdef^^a3{\L}
8041 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8042 \gdef^^a5{\v L}
8043 \gdef^^a6{\'S}
8044 \gdef^^a7{\S}
8045 \gdef^^a8{\"{}}
8046 \gdef^^a9{\v S}
8047 \gdef^^aa{\cedilla S}
8048 \gdef^^ab{\v T}
8049 \gdef^^ac{\'Z}
8050 \gdef^^ad{\-}
8051 \gdef^^ae{\v Z}
8052 \gdef^^af{\dotaccent Z}
8054 \gdef^^b0{\textdegree}
8055 \gdef^^b1{\aogonek}
8056 \gdef^^b2{\ogonek{ }}
8057 \gdef^^b3{\l}
8058 \gdef^^b4{\'{}}
8059 \gdef^^b5{\v l}
8060 \gdef^^b6{\'s}
8061 \gdef^^b7{\v{}}
8062 \gdef^^b8{\cedilla\ }
8063 \gdef^^b9{\v s}
8064 \gdef^^ba{\cedilla s}
8065 \gdef^^bb{\v t}
8066 \gdef^^bc{\'z}
8067 \gdef^^bd{\H{}}
8068 \gdef^^be{\v z}
8069 \gdef^^bf{\dotaccent z}
8071 \gdef^^c0{\'R}
8072 \gdef^^c1{\'A}
8073 \gdef^^c2{\^A}
8074 \gdef^^c3{\u A}
8075 \gdef^^c4{\"A}
8076 \gdef^^c5{\'L}
8077 \gdef^^c6{\'C}
8078 \gdef^^c7{\cedilla C}
8079 \gdef^^c8{\v C}
8080 \gdef^^c9{\'E}
8081 \gdef^^ca{\Eogonek}
8082 \gdef^^cb{\"E}
8083 \gdef^^cc{\v E}
8084 \gdef^^cd{\'I}
8085 \gdef^^ce{\^I}
8086 \gdef^^cf{\v D}
8088 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER D WITH STROKE}}
8089 \gdef^^d1{\'N}
8090 \gdef^^d2{\v N}
8091 \gdef^^d3{\'O}
8092 \gdef^^d4{\^O}
8093 \gdef^^d5{\H O}
8094 \gdef^^d6{\"O}
8095 \gdef^^d7{$\times$}
8096 \gdef^^d8{\v R}
8097 \gdef^^d9{\ringaccent U}
8098 \gdef^^da{\'U}
8099 \gdef^^db{\H U}
8100 \gdef^^dc{\"U}
8101 \gdef^^dd{\'Y}
8102 \gdef^^de{\cedilla T}
8103 \gdef^^df{\ss}
8105 \gdef^^e0{\'r}
8106 \gdef^^e1{\'a}
8107 \gdef^^e2{\^a}
8108 \gdef^^e3{\u a}
8109 \gdef^^e4{\"a}
8110 \gdef^^e5{\'l}
8111 \gdef^^e6{\'c}
8112 \gdef^^e7{\cedilla c}
8113 \gdef^^e8{\v c}
8114 \gdef^^e9{\'e}
8115 \gdef^^ea{\eogonek}
8116 \gdef^^eb{\"e}
8117 \gdef^^ec{\v e}
8118 \gdef^^ed{\'\i}
8119 \gdef^^ee{\^\i}
8120 \gdef^^ef{\v d}
8122 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER D WITH STROKE}}
8123 \gdef^^f1{\'n}
8124 \gdef^^f2{\v n}
8125 \gdef^^f3{\'o}
8126 \gdef^^f4{\^o}
8127 \gdef^^f5{\H o}
8128 \gdef^^f6{\"o}
8129 \gdef^^f7{$\div$}
8130 \gdef^^f8{\v r}
8131 \gdef^^f9{\ringaccent u}
8132 \gdef^^fa{\'u}
8133 \gdef^^fb{\H u}
8134 \gdef^^fc{\"u}
8135 \gdef^^fd{\'y}
8136 \gdef^^fe{\cedilla t}
8137 \gdef^^ff{\dotaccent{}}
8140 % UTF-8 character definitions.
8142 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8143 % changes for Texinfo conventions. It is included here under the GPL by
8144 % permission from Frank Mittelbach and the LaTeX team.
8146 \newcount\countUTFx
8147 \newcount\countUTFy
8148 \newcount\countUTFz
8150 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8151 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8153 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8154 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8156 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8157 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8159 \gdef\UTFviiiDefined#1{%
8160 \ifx #1\relax
8161 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8162 \else
8163 \expandafter #1%
8167 \begingroup
8168 \catcode`\~13
8169 \catcode`\"12
8171 \def\UTFviiiLoop{%
8172 \global\catcode\countUTFx\active
8173 \uccode`\~\countUTFx
8174 \uppercase\expandafter{\UTFviiiTmp}%
8175 \advance\countUTFx by 1
8176 \ifnum\countUTFx < \countUTFy
8177 \expandafter\UTFviiiLoop
8178 \fi}
8180 \countUTFx = "C2
8181 \countUTFy = "E0
8182 \def\UTFviiiTmp{%
8183 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
8184 \UTFviiiLoop
8186 \countUTFx = "E0
8187 \countUTFy = "F0
8188 \def\UTFviiiTmp{%
8189 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
8190 \UTFviiiLoop
8192 \countUTFx = "F0
8193 \countUTFy = "F4
8194 \def\UTFviiiTmp{%
8195 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
8196 \UTFviiiLoop
8197 \endgroup
8199 \begingroup
8200 \catcode`\"=12
8201 \catcode`\<=12
8202 \catcode`\.=12
8203 \catcode`\,=12
8204 \catcode`\;=12
8205 \catcode`\!=12
8206 \catcode`\~=13
8208 \gdef\DeclareUnicodeCharacter#1#2{%
8209 \countUTFz = "#1\relax
8210 \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
8211 \begingroup
8212 \parseXMLCharref
8213 \def\UTFviiiTwoOctets##1##2{%
8214 \csname u8:##1\string ##2\endcsname}%
8215 \def\UTFviiiThreeOctets##1##2##3{%
8216 \csname u8:##1\string ##2\string ##3\endcsname}%
8217 \def\UTFviiiFourOctets##1##2##3##4{%
8218 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
8219 \expandafter\expandafter\expandafter\expandafter
8220 \expandafter\expandafter\expandafter
8221 \gdef\UTFviiiTmp{#2}%
8222 \endgroup}
8224 \gdef\parseXMLCharref{%
8225 \ifnum\countUTFz < "A0\relax
8226 \errhelp = \EMsimple
8227 \errmessage{Cannot define Unicode char value < 00A0}%
8228 \else\ifnum\countUTFz < "800\relax
8229 \parseUTFviiiA,%
8230 \parseUTFviiiB C\UTFviiiTwoOctets.,%
8231 \else\ifnum\countUTFz < "10000\relax
8232 \parseUTFviiiA;%
8233 \parseUTFviiiA,%
8234 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
8235 \else
8236 \parseUTFviiiA;%
8237 \parseUTFviiiA,%
8238 \parseUTFviiiA!%
8239 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
8240 \fi\fi\fi
8243 \gdef\parseUTFviiiA#1{%
8244 \countUTFx = \countUTFz
8245 \divide\countUTFz by 64
8246 \countUTFy = \countUTFz
8247 \multiply\countUTFz by 64
8248 \advance\countUTFx by -\countUTFz
8249 \advance\countUTFx by 128
8250 \uccode `#1\countUTFx
8251 \countUTFz = \countUTFy}
8253 \gdef\parseUTFviiiB#1#2#3#4{%
8254 \advance\countUTFz by "#10\relax
8255 \uccode `#3\countUTFz
8256 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
8257 \endgroup
8259 \def\utfeightchardefs{%
8260 \DeclareUnicodeCharacter{00A0}{\tie}
8261 \DeclareUnicodeCharacter{00A1}{\exclamdown}
8262 \DeclareUnicodeCharacter{00A3}{\pounds}
8263 \DeclareUnicodeCharacter{00A8}{\"{ }}
8264 \DeclareUnicodeCharacter{00A9}{\copyright}
8265 \DeclareUnicodeCharacter{00AA}{\ordf}
8266 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
8267 \DeclareUnicodeCharacter{00AD}{\-}
8268 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
8269 \DeclareUnicodeCharacter{00AF}{\={ }}
8271 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
8272 \DeclareUnicodeCharacter{00B4}{\'{ }}
8273 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
8274 \DeclareUnicodeCharacter{00BA}{\ordm}
8275 \DeclareUnicodeCharacter{00BB}{\guillemetright}
8276 \DeclareUnicodeCharacter{00BF}{\questiondown}
8278 \DeclareUnicodeCharacter{00C0}{\`A}
8279 \DeclareUnicodeCharacter{00C1}{\'A}
8280 \DeclareUnicodeCharacter{00C2}{\^A}
8281 \DeclareUnicodeCharacter{00C3}{\~A}
8282 \DeclareUnicodeCharacter{00C4}{\"A}
8283 \DeclareUnicodeCharacter{00C5}{\AA}
8284 \DeclareUnicodeCharacter{00C6}{\AE}
8285 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
8286 \DeclareUnicodeCharacter{00C8}{\`E}
8287 \DeclareUnicodeCharacter{00C9}{\'E}
8288 \DeclareUnicodeCharacter{00CA}{\^E}
8289 \DeclareUnicodeCharacter{00CB}{\"E}
8290 \DeclareUnicodeCharacter{00CC}{\`I}
8291 \DeclareUnicodeCharacter{00CD}{\'I}
8292 \DeclareUnicodeCharacter{00CE}{\^I}
8293 \DeclareUnicodeCharacter{00CF}{\"I}
8295 \DeclareUnicodeCharacter{00D1}{\~N}
8296 \DeclareUnicodeCharacter{00D2}{\`O}
8297 \DeclareUnicodeCharacter{00D3}{\'O}
8298 \DeclareUnicodeCharacter{00D4}{\^O}
8299 \DeclareUnicodeCharacter{00D5}{\~O}
8300 \DeclareUnicodeCharacter{00D6}{\"O}
8301 \DeclareUnicodeCharacter{00D8}{\O}
8302 \DeclareUnicodeCharacter{00D9}{\`U}
8303 \DeclareUnicodeCharacter{00DA}{\'U}
8304 \DeclareUnicodeCharacter{00DB}{\^U}
8305 \DeclareUnicodeCharacter{00DC}{\"U}
8306 \DeclareUnicodeCharacter{00DD}{\'Y}
8307 \DeclareUnicodeCharacter{00DF}{\ss}
8309 \DeclareUnicodeCharacter{00E0}{\`a}
8310 \DeclareUnicodeCharacter{00E1}{\'a}
8311 \DeclareUnicodeCharacter{00E2}{\^a}
8312 \DeclareUnicodeCharacter{00E3}{\~a}
8313 \DeclareUnicodeCharacter{00E4}{\"a}
8314 \DeclareUnicodeCharacter{00E5}{\aa}
8315 \DeclareUnicodeCharacter{00E6}{\ae}
8316 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
8317 \DeclareUnicodeCharacter{00E8}{\`e}
8318 \DeclareUnicodeCharacter{00E9}{\'e}
8319 \DeclareUnicodeCharacter{00EA}{\^e}
8320 \DeclareUnicodeCharacter{00EB}{\"e}
8321 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
8322 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
8323 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
8324 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
8326 \DeclareUnicodeCharacter{00F1}{\~n}
8327 \DeclareUnicodeCharacter{00F2}{\`o}
8328 \DeclareUnicodeCharacter{00F3}{\'o}
8329 \DeclareUnicodeCharacter{00F4}{\^o}
8330 \DeclareUnicodeCharacter{00F5}{\~o}
8331 \DeclareUnicodeCharacter{00F6}{\"o}
8332 \DeclareUnicodeCharacter{00F8}{\o}
8333 \DeclareUnicodeCharacter{00F9}{\`u}
8334 \DeclareUnicodeCharacter{00FA}{\'u}
8335 \DeclareUnicodeCharacter{00FB}{\^u}
8336 \DeclareUnicodeCharacter{00FC}{\"u}
8337 \DeclareUnicodeCharacter{00FD}{\'y}
8338 \DeclareUnicodeCharacter{00FF}{\"y}
8340 \DeclareUnicodeCharacter{0100}{\=A}
8341 \DeclareUnicodeCharacter{0101}{\=a}
8342 \DeclareUnicodeCharacter{0102}{\u{A}}
8343 \DeclareUnicodeCharacter{0103}{\u{a}}
8344 \DeclareUnicodeCharacter{0104}{\Aogonek}
8345 \DeclareUnicodeCharacter{0105}{\aogonek}
8346 \DeclareUnicodeCharacter{0106}{\'C}
8347 \DeclareUnicodeCharacter{0107}{\'c}
8348 \DeclareUnicodeCharacter{0108}{\^C}
8349 \DeclareUnicodeCharacter{0109}{\^c}
8350 \DeclareUnicodeCharacter{0118}{\Eogonek}
8351 \DeclareUnicodeCharacter{0119}{\eogonek}
8352 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
8353 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
8354 \DeclareUnicodeCharacter{010C}{\v{C}}
8355 \DeclareUnicodeCharacter{010D}{\v{c}}
8356 \DeclareUnicodeCharacter{010E}{\v{D}}
8358 \DeclareUnicodeCharacter{0112}{\=E}
8359 \DeclareUnicodeCharacter{0113}{\=e}
8360 \DeclareUnicodeCharacter{0114}{\u{E}}
8361 \DeclareUnicodeCharacter{0115}{\u{e}}
8362 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
8363 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
8364 \DeclareUnicodeCharacter{011A}{\v{E}}
8365 \DeclareUnicodeCharacter{011B}{\v{e}}
8366 \DeclareUnicodeCharacter{011C}{\^G}
8367 \DeclareUnicodeCharacter{011D}{\^g}
8368 \DeclareUnicodeCharacter{011E}{\u{G}}
8369 \DeclareUnicodeCharacter{011F}{\u{g}}
8371 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8372 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8373 \DeclareUnicodeCharacter{0124}{\^H}
8374 \DeclareUnicodeCharacter{0125}{\^h}
8375 \DeclareUnicodeCharacter{0128}{\~I}
8376 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8377 \DeclareUnicodeCharacter{012A}{\=I}
8378 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8379 \DeclareUnicodeCharacter{012C}{\u{I}}
8380 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8382 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8383 \DeclareUnicodeCharacter{0131}{\dotless{i}}
8384 \DeclareUnicodeCharacter{0132}{IJ}
8385 \DeclareUnicodeCharacter{0133}{ij}
8386 \DeclareUnicodeCharacter{0134}{\^J}
8387 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8388 \DeclareUnicodeCharacter{0139}{\'L}
8389 \DeclareUnicodeCharacter{013A}{\'l}
8391 \DeclareUnicodeCharacter{0141}{\L}
8392 \DeclareUnicodeCharacter{0142}{\l}
8393 \DeclareUnicodeCharacter{0143}{\'N}
8394 \DeclareUnicodeCharacter{0144}{\'n}
8395 \DeclareUnicodeCharacter{0147}{\v{N}}
8396 \DeclareUnicodeCharacter{0148}{\v{n}}
8397 \DeclareUnicodeCharacter{014C}{\=O}
8398 \DeclareUnicodeCharacter{014D}{\=o}
8399 \DeclareUnicodeCharacter{014E}{\u{O}}
8400 \DeclareUnicodeCharacter{014F}{\u{o}}
8402 \DeclareUnicodeCharacter{0150}{\H{O}}
8403 \DeclareUnicodeCharacter{0151}{\H{o}}
8404 \DeclareUnicodeCharacter{0152}{\OE}
8405 \DeclareUnicodeCharacter{0153}{\oe}
8406 \DeclareUnicodeCharacter{0154}{\'R}
8407 \DeclareUnicodeCharacter{0155}{\'r}
8408 \DeclareUnicodeCharacter{0158}{\v{R}}
8409 \DeclareUnicodeCharacter{0159}{\v{r}}
8410 \DeclareUnicodeCharacter{015A}{\'S}
8411 \DeclareUnicodeCharacter{015B}{\'s}
8412 \DeclareUnicodeCharacter{015C}{\^S}
8413 \DeclareUnicodeCharacter{015D}{\^s}
8414 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8415 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8417 \DeclareUnicodeCharacter{0160}{\v{S}}
8418 \DeclareUnicodeCharacter{0161}{\v{s}}
8419 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8420 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8421 \DeclareUnicodeCharacter{0164}{\v{T}}
8423 \DeclareUnicodeCharacter{0168}{\~U}
8424 \DeclareUnicodeCharacter{0169}{\~u}
8425 \DeclareUnicodeCharacter{016A}{\=U}
8426 \DeclareUnicodeCharacter{016B}{\=u}
8427 \DeclareUnicodeCharacter{016C}{\u{U}}
8428 \DeclareUnicodeCharacter{016D}{\u{u}}
8429 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8430 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8432 \DeclareUnicodeCharacter{0170}{\H{U}}
8433 \DeclareUnicodeCharacter{0171}{\H{u}}
8434 \DeclareUnicodeCharacter{0174}{\^W}
8435 \DeclareUnicodeCharacter{0175}{\^w}
8436 \DeclareUnicodeCharacter{0176}{\^Y}
8437 \DeclareUnicodeCharacter{0177}{\^y}
8438 \DeclareUnicodeCharacter{0178}{\"Y}
8439 \DeclareUnicodeCharacter{0179}{\'Z}
8440 \DeclareUnicodeCharacter{017A}{\'z}
8441 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8442 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8443 \DeclareUnicodeCharacter{017D}{\v{Z}}
8444 \DeclareUnicodeCharacter{017E}{\v{z}}
8446 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8447 \DeclareUnicodeCharacter{01C5}{D\v{z}}
8448 \DeclareUnicodeCharacter{01C6}{d\v{z}}
8449 \DeclareUnicodeCharacter{01C7}{LJ}
8450 \DeclareUnicodeCharacter{01C8}{Lj}
8451 \DeclareUnicodeCharacter{01C9}{lj}
8452 \DeclareUnicodeCharacter{01CA}{NJ}
8453 \DeclareUnicodeCharacter{01CB}{Nj}
8454 \DeclareUnicodeCharacter{01CC}{nj}
8455 \DeclareUnicodeCharacter{01CD}{\v{A}}
8456 \DeclareUnicodeCharacter{01CE}{\v{a}}
8457 \DeclareUnicodeCharacter{01CF}{\v{I}}
8459 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8460 \DeclareUnicodeCharacter{01D1}{\v{O}}
8461 \DeclareUnicodeCharacter{01D2}{\v{o}}
8462 \DeclareUnicodeCharacter{01D3}{\v{U}}
8463 \DeclareUnicodeCharacter{01D4}{\v{u}}
8465 \DeclareUnicodeCharacter{01E2}{\={\AE}}
8466 \DeclareUnicodeCharacter{01E3}{\={\ae}}
8467 \DeclareUnicodeCharacter{01E6}{\v{G}}
8468 \DeclareUnicodeCharacter{01E7}{\v{g}}
8469 \DeclareUnicodeCharacter{01E8}{\v{K}}
8470 \DeclareUnicodeCharacter{01E9}{\v{k}}
8472 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8473 \DeclareUnicodeCharacter{01F1}{DZ}
8474 \DeclareUnicodeCharacter{01F2}{Dz}
8475 \DeclareUnicodeCharacter{01F3}{dz}
8476 \DeclareUnicodeCharacter{01F4}{\'G}
8477 \DeclareUnicodeCharacter{01F5}{\'g}
8478 \DeclareUnicodeCharacter{01F8}{\`N}
8479 \DeclareUnicodeCharacter{01F9}{\`n}
8480 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8481 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8482 \DeclareUnicodeCharacter{01FE}{\'{\O}}
8483 \DeclareUnicodeCharacter{01FF}{\'{\o}}
8485 \DeclareUnicodeCharacter{021E}{\v{H}}
8486 \DeclareUnicodeCharacter{021F}{\v{h}}
8488 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8489 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8490 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8491 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8492 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8493 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8495 \DeclareUnicodeCharacter{0232}{\=Y}
8496 \DeclareUnicodeCharacter{0233}{\=y}
8497 \DeclareUnicodeCharacter{0237}{\dotless{j}}
8499 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
8501 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8502 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8503 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8504 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8505 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8506 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8507 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8508 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8509 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8510 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8511 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8512 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8514 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8515 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8517 \DeclareUnicodeCharacter{1E20}{\=G}
8518 \DeclareUnicodeCharacter{1E21}{\=g}
8519 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8520 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8521 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8522 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8523 \DeclareUnicodeCharacter{1E26}{\"H}
8524 \DeclareUnicodeCharacter{1E27}{\"h}
8526 \DeclareUnicodeCharacter{1E30}{\'K}
8527 \DeclareUnicodeCharacter{1E31}{\'k}
8528 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8529 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8530 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8531 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8532 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8533 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8534 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8535 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8536 \DeclareUnicodeCharacter{1E3E}{\'M}
8537 \DeclareUnicodeCharacter{1E3F}{\'m}
8539 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8540 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8541 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8542 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8543 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8544 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8545 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8546 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8547 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8548 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8550 \DeclareUnicodeCharacter{1E54}{\'P}
8551 \DeclareUnicodeCharacter{1E55}{\'p}
8552 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8553 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8554 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8555 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8556 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8557 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8558 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8559 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8561 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8562 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8563 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8564 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8565 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8566 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8567 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8568 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8569 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8570 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8572 \DeclareUnicodeCharacter{1E7C}{\~V}
8573 \DeclareUnicodeCharacter{1E7D}{\~v}
8574 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8575 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8577 \DeclareUnicodeCharacter{1E80}{\`W}
8578 \DeclareUnicodeCharacter{1E81}{\`w}
8579 \DeclareUnicodeCharacter{1E82}{\'W}
8580 \DeclareUnicodeCharacter{1E83}{\'w}
8581 \DeclareUnicodeCharacter{1E84}{\"W}
8582 \DeclareUnicodeCharacter{1E85}{\"w}
8583 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8584 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8585 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8586 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8587 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8588 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8589 \DeclareUnicodeCharacter{1E8C}{\"X}
8590 \DeclareUnicodeCharacter{1E8D}{\"x}
8591 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8592 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8594 \DeclareUnicodeCharacter{1E90}{\^Z}
8595 \DeclareUnicodeCharacter{1E91}{\^z}
8596 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8597 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8598 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
8599 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
8600 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
8601 \DeclareUnicodeCharacter{1E97}{\"t}
8602 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
8603 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
8605 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
8606 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
8608 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
8609 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
8610 \DeclareUnicodeCharacter{1EBC}{\~E}
8611 \DeclareUnicodeCharacter{1EBD}{\~e}
8613 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
8614 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
8615 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
8616 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
8618 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
8619 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
8621 \DeclareUnicodeCharacter{1EF2}{\`Y}
8622 \DeclareUnicodeCharacter{1EF3}{\`y}
8623 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
8625 \DeclareUnicodeCharacter{1EF8}{\~Y}
8626 \DeclareUnicodeCharacter{1EF9}{\~y}
8628 \DeclareUnicodeCharacter{2013}{--}
8629 \DeclareUnicodeCharacter{2014}{---}
8630 \DeclareUnicodeCharacter{2018}{\quoteleft}
8631 \DeclareUnicodeCharacter{2019}{\quoteright}
8632 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
8633 \DeclareUnicodeCharacter{201C}{\quotedblleft}
8634 \DeclareUnicodeCharacter{201D}{\quotedblright}
8635 \DeclareUnicodeCharacter{201E}{\quotedblbase}
8636 \DeclareUnicodeCharacter{2022}{\bullet}
8637 \DeclareUnicodeCharacter{2026}{\dots}
8638 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
8639 \DeclareUnicodeCharacter{203A}{\guilsinglright}
8640 \DeclareUnicodeCharacter{20AC}{\euro}
8642 \DeclareUnicodeCharacter{2192}{\expansion}
8643 \DeclareUnicodeCharacter{21D2}{\result}
8645 \DeclareUnicodeCharacter{2212}{\minus}
8646 \DeclareUnicodeCharacter{2217}{\point}
8647 \DeclareUnicodeCharacter{2261}{\equiv}
8648 }% end of \utfeightchardefs
8651 % US-ASCII character definitions.
8652 \def\asciichardefs{% nothing need be done
8653 \relax
8656 % Make non-ASCII characters printable again for compatibility with
8657 % existing Texinfo documents that may use them, even without declaring a
8658 % document encoding.
8660 \setnonasciicharscatcode \other
8663 \message{formatting,}
8665 \newdimen\defaultparindent \defaultparindent = 15pt
8667 \chapheadingskip = 15pt plus 4pt minus 2pt
8668 \secheadingskip = 12pt plus 3pt minus 2pt
8669 \subsecheadingskip = 9pt plus 2pt minus 2pt
8671 % Prevent underfull vbox error messages.
8672 \vbadness = 10000
8674 % Don't be so finicky about underfull hboxes, either.
8675 \hbadness = 2000
8677 % Following George Bush, get rid of widows and orphans.
8678 \widowpenalty=10000
8679 \clubpenalty=10000
8681 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
8682 % using an old version of TeX, don't do anything. We want the amount of
8683 % stretch added to depend on the line length, hence the dependence on
8684 % \hsize. We call this whenever the paper size is set.
8686 \def\setemergencystretch{%
8687 \ifx\emergencystretch\thisisundefined
8688 % Allow us to assign to \emergencystretch anyway.
8689 \def\emergencystretch{\dimen0}%
8690 \else
8691 \emergencystretch = .15\hsize
8695 % Parameters in order: 1) textheight; 2) textwidth;
8696 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
8697 % 7) physical page height; 8) physical page width.
8699 % We also call \setleading{\textleading}, so the caller should define
8700 % \textleading. The caller should also set \parskip.
8702 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
8703 \voffset = #3\relax
8704 \topskip = #6\relax
8705 \splittopskip = \topskip
8707 \vsize = #1\relax
8708 \advance\vsize by \topskip
8709 \outervsize = \vsize
8710 \advance\outervsize by 2\topandbottommargin
8711 \pageheight = \vsize
8713 \hsize = #2\relax
8714 \outerhsize = \hsize
8715 \advance\outerhsize by 0.5in
8716 \pagewidth = \hsize
8718 \normaloffset = #4\relax
8719 \bindingoffset = #5\relax
8721 \ifpdf
8722 \pdfpageheight #7\relax
8723 \pdfpagewidth #8\relax
8724 % if we don't reset these, they will remain at "1 true in" of
8725 % whatever layout pdftex was dumped with.
8726 \pdfhorigin = 1 true in
8727 \pdfvorigin = 1 true in
8730 \setleading{\textleading}
8732 \parindent = \defaultparindent
8733 \setemergencystretch
8736 % @letterpaper (the default).
8737 \def\letterpaper{{\globaldefs = 1
8738 \parskip = 3pt plus 2pt minus 1pt
8739 \textleading = 13.2pt
8741 % If page is nothing but text, make it come out even.
8742 \internalpagesizes{607.2pt}{6in}% that's 46 lines
8743 {\voffset}{.25in}%
8744 {\bindingoffset}{36pt}%
8745 {11in}{8.5in}%
8748 % Use @smallbook to reset parameters for 7x9.25 trim size.
8749 \def\smallbook{{\globaldefs = 1
8750 \parskip = 2pt plus 1pt
8751 \textleading = 12pt
8753 \internalpagesizes{7.5in}{5in}%
8754 {-.2in}{0in}%
8755 {\bindingoffset}{16pt}%
8756 {9.25in}{7in}%
8758 \lispnarrowing = 0.3in
8759 \tolerance = 700
8760 \hfuzz = 1pt
8761 \contentsrightmargin = 0pt
8762 \defbodyindent = .5cm
8765 % Use @smallerbook to reset parameters for 6x9 trim size.
8766 % (Just testing, parameters still in flux.)
8767 \def\smallerbook{{\globaldefs = 1
8768 \parskip = 1.5pt plus 1pt
8769 \textleading = 12pt
8771 \internalpagesizes{7.4in}{4.8in}%
8772 {-.2in}{-.4in}%
8773 {0pt}{14pt}%
8774 {9in}{6in}%
8776 \lispnarrowing = 0.25in
8777 \tolerance = 700
8778 \hfuzz = 1pt
8779 \contentsrightmargin = 0pt
8780 \defbodyindent = .4cm
8783 % Use @afourpaper to print on European A4 paper.
8784 \def\afourpaper{{\globaldefs = 1
8785 \parskip = 3pt plus 2pt minus 1pt
8786 \textleading = 13.2pt
8788 % Double-side printing via postscript on Laserjet 4050
8789 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
8790 % To change the settings for a different printer or situation, adjust
8791 % \normaloffset until the front-side and back-side texts align. Then
8792 % do the same for \bindingoffset. You can set these for testing in
8793 % your texinfo source file like this:
8794 % @tex
8795 % \global\normaloffset = -6mm
8796 % \global\bindingoffset = 10mm
8797 % @end tex
8798 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
8799 {\voffset}{\hoffset}%
8800 {\bindingoffset}{44pt}%
8801 {297mm}{210mm}%
8803 \tolerance = 700
8804 \hfuzz = 1pt
8805 \contentsrightmargin = 0pt
8806 \defbodyindent = 5mm
8809 % Use @afivepaper to print on European A5 paper.
8810 % From romildo@urano.iceb.ufop.br, 2 July 2000.
8811 % He also recommends making @example and @lisp be small.
8812 \def\afivepaper{{\globaldefs = 1
8813 \parskip = 2pt plus 1pt minus 0.1pt
8814 \textleading = 12.5pt
8816 \internalpagesizes{160mm}{120mm}%
8817 {\voffset}{\hoffset}%
8818 {\bindingoffset}{8pt}%
8819 {210mm}{148mm}%
8821 \lispnarrowing = 0.2in
8822 \tolerance = 800
8823 \hfuzz = 1.2pt
8824 \contentsrightmargin = 0pt
8825 \defbodyindent = 2mm
8826 \tableindent = 12mm
8829 % A specific text layout, 24x15cm overall, intended for A4 paper.
8830 \def\afourlatex{{\globaldefs = 1
8831 \afourpaper
8832 \internalpagesizes{237mm}{150mm}%
8833 {\voffset}{4.6mm}%
8834 {\bindingoffset}{7mm}%
8835 {297mm}{210mm}%
8837 % Must explicitly reset to 0 because we call \afourpaper.
8838 \globaldefs = 0
8841 % Use @afourwide to print on A4 paper in landscape format.
8842 \def\afourwide{{\globaldefs = 1
8843 \afourpaper
8844 \internalpagesizes{241mm}{165mm}%
8845 {\voffset}{-2.95mm}%
8846 {\bindingoffset}{7mm}%
8847 {297mm}{210mm}%
8848 \globaldefs = 0
8851 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
8852 % Perhaps we should allow setting the margins, \topskip, \parskip,
8853 % and/or leading, also. Or perhaps we should compute them somehow.
8855 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
8856 \def\pagesizesyyy#1,#2,#3\finish{{%
8857 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
8858 \globaldefs = 1
8860 \parskip = 3pt plus 2pt minus 1pt
8861 \setleading{\textleading}%
8863 \dimen0 = #1\relax
8864 \advance\dimen0 by \voffset
8866 \dimen2 = \hsize
8867 \advance\dimen2 by \normaloffset
8869 \internalpagesizes{#1}{\hsize}%
8870 {\voffset}{\normaloffset}%
8871 {\bindingoffset}{44pt}%
8872 {\dimen0}{\dimen2}%
8875 % Set default to letter.
8877 \letterpaper
8880 \message{and turning on texinfo input format.}
8882 % Define macros to output various characters with catcode for normal text.
8883 \catcode`\"=\other
8884 \catcode`\~=\other
8885 \catcode`\^=\other
8886 \catcode`\_=\other
8887 \catcode`\|=\other
8888 \catcode`\<=\other
8889 \catcode`\>=\other
8890 \catcode`\+=\other
8891 \catcode`\$=\other
8892 \def\normaldoublequote{"}
8893 \def\normaltilde{~}
8894 \def\normalcaret{^}
8895 \def\normalunderscore{_}
8896 \def\normalverticalbar{|}
8897 \def\normalless{<}
8898 \def\normalgreater{>}
8899 \def\normalplus{+}
8900 \def\normaldollar{$}%$ font-lock fix
8902 % This macro is used to make a character print one way in \tt
8903 % (where it can probably be output as-is), and another way in other fonts,
8904 % where something hairier probably needs to be done.
8906 % #1 is what to print if we are indeed using \tt; #2 is what to print
8907 % otherwise. Since all the Computer Modern typewriter fonts have zero
8908 % interword stretch (and shrink), and it is reasonable to expect all
8909 % typewriter fonts to have this, we can check that font parameter.
8911 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
8913 % Same as above, but check for italic font. Actually this also catches
8914 % non-italic slanted fonts since it is impossible to distinguish them from
8915 % italic fonts. But since this is only used by $ and it uses \sl anyway
8916 % this is not a problem.
8917 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
8919 % Turn off all special characters except @
8920 % (and those which the user can use as if they were ordinary).
8921 % Most of these we simply print from the \tt font, but for some, we can
8922 % use math or other variants that look better in normal text.
8924 \catcode`\"=\active
8925 \def\activedoublequote{{\tt\char34}}
8926 \let"=\activedoublequote
8927 \catcode`\~=\active
8928 \def~{{\tt\char126}}
8929 \chardef\hat=`\^
8930 \catcode`\^=\active
8931 \def^{{\tt \hat}}
8933 \catcode`\_=\active
8934 \def_{\ifusingtt\normalunderscore\_}
8935 \let\realunder=_
8936 % Subroutine for the previous macro.
8937 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
8939 \catcode`\|=\active
8940 \def|{{\tt\char124}}
8941 \chardef \less=`\<
8942 \catcode`\<=\active
8943 \def<{{\tt \less}}
8944 \chardef \gtr=`\>
8945 \catcode`\>=\active
8946 \def>{{\tt \gtr}}
8947 \catcode`\+=\active
8948 \def+{{\tt \char 43}}
8949 \catcode`\$=\active
8950 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
8952 % If a .fmt file is being used, characters that might appear in a file
8953 % name cannot be active until we have parsed the command line.
8954 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
8955 % \otherifyactive is called near the end of this file.
8956 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
8958 % Used sometimes to turn off (effectively) the active characters even after
8959 % parsing them.
8960 \def\turnoffactive{%
8961 \normalturnoffactive
8962 \otherbackslash
8965 \catcode`\@=0
8967 % \backslashcurfont outputs one backslash character in current font,
8968 % as in \char`\\.
8969 \global\chardef\backslashcurfont=`\\
8970 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
8972 % \realbackslash is an actual character `\' with catcode other, and
8973 % \doublebackslash is two of them (for the pdf outlines).
8974 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
8976 % In texinfo, backslash is an active character; it prints the backslash
8977 % in fixed width font.
8978 \catcode`\\=\active
8979 @def@normalbackslash{{@tt@backslashcurfont}}
8980 % On startup, @fixbackslash assigns:
8981 % @let \ = @normalbackslash
8983 % \rawbackslash defines an active \ to do \backslashcurfont.
8984 % \otherbackslash defines an active \ to be a literal `\' character with
8985 % catcode other.
8986 @gdef@rawbackslash{@let\=@backslashcurfont}
8987 @gdef@otherbackslash{@let\=@realbackslash}
8989 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
8990 % the literal character `\'.
8992 @def@normalturnoffactive{%
8993 @let\=@normalbackslash
8994 @let"=@normaldoublequote
8995 @let~=@normaltilde
8996 @let^=@normalcaret
8997 @let_=@normalunderscore
8998 @let|=@normalverticalbar
8999 @let<=@normalless
9000 @let>=@normalgreater
9001 @let+=@normalplus
9002 @let$=@normaldollar %$ font-lock fix
9003 @unsepspaces
9006 % Make _ and + \other characters, temporarily.
9007 % This is canceled by @fixbackslash.
9008 @otherifyactive
9010 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9011 % That is what \eatinput is for; after that, the `\' should revert to printing
9012 % a backslash.
9014 @gdef@eatinput input texinfo{@fixbackslash}
9015 @global@let\ = @eatinput
9017 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
9018 % the first `\' in the file would cause an error. This macro tries to fix
9019 % that, assuming it is called before the first `\' could plausibly occur.
9020 % Also turn back on active characters that might appear in the input
9021 % file name, in case not using a pre-dumped format.
9023 @gdef@fixbackslash{%
9024 @ifx\@eatinput @let\ = @normalbackslash @fi
9025 @catcode`+=@active
9026 @catcode`@_=@active
9029 % Say @foo, not \foo, in error messages.
9030 @escapechar = `@@
9032 % These look ok in all fonts, so just make them not special.
9033 @catcode`@& = @other
9034 @catcode`@# = @other
9035 @catcode`@% = @other
9037 @c Finally, make ` and ' active, so that txicodequoteundirected and
9038 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
9039 @c don't make ` and ' active, @code will not get them as active chars.
9040 @c Do this last of all since we use ` in the previous @catcode assignments.
9041 @c (not ready yet, sigh)
9042 @c atcode`@'=@active @let'@rq
9043 @c atcode`@`=@active @let`@lq
9045 @c Local variables:
9046 @c eval: (add-hook 'write-file-hooks 'time-stamp)
9047 @c page-delimiter: "^\\\\message"
9048 @c time-stamp-start: "def\\\\texinfoversion{"
9049 @c time-stamp-format: "%:y-%02m-%02d.%02H"
9050 @c time-stamp-end: "}"
9051 @c End:
9053 @c vim:sw=2:
9055 @ignore
9056 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
9057 @end ignore