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