Avoid infinite aclocal loop.
[autoconf.git] / build-aux / texinfo.tex
blob175c320de495a2ea4789967a9c36bd5bef55309d
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-03-31.10}
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 \ptexi
654 \else\ifx\temp\jmacro \j
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 \edef\temp{\noexpand\input #1 }%
931 % This trickery is to read FILE outside of a group, in case it makes
932 % definitions, etc.
933 \expandafter
934 }\temp
935 \popthisfilestack
937 \def\filenamecatcodes{%
938 \catcode`\\=\other
939 \catcode`~=\other
940 \catcode`^=\other
941 \catcode`_=\other
942 \catcode`|=\other
943 \catcode`<=\other
944 \catcode`>=\other
945 \catcode`+=\other
946 \catcode`-=\other
949 \def\pushthisfilestack{%
950 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
952 \def\pushthisfilestackX{%
953 \expandafter\pushthisfilestackY\thisfile\StackTerm
955 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
956 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
959 \def\popthisfilestack{\errthisfilestackempty}
960 \def\errthisfilestackempty{\errmessage{Internal error:
961 the stack of filenames is empty.}}
963 \def\thisfile{}
965 % @center line
966 % outputs that line, centered.
968 \parseargdef\center{%
969 \ifhmode
970 \let\next\centerH
971 \else
972 \let\next\centerV
974 \next{\hfil \ignorespaces#1\unskip \hfil}%
976 \def\centerH#1{%
978 \hfil\break
979 \advance\hsize by -\leftskip
980 \advance\hsize by -\rightskip
981 \line{#1}%
982 \break
985 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
987 % @sp n outputs n lines of vertical space
989 \parseargdef\sp{\vskip #1\baselineskip}
991 % @comment ...line which is ignored...
992 % @c is the same as @comment
993 % @ignore ... @end ignore is another way to write a comment
995 \def\comment{\begingroup \catcode`\^^M=\other%
996 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
997 \commentxxx}
998 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
1000 \let\c=\comment
1002 % @paragraphindent NCHARS
1003 % We'll use ems for NCHARS, close enough.
1004 % NCHARS can also be the word `asis' or `none'.
1005 % We cannot feasibly implement @paragraphindent asis, though.
1007 \def\asisword{asis} % no translation, these are keywords
1008 \def\noneword{none}
1010 \parseargdef\paragraphindent{%
1011 \def\temp{#1}%
1012 \ifx\temp\asisword
1013 \else
1014 \ifx\temp\noneword
1015 \defaultparindent = 0pt
1016 \else
1017 \defaultparindent = #1em
1020 \parindent = \defaultparindent
1023 % @exampleindent NCHARS
1024 % We'll use ems for NCHARS like @paragraphindent.
1025 % It seems @exampleindent asis isn't necessary, but
1026 % I preserve it to make it similar to @paragraphindent.
1027 \parseargdef\exampleindent{%
1028 \def\temp{#1}%
1029 \ifx\temp\asisword
1030 \else
1031 \ifx\temp\noneword
1032 \lispnarrowing = 0pt
1033 \else
1034 \lispnarrowing = #1em
1039 % @firstparagraphindent WORD
1040 % If WORD is `none', then suppress indentation of the first paragraph
1041 % after a section heading. If WORD is `insert', then do indent at such
1042 % paragraphs.
1044 % The paragraph indentation is suppressed or not by calling
1045 % \suppressfirstparagraphindent, which the sectioning commands do.
1046 % We switch the definition of this back and forth according to WORD.
1047 % By default, we suppress indentation.
1049 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1050 \def\insertword{insert}
1052 \parseargdef\firstparagraphindent{%
1053 \def\temp{#1}%
1054 \ifx\temp\noneword
1055 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1056 \else\ifx\temp\insertword
1057 \let\suppressfirstparagraphindent = \relax
1058 \else
1059 \errhelp = \EMsimple
1060 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1061 \fi\fi
1064 % Here is how we actually suppress indentation. Redefine \everypar to
1065 % \kern backwards by \parindent, and then reset itself to empty.
1067 % We also make \indent itself not actually do anything until the next
1068 % paragraph.
1070 \gdef\dosuppressfirstparagraphindent{%
1071 \gdef\indent{%
1072 \restorefirstparagraphindent
1073 \indent
1075 \gdef\noindent{%
1076 \restorefirstparagraphindent
1077 \noindent
1079 \global\everypar = {%
1080 \kern -\parindent
1081 \restorefirstparagraphindent
1085 \gdef\restorefirstparagraphindent{%
1086 \global \let \indent = \ptexindent
1087 \global \let \noindent = \ptexnoindent
1088 \global \everypar = {}%
1092 % @asis just yields its argument. Used with @table, for example.
1094 \def\asis#1{#1}
1096 % @math outputs its argument in math mode.
1098 % One complication: _ usually means subscripts, but it could also mean
1099 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1100 % _ active, and distinguish by seeing if the current family is \slfam,
1101 % which is what @var uses.
1103 \catcode`\_ = \active
1104 \gdef\mathunderscore{%
1105 \catcode`\_=\active
1106 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1109 % Another complication: we want \\ (and @\) to output a \ character.
1110 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1111 % this is not advertised and we don't care. Texinfo does not
1112 % otherwise define @\.
1114 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1115 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1117 \def\math{%
1118 \tex
1119 \mathunderscore
1120 \let\\ = \mathbackslash
1121 \mathactive
1122 $\finishmath
1124 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1126 % Some active characters (such as <) are spaced differently in math.
1127 % We have to reset their definitions in case the @math was an argument
1128 % to a command which sets the catcodes (such as @item or @section).
1131 \catcode`^ = \active
1132 \catcode`< = \active
1133 \catcode`> = \active
1134 \catcode`+ = \active
1135 \gdef\mathactive{%
1136 \let^ = \ptexhat
1137 \let< = \ptexless
1138 \let> = \ptexgtr
1139 \let+ = \ptexplus
1143 % @bullet and @minus need the same treatment as @math, just above.
1144 \def\bullet{$\ptexbullet$}
1145 \def\minus{$-$}
1147 % @dots{} outputs an ellipsis using the current font.
1148 % We do .5em per period so that it has the same spacing in the cm
1149 % typewriter fonts as three actual period characters; on the other hand,
1150 % in other typewriter fonts three periods are wider than 1.5em. So do
1151 % whichever is larger.
1153 \def\dots{%
1154 \leavevmode
1155 \setbox0=\hbox{...}% get width of three periods
1156 \ifdim\wd0 > 1.5em
1157 \dimen0 = \wd0
1158 \else
1159 \dimen0 = 1.5em
1161 \hbox to \dimen0{%
1162 \hskip 0pt plus.25fil
1163 .\hskip 0pt plus1fil
1164 .\hskip 0pt plus1fil
1165 .\hskip 0pt plus.5fil
1169 % @enddots{} is an end-of-sentence ellipsis.
1171 \def\enddots{%
1172 \dots
1173 \spacefactor=\endofsentencespacefactor
1176 % @comma{} is so commas can be inserted into text without messing up
1177 % Texinfo's parsing.
1179 \let\comma = ,
1181 % @refill is a no-op.
1182 \let\refill=\relax
1184 % If working on a large document in chapters, it is convenient to
1185 % be able to disable indexing, cross-referencing, and contents, for test runs.
1186 % This is done with @novalidate (before @setfilename).
1188 \newif\iflinks \linkstrue % by default we want the aux files.
1189 \let\novalidate = \linksfalse
1191 % @setfilename is done at the beginning of every texinfo file.
1192 % So open here the files we need to have open while reading the input.
1193 % This makes it possible to make a .fmt file for texinfo.
1194 \def\setfilename{%
1195 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1196 \iflinks
1197 \tryauxfile
1198 % Open the new aux file. TeX will close it automatically at exit.
1199 \immediate\openout\auxfile=\jobname.aux
1200 \fi % \openindices needs to do some work in any case.
1201 \openindices
1202 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1204 % If texinfo.cnf is present on the system, read it.
1205 % Useful for site-wide @afourpaper, etc.
1206 \openin 1 texinfo.cnf
1207 \ifeof 1 \else \input texinfo.cnf \fi
1208 \closein 1
1210 \comment % Ignore the actual filename.
1213 % Called from \setfilename.
1215 \def\openindices{%
1216 \newindex{cp}%
1217 \newcodeindex{fn}%
1218 \newcodeindex{vr}%
1219 \newcodeindex{tp}%
1220 \newcodeindex{ky}%
1221 \newcodeindex{pg}%
1224 % @bye.
1225 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1228 \message{pdf,}
1229 % adobe `portable' document format
1230 \newcount\tempnum
1231 \newcount\lnkcount
1232 \newtoks\filename
1233 \newcount\filenamelength
1234 \newcount\pgn
1235 \newtoks\toksA
1236 \newtoks\toksB
1237 \newtoks\toksC
1238 \newtoks\toksD
1239 \newbox\boxA
1240 \newcount\countA
1241 \newif\ifpdf
1242 \newif\ifpdfmakepagedest
1244 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1245 % can be set). So we test for \relax and 0 as well as \undefined,
1246 % borrowed from ifpdf.sty.
1247 \ifx\pdfoutput\undefined
1248 \else
1249 \ifx\pdfoutput\relax
1250 \else
1251 \ifcase\pdfoutput
1252 \else
1253 \pdftrue
1258 % PDF uses PostScript string constants for the names of xref targets,
1259 % for display in the outlines, and in other places. Thus, we have to
1260 % double any backslashes. Otherwise, a name like "\node" will be
1261 % interpreted as a newline (\n), followed by o, d, e. Not good.
1262 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1263 % (and related messages, the final outcome is that it is up to the TeX
1264 % user to double the backslashes and otherwise make the string valid, so
1265 % that's what we do).
1267 % double active backslashes.
1269 {\catcode`\@=0 \catcode`\\=\active
1270 @gdef@activebackslashdouble{%
1271 @catcode`@\=@active
1272 @let\=@doublebackslash}
1275 % To handle parens, we must adopt a different approach, since parens are
1276 % not active characters. hyperref.dtx (which has the same problem as
1277 % us) handles it with this amazing macro to replace tokens, with minor
1278 % changes for Texinfo. It is included here under the GPL by permission
1279 % from the author, Heiko Oberdiek.
1281 % #1 is the tokens to replace.
1282 % #2 is the replacement.
1283 % #3 is the control sequence with the string.
1285 \def\HyPsdSubst#1#2#3{%
1286 \def\HyPsdReplace##1#1##2\END{%
1287 ##1%
1288 \ifx\\##2\\%
1289 \else
1291 \HyReturnAfterFi{%
1292 \HyPsdReplace##2\END
1296 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1298 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1300 % #1 is a control sequence in which to do the replacements.
1301 \def\backslashparens#1{%
1302 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1303 % \lastnode when called from \setref -> \pdfmkdest.
1304 \HyPsdSubst{(}{\realbackslash(}{#1}%
1305 \HyPsdSubst{)}{\realbackslash)}{#1}%
1308 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1309 with PDF output, and none of those formats could be found. (.eps cannot
1310 be supported due to the design of the PDF format; use regular TeX (DVI
1311 output) for that.)}
1313 \ifpdf
1315 % Color manipulation macros based on pdfcolor.tex.
1316 \def\cmykDarkRed{0.28 1 1 0.35}
1317 \def\cmykBlack{0 0 0 1}
1319 \def\pdfsetcolor#1{\pdfliteral{#1 k}}
1320 % Set color, and create a mark which defines \thiscolor accordingly,
1321 % so that \makeheadline knows which color to restore.
1322 \def\setcolor#1{%
1323 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1324 \domark
1325 \pdfsetcolor{#1}%
1328 \def\maincolor{\cmykBlack}
1329 \pdfsetcolor{\maincolor}
1330 \edef\thiscolor{\maincolor}
1331 \def\lastcolordefs{}
1333 \def\makefootline{%
1334 \baselineskip24pt
1335 \line{\pdfsetcolor{\maincolor}\the\footline}%
1338 \def\makeheadline{%
1339 \vbox to 0pt{%
1340 \vskip-22.5pt
1341 \line{%
1342 \vbox to8.5pt{}%
1343 % Extract \thiscolor definition from the marks.
1344 \getcolormarks
1345 % Typeset the headline with \maincolor, then restore the color.
1346 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1348 \vss
1350 \nointerlineskip
1354 \pdfcatalog{/PageMode /UseOutlines}
1356 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1357 \def\dopdfimage#1#2#3{%
1358 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1359 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1361 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1362 % others). Let's try in that order.
1363 \let\pdfimgext=\empty
1364 \begingroup
1365 \openin 1 #1.png \ifeof 1
1366 \openin 1 #1.jpg \ifeof 1
1367 \openin 1 #1.jpeg \ifeof 1
1368 \openin 1 #1.JPG \ifeof 1
1369 \openin 1 #1.pdf \ifeof 1
1370 \openin 1 #1.PDF \ifeof 1
1371 \errhelp = \nopdfimagehelp
1372 \errmessage{Could not find image file #1 for pdf}%
1373 \else \gdef\pdfimgext{PDF}%
1375 \else \gdef\pdfimgext{pdf}%
1377 \else \gdef\pdfimgext{JPG}%
1379 \else \gdef\pdfimgext{jpeg}%
1381 \else \gdef\pdfimgext{jpg}%
1383 \else \gdef\pdfimgext{png}%
1385 \closein 1
1386 \endgroup
1388 % without \immediate, ancient pdftex seg faults when the same image is
1389 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1390 \ifnum\pdftexversion < 14
1391 \immediate\pdfimage
1392 \else
1393 \immediate\pdfximage
1395 \ifdim \wd0 >0pt width \imagewidth \fi
1396 \ifdim \wd2 >0pt height \imageheight \fi
1397 \ifnum\pdftexversion<13
1398 #1.\pdfimgext
1399 \else
1400 {#1.\pdfimgext}%
1402 \ifnum\pdftexversion < 14 \else
1403 \pdfrefximage \pdflastximage
1404 \fi}
1406 \def\pdfmkdest#1{{%
1407 % We have to set dummies so commands such as @code, and characters
1408 % such as \, aren't expanded when present in a section title.
1409 \indexnofonts
1410 \turnoffactive
1411 \activebackslashdouble
1412 \makevalueexpandable
1413 \def\pdfdestname{#1}%
1414 \backslashparens\pdfdestname
1415 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1418 % used to mark target names; must be expandable.
1419 \def\pdfmkpgn#1{#1}
1421 % by default, use a color that is dark enough to print on paper as
1422 % nearly black, but still distinguishable for online viewing.
1423 \def\urlcolor{\cmykDarkRed}
1424 \def\linkcolor{\cmykDarkRed}
1425 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1427 % Adding outlines to PDF; macros for calculating structure of outlines
1428 % come from Petr Olsak
1429 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1430 \else \csname#1\endcsname \fi}
1431 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1432 \advance\tempnum by 1
1433 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1435 % #1 is the section text, which is what will be displayed in the
1436 % outline by the pdf viewer. #2 is the pdf expression for the number
1437 % of subentries (or empty, for subsubsections). #3 is the node text,
1438 % which might be empty if this toc entry had no corresponding node.
1439 % #4 is the page number
1441 \def\dopdfoutline#1#2#3#4{%
1442 % Generate a link to the node text if that exists; else, use the
1443 % page number. We could generate a destination for the section
1444 % text in the case where a section has no node, but it doesn't
1445 % seem worth the trouble, since most documents are normally structured.
1446 \def\pdfoutlinedest{#3}%
1447 \ifx\pdfoutlinedest\empty
1448 \def\pdfoutlinedest{#4}%
1449 \else
1450 % Doubled backslashes in the name.
1451 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1452 \backslashparens\pdfoutlinedest}%
1455 % Also double the backslashes in the display string.
1456 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1457 \backslashparens\pdfoutlinetext}%
1459 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1462 \def\pdfmakeoutlines{%
1463 \begingroup
1464 % Thanh's hack / proper braces in bookmarks
1465 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1466 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1468 % Read toc silently, to get counts of subentries for \pdfoutline.
1469 \def\numchapentry##1##2##3##4{%
1470 \def\thischapnum{##2}%
1471 \def\thissecnum{0}%
1472 \def\thissubsecnum{0}%
1474 \def\numsecentry##1##2##3##4{%
1475 \advancenumber{chap\thischapnum}%
1476 \def\thissecnum{##2}%
1477 \def\thissubsecnum{0}%
1479 \def\numsubsecentry##1##2##3##4{%
1480 \advancenumber{sec\thissecnum}%
1481 \def\thissubsecnum{##2}%
1483 \def\numsubsubsecentry##1##2##3##4{%
1484 \advancenumber{subsec\thissubsecnum}%
1486 \def\thischapnum{0}%
1487 \def\thissecnum{0}%
1488 \def\thissubsecnum{0}%
1490 % use \def rather than \let here because we redefine \chapentry et
1491 % al. a second time, below.
1492 \def\appentry{\numchapentry}%
1493 \def\appsecentry{\numsecentry}%
1494 \def\appsubsecentry{\numsubsecentry}%
1495 \def\appsubsubsecentry{\numsubsubsecentry}%
1496 \def\unnchapentry{\numchapentry}%
1497 \def\unnsecentry{\numsecentry}%
1498 \def\unnsubsecentry{\numsubsecentry}%
1499 \def\unnsubsubsecentry{\numsubsubsecentry}%
1500 \readdatafile{toc}%
1502 % Read toc second time, this time actually producing the outlines.
1503 % The `-' means take the \expnumber as the absolute number of
1504 % subentries, which we calculated on our first read of the .toc above.
1506 % We use the node names as the destinations.
1507 \def\numchapentry##1##2##3##4{%
1508 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1509 \def\numsecentry##1##2##3##4{%
1510 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1511 \def\numsubsecentry##1##2##3##4{%
1512 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1513 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1514 \dopdfoutline{##1}{}{##3}{##4}}%
1516 % PDF outlines are displayed using system fonts, instead of
1517 % document fonts. Therefore we cannot use special characters,
1518 % since the encoding is unknown. For example, the eogonek from
1519 % Latin 2 (0xea) gets translated to a | character. Info from
1520 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1522 % xx to do this right, we have to translate 8-bit characters to
1523 % their "best" equivalent, based on the @documentencoding. Right
1524 % now, I guess we'll just let the pdf reader have its way.
1525 \indexnofonts
1526 \setupdatafile
1527 \catcode`\\=\active \otherbackslash
1528 \input \tocreadfilename
1529 \endgroup
1532 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1533 \ifx\PP\D\let\nextsp\relax
1534 \else\let\nextsp\skipspaces
1535 \ifx\p\space\else\addtokens{\filename}{\PP}%
1536 \advance\filenamelength by 1
1539 \nextsp}
1540 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1541 \ifnum\pdftexversion < 14
1542 \let \startlink \pdfannotlink
1543 \else
1544 \let \startlink \pdfstartlink
1546 % make a live url in pdf output.
1547 \def\pdfurl#1{%
1548 \begingroup
1549 % it seems we really need yet another set of dummies; have not
1550 % tried to figure out what each command should do in the context
1551 % of @url. for now, just make @/ a no-op, that's the only one
1552 % people have actually reported a problem with.
1554 \normalturnoffactive
1555 \def\@{@}%
1556 \let\/=\empty
1557 \makevalueexpandable
1558 \leavevmode\setcolor{\urlcolor}%
1559 \startlink attr{/Border [0 0 0]}%
1560 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1561 \endgroup}
1562 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1563 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1564 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1565 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1566 \def\maketoks{%
1567 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1568 \ifx\first0\adn0
1569 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1570 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1571 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1572 \else
1573 \ifnum0=\countA\else\makelink\fi
1574 \ifx\first.\let\next=\done\else
1575 \let\next=\maketoks
1576 \addtokens{\toksB}{\the\toksD}
1577 \ifx\first,\addtokens{\toksB}{\space}\fi
1579 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1580 \next}
1581 \def\makelink{\addtokens{\toksB}%
1582 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1583 \def\pdflink#1{%
1584 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1585 \setcolor{\linkcolor}#1\endlink}
1586 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1587 \else
1588 \let\pdfmkdest = \gobble
1589 \let\pdfurl = \gobble
1590 \let\endlink = \relax
1591 \let\setcolor = \gobble
1592 \let\pdfsetcolor = \gobble
1593 \let\pdfmakeoutlines = \relax
1594 \fi % \ifx\pdfoutput
1597 \message{fonts,}
1599 % Change the current font style to #1, remembering it in \curfontstyle.
1600 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1601 % italics, not bold italics.
1603 \def\setfontstyle#1{%
1604 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1605 \csname ten#1\endcsname % change the current font
1608 % Select #1 fonts with the current style.
1610 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1612 \def\rm{\fam=0 \setfontstyle{rm}}
1613 \def\it{\fam=\itfam \setfontstyle{it}}
1614 \def\sl{\fam=\slfam \setfontstyle{sl}}
1615 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1616 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1618 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1619 % So we set up a \sf.
1620 \newfam\sffam
1621 \def\sf{\fam=\sffam \setfontstyle{sf}}
1622 \let\li = \sf % Sometimes we call it \li, not \sf.
1624 % We don't need math for this font style.
1625 \def\ttsl{\setfontstyle{ttsl}}
1628 % Default leading.
1629 \newdimen\textleading \textleading = 13.2pt
1631 % Set the baselineskip to #1, and the lineskip and strut size
1632 % correspondingly. There is no deep meaning behind these magic numbers
1633 % used as factors; they just match (closely enough) what Knuth defined.
1635 \def\lineskipfactor{.08333}
1636 \def\strutheightpercent{.70833}
1637 \def\strutdepthpercent {.29167}
1639 % can get a sort of poor man's double spacing by redefining this.
1640 \def\baselinefactor{1}
1642 \def\setleading#1{%
1643 \dimen0 = #1\relax
1644 \normalbaselineskip = \baselinefactor\dimen0
1645 \normallineskip = \lineskipfactor\normalbaselineskip
1646 \normalbaselines
1647 \setbox\strutbox =\hbox{%
1648 \vrule width0pt height\strutheightpercent\baselineskip
1649 depth \strutdepthpercent \baselineskip
1653 % PDF CMaps. See also LaTeX's t1.cmap.
1655 % do nothing with this by default.
1656 \expandafter\let\csname cmapOT1\endcsname\gobble
1657 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1658 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1660 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1661 % (\pdffontattr was introduced many years ago, but people still run
1662 % older pdftex's; it's easy to conditionalize, so we do.)
1663 \ifpdf \ifx\pdffontattr\undefined \else
1664 \begingroup
1665 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1666 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1667 %%DocumentNeededResources: ProcSet (CIDInit)
1668 %%IncludeResource: ProcSet (CIDInit)
1669 %%BeginResource: CMap (TeX-OT1-0)
1670 %%Title: (TeX-OT1-0 TeX OT1 0)
1671 %%Version: 1.000
1672 %%EndComments
1673 /CIDInit /ProcSet findresource begin
1674 12 dict begin
1675 begincmap
1676 /CIDSystemInfo
1677 << /Registry (TeX)
1678 /Ordering (OT1)
1679 /Supplement 0
1680 >> def
1681 /CMapName /TeX-OT1-0 def
1682 /CMapType 2 def
1683 1 begincodespacerange
1684 <00> <7F>
1685 endcodespacerange
1686 8 beginbfrange
1687 <00> <01> <0393>
1688 <09> <0A> <03A8>
1689 <23> <26> <0023>
1690 <28> <3B> <0028>
1691 <3F> <5B> <003F>
1692 <5D> <5E> <005D>
1693 <61> <7A> <0061>
1694 <7B> <7C> <2013>
1695 endbfrange
1696 40 beginbfchar
1697 <02> <0398>
1698 <03> <039B>
1699 <04> <039E>
1700 <05> <03A0>
1701 <06> <03A3>
1702 <07> <03D2>
1703 <08> <03A6>
1704 <0B> <00660066>
1705 <0C> <00660069>
1706 <0D> <0066006C>
1707 <0E> <006600660069>
1708 <0F> <00660066006C>
1709 <10> <0131>
1710 <11> <0237>
1711 <12> <0060>
1712 <13> <00B4>
1713 <14> <02C7>
1714 <15> <02D8>
1715 <16> <00AF>
1716 <17> <02DA>
1717 <18> <00B8>
1718 <19> <00DF>
1719 <1A> <00E6>
1720 <1B> <0153>
1721 <1C> <00F8>
1722 <1D> <00C6>
1723 <1E> <0152>
1724 <1F> <00D8>
1725 <21> <0021>
1726 <22> <201D>
1727 <27> <2019>
1728 <3C> <00A1>
1729 <3D> <003D>
1730 <3E> <00BF>
1731 <5C> <201C>
1732 <5F> <02D9>
1733 <60> <2018>
1734 <7D> <02DD>
1735 <7E> <007E>
1736 <7F> <00A8>
1737 endbfchar
1738 endcmap
1739 CMapName currentdict /CMap defineresource pop
1742 %%EndResource
1743 %%EOF
1744 }\endgroup
1745 \expandafter\edef\csname cmapOT1\endcsname#1{%
1746 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1749 % \cmapOT1IT
1750 \begingroup
1751 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1752 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1753 %%DocumentNeededResources: ProcSet (CIDInit)
1754 %%IncludeResource: ProcSet (CIDInit)
1755 %%BeginResource: CMap (TeX-OT1IT-0)
1756 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1757 %%Version: 1.000
1758 %%EndComments
1759 /CIDInit /ProcSet findresource begin
1760 12 dict begin
1761 begincmap
1762 /CIDSystemInfo
1763 << /Registry (TeX)
1764 /Ordering (OT1IT)
1765 /Supplement 0
1766 >> def
1767 /CMapName /TeX-OT1IT-0 def
1768 /CMapType 2 def
1769 1 begincodespacerange
1770 <00> <7F>
1771 endcodespacerange
1772 8 beginbfrange
1773 <00> <01> <0393>
1774 <09> <0A> <03A8>
1775 <25> <26> <0025>
1776 <28> <3B> <0028>
1777 <3F> <5B> <003F>
1778 <5D> <5E> <005D>
1779 <61> <7A> <0061>
1780 <7B> <7C> <2013>
1781 endbfrange
1782 42 beginbfchar
1783 <02> <0398>
1784 <03> <039B>
1785 <04> <039E>
1786 <05> <03A0>
1787 <06> <03A3>
1788 <07> <03D2>
1789 <08> <03A6>
1790 <0B> <00660066>
1791 <0C> <00660069>
1792 <0D> <0066006C>
1793 <0E> <006600660069>
1794 <0F> <00660066006C>
1795 <10> <0131>
1796 <11> <0237>
1797 <12> <0060>
1798 <13> <00B4>
1799 <14> <02C7>
1800 <15> <02D8>
1801 <16> <00AF>
1802 <17> <02DA>
1803 <18> <00B8>
1804 <19> <00DF>
1805 <1A> <00E6>
1806 <1B> <0153>
1807 <1C> <00F8>
1808 <1D> <00C6>
1809 <1E> <0152>
1810 <1F> <00D8>
1811 <21> <0021>
1812 <22> <201D>
1813 <23> <0023>
1814 <24> <00A3>
1815 <27> <2019>
1816 <3C> <00A1>
1817 <3D> <003D>
1818 <3E> <00BF>
1819 <5C> <201C>
1820 <5F> <02D9>
1821 <60> <2018>
1822 <7D> <02DD>
1823 <7E> <007E>
1824 <7F> <00A8>
1825 endbfchar
1826 endcmap
1827 CMapName currentdict /CMap defineresource pop
1830 %%EndResource
1831 %%EOF
1832 }\endgroup
1833 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1834 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1837 % \cmapOT1TT
1838 \begingroup
1839 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1840 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1841 %%DocumentNeededResources: ProcSet (CIDInit)
1842 %%IncludeResource: ProcSet (CIDInit)
1843 %%BeginResource: CMap (TeX-OT1TT-0)
1844 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1845 %%Version: 1.000
1846 %%EndComments
1847 /CIDInit /ProcSet findresource begin
1848 12 dict begin
1849 begincmap
1850 /CIDSystemInfo
1851 << /Registry (TeX)
1852 /Ordering (OT1TT)
1853 /Supplement 0
1854 >> def
1855 /CMapName /TeX-OT1TT-0 def
1856 /CMapType 2 def
1857 1 begincodespacerange
1858 <00> <7F>
1859 endcodespacerange
1860 5 beginbfrange
1861 <00> <01> <0393>
1862 <09> <0A> <03A8>
1863 <21> <26> <0021>
1864 <28> <5F> <0028>
1865 <61> <7E> <0061>
1866 endbfrange
1867 32 beginbfchar
1868 <02> <0398>
1869 <03> <039B>
1870 <04> <039E>
1871 <05> <03A0>
1872 <06> <03A3>
1873 <07> <03D2>
1874 <08> <03A6>
1875 <0B> <2191>
1876 <0C> <2193>
1877 <0D> <0027>
1878 <0E> <00A1>
1879 <0F> <00BF>
1880 <10> <0131>
1881 <11> <0237>
1882 <12> <0060>
1883 <13> <00B4>
1884 <14> <02C7>
1885 <15> <02D8>
1886 <16> <00AF>
1887 <17> <02DA>
1888 <18> <00B8>
1889 <19> <00DF>
1890 <1A> <00E6>
1891 <1B> <0153>
1892 <1C> <00F8>
1893 <1D> <00C6>
1894 <1E> <0152>
1895 <1F> <00D8>
1896 <20> <2423>
1897 <27> <2019>
1898 <60> <2018>
1899 <7F> <00A8>
1900 endbfchar
1901 endcmap
1902 CMapName currentdict /CMap defineresource pop
1905 %%EndResource
1906 %%EOF
1907 }\endgroup
1908 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1909 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1911 \fi\fi
1914 % Set the font macro #1 to the font named #2, adding on the
1915 % specified font prefix (normally `cm').
1916 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1917 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1918 % empty to omit).
1919 \def\setfont#1#2#3#4#5{%
1920 \font#1=\fontprefix#2#3 scaled #4
1921 \csname cmap#5\endcsname#1%
1923 % This is what gets called when #5 of \setfont is empty.
1924 \let\cmap\gobble
1925 % emacs-page end of cmaps
1927 % Use cm as the default font prefix.
1928 % To specify the font prefix, you must define \fontprefix
1929 % before you read in texinfo.tex.
1930 \ifx\fontprefix\undefined
1931 \def\fontprefix{cm}
1933 % Support font families that don't use the same naming scheme as CM.
1934 \def\rmshape{r}
1935 \def\rmbshape{bx} %where the normal face is bold
1936 \def\bfshape{b}
1937 \def\bxshape{bx}
1938 \def\ttshape{tt}
1939 \def\ttbshape{tt}
1940 \def\ttslshape{sltt}
1941 \def\itshape{ti}
1942 \def\itbshape{bxti}
1943 \def\slshape{sl}
1944 \def\slbshape{bxsl}
1945 \def\sfshape{ss}
1946 \def\sfbshape{ss}
1947 \def\scshape{csc}
1948 \def\scbshape{csc}
1950 % Definitions for a main text size of 11pt. This is the default in
1951 % Texinfo.
1953 \def\definetextfontsizexi{%
1954 % Text fonts (11.2pt, magstep1).
1955 \def\textnominalsize{11pt}
1956 \edef\mainmagstep{\magstephalf}
1957 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1958 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1959 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1960 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1961 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1962 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1963 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1964 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1965 \font\texti=cmmi10 scaled \mainmagstep
1966 \font\textsy=cmsy10 scaled \mainmagstep
1967 \def\textecsize{1095}
1969 % A few fonts for @defun names and args.
1970 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1971 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1972 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1973 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1975 % Fonts for indices, footnotes, small examples (9pt).
1976 \def\smallnominalsize{9pt}
1977 \setfont\smallrm\rmshape{9}{1000}{OT1}
1978 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1979 \setfont\smallbf\bfshape{10}{900}{OT1}
1980 \setfont\smallit\itshape{9}{1000}{OT1IT}
1981 \setfont\smallsl\slshape{9}{1000}{OT1}
1982 \setfont\smallsf\sfshape{9}{1000}{OT1}
1983 \setfont\smallsc\scshape{10}{900}{OT1}
1984 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1985 \font\smalli=cmmi9
1986 \font\smallsy=cmsy9
1987 \def\smallecsize{0900}
1989 % Fonts for small examples (8pt).
1990 \def\smallernominalsize{8pt}
1991 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1992 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1993 \setfont\smallerbf\bfshape{10}{800}{OT1}
1994 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1995 \setfont\smallersl\slshape{8}{1000}{OT1}
1996 \setfont\smallersf\sfshape{8}{1000}{OT1}
1997 \setfont\smallersc\scshape{10}{800}{OT1}
1998 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1999 \font\smalleri=cmmi8
2000 \font\smallersy=cmsy8
2001 \def\smallerecsize{0800}
2003 % Fonts for title page (20.4pt):
2004 \def\titlenominalsize{20pt}
2005 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2006 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2007 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2008 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2009 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2010 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2011 \let\titlebf=\titlerm
2012 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2013 \font\titlei=cmmi12 scaled \magstep3
2014 \font\titlesy=cmsy10 scaled \magstep4
2015 \def\authorrm{\secrm}
2016 \def\authortt{\sectt}
2017 \def\titleecsize{2074}
2019 % Chapter (and unnumbered) fonts (17.28pt).
2020 \def\chapnominalsize{17pt}
2021 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
2022 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
2023 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
2024 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
2025 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2026 \setfont\chapsf\sfbshape{17}{1000}{OT1}
2027 \let\chapbf=\chaprm
2028 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
2029 \font\chapi=cmmi12 scaled \magstep2
2030 \font\chapsy=cmsy10 scaled \magstep3
2031 \def\chapecsize{1728}
2033 % Section fonts (14.4pt).
2034 \def\secnominalsize{14pt}
2035 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
2036 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
2037 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
2038 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
2039 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2040 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
2041 \let\secbf\secrm
2042 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
2043 \font\seci=cmmi12 scaled \magstep1
2044 \font\secsy=cmsy10 scaled \magstep2
2045 \def\sececsize{1440}
2047 % Subsection fonts (13.15pt).
2048 \def\ssecnominalsize{13pt}
2049 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
2050 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
2051 \setfont\ssecsl\slbshape{10}{1315}{OT1}
2052 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
2053 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2054 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
2055 \let\ssecbf\ssecrm
2056 \setfont\ssecsc\scbshape{10}{1315}{OT1}
2057 \font\sseci=cmmi12 scaled \magstephalf
2058 \font\ssecsy=cmsy10 scaled 1315
2059 \def\ssececsize{1200}
2061 % Reduced fonts for @acro in text (10pt).
2062 \def\reducednominalsize{10pt}
2063 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2064 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2065 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2066 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2067 \setfont\reducedsl\slshape{10}{1000}{OT1}
2068 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2069 \setfont\reducedsc\scshape{10}{1000}{OT1}
2070 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2071 \font\reducedi=cmmi10
2072 \font\reducedsy=cmsy10
2073 \def\reducedecsize{1000}
2075 % reset the current fonts
2076 \textfonts
2078 } % end of 11pt text font size definitions
2081 % Definitions to make the main text be 10pt Computer Modern, with
2082 % section, chapter, etc., sizes following suit. This is for the GNU
2083 % Press printing of the Emacs 22 manual. Maybe other manuals in the
2084 % future. Used with @smallbook, which sets the leading to 12pt.
2086 \def\definetextfontsizex{%
2087 % Text fonts (10pt).
2088 \def\textnominalsize{10pt}
2089 \edef\mainmagstep{1000}
2090 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2091 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2092 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2093 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2094 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2095 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2096 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2097 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2098 \font\texti=cmmi10 scaled \mainmagstep
2099 \font\textsy=cmsy10 scaled \mainmagstep
2100 \def\textecsize{1000}
2102 % A few fonts for @defun names and args.
2103 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2104 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2105 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2106 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2108 % Fonts for indices, footnotes, small examples (9pt).
2109 \def\smallnominalsize{9pt}
2110 \setfont\smallrm\rmshape{9}{1000}{OT1}
2111 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2112 \setfont\smallbf\bfshape{10}{900}{OT1}
2113 \setfont\smallit\itshape{9}{1000}{OT1IT}
2114 \setfont\smallsl\slshape{9}{1000}{OT1}
2115 \setfont\smallsf\sfshape{9}{1000}{OT1}
2116 \setfont\smallsc\scshape{10}{900}{OT1}
2117 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2118 \font\smalli=cmmi9
2119 \font\smallsy=cmsy9
2120 \def\smallecsize{0900}
2122 % Fonts for small examples (8pt).
2123 \def\smallernominalsize{8pt}
2124 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2125 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2126 \setfont\smallerbf\bfshape{10}{800}{OT1}
2127 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2128 \setfont\smallersl\slshape{8}{1000}{OT1}
2129 \setfont\smallersf\sfshape{8}{1000}{OT1}
2130 \setfont\smallersc\scshape{10}{800}{OT1}
2131 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2132 \font\smalleri=cmmi8
2133 \font\smallersy=cmsy8
2134 \def\smallerecsize{0800}
2136 % Fonts for title page (20.4pt):
2137 \def\titlenominalsize{20pt}
2138 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2139 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2140 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2141 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2142 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2143 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2144 \let\titlebf=\titlerm
2145 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2146 \font\titlei=cmmi12 scaled \magstep3
2147 \font\titlesy=cmsy10 scaled \magstep4
2148 \def\authorrm{\secrm}
2149 \def\authortt{\sectt}
2150 \def\titleecsize{2074}
2152 % Chapter fonts (14.4pt).
2153 \def\chapnominalsize{14pt}
2154 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2155 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2156 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2157 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2158 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2159 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2160 \let\chapbf\chaprm
2161 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2162 \font\chapi=cmmi12 scaled \magstep1
2163 \font\chapsy=cmsy10 scaled \magstep2
2164 \def\chapecsize{1440}
2166 % Section fonts (12pt).
2167 \def\secnominalsize{12pt}
2168 \setfont\secrm\rmbshape{12}{1000}{OT1}
2169 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2170 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2171 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2172 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2173 \setfont\secsf\sfbshape{12}{1000}{OT1}
2174 \let\secbf\secrm
2175 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2176 \font\seci=cmmi12
2177 \font\secsy=cmsy10 scaled \magstep1
2178 \def\sececsize{1200}
2180 % Subsection fonts (10pt).
2181 \def\ssecnominalsize{10pt}
2182 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2183 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2184 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2185 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2186 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2187 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2188 \let\ssecbf\ssecrm
2189 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2190 \font\sseci=cmmi10
2191 \font\ssecsy=cmsy10
2192 \def\ssececsize{1000}
2194 % Reduced fonts for @acro in text (9pt).
2195 \def\reducednominalsize{9pt}
2196 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2197 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2198 \setfont\reducedbf\bfshape{10}{900}{OT1}
2199 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2200 \setfont\reducedsl\slshape{9}{1000}{OT1}
2201 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2202 \setfont\reducedsc\scshape{10}{900}{OT1}
2203 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2204 \font\reducedi=cmmi9
2205 \font\reducedsy=cmsy9
2206 \def\reducedecsize{0900}
2208 % reduce space between paragraphs
2209 \divide\parskip by 2
2211 % reset the current fonts
2212 \textfonts
2214 } % end of 10pt text font size definitions
2217 % We provide the user-level command
2218 % @fonttextsize 10
2219 % (or 11) to redefine the text font size. pt is assumed.
2221 \def\xword{10}
2222 \def\xiword{11}
2224 \parseargdef\fonttextsize{%
2225 \def\textsizearg{#1}%
2226 \wlog{doing @fonttextsize \textsizearg}%
2228 % Set \globaldefs so that documents can use this inside @tex, since
2229 % makeinfo 4.8 does not support it, but we need it nonetheless.
2231 \begingroup \globaldefs=1
2232 \ifx\textsizearg\xword \definetextfontsizex
2233 \else \ifx\textsizearg\xiword \definetextfontsizexi
2234 \else
2235 \errhelp=\EMsimple
2236 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2237 \fi\fi
2238 \endgroup
2242 % In order for the font changes to affect most math symbols and letters,
2243 % we have to define the \textfont of the standard families. Since
2244 % texinfo doesn't allow for producing subscripts and superscripts except
2245 % in the main text, we don't bother to reset \scriptfont and
2246 % \scriptscriptfont (which would also require loading a lot more fonts).
2248 \def\resetmathfonts{%
2249 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2250 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2251 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2254 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2255 % of just \STYLE. We do this because \STYLE needs to also set the
2256 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2257 % \tenSTYLE to set the current font.
2259 % Each font-changing command also sets the names \lsize (one size lower)
2260 % and \lllsize (three sizes lower). These relative commands are used in
2261 % the LaTeX logo and acronyms.
2263 % This all needs generalizing, badly.
2265 \def\textfonts{%
2266 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2267 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2268 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2269 \let\tenttsl=\textttsl
2270 \def\curfontsize{text}%
2271 \def\lsize{reduced}\def\lllsize{smaller}%
2272 \resetmathfonts \setleading{\textleading}}
2273 \def\titlefonts{%
2274 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2275 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2276 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2277 \let\tenttsl=\titlettsl
2278 \def\curfontsize{title}%
2279 \def\lsize{chap}\def\lllsize{subsec}%
2280 \resetmathfonts \setleading{25pt}}
2281 \def\titlefont#1{{\titlefonts\rm #1}}
2282 \def\chapfonts{%
2283 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2284 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2285 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2286 \let\tenttsl=\chapttsl
2287 \def\curfontsize{chap}%
2288 \def\lsize{sec}\def\lllsize{text}%
2289 \resetmathfonts \setleading{19pt}}
2290 \def\secfonts{%
2291 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2292 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2293 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2294 \let\tenttsl=\secttsl
2295 \def\curfontsize{sec}%
2296 \def\lsize{subsec}\def\lllsize{reduced}%
2297 \resetmathfonts \setleading{16pt}}
2298 \def\subsecfonts{%
2299 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2300 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2301 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2302 \let\tenttsl=\ssecttsl
2303 \def\curfontsize{ssec}%
2304 \def\lsize{text}\def\lllsize{small}%
2305 \resetmathfonts \setleading{15pt}}
2306 \let\subsubsecfonts = \subsecfonts
2307 \def\reducedfonts{%
2308 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2309 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2310 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2311 \let\tenttsl=\reducedttsl
2312 \def\curfontsize{reduced}%
2313 \def\lsize{small}\def\lllsize{smaller}%
2314 \resetmathfonts \setleading{10.5pt}}
2315 \def\smallfonts{%
2316 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2317 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2318 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2319 \let\tenttsl=\smallttsl
2320 \def\curfontsize{small}%
2321 \def\lsize{smaller}\def\lllsize{smaller}%
2322 \resetmathfonts \setleading{10.5pt}}
2323 \def\smallerfonts{%
2324 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2325 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2326 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2327 \let\tenttsl=\smallerttsl
2328 \def\curfontsize{smaller}%
2329 \def\lsize{smaller}\def\lllsize{smaller}%
2330 \resetmathfonts \setleading{9.5pt}}
2332 % Set the fonts to use with the @small... environments.
2333 \let\smallexamplefonts = \smallfonts
2335 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2336 % can fit this many characters:
2337 % 8.5x11=86 smallbook=72 a4=90 a5=69
2338 % If we use \scriptfonts (8pt), then we can fit this many characters:
2339 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2340 % For me, subjectively, the few extra characters that fit aren't worth
2341 % the additional smallness of 8pt. So I'm making the default 9pt.
2343 % By the way, for comparison, here's what fits with @example (10pt):
2344 % 8.5x11=71 smallbook=60 a4=75 a5=58
2346 % I wish the USA used A4 paper.
2347 % --karl, 24jan03.
2350 % Set up the default fonts, so we can use them for creating boxes.
2352 \definetextfontsizexi
2354 % Define these so they can be easily changed for other fonts.
2355 \def\angleleft{$\langle$}
2356 \def\angleright{$\rangle$}
2358 % Count depth in font-changes, for error checks
2359 \newcount\fontdepth \fontdepth=0
2361 % Fonts for short table of contents.
2362 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2363 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2364 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2365 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2367 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
2368 %% serif) and @ii for TeX italic
2370 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
2371 % unless the following character is such as not to need one.
2372 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
2373 \ptexslash\fi\fi\fi}
2374 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
2375 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
2377 % like \smartslanted except unconditionally uses \ttsl.
2378 % @var is set to this for defun arguments.
2379 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
2381 % like \smartslanted except unconditionally use \sl. We never want
2382 % ttsl for book titles, do we?
2383 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
2385 \let\i=\smartitalic
2386 \let\slanted=\smartslanted
2387 \let\var=\smartslanted
2388 \let\dfn=\smartslanted
2389 \let\emph=\smartitalic
2391 % @b, explicit bold.
2392 \def\b#1{{\bf #1}}
2393 \let\strong=\b
2395 % @sansserif, explicit sans.
2396 \def\sansserif#1{{\sf #1}}
2398 % We can't just use \exhyphenpenalty, because that only has effect at
2399 % the end of a paragraph. Restore normal hyphenation at the end of the
2400 % group within which \nohyphenation is presumably called.
2402 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2403 \def\restorehyphenation{\hyphenchar\font = `- }
2405 % Set sfcode to normal for the chars that usually have another value.
2406 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2407 % sometimes \x has an active definition that messes things up.
2409 \catcode`@=11
2410 \def\plainfrenchspacing{%
2411 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2412 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2413 \def\endofsentencespacefactor{1000}% for @. and friends
2415 \def\plainnonfrenchspacing{%
2416 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2417 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2418 \def\endofsentencespacefactor{3000}% for @. and friends
2420 \catcode`@=\other
2421 \def\endofsentencespacefactor{3000}% default
2423 \def\t#1{%
2424 {\tt \rawbackslash \plainfrenchspacing #1}%
2425 \null
2427 \def\samp#1{`\tclose{#1}'\null}
2428 \setfont\keyrm\rmshape{8}{1000}{OT1}
2429 \font\keysy=cmsy9
2430 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2431 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2432 \vbox{\hrule\kern-0.4pt
2433 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2434 \kern-0.4pt\hrule}%
2435 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2436 \def\key #1{{\nohyphenation \uppercase{#1}}\null}
2437 % The old definition, with no lozenge:
2438 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
2439 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2441 % @file, @option are the same as @samp.
2442 \let\file=\samp
2443 \let\option=\samp
2445 % @code is a modification of @t,
2446 % which makes spaces the same size as normal in the surrounding text.
2447 \def\tclose#1{%
2449 % Change normal interword space to be same as for the current font.
2450 \spaceskip = \fontdimen2\font
2452 % Switch to typewriter.
2455 % But `\ ' produces the large typewriter interword space.
2456 \def\ {{\spaceskip = 0pt{} }}%
2458 % Turn off hyphenation.
2459 \nohyphenation
2461 \rawbackslash
2462 \plainfrenchspacing
2465 \null
2468 % We *must* turn on hyphenation at `-' and `_' in @code.
2469 % Otherwise, it is too hard to avoid overfull hboxes
2470 % in the Emacs manual, the Library manual, etc.
2472 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2473 % both hyphenation at - and hyphenation within words.
2474 % We must therefore turn them both off (\tclose does that)
2475 % and arrange explicitly to hyphenate at a dash.
2476 % -- rms.
2478 \catcode`\-=\active \catcode`\_=\active
2479 \catcode`\'=\active \catcode`\`=\active
2481 \global\def\code{\begingroup
2482 \catcode\rquoteChar=\active \catcode\lquoteChar=\active
2483 \let'\codequoteright \let`\codequoteleft
2485 \catcode\dashChar=\active \catcode\underChar=\active
2486 \ifallowcodebreaks
2487 \let-\codedash
2488 \let_\codeunder
2489 \else
2490 \let-\realdash
2491 \let_\realunder
2493 \codex
2497 \def\realdash{-}
2498 \def\codedash{-\discretionary{}{}{}}
2499 \def\codeunder{%
2500 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2501 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2502 % will therefore expand the active definition of _, which is us
2503 % (inside @code that is), therefore an endless loop.
2504 \ifusingtt{\ifmmode
2505 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2506 \else\normalunderscore \fi
2507 \discretionary{}{}{}}%
2508 {\_}%
2510 \def\codex #1{\tclose{#1}\endgroup}
2512 % An additional complication: the above will allow breaks after, e.g.,
2513 % each of the four underscores in __typeof__. This is undesirable in
2514 % some manuals, especially if they don't have long identifiers in
2515 % general. @allowcodebreaks provides a way to control this.
2517 \newif\ifallowcodebreaks \allowcodebreakstrue
2519 \def\keywordtrue{true}
2520 \def\keywordfalse{false}
2522 \parseargdef\allowcodebreaks{%
2523 \def\txiarg{#1}%
2524 \ifx\txiarg\keywordtrue
2525 \allowcodebreakstrue
2526 \else\ifx\txiarg\keywordfalse
2527 \allowcodebreaksfalse
2528 \else
2529 \errhelp = \EMsimple
2530 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2531 \fi\fi
2534 % @kbd is like @code, except that if the argument is just one @key command,
2535 % then @kbd has no effect.
2537 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2538 % `example' (@kbd uses ttsl only inside of @example and friends),
2539 % or `code' (@kbd uses normal tty font always).
2540 \parseargdef\kbdinputstyle{%
2541 \def\txiarg{#1}%
2542 \ifx\txiarg\worddistinct
2543 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2544 \else\ifx\txiarg\wordexample
2545 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2546 \else\ifx\txiarg\wordcode
2547 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2548 \else
2549 \errhelp = \EMsimple
2550 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2551 \fi\fi\fi
2553 \def\worddistinct{distinct}
2554 \def\wordexample{example}
2555 \def\wordcode{code}
2557 % Default is `distinct.'
2558 \kbdinputstyle distinct
2560 \def\xkey{\key}
2561 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2562 \ifx\one\xkey\ifx\threex\three \key{#2}%
2563 \else{\tclose{\kbdfont\look}}\fi
2564 \else{\tclose{\kbdfont\look}}\fi}
2566 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2567 \let\indicateurl=\code
2568 \let\env=\code
2569 \let\command=\code
2571 % @clicksequence{File @click{} Open ...}
2572 \def\clicksequence#1{\begingroup #1\endgroup}
2574 % @clickstyle @arrow (by default)
2575 \parseargdef\clickstyle{\def\click{#1}}
2576 \def\click{\arrow}
2578 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2579 % second argument specifying the text to display and an optional third
2580 % arg as text to display instead of (rather than in addition to) the url
2581 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2582 % a hypertex \special here.
2584 \def\uref#1{\douref #1,,,\finish}
2585 \def\douref#1,#2,#3,#4\finish{\begingroup
2586 \unsepspaces
2587 \pdfurl{#1}%
2588 \setbox0 = \hbox{\ignorespaces #3}%
2589 \ifdim\wd0 > 0pt
2590 \unhbox0 % third arg given, show only that
2591 \else
2592 \setbox0 = \hbox{\ignorespaces #2}%
2593 \ifdim\wd0 > 0pt
2594 \ifpdf
2595 \unhbox0 % PDF: 2nd arg given, show only it
2596 \else
2597 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2599 \else
2600 \code{#1}% only url given, so show it
2603 \endlink
2604 \endgroup}
2606 % @url synonym for @uref, since that's how everyone uses it.
2608 \let\url=\uref
2610 % rms does not like angle brackets --karl, 17may97.
2611 % So now @email is just like @uref, unless we are pdf.
2613 %\def\email#1{\angleleft{\tt #1}\angleright}
2614 \ifpdf
2615 \def\email#1{\doemail#1,,\finish}
2616 \def\doemail#1,#2,#3\finish{\begingroup
2617 \unsepspaces
2618 \pdfurl{mailto:#1}%
2619 \setbox0 = \hbox{\ignorespaces #2}%
2620 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2621 \endlink
2622 \endgroup}
2623 \else
2624 \let\email=\uref
2627 % Check if we are currently using a typewriter font. Since all the
2628 % Computer Modern typewriter fonts have zero interword stretch (and
2629 % shrink), and it is reasonable to expect all typewriter fonts to have
2630 % this property, we can check that font parameter.
2632 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2634 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2635 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2637 \def\dmn#1{\thinspace #1}
2639 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2641 % @l was never documented to mean ``switch to the Lisp font'',
2642 % and it is not used as such in any manual I can find. We need it for
2643 % Polish suppressed-l. --karl, 22sep96.
2644 %\def\l#1{{\li #1}\null}
2646 % Explicit font changes: @r, @sc, undocumented @ii.
2647 \def\r#1{{\rm #1}} % roman font
2648 \def\sc#1{{\smallcaps#1}} % smallcaps font
2649 \def\ii#1{{\it #1}} % italic font
2651 % @acronym for "FBI", "NATO", and the like.
2652 % We print this one point size smaller, since it's intended for
2653 % all-uppercase.
2655 \def\acronym#1{\doacronym #1,,\finish}
2656 \def\doacronym#1,#2,#3\finish{%
2657 {\selectfonts\lsize #1}%
2658 \def\temp{#2}%
2659 \ifx\temp\empty \else
2660 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2664 % @abbr for "Comput. J." and the like.
2665 % No font change, but don't do end-of-sentence spacing.
2667 \def\abbr#1{\doabbr #1,,\finish}
2668 \def\doabbr#1,#2,#3\finish{%
2669 {\plainfrenchspacing #1}%
2670 \def\temp{#2}%
2671 \ifx\temp\empty \else
2672 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2676 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2678 \def\pounds{{\it\$}}
2680 % @euro{} comes from a separate font, depending on the current style.
2681 % We use the free feym* fonts from the eurosym package by Henrik
2682 % Theiling, which support regular, slanted, bold and bold slanted (and
2683 % "outlined" (blackboard board, sort of) versions, which we don't need).
2684 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2686 % Although only regular is the truly official Euro symbol, we ignore
2687 % that. The Euro is designed to be slightly taller than the regular
2688 % font height.
2690 % feymr - regular
2691 % feymo - slanted
2692 % feybr - bold
2693 % feybo - bold slanted
2695 % There is no good (free) typewriter version, to my knowledge.
2696 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2697 % Hmm.
2699 % Also doesn't work in math. Do we need to do math with euro symbols?
2700 % Hope not.
2703 \def\euro{{\eurofont e}}
2704 \def\eurofont{%
2705 % We set the font at each command, rather than predefining it in
2706 % \textfonts and the other font-switching commands, so that
2707 % installations which never need the symbol don't have to have the
2708 % font installed.
2710 % There is only one designed size (nominal 10pt), so we always scale
2711 % that to the current nominal size.
2713 % By the way, simply using "at 1em" works for cmr10 and the like, but
2714 % does not work for cmbx10 and other extended/shrunken fonts.
2716 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2718 \ifx\curfontstyle\bfstylename
2719 % bold:
2720 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2721 \else
2722 % regular:
2723 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2725 \thiseurofont
2728 % Hacks for glyphs from the EC fonts similar to \euro. We don't
2729 % use \let for the aliases, because sometimes we redefine the original
2730 % macro, and the alias should reflect the redefinition.
2731 \def\guillemetleft{{\ecfont \char"13}}
2732 \def\guillemotleft{\guillemetleft}
2733 \def\guillemetright{{\ecfont \char"14}}
2734 \def\guillemotright{\guillemetright}
2735 \def\guilsinglleft{{\ecfont \char"0E}}
2736 \def\guilsinglright{{\ecfont \char"0F}}
2737 \def\quotedblbase{{\ecfont \char"12}}
2738 \def\quotesinglbase{{\ecfont \char"0D}}
2740 \def\ecfont{%
2741 % We can't distinguish serif/sanserif and italic/slanted, but this
2742 % is used for crude hacks anyway (like adding French and German
2743 % quotes to documents typeset with CM, where we lose kerning), so
2744 % hopefully nobody will notice/care.
2745 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
2746 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
2747 \ifx\curfontstyle\bfstylename
2748 % bold:
2749 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
2750 \else
2751 % regular:
2752 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
2754 \thisecfont
2757 % @registeredsymbol - R in a circle. The font for the R should really
2758 % be smaller yet, but lllsize is the best we can do for now.
2759 % Adapted from the plain.tex definition of \copyright.
2761 \def\registeredsymbol{%
2762 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2763 \hfil\crcr\Orb}}%
2767 % @textdegree - the normal degrees sign.
2769 \def\textdegree{$^\circ$}
2771 % Laurent Siebenmann reports \Orb undefined with:
2772 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2773 % so we'll define it if necessary.
2775 \ifx\Orb\undefined
2776 \def\Orb{\mathhexbox20D}
2779 % Quotes.
2780 \chardef\quotedblleft="5C
2781 \chardef\quotedblright=`\"
2782 \chardef\quoteleft=`\`
2783 \chardef\quoteright=`\'
2786 \message{page headings,}
2788 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2789 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2791 % First the title page. Must do @settitle before @titlepage.
2792 \newif\ifseenauthor
2793 \newif\iffinishedtitlepage
2795 % Do an implicit @contents or @shortcontents after @end titlepage if the
2796 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2798 \newif\ifsetcontentsaftertitlepage
2799 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2800 \newif\ifsetshortcontentsaftertitlepage
2801 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2803 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2804 \endgroup\page\hbox{}\page}
2806 \envdef\titlepage{%
2807 % Open one extra group, as we want to close it in the middle of \Etitlepage.
2808 \begingroup
2809 \parindent=0pt \textfonts
2810 % Leave some space at the very top of the page.
2811 \vglue\titlepagetopglue
2812 % No rule at page bottom unless we print one at the top with @title.
2813 \finishedtitlepagetrue
2815 % Most title ``pages'' are actually two pages long, with space
2816 % at the top of the second. We don't want the ragged left on the second.
2817 \let\oldpage = \page
2818 \def\page{%
2819 \iffinishedtitlepage\else
2820 \finishtitlepage
2822 \let\page = \oldpage
2823 \page
2824 \null
2828 \def\Etitlepage{%
2829 \iffinishedtitlepage\else
2830 \finishtitlepage
2832 % It is important to do the page break before ending the group,
2833 % because the headline and footline are only empty inside the group.
2834 % If we use the new definition of \page, we always get a blank page
2835 % after the title page, which we certainly don't want.
2836 \oldpage
2837 \endgroup
2839 % Need this before the \...aftertitlepage checks so that if they are
2840 % in effect the toc pages will come out with page numbers.
2841 \HEADINGSon
2843 % If they want short, they certainly want long too.
2844 \ifsetshortcontentsaftertitlepage
2845 \shortcontents
2846 \contents
2847 \global\let\shortcontents = \relax
2848 \global\let\contents = \relax
2851 \ifsetcontentsaftertitlepage
2852 \contents
2853 \global\let\contents = \relax
2854 \global\let\shortcontents = \relax
2858 \def\finishtitlepage{%
2859 \vskip4pt \hrule height 2pt width \hsize
2860 \vskip\titlepagebottomglue
2861 \finishedtitlepagetrue
2864 %%% Macros to be used within @titlepage:
2866 \let\subtitlerm=\tenrm
2867 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2869 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2870 \let\tt=\authortt}
2872 \parseargdef\title{%
2873 \checkenv\titlepage
2874 \leftline{\titlefonts\rm #1}
2875 % print a rule at the page bottom also.
2876 \finishedtitlepagefalse
2877 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2880 \parseargdef\subtitle{%
2881 \checkenv\titlepage
2882 {\subtitlefont \rightline{#1}}%
2885 % @author should come last, but may come many times.
2886 % It can also be used inside @quotation.
2888 \parseargdef\author{%
2889 \def\temp{\quotation}%
2890 \ifx\thisenv\temp
2891 \def\quotationauthor{#1}% printed in \Equotation.
2892 \else
2893 \checkenv\titlepage
2894 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2895 {\authorfont \leftline{#1}}%
2900 %%% Set up page headings and footings.
2902 \let\thispage=\folio
2904 \newtoks\evenheadline % headline on even pages
2905 \newtoks\oddheadline % headline on odd pages
2906 \newtoks\evenfootline % footline on even pages
2907 \newtoks\oddfootline % footline on odd pages
2909 % Now make TeX use those variables
2910 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2911 \else \the\evenheadline \fi}}
2912 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2913 \else \the\evenfootline \fi}\HEADINGShook}
2914 \let\HEADINGShook=\relax
2916 % Commands to set those variables.
2917 % For example, this is what @headings on does
2918 % @evenheading @thistitle|@thispage|@thischapter
2919 % @oddheading @thischapter|@thispage|@thistitle
2920 % @evenfooting @thisfile||
2921 % @oddfooting ||@thisfile
2924 \def\evenheading{\parsearg\evenheadingxxx}
2925 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2926 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2927 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2929 \def\oddheading{\parsearg\oddheadingxxx}
2930 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2931 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2932 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2934 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2936 \def\evenfooting{\parsearg\evenfootingxxx}
2937 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2938 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2939 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2941 \def\oddfooting{\parsearg\oddfootingxxx}
2942 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2943 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2944 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2946 % Leave some space for the footline. Hopefully ok to assume
2947 % @evenfooting will not be used by itself.
2948 \global\advance\pageheight by -12pt
2949 \global\advance\vsize by -12pt
2952 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2954 % @evenheadingmarks top \thischapter <- chapter at the top of a page
2955 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
2957 % The same set of arguments for:
2959 % @oddheadingmarks
2960 % @evenfootingmarks
2961 % @oddfootingmarks
2962 % @everyheadingmarks
2963 % @everyfootingmarks
2965 \def\evenheadingmarks{\headingmarks{even}{heading}}
2966 \def\oddheadingmarks{\headingmarks{odd}{heading}}
2967 \def\evenfootingmarks{\headingmarks{even}{footing}}
2968 \def\oddfootingmarks{\headingmarks{odd}{footing}}
2969 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
2970 \headingmarks{odd}{heading}{#1} }
2971 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
2972 \headingmarks{odd}{footing}{#1} }
2973 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
2974 \def\headingmarks#1#2#3 {%
2975 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
2976 \global\expandafter\let\csname get#1#2marks\endcsname \temp
2979 \everyheadingmarks bottom
2980 \everyfootingmarks bottom
2982 % @headings double turns headings on for double-sided printing.
2983 % @headings single turns headings on for single-sided printing.
2984 % @headings off turns them off.
2985 % @headings on same as @headings double, retained for compatibility.
2986 % @headings after turns on double-sided headings after this page.
2987 % @headings doubleafter turns on double-sided headings after this page.
2988 % @headings singleafter turns on single-sided headings after this page.
2989 % By default, they are off at the start of a document,
2990 % and turned `on' after @end titlepage.
2992 \def\headings #1 {\csname HEADINGS#1\endcsname}
2994 \def\HEADINGSoff{%
2995 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2996 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2997 \HEADINGSoff
2998 % When we turn headings on, set the page number to 1.
2999 % For double-sided printing, put current file name in lower left corner,
3000 % chapter name on inside top of right hand pages, document
3001 % title on inside top of left hand pages, and page numbers on outside top
3002 % edge of all pages.
3003 \def\HEADINGSdouble{%
3004 \global\pageno=1
3005 \global\evenfootline={\hfil}
3006 \global\oddfootline={\hfil}
3007 \global\evenheadline={\line{\folio\hfil\thistitle}}
3008 \global\oddheadline={\line{\thischapter\hfil\folio}}
3009 \global\let\contentsalignmacro = \chapoddpage
3011 \let\contentsalignmacro = \chappager
3013 % For single-sided printing, chapter title goes across top left of page,
3014 % page number on top right.
3015 \def\HEADINGSsingle{%
3016 \global\pageno=1
3017 \global\evenfootline={\hfil}
3018 \global\oddfootline={\hfil}
3019 \global\evenheadline={\line{\thischapter\hfil\folio}}
3020 \global\oddheadline={\line{\thischapter\hfil\folio}}
3021 \global\let\contentsalignmacro = \chappager
3023 \def\HEADINGSon{\HEADINGSdouble}
3025 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3026 \let\HEADINGSdoubleafter=\HEADINGSafter
3027 \def\HEADINGSdoublex{%
3028 \global\evenfootline={\hfil}
3029 \global\oddfootline={\hfil}
3030 \global\evenheadline={\line{\folio\hfil\thistitle}}
3031 \global\oddheadline={\line{\thischapter\hfil\folio}}
3032 \global\let\contentsalignmacro = \chapoddpage
3035 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3036 \def\HEADINGSsinglex{%
3037 \global\evenfootline={\hfil}
3038 \global\oddfootline={\hfil}
3039 \global\evenheadline={\line{\thischapter\hfil\folio}}
3040 \global\oddheadline={\line{\thischapter\hfil\folio}}
3041 \global\let\contentsalignmacro = \chappager
3044 % Subroutines used in generating headings
3045 % This produces Day Month Year style of output.
3046 % Only define if not already defined, in case a txi-??.tex file has set
3047 % up a different format (e.g., txi-cs.tex does this).
3048 \ifx\today\undefined
3049 \def\today{%
3050 \number\day\space
3051 \ifcase\month
3052 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3053 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3054 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3056 \space\number\year}
3059 % @settitle line... specifies the title of the document, for headings.
3060 % It generates no output of its own.
3061 \def\thistitle{\putwordNoTitle}
3062 \def\settitle{\parsearg{\gdef\thistitle}}
3065 \message{tables,}
3066 % Tables -- @table, @ftable, @vtable, @item(x).
3068 % default indentation of table text
3069 \newdimen\tableindent \tableindent=.8in
3070 % default indentation of @itemize and @enumerate text
3071 \newdimen\itemindent \itemindent=.3in
3072 % margin between end of table item and start of table text.
3073 \newdimen\itemmargin \itemmargin=.1in
3075 % used internally for \itemindent minus \itemmargin
3076 \newdimen\itemmax
3078 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3079 % these defs.
3080 % They also define \itemindex
3081 % to index the item name in whatever manner is desired (perhaps none).
3083 \newif\ifitemxneedsnegativevskip
3085 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3087 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3088 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3090 \def\itemzzz #1{\begingroup %
3091 \advance\hsize by -\rightskip
3092 \advance\hsize by -\tableindent
3093 \setbox0=\hbox{\itemindicate{#1}}%
3094 \itemindex{#1}%
3095 \nobreak % This prevents a break before @itemx.
3097 % If the item text does not fit in the space we have, put it on a line
3098 % by itself, and do not allow a page break either before or after that
3099 % line. We do not start a paragraph here because then if the next
3100 % command is, e.g., @kindex, the whatsit would get put into the
3101 % horizontal list on a line by itself, resulting in extra blank space.
3102 \ifdim \wd0>\itemmax
3104 % Make this a paragraph so we get the \parskip glue and wrapping,
3105 % but leave it ragged-right.
3106 \begingroup
3107 \advance\leftskip by-\tableindent
3108 \advance\hsize by\tableindent
3109 \advance\rightskip by0pt plus1fil
3110 \leavevmode\unhbox0\par
3111 \endgroup
3113 % We're going to be starting a paragraph, but we don't want the
3114 % \parskip glue -- logically it's part of the @item we just started.
3115 \nobreak \vskip-\parskip
3117 % Stop a page break at the \parskip glue coming up. However, if
3118 % what follows is an environment such as @example, there will be no
3119 % \parskip glue; then the negative vskip we just inserted would
3120 % cause the example and the item to crash together. So we use this
3121 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3122 % \parskip glue after all. Section titles are handled this way also.
3124 \penalty 10001
3125 \endgroup
3126 \itemxneedsnegativevskipfalse
3127 \else
3128 % The item text fits into the space. Start a paragraph, so that the
3129 % following text (if any) will end up on the same line.
3130 \noindent
3131 % Do this with kerns and \unhbox so that if there is a footnote in
3132 % the item text, it can migrate to the main vertical list and
3133 % eventually be printed.
3134 \nobreak\kern-\tableindent
3135 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3136 \unhbox0
3137 \nobreak\kern\dimen0
3138 \endgroup
3139 \itemxneedsnegativevskiptrue
3143 \def\item{\errmessage{@item while not in a list environment}}
3144 \def\itemx{\errmessage{@itemx while not in a list environment}}
3146 % @table, @ftable, @vtable.
3147 \envdef\table{%
3148 \let\itemindex\gobble
3149 \tablecheck{table}%
3151 \envdef\ftable{%
3152 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3153 \tablecheck{ftable}%
3155 \envdef\vtable{%
3156 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3157 \tablecheck{vtable}%
3159 \def\tablecheck#1{%
3160 \ifnum \the\catcode`\^^M=\active
3161 \endgroup
3162 \errmessage{This command won't work in this context; perhaps the problem is
3163 that we are \inenvironment\thisenv}%
3164 \def\next{\doignore{#1}}%
3165 \else
3166 \let\next\tablex
3168 \next
3170 \def\tablex#1{%
3171 \def\itemindicate{#1}%
3172 \parsearg\tabley
3174 \def\tabley#1{%
3176 \makevalueexpandable
3177 \edef\temp{\noexpand\tablez #1\space\space\space}%
3178 \expandafter
3179 }\temp \endtablez
3181 \def\tablez #1 #2 #3 #4\endtablez{%
3182 \aboveenvbreak
3183 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3184 \ifnum 0#2>0 \tableindent=#2\mil \fi
3185 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3186 \itemmax=\tableindent
3187 \advance \itemmax by -\itemmargin
3188 \advance \leftskip by \tableindent
3189 \exdentamount=\tableindent
3190 \parindent = 0pt
3191 \parskip = \smallskipamount
3192 \ifdim \parskip=0pt \parskip=2pt \fi
3193 \let\item = \internalBitem
3194 \let\itemx = \internalBitemx
3196 \def\Etable{\endgraf\afterenvbreak}
3197 \let\Eftable\Etable
3198 \let\Evtable\Etable
3199 \let\Eitemize\Etable
3200 \let\Eenumerate\Etable
3202 % This is the counter used by @enumerate, which is really @itemize
3204 \newcount \itemno
3206 \envdef\itemize{\parsearg\doitemize}
3208 \def\doitemize#1{%
3209 \aboveenvbreak
3210 \itemmax=\itemindent
3211 \advance\itemmax by -\itemmargin
3212 \advance\leftskip by \itemindent
3213 \exdentamount=\itemindent
3214 \parindent=0pt
3215 \parskip=\smallskipamount
3216 \ifdim\parskip=0pt \parskip=2pt \fi
3217 \def\itemcontents{#1}%
3218 % @itemize with no arg is equivalent to @itemize @bullet.
3219 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3220 \let\item=\itemizeitem
3223 % Definition of @item while inside @itemize and @enumerate.
3225 \def\itemizeitem{%
3226 \advance\itemno by 1 % for enumerations
3227 {\let\par=\endgraf \smallbreak}% reasonable place to break
3229 % If the document has an @itemize directly after a section title, a
3230 % \nobreak will be last on the list, and \sectionheading will have
3231 % done a \vskip-\parskip. In that case, we don't want to zero
3232 % parskip, or the item text will crash with the heading. On the
3233 % other hand, when there is normal text preceding the item (as there
3234 % usually is), we do want to zero parskip, or there would be too much
3235 % space. In that case, we won't have a \nobreak before. At least
3236 % that's the theory.
3237 \ifnum\lastpenalty<10000 \parskip=0in \fi
3238 \noindent
3239 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3240 \vadjust{\penalty 1200}}% not good to break after first line of item.
3241 \flushcr
3244 % \splitoff TOKENS\endmark defines \first to be the first token in
3245 % TOKENS, and \rest to be the remainder.
3247 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3249 % Allow an optional argument of an uppercase letter, lowercase letter,
3250 % or number, to specify the first label in the enumerated list. No
3251 % argument is the same as `1'.
3253 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3254 \def\enumeratey #1 #2\endenumeratey{%
3255 % If we were given no argument, pretend we were given `1'.
3256 \def\thearg{#1}%
3257 \ifx\thearg\empty \def\thearg{1}\fi
3259 % Detect if the argument is a single token. If so, it might be a
3260 % letter. Otherwise, the only valid thing it can be is a number.
3261 % (We will always have one token, because of the test we just made.
3262 % This is a good thing, since \splitoff doesn't work given nothing at
3263 % all -- the first parameter is undelimited.)
3264 \expandafter\splitoff\thearg\endmark
3265 \ifx\rest\empty
3266 % Only one token in the argument. It could still be anything.
3267 % A ``lowercase letter'' is one whose \lccode is nonzero.
3268 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3269 % not equal to itself.
3270 % Otherwise, we assume it's a number.
3272 % We need the \relax at the end of the \ifnum lines to stop TeX from
3273 % continuing to look for a <number>.
3275 \ifnum\lccode\expandafter`\thearg=0\relax
3276 \numericenumerate % a number (we hope)
3277 \else
3278 % It's a letter.
3279 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3280 \lowercaseenumerate % lowercase letter
3281 \else
3282 \uppercaseenumerate % uppercase letter
3285 \else
3286 % Multiple tokens in the argument. We hope it's a number.
3287 \numericenumerate
3291 % An @enumerate whose labels are integers. The starting integer is
3292 % given in \thearg.
3294 \def\numericenumerate{%
3295 \itemno = \thearg
3296 \startenumeration{\the\itemno}%
3299 % The starting (lowercase) letter is in \thearg.
3300 \def\lowercaseenumerate{%
3301 \itemno = \expandafter`\thearg
3302 \startenumeration{%
3303 % Be sure we're not beyond the end of the alphabet.
3304 \ifnum\itemno=0
3305 \errmessage{No more lowercase letters in @enumerate; get a bigger
3306 alphabet}%
3308 \char\lccode\itemno
3312 % The starting (uppercase) letter is in \thearg.
3313 \def\uppercaseenumerate{%
3314 \itemno = \expandafter`\thearg
3315 \startenumeration{%
3316 % Be sure we're not beyond the end of the alphabet.
3317 \ifnum\itemno=0
3318 \errmessage{No more uppercase letters in @enumerate; get a bigger
3319 alphabet}
3321 \char\uccode\itemno
3325 % Call \doitemize, adding a period to the first argument and supplying the
3326 % common last two arguments. Also subtract one from the initial value in
3327 % \itemno, since @item increments \itemno.
3329 \def\startenumeration#1{%
3330 \advance\itemno by -1
3331 \doitemize{#1.}\flushcr
3334 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3335 % to @enumerate.
3337 \def\alphaenumerate{\enumerate{a}}
3338 \def\capsenumerate{\enumerate{A}}
3339 \def\Ealphaenumerate{\Eenumerate}
3340 \def\Ecapsenumerate{\Eenumerate}
3343 % @multitable macros
3344 % Amy Hendrickson, 8/18/94, 3/6/96
3346 % @multitable ... @end multitable will make as many columns as desired.
3347 % Contents of each column will wrap at width given in preamble. Width
3348 % can be specified either with sample text given in a template line,
3349 % or in percent of \hsize, the current width of text on page.
3351 % Table can continue over pages but will only break between lines.
3353 % To make preamble:
3355 % Either define widths of columns in terms of percent of \hsize:
3356 % @multitable @columnfractions .25 .3 .45
3357 % @item ...
3359 % Numbers following @columnfractions are the percent of the total
3360 % current hsize to be used for each column. You may use as many
3361 % columns as desired.
3364 % Or use a template:
3365 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3366 % @item ...
3367 % using the widest term desired in each column.
3369 % Each new table line starts with @item, each subsequent new column
3370 % starts with @tab. Empty columns may be produced by supplying @tab's
3371 % with nothing between them for as many times as empty columns are needed,
3372 % ie, @tab@tab@tab will produce two empty columns.
3374 % @item, @tab do not need to be on their own lines, but it will not hurt
3375 % if they are.
3377 % Sample multitable:
3379 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3380 % @item first col stuff @tab second col stuff @tab third col
3381 % @item
3382 % first col stuff
3383 % @tab
3384 % second col stuff
3385 % @tab
3386 % third col
3387 % @item first col stuff @tab second col stuff
3388 % @tab Many paragraphs of text may be used in any column.
3390 % They will wrap at the width determined by the template.
3391 % @item@tab@tab This will be in third column.
3392 % @end multitable
3394 % Default dimensions may be reset by user.
3395 % @multitableparskip is vertical space between paragraphs in table.
3396 % @multitableparindent is paragraph indent in table.
3397 % @multitablecolmargin is horizontal space to be left between columns.
3398 % @multitablelinespace is space to leave between table items, baseline
3399 % to baseline.
3400 % 0pt means it depends on current normal line spacing.
3402 \newskip\multitableparskip
3403 \newskip\multitableparindent
3404 \newdimen\multitablecolspace
3405 \newskip\multitablelinespace
3406 \multitableparskip=0pt
3407 \multitableparindent=6pt
3408 \multitablecolspace=12pt
3409 \multitablelinespace=0pt
3411 % Macros used to set up halign preamble:
3413 \let\endsetuptable\relax
3414 \def\xendsetuptable{\endsetuptable}
3415 \let\columnfractions\relax
3416 \def\xcolumnfractions{\columnfractions}
3417 \newif\ifsetpercent
3419 % #1 is the @columnfraction, usually a decimal number like .5, but might
3420 % be just 1. We just use it, whatever it is.
3422 \def\pickupwholefraction#1 {%
3423 \global\advance\colcount by 1
3424 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3425 \setuptable
3428 \newcount\colcount
3429 \def\setuptable#1{%
3430 \def\firstarg{#1}%
3431 \ifx\firstarg\xendsetuptable
3432 \let\go = \relax
3433 \else
3434 \ifx\firstarg\xcolumnfractions
3435 \global\setpercenttrue
3436 \else
3437 \ifsetpercent
3438 \let\go\pickupwholefraction
3439 \else
3440 \global\advance\colcount by 1
3441 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3442 % separator; typically that is always in the input, anyway.
3443 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3446 \ifx\go\pickupwholefraction
3447 % Put the argument back for the \pickupwholefraction call, so
3448 % we'll always have a period there to be parsed.
3449 \def\go{\pickupwholefraction#1}%
3450 \else
3451 \let\go = \setuptable
3452 \fi%
3457 % multitable-only commands.
3459 % @headitem starts a heading row, which we typeset in bold.
3460 % Assignments have to be global since we are inside the implicit group
3461 % of an alignment entry. Note that \everycr resets \everytab.
3462 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
3464 % A \tab used to include \hskip1sp. But then the space in a template
3465 % line is not enough. That is bad. So let's go back to just `&' until
3466 % we encounter the problem it was intended to solve again.
3467 % --karl, nathan@acm.org, 20apr99.
3468 \def\tab{\checkenv\multitable &\the\everytab}%
3470 % @multitable ... @end multitable definitions:
3472 \newtoks\everytab % insert after every tab.
3474 \envdef\multitable{%
3475 \vskip\parskip
3476 \startsavinginserts
3478 % @item within a multitable starts a normal row.
3479 % We use \def instead of \let so that if one of the multitable entries
3480 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3481 % \endtemplate) expanding \doitemize.
3482 \def\item{\crcr}%
3484 \tolerance=9500
3485 \hbadness=9500
3486 \setmultitablespacing
3487 \parskip=\multitableparskip
3488 \parindent=\multitableparindent
3489 \overfullrule=0pt
3490 \global\colcount=0
3492 \everycr = {%
3493 \noalign{%
3494 \global\everytab={}%
3495 \global\colcount=0 % Reset the column counter.
3496 % Check for saved footnotes, etc.
3497 \checkinserts
3498 % Keeps underfull box messages off when table breaks over pages.
3499 %\filbreak
3500 % Maybe so, but it also creates really weird page breaks when the
3501 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3502 % problem manifests itself, so it can be fixed for real --karl.
3506 \parsearg\domultitable
3508 \def\domultitable#1{%
3509 % To parse everything between @multitable and @item:
3510 \setuptable#1 \endsetuptable
3512 % This preamble sets up a generic column definition, which will
3513 % be used as many times as user calls for columns.
3514 % \vtop will set a single line and will also let text wrap and
3515 % continue for many paragraphs if desired.
3516 \halign\bgroup &%
3517 \global\advance\colcount by 1
3518 \multistrut
3519 \vtop{%
3520 % Use the current \colcount to find the correct column width:
3521 \hsize=\expandafter\csname col\the\colcount\endcsname
3523 % In order to keep entries from bumping into each other
3524 % we will add a \leftskip of \multitablecolspace to all columns after
3525 % the first one.
3527 % If a template has been used, we will add \multitablecolspace
3528 % to the width of each template entry.
3530 % If the user has set preamble in terms of percent of \hsize we will
3531 % use that dimension as the width of the column, and the \leftskip
3532 % will keep entries from bumping into each other. Table will start at
3533 % left margin and final column will justify at right margin.
3535 % Make sure we don't inherit \rightskip from the outer environment.
3536 \rightskip=0pt
3537 \ifnum\colcount=1
3538 % The first column will be indented with the surrounding text.
3539 \advance\hsize by\leftskip
3540 \else
3541 \ifsetpercent \else
3542 % If user has not set preamble in terms of percent of \hsize
3543 % we will advance \hsize by \multitablecolspace.
3544 \advance\hsize by \multitablecolspace
3546 % In either case we will make \leftskip=\multitablecolspace:
3547 \leftskip=\multitablecolspace
3549 % Ignoring space at the beginning and end avoids an occasional spurious
3550 % blank line, when TeX decides to break the line at the space before the
3551 % box from the multistrut, so the strut ends up on a line by itself.
3552 % For example:
3553 % @multitable @columnfractions .11 .89
3554 % @item @code{#}
3555 % @tab Legal holiday which is valid in major parts of the whole country.
3556 % Is automatically provided with highlighting sequences respectively
3557 % marking characters.
3558 \noindent\ignorespaces##\unskip\multistrut
3559 }\cr
3561 \def\Emultitable{%
3562 \crcr
3563 \egroup % end the \halign
3564 \global\setpercentfalse
3567 \def\setmultitablespacing{%
3568 \def\multistrut{\strut}% just use the standard line spacing
3570 % Compute \multitablelinespace (if not defined by user) for use in
3571 % \multitableparskip calculation. We used define \multistrut based on
3572 % this, but (ironically) that caused the spacing to be off.
3573 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3574 \ifdim\multitablelinespace=0pt
3575 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3576 \global\advance\multitablelinespace by-\ht0
3578 %% Test to see if parskip is larger than space between lines of
3579 %% table. If not, do nothing.
3580 %% If so, set to same dimension as multitablelinespace.
3581 \ifdim\multitableparskip>\multitablelinespace
3582 \global\multitableparskip=\multitablelinespace
3583 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3584 %% than skip between lines in the table.
3585 \fi%
3586 \ifdim\multitableparskip=0pt
3587 \global\multitableparskip=\multitablelinespace
3588 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3589 %% than skip between lines in the table.
3590 \fi}
3593 \message{conditionals,}
3595 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3596 % @ifnotxml always succeed. They currently do nothing; we don't
3597 % attempt to check whether the conditionals are properly nested. But we
3598 % have to remember that they are conditionals, so that @end doesn't
3599 % attempt to close an environment group.
3601 \def\makecond#1{%
3602 \expandafter\let\csname #1\endcsname = \relax
3603 \expandafter\let\csname iscond.#1\endcsname = 1
3605 \makecond{iftex}
3606 \makecond{ifnotdocbook}
3607 \makecond{ifnothtml}
3608 \makecond{ifnotinfo}
3609 \makecond{ifnotplaintext}
3610 \makecond{ifnotxml}
3612 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3614 \def\direntry{\doignore{direntry}}
3615 \def\documentdescription{\doignore{documentdescription}}
3616 \def\docbook{\doignore{docbook}}
3617 \def\html{\doignore{html}}
3618 \def\ifdocbook{\doignore{ifdocbook}}
3619 \def\ifhtml{\doignore{ifhtml}}
3620 \def\ifinfo{\doignore{ifinfo}}
3621 \def\ifnottex{\doignore{ifnottex}}
3622 \def\ifplaintext{\doignore{ifplaintext}}
3623 \def\ifxml{\doignore{ifxml}}
3624 \def\ignore{\doignore{ignore}}
3625 \def\menu{\doignore{menu}}
3626 \def\xml{\doignore{xml}}
3628 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3630 % A count to remember the depth of nesting.
3631 \newcount\doignorecount
3633 \def\doignore#1{\begingroup
3634 % Scan in ``verbatim'' mode:
3635 \obeylines
3636 \catcode`\@ = \other
3637 \catcode`\{ = \other
3638 \catcode`\} = \other
3640 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3641 \spaceisspace
3643 % Count number of #1's that we've seen.
3644 \doignorecount = 0
3646 % Swallow text until we reach the matching `@end #1'.
3647 \dodoignore{#1}%
3650 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3651 \obeylines %
3653 \gdef\dodoignore#1{%
3654 % #1 contains the command name as a string, e.g., `ifinfo'.
3656 % Define a command to find the next `@end #1'.
3657 \long\def\doignoretext##1^^M@end #1{%
3658 \doignoretextyyy##1^^M@#1\_STOP_}%
3660 % And this command to find another #1 command, at the beginning of a
3661 % line. (Otherwise, we would consider a line `@c @ifset', for
3662 % example, to count as an @ifset for nesting.)
3663 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3665 % And now expand that command.
3666 \doignoretext ^^M%
3670 \def\doignoreyyy#1{%
3671 \def\temp{#1}%
3672 \ifx\temp\empty % Nothing found.
3673 \let\next\doignoretextzzz
3674 \else % Found a nested condition, ...
3675 \advance\doignorecount by 1
3676 \let\next\doignoretextyyy % ..., look for another.
3677 % If we're here, #1 ends with ^^M\ifinfo (for example).
3679 \next #1% the token \_STOP_ is present just after this macro.
3682 % We have to swallow the remaining "\_STOP_".
3684 \def\doignoretextzzz#1{%
3685 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3686 \let\next\enddoignore
3687 \else % Still inside a nested condition.
3688 \advance\doignorecount by -1
3689 \let\next\doignoretext % Look for the next @end.
3691 \next
3694 % Finish off ignored text.
3695 { \obeylines%
3696 % Ignore anything after the last `@end #1'; this matters in verbatim
3697 % environments, where otherwise the newline after an ignored conditional
3698 % would result in a blank line in the output.
3699 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3703 % @set VAR sets the variable VAR to an empty value.
3704 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3706 % Since we want to separate VAR from REST-OF-LINE (which might be
3707 % empty), we can't just use \parsearg; we have to insert a space of our
3708 % own to delimit the rest of the line, and then take it out again if we
3709 % didn't need it.
3710 % We rely on the fact that \parsearg sets \catcode`\ =10.
3712 \parseargdef\set{\setyyy#1 \endsetyyy}
3713 \def\setyyy#1 #2\endsetyyy{%
3715 \makevalueexpandable
3716 \def\temp{#2}%
3717 \edef\next{\gdef\makecsname{SET#1}}%
3718 \ifx\temp\empty
3719 \next{}%
3720 \else
3721 \setzzz#2\endsetzzz
3725 % Remove the trailing space \setxxx inserted.
3726 \def\setzzz#1 \endsetzzz{\next{#1}}
3728 % @clear VAR clears (i.e., unsets) the variable VAR.
3730 \parseargdef\clear{%
3732 \makevalueexpandable
3733 \global\expandafter\let\csname SET#1\endcsname=\relax
3737 % @value{foo} gets the text saved in variable foo.
3738 \def\value{\begingroup\makevalueexpandable\valuexxx}
3739 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3741 \catcode`\- = \active \catcode`\_ = \active
3743 \gdef\makevalueexpandable{%
3744 \let\value = \expandablevalue
3745 % We don't want these characters active, ...
3746 \catcode`\-=\other \catcode`\_=\other
3747 % ..., but we might end up with active ones in the argument if
3748 % we're called from @code, as @code{@value{foo-bar_}}, though.
3749 % So \let them to their normal equivalents.
3750 \let-\realdash \let_\normalunderscore
3754 % We have this subroutine so that we can handle at least some @value's
3755 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3756 % The command has to be fully expandable (if the variable is set), since
3757 % the result winds up in the index file. This means that if the
3758 % variable's value contains other Texinfo commands, it's almost certain
3759 % it will fail (although perhaps we could fix that with sufficient work
3760 % to do a one-level expansion on the result, instead of complete).
3762 \def\expandablevalue#1{%
3763 \expandafter\ifx\csname SET#1\endcsname\relax
3764 {[No value for ``#1'']}%
3765 \message{Variable `#1', used in @value, is not set.}%
3766 \else
3767 \csname SET#1\endcsname
3771 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3772 % with @set.
3774 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3776 \makecond{ifset}
3777 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3778 \def\doifset#1#2{%
3780 \makevalueexpandable
3781 \let\next=\empty
3782 \expandafter\ifx\csname SET#2\endcsname\relax
3783 #1% If not set, redefine \next.
3785 \expandafter
3786 }\next
3788 \def\ifsetfail{\doignore{ifset}}
3790 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3791 % defined with @set, or has been undefined with @clear.
3793 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3794 % above code: if the variable is not set, do nothing, if it is set,
3795 % then redefine \next to \ifclearfail.
3797 \makecond{ifclear}
3798 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3799 \def\ifclearfail{\doignore{ifclear}}
3801 % @dircategory CATEGORY -- specify a category of the dir file
3802 % which this file should belong to. Ignore this in TeX.
3803 \let\dircategory=\comment
3805 % @defininfoenclose.
3806 \let\definfoenclose=\comment
3809 \message{indexing,}
3810 % Index generation facilities
3812 % Define \newwrite to be identical to plain tex's \newwrite
3813 % except not \outer, so it can be used within macros and \if's.
3814 \edef\newwrite{\makecsname{ptexnewwrite}}
3816 % \newindex {foo} defines an index named foo.
3817 % It automatically defines \fooindex such that
3818 % \fooindex ...rest of line... puts an entry in the index foo.
3819 % It also defines \fooindfile to be the number of the output channel for
3820 % the file that accumulates this index. The file's extension is foo.
3821 % The name of an index should be no more than 2 characters long
3822 % for the sake of vms.
3824 \def\newindex#1{%
3825 \iflinks
3826 \expandafter\newwrite \csname#1indfile\endcsname
3827 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3829 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3830 \noexpand\doindex{#1}}
3833 % @defindex foo == \newindex{foo}
3835 \def\defindex{\parsearg\newindex}
3837 % Define @defcodeindex, like @defindex except put all entries in @code.
3839 \def\defcodeindex{\parsearg\newcodeindex}
3841 \def\newcodeindex#1{%
3842 \iflinks
3843 \expandafter\newwrite \csname#1indfile\endcsname
3844 \openout \csname#1indfile\endcsname \jobname.#1
3846 \expandafter\xdef\csname#1index\endcsname{%
3847 \noexpand\docodeindex{#1}}%
3851 % @synindex foo bar makes index foo feed into index bar.
3852 % Do this instead of @defindex foo if you don't want it as a separate index.
3854 % @syncodeindex foo bar similar, but put all entries made for index foo
3855 % inside @code.
3857 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3858 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3860 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3861 % #3 the target index (bar).
3862 \def\dosynindex#1#2#3{%
3863 % Only do \closeout if we haven't already done it, else we'll end up
3864 % closing the target index.
3865 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3866 % The \closeout helps reduce unnecessary open files; the limit on the
3867 % Acorn RISC OS is a mere 16 files.
3868 \expandafter\closeout\csname#2indfile\endcsname
3869 \expandafter\let\csname\donesynindex#2\endcsname = 1
3871 % redefine \fooindfile:
3872 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3873 \expandafter\let\csname#2indfile\endcsname=\temp
3874 % redefine \fooindex:
3875 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3878 % Define \doindex, the driver for all \fooindex macros.
3879 % Argument #1 is generated by the calling \fooindex macro,
3880 % and it is "foo", the name of the index.
3882 % \doindex just uses \parsearg; it calls \doind for the actual work.
3883 % This is because \doind is more useful to call from other macros.
3885 % There is also \dosubind {index}{topic}{subtopic}
3886 % which makes an entry in a two-level index such as the operation index.
3888 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3889 \def\singleindexer #1{\doind{\indexname}{#1}}
3891 % like the previous two, but they put @code around the argument.
3892 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3893 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3895 % Take care of Texinfo commands that can appear in an index entry.
3896 % Since there are some commands we want to expand, and others we don't,
3897 % we have to laboriously prevent expansion for those that we don't.
3899 \def\indexdummies{%
3900 \escapechar = `\\ % use backslash in output files.
3901 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3902 \def\ {\realbackslash\space }%
3904 % Need these in case \tex is in effect and \{ is a \delimiter again.
3905 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3906 % braces and backslashes are used only as delimiters.
3907 \let\{ = \mylbrace
3908 \let\} = \myrbrace
3910 % I don't entirely understand this, but when an index entry is
3911 % generated from a macro call, the \endinput which \scanmacro inserts
3912 % causes processing to be prematurely terminated. This is,
3913 % apparently, because \indexsorttmp is fully expanded, and \endinput
3914 % is an expandable command. The redefinition below makes \endinput
3915 % disappear altogether for that purpose -- although logging shows that
3916 % processing continues to some further point. On the other hand, it
3917 % seems \endinput does not hurt in the printed index arg, since that
3918 % is still getting written without apparent harm.
3920 % Sample source (mac-idx3.tex, reported by Graham Percival to
3921 % help-texinfo, 22may06):
3922 % @macro funindex {WORD}
3923 % @findex xyz
3924 % @end macro
3925 % ...
3926 % @funindex commtest
3928 % The above is not enough to reproduce the bug, but it gives the flavor.
3930 % Sample whatsit resulting:
3931 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
3933 % So:
3934 \let\endinput = \empty
3936 % Do the redefinitions.
3937 \commondummies
3940 % For the aux and toc files, @ is the escape character. So we want to
3941 % redefine everything using @ as the escape character (instead of
3942 % \realbackslash, still used for index files). When everything uses @,
3943 % this will be simpler.
3945 \def\atdummies{%
3946 \def\@{@@}%
3947 \def\ {@ }%
3948 \let\{ = \lbraceatcmd
3949 \let\} = \rbraceatcmd
3951 % Do the redefinitions.
3952 \commondummies
3953 \otherbackslash
3956 % Called from \indexdummies and \atdummies.
3958 \def\commondummies{%
3960 % \definedummyword defines \#1 as \string\#1\space, thus effectively
3961 % preventing its expansion. This is used only for control% words,
3962 % not control letters, because the \space would be incorrect for
3963 % control characters, but is needed to separate the control word
3964 % from whatever follows.
3966 % For control letters, we have \definedummyletter, which omits the
3967 % space.
3969 % These can be used both for control words that take an argument and
3970 % those that do not. If it is followed by {arg} in the input, then
3971 % that will dutifully get written to the index (or wherever).
3973 \def\definedummyword ##1{\def##1{\string##1\space}}%
3974 \def\definedummyletter##1{\def##1{\string##1}}%
3975 \let\definedummyaccent\definedummyletter
3977 \commondummiesnofonts
3979 \definedummyletter\_%
3981 % Non-English letters.
3982 \definedummyword\AA
3983 \definedummyword\AE
3984 \definedummyword\L
3985 \definedummyword\OE
3986 \definedummyword\O
3987 \definedummyword\aa
3988 \definedummyword\ae
3989 \definedummyword\l
3990 \definedummyword\oe
3991 \definedummyword\o
3992 \definedummyword\ss
3993 \definedummyword\exclamdown
3994 \definedummyword\questiondown
3995 \definedummyword\ordf
3996 \definedummyword\ordm
3998 % Although these internal commands shouldn't show up, sometimes they do.
3999 \definedummyword\bf
4000 \definedummyword\gtr
4001 \definedummyword\hat
4002 \definedummyword\less
4003 \definedummyword\sf
4004 \definedummyword\sl
4005 \definedummyword\tclose
4006 \definedummyword\tt
4008 \definedummyword\LaTeX
4009 \definedummyword\TeX
4011 % Assorted special characters.
4012 \definedummyword\bullet
4013 \definedummyword\comma
4014 \definedummyword\copyright
4015 \definedummyword\registeredsymbol
4016 \definedummyword\dots
4017 \definedummyword\enddots
4018 \definedummyword\equiv
4019 \definedummyword\error
4020 \definedummyword\euro
4021 \definedummyword\guillemetleft
4022 \definedummyword\guillemetright
4023 \definedummyword\guilsinglleft
4024 \definedummyword\guilsinglright
4025 \definedummyword\expansion
4026 \definedummyword\minus
4027 \definedummyword\pounds
4028 \definedummyword\point
4029 \definedummyword\print
4030 \definedummyword\quotedblbase
4031 \definedummyword\quotedblleft
4032 \definedummyword\quotedblright
4033 \definedummyword\quoteleft
4034 \definedummyword\quoteright
4035 \definedummyword\quotesinglbase
4036 \definedummyword\result
4037 \definedummyword\textdegree
4039 % We want to disable all macros so that they are not expanded by \write.
4040 \macrolist
4042 \normalturnoffactive
4044 % Handle some cases of @value -- where it does not contain any
4045 % (non-fully-expandable) commands.
4046 \makevalueexpandable
4049 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4051 \def\commondummiesnofonts{%
4052 % Control letters and accents.
4053 \definedummyletter\!%
4054 \definedummyaccent\"%
4055 \definedummyaccent\'%
4056 \definedummyletter\*%
4057 \definedummyaccent\,%
4058 \definedummyletter\.%
4059 \definedummyletter\/%
4060 \definedummyletter\:%
4061 \definedummyaccent\=%
4062 \definedummyletter\?%
4063 \definedummyaccent\^%
4064 \definedummyaccent\`%
4065 \definedummyaccent\~%
4066 \definedummyword\u
4067 \definedummyword\v
4068 \definedummyword\H
4069 \definedummyword\dotaccent
4070 \definedummyword\ringaccent
4071 \definedummyword\tieaccent
4072 \definedummyword\ubaraccent
4073 \definedummyword\udotaccent
4074 \definedummyword\dotless
4076 % Texinfo font commands.
4077 \definedummyword\b
4078 \definedummyword\i
4079 \definedummyword\r
4080 \definedummyword\sc
4081 \definedummyword\t
4083 % Commands that take arguments.
4084 \definedummyword\acronym
4085 \definedummyword\cite
4086 \definedummyword\code
4087 \definedummyword\command
4088 \definedummyword\dfn
4089 \definedummyword\emph
4090 \definedummyword\env
4091 \definedummyword\file
4092 \definedummyword\kbd
4093 \definedummyword\key
4094 \definedummyword\math
4095 \definedummyword\option
4096 \definedummyword\pxref
4097 \definedummyword\ref
4098 \definedummyword\samp
4099 \definedummyword\strong
4100 \definedummyword\tie
4101 \definedummyword\uref
4102 \definedummyword\url
4103 \definedummyword\var
4104 \definedummyword\verb
4105 \definedummyword\w
4106 \definedummyword\xref
4109 % \indexnofonts is used when outputting the strings to sort the index
4110 % by, and when constructing control sequence names. It eliminates all
4111 % control sequences and just writes whatever the best ASCII sort string
4112 % would be for a given command (usually its argument).
4114 \def\indexnofonts{%
4115 % Accent commands should become @asis.
4116 \def\definedummyaccent##1{\let##1\asis}%
4117 % We can just ignore other control letters.
4118 \def\definedummyletter##1{\let##1\empty}%
4119 % Hopefully, all control words can become @asis.
4120 \let\definedummyword\definedummyaccent
4122 \commondummiesnofonts
4124 % Don't no-op \tt, since it isn't a user-level command
4125 % and is used in the definitions of the active chars like <, >, |, etc.
4126 % Likewise with the other plain tex font commands.
4127 %\let\tt=\asis
4129 \def\ { }%
4130 \def\@{@}%
4131 % how to handle braces?
4132 \def\_{\normalunderscore}%
4134 % Non-English letters.
4135 \def\AA{AA}%
4136 \def\AE{AE}%
4137 \def\L{L}%
4138 \def\OE{OE}%
4139 \def\O{O}%
4140 \def\aa{aa}%
4141 \def\ae{ae}%
4142 \def\l{l}%
4143 \def\oe{oe}%
4144 \def\o{o}%
4145 \def\ss{ss}%
4146 \def\exclamdown{!}%
4147 \def\questiondown{?}%
4148 \def\ordf{a}%
4149 \def\ordm{o}%
4151 \def\LaTeX{LaTeX}%
4152 \def\TeX{TeX}%
4154 % Assorted special characters.
4155 % (The following {} will end up in the sort string, but that's ok.)
4156 \def\bullet{bullet}%
4157 \def\comma{,}%
4158 \def\copyright{copyright}%
4159 \def\registeredsymbol{R}%
4160 \def\dots{...}%
4161 \def\enddots{...}%
4162 \def\equiv{==}%
4163 \def\error{error}%
4164 \def\euro{euro}%
4165 \def\guillemetleft{<<}%
4166 \def\guillemetright{>>}%
4167 \def\guilsinglleft{<}%
4168 \def\guilsinglright{>}%
4169 \def\expansion{==>}%
4170 \def\minus{-}%
4171 \def\pounds{pounds}%
4172 \def\point{.}%
4173 \def\print{-|}%
4174 \def\quotedblbase{"}%
4175 \def\quotedblleft{"}%
4176 \def\quotedblright{"}%
4177 \def\quoteleft{`}%
4178 \def\quoteright{'}%
4179 \def\quotesinglbase{,}%
4180 \def\result{=>}%
4181 \def\textdegree{degrees}%
4183 % We need to get rid of all macros, leaving only the arguments (if present).
4184 % Of course this is not nearly correct, but it is the best we can do for now.
4185 % makeinfo does not expand macros in the argument to @deffn, which ends up
4186 % writing an index entry, and texindex isn't prepared for an index sort entry
4187 % that starts with \.
4189 % Since macro invocations are followed by braces, we can just redefine them
4190 % to take a single TeX argument. The case of a macro invocation that
4191 % goes to end-of-line is not handled.
4193 \macrolist
4196 \let\indexbackslash=0 %overridden during \printindex.
4197 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4199 % Most index entries go through here, but \dosubind is the general case.
4200 % #1 is the index name, #2 is the entry text.
4201 \def\doind#1#2{\dosubind{#1}{#2}{}}
4203 % Workhorse for all \fooindexes.
4204 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4205 % empty if called from \doind, as we usually are (the main exception
4206 % is with most defuns, which call us directly).
4208 \def\dosubind#1#2#3{%
4209 \iflinks
4211 % Store the main index entry text (including the third arg).
4212 \toks0 = {#2}%
4213 % If third arg is present, precede it with a space.
4214 \def\thirdarg{#3}%
4215 \ifx\thirdarg\empty \else
4216 \toks0 = \expandafter{\the\toks0 \space #3}%
4219 \edef\writeto{\csname#1indfile\endcsname}%
4221 \safewhatsit\dosubindwrite
4226 % Write the entry in \toks0 to the index file:
4228 \def\dosubindwrite{%
4229 % Put the index entry in the margin if desired.
4230 \ifx\SETmarginindex\relax\else
4231 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4234 % Remember, we are within a group.
4235 \indexdummies % Must do this here, since \bf, etc expand at this stage
4236 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4237 % so it will be output as is; and it will print as backslash.
4239 % Process the index entry with all font commands turned off, to
4240 % get the string to sort by.
4241 {\indexnofonts
4242 \edef\temp{\the\toks0}% need full expansion
4243 \xdef\indexsorttmp{\temp}%
4246 % Set up the complete index entry, with both the sort key and
4247 % the original text, including any font commands. We write
4248 % three arguments to \entry to the .?? file (four in the
4249 % subentry case), texindex reduces to two when writing the .??s
4250 % sorted result.
4251 \edef\temp{%
4252 \write\writeto{%
4253 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4255 \temp
4258 % Take care of unwanted page breaks/skips around a whatsit:
4260 % If a skip is the last thing on the list now, preserve it
4261 % by backing up by \lastskip, doing the \write, then inserting
4262 % the skip again. Otherwise, the whatsit generated by the
4263 % \write or \pdfdest will make \lastskip zero. The result is that
4264 % sequences like this:
4265 % @end defun
4266 % @tindex whatever
4267 % @defun ...
4268 % will have extra space inserted, because the \medbreak in the
4269 % start of the @defun won't see the skip inserted by the @end of
4270 % the previous defun.
4272 % But don't do any of this if we're not in vertical mode. We
4273 % don't want to do a \vskip and prematurely end a paragraph.
4275 % Avoid page breaks due to these extra skips, too.
4277 % But wait, there is a catch there:
4278 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4279 % sufficient for this purpose, as it ignores stretch and shrink parts
4280 % of the skip. The only way seems to be to check the textual
4281 % representation of the skip.
4283 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4284 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4286 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4288 \newskip\whatsitskip
4289 \newcount\whatsitpenalty
4291 % ..., ready, GO:
4293 \def\safewhatsit#1{%
4294 \ifhmode
4296 \else
4297 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4298 \whatsitskip = \lastskip
4299 \edef\lastskipmacro{\the\lastskip}%
4300 \whatsitpenalty = \lastpenalty
4302 % If \lastskip is nonzero, that means the last item was a
4303 % skip. And since a skip is discardable, that means this
4304 % -\whatsitskip glue we're inserting is preceded by a
4305 % non-discardable item, therefore it is not a potential
4306 % breakpoint, therefore no \nobreak needed.
4307 \ifx\lastskipmacro\zeroskipmacro
4308 \else
4309 \vskip-\whatsitskip
4314 \ifx\lastskipmacro\zeroskipmacro
4315 % If \lastskip was zero, perhaps the last item was a penalty, and
4316 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4317 % to re-insert the same penalty (values >10000 are used for various
4318 % signals); since we just inserted a non-discardable item, any
4319 % following glue (such as a \parskip) would be a breakpoint. For example:
4321 % @deffn deffn-whatever
4322 % @vindex index-whatever
4323 % Description.
4324 % would allow a break between the index-whatever whatsit
4325 % and the "Description." paragraph.
4326 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4327 \else
4328 % On the other hand, if we had a nonzero \lastskip,
4329 % this make-up glue would be preceded by a non-discardable item
4330 % (the whatsit from the \write), so we must insert a \nobreak.
4331 \nobreak\vskip\whatsitskip
4336 % The index entry written in the file actually looks like
4337 % \entry {sortstring}{page}{topic}
4338 % or
4339 % \entry {sortstring}{page}{topic}{subtopic}
4340 % The texindex program reads in these files and writes files
4341 % containing these kinds of lines:
4342 % \initial {c}
4343 % before the first topic whose initial is c
4344 % \entry {topic}{pagelist}
4345 % for a topic that is used without subtopics
4346 % \primary {topic}
4347 % for the beginning of a topic that is used with subtopics
4348 % \secondary {subtopic}{pagelist}
4349 % for each subtopic.
4351 % Define the user-accessible indexing commands
4352 % @findex, @vindex, @kindex, @cindex.
4354 \def\findex {\fnindex}
4355 \def\kindex {\kyindex}
4356 \def\cindex {\cpindex}
4357 \def\vindex {\vrindex}
4358 \def\tindex {\tpindex}
4359 \def\pindex {\pgindex}
4361 \def\cindexsub {\begingroup\obeylines\cindexsub}
4362 {\obeylines %
4363 \gdef\cindexsub "#1" #2^^M{\endgroup %
4364 \dosubind{cp}{#2}{#1}}}
4366 % Define the macros used in formatting output of the sorted index material.
4368 % @printindex causes a particular index (the ??s file) to get printed.
4369 % It does not print any chapter heading (usually an @unnumbered).
4371 \parseargdef\printindex{\begingroup
4372 \dobreak \chapheadingskip{10000}%
4374 \smallfonts \rm
4375 \tolerance = 9500
4376 \plainfrenchspacing
4377 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4379 % See if the index file exists and is nonempty.
4380 % Change catcode of @ here so that if the index file contains
4381 % \initial {@}
4382 % as its first line, TeX doesn't complain about mismatched braces
4383 % (because it thinks @} is a control sequence).
4384 \catcode`\@ = 11
4385 \openin 1 \jobname.#1s
4386 \ifeof 1
4387 % \enddoublecolumns gets confused if there is no text in the index,
4388 % and it loses the chapter title and the aux file entries for the
4389 % index. The easiest way to prevent this problem is to make sure
4390 % there is some text.
4391 \putwordIndexNonexistent
4392 \else
4394 % If the index file exists but is empty, then \openin leaves \ifeof
4395 % false. We have to make TeX try to read something from the file, so
4396 % it can discover if there is anything in it.
4397 \read 1 to \temp
4398 \ifeof 1
4399 \putwordIndexIsEmpty
4400 \else
4401 % Index files are almost Texinfo source, but we use \ as the escape
4402 % character. It would be better to use @, but that's too big a change
4403 % to make right now.
4404 \def\indexbackslash{\backslashcurfont}%
4405 \catcode`\\ = 0
4406 \escapechar = `\\
4407 \begindoublecolumns
4408 \input \jobname.#1s
4409 \enddoublecolumns
4412 \closein 1
4413 \endgroup}
4415 % These macros are used by the sorted index file itself.
4416 % Change them to control the appearance of the index.
4418 \def\initial#1{{%
4419 % Some minor font changes for the special characters.
4420 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4422 % Remove any glue we may have, we'll be inserting our own.
4423 \removelastskip
4425 % We like breaks before the index initials, so insert a bonus.
4426 \nobreak
4427 \vskip 0pt plus 3\baselineskip
4428 \penalty 0
4429 \vskip 0pt plus -3\baselineskip
4431 % Typeset the initial. Making this add up to a whole number of
4432 % baselineskips increases the chance of the dots lining up from column
4433 % to column. It still won't often be perfect, because of the stretch
4434 % we need before each entry, but it's better.
4436 % No shrink because it confuses \balancecolumns.
4437 \vskip 1.67\baselineskip plus .5\baselineskip
4438 \leftline{\secbf #1}%
4439 % Do our best not to break after the initial.
4440 \nobreak
4441 \vskip .33\baselineskip plus .1\baselineskip
4444 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4445 % then page number (#2) flushed to the right margin. It is used for index
4446 % and table of contents entries. The paragraph is indented by \leftskip.
4448 % A straightforward implementation would start like this:
4449 % \def\entry#1#2{...
4450 % But this freezes the catcodes in the argument, and can cause problems to
4451 % @code, which sets - active. This problem was fixed by a kludge---
4452 % ``-'' was active throughout whole index, but this isn't really right.
4454 % The right solution is to prevent \entry from swallowing the whole text.
4455 % --kasal, 21nov03
4456 \def\entry{%
4457 \begingroup
4459 % Start a new paragraph if necessary, so our assignments below can't
4460 % affect previous text.
4461 \par
4463 % Do not fill out the last line with white space.
4464 \parfillskip = 0in
4466 % No extra space above this paragraph.
4467 \parskip = 0in
4469 % Do not prefer a separate line ending with a hyphen to fewer lines.
4470 \finalhyphendemerits = 0
4472 % \hangindent is only relevant when the entry text and page number
4473 % don't both fit on one line. In that case, bob suggests starting the
4474 % dots pretty far over on the line. Unfortunately, a large
4475 % indentation looks wrong when the entry text itself is broken across
4476 % lines. So we use a small indentation and put up with long leaders.
4478 % \hangafter is reset to 1 (which is the value we want) at the start
4479 % of each paragraph, so we need not do anything with that.
4480 \hangindent = 2em
4482 % When the entry text needs to be broken, just fill out the first line
4483 % with blank space.
4484 \rightskip = 0pt plus1fil
4486 % A bit of stretch before each entry for the benefit of balancing
4487 % columns.
4488 \vskip 0pt plus1pt
4490 % Swallow the left brace of the text (first parameter):
4491 \afterassignment\doentry
4492 \let\temp =
4494 \def\doentry{%
4495 \bgroup % Instead of the swallowed brace.
4496 \noindent
4497 \aftergroup\finishentry
4498 % And now comes the text of the entry.
4500 \def\finishentry#1{%
4501 % #1 is the page number.
4503 % The following is kludged to not output a line of dots in the index if
4504 % there are no page numbers. The next person who breaks this will be
4505 % cursed by a Unix daemon.
4506 \setbox\boxA = \hbox{#1}%
4507 \ifdim\wd\boxA = 0pt
4509 \else
4511 % If we must, put the page number on a line of its own, and fill out
4512 % this line with blank space. (The \hfil is overwhelmed with the
4513 % fill leaders glue in \indexdotfill if the page number does fit.)
4514 \hfil\penalty50
4515 \null\nobreak\indexdotfill % Have leaders before the page number.
4517 % The `\ ' here is removed by the implicit \unskip that TeX does as
4518 % part of (the primitive) \par. Without it, a spurious underfull
4519 % \hbox ensues.
4520 \ifpdf
4521 \pdfgettoks#1.%
4522 \ \the\toksA
4523 \else
4524 \ #1%
4527 \par
4528 \endgroup
4531 % Like plain.tex's \dotfill, except uses up at least 1 em.
4532 \def\indexdotfill{\cleaders
4533 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4535 \def\primary #1{\line{#1\hfil}}
4537 \newskip\secondaryindent \secondaryindent=0.5cm
4538 \def\secondary#1#2{{%
4539 \parfillskip=0in
4540 \parskip=0in
4541 \hangindent=1in
4542 \hangafter=1
4543 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4544 \ifpdf
4545 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4546 \else
4549 \par
4552 % Define two-column mode, which we use to typeset indexes.
4553 % Adapted from the TeXbook, page 416, which is to say,
4554 % the manmac.tex format used to print the TeXbook itself.
4555 \catcode`\@=11
4557 \newbox\partialpage
4558 \newdimen\doublecolumnhsize
4560 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4561 % Grab any single-column material above us.
4562 \output = {%
4564 % Here is a possibility not foreseen in manmac: if we accumulate a
4565 % whole lot of material, we might end up calling this \output
4566 % routine twice in a row (see the doublecol-lose test, which is
4567 % essentially a couple of indexes with @setchapternewpage off). In
4568 % that case we just ship out what is in \partialpage with the normal
4569 % output routine. Generally, \partialpage will be empty when this
4570 % runs and this will be a no-op. See the indexspread.tex test case.
4571 \ifvoid\partialpage \else
4572 \onepageout{\pagecontents\partialpage}%
4575 \global\setbox\partialpage = \vbox{%
4576 % Unvbox the main output page.
4577 \unvbox\PAGE
4578 \kern-\topskip \kern\baselineskip
4581 \eject % run that output routine to set \partialpage
4583 % Use the double-column output routine for subsequent pages.
4584 \output = {\doublecolumnout}%
4586 % Change the page size parameters. We could do this once outside this
4587 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4588 % format, but then we repeat the same computation. Repeating a couple
4589 % of assignments once per index is clearly meaningless for the
4590 % execution time, so we may as well do it in one place.
4592 % First we halve the line length, less a little for the gutter between
4593 % the columns. We compute the gutter based on the line length, so it
4594 % changes automatically with the paper format. The magic constant
4595 % below is chosen so that the gutter has the same value (well, +-<1pt)
4596 % as it did when we hard-coded it.
4598 % We put the result in a separate register, \doublecolumhsize, so we
4599 % can restore it in \pagesofar, after \hsize itself has (potentially)
4600 % been clobbered.
4602 \doublecolumnhsize = \hsize
4603 \advance\doublecolumnhsize by -.04154\hsize
4604 \divide\doublecolumnhsize by 2
4605 \hsize = \doublecolumnhsize
4607 % Double the \vsize as well. (We don't need a separate register here,
4608 % since nobody clobbers \vsize.)
4609 \vsize = 2\vsize
4612 % The double-column output routine for all double-column pages except
4613 % the last.
4615 \def\doublecolumnout{%
4616 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4617 % Get the available space for the double columns -- the normal
4618 % (undoubled) page height minus any material left over from the
4619 % previous page.
4620 \dimen@ = \vsize
4621 \divide\dimen@ by 2
4622 \advance\dimen@ by -\ht\partialpage
4624 % box0 will be the left-hand column, box2 the right.
4625 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4626 \onepageout\pagesofar
4627 \unvbox255
4628 \penalty\outputpenalty
4631 % Re-output the contents of the output page -- any previous material,
4632 % followed by the two boxes we just split, in box0 and box2.
4633 \def\pagesofar{%
4634 \unvbox\partialpage
4636 \hsize = \doublecolumnhsize
4637 \wd0=\hsize \wd2=\hsize
4638 \hbox to\pagewidth{\box0\hfil\box2}%
4641 % All done with double columns.
4642 \def\enddoublecolumns{%
4643 % The following penalty ensures that the page builder is exercised
4644 % _before_ we change the output routine. This is necessary in the
4645 % following situation:
4647 % The last section of the index consists only of a single entry.
4648 % Before this section, \pagetotal is less than \pagegoal, so no
4649 % break occurs before the last section starts. However, the last
4650 % section, consisting of \initial and the single \entry, does not
4651 % fit on the page and has to be broken off. Without the following
4652 % penalty the page builder will not be exercised until \eject
4653 % below, and by that time we'll already have changed the output
4654 % routine to the \balancecolumns version, so the next-to-last
4655 % double-column page will be processed with \balancecolumns, which
4656 % is wrong: The two columns will go to the main vertical list, with
4657 % the broken-off section in the recent contributions. As soon as
4658 % the output routine finishes, TeX starts reconsidering the page
4659 % break. The two columns and the broken-off section both fit on the
4660 % page, because the two columns now take up only half of the page
4661 % goal. When TeX sees \eject from below which follows the final
4662 % section, it invokes the new output routine that we've set after
4663 % \balancecolumns below; \onepageout will try to fit the two columns
4664 % and the final section into the vbox of \pageheight (see
4665 % \pagebody), causing an overfull box.
4667 % Note that glue won't work here, because glue does not exercise the
4668 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4669 \penalty0
4671 \output = {%
4672 % Split the last of the double-column material. Leave it on the
4673 % current page, no automatic page break.
4674 \balancecolumns
4676 % If we end up splitting too much material for the current page,
4677 % though, there will be another page break right after this \output
4678 % invocation ends. Having called \balancecolumns once, we do not
4679 % want to call it again. Therefore, reset \output to its normal
4680 % definition right away. (We hope \balancecolumns will never be
4681 % called on to balance too much material, but if it is, this makes
4682 % the output somewhat more palatable.)
4683 \global\output = {\onepageout{\pagecontents\PAGE}}%
4685 \eject
4686 \endgroup % started in \begindoublecolumns
4688 % \pagegoal was set to the doubled \vsize above, since we restarted
4689 % the current page. We're now back to normal single-column
4690 % typesetting, so reset \pagegoal to the normal \vsize (after the
4691 % \endgroup where \vsize got restored).
4692 \pagegoal = \vsize
4695 % Called at the end of the double column material.
4696 \def\balancecolumns{%
4697 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4698 \dimen@ = \ht0
4699 \advance\dimen@ by \topskip
4700 \advance\dimen@ by-\baselineskip
4701 \divide\dimen@ by 2 % target to split to
4702 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4703 \splittopskip = \topskip
4704 % Loop until we get a decent breakpoint.
4706 \vbadness = 10000
4707 \loop
4708 \global\setbox3 = \copy0
4709 \global\setbox1 = \vsplit3 to \dimen@
4710 \ifdim\ht3>\dimen@
4711 \global\advance\dimen@ by 1pt
4712 \repeat
4714 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4715 \setbox0=\vbox to\dimen@{\unvbox1}%
4716 \setbox2=\vbox to\dimen@{\unvbox3}%
4718 \pagesofar
4720 \catcode`\@ = \other
4723 \message{sectioning,}
4724 % Chapters, sections, etc.
4726 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4727 % sections so that we can refer to them unambiguously in the pdf
4728 % outlines by their "section number". We avoid collisions with chapter
4729 % numbers by starting them at 10000. (If a document ever has 10000
4730 % chapters, we're in trouble anyway, I'm sure.)
4731 \newcount\unnumberedno \unnumberedno = 10000
4732 \newcount\chapno
4733 \newcount\secno \secno=0
4734 \newcount\subsecno \subsecno=0
4735 \newcount\subsubsecno \subsubsecno=0
4737 % This counter is funny since it counts through charcodes of letters A, B, ...
4738 \newcount\appendixno \appendixno = `\@
4740 % \def\appendixletter{\char\the\appendixno}
4741 % We do the following ugly conditional instead of the above simple
4742 % construct for the sake of pdftex, which needs the actual
4743 % letter in the expansion, not just typeset.
4745 \def\appendixletter{%
4746 \ifnum\appendixno=`A A%
4747 \else\ifnum\appendixno=`B B%
4748 \else\ifnum\appendixno=`C C%
4749 \else\ifnum\appendixno=`D D%
4750 \else\ifnum\appendixno=`E E%
4751 \else\ifnum\appendixno=`F F%
4752 \else\ifnum\appendixno=`G G%
4753 \else\ifnum\appendixno=`H H%
4754 \else\ifnum\appendixno=`I I%
4755 \else\ifnum\appendixno=`J J%
4756 \else\ifnum\appendixno=`K K%
4757 \else\ifnum\appendixno=`L L%
4758 \else\ifnum\appendixno=`M M%
4759 \else\ifnum\appendixno=`N N%
4760 \else\ifnum\appendixno=`O O%
4761 \else\ifnum\appendixno=`P P%
4762 \else\ifnum\appendixno=`Q Q%
4763 \else\ifnum\appendixno=`R R%
4764 \else\ifnum\appendixno=`S S%
4765 \else\ifnum\appendixno=`T T%
4766 \else\ifnum\appendixno=`U U%
4767 \else\ifnum\appendixno=`V V%
4768 \else\ifnum\appendixno=`W W%
4769 \else\ifnum\appendixno=`X X%
4770 \else\ifnum\appendixno=`Y Y%
4771 \else\ifnum\appendixno=`Z Z%
4772 % The \the is necessary, despite appearances, because \appendixletter is
4773 % expanded while writing the .toc file. \char\appendixno is not
4774 % expandable, thus it is written literally, thus all appendixes come out
4775 % with the same letter (or @) in the toc without it.
4776 \else\char\the\appendixno
4777 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4778 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4780 % Each @chapter defines these (using marks) as the number+name, number
4781 % and name of the chapter. Page headings and footings can use
4782 % these. @section does likewise.
4783 \def\thischapter{}
4784 \def\thischapternum{}
4785 \def\thischaptername{}
4786 \def\thissection{}
4787 \def\thissectionnum{}
4788 \def\thissectionname{}
4790 \newcount\absseclevel % used to calculate proper heading level
4791 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4793 % @raisesections: treat @section as chapter, @subsection as section, etc.
4794 \def\raisesections{\global\advance\secbase by -1}
4795 \let\up=\raisesections % original BFox name
4797 % @lowersections: treat @chapter as section, @section as subsection, etc.
4798 \def\lowersections{\global\advance\secbase by 1}
4799 \let\down=\lowersections % original BFox name
4801 % we only have subsub.
4802 \chardef\maxseclevel = 3
4804 % A numbered section within an unnumbered changes to unnumbered too.
4805 % To achive this, remember the "biggest" unnum. sec. we are currently in:
4806 \chardef\unmlevel = \maxseclevel
4808 % Trace whether the current chapter is an appendix or not:
4809 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4810 \def\chapheadtype{N}
4812 % Choose a heading macro
4813 % #1 is heading type
4814 % #2 is heading level
4815 % #3 is text for heading
4816 \def\genhead#1#2#3{%
4817 % Compute the abs. sec. level:
4818 \absseclevel=#2
4819 \advance\absseclevel by \secbase
4820 % Make sure \absseclevel doesn't fall outside the range:
4821 \ifnum \absseclevel < 0
4822 \absseclevel = 0
4823 \else
4824 \ifnum \absseclevel > 3
4825 \absseclevel = 3
4828 % The heading type:
4829 \def\headtype{#1}%
4830 \if \headtype U%
4831 \ifnum \absseclevel < \unmlevel
4832 \chardef\unmlevel = \absseclevel
4834 \else
4835 % Check for appendix sections:
4836 \ifnum \absseclevel = 0
4837 \edef\chapheadtype{\headtype}%
4838 \else
4839 \if \headtype A\if \chapheadtype N%
4840 \errmessage{@appendix... within a non-appendix chapter}%
4841 \fi\fi
4843 % Check for numbered within unnumbered:
4844 \ifnum \absseclevel > \unmlevel
4845 \def\headtype{U}%
4846 \else
4847 \chardef\unmlevel = 3
4850 % Now print the heading:
4851 \if \headtype U%
4852 \ifcase\absseclevel
4853 \unnumberedzzz{#3}%
4854 \or \unnumberedseczzz{#3}%
4855 \or \unnumberedsubseczzz{#3}%
4856 \or \unnumberedsubsubseczzz{#3}%
4858 \else
4859 \if \headtype A%
4860 \ifcase\absseclevel
4861 \appendixzzz{#3}%
4862 \or \appendixsectionzzz{#3}%
4863 \or \appendixsubseczzz{#3}%
4864 \or \appendixsubsubseczzz{#3}%
4866 \else
4867 \ifcase\absseclevel
4868 \chapterzzz{#3}%
4869 \or \seczzz{#3}%
4870 \or \numberedsubseczzz{#3}%
4871 \or \numberedsubsubseczzz{#3}%
4875 \suppressfirstparagraphindent
4878 % an interface:
4879 \def\numhead{\genhead N}
4880 \def\apphead{\genhead A}
4881 \def\unnmhead{\genhead U}
4883 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4884 % all lower-level sectioning counters to zero.
4886 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4887 % (e.g., figures), q.v. By default (before any chapter), that is empty.
4888 \let\chaplevelprefix = \empty
4890 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4891 \def\chapterzzz#1{%
4892 % section resetting is \global in case the chapter is in a group, such
4893 % as an @include file.
4894 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4895 \global\advance\chapno by 1
4897 % Used for \float.
4898 \gdef\chaplevelprefix{\the\chapno.}%
4899 \resetallfloatnos
4901 \message{\putwordChapter\space \the\chapno}%
4903 % Write the actual heading.
4904 \chapmacro{#1}{Ynumbered}{\the\chapno}%
4906 % So @section and the like are numbered underneath this chapter.
4907 \global\let\section = \numberedsec
4908 \global\let\subsection = \numberedsubsec
4909 \global\let\subsubsection = \numberedsubsubsec
4912 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4913 \def\appendixzzz#1{%
4914 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4915 \global\advance\appendixno by 1
4916 \gdef\chaplevelprefix{\appendixletter.}%
4917 \resetallfloatnos
4919 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4920 \message{\appendixnum}%
4922 \chapmacro{#1}{Yappendix}{\appendixletter}%
4924 \global\let\section = \appendixsec
4925 \global\let\subsection = \appendixsubsec
4926 \global\let\subsubsection = \appendixsubsubsec
4929 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4930 \def\unnumberedzzz#1{%
4931 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4932 \global\advance\unnumberedno by 1
4934 % Since an unnumbered has no number, no prefix for figures.
4935 \global\let\chaplevelprefix = \empty
4936 \resetallfloatnos
4938 % This used to be simply \message{#1}, but TeX fully expands the
4939 % argument to \message. Therefore, if #1 contained @-commands, TeX
4940 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4941 % expanded @cite (which turns out to cause errors because \cite is meant
4942 % to be executed, not expanded).
4944 % Anyway, we don't want the fully-expanded definition of @cite to appear
4945 % as a result of the \message, we just want `@cite' itself. We use
4946 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4947 % simply yielding the contents of <toks register>. (We also do this for
4948 % the toc entries.)
4949 \toks0 = {#1}%
4950 \message{(\the\toks0)}%
4952 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4954 \global\let\section = \unnumberedsec
4955 \global\let\subsection = \unnumberedsubsec
4956 \global\let\subsubsection = \unnumberedsubsubsec
4959 % @centerchap is like @unnumbered, but the heading is centered.
4960 \outer\parseargdef\centerchap{%
4961 % Well, we could do the following in a group, but that would break
4962 % an assumption that \chapmacro is called at the outermost level.
4963 % Thus we are safer this way: --kasal, 24feb04
4964 \let\centerparametersmaybe = \centerparameters
4965 \unnmhead0{#1}%
4966 \let\centerparametersmaybe = \relax
4969 % @top is like @unnumbered.
4970 \let\top\unnumbered
4972 % Sections.
4973 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4974 \def\seczzz#1{%
4975 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4976 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
4979 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4980 \def\appendixsectionzzz#1{%
4981 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4982 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
4984 \let\appendixsec\appendixsection
4986 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4987 \def\unnumberedseczzz#1{%
4988 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4989 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
4992 % Subsections.
4993 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
4994 \def\numberedsubseczzz#1{%
4995 \global\subsubsecno=0 \global\advance\subsecno by 1
4996 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
4999 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
5000 \def\appendixsubseczzz#1{%
5001 \global\subsubsecno=0 \global\advance\subsecno by 1
5002 \sectionheading{#1}{subsec}{Yappendix}%
5003 {\appendixletter.\the\secno.\the\subsecno}%
5006 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
5007 \def\unnumberedsubseczzz#1{%
5008 \global\subsubsecno=0 \global\advance\subsecno by 1
5009 \sectionheading{#1}{subsec}{Ynothing}%
5010 {\the\unnumberedno.\the\secno.\the\subsecno}%
5013 % Subsubsections.
5014 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
5015 \def\numberedsubsubseczzz#1{%
5016 \global\advance\subsubsecno by 1
5017 \sectionheading{#1}{subsubsec}{Ynumbered}%
5018 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5021 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
5022 \def\appendixsubsubseczzz#1{%
5023 \global\advance\subsubsecno by 1
5024 \sectionheading{#1}{subsubsec}{Yappendix}%
5025 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5028 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
5029 \def\unnumberedsubsubseczzz#1{%
5030 \global\advance\subsubsecno by 1
5031 \sectionheading{#1}{subsubsec}{Ynothing}%
5032 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5035 % These macros control what the section commands do, according
5036 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5037 % Define them by default for a numbered chapter.
5038 \let\section = \numberedsec
5039 \let\subsection = \numberedsubsec
5040 \let\subsubsection = \numberedsubsubsec
5042 % Define @majorheading, @heading and @subheading
5044 % NOTE on use of \vbox for chapter headings, section headings, and such:
5045 % 1) We use \vbox rather than the earlier \line to permit
5046 % overlong headings to fold.
5047 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5048 % heading is obnoxious; this forbids it.
5049 % 3) Likewise, headings look best if no \parindent is used, and
5050 % if justification is not attempted. Hence \raggedright.
5053 \def\majorheading{%
5054 {\advance\chapheadingskip by 10pt \chapbreak }%
5055 \parsearg\chapheadingzzz
5058 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5059 \def\chapheadingzzz#1{%
5060 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5061 \parindent=0pt\raggedright
5062 \rm #1\hfill}}%
5063 \bigskip \par\penalty 200\relax
5064 \suppressfirstparagraphindent
5067 % @heading, @subheading, @subsubheading.
5068 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5069 \suppressfirstparagraphindent}
5070 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5071 \suppressfirstparagraphindent}
5072 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5073 \suppressfirstparagraphindent}
5075 % These macros generate a chapter, section, etc. heading only
5076 % (including whitespace, linebreaking, etc. around it),
5077 % given all the information in convenient, parsed form.
5079 %%% Args are the skip and penalty (usually negative)
5080 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5082 %%% Define plain chapter starts, and page on/off switching for it
5083 % Parameter controlling skip before chapter headings (if needed)
5085 \newskip\chapheadingskip
5087 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5088 \def\chappager{\par\vfill\supereject}
5089 % Because \domark is called before \chapoddpage, the filler page will
5090 % get the headings for the next chapter, which is wrong. But we don't
5091 % care -- we just disable all headings on the filler page.
5092 \def\chapoddpage{%
5093 \chappager
5094 \ifodd\pageno \else
5095 \begingroup
5096 \evenheadline={\hfil}\evenfootline={\hfil}%
5097 \oddheadline={\hfil}\oddfootline={\hfil}%
5098 \hbox to 0pt{}%
5099 \chappager
5100 \endgroup
5104 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5106 \def\CHAPPAGoff{%
5107 \global\let\contentsalignmacro = \chappager
5108 \global\let\pchapsepmacro=\chapbreak
5109 \global\let\pagealignmacro=\chappager}
5111 \def\CHAPPAGon{%
5112 \global\let\contentsalignmacro = \chappager
5113 \global\let\pchapsepmacro=\chappager
5114 \global\let\pagealignmacro=\chappager
5115 \global\def\HEADINGSon{\HEADINGSsingle}}
5117 \def\CHAPPAGodd{%
5118 \global\let\contentsalignmacro = \chapoddpage
5119 \global\let\pchapsepmacro=\chapoddpage
5120 \global\let\pagealignmacro=\chapoddpage
5121 \global\def\HEADINGSon{\HEADINGSdouble}}
5123 \CHAPPAGon
5125 % Chapter opening.
5127 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5128 % Yappendix, Yomitfromtoc), #3 the chapter number.
5130 % To test against our argument.
5131 \def\Ynothingkeyword{Ynothing}
5132 \def\Yomitfromtockeyword{Yomitfromtoc}
5133 \def\Yappendixkeyword{Yappendix}
5135 \def\chapmacro#1#2#3{%
5136 % Insert the first mark before the heading break (see notes for \domark).
5137 \let\prevchapterdefs=\lastchapterdefs
5138 \let\prevsectiondefs=\lastsectiondefs
5139 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5140 \gdef\thissection{}}%
5142 \def\temptype{#2}%
5143 \ifx\temptype\Ynothingkeyword
5144 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5145 \gdef\thischapter{\thischaptername}}%
5146 \else\ifx\temptype\Yomitfromtockeyword
5147 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5148 \gdef\thischapter{}}%
5149 \else\ifx\temptype\Yappendixkeyword
5150 \toks0={#1}%
5151 \xdef\lastchapterdefs{%
5152 \gdef\noexpand\thischaptername{\the\toks0}%
5153 \gdef\noexpand\thischapternum{\appendixletter}%
5154 \gdef\noexpand\thischapter{\putwordAppendix{} \noexpand\thischapternum:
5155 \noexpand\thischaptername}%
5157 \else
5158 \toks0={#1}%
5159 \xdef\lastchapterdefs{%
5160 \gdef\noexpand\thischaptername{\the\toks0}%
5161 \gdef\noexpand\thischapternum{\the\chapno}%
5162 \gdef\noexpand\thischapter{\putwordChapter{} \noexpand\thischapternum:
5163 \noexpand\thischaptername}%
5165 \fi\fi\fi
5167 % Output the mark. Pass it through \safewhatsit, to take care of
5168 % the preceding space.
5169 \safewhatsit\domark
5171 % Insert the chapter heading break.
5172 \pchapsepmacro
5174 % Now the second mark, after the heading break. No break points
5175 % between here and the heading.
5176 \let\prevchapterdefs=\lastchapterdefs
5177 \let\prevsectiondefs=\lastsectiondefs
5178 \domark
5181 \chapfonts \rm
5183 % Have to define \lastsection before calling \donoderef, because the
5184 % xref code eventually uses it. On the other hand, it has to be called
5185 % after \pchapsepmacro, or the headline will change too soon.
5186 \gdef\lastsection{#1}%
5188 % Only insert the separating space if we have a chapter/appendix
5189 % number, and don't print the unnumbered ``number''.
5190 \ifx\temptype\Ynothingkeyword
5191 \setbox0 = \hbox{}%
5192 \def\toctype{unnchap}%
5193 \else\ifx\temptype\Yomitfromtockeyword
5194 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5195 \def\toctype{omit}%
5196 \else\ifx\temptype\Yappendixkeyword
5197 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5198 \def\toctype{app}%
5199 \else
5200 \setbox0 = \hbox{#3\enspace}%
5201 \def\toctype{numchap}%
5202 \fi\fi\fi
5204 % Write the toc entry for this chapter. Must come before the
5205 % \donoderef, because we include the current node name in the toc
5206 % entry, and \donoderef resets it to empty.
5207 \writetocentry{\toctype}{#1}{#3}%
5209 % For pdftex, we have to write out the node definition (aka, make
5210 % the pdfdest) after any page break, but before the actual text has
5211 % been typeset. If the destination for the pdf outline is after the
5212 % text, then jumping from the outline may wind up with the text not
5213 % being visible, for instance under high magnification.
5214 \donoderef{#2}%
5216 % Typeset the actual heading.
5217 \nobreak % Avoid page breaks at the interline glue.
5218 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
5219 \hangindent=\wd0 \centerparametersmaybe
5220 \unhbox0 #1\par}%
5222 \nobreak\bigskip % no page break after a chapter title
5223 \nobreak
5226 % @centerchap -- centered and unnumbered.
5227 \let\centerparametersmaybe = \relax
5228 \def\centerparameters{%
5229 \advance\rightskip by 3\rightskip
5230 \leftskip = \rightskip
5231 \parfillskip = 0pt
5235 % I don't think this chapter style is supported any more, so I'm not
5236 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5238 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5240 \def\unnchfopen #1{%
5241 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5242 \parindent=0pt\raggedright
5243 \rm #1\hfill}}\bigskip \par\nobreak
5245 \def\chfopen #1#2{\chapoddpage {\chapfonts
5246 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5247 \par\penalty 5000 %
5249 \def\centerchfopen #1{%
5250 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5251 \parindent=0pt
5252 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
5254 \def\CHAPFopen{%
5255 \global\let\chapmacro=\chfopen
5256 \global\let\centerchapmacro=\centerchfopen}
5259 % Section titles. These macros combine the section number parts and
5260 % call the generic \sectionheading to do the printing.
5262 \newskip\secheadingskip
5263 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5265 % Subsection titles.
5266 \newskip\subsecheadingskip
5267 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5269 % Subsubsection titles.
5270 \def\subsubsecheadingskip{\subsecheadingskip}
5271 \def\subsubsecheadingbreak{\subsecheadingbreak}
5274 % Print any size, any type, section title.
5276 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5277 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5278 % section number.
5280 \def\seckeyword{sec}
5282 \def\sectionheading#1#2#3#4{%
5284 % Switch to the right set of fonts.
5285 \csname #2fonts\endcsname \rm
5287 \def\sectionlevel{#2}%
5288 \def\temptype{#3}%
5290 % Insert first mark before the heading break (see notes for \domark).
5291 \let\prevsectiondefs=\lastsectiondefs
5292 \ifx\temptype\Ynothingkeyword
5293 \ifx\sectionlevel\seckeyword
5294 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5295 \gdef\thissection{\thissectionname}}%
5297 \else\ifx\temptype\Yomitfromtockeyword
5298 % Don't redefine \thissection.
5299 \else\ifx\temptype\Yappendixkeyword
5300 \ifx\sectionlevel\seckeyword
5301 \toks0={#1}%
5302 \xdef\lastsectiondefs{%
5303 \gdef\noexpand\thissectionname{\the\toks0}%
5304 \gdef\noexpand\thissectionnum{#4}%
5305 \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5306 \noexpand\thissectionname}%
5309 \else
5310 \ifx\sectionlevel\seckeyword
5311 \toks0={#1}%
5312 \xdef\lastsectiondefs{%
5313 \gdef\noexpand\thissectionname{\the\toks0}%
5314 \gdef\noexpand\thissectionnum{#4}%
5315 \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5316 \noexpand\thissectionname}%
5319 \fi\fi\fi
5321 % Output the mark. Pass it through \safewhatsit, to take care of
5322 % the preceding space.
5323 \safewhatsit\domark
5325 % Insert space above the heading.
5326 \csname #2headingbreak\endcsname
5328 % Now the second mark, after the heading break. No break points
5329 % between here and the heading.
5330 \let\prevsectiondefs=\lastsectiondefs
5331 \domark
5333 % Only insert the space after the number if we have a section number.
5334 \ifx\temptype\Ynothingkeyword
5335 \setbox0 = \hbox{}%
5336 \def\toctype{unn}%
5337 \gdef\lastsection{#1}%
5338 \else\ifx\temptype\Yomitfromtockeyword
5339 % for @headings -- no section number, don't include in toc,
5340 % and don't redefine \lastsection.
5341 \setbox0 = \hbox{}%
5342 \def\toctype{omit}%
5343 \let\sectionlevel=\empty
5344 \else\ifx\temptype\Yappendixkeyword
5345 \setbox0 = \hbox{#4\enspace}%
5346 \def\toctype{app}%
5347 \gdef\lastsection{#1}%
5348 \else
5349 \setbox0 = \hbox{#4\enspace}%
5350 \def\toctype{num}%
5351 \gdef\lastsection{#1}%
5352 \fi\fi\fi
5354 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5355 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5357 % Write the node reference (= pdf destination for pdftex).
5358 % Again, see comments in \chapmacro.
5359 \donoderef{#3}%
5361 % Interline glue will be inserted when the vbox is completed.
5362 % That glue will be a valid breakpoint for the page, since it'll be
5363 % preceded by a whatsit (usually from the \donoderef, or from the
5364 % \writetocentry if there was no node). We don't want to allow that
5365 % break, since then the whatsits could end up on page n while the
5366 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5367 \nobreak
5369 % Output the actual section heading.
5370 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
5371 \hangindent=\wd0 % zero if no section number
5372 \unhbox0 #1}%
5374 % Add extra space after the heading -- half of whatever came above it.
5375 % Don't allow stretch, though.
5376 \kern .5 \csname #2headingskip\endcsname
5378 % Do not let the kern be a potential breakpoint, as it would be if it
5379 % was followed by glue.
5380 \nobreak
5382 % We'll almost certainly start a paragraph next, so don't let that
5383 % glue accumulate. (Not a breakpoint because it's preceded by a
5384 % discardable item.)
5385 \vskip-\parskip
5387 % This is purely so the last item on the list is a known \penalty >
5388 % 10000. This is so \startdefun can avoid allowing breakpoints after
5389 % section headings. Otherwise, it would insert a valid breakpoint between:
5391 % @section sec-whatever
5392 % @deffn def-whatever
5393 \penalty 10001
5397 \message{toc,}
5398 % Table of contents.
5399 \newwrite\tocfile
5401 % Write an entry to the toc file, opening it if necessary.
5402 % Called from @chapter, etc.
5404 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5405 % We append the current node name (if any) and page number as additional
5406 % arguments for the \{chap,sec,...}entry macros which will eventually
5407 % read this. The node name is used in the pdf outlines as the
5408 % destination to jump to.
5410 % We open the .toc file for writing here instead of at @setfilename (or
5411 % any other fixed time) so that @contents can be anywhere in the document.
5412 % But if #1 is `omit', then we don't do anything. This is used for the
5413 % table of contents chapter openings themselves.
5415 \newif\iftocfileopened
5416 \def\omitkeyword{omit}%
5418 \def\writetocentry#1#2#3{%
5419 \edef\writetoctype{#1}%
5420 \ifx\writetoctype\omitkeyword \else
5421 \iftocfileopened\else
5422 \immediate\openout\tocfile = \jobname.toc
5423 \global\tocfileopenedtrue
5426 \iflinks
5427 {\atdummies
5428 \edef\temp{%
5429 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5430 \temp
5435 % Tell \shipout to create a pdf destination on each page, if we're
5436 % writing pdf. These are used in the table of contents. We can't
5437 % just write one on every page because the title pages are numbered
5438 % 1 and 2 (the page numbers aren't printed), and so are the first
5439 % two pages of the document. Thus, we'd have two destinations named
5440 % `1', and two named `2'.
5441 \ifpdf \global\pdfmakepagedesttrue \fi
5445 % These characters do not print properly in the Computer Modern roman
5446 % fonts, so we must take special care. This is more or less redundant
5447 % with the Texinfo input format setup at the end of this file.
5449 \def\activecatcodes{%
5450 \catcode`\"=\active
5451 \catcode`\$=\active
5452 \catcode`\<=\active
5453 \catcode`\>=\active
5454 \catcode`\\=\active
5455 \catcode`\^=\active
5456 \catcode`\_=\active
5457 \catcode`\|=\active
5458 \catcode`\~=\active
5462 % Read the toc file, which is essentially Texinfo input.
5463 \def\readtocfile{%
5464 \setupdatafile
5465 \activecatcodes
5466 \input \tocreadfilename
5469 \newskip\contentsrightmargin \contentsrightmargin=1in
5470 \newcount\savepageno
5471 \newcount\lastnegativepageno \lastnegativepageno = -1
5473 % Prepare to read what we've written to \tocfile.
5475 \def\startcontents#1{%
5476 % If @setchapternewpage on, and @headings double, the contents should
5477 % start on an odd page, unlike chapters. Thus, we maintain
5478 % \contentsalignmacro in parallel with \pagealignmacro.
5479 % From: Torbjorn Granlund <tege@matematik.su.se>
5480 \contentsalignmacro
5481 \immediate\closeout\tocfile
5483 % Don't need to put `Contents' or `Short Contents' in the headline.
5484 % It is abundantly clear what they are.
5485 \chapmacro{#1}{Yomitfromtoc}{}%
5487 \savepageno = \pageno
5488 \begingroup % Set up to handle contents files properly.
5489 \raggedbottom % Worry more about breakpoints than the bottom.
5490 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5492 % Roman numerals for page numbers.
5493 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5496 % redefined for the two-volume lispref. We always output on
5497 % \jobname.toc even if this is redefined.
5499 \def\tocreadfilename{\jobname.toc}
5501 % Normal (long) toc.
5503 \def\contents{%
5504 \startcontents{\putwordTOC}%
5505 \openin 1 \tocreadfilename\space
5506 \ifeof 1 \else
5507 \readtocfile
5509 \vfill \eject
5510 \contentsalignmacro % in case @setchapternewpage odd is in effect
5511 \ifeof 1 \else
5512 \pdfmakeoutlines
5514 \closein 1
5515 \endgroup
5516 \lastnegativepageno = \pageno
5517 \global\pageno = \savepageno
5520 % And just the chapters.
5521 \def\summarycontents{%
5522 \startcontents{\putwordShortTOC}%
5524 \let\numchapentry = \shortchapentry
5525 \let\appentry = \shortchapentry
5526 \let\unnchapentry = \shortunnchapentry
5527 % We want a true roman here for the page numbers.
5528 \secfonts
5529 \let\rm=\shortcontrm \let\bf=\shortcontbf
5530 \let\sl=\shortcontsl \let\tt=\shortconttt
5532 \hyphenpenalty = 10000
5533 \advance\baselineskip by 1pt % Open it up a little.
5534 \def\numsecentry##1##2##3##4{}
5535 \let\appsecentry = \numsecentry
5536 \let\unnsecentry = \numsecentry
5537 \let\numsubsecentry = \numsecentry
5538 \let\appsubsecentry = \numsecentry
5539 \let\unnsubsecentry = \numsecentry
5540 \let\numsubsubsecentry = \numsecentry
5541 \let\appsubsubsecentry = \numsecentry
5542 \let\unnsubsubsecentry = \numsecentry
5543 \openin 1 \tocreadfilename\space
5544 \ifeof 1 \else
5545 \readtocfile
5547 \closein 1
5548 \vfill \eject
5549 \contentsalignmacro % in case @setchapternewpage odd is in effect
5550 \endgroup
5551 \lastnegativepageno = \pageno
5552 \global\pageno = \savepageno
5554 \let\shortcontents = \summarycontents
5556 % Typeset the label for a chapter or appendix for the short contents.
5557 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
5559 \def\shortchaplabel#1{%
5560 % This space should be enough, since a single number is .5em, and the
5561 % widest letter (M) is 1em, at least in the Computer Modern fonts.
5562 % But use \hss just in case.
5563 % (This space doesn't include the extra space that gets added after
5564 % the label; that gets put in by \shortchapentry above.)
5566 % We'd like to right-justify chapter numbers, but that looks strange
5567 % with appendix letters. And right-justifying numbers and
5568 % left-justifying letters looks strange when there is less than 10
5569 % chapters. Have to read the whole toc once to know how many chapters
5570 % there are before deciding ...
5571 \hbox to 1em{#1\hss}%
5574 % These macros generate individual entries in the table of contents.
5575 % The first argument is the chapter or section name.
5576 % The last argument is the page number.
5577 % The arguments in between are the chapter number, section number, ...
5579 % Chapters, in the main contents.
5580 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5582 % Chapters, in the short toc.
5583 % See comments in \dochapentry re vbox and related settings.
5584 \def\shortchapentry#1#2#3#4{%
5585 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5588 % Appendices, in the main contents.
5589 % Need the word Appendix, and a fixed-size box.
5591 \def\appendixbox#1{%
5592 % We use M since it's probably the widest letter.
5593 \setbox0 = \hbox{\putwordAppendix{} M}%
5594 \hbox to \wd0{\putwordAppendix{} #1\hss}}
5596 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5598 % Unnumbered chapters.
5599 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5600 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5602 % Sections.
5603 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5604 \let\appsecentry=\numsecentry
5605 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5607 % Subsections.
5608 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5609 \let\appsubsecentry=\numsubsecentry
5610 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5612 % And subsubsections.
5613 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5614 \let\appsubsubsecentry=\numsubsubsecentry
5615 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5617 % This parameter controls the indentation of the various levels.
5618 % Same as \defaultparindent.
5619 \newdimen\tocindent \tocindent = 15pt
5621 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5622 % page number.
5624 % If the toc has to be broken over pages, we want it to be at chapters
5625 % if at all possible; hence the \penalty.
5626 \def\dochapentry#1#2{%
5627 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5628 \begingroup
5629 \chapentryfonts
5630 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5631 \endgroup
5632 \nobreak\vskip .25\baselineskip plus.1\baselineskip
5635 \def\dosecentry#1#2{\begingroup
5636 \secentryfonts \leftskip=\tocindent
5637 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5638 \endgroup}
5640 \def\dosubsecentry#1#2{\begingroup
5641 \subsecentryfonts \leftskip=2\tocindent
5642 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5643 \endgroup}
5645 \def\dosubsubsecentry#1#2{\begingroup
5646 \subsubsecentryfonts \leftskip=3\tocindent
5647 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5648 \endgroup}
5650 % We use the same \entry macro as for the index entries.
5651 \let\tocentry = \entry
5653 % Space between chapter (or whatever) number and the title.
5654 \def\labelspace{\hskip1em \relax}
5656 \def\dopageno#1{{\rm #1}}
5657 \def\doshortpageno#1{{\rm #1}}
5659 \def\chapentryfonts{\secfonts \rm}
5660 \def\secentryfonts{\textfonts}
5661 \def\subsecentryfonts{\textfonts}
5662 \def\subsubsecentryfonts{\textfonts}
5665 \message{environments,}
5666 % @foo ... @end foo.
5668 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
5670 % Since these characters are used in examples, they should be an even number of
5671 % \tt widths. Each \tt character is 1en, so two makes it 1em.
5673 \def\point{$\star$}
5674 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
5675 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
5676 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
5677 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
5678 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
5680 % The @error{} command.
5681 % Adapted from the TeXbook's \boxit.
5683 \newbox\errorbox
5685 {\tentt \global\dimen0 = 3em}% Width of the box.
5686 \dimen2 = .55pt % Thickness of rules
5687 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
5688 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
5690 \setbox\errorbox=\hbox to \dimen0{\hfil
5691 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
5692 \advance\hsize by -2\dimen2 % Rules.
5693 \vbox{%
5694 \hrule height\dimen2
5695 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
5696 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
5697 \kern3pt\vrule width\dimen2}% Space to right.
5698 \hrule height\dimen2}
5699 \hfil}
5701 \def\error{\leavevmode\lower.7ex\copy\errorbox}
5703 % @tex ... @end tex escapes into raw Tex temporarily.
5704 % One exception: @ is still an escape character, so that @end tex works.
5705 % But \@ or @@ will get a plain tex @ character.
5707 \envdef\tex{%
5708 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5709 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5710 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5711 \catcode `\%=14
5712 \catcode `\+=\other
5713 \catcode `\"=\other
5714 \catcode `\|=\other
5715 \catcode `\<=\other
5716 \catcode `\>=\other
5717 \escapechar=`\\
5719 \let\b=\ptexb
5720 \let\bullet=\ptexbullet
5721 \let\c=\ptexc
5722 \let\,=\ptexcomma
5723 \let\.=\ptexdot
5724 \let\dots=\ptexdots
5725 \let\equiv=\ptexequiv
5726 \let\!=\ptexexclam
5727 \let\i=\ptexi
5728 \let\indent=\ptexindent
5729 \let\noindent=\ptexnoindent
5730 \let\{=\ptexlbrace
5731 \let\+=\tabalign
5732 \let\}=\ptexrbrace
5733 \let\/=\ptexslash
5734 \let\*=\ptexstar
5735 \let\t=\ptext
5736 \expandafter \let\csname top\endcsname=\ptextop % outer
5737 \let\frenchspacing=\plainfrenchspacing
5739 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5740 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5741 \def\@{@}%
5743 % There is no need to define \Etex.
5745 % Define @lisp ... @end lisp.
5746 % @lisp environment forms a group so it can rebind things,
5747 % including the definition of @end lisp (which normally is erroneous).
5749 % Amount to narrow the margins by for @lisp.
5750 \newskip\lispnarrowing \lispnarrowing=0.4in
5752 % This is the definition that ^^M gets inside @lisp, @example, and other
5753 % such environments. \null is better than a space, since it doesn't
5754 % have any width.
5755 \def\lisppar{\null\endgraf}
5757 % This space is always present above and below environments.
5758 \newskip\envskipamount \envskipamount = 0pt
5760 % Make spacing and below environment symmetrical. We use \parskip here
5761 % to help in doing that, since in @example-like environments \parskip
5762 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
5763 % start of the next paragraph will insert \parskip.
5765 \def\aboveenvbreak{{%
5766 % =10000 instead of <10000 because of a special case in \itemzzz and
5767 % \sectionheading, q.v.
5768 \ifnum \lastpenalty=10000 \else
5769 \advance\envskipamount by \parskip
5770 \endgraf
5771 \ifdim\lastskip<\envskipamount
5772 \removelastskip
5773 % it's not a good place to break if the last penalty was \nobreak
5774 % or better ...
5775 \ifnum\lastpenalty<10000 \penalty-50 \fi
5776 \vskip\envskipamount
5781 \let\afterenvbreak = \aboveenvbreak
5783 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
5784 % also clear it, so that its embedded environments do the narrowing again.
5785 \let\nonarrowing=\relax
5787 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
5788 % environment contents.
5789 \font\circle=lcircle10
5790 \newdimen\circthick
5791 \newdimen\cartouter\newdimen\cartinner
5792 \newskip\normbskip\newskip\normpskip\newskip\normlskip
5793 \circthick=\fontdimen8\circle
5795 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
5796 \def\ctr{{\hskip 6pt\circle\char'010}}
5797 \def\cbl{{\circle\char'012\hskip -6pt}}
5798 \def\cbr{{\hskip 6pt\circle\char'011}}
5799 \def\carttop{\hbox to \cartouter{\hskip\lskip
5800 \ctl\leaders\hrule height\circthick\hfil\ctr
5801 \hskip\rskip}}
5802 \def\cartbot{\hbox to \cartouter{\hskip\lskip
5803 \cbl\leaders\hrule height\circthick\hfil\cbr
5804 \hskip\rskip}}
5806 \newskip\lskip\newskip\rskip
5808 \envdef\cartouche{%
5809 \ifhmode\par\fi % can't be in the midst of a paragraph.
5810 \startsavinginserts
5811 \lskip=\leftskip \rskip=\rightskip
5812 \leftskip=0pt\rightskip=0pt % we want these *outside*.
5813 \cartinner=\hsize \advance\cartinner by-\lskip
5814 \advance\cartinner by-\rskip
5815 \cartouter=\hsize
5816 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
5817 % side, and for 6pt waste from
5818 % each corner char, and rule thickness
5819 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
5820 % Flag to tell @lisp, etc., not to narrow margin.
5821 \let\nonarrowing = t%
5822 \vbox\bgroup
5823 \baselineskip=0pt\parskip=0pt\lineskip=0pt
5824 \carttop
5825 \hbox\bgroup
5826 \hskip\lskip
5827 \vrule\kern3pt
5828 \vbox\bgroup
5829 \kern3pt
5830 \hsize=\cartinner
5831 \baselineskip=\normbskip
5832 \lineskip=\normlskip
5833 \parskip=\normpskip
5834 \vskip -\parskip
5835 \comment % For explanation, see the end of \def\group.
5837 \def\Ecartouche{%
5838 \ifhmode\par\fi
5839 \kern3pt
5840 \egroup
5841 \kern3pt\vrule
5842 \hskip\rskip
5843 \egroup
5844 \cartbot
5845 \egroup
5846 \checkinserts
5850 % This macro is called at the beginning of all the @example variants,
5851 % inside a group.
5852 \def\nonfillstart{%
5853 \aboveenvbreak
5854 \hfuzz = 12pt % Don't be fussy
5855 \sepspaces % Make spaces be word-separators rather than space tokens.
5856 \let\par = \lisppar % don't ignore blank lines
5857 \obeylines % each line of input is a line of output
5858 \parskip = 0pt
5859 \parindent = 0pt
5860 \emergencystretch = 0pt % don't try to avoid overfull boxes
5861 \ifx\nonarrowing\relax
5862 \advance \leftskip by \lispnarrowing
5863 \exdentamount=\lispnarrowing
5864 \else
5865 \let\nonarrowing = \relax
5867 \let\exdent=\nofillexdent
5870 % If you want all examples etc. small: @set dispenvsize small.
5871 % If you want even small examples the full size: @set dispenvsize nosmall.
5872 % This affects the following displayed environments:
5873 % @example, @display, @format, @lisp
5875 \def\smallword{small}
5876 \def\nosmallword{nosmall}
5877 \let\SETdispenvsize\relax
5878 \def\setnormaldispenv{%
5879 \ifx\SETdispenvsize\smallword
5880 % end paragraph for sake of leading, in case document has no blank
5881 % line. This is redundant with what happens in \aboveenvbreak, but
5882 % we need to do it before changing the fonts, and it's inconvenient
5883 % to change the fonts afterward.
5884 \ifnum \lastpenalty=10000 \else \endgraf \fi
5885 \smallexamplefonts \rm
5888 \def\setsmalldispenv{%
5889 \ifx\SETdispenvsize\nosmallword
5890 \else
5891 \ifnum \lastpenalty=10000 \else \endgraf \fi
5892 \smallexamplefonts \rm
5896 % We often define two environments, @foo and @smallfoo.
5897 % Let's do it by one command:
5898 \def\makedispenv #1#2{
5899 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5900 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5901 \expandafter\let\csname E#1\endcsname \afterenvbreak
5902 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5905 % Define two synonyms:
5906 \def\maketwodispenvs #1#2#3{
5907 \makedispenv{#1}{#3}
5908 \makedispenv{#2}{#3}
5911 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5913 % @smallexample and @smalllisp: use smaller fonts.
5914 % Originally contributed by Pavel@xerox.
5916 \maketwodispenvs {lisp}{example}{%
5917 \nonfillstart
5918 \tt\quoteexpand
5919 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
5920 \gobble % eat return
5922 % @display/@smalldisplay: same as @lisp except keep current font.
5924 \makedispenv {display}{%
5925 \nonfillstart
5926 \gobble
5929 % @format/@smallformat: same as @display except don't narrow margins.
5931 \makedispenv{format}{%
5932 \let\nonarrowing = t%
5933 \nonfillstart
5934 \gobble
5937 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
5938 \envdef\flushleft{%
5939 \let\nonarrowing = t%
5940 \nonfillstart
5941 \gobble
5943 \let\Eflushleft = \afterenvbreak
5945 % @flushright.
5947 \envdef\flushright{%
5948 \let\nonarrowing = t%
5949 \nonfillstart
5950 \advance\leftskip by 0pt plus 1fill
5951 \gobble
5953 \let\Eflushright = \afterenvbreak
5956 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
5957 % and narrows the margins. We keep \parskip nonzero in general, since
5958 % we're doing normal filling. So, when using \aboveenvbreak and
5959 % \afterenvbreak, temporarily make \parskip 0.
5961 \envdef\quotation{%
5962 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
5963 \parindent=0pt
5965 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
5966 \ifx\nonarrowing\relax
5967 \advance\leftskip by \lispnarrowing
5968 \advance\rightskip by \lispnarrowing
5969 \exdentamount = \lispnarrowing
5970 \else
5971 \let\nonarrowing = \relax
5973 \parsearg\quotationlabel
5976 % We have retained a nonzero parskip for the environment, since we're
5977 % doing normal filling.
5979 \def\Equotation{%
5980 \par
5981 \ifx\quotationauthor\undefined\else
5982 % indent a bit.
5983 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5985 {\parskip=0pt \afterenvbreak}%
5988 % If we're given an argument, typeset it in bold with a colon after.
5989 \def\quotationlabel#1{%
5990 \def\temp{#1}%
5991 \ifx\temp\empty \else
5992 {\bf #1: }%
5997 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
5998 % If we want to allow any <char> as delimiter,
5999 % we need the curly braces so that makeinfo sees the @verb command, eg:
6000 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6002 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6004 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6005 % active too. Otherwise, they get lost as the first character on a
6006 % verbatim line.
6007 \def\dospecials{%
6008 \do\ \do\\\do\{\do\}\do\$\do\&%
6009 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6010 \do\<\do\>\do\|\do\@\do+\do\"%
6013 % [Knuth] p. 380
6014 \def\uncatcodespecials{%
6015 \def\do##1{\catcode`##1=\other}\dospecials}
6017 % [Knuth] pp. 380,381,391
6018 % Disable Spanish ligatures ?` and !` of \tt font
6019 \begingroup
6020 \catcode`\`=\active\gdef`{\relax\lq}
6021 \endgroup
6023 % Setup for the @verb command.
6025 % Eight spaces for a tab
6026 \begingroup
6027 \catcode`\^^I=\active
6028 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6029 \endgroup
6031 \def\setupverb{%
6032 \tt % easiest (and conventionally used) font for verbatim
6033 \def\par{\leavevmode\endgraf}%
6034 \catcode`\`=\active
6035 \tabeightspaces
6036 % Respect line breaks,
6037 % print special symbols as themselves, and
6038 % make each space count
6039 % must do in this order:
6040 \obeylines \uncatcodespecials \sepspaces
6043 % Setup for the @verbatim environment
6045 % Real tab expansion
6046 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6048 \def\starttabbox{\setbox0=\hbox\bgroup}
6050 % Allow an option to not replace quotes with a regular directed right
6051 % quote/apostrophe (char 0x27), but instead use the undirected quote
6052 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
6053 % the default, but it works for pasting with more pdf viewers (at least
6054 % evince), the lilypond developers report. xpdf does work with the
6055 % regular 0x27.
6057 \def\codequoteright{%
6058 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
6059 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
6061 \else \char'15 \fi
6062 \else \char'15 \fi
6065 % and a similar option for the left quote char vs. a grave accent.
6066 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
6067 % the code environments to do likewise.
6069 \def\codequoteleft{%
6070 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
6071 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
6073 \else \char'22 \fi
6074 \else \char'22 \fi
6077 \begingroup
6078 \catcode`\^^I=\active
6079 \gdef\tabexpand{%
6080 \catcode`\^^I=\active
6081 \def^^I{\leavevmode\egroup
6082 \dimen0=\wd0 % the width so far, or since the previous tab
6083 \divide\dimen0 by\tabw
6084 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
6085 \advance\dimen0 by\tabw % advance to next multiple of \tabw
6086 \wd0=\dimen0 \box0 \starttabbox
6089 \catcode`\'=\active
6090 \gdef\rquoteexpand{\catcode\rquoteChar=\active \def'{\codequoteright}}%
6092 \catcode`\`=\active
6093 \gdef\lquoteexpand{\catcode\lquoteChar=\active \def`{\codequoteleft}}%
6095 \gdef\quoteexpand{\rquoteexpand \lquoteexpand}%
6096 \endgroup
6098 % start the verbatim environment.
6099 \def\setupverbatim{%
6100 \let\nonarrowing = t%
6101 \nonfillstart
6102 % Easiest (and conventionally used) font for verbatim
6104 \def\par{\leavevmode\egroup\box0\endgraf}%
6105 \catcode`\`=\active
6106 \tabexpand
6107 \quoteexpand
6108 % Respect line breaks,
6109 % print special symbols as themselves, and
6110 % make each space count
6111 % must do in this order:
6112 \obeylines \uncatcodespecials \sepspaces
6113 \everypar{\starttabbox}%
6116 % Do the @verb magic: verbatim text is quoted by unique
6117 % delimiter characters. Before first delimiter expect a
6118 % right brace, after last delimiter expect closing brace:
6120 % \def\doverb'{'<char>#1<char>'}'{#1}
6122 % [Knuth] p. 382; only eat outer {}
6123 \begingroup
6124 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6125 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6126 \endgroup
6128 \def\verb{\begingroup\setupverb\doverb}
6131 % Do the @verbatim magic: define the macro \doverbatim so that
6132 % the (first) argument ends when '@end verbatim' is reached, ie:
6134 % \def\doverbatim#1@end verbatim{#1}
6136 % For Texinfo it's a lot easier than for LaTeX,
6137 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6138 % we need not redefine '\', '{' and '}'.
6140 % Inspired by LaTeX's verbatim command set [latex.ltx]
6142 \begingroup
6143 \catcode`\ =\active
6144 \obeylines %
6145 % ignore everything up to the first ^^M, that's the newline at the end
6146 % of the @verbatim input line itself. Otherwise we get an extra blank
6147 % line in the output.
6148 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6149 % We really want {...\end verbatim} in the body of the macro, but
6150 % without the active space; thus we have to use \xdef and \gobble.
6151 \endgroup
6153 \envdef\verbatim{%
6154 \setupverbatim\doverbatim
6156 \let\Everbatim = \afterenvbreak
6159 % @verbatiminclude FILE - insert text of file in verbatim environment.
6161 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6163 \def\doverbatiminclude#1{%
6165 \makevalueexpandable
6166 \setupverbatim
6167 \input #1
6168 \afterenvbreak
6172 % @copying ... @end copying.
6173 % Save the text away for @insertcopying later.
6175 % We save the uninterpreted tokens, rather than creating a box.
6176 % Saving the text in a box would be much easier, but then all the
6177 % typesetting commands (@smallbook, font changes, etc.) have to be done
6178 % beforehand -- and a) we want @copying to be done first in the source
6179 % file; b) letting users define the frontmatter in as flexible order as
6180 % possible is very desirable.
6182 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6183 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6185 \def\insertcopying{%
6186 \begingroup
6187 \parindent = 0pt % paragraph indentation looks wrong on title page
6188 \scanexp\copyingtext
6189 \endgroup
6193 \message{defuns,}
6194 % @defun etc.
6196 \newskip\defbodyindent \defbodyindent=.4in
6197 \newskip\defargsindent \defargsindent=50pt
6198 \newskip\deflastargmargin \deflastargmargin=18pt
6199 \newcount\defunpenalty
6201 % Start the processing of @deffn:
6202 \def\startdefun{%
6203 \ifnum\lastpenalty<10000
6204 \medbreak
6205 \defunpenalty=10003 % Will keep this @deffn together with the
6206 % following @def command, see below.
6207 \else
6208 % If there are two @def commands in a row, we'll have a \nobreak,
6209 % which is there to keep the function description together with its
6210 % header. But if there's nothing but headers, we need to allow a
6211 % break somewhere. Check specifically for penalty 10002, inserted
6212 % by \printdefunline, instead of 10000, since the sectioning
6213 % commands also insert a nobreak penalty, and we don't want to allow
6214 % a break between a section heading and a defun.
6216 % As a minor refinement, we avoid "club" headers by signalling
6217 % with penalty of 10003 after the very first @deffn in the
6218 % sequence (see above), and penalty of 10002 after any following
6219 % @def command.
6220 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6222 % Similarly, after a section heading, do not allow a break.
6223 % But do insert the glue.
6224 \medskip % preceded by discardable penalty, so not a breakpoint
6227 \parindent=0in
6228 \advance\leftskip by \defbodyindent
6229 \exdentamount=\defbodyindent
6232 \def\dodefunx#1{%
6233 % First, check whether we are in the right environment:
6234 \checkenv#1%
6236 % As above, allow line break if we have multiple x headers in a row.
6237 % It's not a great place, though.
6238 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6240 % And now, it's time to reuse the body of the original defun:
6241 \expandafter\gobbledefun#1%
6243 \def\gobbledefun#1\startdefun{}
6245 % \printdefunline \deffnheader{text}
6247 \def\printdefunline#1#2{%
6248 \begingroup
6249 % call \deffnheader:
6250 #1#2 \endheader
6251 % common ending:
6252 \interlinepenalty = 10000
6253 \advance\rightskip by 0pt plus 1fil
6254 \endgraf
6255 \nobreak\vskip -\parskip
6256 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6257 % Some of the @defun-type tags do not enable magic parentheses,
6258 % rendering the following check redundant. But we don't optimize.
6259 \checkparencounts
6260 \endgroup
6263 \def\Edefun{\endgraf\medbreak}
6265 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6266 % the only thing remaining is to define \deffnheader.
6268 \def\makedefun#1{%
6269 \expandafter\let\csname E#1\endcsname = \Edefun
6270 \edef\temp{\noexpand\domakedefun
6271 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6272 \temp
6275 % \domakedefun \deffn \deffnx \deffnheader
6277 % Define \deffn and \deffnx, without parameters.
6278 % \deffnheader has to be defined explicitly.
6280 \def\domakedefun#1#2#3{%
6281 \envdef#1{%
6282 \startdefun
6283 \parseargusing\activeparens{\printdefunline#3}%
6285 \def#2{\dodefunx#1}%
6286 \def#3%
6289 %%% Untyped functions:
6291 % @deffn category name args
6292 \makedefun{deffn}{\deffngeneral{}}
6294 % @deffn category class name args
6295 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6297 % \defopon {category on}class name args
6298 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6300 % \deffngeneral {subind}category name args
6302 \def\deffngeneral#1#2 #3 #4\endheader{%
6303 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6304 \dosubind{fn}{\code{#3}}{#1}%
6305 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6308 %%% Typed functions:
6310 % @deftypefn category type name args
6311 \makedefun{deftypefn}{\deftypefngeneral{}}
6313 % @deftypeop category class type name args
6314 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6316 % \deftypeopon {category on}class type name args
6317 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6319 % \deftypefngeneral {subind}category type name args
6321 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6322 \dosubind{fn}{\code{#4}}{#1}%
6323 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6326 %%% Typed variables:
6328 % @deftypevr category type var args
6329 \makedefun{deftypevr}{\deftypecvgeneral{}}
6331 % @deftypecv category class type var args
6332 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6334 % \deftypecvof {category of}class type var args
6335 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6337 % \deftypecvgeneral {subind}category type var args
6339 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6340 \dosubind{vr}{\code{#4}}{#1}%
6341 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6344 %%% Untyped variables:
6346 % @defvr category var args
6347 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6349 % @defcv category class var args
6350 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6352 % \defcvof {category of}class var args
6353 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6355 %%% Type:
6356 % @deftp category name args
6357 \makedefun{deftp}#1 #2 #3\endheader{%
6358 \doind{tp}{\code{#2}}%
6359 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6362 % Remaining @defun-like shortcuts:
6363 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6364 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6365 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6366 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6367 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6368 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6369 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6370 \makedefun{defmethod}{\defopon\putwordMethodon}
6371 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6372 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6373 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6375 % \defname, which formats the name of the @def (not the args).
6376 % #1 is the category, such as "Function".
6377 % #2 is the return type, if any.
6378 % #3 is the function name.
6380 % We are followed by (but not passed) the arguments, if any.
6382 \def\defname#1#2#3{%
6383 % Get the values of \leftskip and \rightskip as they were outside the @def...
6384 \advance\leftskip by -\defbodyindent
6386 % How we'll format the type name. Putting it in brackets helps
6387 % distinguish it from the body text that may end up on the next line
6388 % just below it.
6389 \def\temp{#1}%
6390 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6392 % Figure out line sizes for the paragraph shape.
6393 % The first line needs space for \box0; but if \rightskip is nonzero,
6394 % we need only space for the part of \box0 which exceeds it:
6395 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6396 % The continuations:
6397 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6398 % (plain.tex says that \dimen1 should be used only as global.)
6399 \parshape 2 0in \dimen0 \defargsindent \dimen2
6401 % Put the type name to the right margin.
6402 \noindent
6403 \hbox to 0pt{%
6404 \hfil\box0 \kern-\hsize
6405 % \hsize has to be shortened this way:
6406 \kern\leftskip
6407 % Intentionally do not respect \rightskip, since we need the space.
6410 % Allow all lines to be underfull without complaint:
6411 \tolerance=10000 \hbadness=10000
6412 \exdentamount=\defbodyindent
6414 % defun fonts. We use typewriter by default (used to be bold) because:
6415 % . we're printing identifiers, they should be in tt in principle.
6416 % . in languages with many accents, such as Czech or French, it's
6417 % common to leave accents off identifiers. The result looks ok in
6418 % tt, but exceedingly strange in rm.
6419 % . we don't want -- and --- to be treated as ligatures.
6420 % . this still does not fix the ?` and !` ligatures, but so far no
6421 % one has made identifiers using them :).
6422 \df \tt
6423 \def\temp{#2}% return value type
6424 \ifx\temp\empty\else \tclose{\temp} \fi
6425 #3% output function name
6427 {\rm\enskip}% hskip 0.5 em of \tenrm
6429 \boldbrax
6430 % arguments will be output next, if any.
6433 % Print arguments in slanted roman (not ttsl), inconsistently with using
6434 % tt for the name. This is because literal text is sometimes needed in
6435 % the argument list (groff manual), and ttsl and tt are not very
6436 % distinguishable. Prevent hyphenation at `-' chars.
6438 \def\defunargs#1{%
6439 % use sl by default (not ttsl),
6440 % tt for the names.
6441 \df \sl \hyphenchar\font=0
6443 % On the other hand, if an argument has two dashes (for instance), we
6444 % want a way to get ttsl. Let's try @var for that.
6445 \let\var=\ttslanted
6447 \sl\hyphenchar\font=45
6450 % We want ()&[] to print specially on the defun line.
6452 \def\activeparens{%
6453 \catcode`\(=\active \catcode`\)=\active
6454 \catcode`\[=\active \catcode`\]=\active
6455 \catcode`\&=\active
6458 % Make control sequences which act like normal parenthesis chars.
6459 \let\lparen = ( \let\rparen = )
6461 % Be sure that we always have a definition for `(', etc. For example,
6462 % if the fn name has parens in it, \boldbrax will not be in effect yet,
6463 % so TeX would otherwise complain about undefined control sequence.
6465 \activeparens
6466 \global\let(=\lparen \global\let)=\rparen
6467 \global\let[=\lbrack \global\let]=\rbrack
6468 \global\let& = \&
6470 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
6471 \gdef\magicamp{\let&=\amprm}
6474 \newcount\parencount
6476 % If we encounter &foo, then turn on ()-hacking afterwards
6477 \newif\ifampseen
6478 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
6480 \def\parenfont{%
6481 \ifampseen
6482 % At the first level, print parens in roman,
6483 % otherwise use the default font.
6484 \ifnum \parencount=1 \rm \fi
6485 \else
6486 % The \sf parens (in \boldbrax) actually are a little bolder than
6487 % the contained text. This is especially needed for [ and ] .
6491 \def\infirstlevel#1{%
6492 \ifampseen
6493 \ifnum\parencount=1
6498 \def\bfafterword#1 {#1 \bf}
6500 \def\opnr{%
6501 \global\advance\parencount by 1
6502 {\parenfont(}%
6503 \infirstlevel \bfafterword
6505 \def\clnr{%
6506 {\parenfont)}%
6507 \infirstlevel \sl
6508 \global\advance\parencount by -1
6511 \newcount\brackcount
6512 \def\lbrb{%
6513 \global\advance\brackcount by 1
6514 {\bf[}%
6516 \def\rbrb{%
6517 {\bf]}%
6518 \global\advance\brackcount by -1
6521 \def\checkparencounts{%
6522 \ifnum\parencount=0 \else \badparencount \fi
6523 \ifnum\brackcount=0 \else \badbrackcount \fi
6525 % these should not use \errmessage; the glibc manual, at least, actually
6526 % has such constructs (when documenting function pointers).
6527 \def\badparencount{%
6528 \message{Warning: unbalanced parentheses in @def...}%
6529 \global\parencount=0
6531 \def\badbrackcount{%
6532 \message{Warning: unbalanced square brackets in @def...}%
6533 \global\brackcount=0
6537 \message{macros,}
6538 % @macro.
6540 % To do this right we need a feature of e-TeX, \scantokens,
6541 % which we arrange to emulate with a temporary file in ordinary TeX.
6542 \ifx\eTeXversion\undefined
6543 \newwrite\macscribble
6544 \def\scantokens#1{%
6545 \toks0={#1}%
6546 \immediate\openout\macscribble=\jobname.tmp
6547 \immediate\write\macscribble{\the\toks0}%
6548 \immediate\closeout\macscribble
6549 \input \jobname.tmp
6553 \def\scanmacro#1{%
6554 \begingroup
6555 \newlinechar`\^^M
6556 \let\xeatspaces\eatspaces
6557 % Undo catcode changes of \startcontents and \doprintindex
6558 % When called from @insertcopying or (short)caption, we need active
6559 % backslash to get it printed correctly. Previously, we had
6560 % \catcode`\\=\other instead. We'll see whether a problem appears
6561 % with macro expansion. --kasal, 19aug04
6562 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6563 % ... and \example
6564 \spaceisspace
6566 % Append \endinput to make sure that TeX does not see the ending newline.
6567 % I've verified that it is necessary both for e-TeX and for ordinary TeX
6568 % --kasal, 29nov03
6569 \scantokens{#1\endinput}%
6570 \endgroup
6573 \def\scanexp#1{%
6574 \edef\temp{\noexpand\scanmacro{#1}}%
6575 \temp
6578 \newcount\paramno % Count of parameters
6579 \newtoks\macname % Macro name
6580 \newif\ifrecursive % Is it recursive?
6582 % List of all defined macros in the form
6583 % \definedummyword\macro1\definedummyword\macro2...
6584 % Currently is also contains all @aliases; the list can be split
6585 % if there is a need.
6586 \def\macrolist{}
6588 % Add the macro to \macrolist
6589 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6590 \def\addtomacrolistxxx#1{%
6591 \toks0 = \expandafter{\macrolist\definedummyword#1}%
6592 \xdef\macrolist{\the\toks0}%
6595 % Utility routines.
6596 % This does \let #1 = #2, with \csnames; that is,
6597 % \let \csname#1\endcsname = \csname#2\endcsname
6598 % (except of course we have to play expansion games).
6600 \def\cslet#1#2{%
6601 \expandafter\let
6602 \csname#1\expandafter\endcsname
6603 \csname#2\endcsname
6606 % Trim leading and trailing spaces off a string.
6607 % Concepts from aro-bend problem 15 (see CTAN).
6608 {\catcode`\@=11
6609 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6610 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6611 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6612 \def\unbrace#1{#1}
6613 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6616 % Trim a single trailing ^^M off a string.
6617 {\catcode`\^^M=\other \catcode`\Q=3%
6618 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6619 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6620 \gdef\eatcrb#1Q#2Q{#1}%
6623 % Macro bodies are absorbed as an argument in a context where
6624 % all characters are catcode 10, 11 or 12, except \ which is active
6625 % (as in normal texinfo). It is necessary to change the definition of \.
6627 % Non-ASCII encodings make 8-bit characters active, so un-activate
6628 % them to avoid their expansion. Must do this non-globally, to
6629 % confine the change to the current group.
6631 % It's necessary to have hard CRs when the macro is executed. This is
6632 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
6633 % body, and then making it the \newlinechar in \scanmacro.
6635 \def\scanctxt{%
6636 \catcode`\"=\other
6637 \catcode`\+=\other
6638 \catcode`\<=\other
6639 \catcode`\>=\other
6640 \catcode`\@=\other
6641 \catcode`\^=\other
6642 \catcode`\_=\other
6643 \catcode`\|=\other
6644 \catcode`\~=\other
6645 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
6648 \def\scanargctxt{%
6649 \scanctxt
6650 \catcode`\\=\other
6651 \catcode`\^^M=\other
6654 \def\macrobodyctxt{%
6655 \scanctxt
6656 \catcode`\{=\other
6657 \catcode`\}=\other
6658 \catcode`\^^M=\other
6659 \usembodybackslash
6662 \def\macroargctxt{%
6663 \scanctxt
6664 \catcode`\\=\other
6667 % \mbodybackslash is the definition of \ in @macro bodies.
6668 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6669 % where N is the macro parameter number.
6670 % We define \csname macarg.\endcsname to be \realbackslash, so
6671 % \\ in macro replacement text gets you a backslash.
6673 {\catcode`@=0 @catcode`@\=@active
6674 @gdef@usembodybackslash{@let\=@mbodybackslash}
6675 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6677 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6679 \def\macro{\recursivefalse\parsearg\macroxxx}
6680 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6682 \def\macroxxx#1{%
6683 \getargs{#1}% now \macname is the macname and \argl the arglist
6684 \ifx\argl\empty % no arguments
6685 \paramno=0%
6686 \else
6687 \expandafter\parsemargdef \argl;%
6689 \if1\csname ismacro.\the\macname\endcsname
6690 \message{Warning: redefining \the\macname}%
6691 \else
6692 \expandafter\ifx\csname \the\macname\endcsname \relax
6693 \else \errmessage{Macro name \the\macname\space already defined}\fi
6694 \global\cslet{macsave.\the\macname}{\the\macname}%
6695 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6696 \addtomacrolist{\the\macname}%
6698 \begingroup \macrobodyctxt
6699 \ifrecursive \expandafter\parsermacbody
6700 \else \expandafter\parsemacbody
6701 \fi}
6703 \parseargdef\unmacro{%
6704 \if1\csname ismacro.#1\endcsname
6705 \global\cslet{#1}{macsave.#1}%
6706 \global\expandafter\let \csname ismacro.#1\endcsname=0%
6707 % Remove the macro name from \macrolist:
6708 \begingroup
6709 \expandafter\let\csname#1\endcsname \relax
6710 \let\definedummyword\unmacrodo
6711 \xdef\macrolist{\macrolist}%
6712 \endgroup
6713 \else
6714 \errmessage{Macro #1 not defined}%
6718 % Called by \do from \dounmacro on each macro. The idea is to omit any
6719 % macro definitions that have been changed to \relax.
6721 \def\unmacrodo#1{%
6722 \ifx #1\relax
6723 % remove this
6724 \else
6725 \noexpand\definedummyword \noexpand#1%
6729 % This makes use of the obscure feature that if the last token of a
6730 % <parameter list> is #, then the preceding argument is delimited by
6731 % an opening brace, and that opening brace is not consumed.
6732 \def\getargs#1{\getargsxxx#1{}}
6733 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
6734 \def\getmacname #1 #2\relax{\macname={#1}}
6735 \def\getmacargs#1{\def\argl{#1}}
6737 % Parse the optional {params} list. Set up \paramno and \paramlist
6738 % so \defmacro knows what to do. Define \macarg.blah for each blah
6739 % in the params list, to be ##N where N is the position in that list.
6740 % That gets used by \mbodybackslash (above).
6742 % We need to get `macro parameter char #' into several definitions.
6743 % The technique used is stolen from LaTeX: let \hash be something
6744 % unexpandable, insert that wherever you need a #, and then redefine
6745 % it to # just before using the token list produced.
6747 % The same technique is used to protect \eatspaces till just before
6748 % the macro is used.
6750 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
6751 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
6752 \def\parsemargdefxxx#1,{%
6753 \if#1;\let\next=\relax
6754 \else \let\next=\parsemargdefxxx
6755 \advance\paramno by 1%
6756 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
6757 {\xeatspaces{\hash\the\paramno}}%
6758 \edef\paramlist{\paramlist\hash\the\paramno,}%
6759 \fi\next}
6761 % These two commands read recursive and nonrecursive macro bodies.
6762 % (They're different since rec and nonrec macros end differently.)
6764 \long\def\parsemacbody#1@end macro%
6765 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6766 \long\def\parsermacbody#1@end rmacro%
6767 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6769 % This defines the macro itself. There are six cases: recursive and
6770 % nonrecursive macros of zero, one, and many arguments.
6771 % Much magic with \expandafter here.
6772 % \xdef is used so that macro definitions will survive the file
6773 % they're defined in; @include reads the file inside a group.
6774 \def\defmacro{%
6775 \let\hash=##% convert placeholders to macro parameter chars
6776 \ifrecursive
6777 \ifcase\paramno
6779 \expandafter\xdef\csname\the\macname\endcsname{%
6780 \noexpand\scanmacro{\temp}}%
6781 \or % 1
6782 \expandafter\xdef\csname\the\macname\endcsname{%
6783 \bgroup\noexpand\macroargctxt
6784 \noexpand\braceorline
6785 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6786 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6787 \egroup\noexpand\scanmacro{\temp}}%
6788 \else % many
6789 \expandafter\xdef\csname\the\macname\endcsname{%
6790 \bgroup\noexpand\macroargctxt
6791 \noexpand\csname\the\macname xx\endcsname}%
6792 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6793 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6794 \expandafter\expandafter
6795 \expandafter\xdef
6796 \expandafter\expandafter
6797 \csname\the\macname xxx\endcsname
6798 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
6800 \else
6801 \ifcase\paramno
6803 \expandafter\xdef\csname\the\macname\endcsname{%
6804 \noexpand\norecurse{\the\macname}%
6805 \noexpand\scanmacro{\temp}\egroup}%
6806 \or % 1
6807 \expandafter\xdef\csname\the\macname\endcsname{%
6808 \bgroup\noexpand\macroargctxt
6809 \noexpand\braceorline
6810 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6811 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6812 \egroup
6813 \noexpand\norecurse{\the\macname}%
6814 \noexpand\scanmacro{\temp}\egroup}%
6815 \else % many
6816 \expandafter\xdef\csname\the\macname\endcsname{%
6817 \bgroup\noexpand\macroargctxt
6818 \expandafter\noexpand\csname\the\macname xx\endcsname}%
6819 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6820 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6821 \expandafter\expandafter
6822 \expandafter\xdef
6823 \expandafter\expandafter
6824 \csname\the\macname xxx\endcsname
6825 \paramlist{%
6826 \egroup
6827 \noexpand\norecurse{\the\macname}%
6828 \noexpand\scanmacro{\temp}\egroup}%
6830 \fi}
6832 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
6834 % \braceorline decides whether the next nonwhitespace character is a
6835 % {. If so it reads up to the closing }, if not, it reads the whole
6836 % line. Whatever was read is then fed to the next control sequence
6837 % as an argument (by \parsebrace or \parsearg)
6838 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
6839 \def\braceorlinexxx{%
6840 \ifx\nchar\bgroup\else
6841 \expandafter\parsearg
6842 \fi \macnamexxx}
6845 % @alias.
6846 % We need some trickery to remove the optional spaces around the equal
6847 % sign. Just make them active and then expand them all to nothing.
6848 \def\alias{\parseargusing\obeyspaces\aliasxxx}
6849 \def\aliasxxx #1{\aliasyyy#1\relax}
6850 \def\aliasyyy #1=#2\relax{%
6852 \expandafter\let\obeyedspace=\empty
6853 \addtomacrolist{#1}%
6854 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
6856 \next
6860 \message{cross references,}
6862 \newwrite\auxfile
6863 \newif\ifhavexrefs % True if xref values are known.
6864 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
6866 % @inforef is relatively simple.
6867 \def\inforef #1{\inforefzzz #1,,,,**}
6868 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
6869 node \samp{\ignorespaces#1{}}}
6871 % @node's only job in TeX is to define \lastnode, which is used in
6872 % cross-references. The @node line might or might not have commas, and
6873 % might or might not have spaces before the first comma, like:
6874 % @node foo , bar , ...
6875 % We don't want such trailing spaces in the node name.
6877 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
6879 % also remove a trailing comma, in case of something like this:
6880 % @node Help-Cross, , , Cross-refs
6881 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
6882 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
6884 \let\nwnode=\node
6885 \let\lastnode=\empty
6887 % Write a cross-reference definition for the current node. #1 is the
6888 % type (Ynumbered, Yappendix, Ynothing).
6890 \def\donoderef#1{%
6891 \ifx\lastnode\empty\else
6892 \setref{\lastnode}{#1}%
6893 \global\let\lastnode=\empty
6897 % @anchor{NAME} -- define xref target at arbitrary point.
6899 \newcount\savesfregister
6901 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
6902 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
6903 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
6905 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
6906 % anchor), which consists of three parts:
6907 % 1) NAME-title - the current sectioning name taken from \lastsection,
6908 % or the anchor name.
6909 % 2) NAME-snt - section number and type, passed as the SNT arg, or
6910 % empty for anchors.
6911 % 3) NAME-pg - the page number.
6913 % This is called from \donoderef, \anchor, and \dofloat. In the case of
6914 % floats, there is an additional part, which is not written here:
6915 % 4) NAME-lof - the text as it should appear in a @listoffloats.
6917 \def\setref#1#2{%
6918 \pdfmkdest{#1}%
6919 \iflinks
6921 \atdummies % preserve commands, but don't expand them
6922 \edef\writexrdef##1##2{%
6923 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6924 ##1}{##2}}% these are parameters of \writexrdef
6926 \toks0 = \expandafter{\lastsection}%
6927 \immediate \writexrdef{title}{\the\toks0 }%
6928 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6929 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout
6934 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
6935 % the node name, #2 the name of the Info cross-reference, #3 the printed
6936 % node name, #4 the name of the Info file, #5 the name of the printed
6937 % manual. All but the node name can be omitted.
6939 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
6940 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
6941 \def\ref#1{\xrefX[#1,,,,,,,]}
6942 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
6943 \unsepspaces
6944 \def\printedmanual{\ignorespaces #5}%
6945 \def\printedrefname{\ignorespaces #3}%
6946 \setbox1=\hbox{\printedmanual\unskip}%
6947 \setbox0=\hbox{\printedrefname\unskip}%
6948 \ifdim \wd0 = 0pt
6949 % No printed node name was explicitly given.
6950 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
6951 % Use the node name inside the square brackets.
6952 \def\printedrefname{\ignorespaces #1}%
6953 \else
6954 % Use the actual chapter/section title appear inside
6955 % the square brackets. Use the real section title if we have it.
6956 \ifdim \wd1 > 0pt
6957 % It is in another manual, so we don't have it.
6958 \def\printedrefname{\ignorespaces #1}%
6959 \else
6960 \ifhavexrefs
6961 % We know the real title if we have the xref values.
6962 \def\printedrefname{\refx{#1-title}{}}%
6963 \else
6964 % Otherwise just copy the Info node name.
6965 \def\printedrefname{\ignorespaces #1}%
6966 \fi%
6971 % Make link in pdf output.
6972 \ifpdf
6973 {\indexnofonts
6974 \turnoffactive
6975 % This expands tokens, so do it after making catcode changes, so _
6976 % etc. don't get their TeX definitions.
6977 \getfilename{#4}%
6979 % See comments at \activebackslashdouble.
6980 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
6981 \backslashparens\pdfxrefdest}%
6983 \leavevmode
6984 \startlink attr{/Border [0 0 0]}%
6985 \ifnum\filenamelength>0
6986 goto file{\the\filename.pdf} name{\pdfxrefdest}%
6987 \else
6988 goto name{\pdfmkpgn{\pdfxrefdest}}%
6991 \setcolor{\linkcolor}%
6994 % Float references are printed completely differently: "Figure 1.2"
6995 % instead of "[somenode], p.3". We distinguish them by the
6996 % LABEL-title being set to a magic string.
6998 % Have to otherify everything special to allow the \csname to
6999 % include an _ in the xref name, etc.
7000 \indexnofonts
7001 \turnoffactive
7002 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7003 \csname XR#1-title\endcsname
7005 \iffloat\Xthisreftitle
7006 % If the user specified the print name (third arg) to the ref,
7007 % print it instead of our usual "Figure 1.2".
7008 \ifdim\wd0 = 0pt
7009 \refx{#1-snt}{}%
7010 \else
7011 \printedrefname
7014 % if the user also gave the printed manual name (fifth arg), append
7015 % "in MANUALNAME".
7016 \ifdim \wd1 > 0pt
7017 \space \putwordin{} \cite{\printedmanual}%
7019 \else
7020 % node/anchor (non-float) references.
7022 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7023 % insert empty discretionaries after hyphens, which means that it will
7024 % not find a line break at a hyphen in a node names. Since some manuals
7025 % are best written with fairly long node names, containing hyphens, this
7026 % is a loss. Therefore, we give the text of the node name again, so it
7027 % is as if TeX is seeing it for the first time.
7028 \ifdim \wd1 > 0pt
7029 \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7030 \else
7031 % _ (for example) has to be the character _ for the purposes of the
7032 % control sequence corresponding to the node, but it has to expand
7033 % into the usual \leavevmode...\vrule stuff for purposes of
7034 % printing. So we \turnoffactive for the \refx-snt, back on for the
7035 % printing, back off for the \refx-pg.
7036 {\turnoffactive
7037 % Only output a following space if the -snt ref is nonempty; for
7038 % @unnumbered and @anchor, it won't be.
7039 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7040 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7042 % output the `[mynode]' via a macro so it can be overridden.
7043 \xrefprintnodename\printedrefname
7045 % But we always want a comma and a space:
7046 ,\space
7048 % output the `page 3'.
7049 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7052 \endlink
7053 \endgroup}
7055 % This macro is called from \xrefX for the `[nodename]' part of xref
7056 % output. It's a separate macro only so it can be changed more easily,
7057 % since square brackets don't work well in some documents. Particularly
7058 % one that Bob is working on :).
7060 \def\xrefprintnodename#1{[#1]}
7062 % Things referred to by \setref.
7064 \def\Ynothing{}
7065 \def\Yomitfromtoc{}
7066 \def\Ynumbered{%
7067 \ifnum\secno=0
7068 \putwordChapter@tie \the\chapno
7069 \else \ifnum\subsecno=0
7070 \putwordSection@tie \the\chapno.\the\secno
7071 \else \ifnum\subsubsecno=0
7072 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7073 \else
7074 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7075 \fi\fi\fi
7077 \def\Yappendix{%
7078 \ifnum\secno=0
7079 \putwordAppendix@tie @char\the\appendixno{}%
7080 \else \ifnum\subsecno=0
7081 \putwordSection@tie @char\the\appendixno.\the\secno
7082 \else \ifnum\subsubsecno=0
7083 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7084 \else
7085 \putwordSection@tie
7086 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7087 \fi\fi\fi
7090 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7091 % If its value is nonempty, SUFFIX is output afterward.
7093 \def\refx#1#2{%
7095 \indexnofonts
7096 \otherbackslash
7097 \expandafter\global\expandafter\let\expandafter\thisrefX
7098 \csname XR#1\endcsname
7100 \ifx\thisrefX\relax
7101 % If not defined, say something at least.
7102 \angleleft un\-de\-fined\angleright
7103 \iflinks
7104 \ifhavexrefs
7105 \message{\linenumber Undefined cross reference `#1'.}%
7106 \else
7107 \ifwarnedxrefs\else
7108 \global\warnedxrefstrue
7109 \message{Cross reference values unknown; you must run TeX again.}%
7113 \else
7114 % It's defined, so just use it.
7115 \thisrefX
7117 #2% Output the suffix in any case.
7120 % This is the macro invoked by entries in the aux file. Usually it's
7121 % just a \def (we prepend XR to the control sequence name to avoid
7122 % collisions). But if this is a float type, we have more work to do.
7124 \def\xrdef#1#2{%
7125 {% The node name might contain 8-bit characters, which in our current
7126 % implementation are changed to commands like @'e. Don't let these
7127 % mess up the control sequence name.
7128 \indexnofonts
7129 \turnoffactive
7130 \xdef\safexrefname{#1}%
7133 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7135 % Was that xref control sequence that we just defined for a float?
7136 \expandafter\iffloat\csname XR\safexrefname\endcsname
7137 % it was a float, and we have the (safe) float type in \iffloattype.
7138 \expandafter\let\expandafter\floatlist
7139 \csname floatlist\iffloattype\endcsname
7141 % Is this the first time we've seen this float type?
7142 \expandafter\ifx\floatlist\relax
7143 \toks0 = {\do}% yes, so just \do
7144 \else
7145 % had it before, so preserve previous elements in list.
7146 \toks0 = \expandafter{\floatlist\do}%
7149 % Remember this xref in the control sequence \floatlistFLOATTYPE,
7150 % for later use in \listoffloats.
7151 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
7152 {\safexrefname}}%
7156 % Read the last existing aux file, if any. No error if none exists.
7158 \def\tryauxfile{%
7159 \openin 1 \jobname.aux
7160 \ifeof 1 \else
7161 \readdatafile{aux}%
7162 \global\havexrefstrue
7164 \closein 1
7167 \def\setupdatafile{%
7168 \catcode`\^^@=\other
7169 \catcode`\^^A=\other
7170 \catcode`\^^B=\other
7171 \catcode`\^^C=\other
7172 \catcode`\^^D=\other
7173 \catcode`\^^E=\other
7174 \catcode`\^^F=\other
7175 \catcode`\^^G=\other
7176 \catcode`\^^H=\other
7177 \catcode`\^^K=\other
7178 \catcode`\^^L=\other
7179 \catcode`\^^N=\other
7180 \catcode`\^^P=\other
7181 \catcode`\^^Q=\other
7182 \catcode`\^^R=\other
7183 \catcode`\^^S=\other
7184 \catcode`\^^T=\other
7185 \catcode`\^^U=\other
7186 \catcode`\^^V=\other
7187 \catcode`\^^W=\other
7188 \catcode`\^^X=\other
7189 \catcode`\^^Z=\other
7190 \catcode`\^^[=\other
7191 \catcode`\^^\=\other
7192 \catcode`\^^]=\other
7193 \catcode`\^^^=\other
7194 \catcode`\^^_=\other
7195 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
7196 % in xref tags, i.e., node names. But since ^^e4 notation isn't
7197 % supported in the main text, it doesn't seem desirable. Furthermore,
7198 % that is not enough: for node names that actually contain a ^
7199 % character, we would end up writing a line like this: 'xrdef {'hat
7200 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
7201 % argument, and \hat is not an expandable control sequence. It could
7202 % all be worked out, but why? Either we support ^^ or we don't.
7204 % The other change necessary for this was to define \auxhat:
7205 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
7206 % and then to call \auxhat in \setq.
7208 \catcode`\^=\other
7210 % Special characters. Should be turned off anyway, but...
7211 \catcode`\~=\other
7212 \catcode`\[=\other
7213 \catcode`\]=\other
7214 \catcode`\"=\other
7215 \catcode`\_=\other
7216 \catcode`\|=\other
7217 \catcode`\<=\other
7218 \catcode`\>=\other
7219 \catcode`\$=\other
7220 \catcode`\#=\other
7221 \catcode`\&=\other
7222 \catcode`\%=\other
7223 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
7225 % This is to support \ in node names and titles, since the \
7226 % characters end up in a \csname. It's easier than
7227 % leaving it active and making its active definition an actual \
7228 % character. What I don't understand is why it works in the *value*
7229 % of the xrdef. Seems like it should be a catcode12 \, and that
7230 % should not typeset properly. But it works, so I'm moving on for
7231 % now. --karl, 15jan04.
7232 \catcode`\\=\other
7234 % Make the characters 128-255 be printing characters.
7236 \count1=128
7237 \def\loop{%
7238 \catcode\count1=\other
7239 \advance\count1 by 1
7240 \ifnum \count1<256 \loop \fi
7244 % @ is our escape character in .aux files, and we need braces.
7245 \catcode`\{=1
7246 \catcode`\}=2
7247 \catcode`\@=0
7250 \def\readdatafile#1{%
7251 \begingroup
7252 \setupdatafile
7253 \input\jobname.#1
7254 \endgroup}
7257 \message{insertions,}
7258 % including footnotes.
7260 \newcount \footnoteno
7262 % The trailing space in the following definition for supereject is
7263 % vital for proper filling; pages come out unaligned when you do a
7264 % pagealignmacro call if that space before the closing brace is
7265 % removed. (Generally, numeric constants should always be followed by a
7266 % space to prevent strange expansion errors.)
7267 \def\supereject{\par\penalty -20000\footnoteno =0 }
7269 % @footnotestyle is meaningful for info output only.
7270 \let\footnotestyle=\comment
7272 {\catcode `\@=11
7274 % Auto-number footnotes. Otherwise like plain.
7275 \gdef\footnote{%
7276 \let\indent=\ptexindent
7277 \let\noindent=\ptexnoindent
7278 \global\advance\footnoteno by \@ne
7279 \edef\thisfootno{$^{\the\footnoteno}$}%
7281 % In case the footnote comes at the end of a sentence, preserve the
7282 % extra spacing after we do the footnote number.
7283 \let\@sf\empty
7284 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
7286 % Remove inadvertent blank space before typesetting the footnote number.
7287 \unskip
7288 \thisfootno\@sf
7289 \dofootnote
7292 % Don't bother with the trickery in plain.tex to not require the
7293 % footnote text as a parameter. Our footnotes don't need to be so general.
7295 % Oh yes, they do; otherwise, @ifset (and anything else that uses
7296 % \parseargline) fails inside footnotes because the tokens are fixed when
7297 % the footnote is read. --karl, 16nov96.
7299 \gdef\dofootnote{%
7300 \insert\footins\bgroup
7301 % We want to typeset this text as a normal paragraph, even if the
7302 % footnote reference occurs in (for example) a display environment.
7303 % So reset some parameters.
7304 \hsize=\pagewidth
7305 \interlinepenalty\interfootnotelinepenalty
7306 \splittopskip\ht\strutbox % top baseline for broken footnotes
7307 \splitmaxdepth\dp\strutbox
7308 \floatingpenalty\@MM
7309 \leftskip\z@skip
7310 \rightskip\z@skip
7311 \spaceskip\z@skip
7312 \xspaceskip\z@skip
7313 \parindent\defaultparindent
7315 \smallfonts \rm
7317 % Because we use hanging indentation in footnotes, a @noindent appears
7318 % to exdent this text, so make it be a no-op. makeinfo does not use
7319 % hanging indentation so @noindent can still be needed within footnote
7320 % text after an @example or the like (not that this is good style).
7321 \let\noindent = \relax
7323 % Hang the footnote text off the number. Use \everypar in case the
7324 % footnote extends for more than one paragraph.
7325 \everypar = {\hang}%
7326 \textindent{\thisfootno}%
7328 % Don't crash into the line above the footnote text. Since this
7329 % expands into a box, it must come within the paragraph, lest it
7330 % provide a place where TeX can split the footnote.
7331 \footstrut
7332 \futurelet\next\fo@t
7334 }%end \catcode `\@=11
7336 % In case a @footnote appears in a vbox, save the footnote text and create
7337 % the real \insert just after the vbox finished. Otherwise, the insertion
7338 % would be lost.
7339 % Similarly, if a @footnote appears inside an alignment, save the footnote
7340 % text to a box and make the \insert when a row of the table is finished.
7341 % And the same can be done for other insert classes. --kasal, 16nov03.
7343 % Replace the \insert primitive by a cheating macro.
7344 % Deeper inside, just make sure that the saved insertions are not spilled
7345 % out prematurely.
7347 \def\startsavinginserts{%
7348 \ifx \insert\ptexinsert
7349 \let\insert\saveinsert
7350 \else
7351 \let\checkinserts\relax
7355 % This \insert replacement works for both \insert\footins{foo} and
7356 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
7358 \def\saveinsert#1{%
7359 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
7360 \afterassignment\next
7361 % swallow the left brace
7362 \let\temp =
7364 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
7365 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
7367 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
7369 \def\placesaveins#1{%
7370 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
7371 {\box#1}%
7374 % eat @SAVE -- beware, all of them have catcode \other:
7376 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
7377 \gdef\gobblesave @SAVE{}
7380 % initialization:
7381 \def\newsaveins #1{%
7382 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
7383 \next
7385 \def\newsaveinsX #1{%
7386 \csname newbox\endcsname #1%
7387 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7388 \checksaveins #1}%
7391 % initialize:
7392 \let\checkinserts\empty
7393 \newsaveins\footins
7394 \newsaveins\margin
7397 % @image. We use the macros from epsf.tex to support this.
7398 % If epsf.tex is not installed and @image is used, we complain.
7400 % Check for and read epsf.tex up front. If we read it only at @image
7401 % time, we might be inside a group, and then its definitions would get
7402 % undone and the next image would fail.
7403 \openin 1 = epsf.tex
7404 \ifeof 1 \else
7405 % Do not bother showing banner with epsf.tex v2.7k (available in
7406 % doc/epsf.tex and on ctan).
7407 \def\epsfannounce{\toks0 = }%
7408 \input epsf.tex
7410 \closein 1
7412 % We will only complain once about lack of epsf.tex.
7413 \newif\ifwarnednoepsf
7414 \newhelp\noepsfhelp{epsf.tex must be installed for images to
7415 work. It is also included in the Texinfo distribution, or you can get
7416 it from ftp://tug.org/tex/epsf.tex.}
7418 \def\image#1{%
7419 \ifx\epsfbox\undefined
7420 \ifwarnednoepsf \else
7421 \errhelp = \noepsfhelp
7422 \errmessage{epsf.tex not found, images will be ignored}%
7423 \global\warnednoepsftrue
7425 \else
7426 \imagexxx #1,,,,,\finish
7430 % Arguments to @image:
7431 % #1 is (mandatory) image filename; we tack on .eps extension.
7432 % #2 is (optional) width, #3 is (optional) height.
7433 % #4 is (ignored optional) html alt text.
7434 % #5 is (ignored optional) extension.
7435 % #6 is just the usual extra ignored arg for parsing this stuff.
7436 \newif\ifimagevmode
7437 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7438 \catcode`\^^M = 5 % in case we're inside an example
7439 \normalturnoffactive % allow _ et al. in names
7440 % If the image is by itself, center it.
7441 \ifvmode
7442 \imagevmodetrue
7443 \nobreak\medskip
7444 % Usually we'll have text after the image which will insert
7445 % \parskip glue, so insert it here too to equalize the space
7446 % above and below.
7447 \nobreak\vskip\parskip
7448 \nobreak
7451 % Leave vertical mode so that indentation from an enclosing
7452 % environment such as @quotation is respected. On the other hand, if
7453 % it's at the top level, we don't want the normal paragraph indentation.
7454 \noindent
7456 % Output the image.
7457 \ifpdf
7458 \dopdfimage{#1}{#2}{#3}%
7459 \else
7460 % \epsfbox itself resets \epsf?size at each figure.
7461 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
7462 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7463 \epsfbox{#1.eps}%
7466 \ifimagevmode \medskip \fi % space after the standalone image
7467 \endgroup}
7470 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7471 % etc. We don't actually implement floating yet, we always include the
7472 % float "here". But it seemed the best name for the future.
7474 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7476 % There may be a space before second and/or third parameter; delete it.
7477 \def\eatcommaspace#1, {#1,}
7479 % #1 is the optional FLOATTYPE, the text label for this float, typically
7480 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
7481 % this float will not be numbered and cannot be referred to.
7483 % #2 is the optional xref label. Also must be present for the float to
7484 % be referable.
7486 % #3 is the optional positioning argument; for now, it is ignored. It
7487 % will somehow specify the positions allowed to float to (here, top, bottom).
7489 % We keep a separate counter for each FLOATTYPE, which we reset at each
7490 % chapter-level command.
7491 \let\resetallfloatnos=\empty
7493 \def\dofloat#1,#2,#3,#4\finish{%
7494 \let\thiscaption=\empty
7495 \let\thisshortcaption=\empty
7497 % don't lose footnotes inside @float.
7499 % BEWARE: when the floats start float, we have to issue warning whenever an
7500 % insert appears inside a float which could possibly float. --kasal, 26may04
7502 \startsavinginserts
7504 % We can't be used inside a paragraph.
7505 \par
7507 \vtop\bgroup
7508 \def\floattype{#1}%
7509 \def\floatlabel{#2}%
7510 \def\floatloc{#3}% we do nothing with this yet.
7512 \ifx\floattype\empty
7513 \let\safefloattype=\empty
7514 \else
7516 % the floattype might have accents or other special characters,
7517 % but we need to use it in a control sequence name.
7518 \indexnofonts
7519 \turnoffactive
7520 \xdef\safefloattype{\floattype}%
7524 % If label is given but no type, we handle that as the empty type.
7525 \ifx\floatlabel\empty \else
7526 % We want each FLOATTYPE to be numbered separately (Figure 1,
7527 % Table 1, Figure 2, ...). (And if no label, no number.)
7529 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7530 \global\advance\floatno by 1
7533 % This magic value for \lastsection is output by \setref as the
7534 % XREFLABEL-title value. \xrefX uses it to distinguish float
7535 % labels (which have a completely different output format) from
7536 % node and anchor labels. And \xrdef uses it to construct the
7537 % lists of floats.
7539 \edef\lastsection{\floatmagic=\safefloattype}%
7540 \setref{\floatlabel}{Yfloat}%
7544 % start with \parskip glue, I guess.
7545 \vskip\parskip
7547 % Don't suppress indentation if a float happens to start a section.
7548 \restorefirstparagraphindent
7551 % we have these possibilities:
7552 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7553 % @float Foo,lbl & no caption: Foo 1.1
7554 % @float Foo & @caption{Cap}: Foo: Cap
7555 % @float Foo & no caption: Foo
7556 % @float ,lbl & Caption{Cap}: 1.1: Cap
7557 % @float ,lbl & no caption: 1.1
7558 % @float & @caption{Cap}: Cap
7559 % @float & no caption:
7561 \def\Efloat{%
7562 \let\floatident = \empty
7564 % In all cases, if we have a float type, it comes first.
7565 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7567 % If we have an xref label, the number comes next.
7568 \ifx\floatlabel\empty \else
7569 \ifx\floattype\empty \else % if also had float type, need tie first.
7570 \appendtomacro\floatident{\tie}%
7572 % the number.
7573 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
7576 % Start the printed caption with what we've constructed in
7577 % \floatident, but keep it separate; we need \floatident again.
7578 \let\captionline = \floatident
7580 \ifx\thiscaption\empty \else
7581 \ifx\floatident\empty \else
7582 \appendtomacro\captionline{: }% had ident, so need a colon between
7585 % caption text.
7586 \appendtomacro\captionline{\scanexp\thiscaption}%
7589 % If we have anything to print, print it, with space before.
7590 % Eventually this needs to become an \insert.
7591 \ifx\captionline\empty \else
7592 \vskip.5\parskip
7593 \captionline
7595 % Space below caption.
7596 \vskip\parskip
7599 % If have an xref label, write the list of floats info. Do this
7600 % after the caption, to avoid chance of it being a breakpoint.
7601 \ifx\floatlabel\empty \else
7602 % Write the text that goes in the lof to the aux file as
7603 % \floatlabel-lof. Besides \floatident, we include the short
7604 % caption if specified, else the full caption if specified, else nothing.
7606 \atdummies
7608 % since we read the caption text in the macro world, where ^^M
7609 % is turned into a normal character, we have to scan it back, so
7610 % we don't write the literal three characters "^^M" into the aux file.
7611 \scanexp{%
7612 \xdef\noexpand\gtemp{%
7613 \ifx\thisshortcaption\empty
7614 \thiscaption
7615 \else
7616 \thisshortcaption
7620 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7621 \ifx\gtemp\empty \else : \gtemp \fi}}%
7624 \egroup % end of \vtop
7626 % place the captured inserts
7628 % BEWARE: when the floats start floating, we have to issue warning
7629 % whenever an insert appears inside a float which could possibly
7630 % float. --kasal, 26may04
7632 \checkinserts
7635 % Append the tokens #2 to the definition of macro #1, not expanding either.
7637 \def\appendtomacro#1#2{%
7638 \expandafter\def\expandafter#1\expandafter{#1#2}%
7641 % @caption, @shortcaption
7643 \def\caption{\docaption\thiscaption}
7644 \def\shortcaption{\docaption\thisshortcaption}
7645 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7646 \def\defcaption#1#2{\egroup \def#1{#2}}
7648 % The parameter is the control sequence identifying the counter we are
7649 % going to use. Create it if it doesn't exist and assign it to \floatno.
7650 \def\getfloatno#1{%
7651 \ifx#1\relax
7652 % Haven't seen this figure type before.
7653 \csname newcount\endcsname #1%
7655 % Remember to reset this floatno at the next chap.
7656 \expandafter\gdef\expandafter\resetallfloatnos
7657 \expandafter{\resetallfloatnos #1=0 }%
7659 \let\floatno#1%
7662 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
7663 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
7664 % first read the @float command.
7666 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7668 % Magic string used for the XREFLABEL-title value, so \xrefX can
7669 % distinguish floats from other xref types.
7670 \def\floatmagic{!!float!!}
7672 % #1 is the control sequence we are passed; we expand into a conditional
7673 % which is true if #1 represents a float ref. That is, the magic
7674 % \lastsection value which we \setref above.
7676 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7678 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
7679 % (safe) float type for this float. We set \iffloattype to #2.
7681 \def\doiffloat#1=#2=#3\finish{%
7682 \def\temp{#1}%
7683 \def\iffloattype{#2}%
7684 \ifx\temp\floatmagic
7687 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7689 \parseargdef\listoffloats{%
7690 \def\floattype{#1}% floattype
7692 % the floattype might have accents or other special characters,
7693 % but we need to use it in a control sequence name.
7694 \indexnofonts
7695 \turnoffactive
7696 \xdef\safefloattype{\floattype}%
7699 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7700 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7701 \ifhavexrefs
7702 % if the user said @listoffloats foo but never @float foo.
7703 \message{\linenumber No `\safefloattype' floats to list.}%
7705 \else
7706 \begingroup
7707 \leftskip=\tocindent % indent these entries like a toc
7708 \let\do=\listoffloatsdo
7709 \csname floatlist\safefloattype\endcsname
7710 \endgroup
7714 % This is called on each entry in a list of floats. We're passed the
7715 % xref label, in the form LABEL-title, which is how we save it in the
7716 % aux file. We strip off the -title and look up \XRLABEL-lof, which
7717 % has the text we're supposed to typeset here.
7719 % Figures without xref labels will not be included in the list (since
7720 % they won't appear in the aux file).
7722 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7723 \def\listoffloatsdoentry#1-title\finish{{%
7724 % Can't fully expand XR#1-lof because it can contain anything. Just
7725 % pass the control sequence. On the other hand, XR#1-pg is just the
7726 % page number, and we want to fully expand that so we can get a link
7727 % in pdf output.
7728 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
7730 % use the same \entry macro we use to generate the TOC and index.
7731 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7732 \writeentry
7736 \message{localization,}
7738 % @documentlanguage is usually given very early, just after
7739 % @setfilename. If done too late, it may not override everything
7740 % properly. Single argument is the language (de) or locale (de_DE)
7741 % abbreviation. It would be nice if we could set up a hyphenation file.
7744 \catcode`\_ = \active
7745 \globaldefs=1
7746 \parseargdef\documentlanguage{\begingroup
7747 \let_=\normalunderscore % normal _ character for filenames
7748 \tex % read txi-??.tex file in plain TeX.
7749 % Read the file by the name they passed if it exists.
7750 \openin 1 txi-#1.tex
7751 \ifeof 1
7752 \documentlanguagetrywithoutunderscore{#1_\finish}%
7753 \else
7754 \input txi-#1.tex
7756 \closein 1
7757 \endgroup
7758 \endgroup}
7761 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
7762 % try txi-de.tex.
7764 \def\documentlanguagetrywithoutunderscore#1_#2\finish{%
7765 \openin 1 txi-#1.tex
7766 \ifeof 1
7767 \errhelp = \nolanghelp
7768 \errmessage{Cannot read language file txi-#1.tex}%
7769 \else
7770 \input txi-#1.tex
7772 \closein 1
7775 \newhelp\nolanghelp{The given language definition file cannot be found or
7776 is empty. Maybe you need to install it? In the current directory
7777 should work if nowhere else does.}
7779 % Set the catcode of characters 128 through 255 to the specified number.
7781 \def\setnonasciicharscatcode#1{%
7782 \count255=128
7783 \loop\ifnum\count255<256
7784 \global\catcode\count255=#1\relax
7785 \advance\count255 by 1
7786 \repeat
7789 \def\setnonasciicharscatcodenonglobal#1{%
7790 \count255=128
7791 \loop\ifnum\count255<256
7792 \catcode\count255=#1\relax
7793 \advance\count255 by 1
7794 \repeat
7797 % @documentencoding sets the definition of non-ASCII characters
7798 % according to the specified encoding.
7800 \parseargdef\documentencoding{%
7801 % Encoding being declared for the document.
7802 \def\declaredencoding{\csname #1.enc\endcsname}%
7804 % Supported encodings: names converted to tokens in order to be able
7805 % to compare them with \ifx.
7806 \def\ascii{\csname US-ASCII.enc\endcsname}%
7807 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
7808 \def\latone{\csname ISO-8859-1.enc\endcsname}%
7809 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
7810 \def\utfeight{\csname UTF-8.enc\endcsname}%
7812 \ifx \declaredencoding \ascii
7813 \asciichardefs
7815 \else \ifx \declaredencoding \lattwo
7816 \setnonasciicharscatcode\active
7817 \lattwochardefs
7819 \else \ifx \declaredencoding \latone
7820 \setnonasciicharscatcode\active
7821 \latonechardefs
7823 \else \ifx \declaredencoding \latnine
7824 \setnonasciicharscatcode\active
7825 \latninechardefs
7827 \else \ifx \declaredencoding \utfeight
7828 \setnonasciicharscatcode\active
7829 \utfeightchardefs
7831 \else
7832 \message{Unknown document encoding #1, ignoring.}%
7834 \fi % utfeight
7835 \fi % latnine
7836 \fi % latone
7837 \fi % lattwo
7838 \fi % ascii
7841 % A message to be logged when using a character that isn't available
7842 % the default font encoding (OT1).
7844 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
7846 % Take account of \c (plain) vs. \, (Texinfo) difference.
7847 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
7849 % First, make active non-ASCII characters in order for them to be
7850 % correctly categorized when TeX reads the replacement text of
7851 % macros containing the character definitions.
7852 \setnonasciicharscatcode\active
7854 % Latin1 (ISO-8859-1) character definitions.
7855 \def\latonechardefs{%
7856 \gdef^^a0{~}
7857 \gdef^^a1{\exclamdown}
7858 \gdef^^a2{\missingcharmsg{CENT SIGN}}
7859 \gdef^^a3{{\pounds}}
7860 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7861 \gdef^^a5{\missingcharmsg{YEN SIGN}}
7862 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
7863 \gdef^^a7{\S}
7864 \gdef^^a8{\"{}}
7865 \gdef^^a9{\copyright}
7866 \gdef^^aa{\ordf}
7867 \gdef^^ab{\missingcharmsg{LEFT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7868 \gdef^^ac{$\lnot$}
7869 \gdef^^ad{\-}
7870 \gdef^^ae{\registeredsymbol}
7871 \gdef^^af{\={}}
7873 \gdef^^b0{\textdegree}
7874 \gdef^^b1{$\pm$}
7875 \gdef^^b2{$^2$}
7876 \gdef^^b3{$^3$}
7877 \gdef^^b4{\'{}}
7878 \gdef^^b5{$\mu$}
7879 \gdef^^b6{\P}
7881 \gdef^^b7{$^.$}
7882 \gdef^^b8{\cedilla\ }
7883 \gdef^^b9{$^1$}
7884 \gdef^^ba{\ordm}
7886 \gdef^^bb{\missingcharmsg{RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7887 \gdef^^bc{$1\over4$}
7888 \gdef^^bd{$1\over2$}
7889 \gdef^^be{$3\over4$}
7890 \gdef^^bf{\questiondown}
7892 \gdef^^c0{\`A}
7893 \gdef^^c1{\'A}
7894 \gdef^^c2{\^A}
7895 \gdef^^c3{\~A}
7896 \gdef^^c4{\"A}
7897 \gdef^^c5{\ringaccent A}
7898 \gdef^^c6{\AE}
7899 \gdef^^c7{\cedilla C}
7900 \gdef^^c8{\`E}
7901 \gdef^^c9{\'E}
7902 \gdef^^ca{\^E}
7903 \gdef^^cb{\"E}
7904 \gdef^^cc{\`I}
7905 \gdef^^cd{\'I}
7906 \gdef^^ce{\^I}
7907 \gdef^^cf{\"I}
7909 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER ETH}}
7910 \gdef^^d1{\~N}
7911 \gdef^^d2{\`O}
7912 \gdef^^d3{\'O}
7913 \gdef^^d4{\^O}
7914 \gdef^^d5{\~O}
7915 \gdef^^d6{\"O}
7916 \gdef^^d7{$\times$}
7917 \gdef^^d8{\O}
7918 \gdef^^d9{\`U}
7919 \gdef^^da{\'U}
7920 \gdef^^db{\^U}
7921 \gdef^^dc{\"U}
7922 \gdef^^dd{\'Y}
7923 \gdef^^de{\missingcharmsg{LATIN CAPITAL LETTER THORN}}
7924 \gdef^^df{\ss}
7926 \gdef^^e0{\`a}
7927 \gdef^^e1{\'a}
7928 \gdef^^e2{\^a}
7929 \gdef^^e3{\~a}
7930 \gdef^^e4{\"a}
7931 \gdef^^e5{\ringaccent a}
7932 \gdef^^e6{\ae}
7933 \gdef^^e7{\cedilla c}
7934 \gdef^^e8{\`e}
7935 \gdef^^e9{\'e}
7936 \gdef^^ea{\^e}
7937 \gdef^^eb{\"e}
7938 \gdef^^ec{\`{\dotless i}}
7939 \gdef^^ed{\'{\dotless i}}
7940 \gdef^^ee{\^{\dotless i}}
7941 \gdef^^ef{\"{\dotless i}}
7943 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER ETH}}
7944 \gdef^^f1{\~n}
7945 \gdef^^f2{\`o}
7946 \gdef^^f3{\'o}
7947 \gdef^^f4{\^o}
7948 \gdef^^f5{\~o}
7949 \gdef^^f6{\"o}
7950 \gdef^^f7{$\div$}
7951 \gdef^^f8{\o}
7952 \gdef^^f9{\`u}
7953 \gdef^^fa{\'u}
7954 \gdef^^fb{\^u}
7955 \gdef^^fc{\"u}
7956 \gdef^^fd{\'y}
7957 \gdef^^fe{\missingcharmsg{LATIN SMALL LETTER THORN}}
7958 \gdef^^ff{\"y}
7961 % Latin9 (ISO-8859-15) encoding character definitions.
7962 \def\latninechardefs{%
7963 % Encoding is almost identical to Latin1.
7964 \latonechardefs
7966 \gdef^^a4{\euro}
7967 \gdef^^a6{\v S}
7968 \gdef^^a8{\v s}
7969 \gdef^^b4{\v Z}
7970 \gdef^^b8{\v z}
7971 \gdef^^bc{\OE}
7972 \gdef^^bd{\oe}
7973 \gdef^^be{\"Y}
7976 % Latin2 (ISO-8859-2) character definitions.
7977 \def\lattwochardefs{%
7978 \gdef^^a0{~}
7979 \gdef^^a1{\missingcharmsg{LATIN CAPITAL LETTER A WITH OGONEK}}
7980 \gdef^^a2{\u{}}
7981 \gdef^^a3{\L}
7982 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7983 \gdef^^a5{\v L}
7984 \gdef^^a6{\'S}
7985 \gdef^^a7{\S}
7986 \gdef^^a8{\"{}}
7987 \gdef^^a9{\v S}
7988 \gdef^^aa{\cedilla S}
7989 \gdef^^ab{\v T}
7990 \gdef^^ac{\'Z}
7991 \gdef^^ad{\-}
7992 \gdef^^ae{\v Z}
7993 \gdef^^af{\dotaccent Z}
7995 \gdef^^b0{\textdegree}
7996 \gdef^^b1{\missingcharmsg{LATIN SMALL LETTER A WITH OGONEK}}
7997 \gdef^^b2{\missingcharmsg{OGONEK}}
7998 \gdef^^b3{\l}
7999 \gdef^^b4{\'{}}
8000 \gdef^^b5{\v l}
8001 \gdef^^b6{\'s}
8002 \gdef^^b7{\v{}}
8003 \gdef^^b8{\cedilla\ }
8004 \gdef^^b9{\v s}
8005 \gdef^^ba{\cedilla s}
8006 \gdef^^bb{\v t}
8007 \gdef^^bc{\'z}
8008 \gdef^^bd{\H{}}
8009 \gdef^^be{\v z}
8010 \gdef^^bf{\dotaccent z}
8012 \gdef^^c0{\'R}
8013 \gdef^^c1{\'A}
8014 \gdef^^c2{\^A}
8015 \gdef^^c3{\u A}
8016 \gdef^^c4{\"A}
8017 \gdef^^c5{\'L}
8018 \gdef^^c6{\'C}
8019 \gdef^^c7{\cedilla C}
8020 \gdef^^c8{\v C}
8021 \gdef^^c9{\'E}
8022 \gdef^^ca{\missingcharmsg{LATIN CAPITAL LETTER E WITH OGONEK}}
8023 \gdef^^cb{\"E}
8024 \gdef^^cc{\v E}
8025 \gdef^^cd{\'I}
8026 \gdef^^ce{\^I}
8027 \gdef^^cf{\v D}
8029 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER D WITH STROKE}}
8030 \gdef^^d1{\'N}
8031 \gdef^^d2{\v N}
8032 \gdef^^d3{\'O}
8033 \gdef^^d4{\^O}
8034 \gdef^^d5{\H O}
8035 \gdef^^d6{\"O}
8036 \gdef^^d7{$\times$}
8037 \gdef^^d8{\v R}
8038 \gdef^^d9{\ringaccent U}
8039 \gdef^^da{\'U}
8040 \gdef^^db{\H U}
8041 \gdef^^dc{\"U}
8042 \gdef^^dd{\'Y}
8043 \gdef^^de{\cedilla T}
8044 \gdef^^df{\ss}
8046 \gdef^^e0{\'r}
8047 \gdef^^e1{\'a}
8048 \gdef^^e2{\^a}
8049 \gdef^^e3{\u a}
8050 \gdef^^e4{\"a}
8051 \gdef^^e5{\'l}
8052 \gdef^^e6{\'c}
8053 \gdef^^e7{\cedilla c}
8054 \gdef^^e8{\v c}
8055 \gdef^^e9{\'e}
8056 \gdef^^ea{\missingcharmsg{LATIN SMALL LETTER E WITH OGONEK}}
8057 \gdef^^eb{\"e}
8058 \gdef^^ec{\v e}
8059 \gdef^^ed{\'\i}
8060 \gdef^^ee{\^\i}
8061 \gdef^^ef{\v d}
8063 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER D WITH STROKE}}
8064 \gdef^^f1{\'n}
8065 \gdef^^f2{\v n}
8066 \gdef^^f3{\'o}
8067 \gdef^^f4{\^o}
8068 \gdef^^f5{\H o}
8069 \gdef^^f6{\"o}
8070 \gdef^^f7{$\div$}
8071 \gdef^^f8{\v r}
8072 \gdef^^f9{\ringaccent u}
8073 \gdef^^fa{\'u}
8074 \gdef^^fb{\H u}
8075 \gdef^^fc{\"u}
8076 \gdef^^fd{\'y}
8077 \gdef^^fe{\cedilla t}
8078 \gdef^^ff{\dotaccent{}}
8081 % UTF-8 character definitions.
8083 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8084 % changes for Texinfo conventions. It is included here under the GPL by
8085 % permission from Frank Mittelbach and the LaTeX team.
8087 \newcount\countUTFx
8088 \newcount\countUTFy
8089 \newcount\countUTFz
8091 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8092 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8094 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8095 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8097 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8098 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8100 \gdef\UTFviiiDefined#1{%
8101 \ifx #1\relax
8102 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8103 \else
8104 \expandafter #1%
8108 \begingroup
8109 \catcode`\~13
8110 \catcode`\"12
8112 \def\UTFviiiLoop{%
8113 \global\catcode\countUTFx\active
8114 \uccode`\~\countUTFx
8115 \uppercase\expandafter{\UTFviiiTmp}%
8116 \advance\countUTFx by 1
8117 \ifnum\countUTFx < \countUTFy
8118 \expandafter\UTFviiiLoop
8119 \fi}
8121 \countUTFx = "C2
8122 \countUTFy = "E0
8123 \def\UTFviiiTmp{%
8124 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
8125 \UTFviiiLoop
8127 \countUTFx = "E0
8128 \countUTFy = "F0
8129 \def\UTFviiiTmp{%
8130 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
8131 \UTFviiiLoop
8133 \countUTFx = "F0
8134 \countUTFy = "F4
8135 \def\UTFviiiTmp{%
8136 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
8137 \UTFviiiLoop
8138 \endgroup
8140 \begingroup
8141 \catcode`\"=12
8142 \catcode`\<=12
8143 \catcode`\.=12
8144 \catcode`\,=12
8145 \catcode`\;=12
8146 \catcode`\!=12
8147 \catcode`\~=13
8149 \gdef\DeclareUnicodeCharacter#1#2{%
8150 \countUTFz = "#1\relax
8151 \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
8152 \begingroup
8153 \parseXMLCharref
8154 \def\UTFviiiTwoOctets##1##2{%
8155 \csname u8:##1\string ##2\endcsname}%
8156 \def\UTFviiiThreeOctets##1##2##3{%
8157 \csname u8:##1\string ##2\string ##3\endcsname}%
8158 \def\UTFviiiFourOctets##1##2##3##4{%
8159 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
8160 \expandafter\expandafter\expandafter\expandafter
8161 \expandafter\expandafter\expandafter
8162 \gdef\UTFviiiTmp{#2}%
8163 \endgroup}
8165 \gdef\parseXMLCharref{%
8166 \ifnum\countUTFz < "A0\relax
8167 \errhelp = \EMsimple
8168 \errmessage{Cannot define Unicode char value < 00A0}%
8169 \else\ifnum\countUTFz < "800\relax
8170 \parseUTFviiiA,%
8171 \parseUTFviiiB C\UTFviiiTwoOctets.,%
8172 \else\ifnum\countUTFz < "10000\relax
8173 \parseUTFviiiA;%
8174 \parseUTFviiiA,%
8175 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
8176 \else
8177 \parseUTFviiiA;%
8178 \parseUTFviiiA,%
8179 \parseUTFviiiA!%
8180 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
8181 \fi\fi\fi
8184 \gdef\parseUTFviiiA#1{%
8185 \countUTFx = \countUTFz
8186 \divide\countUTFz by 64
8187 \countUTFy = \countUTFz
8188 \multiply\countUTFz by 64
8189 \advance\countUTFx by -\countUTFz
8190 \advance\countUTFx by 128
8191 \uccode `#1\countUTFx
8192 \countUTFz = \countUTFy}
8194 \gdef\parseUTFviiiB#1#2#3#4{%
8195 \advance\countUTFz by "#10\relax
8196 \uccode `#3\countUTFz
8197 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
8198 \endgroup
8200 \def\utfeightchardefs{%
8201 \DeclareUnicodeCharacter{00A0}{\tie}
8202 \DeclareUnicodeCharacter{00A1}{\exclamdown}
8203 \DeclareUnicodeCharacter{00A3}{\pounds}
8204 \DeclareUnicodeCharacter{00A8}{\"{ }}
8205 \DeclareUnicodeCharacter{00A9}{\copyright}
8206 \DeclareUnicodeCharacter{00AA}{\ordf}
8207 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
8208 \DeclareUnicodeCharacter{00AD}{\-}
8209 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
8210 \DeclareUnicodeCharacter{00AF}{\={ }}
8212 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
8213 \DeclareUnicodeCharacter{00B4}{\'{ }}
8214 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
8215 \DeclareUnicodeCharacter{00BA}{\ordm}
8216 \DeclareUnicodeCharacter{00BB}{\guillemetright}
8217 \DeclareUnicodeCharacter{00BF}{\questiondown}
8219 \DeclareUnicodeCharacter{00C0}{\`A}
8220 \DeclareUnicodeCharacter{00C1}{\'A}
8221 \DeclareUnicodeCharacter{00C2}{\^A}
8222 \DeclareUnicodeCharacter{00C3}{\~A}
8223 \DeclareUnicodeCharacter{00C4}{\"A}
8224 \DeclareUnicodeCharacter{00C5}{\AA}
8225 \DeclareUnicodeCharacter{00C6}{\AE}
8226 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
8227 \DeclareUnicodeCharacter{00C8}{\`E}
8228 \DeclareUnicodeCharacter{00C9}{\'E}
8229 \DeclareUnicodeCharacter{00CA}{\^E}
8230 \DeclareUnicodeCharacter{00CB}{\"E}
8231 \DeclareUnicodeCharacter{00CC}{\`I}
8232 \DeclareUnicodeCharacter{00CD}{\'I}
8233 \DeclareUnicodeCharacter{00CE}{\^I}
8234 \DeclareUnicodeCharacter{00CF}{\"I}
8236 \DeclareUnicodeCharacter{00D1}{\~N}
8237 \DeclareUnicodeCharacter{00D2}{\`O}
8238 \DeclareUnicodeCharacter{00D3}{\'O}
8239 \DeclareUnicodeCharacter{00D4}{\^O}
8240 \DeclareUnicodeCharacter{00D5}{\~O}
8241 \DeclareUnicodeCharacter{00D6}{\"O}
8242 \DeclareUnicodeCharacter{00D8}{\O}
8243 \DeclareUnicodeCharacter{00D9}{\`U}
8244 \DeclareUnicodeCharacter{00DA}{\'U}
8245 \DeclareUnicodeCharacter{00DB}{\^U}
8246 \DeclareUnicodeCharacter{00DC}{\"U}
8247 \DeclareUnicodeCharacter{00DD}{\'Y}
8248 \DeclareUnicodeCharacter{00DF}{\ss}
8250 \DeclareUnicodeCharacter{00E0}{\`a}
8251 \DeclareUnicodeCharacter{00E1}{\'a}
8252 \DeclareUnicodeCharacter{00E2}{\^a}
8253 \DeclareUnicodeCharacter{00E3}{\~a}
8254 \DeclareUnicodeCharacter{00E4}{\"a}
8255 \DeclareUnicodeCharacter{00E5}{\aa}
8256 \DeclareUnicodeCharacter{00E6}{\ae}
8257 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
8258 \DeclareUnicodeCharacter{00E8}{\`e}
8259 \DeclareUnicodeCharacter{00E9}{\'e}
8260 \DeclareUnicodeCharacter{00EA}{\^e}
8261 \DeclareUnicodeCharacter{00EB}{\"e}
8262 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
8263 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
8264 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
8265 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
8267 \DeclareUnicodeCharacter{00F1}{\~n}
8268 \DeclareUnicodeCharacter{00F2}{\`o}
8269 \DeclareUnicodeCharacter{00F3}{\'o}
8270 \DeclareUnicodeCharacter{00F4}{\^o}
8271 \DeclareUnicodeCharacter{00F5}{\~o}
8272 \DeclareUnicodeCharacter{00F6}{\"o}
8273 \DeclareUnicodeCharacter{00F8}{\o}
8274 \DeclareUnicodeCharacter{00F9}{\`u}
8275 \DeclareUnicodeCharacter{00FA}{\'u}
8276 \DeclareUnicodeCharacter{00FB}{\^u}
8277 \DeclareUnicodeCharacter{00FC}{\"u}
8278 \DeclareUnicodeCharacter{00FD}{\'y}
8279 \DeclareUnicodeCharacter{00FF}{\"y}
8281 \DeclareUnicodeCharacter{0100}{\=A}
8282 \DeclareUnicodeCharacter{0101}{\=a}
8283 \DeclareUnicodeCharacter{0102}{\u{A}}
8284 \DeclareUnicodeCharacter{0103}{\u{a}}
8285 \DeclareUnicodeCharacter{0106}{\'C}
8286 \DeclareUnicodeCharacter{0107}{\'c}
8287 \DeclareUnicodeCharacter{0108}{\^C}
8288 \DeclareUnicodeCharacter{0109}{\^c}
8289 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
8290 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
8291 \DeclareUnicodeCharacter{010C}{\v{C}}
8292 \DeclareUnicodeCharacter{010D}{\v{c}}
8293 \DeclareUnicodeCharacter{010E}{\v{D}}
8295 \DeclareUnicodeCharacter{0112}{\=E}
8296 \DeclareUnicodeCharacter{0113}{\=e}
8297 \DeclareUnicodeCharacter{0114}{\u{E}}
8298 \DeclareUnicodeCharacter{0115}{\u{e}}
8299 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
8300 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
8301 \DeclareUnicodeCharacter{011A}{\v{E}}
8302 \DeclareUnicodeCharacter{011B}{\v{e}}
8303 \DeclareUnicodeCharacter{011C}{\^G}
8304 \DeclareUnicodeCharacter{011D}{\^g}
8305 \DeclareUnicodeCharacter{011E}{\u{G}}
8306 \DeclareUnicodeCharacter{011F}{\u{g}}
8308 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8309 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8310 \DeclareUnicodeCharacter{0124}{\^H}
8311 \DeclareUnicodeCharacter{0125}{\^h}
8312 \DeclareUnicodeCharacter{0128}{\~I}
8313 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8314 \DeclareUnicodeCharacter{012A}{\=I}
8315 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8316 \DeclareUnicodeCharacter{012C}{\u{I}}
8317 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8319 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8320 \DeclareUnicodeCharacter{0131}{\dotless{i}}
8321 \DeclareUnicodeCharacter{0132}{IJ}
8322 \DeclareUnicodeCharacter{0133}{ij}
8323 \DeclareUnicodeCharacter{0134}{\^J}
8324 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8325 \DeclareUnicodeCharacter{0139}{\'L}
8326 \DeclareUnicodeCharacter{013A}{\'l}
8328 \DeclareUnicodeCharacter{0141}{\L}
8329 \DeclareUnicodeCharacter{0142}{\l}
8330 \DeclareUnicodeCharacter{0143}{\'N}
8331 \DeclareUnicodeCharacter{0144}{\'n}
8332 \DeclareUnicodeCharacter{0147}{\v{N}}
8333 \DeclareUnicodeCharacter{0148}{\v{n}}
8334 \DeclareUnicodeCharacter{014C}{\=O}
8335 \DeclareUnicodeCharacter{014D}{\=o}
8336 \DeclareUnicodeCharacter{014E}{\u{O}}
8337 \DeclareUnicodeCharacter{014F}{\u{o}}
8339 \DeclareUnicodeCharacter{0150}{\H{O}}
8340 \DeclareUnicodeCharacter{0151}{\H{o}}
8341 \DeclareUnicodeCharacter{0152}{\OE}
8342 \DeclareUnicodeCharacter{0153}{\oe}
8343 \DeclareUnicodeCharacter{0154}{\'R}
8344 \DeclareUnicodeCharacter{0155}{\'r}
8345 \DeclareUnicodeCharacter{0158}{\v{R}}
8346 \DeclareUnicodeCharacter{0159}{\v{r}}
8347 \DeclareUnicodeCharacter{015A}{\'S}
8348 \DeclareUnicodeCharacter{015B}{\'s}
8349 \DeclareUnicodeCharacter{015C}{\^S}
8350 \DeclareUnicodeCharacter{015D}{\^s}
8351 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8352 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8354 \DeclareUnicodeCharacter{0160}{\v{S}}
8355 \DeclareUnicodeCharacter{0161}{\v{s}}
8356 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8357 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8358 \DeclareUnicodeCharacter{0164}{\v{T}}
8360 \DeclareUnicodeCharacter{0168}{\~U}
8361 \DeclareUnicodeCharacter{0169}{\~u}
8362 \DeclareUnicodeCharacter{016A}{\=U}
8363 \DeclareUnicodeCharacter{016B}{\=u}
8364 \DeclareUnicodeCharacter{016C}{\u{U}}
8365 \DeclareUnicodeCharacter{016D}{\u{u}}
8366 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8367 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8369 \DeclareUnicodeCharacter{0170}{\H{U}}
8370 \DeclareUnicodeCharacter{0171}{\H{u}}
8371 \DeclareUnicodeCharacter{0174}{\^W}
8372 \DeclareUnicodeCharacter{0175}{\^w}
8373 \DeclareUnicodeCharacter{0176}{\^Y}
8374 \DeclareUnicodeCharacter{0177}{\^y}
8375 \DeclareUnicodeCharacter{0178}{\"Y}
8376 \DeclareUnicodeCharacter{0179}{\'Z}
8377 \DeclareUnicodeCharacter{017A}{\'z}
8378 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8379 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8380 \DeclareUnicodeCharacter{017D}{\v{Z}}
8381 \DeclareUnicodeCharacter{017E}{\v{z}}
8383 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8384 \DeclareUnicodeCharacter{01C5}{D\v{z}}
8385 \DeclareUnicodeCharacter{01C6}{d\v{z}}
8386 \DeclareUnicodeCharacter{01C7}{LJ}
8387 \DeclareUnicodeCharacter{01C8}{Lj}
8388 \DeclareUnicodeCharacter{01C9}{lj}
8389 \DeclareUnicodeCharacter{01CA}{NJ}
8390 \DeclareUnicodeCharacter{01CB}{Nj}
8391 \DeclareUnicodeCharacter{01CC}{nj}
8392 \DeclareUnicodeCharacter{01CD}{\v{A}}
8393 \DeclareUnicodeCharacter{01CE}{\v{a}}
8394 \DeclareUnicodeCharacter{01CF}{\v{I}}
8396 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8397 \DeclareUnicodeCharacter{01D1}{\v{O}}
8398 \DeclareUnicodeCharacter{01D2}{\v{o}}
8399 \DeclareUnicodeCharacter{01D3}{\v{U}}
8400 \DeclareUnicodeCharacter{01D4}{\v{u}}
8402 \DeclareUnicodeCharacter{01E2}{\={\AE}}
8403 \DeclareUnicodeCharacter{01E3}{\={\ae}}
8404 \DeclareUnicodeCharacter{01E6}{\v{G}}
8405 \DeclareUnicodeCharacter{01E7}{\v{g}}
8406 \DeclareUnicodeCharacter{01E8}{\v{K}}
8407 \DeclareUnicodeCharacter{01E9}{\v{k}}
8409 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8410 \DeclareUnicodeCharacter{01F1}{DZ}
8411 \DeclareUnicodeCharacter{01F2}{Dz}
8412 \DeclareUnicodeCharacter{01F3}{dz}
8413 \DeclareUnicodeCharacter{01F4}{\'G}
8414 \DeclareUnicodeCharacter{01F5}{\'g}
8415 \DeclareUnicodeCharacter{01F8}{\`N}
8416 \DeclareUnicodeCharacter{01F9}{\`n}
8417 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8418 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8419 \DeclareUnicodeCharacter{01FE}{\'{\O}}
8420 \DeclareUnicodeCharacter{01FF}{\'{\o}}
8422 \DeclareUnicodeCharacter{021E}{\v{H}}
8423 \DeclareUnicodeCharacter{021F}{\v{h}}
8425 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8426 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8427 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8428 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8429 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8430 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8432 \DeclareUnicodeCharacter{0232}{\=Y}
8433 \DeclareUnicodeCharacter{0233}{\=y}
8434 \DeclareUnicodeCharacter{0237}{\dotless{j}}
8436 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8437 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8438 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8439 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8440 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8441 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8442 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8443 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8444 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8445 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8446 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8447 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8449 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8450 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8452 \DeclareUnicodeCharacter{1E20}{\=G}
8453 \DeclareUnicodeCharacter{1E21}{\=g}
8454 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8455 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8456 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8457 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8458 \DeclareUnicodeCharacter{1E26}{\"H}
8459 \DeclareUnicodeCharacter{1E27}{\"h}
8461 \DeclareUnicodeCharacter{1E30}{\'K}
8462 \DeclareUnicodeCharacter{1E31}{\'k}
8463 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8464 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8465 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8466 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8467 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8468 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8469 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8470 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8471 \DeclareUnicodeCharacter{1E3E}{\'M}
8472 \DeclareUnicodeCharacter{1E3F}{\'m}
8474 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8475 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8476 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8477 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8478 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8479 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8480 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8481 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8482 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8483 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8485 \DeclareUnicodeCharacter{1E54}{\'P}
8486 \DeclareUnicodeCharacter{1E55}{\'p}
8487 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8488 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8489 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8490 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8491 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8492 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8493 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8494 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8496 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8497 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8498 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8499 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8500 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8501 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8502 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8503 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8504 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8505 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8507 \DeclareUnicodeCharacter{1E7C}{\~V}
8508 \DeclareUnicodeCharacter{1E7D}{\~v}
8509 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8510 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8512 \DeclareUnicodeCharacter{1E80}{\`W}
8513 \DeclareUnicodeCharacter{1E81}{\`w}
8514 \DeclareUnicodeCharacter{1E82}{\'W}
8515 \DeclareUnicodeCharacter{1E83}{\'w}
8516 \DeclareUnicodeCharacter{1E84}{\"W}
8517 \DeclareUnicodeCharacter{1E85}{\"w}
8518 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8519 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8520 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8521 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8522 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8523 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8524 \DeclareUnicodeCharacter{1E8C}{\"X}
8525 \DeclareUnicodeCharacter{1E8D}{\"x}
8526 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8527 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8529 \DeclareUnicodeCharacter{1E90}{\^Z}
8530 \DeclareUnicodeCharacter{1E91}{\^z}
8531 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8532 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8533 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
8534 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
8535 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
8536 \DeclareUnicodeCharacter{1E97}{\"t}
8537 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
8538 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
8540 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
8541 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
8543 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
8544 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
8545 \DeclareUnicodeCharacter{1EBC}{\~E}
8546 \DeclareUnicodeCharacter{1EBD}{\~e}
8548 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
8549 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
8550 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
8551 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
8553 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
8554 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
8556 \DeclareUnicodeCharacter{1EF2}{\`Y}
8557 \DeclareUnicodeCharacter{1EF3}{\`y}
8558 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
8560 \DeclareUnicodeCharacter{1EF8}{\~Y}
8561 \DeclareUnicodeCharacter{1EF9}{\~y}
8563 \DeclareUnicodeCharacter{2013}{--}
8564 \DeclareUnicodeCharacter{2014}{---}
8565 \DeclareUnicodeCharacter{2018}{\quoteleft}
8566 \DeclareUnicodeCharacter{2019}{\quoteright}
8567 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
8568 \DeclareUnicodeCharacter{201C}{\quotedblleft}
8569 \DeclareUnicodeCharacter{201D}{\quotedblright}
8570 \DeclareUnicodeCharacter{201E}{\quotedblbase}
8571 \DeclareUnicodeCharacter{2022}{\bullet}
8572 \DeclareUnicodeCharacter{2026}{\dots}
8573 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
8574 \DeclareUnicodeCharacter{203A}{\guilsinglright}
8575 \DeclareUnicodeCharacter{20AC}{\euro}
8577 \DeclareUnicodeCharacter{2192}{\expansion}
8578 \DeclareUnicodeCharacter{21D2}{\result}
8580 \DeclareUnicodeCharacter{2212}{\minus}
8581 \DeclareUnicodeCharacter{2217}{\point}
8582 \DeclareUnicodeCharacter{2261}{\equiv}
8583 }% end of \utfeightchardefs
8586 % US-ASCII character definitions.
8587 \def\asciichardefs{% nothing need be done
8588 \relax
8591 % Make non-ASCII characters printable again for compatibility with
8592 % existing Texinfo documents that may use them, even without declaring a
8593 % document encoding.
8595 \setnonasciicharscatcode \other
8598 \message{formatting,}
8600 \newdimen\defaultparindent \defaultparindent = 15pt
8602 \chapheadingskip = 15pt plus 4pt minus 2pt
8603 \secheadingskip = 12pt plus 3pt minus 2pt
8604 \subsecheadingskip = 9pt plus 2pt minus 2pt
8606 % Prevent underfull vbox error messages.
8607 \vbadness = 10000
8609 % Don't be so finicky about underfull hboxes, either.
8610 \hbadness = 2000
8612 % Following George Bush, get rid of widows and orphans.
8613 \widowpenalty=10000
8614 \clubpenalty=10000
8616 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
8617 % using an old version of TeX, don't do anything. We want the amount of
8618 % stretch added to depend on the line length, hence the dependence on
8619 % \hsize. We call this whenever the paper size is set.
8621 \def\setemergencystretch{%
8622 \ifx\emergencystretch\thisisundefined
8623 % Allow us to assign to \emergencystretch anyway.
8624 \def\emergencystretch{\dimen0}%
8625 \else
8626 \emergencystretch = .15\hsize
8630 % Parameters in order: 1) textheight; 2) textwidth;
8631 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
8632 % 7) physical page height; 8) physical page width.
8634 % We also call \setleading{\textleading}, so the caller should define
8635 % \textleading. The caller should also set \parskip.
8637 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
8638 \voffset = #3\relax
8639 \topskip = #6\relax
8640 \splittopskip = \topskip
8642 \vsize = #1\relax
8643 \advance\vsize by \topskip
8644 \outervsize = \vsize
8645 \advance\outervsize by 2\topandbottommargin
8646 \pageheight = \vsize
8648 \hsize = #2\relax
8649 \outerhsize = \hsize
8650 \advance\outerhsize by 0.5in
8651 \pagewidth = \hsize
8653 \normaloffset = #4\relax
8654 \bindingoffset = #5\relax
8656 \ifpdf
8657 \pdfpageheight #7\relax
8658 \pdfpagewidth #8\relax
8659 % if we don't reset these, they will remain at "1 true in" of
8660 % whatever layout pdftex was dumped with.
8661 \pdfhorigin = 1 true in
8662 \pdfvorigin = 1 true in
8665 \setleading{\textleading}
8667 \parindent = \defaultparindent
8668 \setemergencystretch
8671 % @letterpaper (the default).
8672 \def\letterpaper{{\globaldefs = 1
8673 \parskip = 3pt plus 2pt minus 1pt
8674 \textleading = 13.2pt
8676 % If page is nothing but text, make it come out even.
8677 \internalpagesizes{607.2pt}{6in}% that's 46 lines
8678 {\voffset}{.25in}%
8679 {\bindingoffset}{36pt}%
8680 {11in}{8.5in}%
8683 % Use @smallbook to reset parameters for 7x9.25 trim size.
8684 \def\smallbook{{\globaldefs = 1
8685 \parskip = 2pt plus 1pt
8686 \textleading = 12pt
8688 \internalpagesizes{7.5in}{5in}%
8689 {-.2in}{0in}%
8690 {\bindingoffset}{16pt}%
8691 {9.25in}{7in}%
8693 \lispnarrowing = 0.3in
8694 \tolerance = 700
8695 \hfuzz = 1pt
8696 \contentsrightmargin = 0pt
8697 \defbodyindent = .5cm
8700 % Use @smallerbook to reset parameters for 6x9 trim size.
8701 % (Just testing, parameters still in flux.)
8702 \def\smallerbook{{\globaldefs = 1
8703 \parskip = 1.5pt plus 1pt
8704 \textleading = 12pt
8706 \internalpagesizes{7.4in}{4.8in}%
8707 {-.2in}{-.4in}%
8708 {0pt}{14pt}%
8709 {9in}{6in}%
8711 \lispnarrowing = 0.25in
8712 \tolerance = 700
8713 \hfuzz = 1pt
8714 \contentsrightmargin = 0pt
8715 \defbodyindent = .4cm
8718 % Use @afourpaper to print on European A4 paper.
8719 \def\afourpaper{{\globaldefs = 1
8720 \parskip = 3pt plus 2pt minus 1pt
8721 \textleading = 13.2pt
8723 % Double-side printing via postscript on Laserjet 4050
8724 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
8725 % To change the settings for a different printer or situation, adjust
8726 % \normaloffset until the front-side and back-side texts align. Then
8727 % do the same for \bindingoffset. You can set these for testing in
8728 % your texinfo source file like this:
8729 % @tex
8730 % \global\normaloffset = -6mm
8731 % \global\bindingoffset = 10mm
8732 % @end tex
8733 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
8734 {\voffset}{\hoffset}%
8735 {\bindingoffset}{44pt}%
8736 {297mm}{210mm}%
8738 \tolerance = 700
8739 \hfuzz = 1pt
8740 \contentsrightmargin = 0pt
8741 \defbodyindent = 5mm
8744 % Use @afivepaper to print on European A5 paper.
8745 % From romildo@urano.iceb.ufop.br, 2 July 2000.
8746 % He also recommends making @example and @lisp be small.
8747 \def\afivepaper{{\globaldefs = 1
8748 \parskip = 2pt plus 1pt minus 0.1pt
8749 \textleading = 12.5pt
8751 \internalpagesizes{160mm}{120mm}%
8752 {\voffset}{\hoffset}%
8753 {\bindingoffset}{8pt}%
8754 {210mm}{148mm}%
8756 \lispnarrowing = 0.2in
8757 \tolerance = 800
8758 \hfuzz = 1.2pt
8759 \contentsrightmargin = 0pt
8760 \defbodyindent = 2mm
8761 \tableindent = 12mm
8764 % A specific text layout, 24x15cm overall, intended for A4 paper.
8765 \def\afourlatex{{\globaldefs = 1
8766 \afourpaper
8767 \internalpagesizes{237mm}{150mm}%
8768 {\voffset}{4.6mm}%
8769 {\bindingoffset}{7mm}%
8770 {297mm}{210mm}%
8772 % Must explicitly reset to 0 because we call \afourpaper.
8773 \globaldefs = 0
8776 % Use @afourwide to print on A4 paper in landscape format.
8777 \def\afourwide{{\globaldefs = 1
8778 \afourpaper
8779 \internalpagesizes{241mm}{165mm}%
8780 {\voffset}{-2.95mm}%
8781 {\bindingoffset}{7mm}%
8782 {297mm}{210mm}%
8783 \globaldefs = 0
8786 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
8787 % Perhaps we should allow setting the margins, \topskip, \parskip,
8788 % and/or leading, also. Or perhaps we should compute them somehow.
8790 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
8791 \def\pagesizesyyy#1,#2,#3\finish{{%
8792 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
8793 \globaldefs = 1
8795 \parskip = 3pt plus 2pt minus 1pt
8796 \setleading{\textleading}%
8798 \dimen0 = #1\relax
8799 \advance\dimen0 by \voffset
8801 \dimen2 = \hsize
8802 \advance\dimen2 by \normaloffset
8804 \internalpagesizes{#1}{\hsize}%
8805 {\voffset}{\normaloffset}%
8806 {\bindingoffset}{44pt}%
8807 {\dimen0}{\dimen2}%
8810 % Set default to letter.
8812 \letterpaper
8815 \message{and turning on texinfo input format.}
8817 % Define macros to output various characters with catcode for normal text.
8818 \catcode`\"=\other
8819 \catcode`\~=\other
8820 \catcode`\^=\other
8821 \catcode`\_=\other
8822 \catcode`\|=\other
8823 \catcode`\<=\other
8824 \catcode`\>=\other
8825 \catcode`\+=\other
8826 \catcode`\$=\other
8827 \def\normaldoublequote{"}
8828 \def\normaltilde{~}
8829 \def\normalcaret{^}
8830 \def\normalunderscore{_}
8831 \def\normalverticalbar{|}
8832 \def\normalless{<}
8833 \def\normalgreater{>}
8834 \def\normalplus{+}
8835 \def\normaldollar{$}%$ font-lock fix
8837 % This macro is used to make a character print one way in \tt
8838 % (where it can probably be output as-is), and another way in other fonts,
8839 % where something hairier probably needs to be done.
8841 % #1 is what to print if we are indeed using \tt; #2 is what to print
8842 % otherwise. Since all the Computer Modern typewriter fonts have zero
8843 % interword stretch (and shrink), and it is reasonable to expect all
8844 % typewriter fonts to have this, we can check that font parameter.
8846 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
8848 % Same as above, but check for italic font. Actually this also catches
8849 % non-italic slanted fonts since it is impossible to distinguish them from
8850 % italic fonts. But since this is only used by $ and it uses \sl anyway
8851 % this is not a problem.
8852 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
8854 % Turn off all special characters except @
8855 % (and those which the user can use as if they were ordinary).
8856 % Most of these we simply print from the \tt font, but for some, we can
8857 % use math or other variants that look better in normal text.
8859 \catcode`\"=\active
8860 \def\activedoublequote{{\tt\char34}}
8861 \let"=\activedoublequote
8862 \catcode`\~=\active
8863 \def~{{\tt\char126}}
8864 \chardef\hat=`\^
8865 \catcode`\^=\active
8866 \def^{{\tt \hat}}
8868 \catcode`\_=\active
8869 \def_{\ifusingtt\normalunderscore\_}
8870 \let\realunder=_
8871 % Subroutine for the previous macro.
8872 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
8874 \catcode`\|=\active
8875 \def|{{\tt\char124}}
8876 \chardef \less=`\<
8877 \catcode`\<=\active
8878 \def<{{\tt \less}}
8879 \chardef \gtr=`\>
8880 \catcode`\>=\active
8881 \def>{{\tt \gtr}}
8882 \catcode`\+=\active
8883 \def+{{\tt \char 43}}
8884 \catcode`\$=\active
8885 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
8887 % If a .fmt file is being used, characters that might appear in a file
8888 % name cannot be active until we have parsed the command line.
8889 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
8890 % \otherifyactive is called near the end of this file.
8891 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
8893 % Used sometimes to turn off (effectively) the active characters even after
8894 % parsing them.
8895 \def\turnoffactive{%
8896 \normalturnoffactive
8897 \otherbackslash
8900 \catcode`\@=0
8902 % \backslashcurfont outputs one backslash character in current font,
8903 % as in \char`\\.
8904 \global\chardef\backslashcurfont=`\\
8905 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
8907 % \realbackslash is an actual character `\' with catcode other, and
8908 % \doublebackslash is two of them (for the pdf outlines).
8909 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
8911 % In texinfo, backslash is an active character; it prints the backslash
8912 % in fixed width font.
8913 \catcode`\\=\active
8914 @def@normalbackslash{{@tt@backslashcurfont}}
8915 % On startup, @fixbackslash assigns:
8916 % @let \ = @normalbackslash
8918 % \rawbackslash defines an active \ to do \backslashcurfont.
8919 % \otherbackslash defines an active \ to be a literal `\' character with
8920 % catcode other.
8921 @gdef@rawbackslash{@let\=@backslashcurfont}
8922 @gdef@otherbackslash{@let\=@realbackslash}
8924 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
8925 % the literal character `\'.
8927 @def@normalturnoffactive{%
8928 @let\=@normalbackslash
8929 @let"=@normaldoublequote
8930 @let~=@normaltilde
8931 @let^=@normalcaret
8932 @let_=@normalunderscore
8933 @let|=@normalverticalbar
8934 @let<=@normalless
8935 @let>=@normalgreater
8936 @let+=@normalplus
8937 @let$=@normaldollar %$ font-lock fix
8938 @unsepspaces
8941 % Make _ and + \other characters, temporarily.
8942 % This is canceled by @fixbackslash.
8943 @otherifyactive
8945 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
8946 % That is what \eatinput is for; after that, the `\' should revert to printing
8947 % a backslash.
8949 @gdef@eatinput input texinfo{@fixbackslash}
8950 @global@let\ = @eatinput
8952 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
8953 % the first `\' in the file would cause an error. This macro tries to fix
8954 % that, assuming it is called before the first `\' could plausibly occur.
8955 % Also turn back on active characters that might appear in the input
8956 % file name, in case not using a pre-dumped format.
8958 @gdef@fixbackslash{%
8959 @ifx\@eatinput @let\ = @normalbackslash @fi
8960 @catcode`+=@active
8961 @catcode`@_=@active
8964 % Say @foo, not \foo, in error messages.
8965 @escapechar = `@@
8967 % These look ok in all fonts, so just make them not special.
8968 @catcode`@& = @other
8969 @catcode`@# = @other
8970 @catcode`@% = @other
8973 @c Local variables:
8974 @c eval: (add-hook 'write-file-hooks 'time-stamp)
8975 @c page-delimiter: "^\\\\message"
8976 @c time-stamp-start: "def\\\\texinfoversion{"
8977 @c time-stamp-format: "%:y-%02m-%02d.%02H"
8978 @c time-stamp-end: "}"
8979 @c End:
8981 @c vim:sw=2:
8983 @ignore
8984 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
8985 @end ignore