Update copyright year to 2015
[emacs.git] / doc / misc / texinfo.tex
blob8edee5a452ec618607b9b766ab294949fa441296
1 % texinfo.tex -- TeX macros to handle Texinfo files.
2 %
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
6 \def\texinfoversion{2014-12-03.16}
8 % Copyright 1985-1986, 1988, 1990-2015 Free Software Foundation, Inc.
10 % This texinfo.tex file is free software: you can redistribute it and/or
11 % modify it under the terms of the GNU General Public License as
12 % published by the Free Software Foundation, either version 3 of the
13 % License, or (at your option) any later version.
15 % This texinfo.tex file is distributed in the hope that it will be
16 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
17 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 % General Public License for more details.
20 % You should have received a copy of the GNU General Public License
21 % along with this program. If not, see <http://www.gnu.org/licenses/>.
23 % As a special exception, when this file is read by TeX when processing
24 % a Texinfo source document, you may use the result without
25 % restriction. This Exception is an additional permission under section 7
26 % of the GNU General Public License, version 3 ("GPLv3").
28 % Please try the latest version of texinfo.tex before submitting bug
29 % reports; you can get the latest version from:
30 % http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
31 % http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
32 % http://www.gnu.org/software/texinfo/ (the Texinfo home page)
33 % The texinfo.tex in any given distribution could well be out
34 % of date, so if that's what you're using, please check.
36 % Send bug reports to bug-texinfo@gnu.org. Please include including a
37 % complete document in each bug report with which we can reproduce the
38 % problem. Patches are, of course, greatly appreciated.
40 % To process a Texinfo manual with TeX, it's most reliable to use the
41 % texi2dvi shell script that comes with the distribution. For a simple
42 % manual foo.texi, however, you can get away with this:
43 % tex foo.texi
44 % texindex foo.??
45 % tex foo.texi
46 % tex foo.texi
47 % dvips foo.dvi -o # or whatever; this makes foo.ps.
48 % The extra TeX runs get the cross-reference information correct.
49 % Sometimes one run after texindex suffices, and sometimes you need more
50 % than two; texi2dvi does it as many times as necessary.
52 % It is possible to adapt texinfo.tex for other languages, to some
53 % extent. You can get the existing language-specific files from the
54 % full Texinfo distribution.
56 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
59 \message{Loading texinfo [version \texinfoversion]:}
61 % If in a .fmt file, print the version number
62 % and turn on active characters that we couldn't do earlier because
63 % they might have appeared in the input file name.
64 \everyjob{\message{[Texinfo version \texinfoversion]}%
65 \catcode`+=\active \catcode`\_=\active}
67 \chardef\other=12
69 % We never want plain's \outer definition of \+ in Texinfo.
70 % For @tex, we can use \tabalign.
71 \let\+ = \relax
73 % Save some plain tex macros whose names we will redefine.
74 \let\ptexb=\b
75 \let\ptexbullet=\bullet
76 \let\ptexc=\c
77 \let\ptexcomma=\,
78 \let\ptexdot=\.
79 \let\ptexdots=\dots
80 \let\ptexend=\end
81 \let\ptexequiv=\equiv
82 \let\ptexexclam=\!
83 \let\ptexfootnote=\footnote
84 \let\ptexgtr=>
85 \let\ptexhat=^
86 \let\ptexi=\i
87 \let\ptexindent=\indent
88 \let\ptexinsert=\insert
89 \let\ptexlbrace=\{
90 \let\ptexless=<
91 \let\ptexnewwrite\newwrite
92 \let\ptexnoindent=\noindent
93 \let\ptexplus=+
94 \let\ptexraggedright=\raggedright
95 \let\ptexrbrace=\}
96 \let\ptexslash=\/
97 \let\ptexsp=\sp
98 \let\ptexstar=\*
99 \let\ptexsup=\sup
100 \let\ptext=\t
101 \let\ptextop=\top
102 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
104 % If this character appears in an error message or help string, it
105 % starts a new line in the output.
106 \newlinechar = `^^J
108 % Use TeX 3.0's \inputlineno to get the line number, for better error
109 % messages, but if we're using an old version of TeX, don't do anything.
111 \ifx\inputlineno\thisisundefined
112 \let\linenumber = \empty % Pre-3.0.
113 \else
114 \def\linenumber{l.\the\inputlineno:\space}
117 % Set up fixed words for English if not already set.
118 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
119 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
120 \ifx\putworderror\undefined \gdef\putworderror{error}\fi
121 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
122 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
123 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
124 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
125 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
126 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
127 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
128 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
129 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
130 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
131 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
132 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
133 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
134 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
135 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
136 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
137 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
139 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
140 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
141 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
142 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
143 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
144 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
145 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
146 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
147 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
148 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
149 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
150 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
152 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
153 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
154 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
155 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
156 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
158 % Since the category of space is not known, we have to be careful.
159 \chardef\spacecat = 10
160 \def\spaceisspace{\catcode`\ =\spacecat}
162 % sometimes characters are active, so we need control sequences.
163 \chardef\ampChar = `\&
164 \chardef\colonChar = `\:
165 \chardef\commaChar = `\,
166 \chardef\dashChar = `\-
167 \chardef\dotChar = `\.
168 \chardef\exclamChar= `\!
169 \chardef\hashChar = `\#
170 \chardef\lquoteChar= `\`
171 \chardef\questChar = `\?
172 \chardef\rquoteChar= `\'
173 \chardef\semiChar = `\;
174 \chardef\slashChar = `\/
175 \chardef\underChar = `\_
177 % Ignore a token.
179 \def\gobble#1{}
181 % The following is used inside several \edef's.
182 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
184 % Hyphenation fixes.
185 \hyphenation{
186 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
187 ap-pen-dix bit-map bit-maps
188 data-base data-bases eshell fall-ing half-way long-est man-u-script
189 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
190 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
191 spell-ing spell-ings
192 stand-alone strong-est time-stamp time-stamps which-ever white-space
193 wide-spread wrap-around
196 % Margin to add to right of even pages, to left of odd pages.
197 \newdimen\bindingoffset
198 \newdimen\normaloffset
199 \newdimen\pagewidth \newdimen\pageheight
201 % For a final copy, take out the rectangles
202 % that mark overfull boxes (in case you have decided
203 % that the text looks ok even though it passes the margin).
205 \def\finalout{\overfullrule=0pt }
207 % Sometimes it is convenient to have everything in the transcript file
208 % and nothing on the terminal. We don't just call \tracingall here,
209 % since that produces some useless output on the terminal. We also make
210 % some effort to order the tracing commands to reduce output in the log
211 % file; cf. trace.sty in LaTeX.
213 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
214 \def\loggingall{%
215 \tracingstats2
216 \tracingpages1
217 \tracinglostchars2 % 2 gives us more in etex
218 \tracingparagraphs1
219 \tracingoutput1
220 \tracingmacros2
221 \tracingrestores1
222 \showboxbreadth\maxdimen \showboxdepth\maxdimen
223 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
224 \tracingscantokens1
225 \tracingifs1
226 \tracinggroups1
227 \tracingnesting2
228 \tracingassigns1
230 \tracingcommands3 % 3 gives us more in etex
231 \errorcontextlines16
234 % @errormsg{MSG}. Do the index-like expansions on MSG, but if things
235 % aren't perfect, it's not the end of the world, being an error message,
236 % after all.
238 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
239 \def\doerrormsg#1{\errmessage{#1}}
241 % add check for \lastpenalty to plain's definitions. If the last thing
242 % we did was a \nobreak, we don't want to insert more space.
244 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
245 \removelastskip\penalty-50\smallskip\fi\fi}
246 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
247 \removelastskip\penalty-100\medskip\fi\fi}
248 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
249 \removelastskip\penalty-200\bigskip\fi\fi}
251 % Do @cropmarks to get crop marks.
253 \newif\ifcropmarks
254 \let\cropmarks = \cropmarkstrue
256 % Dimensions to add cropmarks at corners.
257 % Added by P. A. MacKay, 12 Nov. 1986
259 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
260 \newdimen\cornerlong \cornerlong=1pc
261 \newdimen\cornerthick \cornerthick=.3pt
262 \newdimen\topandbottommargin \topandbottommargin=.75in
264 % Output a mark which sets \thischapter, \thissection and \thiscolor.
265 % We dump everything together because we only have one kind of mark.
266 % This works because we only use \botmark / \topmark, not \firstmark.
268 % A mark contains a subexpression of the \ifcase ... \fi construct.
269 % \get*marks macros below extract the needed part using \ifcase.
271 % Another complication is to let the user choose whether \thischapter
272 % (\thissection) refers to the chapter (section) in effect at the top
273 % of a page, or that at the bottom of a page. The solution is
274 % described on page 260 of The TeXbook. It involves outputting two
275 % marks for the sectioning macros, one before the section break, and
276 % one after. I won't pretend I can describe this better than DEK...
277 \def\domark{%
278 \toks0=\expandafter{\lastchapterdefs}%
279 \toks2=\expandafter{\lastsectiondefs}%
280 \toks4=\expandafter{\prevchapterdefs}%
281 \toks6=\expandafter{\prevsectiondefs}%
282 \toks8=\expandafter{\lastcolordefs}%
283 \mark{%
284 \the\toks0 \the\toks2 % 0: top marks (\last...)
285 \noexpand\or \the\toks4 \the\toks6 % 1: bottom marks (default, \prev...)
286 \noexpand\else \the\toks8 % 2: color marks
289 % \topmark doesn't work for the very first chapter (after the title
290 % page or the contents), so we use \firstmark there -- this gets us
291 % the mark with the chapter defs, unless the user sneaks in, e.g.,
292 % @setcolor (or @url, or @link, etc.) between @contents and the very
293 % first @chapter.
294 \def\gettopheadingmarks{%
295 \ifcase0\topmark\fi
296 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
298 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
299 \def\getcolormarks{\ifcase2\topmark\fi}
301 % Avoid "undefined control sequence" errors.
302 \def\lastchapterdefs{}
303 \def\lastsectiondefs{}
304 \def\prevchapterdefs{}
305 \def\prevsectiondefs{}
306 \def\lastcolordefs{}
308 % Main output routine.
309 \chardef\PAGE = 255
310 \output = {\onepageout{\pagecontents\PAGE}}
312 \newbox\headlinebox
313 \newbox\footlinebox
315 % \onepageout takes a vbox as an argument. Note that \pagecontents
316 % does insertions, but you have to call it yourself.
317 \def\onepageout#1{%
318 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
320 \ifodd\pageno \advance\hoffset by \bindingoffset
321 \else \advance\hoffset by -\bindingoffset\fi
323 % Do this outside of the \shipout so @code etc. will be expanded in
324 % the headline as they should be, not taken literally (outputting ''code).
325 \def\commmonheadfootline{\let\hsize=\pagewidth \texinfochars}
327 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
328 \global\setbox\headlinebox = \vbox{\commmonheadfootline \makeheadline}%
330 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
331 \global\setbox\footlinebox = \vbox{\commmonheadfootline \makefootline}%
334 % Have to do this stuff outside the \shipout because we want it to
335 % take effect in \write's, yet the group defined by the \vbox ends
336 % before the \shipout runs.
338 \indexdummies % don't expand commands in the output.
339 \normalturnoffactive % \ in index entries must not stay \, e.g., if
340 % the page break happens to be in the middle of an example.
341 % We don't want .vr (or whatever) entries like this:
342 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
343 % "\acronym" won't work when it's read back in;
344 % it needs to be
345 % {\code {{\tt \backslashcurfont }acronym}
346 \shipout\vbox{%
347 % Do this early so pdf references go to the beginning of the page.
348 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
350 \ifcropmarks \vbox to \outervsize\bgroup
351 \hsize = \outerhsize
352 \vskip-\topandbottommargin
353 \vtop to0pt{%
354 \line{\ewtop\hfil\ewtop}%
355 \nointerlineskip
356 \line{%
357 \vbox{\moveleft\cornerthick\nstop}%
358 \hfill
359 \vbox{\moveright\cornerthick\nstop}%
361 \vss}%
362 \vskip\topandbottommargin
363 \line\bgroup
364 \hfil % center the page within the outer (page) hsize.
365 \ifodd\pageno\hskip\bindingoffset\fi
366 \vbox\bgroup
369 \unvbox\headlinebox
370 \pagebody{#1}%
371 \ifdim\ht\footlinebox > 0pt
372 % Only leave this space if the footline is nonempty.
373 % (We lessened \vsize for it in \oddfootingyyy.)
374 % The \baselineskip=24pt in plain's \makefootline has no effect.
375 \vskip 24pt
376 \unvbox\footlinebox
379 \ifcropmarks
380 \egroup % end of \vbox\bgroup
381 \hfil\egroup % end of (centering) \line\bgroup
382 \vskip\topandbottommargin plus1fill minus1fill
383 \boxmaxdepth = \cornerthick
384 \vbox to0pt{\vss
385 \line{%
386 \vbox{\moveleft\cornerthick\nsbot}%
387 \hfill
388 \vbox{\moveright\cornerthick\nsbot}%
390 \nointerlineskip
391 \line{\ewbot\hfil\ewbot}%
393 \egroup % \vbox from first cropmarks clause
395 }% end of \shipout\vbox
396 }% end of group with \indexdummies
397 \advancepageno
398 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
401 \newinsert\margin \dimen\margin=\maxdimen
403 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
404 {\catcode`\@ =11
405 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
406 % marginal hacks, juha@viisa.uucp (Juha Takala)
407 \ifvoid\margin\else % marginal info is present
408 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
409 \dimen@=\dp#1\relax \unvbox#1\relax
410 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
411 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
414 % Here are the rules for the cropmarks. Note that they are
415 % offset so that the space between them is truly \outerhsize or \outervsize
416 % (P. A. MacKay, 12 November, 1986)
418 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
419 \def\nstop{\vbox
420 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
421 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
422 \def\nsbot{\vbox
423 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
425 % Parse an argument, then pass it to #1. The argument is the rest of
426 % the input line (except we remove a trailing comment). #1 should be a
427 % macro which expects an ordinary undelimited TeX argument.
429 \def\parsearg{\parseargusing{}}
430 \def\parseargusing#1#2{%
431 \def\argtorun{#2}%
432 \begingroup
433 \obeylines
434 \spaceisspace
436 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
439 {\obeylines %
440 \gdef\parseargline#1^^M{%
441 \endgroup % End of the group started in \parsearg.
442 \argremovecomment #1\comment\ArgTerm%
446 % First remove any @comment, then any @c comment.
447 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
448 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
450 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
452 % \argremovec might leave us with trailing space, e.g.,
453 % @end itemize @c foo
454 % This space token undergoes the same procedure and is eventually removed
455 % by \finishparsearg.
457 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
458 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
459 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
460 \def\temp{#3}%
461 \ifx\temp\empty
462 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
463 \let\temp\finishparsearg
464 \else
465 \let\temp\argcheckspaces
467 % Put the space token in:
468 \temp#1 #3\ArgTerm
471 % If a _delimited_ argument is enclosed in braces, they get stripped; so
472 % to get _exactly_ the rest of the line, we had to prevent such situation.
473 % We prepended an \empty token at the very beginning and we expand it now,
474 % just before passing the control to \argtorun.
475 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
476 % either the null string, or it ends with \^^M---thus there is no danger
477 % that a pair of braces would be stripped.
479 % But first, we have to remove the trailing space token.
481 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
483 % \parseargdef\foo{...}
484 % is roughly equivalent to
485 % \def\foo{\parsearg\Xfoo}
486 % \def\Xfoo#1{...}
488 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
489 % favourite TeX trick. --kasal, 16nov03
491 \def\parseargdef#1{%
492 \expandafter \doparseargdef \csname\string#1\endcsname #1%
494 \def\doparseargdef#1#2{%
495 \def#2{\parsearg#1}%
496 \def#1##1%
499 % Several utility definitions with active space:
501 \obeyspaces
502 \gdef\obeyedspace{ }
504 % Make each space character in the input produce a normal interword
505 % space in the output. Don't allow a line break at this space, as this
506 % is used only in environments like @example, where each line of input
507 % should produce a line of output anyway.
509 \gdef\sepspaces{\obeyspaces\let =\tie}
511 % If an index command is used in an @example environment, any spaces
512 % therein should become regular spaces in the raw index file, not the
513 % expansion of \tie (\leavevmode \penalty \@M \ ).
514 \gdef\unsepspaces{\let =\space}
518 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
520 % Define the framework for environments in texinfo.tex. It's used like this:
522 % \envdef\foo{...}
523 % \def\Efoo{...}
525 % It's the responsibility of \envdef to insert \begingroup before the
526 % actual body; @end closes the group after calling \Efoo. \envdef also
527 % defines \thisenv, so the current environment is known; @end checks
528 % whether the environment name matches. The \checkenv macro can also be
529 % used to check whether the current environment is the one expected.
531 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
532 % are not treated as environments; they don't open a group. (The
533 % implementation of @end takes care not to call \endgroup in this
534 % special case.)
537 % At run-time, environments start with this:
538 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
539 % initialize
540 \let\thisenv\empty
542 % ... but they get defined via ``\envdef\foo{...}'':
543 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
544 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
546 % Check whether we're in the right environment:
547 \def\checkenv#1{%
548 \def\temp{#1}%
549 \ifx\thisenv\temp
550 \else
551 \badenverr
555 % Environment mismatch, #1 expected:
556 \def\badenverr{%
557 \errhelp = \EMsimple
558 \errmessage{This command can appear only \inenvironment\temp,
559 not \inenvironment\thisenv}%
561 \def\inenvironment#1{%
562 \ifx#1\empty
563 outside of any environment%
564 \else
565 in environment \expandafter\string#1%
569 % @end foo executes the definition of \Efoo.
570 % But first, it executes a specialized version of \checkenv
572 \parseargdef\end{%
573 \if 1\csname iscond.#1\endcsname
574 \else
575 % The general wording of \badenverr may not be ideal.
576 \expandafter\checkenv\csname#1\endcsname
577 \csname E#1\endcsname
578 \endgroup
582 \newhelp\EMsimple{Press RETURN to continue.}
585 % Be sure we're in horizontal mode when doing a tie, since we make space
586 % equivalent to this in @example-like environments. Otherwise, a space
587 % at the beginning of a line will start with \penalty -- and
588 % since \penalty is valid in vertical mode, we'd end up putting the
589 % penalty on the vertical list instead of in the new paragraph.
590 {\catcode`@ = 11
591 % Avoid using \@M directly, because that causes trouble
592 % if the definition is written into an index file.
593 \global\let\tiepenalty = \@M
594 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
597 % @: forces normal size whitespace following.
598 \def\:{\spacefactor=1000 }
600 % @* forces a line break.
601 \def\*{\unskip\hfil\break\hbox{}\ignorespaces}
603 % @/ allows a line break.
604 \let\/=\allowbreak
606 % @. is an end-of-sentence period.
607 \def\.{.\spacefactor=\endofsentencespacefactor\space}
609 % @! is an end-of-sentence bang.
610 \def\!{!\spacefactor=\endofsentencespacefactor\space}
612 % @? is an end-of-sentence query.
613 \def\?{?\spacefactor=\endofsentencespacefactor\space}
615 % @frenchspacing on|off says whether to put extra space after punctuation.
617 \def\onword{on}
618 \def\offword{off}
620 \parseargdef\frenchspacing{%
621 \def\temp{#1}%
622 \ifx\temp\onword \plainfrenchspacing
623 \else\ifx\temp\offword \plainnonfrenchspacing
624 \else
625 \errhelp = \EMsimple
626 \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
627 \fi\fi
630 % @w prevents a word break. Without the \leavevmode, @w at the
631 % beginning of a paragraph, when TeX is still in vertical mode, would
632 % produce a whole line of output instead of starting the paragraph.
633 \def\w#1{\leavevmode\hbox{#1}}
635 % @group ... @end group forces ... to be all on one page, by enclosing
636 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
637 % to keep its height that of a normal line. According to the rules for
638 % \topskip (p.114 of the TeXbook), the glue inserted is
639 % max (\topskip - \ht (first item), 0). If that height is large,
640 % therefore, no glue is inserted, and the space between the headline and
641 % the text is small, which looks bad.
643 % Another complication is that the group might be very large. This can
644 % cause the glue on the previous page to be unduly stretched, because it
645 % does not have much material. In this case, it's better to add an
646 % explicit \vfill so that the extra space is at the bottom. The
647 % threshold for doing this is if the group is more than \vfilllimit
648 % percent of a page (\vfilllimit can be changed inside of @tex).
650 \newbox\groupbox
651 \def\vfilllimit{0.7}
653 \envdef\group{%
654 \ifnum\catcode`\^^M=\active \else
655 \errhelp = \groupinvalidhelp
656 \errmessage{@group invalid in context where filling is enabled}%
658 \startsavinginserts
660 \setbox\groupbox = \vtop\bgroup
661 % Do @comment since we are called inside an environment such as
662 % @example, where each end-of-line in the input causes an
663 % end-of-line in the output. We don't want the end-of-line after
664 % the `@group' to put extra space in the output. Since @group
665 % should appear on a line by itself (according to the Texinfo
666 % manual), we don't worry about eating any user text.
667 \comment
670 % The \vtop produces a box with normal height and large depth; thus, TeX puts
671 % \baselineskip glue before it, and (when the next line of text is done)
672 % \lineskip glue after it. Thus, space below is not quite equal to space
673 % above. But it's pretty close.
674 \def\Egroup{%
675 % To get correct interline space between the last line of the group
676 % and the first line afterwards, we have to propagate \prevdepth.
677 \endgraf % Not \par, as it may have been set to \lisppar.
678 \global\dimen1 = \prevdepth
679 \egroup % End the \vtop.
680 % \dimen0 is the vertical size of the group's box.
681 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
682 % \dimen2 is how much space is left on the page (more or less).
683 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
684 % if the group doesn't fit on the current page, and it's a big big
685 % group, force a page break.
686 \ifdim \dimen0 > \dimen2
687 \ifdim \pagetotal < \vfilllimit\pageheight
688 \page
691 \box\groupbox
692 \prevdepth = \dimen1
693 \checkinserts
696 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
697 % message, so this ends up printing `@group can only ...'.
699 \newhelp\groupinvalidhelp{%
700 group can only be used in environments such as @example,^^J%
701 where each line of input produces a line of output.}
703 % @need space-in-mils
704 % forces a page break if there is not space-in-mils remaining.
706 \newdimen\mil \mil=0.001in
708 \parseargdef\need{%
709 % Ensure vertical mode, so we don't make a big box in the middle of a
710 % paragraph.
711 \par
713 % If the @need value is less than one line space, it's useless.
714 \dimen0 = #1\mil
715 \dimen2 = \ht\strutbox
716 \advance\dimen2 by \dp\strutbox
717 \ifdim\dimen0 > \dimen2
719 % Do a \strut just to make the height of this box be normal, so the
720 % normal leading is inserted relative to the preceding line.
721 % And a page break here is fine.
722 \vtop to #1\mil{\strut\vfil}%
724 % TeX does not even consider page breaks if a penalty added to the
725 % main vertical list is 10000 or more. But in order to see if the
726 % empty box we just added fits on the page, we must make it consider
727 % page breaks. On the other hand, we don't want to actually break the
728 % page after the empty box. So we use a penalty of 9999.
730 % There is an extremely small chance that TeX will actually break the
731 % page at this \penalty, if there are no other feasible breakpoints in
732 % sight. (If the user is using lots of big @group commands, which
733 % almost-but-not-quite fill up a page, TeX will have a hard time doing
734 % good page breaking, for example.) However, I could not construct an
735 % example where a page broke at this \penalty; if it happens in a real
736 % document, then we can reconsider our strategy.
737 \penalty9999
739 % Back up by the size of the box, whether we did a page break or not.
740 \kern -#1\mil
742 % Do not allow a page break right after this kern.
743 \nobreak
747 % @br forces paragraph break (and is undocumented).
749 \let\br = \par
751 % @page forces the start of a new page.
753 \def\page{\par\vfill\supereject}
755 % @exdent text....
756 % outputs text on separate line in roman font, starting at standard page margin
758 % This records the amount of indent in the innermost environment.
759 % That's how much \exdent should take out.
760 \newskip\exdentamount
762 % This defn is used inside fill environments such as @defun.
763 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
765 % This defn is used inside nofill environments such as @example.
766 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
767 \leftline{\hskip\leftskip{\rm#1}}}}
769 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
770 % paragraph. For more general purposes, use the \margin insertion
771 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
773 \newskip\inmarginspacing \inmarginspacing=1cm
774 \def\strutdepth{\dp\strutbox}
776 \def\doinmargin#1#2{\strut\vadjust{%
777 \nobreak
778 \kern-\strutdepth
779 \vtop to \strutdepth{%
780 \baselineskip=\strutdepth
781 \vss
782 % if you have multiple lines of stuff to put here, you'll need to
783 % make the vbox yourself of the appropriate size.
784 \ifx#1l%
785 \llap{\ignorespaces #2\hskip\inmarginspacing}%
786 \else
787 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
789 \null
792 \def\inleftmargin{\doinmargin l}
793 \def\inrightmargin{\doinmargin r}
795 % @inmargin{TEXT [, RIGHT-TEXT]}
796 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
797 % else use TEXT for both).
799 \def\inmargin#1{\parseinmargin #1,,\finish}
800 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
801 \setbox0 = \hbox{\ignorespaces #2}%
802 \ifdim\wd0 > 0pt
803 \def\lefttext{#1}% have both texts
804 \def\righttext{#2}%
805 \else
806 \def\lefttext{#1}% have only one text
807 \def\righttext{#1}%
810 \ifodd\pageno
811 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
812 \else
813 \def\temp{\inleftmargin\lefttext}%
815 \temp
818 % @| inserts a changebar to the left of the current line. It should
819 % surround any changed text. This approach does *not* work if the
820 % change spans more than two lines of output. To handle that, we would
821 % have adopt a much more difficult approach (putting marks into the main
822 % vertical list for the beginning and end of each change). This command
823 % is not documented, not supported, and doesn't work.
825 \def\|{%
826 % \vadjust can only be used in horizontal mode.
827 \leavevmode
829 % Append this vertical mode material after the current line in the output.
830 \vadjust{%
831 % We want to insert a rule with the height and depth of the current
832 % leading; that is exactly what \strutbox is supposed to record.
833 \vskip-\baselineskip
835 % \vadjust-items are inserted at the left edge of the type. So
836 % the \llap here moves out into the left-hand margin.
837 \llap{%
839 % For a thicker or thinner bar, change the `1pt'.
840 \vrule height\baselineskip width1pt
842 % This is the space between the bar and the text.
843 \hskip 12pt
848 % @include FILE -- \input text of FILE.
850 \def\include{\parseargusing\filenamecatcodes\includezzz}
851 \def\includezzz#1{%
852 \pushthisfilestack
853 \def\thisfile{#1}%
855 \makevalueexpandable % we want to expand any @value in FILE.
856 \turnoffactive % and allow special characters in the expansion
857 \indexnofonts % Allow `@@' and other weird things in file names.
858 \wlog{texinfo.tex: doing @include of #1^^J}%
859 \edef\temp{\noexpand\input #1 }%
861 % This trickery is to read FILE outside of a group, in case it makes
862 % definitions, etc.
863 \expandafter
864 }\temp
865 \popthisfilestack
867 \def\filenamecatcodes{%
868 \catcode`\\=\other
869 \catcode`~=\other
870 \catcode`^=\other
871 \catcode`_=\other
872 \catcode`|=\other
873 \catcode`<=\other
874 \catcode`>=\other
875 \catcode`+=\other
876 \catcode`-=\other
877 \catcode`\`=\other
878 \catcode`\'=\other
881 \def\pushthisfilestack{%
882 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
884 \def\pushthisfilestackX{%
885 \expandafter\pushthisfilestackY\thisfile\StackTerm
887 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
888 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
891 \def\popthisfilestack{\errthisfilestackempty}
892 \def\errthisfilestackempty{\errmessage{Internal error:
893 the stack of filenames is empty.}}
895 \def\thisfile{}
897 % @center line
898 % outputs that line, centered.
900 \parseargdef\center{%
901 \ifhmode
902 \let\centersub\centerH
903 \else
904 \let\centersub\centerV
906 \centersub{\hfil \ignorespaces#1\unskip \hfil}%
907 \let\centersub\relax % don't let the definition persist, just in case
909 \def\centerH#1{{%
910 \hfil\break
911 \advance\hsize by -\leftskip
912 \advance\hsize by -\rightskip
913 \line{#1}%
914 \break
917 \newcount\centerpenalty
918 \def\centerV#1{%
919 % The idea here is the same as in \startdefun, \cartouche, etc.: if
920 % @center is the first thing after a section heading, we need to wipe
921 % out the negative parskip inserted by \sectionheading, but still
922 % prevent a page break here.
923 \centerpenalty = \lastpenalty
924 \ifnum\centerpenalty>10000 \vskip\parskip \fi
925 \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi
926 \line{\kern\leftskip #1\kern\rightskip}%
929 % @sp n outputs n lines of vertical space
931 \parseargdef\sp{\vskip #1\baselineskip}
933 % @comment ...line which is ignored...
934 % @c is the same as @comment
935 % @ignore ... @end ignore is another way to write a comment
937 \def\comment{\begingroup \catcode`\^^M=\other%
938 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
939 \commentxxx}
940 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
942 \let\c=\comment
944 % @paragraphindent NCHARS
945 % We'll use ems for NCHARS, close enough.
946 % NCHARS can also be the word `asis' or `none'.
947 % We cannot feasibly implement @paragraphindent asis, though.
949 \def\asisword{asis} % no translation, these are keywords
950 \def\noneword{none}
952 \parseargdef\paragraphindent{%
953 \def\temp{#1}%
954 \ifx\temp\asisword
955 \else
956 \ifx\temp\noneword
957 \defaultparindent = 0pt
958 \else
959 \defaultparindent = #1em
962 \parindent = \defaultparindent
965 % @exampleindent NCHARS
966 % We'll use ems for NCHARS like @paragraphindent.
967 % It seems @exampleindent asis isn't necessary, but
968 % I preserve it to make it similar to @paragraphindent.
969 \parseargdef\exampleindent{%
970 \def\temp{#1}%
971 \ifx\temp\asisword
972 \else
973 \ifx\temp\noneword
974 \lispnarrowing = 0pt
975 \else
976 \lispnarrowing = #1em
981 % @firstparagraphindent WORD
982 % If WORD is `none', then suppress indentation of the first paragraph
983 % after a section heading. If WORD is `insert', then do indent at such
984 % paragraphs.
986 % The paragraph indentation is suppressed or not by calling
987 % \suppressfirstparagraphindent, which the sectioning commands do.
988 % We switch the definition of this back and forth according to WORD.
989 % By default, we suppress indentation.
991 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
992 \def\insertword{insert}
994 \parseargdef\firstparagraphindent{%
995 \def\temp{#1}%
996 \ifx\temp\noneword
997 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
998 \else\ifx\temp\insertword
999 \let\suppressfirstparagraphindent = \relax
1000 \else
1001 \errhelp = \EMsimple
1002 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1003 \fi\fi
1006 % Here is how we actually suppress indentation. Redefine \everypar to
1007 % \kern backwards by \parindent, and then reset itself to empty.
1009 % We also make \indent itself not actually do anything until the next
1010 % paragraph.
1012 \gdef\dosuppressfirstparagraphindent{%
1013 \gdef\indent {\restorefirstparagraphindent \indent}%
1014 \gdef\noindent{\restorefirstparagraphindent \noindent}%
1015 \global\everypar = {\kern -\parindent \restorefirstparagraphindent}%
1018 \gdef\restorefirstparagraphindent{%
1019 \global\let\indent = \ptexindent
1020 \global\let\noindent = \ptexnoindent
1021 \global\everypar = {}%
1025 % @refill is a no-op.
1026 \let\refill=\relax
1028 % If working on a large document in chapters, it is convenient to
1029 % be able to disable indexing, cross-referencing, and contents, for test runs.
1030 % This is done with @novalidate (before @setfilename).
1032 \newif\iflinks \linkstrue % by default we want the aux files.
1033 \let\novalidate = \linksfalse
1035 % @setfilename is done at the beginning of every texinfo file.
1036 % So open here the files we need to have open while reading the input.
1037 % This makes it possible to make a .fmt file for texinfo.
1038 \def\setfilename{%
1039 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1040 \iflinks
1041 \tryauxfile
1042 % Open the new aux file. TeX will close it automatically at exit.
1043 \immediate\openout\auxfile=\jobname.aux
1044 \fi % \openindices needs to do some work in any case.
1045 \openindices
1046 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1048 % If texinfo.cnf is present on the system, read it.
1049 % Useful for site-wide @afourpaper, etc.
1050 \openin 1 texinfo.cnf
1051 \ifeof 1 \else \input texinfo.cnf \fi
1052 \closein 1
1054 \comment % Ignore the actual filename.
1057 % Called from \setfilename.
1059 \def\openindices{%
1060 \newindex{cp}%
1061 \newcodeindex{fn}%
1062 \newcodeindex{vr}%
1063 \newcodeindex{tp}%
1064 \newcodeindex{ky}%
1065 \newcodeindex{pg}%
1068 % @bye.
1069 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1072 \message{pdf,}
1073 % adobe `portable' document format
1074 \newcount\tempnum
1075 \newcount\lnkcount
1076 \newtoks\filename
1077 \newcount\filenamelength
1078 \newcount\pgn
1079 \newtoks\toksA
1080 \newtoks\toksB
1081 \newtoks\toksC
1082 \newtoks\toksD
1083 \newbox\boxA
1084 \newcount\countA
1085 \newif\ifpdf
1086 \newif\ifpdfmakepagedest
1088 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1089 % can be set). So we test for \relax and 0 as well as being undefined.
1090 \ifx\pdfoutput\thisisundefined
1091 \else
1092 \ifx\pdfoutput\relax
1093 \else
1094 \ifcase\pdfoutput
1095 \else
1096 \pdftrue
1101 % PDF uses PostScript string constants for the names of xref targets,
1102 % for display in the outlines, and in other places. Thus, we have to
1103 % double any backslashes. Otherwise, a name like "\node" will be
1104 % interpreted as a newline (\n), followed by o, d, e. Not good.
1106 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1107 % related messages. The final outcome is that it is up to the TeX user
1108 % to double the backslashes and otherwise make the string valid, so
1109 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1110 % do this reliably, so we use it.
1112 % #1 is a control sequence in which to do the replacements,
1113 % which we \xdef.
1114 \def\txiescapepdf#1{%
1115 \ifx\pdfescapestring\thisisundefined
1116 % No primitive available; should we give a warning or log?
1117 % Many times it won't matter.
1118 \else
1119 % The expandable \pdfescapestring primitive escapes parentheses,
1120 % backslashes, and other special chars.
1121 \xdef#1{\pdfescapestring{#1}}%
1125 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1126 with PDF output, and none of those formats could be found. (.eps cannot
1127 be supported due to the design of the PDF format; use regular TeX (DVI
1128 output) for that.)}
1130 \ifpdf
1132 % Color manipulation macros using ideas from pdfcolor.tex,
1133 % except using rgb instead of cmyk; the latter is said to render as a
1134 % very dark gray on-screen and a very dark halftone in print, instead
1135 % of actual black. The dark red here is dark enough to print on paper as
1136 % nearly black, but still distinguishable for online viewing. We use
1137 % black by default, though.
1138 \def\rgbDarkRed{0.50 0.09 0.12}
1139 \def\rgbBlack{0 0 0}
1141 % k sets the color for filling (usual text, etc.);
1142 % K sets the color for stroking (thin rules, e.g., normal _'s).
1143 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1145 % Set color, and create a mark which defines \thiscolor accordingly,
1146 % so that \makeheadline knows which color to restore.
1147 \def\setcolor#1{%
1148 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1149 \domark
1150 \pdfsetcolor{#1}%
1153 \def\maincolor{\rgbBlack}
1154 \pdfsetcolor{\maincolor}
1155 \edef\thiscolor{\maincolor}
1156 \def\lastcolordefs{}
1158 \def\makefootline{%
1159 \baselineskip24pt
1160 \line{\pdfsetcolor{\maincolor}\the\footline}%
1163 \def\makeheadline{%
1164 \vbox to 0pt{%
1165 \vskip-22.5pt
1166 \line{%
1167 \vbox to8.5pt{}%
1168 % Extract \thiscolor definition from the marks.
1169 \getcolormarks
1170 % Typeset the headline with \maincolor, then restore the color.
1171 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1173 \vss
1175 \nointerlineskip
1179 \pdfcatalog{/PageMode /UseOutlines}
1181 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1182 \def\dopdfimage#1#2#3{%
1183 \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1184 \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1186 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1187 % others). Let's try in that order, PDF first since if
1188 % someone has a scalable image, presumably better to use that than a
1189 % bitmap.
1190 \let\pdfimgext=\empty
1191 \begingroup
1192 \openin 1 #1.pdf \ifeof 1
1193 \openin 1 #1.PDF \ifeof 1
1194 \openin 1 #1.png \ifeof 1
1195 \openin 1 #1.jpg \ifeof 1
1196 \openin 1 #1.jpeg \ifeof 1
1197 \openin 1 #1.JPG \ifeof 1
1198 \errhelp = \nopdfimagehelp
1199 \errmessage{Could not find image file #1 for pdf}%
1200 \else \gdef\pdfimgext{JPG}%
1202 \else \gdef\pdfimgext{jpeg}%
1204 \else \gdef\pdfimgext{jpg}%
1206 \else \gdef\pdfimgext{png}%
1208 \else \gdef\pdfimgext{PDF}%
1210 \else \gdef\pdfimgext{pdf}%
1212 \closein 1
1213 \endgroup
1215 % without \immediate, ancient pdftex seg faults when the same image is
1216 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1217 \ifnum\pdftexversion < 14
1218 \immediate\pdfimage
1219 \else
1220 \immediate\pdfximage
1222 \ifdim \wd0 >0pt width \pdfimagewidth \fi
1223 \ifdim \wd2 >0pt height \pdfimageheight \fi
1224 \ifnum\pdftexversion<13
1225 #1.\pdfimgext
1226 \else
1227 {#1.\pdfimgext}%
1229 \ifnum\pdftexversion < 14 \else
1230 \pdfrefximage \pdflastximage
1231 \fi}
1233 \def\pdfmkdest#1{{%
1234 % We have to set dummies so commands such as @code, and characters
1235 % such as \, aren't expanded when present in a section title.
1236 \indexnofonts
1237 \turnoffactive
1238 \makevalueexpandable
1239 \def\pdfdestname{#1}%
1240 \txiescapepdf\pdfdestname
1241 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1244 % used to mark target names; must be expandable.
1245 \def\pdfmkpgn#1{#1}
1247 % by default, use black for everything.
1248 \def\urlcolor{\rgbBlack}
1249 \def\linkcolor{\rgbBlack}
1250 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1252 % Adding outlines to PDF; macros for calculating structure of outlines
1253 % come from Petr Olsak
1254 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1255 \else \csname#1\endcsname \fi}
1256 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1257 \advance\tempnum by 1
1258 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1260 % #1 is the section text, which is what will be displayed in the
1261 % outline by the pdf viewer. #2 is the pdf expression for the number
1262 % of subentries (or empty, for subsubsections). #3 is the node text,
1263 % which might be empty if this toc entry had no corresponding node.
1264 % #4 is the page number
1266 \def\dopdfoutline#1#2#3#4{%
1267 % Generate a link to the node text if that exists; else, use the
1268 % page number. We could generate a destination for the section
1269 % text in the case where a section has no node, but it doesn't
1270 % seem worth the trouble, since most documents are normally structured.
1271 \edef\pdfoutlinedest{#3}%
1272 \ifx\pdfoutlinedest\empty
1273 \def\pdfoutlinedest{#4}%
1274 \else
1275 \txiescapepdf\pdfoutlinedest
1278 % Also escape PDF chars in the display string.
1279 \edef\pdfoutlinetext{#1}%
1280 \txiescapepdf\pdfoutlinetext
1282 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1285 \def\pdfmakeoutlines{%
1286 \begingroup
1287 % Read toc silently, to get counts of subentries for \pdfoutline.
1288 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1289 \def\numchapentry##1##2##3##4{%
1290 \def\thischapnum{##2}%
1291 \def\thissecnum{0}%
1292 \def\thissubsecnum{0}%
1294 \def\numsecentry##1##2##3##4{%
1295 \advancenumber{chap\thischapnum}%
1296 \def\thissecnum{##2}%
1297 \def\thissubsecnum{0}%
1299 \def\numsubsecentry##1##2##3##4{%
1300 \advancenumber{sec\thissecnum}%
1301 \def\thissubsecnum{##2}%
1303 \def\numsubsubsecentry##1##2##3##4{%
1304 \advancenumber{subsec\thissubsecnum}%
1306 \def\thischapnum{0}%
1307 \def\thissecnum{0}%
1308 \def\thissubsecnum{0}%
1310 % use \def rather than \let here because we redefine \chapentry et
1311 % al. a second time, below.
1312 \def\appentry{\numchapentry}%
1313 \def\appsecentry{\numsecentry}%
1314 \def\appsubsecentry{\numsubsecentry}%
1315 \def\appsubsubsecentry{\numsubsubsecentry}%
1316 \def\unnchapentry{\numchapentry}%
1317 \def\unnsecentry{\numsecentry}%
1318 \def\unnsubsecentry{\numsubsecentry}%
1319 \def\unnsubsubsecentry{\numsubsubsecentry}%
1320 \readdatafile{toc}%
1322 % Read toc second time, this time actually producing the outlines.
1323 % The `-' means take the \expnumber as the absolute number of
1324 % subentries, which we calculated on our first read of the .toc above.
1326 % We use the node names as the destinations.
1327 \def\numchapentry##1##2##3##4{%
1328 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1329 \def\numsecentry##1##2##3##4{%
1330 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1331 \def\numsubsecentry##1##2##3##4{%
1332 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1333 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1334 \dopdfoutline{##1}{}{##3}{##4}}%
1336 % PDF outlines are displayed using system fonts, instead of
1337 % document fonts. Therefore we cannot use special characters,
1338 % since the encoding is unknown. For example, the eogonek from
1339 % Latin 2 (0xea) gets translated to a | character. Info from
1340 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1342 % TODO this right, we have to translate 8-bit characters to
1343 % their "best" equivalent, based on the @documentencoding. Too
1344 % much work for too little return. Just use the ASCII equivalents
1345 % we use for the index sort strings.
1347 \indexnofonts
1348 \setupdatafile
1349 % We can have normal brace characters in the PDF outlines, unlike
1350 % Texinfo index files. So set that up.
1351 \def\{{\lbracecharliteral}%
1352 \def\}{\rbracecharliteral}%
1353 \catcode`\\=\active \otherbackslash
1354 \input \tocreadfilename
1355 \endgroup
1357 {\catcode`[=1 \catcode`]=2
1358 \catcode`{=\other \catcode`}=\other
1359 \gdef\lbracecharliteral[{]%
1360 \gdef\rbracecharliteral[}]%
1363 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1364 \ifx\PP\D\let\nextsp\relax
1365 \else\let\nextsp\skipspaces
1366 \addtokens{\filename}{\PP}%
1367 \advance\filenamelength by 1
1369 \nextsp}
1370 \def\getfilename#1{%
1371 \filenamelength=0
1372 % If we don't expand the argument now, \skipspaces will get
1373 % snagged on things like "@value{foo}".
1374 \edef\temp{#1}%
1375 \expandafter\skipspaces\temp|\relax
1377 \ifnum\pdftexversion < 14
1378 \let \startlink \pdfannotlink
1379 \else
1380 \let \startlink \pdfstartlink
1382 % make a live url in pdf output.
1383 \def\pdfurl#1{%
1384 \begingroup
1385 % it seems we really need yet another set of dummies; have not
1386 % tried to figure out what each command should do in the context
1387 % of @url. for now, just make @/ a no-op, that's the only one
1388 % people have actually reported a problem with.
1390 \normalturnoffactive
1391 \def\@{@}%
1392 \let\/=\empty
1393 \makevalueexpandable
1394 % do we want to go so far as to use \indexnofonts instead of just
1395 % special-casing \var here?
1396 \def\var##1{##1}%
1398 \leavevmode\setcolor{\urlcolor}%
1399 \startlink attr{/Border [0 0 0]}%
1400 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1401 \endgroup}
1402 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1403 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1404 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1405 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1406 \def\maketoks{%
1407 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1408 \ifx\first0\adn0
1409 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1410 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1411 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1412 \else
1413 \ifnum0=\countA\else\makelink\fi
1414 \ifx\first.\let\next=\done\else
1415 \let\next=\maketoks
1416 \addtokens{\toksB}{\the\toksD}
1417 \ifx\first,\addtokens{\toksB}{\space}\fi
1419 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1420 \next}
1421 \def\makelink{\addtokens{\toksB}%
1422 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1423 \def\pdflink#1{%
1424 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1425 \setcolor{\linkcolor}#1\endlink}
1426 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1427 \else
1428 % non-pdf mode
1429 \let\pdfmkdest = \gobble
1430 \let\pdfurl = \gobble
1431 \let\endlink = \relax
1432 \let\setcolor = \gobble
1433 \let\pdfsetcolor = \gobble
1434 \let\pdfmakeoutlines = \relax
1435 \fi % \ifx\pdfoutput
1438 \message{fonts,}
1440 % Change the current font style to #1, remembering it in \curfontstyle.
1441 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1442 % italics, not bold italics.
1444 \def\setfontstyle#1{%
1445 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1446 \csname ten#1\endcsname % change the current font
1449 % Select #1 fonts with the current style.
1451 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1453 \def\rm{\fam=0 \setfontstyle{rm}}
1454 \def\it{\fam=\itfam \setfontstyle{it}}
1455 \def\sl{\fam=\slfam \setfontstyle{sl}}
1456 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1457 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1459 % Unfortunately, we have to override this for titles and the like, since
1460 % in those cases "rm" is bold. Sigh.
1461 \def\rmisbold{\rm\def\curfontstyle{bf}}
1463 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1464 % So we set up a \sf.
1465 \newfam\sffam
1466 \def\sf{\fam=\sffam \setfontstyle{sf}}
1467 \let\li = \sf % Sometimes we call it \li, not \sf.
1469 % We don't need math for this font style.
1470 \def\ttsl{\setfontstyle{ttsl}}
1473 % Set the baselineskip to #1, and the lineskip and strut size
1474 % correspondingly. There is no deep meaning behind these magic numbers
1475 % used as factors; they just match (closely enough) what Knuth defined.
1477 \def\lineskipfactor{.08333}
1478 \def\strutheightpercent{.70833}
1479 \def\strutdepthpercent {.29167}
1481 % can get a sort of poor man's double spacing by redefining this.
1482 \def\baselinefactor{1}
1484 \newdimen\textleading
1485 \def\setleading#1{%
1486 \dimen0 = #1\relax
1487 \normalbaselineskip = \baselinefactor\dimen0
1488 \normallineskip = \lineskipfactor\normalbaselineskip
1489 \normalbaselines
1490 \setbox\strutbox =\hbox{%
1491 \vrule width0pt height\strutheightpercent\baselineskip
1492 depth \strutdepthpercent \baselineskip
1496 % PDF CMaps. See also LaTeX's t1.cmap.
1498 % do nothing with this by default.
1499 \expandafter\let\csname cmapOT1\endcsname\gobble
1500 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1501 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1503 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1504 % (\pdffontattr was introduced many years ago, but people still run
1505 % older pdftex's; it's easy to conditionalize, so we do.)
1506 \ifpdf \ifx\pdffontattr\thisisundefined \else
1507 \begingroup
1508 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1509 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1510 %%DocumentNeededResources: ProcSet (CIDInit)
1511 %%IncludeResource: ProcSet (CIDInit)
1512 %%BeginResource: CMap (TeX-OT1-0)
1513 %%Title: (TeX-OT1-0 TeX OT1 0)
1514 %%Version: 1.000
1515 %%EndComments
1516 /CIDInit /ProcSet findresource begin
1517 12 dict begin
1518 begincmap
1519 /CIDSystemInfo
1520 << /Registry (TeX)
1521 /Ordering (OT1)
1522 /Supplement 0
1523 >> def
1524 /CMapName /TeX-OT1-0 def
1525 /CMapType 2 def
1526 1 begincodespacerange
1527 <00> <7F>
1528 endcodespacerange
1529 8 beginbfrange
1530 <00> <01> <0393>
1531 <09> <0A> <03A8>
1532 <23> <26> <0023>
1533 <28> <3B> <0028>
1534 <3F> <5B> <003F>
1535 <5D> <5E> <005D>
1536 <61> <7A> <0061>
1537 <7B> <7C> <2013>
1538 endbfrange
1539 40 beginbfchar
1540 <02> <0398>
1541 <03> <039B>
1542 <04> <039E>
1543 <05> <03A0>
1544 <06> <03A3>
1545 <07> <03D2>
1546 <08> <03A6>
1547 <0B> <00660066>
1548 <0C> <00660069>
1549 <0D> <0066006C>
1550 <0E> <006600660069>
1551 <0F> <00660066006C>
1552 <10> <0131>
1553 <11> <0237>
1554 <12> <0060>
1555 <13> <00B4>
1556 <14> <02C7>
1557 <15> <02D8>
1558 <16> <00AF>
1559 <17> <02DA>
1560 <18> <00B8>
1561 <19> <00DF>
1562 <1A> <00E6>
1563 <1B> <0153>
1564 <1C> <00F8>
1565 <1D> <00C6>
1566 <1E> <0152>
1567 <1F> <00D8>
1568 <21> <0021>
1569 <22> <201D>
1570 <27> <2019>
1571 <3C> <00A1>
1572 <3D> <003D>
1573 <3E> <00BF>
1574 <5C> <201C>
1575 <5F> <02D9>
1576 <60> <2018>
1577 <7D> <02DD>
1578 <7E> <007E>
1579 <7F> <00A8>
1580 endbfchar
1581 endcmap
1582 CMapName currentdict /CMap defineresource pop
1585 %%EndResource
1586 %%EOF
1587 }\endgroup
1588 \expandafter\edef\csname cmapOT1\endcsname#1{%
1589 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1592 % \cmapOT1IT
1593 \begingroup
1594 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1595 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1596 %%DocumentNeededResources: ProcSet (CIDInit)
1597 %%IncludeResource: ProcSet (CIDInit)
1598 %%BeginResource: CMap (TeX-OT1IT-0)
1599 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1600 %%Version: 1.000
1601 %%EndComments
1602 /CIDInit /ProcSet findresource begin
1603 12 dict begin
1604 begincmap
1605 /CIDSystemInfo
1606 << /Registry (TeX)
1607 /Ordering (OT1IT)
1608 /Supplement 0
1609 >> def
1610 /CMapName /TeX-OT1IT-0 def
1611 /CMapType 2 def
1612 1 begincodespacerange
1613 <00> <7F>
1614 endcodespacerange
1615 8 beginbfrange
1616 <00> <01> <0393>
1617 <09> <0A> <03A8>
1618 <25> <26> <0025>
1619 <28> <3B> <0028>
1620 <3F> <5B> <003F>
1621 <5D> <5E> <005D>
1622 <61> <7A> <0061>
1623 <7B> <7C> <2013>
1624 endbfrange
1625 42 beginbfchar
1626 <02> <0398>
1627 <03> <039B>
1628 <04> <039E>
1629 <05> <03A0>
1630 <06> <03A3>
1631 <07> <03D2>
1632 <08> <03A6>
1633 <0B> <00660066>
1634 <0C> <00660069>
1635 <0D> <0066006C>
1636 <0E> <006600660069>
1637 <0F> <00660066006C>
1638 <10> <0131>
1639 <11> <0237>
1640 <12> <0060>
1641 <13> <00B4>
1642 <14> <02C7>
1643 <15> <02D8>
1644 <16> <00AF>
1645 <17> <02DA>
1646 <18> <00B8>
1647 <19> <00DF>
1648 <1A> <00E6>
1649 <1B> <0153>
1650 <1C> <00F8>
1651 <1D> <00C6>
1652 <1E> <0152>
1653 <1F> <00D8>
1654 <21> <0021>
1655 <22> <201D>
1656 <23> <0023>
1657 <24> <00A3>
1658 <27> <2019>
1659 <3C> <00A1>
1660 <3D> <003D>
1661 <3E> <00BF>
1662 <5C> <201C>
1663 <5F> <02D9>
1664 <60> <2018>
1665 <7D> <02DD>
1666 <7E> <007E>
1667 <7F> <00A8>
1668 endbfchar
1669 endcmap
1670 CMapName currentdict /CMap defineresource pop
1673 %%EndResource
1674 %%EOF
1675 }\endgroup
1676 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1677 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1680 % \cmapOT1TT
1681 \begingroup
1682 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1683 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1684 %%DocumentNeededResources: ProcSet (CIDInit)
1685 %%IncludeResource: ProcSet (CIDInit)
1686 %%BeginResource: CMap (TeX-OT1TT-0)
1687 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1688 %%Version: 1.000
1689 %%EndComments
1690 /CIDInit /ProcSet findresource begin
1691 12 dict begin
1692 begincmap
1693 /CIDSystemInfo
1694 << /Registry (TeX)
1695 /Ordering (OT1TT)
1696 /Supplement 0
1697 >> def
1698 /CMapName /TeX-OT1TT-0 def
1699 /CMapType 2 def
1700 1 begincodespacerange
1701 <00> <7F>
1702 endcodespacerange
1703 5 beginbfrange
1704 <00> <01> <0393>
1705 <09> <0A> <03A8>
1706 <21> <26> <0021>
1707 <28> <5F> <0028>
1708 <61> <7E> <0061>
1709 endbfrange
1710 32 beginbfchar
1711 <02> <0398>
1712 <03> <039B>
1713 <04> <039E>
1714 <05> <03A0>
1715 <06> <03A3>
1716 <07> <03D2>
1717 <08> <03A6>
1718 <0B> <2191>
1719 <0C> <2193>
1720 <0D> <0027>
1721 <0E> <00A1>
1722 <0F> <00BF>
1723 <10> <0131>
1724 <11> <0237>
1725 <12> <0060>
1726 <13> <00B4>
1727 <14> <02C7>
1728 <15> <02D8>
1729 <16> <00AF>
1730 <17> <02DA>
1731 <18> <00B8>
1732 <19> <00DF>
1733 <1A> <00E6>
1734 <1B> <0153>
1735 <1C> <00F8>
1736 <1D> <00C6>
1737 <1E> <0152>
1738 <1F> <00D8>
1739 <20> <2423>
1740 <27> <2019>
1741 <60> <2018>
1742 <7F> <00A8>
1743 endbfchar
1744 endcmap
1745 CMapName currentdict /CMap defineresource pop
1748 %%EndResource
1749 %%EOF
1750 }\endgroup
1751 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1752 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1754 \fi\fi
1757 % Set the font macro #1 to the font named \fontprefix#2.
1758 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1759 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
1760 % Example:
1761 % #1 = \textrm
1762 % #2 = \rmshape
1763 % #3 = 10
1764 % #4 = \mainmagstep
1765 % #5 = OT1
1767 \def\setfont#1#2#3#4#5{%
1768 \font#1=\fontprefix#2#3 scaled #4
1769 \csname cmap#5\endcsname#1%
1771 % This is what gets called when #5 of \setfont is empty.
1772 \let\cmap\gobble
1774 % (end of cmaps)
1776 % Use cm as the default font prefix.
1777 % To specify the font prefix, you must define \fontprefix
1778 % before you read in texinfo.tex.
1779 \ifx\fontprefix\thisisundefined
1780 \def\fontprefix{cm}
1782 % Support font families that don't use the same naming scheme as CM.
1783 \def\rmshape{r}
1784 \def\rmbshape{bx} % where the normal face is bold
1785 \def\bfshape{b}
1786 \def\bxshape{bx}
1787 \def\ttshape{tt}
1788 \def\ttbshape{tt}
1789 \def\ttslshape{sltt}
1790 \def\itshape{ti}
1791 \def\itbshape{bxti}
1792 \def\slshape{sl}
1793 \def\slbshape{bxsl}
1794 \def\sfshape{ss}
1795 \def\sfbshape{ss}
1796 \def\scshape{csc}
1797 \def\scbshape{csc}
1799 % Definitions for a main text size of 11pt. (The default in Texinfo.)
1801 \def\definetextfontsizexi{%
1802 % Text fonts (11.2pt, magstep1).
1803 \def\textnominalsize{11pt}
1804 \edef\mainmagstep{\magstephalf}
1805 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1806 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1807 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1808 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1809 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1810 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1811 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1812 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1813 \font\texti=cmmi10 scaled \mainmagstep
1814 \font\textsy=cmsy10 scaled \mainmagstep
1815 \def\textecsize{1095}
1817 % A few fonts for @defun names and args.
1818 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1819 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1820 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1821 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1823 % Fonts for indices, footnotes, small examples (9pt).
1824 \def\smallnominalsize{9pt}
1825 \setfont\smallrm\rmshape{9}{1000}{OT1}
1826 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1827 \setfont\smallbf\bfshape{10}{900}{OT1}
1828 \setfont\smallit\itshape{9}{1000}{OT1IT}
1829 \setfont\smallsl\slshape{9}{1000}{OT1}
1830 \setfont\smallsf\sfshape{9}{1000}{OT1}
1831 \setfont\smallsc\scshape{10}{900}{OT1}
1832 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1833 \font\smalli=cmmi9
1834 \font\smallsy=cmsy9
1835 \def\smallecsize{0900}
1837 % Fonts for small examples (8pt).
1838 \def\smallernominalsize{8pt}
1839 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1840 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1841 \setfont\smallerbf\bfshape{10}{800}{OT1}
1842 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1843 \setfont\smallersl\slshape{8}{1000}{OT1}
1844 \setfont\smallersf\sfshape{8}{1000}{OT1}
1845 \setfont\smallersc\scshape{10}{800}{OT1}
1846 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1847 \font\smalleri=cmmi8
1848 \font\smallersy=cmsy8
1849 \def\smallerecsize{0800}
1851 % Fonts for title page (20.4pt):
1852 \def\titlenominalsize{20pt}
1853 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1854 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1855 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1856 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1857 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1858 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1859 \let\titlebf=\titlerm
1860 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1861 \font\titlei=cmmi12 scaled \magstep3
1862 \font\titlesy=cmsy10 scaled \magstep4
1863 \def\titleecsize{2074}
1865 % Chapter (and unnumbered) fonts (17.28pt).
1866 \def\chapnominalsize{17pt}
1867 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1868 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1869 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1870 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1871 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1872 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1873 \let\chapbf=\chaprm
1874 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1875 \font\chapi=cmmi12 scaled \magstep2
1876 \font\chapsy=cmsy10 scaled \magstep3
1877 \def\chapecsize{1728}
1879 % Section fonts (14.4pt).
1880 \def\secnominalsize{14pt}
1881 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1882 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1883 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1884 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1885 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1886 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1887 \let\secbf\secrm
1888 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1889 \font\seci=cmmi12 scaled \magstep1
1890 \font\secsy=cmsy10 scaled \magstep2
1891 \def\sececsize{1440}
1893 % Subsection fonts (13.15pt).
1894 \def\ssecnominalsize{13pt}
1895 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1896 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1897 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1898 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1899 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1900 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1901 \let\ssecbf\ssecrm
1902 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1903 \font\sseci=cmmi12 scaled \magstephalf
1904 \font\ssecsy=cmsy10 scaled 1315
1905 \def\ssececsize{1200}
1907 % Reduced fonts for @acro in text (10pt).
1908 \def\reducednominalsize{10pt}
1909 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1910 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1911 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1912 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1913 \setfont\reducedsl\slshape{10}{1000}{OT1}
1914 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1915 \setfont\reducedsc\scshape{10}{1000}{OT1}
1916 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1917 \font\reducedi=cmmi10
1918 \font\reducedsy=cmsy10
1919 \def\reducedecsize{1000}
1921 \textleading = 13.2pt % line spacing for 11pt CM
1922 \textfonts % reset the current fonts
1924 } % end of 11pt text font size definitions, \definetextfontsizexi
1927 % Definitions to make the main text be 10pt Computer Modern, with
1928 % section, chapter, etc., sizes following suit. This is for the GNU
1929 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1930 % future. Used with @smallbook, which sets the leading to 12pt.
1932 \def\definetextfontsizex{%
1933 % Text fonts (10pt).
1934 \def\textnominalsize{10pt}
1935 \edef\mainmagstep{1000}
1936 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1937 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1938 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1939 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1940 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1941 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1942 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1943 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1944 \font\texti=cmmi10 scaled \mainmagstep
1945 \font\textsy=cmsy10 scaled \mainmagstep
1946 \def\textecsize{1000}
1948 % A few fonts for @defun names and args.
1949 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
1950 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
1951 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
1952 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1954 % Fonts for indices, footnotes, small examples (9pt).
1955 \def\smallnominalsize{9pt}
1956 \setfont\smallrm\rmshape{9}{1000}{OT1}
1957 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1958 \setfont\smallbf\bfshape{10}{900}{OT1}
1959 \setfont\smallit\itshape{9}{1000}{OT1IT}
1960 \setfont\smallsl\slshape{9}{1000}{OT1}
1961 \setfont\smallsf\sfshape{9}{1000}{OT1}
1962 \setfont\smallsc\scshape{10}{900}{OT1}
1963 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1964 \font\smalli=cmmi9
1965 \font\smallsy=cmsy9
1966 \def\smallecsize{0900}
1968 % Fonts for small examples (8pt).
1969 \def\smallernominalsize{8pt}
1970 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1971 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1972 \setfont\smallerbf\bfshape{10}{800}{OT1}
1973 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1974 \setfont\smallersl\slshape{8}{1000}{OT1}
1975 \setfont\smallersf\sfshape{8}{1000}{OT1}
1976 \setfont\smallersc\scshape{10}{800}{OT1}
1977 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1978 \font\smalleri=cmmi8
1979 \font\smallersy=cmsy8
1980 \def\smallerecsize{0800}
1982 % Fonts for title page (20.4pt):
1983 \def\titlenominalsize{20pt}
1984 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1985 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1986 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1987 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1988 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1989 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1990 \let\titlebf=\titlerm
1991 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1992 \font\titlei=cmmi12 scaled \magstep3
1993 \font\titlesy=cmsy10 scaled \magstep4
1994 \def\titleecsize{2074}
1996 % Chapter fonts (14.4pt).
1997 \def\chapnominalsize{14pt}
1998 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
1999 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2000 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2001 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2002 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2003 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2004 \let\chapbf\chaprm
2005 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2006 \font\chapi=cmmi12 scaled \magstep1
2007 \font\chapsy=cmsy10 scaled \magstep2
2008 \def\chapecsize{1440}
2010 % Section fonts (12pt).
2011 \def\secnominalsize{12pt}
2012 \setfont\secrm\rmbshape{12}{1000}{OT1}
2013 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2014 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2015 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2016 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2017 \setfont\secsf\sfbshape{12}{1000}{OT1}
2018 \let\secbf\secrm
2019 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2020 \font\seci=cmmi12
2021 \font\secsy=cmsy10 scaled \magstep1
2022 \def\sececsize{1200}
2024 % Subsection fonts (10pt).
2025 \def\ssecnominalsize{10pt}
2026 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2027 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2028 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2029 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2030 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2031 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2032 \let\ssecbf\ssecrm
2033 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2034 \font\sseci=cmmi10
2035 \font\ssecsy=cmsy10
2036 \def\ssececsize{1000}
2038 % Reduced fonts for @acro in text (9pt).
2039 \def\reducednominalsize{9pt}
2040 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2041 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2042 \setfont\reducedbf\bfshape{10}{900}{OT1}
2043 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2044 \setfont\reducedsl\slshape{9}{1000}{OT1}
2045 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2046 \setfont\reducedsc\scshape{10}{900}{OT1}
2047 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2048 \font\reducedi=cmmi9
2049 \font\reducedsy=cmsy9
2050 \def\reducedecsize{0900}
2052 \divide\parskip by 2 % reduce space between paragraphs
2053 \textleading = 12pt % line spacing for 10pt CM
2054 \textfonts % reset the current fonts
2056 } % end of 10pt text font size definitions, \definetextfontsizex
2059 % We provide the user-level command
2060 % @fonttextsize 10
2061 % (or 11) to redefine the text font size. pt is assumed.
2063 \def\xiword{11}
2064 \def\xword{10}
2065 \def\xwordpt{10pt}
2067 \parseargdef\fonttextsize{%
2068 \def\textsizearg{#1}%
2069 %\wlog{doing @fonttextsize \textsizearg}%
2071 % Set \globaldefs so that documents can use this inside @tex, since
2072 % makeinfo 4.8 does not support it, but we need it nonetheless.
2074 \begingroup \globaldefs=1
2075 \ifx\textsizearg\xword \definetextfontsizex
2076 \else \ifx\textsizearg\xiword \definetextfontsizexi
2077 \else
2078 \errhelp=\EMsimple
2079 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2080 \fi\fi
2081 \endgroup
2084 % In order for the font changes to affect most math symbols and letters,
2085 % we have to define the \textfont of the standard families. We don't
2086 % bother to reset \scriptfont and \scriptscriptfont; awaiting user need.
2088 \def\resetmathfonts{%
2089 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2090 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2091 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2094 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2095 % of just \STYLE. We do this because \STYLE needs to also set the
2096 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2097 % \tenSTYLE to set the current font.
2099 % Each font-changing command also sets the names \lsize (one size lower)
2100 % and \lllsize (three sizes lower). These relative commands are used
2101 % in, e.g., the LaTeX logo and acronyms.
2103 % This all needs generalizing, badly.
2105 \def\textfonts{%
2106 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2107 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2108 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2109 \let\tenttsl=\textttsl
2110 \def\curfontsize{text}%
2111 \def\lsize{reduced}\def\lllsize{smaller}%
2112 \resetmathfonts \setleading{\textleading}}
2113 \def\titlefonts{%
2114 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2115 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2116 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2117 \let\tenttsl=\titlettsl
2118 \def\curfontsize{title}%
2119 \def\lsize{chap}\def\lllsize{subsec}%
2120 \resetmathfonts \setleading{27pt}}
2121 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2122 \def\chapfonts{%
2123 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2124 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2125 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2126 \let\tenttsl=\chapttsl
2127 \def\curfontsize{chap}%
2128 \def\lsize{sec}\def\lllsize{text}%
2129 \resetmathfonts \setleading{19pt}}
2130 \def\secfonts{%
2131 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2132 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2133 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2134 \let\tenttsl=\secttsl
2135 \def\curfontsize{sec}%
2136 \def\lsize{subsec}\def\lllsize{reduced}%
2137 \resetmathfonts \setleading{17pt}}
2138 \def\subsecfonts{%
2139 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2140 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2141 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2142 \let\tenttsl=\ssecttsl
2143 \def\curfontsize{ssec}%
2144 \def\lsize{text}\def\lllsize{small}%
2145 \resetmathfonts \setleading{15pt}}
2146 \let\subsubsecfonts = \subsecfonts
2147 \def\reducedfonts{%
2148 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2149 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2150 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2151 \let\tenttsl=\reducedttsl
2152 \def\curfontsize{reduced}%
2153 \def\lsize{small}\def\lllsize{smaller}%
2154 \resetmathfonts \setleading{10.5pt}}
2155 \def\smallfonts{%
2156 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2157 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2158 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2159 \let\tenttsl=\smallttsl
2160 \def\curfontsize{small}%
2161 \def\lsize{smaller}\def\lllsize{smaller}%
2162 \resetmathfonts \setleading{10.5pt}}
2163 \def\smallerfonts{%
2164 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2165 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2166 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2167 \let\tenttsl=\smallerttsl
2168 \def\curfontsize{smaller}%
2169 \def\lsize{smaller}\def\lllsize{smaller}%
2170 \resetmathfonts \setleading{9.5pt}}
2172 % Fonts for short table of contents.
2173 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2174 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2175 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2176 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2178 % Define these just so they can be easily changed for other fonts.
2179 \def\angleleft{$\langle$}
2180 \def\angleright{$\rangle$}
2182 % Set the fonts to use with the @small... environments.
2183 \let\smallexamplefonts = \smallfonts
2185 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2186 % can fit this many characters:
2187 % 8.5x11=86 smallbook=72 a4=90 a5=69
2188 % If we use \scriptfonts (8pt), then we can fit this many characters:
2189 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2190 % For me, subjectively, the few extra characters that fit aren't worth
2191 % the additional smallness of 8pt. So I'm making the default 9pt.
2193 % By the way, for comparison, here's what fits with @example (10pt):
2194 % 8.5x11=71 smallbook=60 a4=75 a5=58
2195 % --karl, 24jan03.
2197 % Set up the default fonts, so we can use them for creating boxes.
2199 \definetextfontsizexi
2202 \message{markup,}
2204 % Check if we are currently using a typewriter font. Since all the
2205 % Computer Modern typewriter fonts have zero interword stretch (and
2206 % shrink), and it is reasonable to expect all typewriter fonts to have
2207 % this property, we can check that font parameter.
2209 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2211 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2212 % define and register \INITMACRO to be called on markup style changes.
2213 % \INITMACRO can check \currentmarkupstyle for the innermost
2214 % style and the set of \ifmarkupSTYLE switches for all styles
2215 % currently in effect.
2216 \newif\ifmarkupvar
2217 \newif\ifmarkupsamp
2218 \newif\ifmarkupkey
2219 %\newif\ifmarkupfile % @file == @samp.
2220 %\newif\ifmarkupoption % @option == @samp.
2221 \newif\ifmarkupcode
2222 \newif\ifmarkupkbd
2223 %\newif\ifmarkupenv % @env == @code.
2224 %\newif\ifmarkupcommand % @command == @code.
2225 \newif\ifmarkuptex % @tex (and part of @math, for now).
2226 \newif\ifmarkupexample
2227 \newif\ifmarkupverb
2228 \newif\ifmarkupverbatim
2230 \let\currentmarkupstyle\empty
2232 \def\setupmarkupstyle#1{%
2233 \csname markup#1true\endcsname
2234 \def\currentmarkupstyle{#1}%
2235 \markupstylesetup
2238 \let\markupstylesetup\empty
2240 \def\defmarkupstylesetup#1{%
2241 \expandafter\def\expandafter\markupstylesetup
2242 \expandafter{\markupstylesetup #1}%
2243 \def#1%
2246 % Markup style setup for left and right quotes.
2247 \defmarkupstylesetup\markupsetuplq{%
2248 \expandafter\let\expandafter \temp
2249 \csname markupsetuplq\currentmarkupstyle\endcsname
2250 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2253 \defmarkupstylesetup\markupsetuprq{%
2254 \expandafter\let\expandafter \temp
2255 \csname markupsetuprq\currentmarkupstyle\endcsname
2256 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2260 \catcode`\'=\active
2261 \catcode`\`=\active
2263 \gdef\markupsetuplqdefault{\let`\lq}
2264 \gdef\markupsetuprqdefault{\let'\rq}
2266 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2267 \gdef\markupsetcodequoteright{\let'\codequoteright}
2270 \let\markupsetuplqcode \markupsetcodequoteleft
2271 \let\markupsetuprqcode \markupsetcodequoteright
2273 \let\markupsetuplqexample \markupsetcodequoteleft
2274 \let\markupsetuprqexample \markupsetcodequoteright
2276 \let\markupsetuplqkbd \markupsetcodequoteleft
2277 \let\markupsetuprqkbd \markupsetcodequoteright
2279 \let\markupsetuplqsamp \markupsetcodequoteleft
2280 \let\markupsetuprqsamp \markupsetcodequoteright
2282 \let\markupsetuplqverb \markupsetcodequoteleft
2283 \let\markupsetuprqverb \markupsetcodequoteright
2285 \let\markupsetuplqverbatim \markupsetcodequoteleft
2286 \let\markupsetuprqverbatim \markupsetcodequoteright
2288 % Allow an option to not use regular directed right quote/apostrophe
2289 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2290 % The undirected quote is ugly, so don't make it the default, but it
2291 % works for pasting with more pdf viewers (at least evince), the
2292 % lilypond developers report. xpdf does work with the regular 0x27.
2294 \def\codequoteright{%
2295 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2296 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2298 \else \char'15 \fi
2299 \else \char'15 \fi
2302 % and a similar option for the left quote char vs. a grave accent.
2303 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2304 % the code environments to do likewise.
2306 \def\codequoteleft{%
2307 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2308 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2309 % [Knuth] pp. 380,381,391
2310 % \relax disables Spanish ligatures ?` and !` of \tt font.
2311 \relax`%
2312 \else \char'22 \fi
2313 \else \char'22 \fi
2316 % Commands to set the quote options.
2318 \parseargdef\codequoteundirected{%
2319 \def\temp{#1}%
2320 \ifx\temp\onword
2321 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2322 = t%
2323 \else\ifx\temp\offword
2324 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2325 = \relax
2326 \else
2327 \errhelp = \EMsimple
2328 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2329 \fi\fi
2332 \parseargdef\codequotebacktick{%
2333 \def\temp{#1}%
2334 \ifx\temp\onword
2335 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2336 = t%
2337 \else\ifx\temp\offword
2338 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2339 = \relax
2340 \else
2341 \errhelp = \EMsimple
2342 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2343 \fi\fi
2346 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2347 \def\noligaturesquoteleft{\relax\lq}
2349 % Count depth in font-changes, for error checks
2350 \newcount\fontdepth \fontdepth=0
2352 % Font commands.
2354 % #1 is the font command (\sl or \it), #2 is the text to slant.
2355 % If we are in a monospaced environment, however, 1) always use \ttsl,
2356 % and 2) do not add an italic correction.
2357 \def\dosmartslant#1#2{%
2358 \ifusingtt
2359 {{\ttsl #2}\let\next=\relax}%
2360 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2361 \next
2363 \def\smartslanted{\dosmartslant\sl}
2364 \def\smartitalic{\dosmartslant\it}
2366 % Output an italic correction unless \next (presumed to be the following
2367 % character) is such as not to need one.
2368 \def\smartitaliccorrection{%
2369 \ifx\next,%
2370 \else\ifx\next-%
2371 \else\ifx\next.%
2372 \else\ifx\next\.%
2373 \else\ifx\next\comma%
2374 \else\ptexslash
2375 \fi\fi\fi\fi\fi
2376 \aftersmartic
2379 % Unconditional use \ttsl, and no ic. @var is set to this for defuns.
2380 \def\ttslanted#1{{\ttsl #1}}
2382 % @cite is like \smartslanted except unconditionally use \sl. We never want
2383 % ttsl for book titles, do we?
2384 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2386 \def\aftersmartic{}
2387 \def\var#1{%
2388 \let\saveaftersmartic = \aftersmartic
2389 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2390 \smartslanted{#1}%
2393 \let\i=\smartitalic
2394 \let\slanted=\smartslanted
2395 \let\dfn=\smartslanted
2396 \let\emph=\smartitalic
2398 % Explicit font changes: @r, @sc, undocumented @ii.
2399 \def\r#1{{\rm #1}} % roman font
2400 \def\sc#1{{\smallcaps#1}} % smallcaps font
2401 \def\ii#1{{\it #1}} % italic font
2403 % @b, explicit bold. Also @strong.
2404 \def\b#1{{\bf #1}}
2405 \let\strong=\b
2407 % @sansserif, explicit sans.
2408 \def\sansserif#1{{\sf #1}}
2410 % We can't just use \exhyphenpenalty, because that only has effect at
2411 % the end of a paragraph. Restore normal hyphenation at the end of the
2412 % group within which \nohyphenation is presumably called.
2414 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2415 \def\restorehyphenation{\hyphenchar\font = `- }
2417 % Set sfcode to normal for the chars that usually have another value.
2418 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2419 % sometimes \x has an active definition that messes things up.
2421 \catcode`@=11
2422 \def\plainfrenchspacing{%
2423 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2424 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2425 \def\endofsentencespacefactor{1000}% for @. and friends
2427 \def\plainnonfrenchspacing{%
2428 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2429 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2430 \def\endofsentencespacefactor{3000}% for @. and friends
2432 \catcode`@=\other
2433 \def\endofsentencespacefactor{3000}% default
2435 % @t, explicit typewriter.
2436 \def\t#1{%
2437 {\tt \rawbackslash \plainfrenchspacing #1}%
2438 \null
2441 % @samp.
2442 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2444 % @indicateurl is \samp, that is, with quotes.
2445 \let\indicateurl=\samp
2447 % @code (and similar) prints in typewriter, but with spaces the same
2448 % size as normal in the surrounding text, without hyphenation, etc.
2449 % This is a subroutine for that.
2450 \def\tclose#1{%
2452 % Change normal interword space to be same as for the current font.
2453 \spaceskip = \fontdimen2\font
2455 % Switch to typewriter.
2458 % But `\ ' produces the large typewriter interword space.
2459 \def\ {{\spaceskip = 0pt{} }}%
2461 % Turn off hyphenation.
2462 \nohyphenation
2464 \rawbackslash
2465 \plainfrenchspacing
2468 \null % reset spacefactor to 1000
2471 % We *must* turn on hyphenation at `-' and `_' in @code.
2472 % (But see \codedashfinish below.)
2473 % Otherwise, it is too hard to avoid overfull hboxes
2474 % in the Emacs manual, the Library manual, etc.
2476 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2477 % both hyphenation at - and hyphenation within words.
2478 % We must therefore turn them both off (\tclose does that)
2479 % and arrange explicitly to hyphenate at a dash. -- rms.
2481 \catcode`\-=\active \catcode`\_=\active
2482 \catcode`\'=\active \catcode`\`=\active
2483 \global\let'=\rq \global\let`=\lq % default definitions
2485 \global\def\code{\begingroup
2486 \setupmarkupstyle{code}%
2487 % The following should really be moved into \setupmarkupstyle handlers.
2488 \catcode\dashChar=\active \catcode\underChar=\active
2489 \ifallowcodebreaks
2490 \let-\codedash
2491 \let_\codeunder
2492 \else
2493 \let-\normaldash
2494 \let_\realunder
2496 % Given -foo (with a single dash), we do not want to allow a break
2497 % after the hyphen.
2498 \global\let\codedashprev=\codedash
2500 \codex
2503 \gdef\codedash{\futurelet\next\codedashfinish}
2504 \gdef\codedashfinish{%
2505 \normaldash % always output the dash character itself.
2507 % Now, output a discretionary to allow a line break, unless
2508 % (a) the next character is a -, or
2509 % (b) the preceding character is a -.
2510 % E.g., given --posix, we do not want to allow a break after either -.
2511 % Given --foo-bar, we do want to allow a break between the - and the b.
2512 \ifx\next\codedash \else
2513 \ifx\codedashprev\codedash
2514 \else \discretionary{}{}{}\fi
2516 % we need the space after the = for the case when \next itself is a
2517 % space token; it would get swallowed otherwise. As in @code{- a}.
2518 \global\let\codedashprev= \next
2521 \def\normaldash{-}
2523 \def\codex #1{\tclose{#1}\endgroup}
2525 \def\codeunder{%
2526 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2527 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2528 % will therefore expand the active definition of _, which is us
2529 % (inside @code that is), therefore an endless loop.
2530 \ifusingtt{\ifmmode
2531 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2532 \else\normalunderscore \fi
2533 \discretionary{}{}{}}%
2534 {\_}%
2537 % An additional complication: the above will allow breaks after, e.g.,
2538 % each of the four underscores in __typeof__. This is bad.
2539 % @allowcodebreaks provides a document-level way to turn breaking at -
2540 % and _ on and off.
2542 \newif\ifallowcodebreaks \allowcodebreakstrue
2544 \def\keywordtrue{true}
2545 \def\keywordfalse{false}
2547 \parseargdef\allowcodebreaks{%
2548 \def\txiarg{#1}%
2549 \ifx\txiarg\keywordtrue
2550 \allowcodebreakstrue
2551 \else\ifx\txiarg\keywordfalse
2552 \allowcodebreaksfalse
2553 \else
2554 \errhelp = \EMsimple
2555 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2556 \fi\fi
2559 % For @command, @env, @file, @option quotes seem unnecessary,
2560 % so use \code rather than \samp.
2561 \let\command=\code
2562 \let\env=\code
2563 \let\file=\code
2564 \let\option=\code
2566 % @uref (abbreviation for `urlref') aka @url takes an optional
2567 % (comma-separated) second argument specifying the text to display and
2568 % an optional third arg as text to display instead of (rather than in
2569 % addition to) the url itself. First (mandatory) arg is the url.
2571 % TeX-only option to allow changing PDF output to show only the second
2572 % arg (if given), and not the url (which is then just the link target).
2573 \newif\ifurefurlonlylink
2575 % The main macro is \urefbreak, which allows breaking at expected
2576 % places within the url. (There used to be another version, which
2577 % didn't support automatic breaking.)
2578 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2579 \let\uref=\urefbreak
2581 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
2582 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
2583 \unsepspaces
2584 \pdfurl{#1}%
2585 \setbox0 = \hbox{\ignorespaces #3}%
2586 \ifdim\wd0 > 0pt
2587 \unhbox0 % third arg given, show only that
2588 \else
2589 \setbox0 = \hbox{\ignorespaces #2}% look for second arg
2590 \ifdim\wd0 > 0pt
2591 \ifpdf
2592 \ifurefurlonlylink
2593 % PDF plus option to not display url, show just arg
2594 \unhbox0
2595 \else
2596 % PDF, normally display both arg and url for consistency,
2597 % visibility, if the pdf is eventually used to print, etc.
2598 \unhbox0\ (\urefcode{#1})%
2600 \else
2601 \unhbox0\ (\urefcode{#1})% DVI, always show arg and url
2603 \else
2604 \urefcode{#1}% only url given, so show it
2607 \endlink
2608 \endgroup}
2610 % Allow line breaks around only a few characters (only).
2611 \def\urefcatcodes{%
2612 \catcode\ampChar=\active \catcode\dotChar=\active
2613 \catcode\hashChar=\active \catcode\questChar=\active
2614 \catcode\slashChar=\active
2617 \urefcatcodes
2619 \global\def\urefcode{\begingroup
2620 \setupmarkupstyle{code}%
2621 \urefcatcodes
2622 \let&\urefcodeamp
2623 \let.\urefcodedot
2624 \let#\urefcodehash
2625 \let?\urefcodequest
2626 \let/\urefcodeslash
2627 \codex
2630 % By default, they are just regular characters.
2631 \global\def&{\normalamp}
2632 \global\def.{\normaldot}
2633 \global\def#{\normalhash}
2634 \global\def?{\normalquest}
2635 \global\def/{\normalslash}
2638 % we put a little stretch before and after the breakable chars, to help
2639 % line breaking of long url's. The unequal skips make look better in
2640 % cmtt at least, especially for dots.
2641 \def\urefprestretchamount{.13em}
2642 \def\urefpoststretchamount{.1em}
2643 \def\urefprestretch{\urefprebreak \hskip0pt plus\urefprestretchamount\relax}
2644 \def\urefpoststretch{\urefpostbreak \hskip0pt plus\urefprestretchamount\relax}
2646 \def\urefcodeamp{\urefprestretch \&\urefpoststretch}
2647 \def\urefcodedot{\urefprestretch .\urefpoststretch}
2648 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
2649 \def\urefcodequest{\urefprestretch ?\urefpoststretch}
2650 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2652 \catcode`\/=\active
2653 \global\def\urefcodeslashfinish{%
2654 \urefprestretch \slashChar
2655 % Allow line break only after the final / in a sequence of
2656 % slashes, to avoid line break between the slashes in http://.
2657 \ifx\next/\else \urefpoststretch \fi
2661 % One more complication: by default we'll break after the special
2662 % characters, but some people like to break before the special chars, so
2663 % allow that. Also allow no breaking at all, for manual control.
2665 \parseargdef\urefbreakstyle{%
2666 \def\txiarg{#1}%
2667 \ifx\txiarg\wordnone
2668 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2669 \else\ifx\txiarg\wordbefore
2670 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2671 \else\ifx\txiarg\wordafter
2672 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2673 \else
2674 \errhelp = \EMsimple
2675 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
2676 \fi\fi\fi
2678 \def\wordafter{after}
2679 \def\wordbefore{before}
2680 \def\wordnone{none}
2682 \urefbreakstyle after
2684 % @url synonym for @uref, since that's how everyone uses it.
2686 \let\url=\uref
2688 % rms does not like angle brackets --karl, 17may97.
2689 % So now @email is just like @uref, unless we are pdf.
2691 %\def\email#1{\angleleft{\tt #1}\angleright}
2692 \ifpdf
2693 \def\email#1{\doemail#1,,\finish}
2694 \def\doemail#1,#2,#3\finish{\begingroup
2695 \unsepspaces
2696 \pdfurl{mailto:#1}%
2697 \setbox0 = \hbox{\ignorespaces #2}%
2698 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2699 \endlink
2700 \endgroup}
2701 \else
2702 \let\email=\uref
2705 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2706 % `example' (@kbd uses ttsl only inside of @example and friends),
2707 % or `code' (@kbd uses normal tty font always).
2708 \parseargdef\kbdinputstyle{%
2709 \def\txiarg{#1}%
2710 \ifx\txiarg\worddistinct
2711 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2712 \else\ifx\txiarg\wordexample
2713 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2714 \else\ifx\txiarg\wordcode
2715 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2716 \else
2717 \errhelp = \EMsimple
2718 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
2719 \fi\fi\fi
2721 \def\worddistinct{distinct}
2722 \def\wordexample{example}
2723 \def\wordcode{code}
2725 % Default is `distinct'.
2726 \kbdinputstyle distinct
2728 % @kbd is like @code, except that if the argument is just one @key command,
2729 % then @kbd has no effect.
2730 \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}}
2732 \def\xkey{\key}
2733 \def\kbdsub#1#2#3\par{%
2734 \def\one{#1}\def\three{#3}\def\threex{??}%
2735 \ifx\one\xkey\ifx\threex\three \key{#2}%
2736 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2737 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2740 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2741 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2742 %\font\keysy=cmsy9
2743 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2744 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2745 % \vbox{\hrule\kern-0.4pt
2746 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2747 % \kern-0.4pt\hrule}%
2748 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2750 % definition of @key with no lozenge. If the current font is already
2751 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2752 % if it isn't monospace, then use \tt.
2754 \def\key#1{{\setupmarkupstyle{key}%
2755 \nohyphenation
2756 \ifmonospace\else\tt\fi
2757 #1}\null}
2759 % @clicksequence{File @click{} Open ...}
2760 \def\clicksequence#1{\begingroup #1\endgroup}
2762 % @clickstyle @arrow (by default)
2763 \parseargdef\clickstyle{\def\click{#1}}
2764 \def\click{\arrow}
2766 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2767 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2769 \def\dmn#1{\thinspace #1}
2771 % @l was never documented to mean ``switch to the Lisp font'',
2772 % and it is not used as such in any manual I can find. We need it for
2773 % Polish suppressed-l. --karl, 22sep96.
2774 %\def\l#1{{\li #1}\null}
2776 % @acronym for "FBI", "NATO", and the like.
2777 % We print this one point size smaller, since it's intended for
2778 % all-uppercase.
2780 \def\acronym#1{\doacronym #1,,\finish}
2781 \def\doacronym#1,#2,#3\finish{%
2782 {\selectfonts\lsize #1}%
2783 \def\temp{#2}%
2784 \ifx\temp\empty \else
2785 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2787 \null % reset \spacefactor=1000
2790 % @abbr for "Comput. J." and the like.
2791 % No font change, but don't do end-of-sentence spacing.
2793 \def\abbr#1{\doabbr #1,,\finish}
2794 \def\doabbr#1,#2,#3\finish{%
2795 {\plainfrenchspacing #1}%
2796 \def\temp{#2}%
2797 \ifx\temp\empty \else
2798 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2800 \null % reset \spacefactor=1000
2803 % @asis just yields its argument. Used with @table, for example.
2805 \def\asis#1{#1}
2807 % @math outputs its argument in math mode.
2809 % One complication: _ usually means subscripts, but it could also mean
2810 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2811 % _ active, and distinguish by seeing if the current family is \slfam,
2812 % which is what @var uses.
2814 \catcode`\_ = \active
2815 \gdef\mathunderscore{%
2816 \catcode`\_=\active
2817 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
2820 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2821 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2822 % particular reason), but this is not advertised and we don't care.
2824 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2825 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
2827 \def\math{%
2828 \tex
2829 \mathunderscore
2830 \let\\ = \mathbackslash
2831 \mathactive
2832 % make the texinfo accent commands work in math mode
2833 \let\"=\ddot
2834 \let\'=\acute
2835 \let\==\bar
2836 \let\^=\hat
2837 \let\`=\grave
2838 \let\u=\breve
2839 \let\v=\check
2840 \let\~=\tilde
2841 \let\dotaccent=\dot
2842 % have to provide another name for sup operator
2843 \let\mathopsup=\sup
2844 $\finishmath
2846 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
2848 % Some active characters (such as <) are spaced differently in math.
2849 % We have to reset their definitions in case the @math was an argument
2850 % to a command which sets the catcodes (such as @item or @section).
2853 \catcode`^ = \active
2854 \catcode`< = \active
2855 \catcode`> = \active
2856 \catcode`+ = \active
2857 \catcode`' = \active
2858 \gdef\mathactive{%
2859 \let^ = \ptexhat
2860 \let< = \ptexless
2861 \let> = \ptexgtr
2862 \let+ = \ptexplus
2863 \let' = \ptexquoteright
2867 % for @sub and @sup, if in math mode, just do a normal sub/superscript.
2868 % If in text, use math to place as sub/superscript, but switch
2869 % into text mode, with smaller fonts. This is a different font than the
2870 % one used for real math sub/superscripts (8pt vs. 7pt), but let's not
2871 % fix it (significant additions to font machinery) until someone notices.
2873 \def\sub{\ifmmode \expandafter\sb \else \expandafter\finishsub\fi}
2874 \def\finishsub#1{$\sb{\hbox{\selectfonts\lllsize #1}}$}%
2876 \def\sup{\ifmmode \expandafter\ptexsp \else \expandafter\finishsup\fi}
2877 \def\finishsup#1{$\ptexsp{\hbox{\selectfonts\lllsize #1}}$}%
2879 % ctrl is no longer a Texinfo command, but leave this definition for fun.
2880 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2882 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
2883 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
2884 % except specified as a normal braced arg, so no newlines to worry about.
2886 \def\outfmtnametex{tex}
2888 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
2889 \long\def\doinlinefmt#1,#2,\finish{%
2890 \def\inlinefmtname{#1}%
2891 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
2894 % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
2895 % FMTNAME is tex, else ELSE-TEXT.
2896 \long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,\finish}
2897 \long\def\doinlinefmtifelse#1,#2,#3,#4,\finish{%
2898 \def\inlinefmtname{#1}%
2899 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
2902 % For raw, must switch into @tex before parsing the argument, to avoid
2903 % setting catcodes prematurely. Doing it this way means that, for
2904 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
2905 % ignored. But this isn't important because if people want a literal
2906 % *right* brace they would have to use a command anyway, so they may as
2907 % well use a command to get a left brace too. We could re-use the
2908 % delimiter character idea from \verb, but it seems like overkill.
2910 \long\def\inlineraw{\tex \doinlineraw}
2911 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
2912 \def\doinlinerawtwo#1,#2,\finish{%
2913 \def\inlinerawname{#1}%
2914 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
2915 \endgroup % close group opened by \tex.
2918 % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
2920 \long\def\inlineifset#1{\doinlineifset #1,\finish}
2921 \long\def\doinlineifset#1,#2,\finish{%
2922 \def\inlinevarname{#1}%
2923 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax
2924 \else\ignorespaces#2\fi
2927 % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
2929 \long\def\inlineifclear#1{\doinlineifclear #1,\finish}
2930 \long\def\doinlineifclear#1,#2,\finish{%
2931 \def\inlinevarname{#1}%
2932 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \ignorespaces#2\fi
2936 \message{glyphs,}
2937 % and logos.
2939 % @@ prints an @, as does @atchar{}.
2940 \def\@{\char64 }
2941 \let\atchar=\@
2943 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
2944 % Unless we're in typewriter, use \ecfont because the CM text fonts do
2945 % not have braces, and we don't want to switch into math.
2946 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2947 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2948 \let\{=\mylbrace \let\lbracechar=\{
2949 \let\}=\myrbrace \let\rbracechar=\}
2950 \begingroup
2951 % Definitions to produce \{ and \} commands for indices,
2952 % and @{ and @} for the aux/toc files.
2953 \catcode`\{ = \other \catcode`\} = \other
2954 \catcode`\[ = 1 \catcode`\] = 2
2955 \catcode`\! = 0 \catcode`\\ = \other
2956 !gdef!lbracecmd[\{]%
2957 !gdef!rbracecmd[\}]%
2958 !gdef!lbraceatcmd[@{]%
2959 !gdef!rbraceatcmd[@}]%
2960 !endgroup
2962 % @comma{} to avoid , parsing problems.
2963 \let\comma = ,
2965 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2966 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2967 \let\, = \ptexc
2968 \let\dotaccent = \ptexdot
2969 \def\ringaccent#1{{\accent23 #1}}
2970 \let\tieaccent = \ptext
2971 \let\ubaraccent = \ptexb
2972 \let\udotaccent = \d
2974 % Other special characters: @questiondown @exclamdown @ordf @ordm
2975 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2976 \def\questiondown{?`}
2977 \def\exclamdown{!`}
2978 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
2979 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
2981 % Dotless i and dotless j, used for accents.
2982 \def\imacro{i}
2983 \def\jmacro{j}
2984 \def\dotless#1{%
2985 \def\temp{#1}%
2986 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2987 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2988 \else \errmessage{@dotless can be used only with i or j}%
2989 \fi\fi
2992 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2993 % period following counts as ending a sentence. (Idea found in latex.)
2995 \edef\TeX{\TeX \spacefactor=1000 }
2997 % @LaTeX{} logo. Not quite the same results as the definition in
2998 % latex.ltx, since we use a different font for the raised A; it's most
2999 % convenient for us to use an explicitly smaller font, rather than using
3000 % the \scriptstyle font (since we don't reset \scriptstyle and
3001 % \scriptscriptstyle).
3003 \def\LaTeX{%
3004 L\kern-.36em
3005 {\setbox0=\hbox{T}%
3006 \vbox to \ht0{\hbox{%
3007 \ifx\textnominalsize\xwordpt
3008 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
3009 % Revert to plain's \scriptsize, which is 7pt.
3010 \count255=\the\fam $\fam\count255 \scriptstyle A$%
3011 \else
3012 % For 11pt, we can use our lllsize.
3013 \selectfonts\lllsize A%
3016 \vss
3018 \kern-.15em
3019 \TeX
3022 % Some math mode symbols.
3023 \def\bullet{$\ptexbullet$}
3024 \def\geq{\ifmmode \ge\else $\ge$\fi}
3025 \def\leq{\ifmmode \le\else $\le$\fi}
3026 \def\minus{\ifmmode -\else $-$\fi}
3028 % @dots{} outputs an ellipsis using the current font.
3029 % We do .5em per period so that it has the same spacing in the cm
3030 % typewriter fonts as three actual period characters; on the other hand,
3031 % in other typewriter fonts three periods are wider than 1.5em. So do
3032 % whichever is larger.
3034 \def\dots{%
3035 \leavevmode
3036 \setbox0=\hbox{...}% get width of three periods
3037 \ifdim\wd0 > 1.5em
3038 \dimen0 = \wd0
3039 \else
3040 \dimen0 = 1.5em
3042 \hbox to \dimen0{%
3043 \hskip 0pt plus.25fil
3044 .\hskip 0pt plus1fil
3045 .\hskip 0pt plus1fil
3046 .\hskip 0pt plus.5fil
3050 % @enddots{} is an end-of-sentence ellipsis.
3052 \def\enddots{%
3053 \dots
3054 \spacefactor=\endofsentencespacefactor
3057 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3059 % Since these characters are used in examples, they should be an even number of
3060 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3062 \def\point{$\star$}
3063 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3064 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3065 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3066 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3067 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3069 % The @error{} command.
3070 % Adapted from the TeXbook's \boxit.
3072 \newbox\errorbox
3074 {\tentt \global\dimen0 = 3em}% Width of the box.
3075 \dimen2 = .55pt % Thickness of rules
3076 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3077 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
3079 \setbox\errorbox=\hbox to \dimen0{\hfil
3080 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3081 \advance\hsize by -2\dimen2 % Rules.
3082 \vbox{%
3083 \hrule height\dimen2
3084 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3085 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3086 \kern3pt\vrule width\dimen2}% Space to right.
3087 \hrule height\dimen2}
3088 \hfil}
3090 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3092 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3094 \def\pounds{{\it\$}}
3096 % @euro{} comes from a separate font, depending on the current style.
3097 % We use the free feym* fonts from the eurosym package by Henrik
3098 % Theiling, which support regular, slanted, bold and bold slanted (and
3099 % "outlined" (blackboard board, sort of) versions, which we don't need).
3100 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3102 % Although only regular is the truly official Euro symbol, we ignore
3103 % that. The Euro is designed to be slightly taller than the regular
3104 % font height.
3106 % feymr - regular
3107 % feymo - slanted
3108 % feybr - bold
3109 % feybo - bold slanted
3111 % There is no good (free) typewriter version, to my knowledge.
3112 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3113 % Hmm.
3115 % Also doesn't work in math. Do we need to do math with euro symbols?
3116 % Hope not.
3119 \def\euro{{\eurofont e}}
3120 \def\eurofont{%
3121 % We set the font at each command, rather than predefining it in
3122 % \textfonts and the other font-switching commands, so that
3123 % installations which never need the symbol don't have to have the
3124 % font installed.
3126 % There is only one designed size (nominal 10pt), so we always scale
3127 % that to the current nominal size.
3129 % By the way, simply using "at 1em" works for cmr10 and the like, but
3130 % does not work for cmbx10 and other extended/shrunken fonts.
3132 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3134 \ifx\curfontstyle\bfstylename
3135 % bold:
3136 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3137 \else
3138 % regular:
3139 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3141 \thiseurofont
3144 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3145 % sometimes we redefine the original macro, and the alias should reflect
3146 % the redefinition.
3148 % Use LaTeX names for the Icelandic letters.
3149 \def\DH{{\ecfont \char"D0}} % Eth
3150 \def\dh{{\ecfont \char"F0}} % eth
3151 \def\TH{{\ecfont \char"DE}} % Thorn
3152 \def\th{{\ecfont \char"FE}} % thorn
3154 \def\guillemetleft{{\ecfont \char"13}}
3155 \def\guillemotleft{\guillemetleft}
3156 \def\guillemetright{{\ecfont \char"14}}
3157 \def\guillemotright{\guillemetright}
3158 \def\guilsinglleft{{\ecfont \char"0E}}
3159 \def\guilsinglright{{\ecfont \char"0F}}
3160 \def\quotedblbase{{\ecfont \char"12}}
3161 \def\quotesinglbase{{\ecfont \char"0D}}
3163 % This positioning is not perfect (see the ogonek LaTeX package), but
3164 % we have the precomposed glyphs for the most common cases. We put the
3165 % tests to use those glyphs in the single \ogonek macro so we have fewer
3166 % dummy definitions to worry about for index entries, etc.
3168 % ogonek is also used with other letters in Lithuanian (IOU), but using
3169 % the precomposed glyphs for those is not so easy since they aren't in
3170 % the same EC font.
3171 \def\ogonek#1{{%
3172 \def\temp{#1}%
3173 \ifx\temp\macrocharA\Aogonek
3174 \else\ifx\temp\macrochara\aogonek
3175 \else\ifx\temp\macrocharE\Eogonek
3176 \else\ifx\temp\macrochare\eogonek
3177 \else
3178 \ecfont \setbox0=\hbox{#1}%
3179 \ifdim\ht0=1ex\accent"0C #1%
3180 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3182 \fi\fi\fi\fi
3185 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3186 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3187 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3188 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3190 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
3191 \def\ecfont{%
3192 % We can't distinguish serif/sans and italic/slanted, but this
3193 % is used for crude hacks anyway (like adding French and German
3194 % quotes to documents typeset with CM, where we lose kerning), so
3195 % hopefully nobody will notice/care.
3196 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3197 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3198 \ifmonospace
3199 % typewriter:
3200 \font\thisecfont = ectt\ecsize \space at \nominalsize
3201 \else
3202 \ifx\curfontstyle\bfstylename
3203 % bold:
3204 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
3205 \else
3206 % regular:
3207 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3210 \thisecfont
3213 % @registeredsymbol - R in a circle. The font for the R should really
3214 % be smaller yet, but lllsize is the best we can do for now.
3215 % Adapted from the plain.tex definition of \copyright.
3217 \def\registeredsymbol{%
3218 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
3219 \hfil\crcr\Orb}}%
3223 % @textdegree - the normal degrees sign.
3225 \def\textdegree{$^\circ$}
3227 % Laurent Siebenmann reports \Orb undefined with:
3228 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3229 % so we'll define it if necessary.
3231 \ifx\Orb\thisisundefined
3232 \def\Orb{\mathhexbox20D}
3235 % Quotes.
3236 \chardef\quotedblleft="5C
3237 \chardef\quotedblright=`\"
3238 \chardef\quoteleft=`\`
3239 \chardef\quoteright=`\'
3242 \message{page headings,}
3244 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3245 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3247 % First the title page. Must do @settitle before @titlepage.
3248 \newif\ifseenauthor
3249 \newif\iffinishedtitlepage
3251 % Do an implicit @contents or @shortcontents after @end titlepage if the
3252 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3254 \newif\ifsetcontentsaftertitlepage
3255 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3256 \newif\ifsetshortcontentsaftertitlepage
3257 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3259 \parseargdef\shorttitlepage{%
3260 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3261 \endgroup\page\hbox{}\page}
3263 \envdef\titlepage{%
3264 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3265 \begingroup
3266 \parindent=0pt \textfonts
3267 % Leave some space at the very top of the page.
3268 \vglue\titlepagetopglue
3269 % No rule at page bottom unless we print one at the top with @title.
3270 \finishedtitlepagetrue
3272 % Most title ``pages'' are actually two pages long, with space
3273 % at the top of the second. We don't want the ragged left on the second.
3274 \let\oldpage = \page
3275 \def\page{%
3276 \iffinishedtitlepage\else
3277 \finishtitlepage
3279 \let\page = \oldpage
3280 \page
3281 \null
3285 \def\Etitlepage{%
3286 \iffinishedtitlepage\else
3287 \finishtitlepage
3289 % It is important to do the page break before ending the group,
3290 % because the headline and footline are only empty inside the group.
3291 % If we use the new definition of \page, we always get a blank page
3292 % after the title page, which we certainly don't want.
3293 \oldpage
3294 \endgroup
3296 % Need this before the \...aftertitlepage checks so that if they are
3297 % in effect the toc pages will come out with page numbers.
3298 \HEADINGSon
3300 % If they want short, they certainly want long too.
3301 \ifsetshortcontentsaftertitlepage
3302 \shortcontents
3303 \contents
3304 \global\let\shortcontents = \relax
3305 \global\let\contents = \relax
3308 \ifsetcontentsaftertitlepage
3309 \contents
3310 \global\let\contents = \relax
3311 \global\let\shortcontents = \relax
3315 \def\finishtitlepage{%
3316 \vskip4pt \hrule height 2pt width \hsize
3317 \vskip\titlepagebottomglue
3318 \finishedtitlepagetrue
3321 % Settings used for typesetting titles: no hyphenation, no indentation,
3322 % don't worry much about spacing, ragged right. This should be used
3323 % inside a \vbox, and fonts need to be set appropriately first. Because
3324 % it is always used for titles, nothing else, we call \rmisbold. \par
3325 % should be specified before the end of the \vbox, since a vbox is a group.
3327 \def\raggedtitlesettings{%
3328 \rmisbold
3329 \hyphenpenalty=10000
3330 \parindent=0pt
3331 \tolerance=5000
3332 \ptexraggedright
3335 % Macros to be used within @titlepage:
3337 \let\subtitlerm=\tenrm
3338 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3340 \parseargdef\title{%
3341 \checkenv\titlepage
3342 \vbox{\titlefonts \raggedtitlesettings #1\par}%
3343 % print a rule at the page bottom also.
3344 \finishedtitlepagefalse
3345 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3348 \parseargdef\subtitle{%
3349 \checkenv\titlepage
3350 {\subtitlefont \rightline{#1}}%
3353 % @author should come last, but may come many times.
3354 % It can also be used inside @quotation.
3356 \parseargdef\author{%
3357 \def\temp{\quotation}%
3358 \ifx\thisenv\temp
3359 \def\quotationauthor{#1}% printed in \Equotation.
3360 \else
3361 \checkenv\titlepage
3362 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3363 {\secfonts\rmisbold \leftline{#1}}%
3368 % Set up page headings and footings.
3370 \let\thispage=\folio
3372 \newtoks\evenheadline % headline on even pages
3373 \newtoks\oddheadline % headline on odd pages
3374 \newtoks\evenfootline % footline on even pages
3375 \newtoks\oddfootline % footline on odd pages
3377 % Now make TeX use those variables
3378 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3379 \else \the\evenheadline \fi}}
3380 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3381 \else \the\evenfootline \fi}\HEADINGShook}
3382 \let\HEADINGShook=\relax
3384 % Commands to set those variables.
3385 % For example, this is what @headings on does
3386 % @evenheading @thistitle|@thispage|@thischapter
3387 % @oddheading @thischapter|@thispage|@thistitle
3388 % @evenfooting @thisfile||
3389 % @oddfooting ||@thisfile
3392 \def\evenheading{\parsearg\evenheadingxxx}
3393 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3394 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3395 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3397 \def\oddheading{\parsearg\oddheadingxxx}
3398 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3399 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3400 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3402 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3404 \def\evenfooting{\parsearg\evenfootingxxx}
3405 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3406 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3407 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3409 \def\oddfooting{\parsearg\oddfootingxxx}
3410 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3411 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3412 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3414 % Leave some space for the footline. Hopefully ok to assume
3415 % @evenfooting will not be used by itself.
3416 \global\advance\pageheight by -12pt
3417 \global\advance\vsize by -12pt
3420 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3422 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3423 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3425 % The same set of arguments for:
3427 % @oddheadingmarks
3428 % @evenfootingmarks
3429 % @oddfootingmarks
3430 % @everyheadingmarks
3431 % @everyfootingmarks
3433 \def\evenheadingmarks{\headingmarks{even}{heading}}
3434 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3435 \def\evenfootingmarks{\headingmarks{even}{footing}}
3436 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3437 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3438 \headingmarks{odd}{heading}{#1} }
3439 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3440 \headingmarks{odd}{footing}{#1} }
3441 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3442 \def\headingmarks#1#2#3 {%
3443 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3444 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3447 \everyheadingmarks bottom
3448 \everyfootingmarks bottom
3450 % @headings double turns headings on for double-sided printing.
3451 % @headings single turns headings on for single-sided printing.
3452 % @headings off turns them off.
3453 % @headings on same as @headings double, retained for compatibility.
3454 % @headings after turns on double-sided headings after this page.
3455 % @headings doubleafter turns on double-sided headings after this page.
3456 % @headings singleafter turns on single-sided headings after this page.
3457 % By default, they are off at the start of a document,
3458 % and turned `on' after @end titlepage.
3460 \def\headings #1 {\csname HEADINGS#1\endcsname}
3462 \def\headingsoff{% non-global headings elimination
3463 \evenheadline={\hfil}\evenfootline={\hfil}%
3464 \oddheadline={\hfil}\oddfootline={\hfil}%
3467 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3468 \HEADINGSoff % it's the default
3470 % When we turn headings on, set the page number to 1.
3471 % For double-sided printing, put current file name in lower left corner,
3472 % chapter name on inside top of right hand pages, document
3473 % title on inside top of left hand pages, and page numbers on outside top
3474 % edge of all pages.
3475 \def\HEADINGSdouble{%
3476 \global\pageno=1
3477 \global\evenfootline={\hfil}
3478 \global\oddfootline={\hfil}
3479 \global\evenheadline={\line{\folio\hfil\thistitle}}
3480 \global\oddheadline={\line{\thischapter\hfil\folio}}
3481 \global\let\contentsalignmacro = \chapoddpage
3483 \let\contentsalignmacro = \chappager
3485 % For single-sided printing, chapter title goes across top left of page,
3486 % page number on top right.
3487 \def\HEADINGSsingle{%
3488 \global\pageno=1
3489 \global\evenfootline={\hfil}
3490 \global\oddfootline={\hfil}
3491 \global\evenheadline={\line{\thischapter\hfil\folio}}
3492 \global\oddheadline={\line{\thischapter\hfil\folio}}
3493 \global\let\contentsalignmacro = \chappager
3495 \def\HEADINGSon{\HEADINGSdouble}
3497 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3498 \let\HEADINGSdoubleafter=\HEADINGSafter
3499 \def\HEADINGSdoublex{%
3500 \global\evenfootline={\hfil}
3501 \global\oddfootline={\hfil}
3502 \global\evenheadline={\line{\folio\hfil\thistitle}}
3503 \global\oddheadline={\line{\thischapter\hfil\folio}}
3504 \global\let\contentsalignmacro = \chapoddpage
3507 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3508 \def\HEADINGSsinglex{%
3509 \global\evenfootline={\hfil}
3510 \global\oddfootline={\hfil}
3511 \global\evenheadline={\line{\thischapter\hfil\folio}}
3512 \global\oddheadline={\line{\thischapter\hfil\folio}}
3513 \global\let\contentsalignmacro = \chappager
3516 % Subroutines used in generating headings
3517 % This produces Day Month Year style of output.
3518 % Only define if not already defined, in case a txi-??.tex file has set
3519 % up a different format (e.g., txi-cs.tex does this).
3520 \ifx\today\thisisundefined
3521 \def\today{%
3522 \number\day\space
3523 \ifcase\month
3524 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3525 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3526 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3528 \space\number\year}
3531 % @settitle line... specifies the title of the document, for headings.
3532 % It generates no output of its own.
3533 \def\thistitle{\putwordNoTitle}
3534 \def\settitle{\parsearg{\gdef\thistitle}}
3537 \message{tables,}
3538 % Tables -- @table, @ftable, @vtable, @item(x).
3540 % default indentation of table text
3541 \newdimen\tableindent \tableindent=.8in
3542 % default indentation of @itemize and @enumerate text
3543 \newdimen\itemindent \itemindent=.3in
3544 % margin between end of table item and start of table text.
3545 \newdimen\itemmargin \itemmargin=.1in
3547 % used internally for \itemindent minus \itemmargin
3548 \newdimen\itemmax
3550 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3551 % these defs.
3552 % They also define \itemindex
3553 % to index the item name in whatever manner is desired (perhaps none).
3555 \newif\ifitemxneedsnegativevskip
3557 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3559 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3560 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3562 \def\itemzzz #1{\begingroup %
3563 \advance\hsize by -\rightskip
3564 \advance\hsize by -\tableindent
3565 \setbox0=\hbox{\itemindicate{#1}}%
3566 \itemindex{#1}%
3567 \nobreak % This prevents a break before @itemx.
3569 % If the item text does not fit in the space we have, put it on a line
3570 % by itself, and do not allow a page break either before or after that
3571 % line. We do not start a paragraph here because then if the next
3572 % command is, e.g., @kindex, the whatsit would get put into the
3573 % horizontal list on a line by itself, resulting in extra blank space.
3574 \ifdim \wd0>\itemmax
3576 % Make this a paragraph so we get the \parskip glue and wrapping,
3577 % but leave it ragged-right.
3578 \begingroup
3579 \advance\leftskip by-\tableindent
3580 \advance\hsize by\tableindent
3581 \advance\rightskip by0pt plus1fil\relax
3582 \leavevmode\unhbox0\par
3583 \endgroup
3585 % We're going to be starting a paragraph, but we don't want the
3586 % \parskip glue -- logically it's part of the @item we just started.
3587 \nobreak \vskip-\parskip
3589 % Stop a page break at the \parskip glue coming up. However, if
3590 % what follows is an environment such as @example, there will be no
3591 % \parskip glue; then the negative vskip we just inserted would
3592 % cause the example and the item to crash together. So we use this
3593 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3594 % \parskip glue after all. Section titles are handled this way also.
3596 \penalty 10001
3597 \endgroup
3598 \itemxneedsnegativevskipfalse
3599 \else
3600 % The item text fits into the space. Start a paragraph, so that the
3601 % following text (if any) will end up on the same line.
3602 \noindent
3603 % Do this with kerns and \unhbox so that if there is a footnote in
3604 % the item text, it can migrate to the main vertical list and
3605 % eventually be printed.
3606 \nobreak\kern-\tableindent
3607 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3608 \unhbox0
3609 \nobreak\kern\dimen0
3610 \endgroup
3611 \itemxneedsnegativevskiptrue
3615 \def\item{\errmessage{@item while not in a list environment}}
3616 \def\itemx{\errmessage{@itemx while not in a list environment}}
3618 % @table, @ftable, @vtable.
3619 \envdef\table{%
3620 \let\itemindex\gobble
3621 \tablecheck{table}%
3623 \envdef\ftable{%
3624 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3625 \tablecheck{ftable}%
3627 \envdef\vtable{%
3628 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3629 \tablecheck{vtable}%
3631 \def\tablecheck#1{%
3632 \ifnum \the\catcode`\^^M=\active
3633 \endgroup
3634 \errmessage{This command won't work in this context; perhaps the problem is
3635 that we are \inenvironment\thisenv}%
3636 \def\next{\doignore{#1}}%
3637 \else
3638 \let\next\tablex
3640 \next
3642 \def\tablex#1{%
3643 \def\itemindicate{#1}%
3644 \parsearg\tabley
3646 \def\tabley#1{%
3648 \makevalueexpandable
3649 \edef\temp{\noexpand\tablez #1\space\space\space}%
3650 \expandafter
3651 }\temp \endtablez
3653 \def\tablez #1 #2 #3 #4\endtablez{%
3654 \aboveenvbreak
3655 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3656 \ifnum 0#2>0 \tableindent=#2\mil \fi
3657 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3658 \itemmax=\tableindent
3659 \advance \itemmax by -\itemmargin
3660 \advance \leftskip by \tableindent
3661 \exdentamount=\tableindent
3662 \parindent = 0pt
3663 \parskip = \smallskipamount
3664 \ifdim \parskip=0pt \parskip=2pt \fi
3665 \let\item = \internalBitem
3666 \let\itemx = \internalBitemx
3668 \def\Etable{\endgraf\afterenvbreak}
3669 \let\Eftable\Etable
3670 \let\Evtable\Etable
3671 \let\Eitemize\Etable
3672 \let\Eenumerate\Etable
3674 % This is the counter used by @enumerate, which is really @itemize
3676 \newcount \itemno
3678 \envdef\itemize{\parsearg\doitemize}
3680 \def\doitemize#1{%
3681 \aboveenvbreak
3682 \itemmax=\itemindent
3683 \advance\itemmax by -\itemmargin
3684 \advance\leftskip by \itemindent
3685 \exdentamount=\itemindent
3686 \parindent=0pt
3687 \parskip=\smallskipamount
3688 \ifdim\parskip=0pt \parskip=2pt \fi
3690 % Try typesetting the item mark so that if the document erroneously says
3691 % something like @itemize @samp (intending @table), there's an error
3692 % right away at the @itemize. It's not the best error message in the
3693 % world, but it's better than leaving it to the @item. This means if
3694 % the user wants an empty mark, they have to say @w{} not just @w.
3695 \def\itemcontents{#1}%
3696 \setbox0 = \hbox{\itemcontents}%
3698 % @itemize with no arg is equivalent to @itemize @bullet.
3699 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3701 \let\item=\itemizeitem
3704 % Definition of @item while inside @itemize and @enumerate.
3706 \def\itemizeitem{%
3707 \advance\itemno by 1 % for enumerations
3708 {\let\par=\endgraf \smallbreak}% reasonable place to break
3710 % If the document has an @itemize directly after a section title, a
3711 % \nobreak will be last on the list, and \sectionheading will have
3712 % done a \vskip-\parskip. In that case, we don't want to zero
3713 % parskip, or the item text will crash with the heading. On the
3714 % other hand, when there is normal text preceding the item (as there
3715 % usually is), we do want to zero parskip, or there would be too much
3716 % space. In that case, we won't have a \nobreak before. At least
3717 % that's the theory.
3718 \ifnum\lastpenalty<10000 \parskip=0in \fi
3719 \noindent
3720 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3722 \vadjust{\penalty 1200}}% not good to break after first line of item.
3723 \flushcr
3726 % \splitoff TOKENS\endmark defines \first to be the first token in
3727 % TOKENS, and \rest to be the remainder.
3729 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3731 % Allow an optional argument of an uppercase letter, lowercase letter,
3732 % or number, to specify the first label in the enumerated list. No
3733 % argument is the same as `1'.
3735 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3736 \def\enumeratey #1 #2\endenumeratey{%
3737 % If we were given no argument, pretend we were given `1'.
3738 \def\thearg{#1}%
3739 \ifx\thearg\empty \def\thearg{1}\fi
3741 % Detect if the argument is a single token. If so, it might be a
3742 % letter. Otherwise, the only valid thing it can be is a number.
3743 % (We will always have one token, because of the test we just made.
3744 % This is a good thing, since \splitoff doesn't work given nothing at
3745 % all -- the first parameter is undelimited.)
3746 \expandafter\splitoff\thearg\endmark
3747 \ifx\rest\empty
3748 % Only one token in the argument. It could still be anything.
3749 % A ``lowercase letter'' is one whose \lccode is nonzero.
3750 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3751 % not equal to itself.
3752 % Otherwise, we assume it's a number.
3754 % We need the \relax at the end of the \ifnum lines to stop TeX from
3755 % continuing to look for a <number>.
3757 \ifnum\lccode\expandafter`\thearg=0\relax
3758 \numericenumerate % a number (we hope)
3759 \else
3760 % It's a letter.
3761 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3762 \lowercaseenumerate % lowercase letter
3763 \else
3764 \uppercaseenumerate % uppercase letter
3767 \else
3768 % Multiple tokens in the argument. We hope it's a number.
3769 \numericenumerate
3773 % An @enumerate whose labels are integers. The starting integer is
3774 % given in \thearg.
3776 \def\numericenumerate{%
3777 \itemno = \thearg
3778 \startenumeration{\the\itemno}%
3781 % The starting (lowercase) letter is in \thearg.
3782 \def\lowercaseenumerate{%
3783 \itemno = \expandafter`\thearg
3784 \startenumeration{%
3785 % Be sure we're not beyond the end of the alphabet.
3786 \ifnum\itemno=0
3787 \errmessage{No more lowercase letters in @enumerate; get a bigger
3788 alphabet}%
3790 \char\lccode\itemno
3794 % The starting (uppercase) letter is in \thearg.
3795 \def\uppercaseenumerate{%
3796 \itemno = \expandafter`\thearg
3797 \startenumeration{%
3798 % Be sure we're not beyond the end of the alphabet.
3799 \ifnum\itemno=0
3800 \errmessage{No more uppercase letters in @enumerate; get a bigger
3801 alphabet}
3803 \char\uccode\itemno
3807 % Call \doitemize, adding a period to the first argument and supplying the
3808 % common last two arguments. Also subtract one from the initial value in
3809 % \itemno, since @item increments \itemno.
3811 \def\startenumeration#1{%
3812 \advance\itemno by -1
3813 \doitemize{#1.}\flushcr
3816 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3817 % to @enumerate.
3819 \def\alphaenumerate{\enumerate{a}}
3820 \def\capsenumerate{\enumerate{A}}
3821 \def\Ealphaenumerate{\Eenumerate}
3822 \def\Ecapsenumerate{\Eenumerate}
3825 % @multitable macros
3826 % Amy Hendrickson, 8/18/94, 3/6/96
3828 % @multitable ... @end multitable will make as many columns as desired.
3829 % Contents of each column will wrap at width given in preamble. Width
3830 % can be specified either with sample text given in a template line,
3831 % or in percent of \hsize, the current width of text on page.
3833 % Table can continue over pages but will only break between lines.
3835 % To make preamble:
3837 % Either define widths of columns in terms of percent of \hsize:
3838 % @multitable @columnfractions .25 .3 .45
3839 % @item ...
3841 % Numbers following @columnfractions are the percent of the total
3842 % current hsize to be used for each column. You may use as many
3843 % columns as desired.
3846 % Or use a template:
3847 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3848 % @item ...
3849 % using the widest term desired in each column.
3851 % Each new table line starts with @item, each subsequent new column
3852 % starts with @tab. Empty columns may be produced by supplying @tab's
3853 % with nothing between them for as many times as empty columns are needed,
3854 % ie, @tab@tab@tab will produce two empty columns.
3856 % @item, @tab do not need to be on their own lines, but it will not hurt
3857 % if they are.
3859 % Sample multitable:
3861 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3862 % @item first col stuff @tab second col stuff @tab third col
3863 % @item
3864 % first col stuff
3865 % @tab
3866 % second col stuff
3867 % @tab
3868 % third col
3869 % @item first col stuff @tab second col stuff
3870 % @tab Many paragraphs of text may be used in any column.
3872 % They will wrap at the width determined by the template.
3873 % @item@tab@tab This will be in third column.
3874 % @end multitable
3876 % Default dimensions may be reset by user.
3877 % @multitableparskip is vertical space between paragraphs in table.
3878 % @multitableparindent is paragraph indent in table.
3879 % @multitablecolmargin is horizontal space to be left between columns.
3880 % @multitablelinespace is space to leave between table items, baseline
3881 % to baseline.
3882 % 0pt means it depends on current normal line spacing.
3884 \newskip\multitableparskip
3885 \newskip\multitableparindent
3886 \newdimen\multitablecolspace
3887 \newskip\multitablelinespace
3888 \multitableparskip=0pt
3889 \multitableparindent=6pt
3890 \multitablecolspace=12pt
3891 \multitablelinespace=0pt
3893 % Macros used to set up halign preamble:
3895 \let\endsetuptable\relax
3896 \def\xendsetuptable{\endsetuptable}
3897 \let\columnfractions\relax
3898 \def\xcolumnfractions{\columnfractions}
3899 \newif\ifsetpercent
3901 % #1 is the @columnfraction, usually a decimal number like .5, but might
3902 % be just 1. We just use it, whatever it is.
3904 \def\pickupwholefraction#1 {%
3905 \global\advance\colcount by 1
3906 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3907 \setuptable
3910 \newcount\colcount
3911 \def\setuptable#1{%
3912 \def\firstarg{#1}%
3913 \ifx\firstarg\xendsetuptable
3914 \let\go = \relax
3915 \else
3916 \ifx\firstarg\xcolumnfractions
3917 \global\setpercenttrue
3918 \else
3919 \ifsetpercent
3920 \let\go\pickupwholefraction
3921 \else
3922 \global\advance\colcount by 1
3923 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3924 % separator; typically that is always in the input, anyway.
3925 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3928 \ifx\go\pickupwholefraction
3929 % Put the argument back for the \pickupwholefraction call, so
3930 % we'll always have a period there to be parsed.
3931 \def\go{\pickupwholefraction#1}%
3932 \else
3933 \let\go = \setuptable
3934 \fi%
3939 % multitable-only commands.
3941 % @headitem starts a heading row, which we typeset in bold. Assignments
3942 % have to be global since we are inside the implicit group of an
3943 % alignment entry. \everycr below resets \everytab so we don't have to
3944 % undo it ourselves.
3945 \def\headitemfont{\b}% for people to use in the template row; not changeable
3946 \def\headitem{%
3947 \checkenv\multitable
3948 \crcr
3949 \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings
3950 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3951 \the\everytab % for the first item
3954 % default for tables with no headings.
3955 \let\headitemcrhook=\relax
3957 % A \tab used to include \hskip1sp. But then the space in a template
3958 % line is not enough. That is bad. So let's go back to just `&' until
3959 % we again encounter the problem the 1sp was intended to solve.
3960 % --karl, nathan@acm.org, 20apr99.
3961 \def\tab{\checkenv\multitable &\the\everytab}%
3963 % @multitable ... @end multitable definitions:
3965 \newtoks\everytab % insert after every tab.
3967 \envdef\multitable{%
3968 \vskip\parskip
3969 \startsavinginserts
3971 % @item within a multitable starts a normal row.
3972 % We use \def instead of \let so that if one of the multitable entries
3973 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3974 % \endtemplate) expanding \doitemize.
3975 \def\item{\crcr}%
3977 \tolerance=9500
3978 \hbadness=9500
3979 \setmultitablespacing
3980 \parskip=\multitableparskip
3981 \parindent=\multitableparindent
3982 \overfullrule=0pt
3983 \global\colcount=0
3985 \everycr = {%
3986 \noalign{%
3987 \global\everytab={}% Reset from possible headitem.
3988 \global\colcount=0 % Reset the column counter.
3990 % Check for saved footnotes, etc.:
3991 \checkinserts
3993 % Perhaps a \nobreak, then reset:
3994 \headitemcrhook
3995 \global\let\headitemcrhook=\relax
3999 \parsearg\domultitable
4001 \def\domultitable#1{%
4002 % To parse everything between @multitable and @item:
4003 \setuptable#1 \endsetuptable
4005 % This preamble sets up a generic column definition, which will
4006 % be used as many times as user calls for columns.
4007 % \vtop will set a single line and will also let text wrap and
4008 % continue for many paragraphs if desired.
4009 \halign\bgroup &%
4010 \global\advance\colcount by 1
4011 \multistrut
4012 \vtop{%
4013 % Use the current \colcount to find the correct column width:
4014 \hsize=\expandafter\csname col\the\colcount\endcsname
4016 % In order to keep entries from bumping into each other
4017 % we will add a \leftskip of \multitablecolspace to all columns after
4018 % the first one.
4020 % If a template has been used, we will add \multitablecolspace
4021 % to the width of each template entry.
4023 % If the user has set preamble in terms of percent of \hsize we will
4024 % use that dimension as the width of the column, and the \leftskip
4025 % will keep entries from bumping into each other. Table will start at
4026 % left margin and final column will justify at right margin.
4028 % Make sure we don't inherit \rightskip from the outer environment.
4029 \rightskip=0pt
4030 \ifnum\colcount=1
4031 % The first column will be indented with the surrounding text.
4032 \advance\hsize by\leftskip
4033 \else
4034 \ifsetpercent \else
4035 % If user has not set preamble in terms of percent of \hsize
4036 % we will advance \hsize by \multitablecolspace.
4037 \advance\hsize by \multitablecolspace
4039 % In either case we will make \leftskip=\multitablecolspace:
4040 \leftskip=\multitablecolspace
4042 % Ignoring space at the beginning and end avoids an occasional spurious
4043 % blank line, when TeX decides to break the line at the space before the
4044 % box from the multistrut, so the strut ends up on a line by itself.
4045 % For example:
4046 % @multitable @columnfractions .11 .89
4047 % @item @code{#}
4048 % @tab Legal holiday which is valid in major parts of the whole country.
4049 % Is automatically provided with highlighting sequences respectively
4050 % marking characters.
4051 \noindent\ignorespaces##\unskip\multistrut
4052 }\cr
4054 \def\Emultitable{%
4055 \crcr
4056 \egroup % end the \halign
4057 \global\setpercentfalse
4060 \def\setmultitablespacing{%
4061 \def\multistrut{\strut}% just use the standard line spacing
4063 % Compute \multitablelinespace (if not defined by user) for use in
4064 % \multitableparskip calculation. We used define \multistrut based on
4065 % this, but (ironically) that caused the spacing to be off.
4066 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
4067 \ifdim\multitablelinespace=0pt
4068 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
4069 \global\advance\multitablelinespace by-\ht0
4071 % Test to see if parskip is larger than space between lines of
4072 % table. If not, do nothing.
4073 % If so, set to same dimension as multitablelinespace.
4074 \ifdim\multitableparskip>\multitablelinespace
4075 \global\multitableparskip=\multitablelinespace
4076 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4077 % than skip between lines in the table.
4078 \fi%
4079 \ifdim\multitableparskip=0pt
4080 \global\multitableparskip=\multitablelinespace
4081 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4082 % than skip between lines in the table.
4083 \fi}
4086 \message{conditionals,}
4088 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4089 % @ifnotxml always succeed. They currently do nothing; we don't
4090 % attempt to check whether the conditionals are properly nested. But we
4091 % have to remember that they are conditionals, so that @end doesn't
4092 % attempt to close an environment group.
4094 \def\makecond#1{%
4095 \expandafter\let\csname #1\endcsname = \relax
4096 \expandafter\let\csname iscond.#1\endcsname = 1
4098 \makecond{iftex}
4099 \makecond{ifnotdocbook}
4100 \makecond{ifnothtml}
4101 \makecond{ifnotinfo}
4102 \makecond{ifnotplaintext}
4103 \makecond{ifnotxml}
4105 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4107 \def\direntry{\doignore{direntry}}
4108 \def\documentdescription{\doignore{documentdescription}}
4109 \def\docbook{\doignore{docbook}}
4110 \def\html{\doignore{html}}
4111 \def\ifdocbook{\doignore{ifdocbook}}
4112 \def\ifhtml{\doignore{ifhtml}}
4113 \def\ifinfo{\doignore{ifinfo}}
4114 \def\ifnottex{\doignore{ifnottex}}
4115 \def\ifplaintext{\doignore{ifplaintext}}
4116 \def\ifxml{\doignore{ifxml}}
4117 \def\ignore{\doignore{ignore}}
4118 \def\menu{\doignore{menu}}
4119 \def\xml{\doignore{xml}}
4121 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4123 % A count to remember the depth of nesting.
4124 \newcount\doignorecount
4126 \def\doignore#1{\begingroup
4127 % Scan in ``verbatim'' mode:
4128 \obeylines
4129 \catcode`\@ = \other
4130 \catcode`\{ = \other
4131 \catcode`\} = \other
4133 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4134 \spaceisspace
4136 % Count number of #1's that we've seen.
4137 \doignorecount = 0
4139 % Swallow text until we reach the matching `@end #1'.
4140 \dodoignore{#1}%
4143 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4144 \obeylines %
4146 \gdef\dodoignore#1{%
4147 % #1 contains the command name as a string, e.g., `ifinfo'.
4149 % Define a command to find the next `@end #1'.
4150 \long\def\doignoretext##1^^M@end #1{%
4151 \doignoretextyyy##1^^M@#1\_STOP_}%
4153 % And this command to find another #1 command, at the beginning of a
4154 % line. (Otherwise, we would consider a line `@c @ifset', for
4155 % example, to count as an @ifset for nesting.)
4156 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4158 % And now expand that command.
4159 \doignoretext ^^M%
4163 \def\doignoreyyy#1{%
4164 \def\temp{#1}%
4165 \ifx\temp\empty % Nothing found.
4166 \let\next\doignoretextzzz
4167 \else % Found a nested condition, ...
4168 \advance\doignorecount by 1
4169 \let\next\doignoretextyyy % ..., look for another.
4170 % If we're here, #1 ends with ^^M\ifinfo (for example).
4172 \next #1% the token \_STOP_ is present just after this macro.
4175 % We have to swallow the remaining "\_STOP_".
4177 \def\doignoretextzzz#1{%
4178 \ifnum\doignorecount = 0 % We have just found the outermost @end.
4179 \let\next\enddoignore
4180 \else % Still inside a nested condition.
4181 \advance\doignorecount by -1
4182 \let\next\doignoretext % Look for the next @end.
4184 \next
4187 % Finish off ignored text.
4188 { \obeylines%
4189 % Ignore anything after the last `@end #1'; this matters in verbatim
4190 % environments, where otherwise the newline after an ignored conditional
4191 % would result in a blank line in the output.
4192 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4196 % @set VAR sets the variable VAR to an empty value.
4197 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4199 % Since we want to separate VAR from REST-OF-LINE (which might be
4200 % empty), we can't just use \parsearg; we have to insert a space of our
4201 % own to delimit the rest of the line, and then take it out again if we
4202 % didn't need it.
4203 % We rely on the fact that \parsearg sets \catcode`\ =10.
4205 \parseargdef\set{\setyyy#1 \endsetyyy}
4206 \def\setyyy#1 #2\endsetyyy{%
4208 \makevalueexpandable
4209 \def\temp{#2}%
4210 \edef\next{\gdef\makecsname{SET#1}}%
4211 \ifx\temp\empty
4212 \next{}%
4213 \else
4214 \setzzz#2\endsetzzz
4218 % Remove the trailing space \setxxx inserted.
4219 \def\setzzz#1 \endsetzzz{\next{#1}}
4221 % @clear VAR clears (i.e., unsets) the variable VAR.
4223 \parseargdef\clear{%
4225 \makevalueexpandable
4226 \global\expandafter\let\csname SET#1\endcsname=\relax
4230 % @value{foo} gets the text saved in variable foo.
4231 \def\value{\begingroup\makevalueexpandable\valuexxx}
4232 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4234 \catcode`\-=\active \catcode`\_=\active
4236 \gdef\makevalueexpandable{%
4237 \let\value = \expandablevalue
4238 % We don't want these characters active, ...
4239 \catcode`\-=\other \catcode`\_=\other
4240 % ..., but we might end up with active ones in the argument if
4241 % we're called from @code, as @code{@value{foo-bar_}}, though.
4242 % So \let them to their normal equivalents.
4243 \let-\normaldash \let_\normalunderscore
4247 % We have this subroutine so that we can handle at least some @value's
4248 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4249 % The command has to be fully expandable (if the variable is set), since
4250 % the result winds up in the index file. This means that if the
4251 % variable's value contains other Texinfo commands, it's almost certain
4252 % it will fail (although perhaps we could fix that with sufficient work
4253 % to do a one-level expansion on the result, instead of complete).
4255 % Unfortunately, this has the consequence that when _ is in the *value*
4256 % of an @set, it does not print properly in the roman fonts (get the cmr
4257 % dot accent at position 126 instead). No fix comes to mind, and it's
4258 % been this way since 2003 or earlier, so just ignore it.
4260 \def\expandablevalue#1{%
4261 \expandafter\ifx\csname SET#1\endcsname\relax
4262 {[No value for ``#1'']}%
4263 \message{Variable `#1', used in @value, is not set.}%
4264 \else
4265 \csname SET#1\endcsname
4269 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4270 % with @set.
4272 % To get the special treatment we need for `@end ifset,' we call
4273 % \makecond and then redefine.
4275 \makecond{ifset}
4276 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4277 \def\doifset#1#2{%
4279 \makevalueexpandable
4280 \let\next=\empty
4281 \expandafter\ifx\csname SET#2\endcsname\relax
4282 #1% If not set, redefine \next.
4284 \expandafter
4285 }\next
4287 \def\ifsetfail{\doignore{ifset}}
4289 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4290 % defined with @set, or has been undefined with @clear.
4292 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4293 % above code: if the variable is not set, do nothing, if it is set,
4294 % then redefine \next to \ifclearfail.
4296 \makecond{ifclear}
4297 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4298 \def\ifclearfail{\doignore{ifclear}}
4300 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4301 % without the @) is in fact defined. We can only feasibly check at the
4302 % TeX level, so something like `mathcode' is going to considered
4303 % defined even though it is not a Texinfo command.
4305 \makecond{ifcommanddefined}
4306 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
4308 \def\doifcmddefined#1#2{{%
4309 \makevalueexpandable
4310 \let\next=\empty
4311 \expandafter\ifx\csname #2\endcsname\relax
4312 #1% If not defined, \let\next as above.
4314 \expandafter
4315 }\next
4317 \def\ifcmddefinedfail{\doignore{ifcommanddefined}}
4319 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4320 \makecond{ifcommandnotdefined}
4321 \def\ifcommandnotdefined{%
4322 \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
4323 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
4325 % Set the `txicommandconditionals' variable, so documents have a way to
4326 % test if the @ifcommand...defined conditionals are available.
4327 \set txicommandconditionals
4329 % @dircategory CATEGORY -- specify a category of the dir file
4330 % which this file should belong to. Ignore this in TeX.
4331 \let\dircategory=\comment
4333 % @defininfoenclose.
4334 \let\definfoenclose=\comment
4337 \message{indexing,}
4338 % Index generation facilities
4340 % Define \newwrite to be identical to plain tex's \newwrite
4341 % except not \outer, so it can be used within macros and \if's.
4342 \edef\newwrite{\makecsname{ptexnewwrite}}
4344 % \newindex {foo} defines an index named foo.
4345 % It automatically defines \fooindex such that
4346 % \fooindex ...rest of line... puts an entry in the index foo.
4347 % It also defines \fooindfile to be the number of the output channel for
4348 % the file that accumulates this index. The file's extension is foo.
4349 % The name of an index should be no more than 2 characters long
4350 % for the sake of vms.
4352 \def\newindex#1{%
4353 \iflinks
4354 \expandafter\newwrite \csname#1indfile\endcsname
4355 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4357 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4358 \noexpand\doindex{#1}}
4361 % @defindex foo == \newindex{foo}
4363 \def\defindex{\parsearg\newindex}
4365 % Define @defcodeindex, like @defindex except put all entries in @code.
4367 \def\defcodeindex{\parsearg\newcodeindex}
4369 \def\newcodeindex#1{%
4370 \iflinks
4371 \expandafter\newwrite \csname#1indfile\endcsname
4372 \openout \csname#1indfile\endcsname \jobname.#1
4374 \expandafter\xdef\csname#1index\endcsname{%
4375 \noexpand\docodeindex{#1}}%
4379 % @synindex foo bar makes index foo feed into index bar.
4380 % Do this instead of @defindex foo if you don't want it as a separate index.
4382 % @syncodeindex foo bar similar, but put all entries made for index foo
4383 % inside @code.
4385 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4386 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4388 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4389 % #3 the target index (bar).
4390 \def\dosynindex#1#2#3{%
4391 % Only do \closeout if we haven't already done it, else we'll end up
4392 % closing the target index.
4393 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4394 % The \closeout helps reduce unnecessary open files; the limit on the
4395 % Acorn RISC OS is a mere 16 files.
4396 \expandafter\closeout\csname#2indfile\endcsname
4397 \expandafter\let\csname donesynindex#2\endcsname = 1
4399 % redefine \fooindfile:
4400 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4401 \expandafter\let\csname#2indfile\endcsname=\temp
4402 % redefine \fooindex:
4403 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4406 % Define \doindex, the driver for all \fooindex macros.
4407 % Argument #1 is generated by the calling \fooindex macro,
4408 % and it is "foo", the name of the index.
4410 % \doindex just uses \parsearg; it calls \doind for the actual work.
4411 % This is because \doind is more useful to call from other macros.
4413 % There is also \dosubind {index}{topic}{subtopic}
4414 % which makes an entry in a two-level index such as the operation index.
4416 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4417 \def\singleindexer #1{\doind{\indexname}{#1}}
4419 % like the previous two, but they put @code around the argument.
4420 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4421 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4423 % Take care of Texinfo commands that can appear in an index entry.
4424 % Since there are some commands we want to expand, and others we don't,
4425 % we have to laboriously prevent expansion for those that we don't.
4427 \def\indexdummies{%
4428 \escapechar = `\\ % use backslash in output files.
4429 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4430 \def\ {\realbackslash\space }%
4432 % Need these unexpandable (because we define \tt as a dummy)
4433 % definitions when @{ or @} appear in index entry text. Also, more
4434 % complicated, when \tex is in effect and \{ is a \delimiter again.
4435 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4436 % braces and backslashes are used only as delimiters. Perhaps we
4437 % should use @lbracechar and @rbracechar?
4438 \def\{{{\tt\char123}}%
4439 \def\}{{\tt\char125}}%
4441 % I don't entirely understand this, but when an index entry is
4442 % generated from a macro call, the \endinput which \scanmacro inserts
4443 % causes processing to be prematurely terminated. This is,
4444 % apparently, because \indexsorttmp is fully expanded, and \endinput
4445 % is an expandable command. The redefinition below makes \endinput
4446 % disappear altogether for that purpose -- although logging shows that
4447 % processing continues to some further point. On the other hand, it
4448 % seems \endinput does not hurt in the printed index arg, since that
4449 % is still getting written without apparent harm.
4451 % Sample source (mac-idx3.tex, reported by Graham Percival to
4452 % help-texinfo, 22may06):
4453 % @macro funindex {WORD}
4454 % @findex xyz
4455 % @end macro
4456 % ...
4457 % @funindex commtest
4458 % This is not enough to reproduce the bug, but it gives the flavor.
4460 % Sample whatsit resulting:
4461 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4463 % So:
4464 \let\endinput = \empty
4466 % Do the redefinitions.
4467 \commondummies
4470 % For the aux and toc files, @ is the escape character. So we want to
4471 % redefine everything using @ as the escape character (instead of
4472 % \realbackslash, still used for index files). When everything uses @,
4473 % this will be simpler.
4475 \def\atdummies{%
4476 \def\@{@@}%
4477 \def\ {@ }%
4478 \let\{ = \lbraceatcmd
4479 \let\} = \rbraceatcmd
4481 % Do the redefinitions.
4482 \commondummies
4483 \otherbackslash
4486 % Called from \indexdummies and \atdummies.
4488 \def\commondummies{%
4490 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4491 % preventing its expansion. This is used only for control words,
4492 % not control letters, because the \space would be incorrect for
4493 % control characters, but is needed to separate the control word
4494 % from whatever follows.
4496 % For control letters, we have \definedummyletter, which omits the
4497 % space.
4499 % These can be used both for control words that take an argument and
4500 % those that do not. If it is followed by {arg} in the input, then
4501 % that will dutifully get written to the index (or wherever).
4503 \def\definedummyword ##1{\def##1{\string##1\space}}%
4504 \def\definedummyletter##1{\def##1{\string##1}}%
4505 \let\definedummyaccent\definedummyletter
4507 \commondummiesnofonts
4509 \definedummyletter\_%
4510 \definedummyletter\-%
4512 % Non-English letters.
4513 \definedummyword\AA
4514 \definedummyword\AE
4515 \definedummyword\DH
4516 \definedummyword\L
4517 \definedummyword\O
4518 \definedummyword\OE
4519 \definedummyword\TH
4520 \definedummyword\aa
4521 \definedummyword\ae
4522 \definedummyword\dh
4523 \definedummyword\exclamdown
4524 \definedummyword\l
4525 \definedummyword\o
4526 \definedummyword\oe
4527 \definedummyword\ordf
4528 \definedummyword\ordm
4529 \definedummyword\questiondown
4530 \definedummyword\ss
4531 \definedummyword\th
4533 % Although these internal commands shouldn't show up, sometimes they do.
4534 \definedummyword\bf
4535 \definedummyword\gtr
4536 \definedummyword\hat
4537 \definedummyword\less
4538 \definedummyword\sf
4539 \definedummyword\sl
4540 \definedummyword\tclose
4541 \definedummyword\tt
4543 \definedummyword\LaTeX
4544 \definedummyword\TeX
4546 % Assorted special characters.
4547 \definedummyword\arrow
4548 \definedummyword\bullet
4549 \definedummyword\comma
4550 \definedummyword\copyright
4551 \definedummyword\registeredsymbol
4552 \definedummyword\dots
4553 \definedummyword\enddots
4554 \definedummyword\entrybreak
4555 \definedummyword\equiv
4556 \definedummyword\error
4557 \definedummyword\euro
4558 \definedummyword\expansion
4559 \definedummyword\geq
4560 \definedummyword\guillemetleft
4561 \definedummyword\guillemetright
4562 \definedummyword\guilsinglleft
4563 \definedummyword\guilsinglright
4564 \definedummyword\lbracechar
4565 \definedummyword\leq
4566 \definedummyword\minus
4567 \definedummyword\ogonek
4568 \definedummyword\pounds
4569 \definedummyword\point
4570 \definedummyword\print
4571 \definedummyword\quotedblbase
4572 \definedummyword\quotedblleft
4573 \definedummyword\quotedblright
4574 \definedummyword\quoteleft
4575 \definedummyword\quoteright
4576 \definedummyword\quotesinglbase
4577 \definedummyword\rbracechar
4578 \definedummyword\result
4579 \definedummyword\textdegree
4581 % We want to disable all macros so that they are not expanded by \write.
4582 \macrolist
4584 \normalturnoffactive
4586 % Handle some cases of @value -- where it does not contain any
4587 % (non-fully-expandable) commands.
4588 \makevalueexpandable
4591 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4593 \def\commondummiesnofonts{%
4594 % Control letters and accents.
4595 \definedummyletter\!%
4596 \definedummyaccent\"%
4597 \definedummyaccent\'%
4598 \definedummyletter\*%
4599 \definedummyaccent\,%
4600 \definedummyletter\.%
4601 \definedummyletter\/%
4602 \definedummyletter\:%
4603 \definedummyaccent\=%
4604 \definedummyletter\?%
4605 \definedummyaccent\^%
4606 \definedummyaccent\`%
4607 \definedummyaccent\~%
4608 \definedummyword\u
4609 \definedummyword\v
4610 \definedummyword\H
4611 \definedummyword\dotaccent
4612 \definedummyword\ogonek
4613 \definedummyword\ringaccent
4614 \definedummyword\tieaccent
4615 \definedummyword\ubaraccent
4616 \definedummyword\udotaccent
4617 \definedummyword\dotless
4619 % Texinfo font commands.
4620 \definedummyword\b
4621 \definedummyword\i
4622 \definedummyword\r
4623 \definedummyword\sansserif
4624 \definedummyword\sc
4625 \definedummyword\slanted
4626 \definedummyword\t
4628 % Commands that take arguments.
4629 \definedummyword\abbr
4630 \definedummyword\acronym
4631 \definedummyword\anchor
4632 \definedummyword\cite
4633 \definedummyword\code
4634 \definedummyword\command
4635 \definedummyword\dfn
4636 \definedummyword\dmn
4637 \definedummyword\email
4638 \definedummyword\emph
4639 \definedummyword\env
4640 \definedummyword\file
4641 \definedummyword\image
4642 \definedummyword\indicateurl
4643 \definedummyword\inforef
4644 \definedummyword\kbd
4645 \definedummyword\key
4646 \definedummyword\math
4647 \definedummyword\option
4648 \definedummyword\pxref
4649 \definedummyword\ref
4650 \definedummyword\samp
4651 \definedummyword\strong
4652 \definedummyword\tie
4653 \definedummyword\uref
4654 \definedummyword\url
4655 \definedummyword\var
4656 \definedummyword\verb
4657 \definedummyword\w
4658 \definedummyword\xref
4660 % Consider:
4661 % @macro mkind{arg1,arg2}
4662 % @cindex \arg2\
4663 % @end macro
4664 % @mkind{foo, bar}
4665 % The space after the comma will end up in the temporary definition
4666 % that we make for arg2 (see \parsemargdef ff.). We want all this to be
4667 % expanded for the sake of the index, so we end up just seeing "bar".
4668 \let\xeatspaces = \eatspaces
4671 % For testing: output @{ and @} in index sort strings as \{ and \}.
4672 \newif\ifusebracesinindexes
4674 % \indexnofonts is used when outputting the strings to sort the index
4675 % by, and when constructing control sequence names. It eliminates all
4676 % control sequences and just writes whatever the best ASCII sort string
4677 % would be for a given command (usually its argument).
4679 \def\indexnofonts{%
4680 % Accent commands should become @asis.
4681 \def\definedummyaccent##1{\let##1\asis}%
4682 % We can just ignore other control letters.
4683 \def\definedummyletter##1{\let##1\empty}%
4684 % All control words become @asis by default; overrides below.
4685 \let\definedummyword\definedummyaccent
4687 \commondummiesnofonts
4689 % Don't no-op \tt, since it isn't a user-level command
4690 % and is used in the definitions of the active chars like <, >, |, etc.
4691 % Likewise with the other plain tex font commands.
4692 %\let\tt=\asis
4694 \def\ { }%
4695 \def\@{@}%
4696 \def\_{\normalunderscore}%
4697 \def\-{}% @- shouldn't affect sorting
4699 % Unfortunately, texindex is not prepared to handle braces in the
4700 % content at all. So for index sorting, we map @{ and @} to strings
4701 % starting with |, since that ASCII character is between ASCII { and }.
4702 \ifusebracesinindexes
4703 \def\lbracechar{\lbracecmd}%
4704 \def\rbracechar{\rbracecmd}%
4705 \else
4706 \def\lbracechar{|a}%
4707 \def\rbracechar{|b}%
4709 \let\{=\lbracechar
4710 \let\}=\rbracechar
4713 % Non-English letters.
4714 \def\AA{AA}%
4715 \def\AE{AE}%
4716 \def\DH{DZZ}%
4717 \def\L{L}%
4718 \def\OE{OE}%
4719 \def\O{O}%
4720 \def\TH{ZZZ}%
4721 \def\aa{aa}%
4722 \def\ae{ae}%
4723 \def\dh{dzz}%
4724 \def\exclamdown{!}%
4725 \def\l{l}%
4726 \def\oe{oe}%
4727 \def\ordf{a}%
4728 \def\ordm{o}%
4729 \def\o{o}%
4730 \def\questiondown{?}%
4731 \def\ss{ss}%
4732 \def\th{zzz}%
4734 \def\LaTeX{LaTeX}%
4735 \def\TeX{TeX}%
4737 % Assorted special characters.
4738 % (The following {} will end up in the sort string, but that's ok.)
4739 \def\arrow{->}%
4740 \def\bullet{bullet}%
4741 \def\comma{,}%
4742 \def\copyright{copyright}%
4743 \def\dots{...}%
4744 \def\enddots{...}%
4745 \def\equiv{==}%
4746 \def\error{error}%
4747 \def\euro{euro}%
4748 \def\expansion{==>}%
4749 \def\geq{>=}%
4750 \def\guillemetleft{<<}%
4751 \def\guillemetright{>>}%
4752 \def\guilsinglleft{<}%
4753 \def\guilsinglright{>}%
4754 \def\leq{<=}%
4755 \def\minus{-}%
4756 \def\point{.}%
4757 \def\pounds{pounds}%
4758 \def\print{-|}%
4759 \def\quotedblbase{"}%
4760 \def\quotedblleft{"}%
4761 \def\quotedblright{"}%
4762 \def\quoteleft{`}%
4763 \def\quoteright{'}%
4764 \def\quotesinglbase{,}%
4765 \def\registeredsymbol{R}%
4766 \def\result{=>}%
4767 \def\textdegree{o}%
4769 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4770 \else \indexlquoteignore \fi
4772 % We need to get rid of all macros, leaving only the arguments (if present).
4773 % Of course this is not nearly correct, but it is the best we can do for now.
4774 % makeinfo does not expand macros in the argument to @deffn, which ends up
4775 % writing an index entry, and texindex isn't prepared for an index sort entry
4776 % that starts with \.
4778 % Since macro invocations are followed by braces, we can just redefine them
4779 % to take a single TeX argument. The case of a macro invocation that
4780 % goes to end-of-line is not handled.
4782 \macrolist
4785 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4786 % ignore left quotes in the sort term.
4787 {\catcode`\`=\active
4788 \gdef\indexlquoteignore{\let`=\empty}}
4790 \let\indexbackslash=0 %overridden during \printindex.
4791 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4793 % Most index entries go through here, but \dosubind is the general case.
4794 % #1 is the index name, #2 is the entry text.
4795 \def\doind#1#2{\dosubind{#1}{#2}{}}
4797 % Workhorse for all \fooindexes.
4798 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4799 % empty if called from \doind, as we usually are (the main exception
4800 % is with most defuns, which call us directly).
4802 \def\dosubind#1#2#3{%
4803 \iflinks
4805 % Store the main index entry text (including the third arg).
4806 \toks0 = {#2}%
4807 % If third arg is present, precede it with a space.
4808 \def\thirdarg{#3}%
4809 \ifx\thirdarg\empty \else
4810 \toks0 = \expandafter{\the\toks0 \space #3}%
4813 \edef\writeto{\csname#1indfile\endcsname}%
4815 \safewhatsit\dosubindwrite
4820 % Write the entry in \toks0 to the index file:
4822 \def\dosubindwrite{%
4823 % Put the index entry in the margin if desired.
4824 \ifx\SETmarginindex\relax\else
4825 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4828 % Remember, we are within a group.
4829 \indexdummies % Must do this here, since \bf, etc expand at this stage
4830 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4831 % so it will be output as is; and it will print as backslash.
4833 % Process the index entry with all font commands turned off, to
4834 % get the string to sort by.
4835 {\indexnofonts
4836 \edef\temp{\the\toks0}% need full expansion
4837 \xdef\indexsorttmp{\temp}%
4840 % Set up the complete index entry, with both the sort key and
4841 % the original text, including any font commands. We write
4842 % three arguments to \entry to the .?? file (four in the
4843 % subentry case), texindex reduces to two when writing the .??s
4844 % sorted result.
4845 \edef\temp{%
4846 \write\writeto{%
4847 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4849 \temp
4852 % Take care of unwanted page breaks/skips around a whatsit:
4854 % If a skip is the last thing on the list now, preserve it
4855 % by backing up by \lastskip, doing the \write, then inserting
4856 % the skip again. Otherwise, the whatsit generated by the
4857 % \write or \pdfdest will make \lastskip zero. The result is that
4858 % sequences like this:
4859 % @end defun
4860 % @tindex whatever
4861 % @defun ...
4862 % will have extra space inserted, because the \medbreak in the
4863 % start of the @defun won't see the skip inserted by the @end of
4864 % the previous defun.
4866 % But don't do any of this if we're not in vertical mode. We
4867 % don't want to do a \vskip and prematurely end a paragraph.
4869 % Avoid page breaks due to these extra skips, too.
4871 % But wait, there is a catch there:
4872 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4873 % sufficient for this purpose, as it ignores stretch and shrink parts
4874 % of the skip. The only way seems to be to check the textual
4875 % representation of the skip.
4877 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4878 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4880 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4882 \newskip\whatsitskip
4883 \newcount\whatsitpenalty
4885 % ..., ready, GO:
4887 \def\safewhatsit#1{\ifhmode
4889 \else
4890 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4891 \whatsitskip = \lastskip
4892 \edef\lastskipmacro{\the\lastskip}%
4893 \whatsitpenalty = \lastpenalty
4895 % If \lastskip is nonzero, that means the last item was a
4896 % skip. And since a skip is discardable, that means this
4897 % -\whatsitskip glue we're inserting is preceded by a
4898 % non-discardable item, therefore it is not a potential
4899 % breakpoint, therefore no \nobreak needed.
4900 \ifx\lastskipmacro\zeroskipmacro
4901 \else
4902 \vskip-\whatsitskip
4907 \ifx\lastskipmacro\zeroskipmacro
4908 % If \lastskip was zero, perhaps the last item was a penalty, and
4909 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4910 % to re-insert the same penalty (values >10000 are used for various
4911 % signals); since we just inserted a non-discardable item, any
4912 % following glue (such as a \parskip) would be a breakpoint. For example:
4913 % @deffn deffn-whatever
4914 % @vindex index-whatever
4915 % Description.
4916 % would allow a break between the index-whatever whatsit
4917 % and the "Description." paragraph.
4918 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4919 \else
4920 % On the other hand, if we had a nonzero \lastskip,
4921 % this make-up glue would be preceded by a non-discardable item
4922 % (the whatsit from the \write), so we must insert a \nobreak.
4923 \nobreak\vskip\whatsitskip
4925 \fi}
4927 % The index entry written in the file actually looks like
4928 % \entry {sortstring}{page}{topic}
4929 % or
4930 % \entry {sortstring}{page}{topic}{subtopic}
4931 % The texindex program reads in these files and writes files
4932 % containing these kinds of lines:
4933 % \initial {c}
4934 % before the first topic whose initial is c
4935 % \entry {topic}{pagelist}
4936 % for a topic that is used without subtopics
4937 % \primary {topic}
4938 % for the beginning of a topic that is used with subtopics
4939 % \secondary {subtopic}{pagelist}
4940 % for each subtopic.
4942 % Define the user-accessible indexing commands
4943 % @findex, @vindex, @kindex, @cindex.
4945 \def\findex {\fnindex}
4946 \def\kindex {\kyindex}
4947 \def\cindex {\cpindex}
4948 \def\vindex {\vrindex}
4949 \def\tindex {\tpindex}
4950 \def\pindex {\pgindex}
4952 \def\cindexsub {\begingroup\obeylines\cindexsub}
4953 {\obeylines %
4954 \gdef\cindexsub "#1" #2^^M{\endgroup %
4955 \dosubind{cp}{#2}{#1}}}
4957 % Define the macros used in formatting output of the sorted index material.
4959 % @printindex causes a particular index (the ??s file) to get printed.
4960 % It does not print any chapter heading (usually an @unnumbered).
4962 \parseargdef\printindex{\begingroup
4963 \dobreak \chapheadingskip{10000}%
4965 \smallfonts \rm
4966 \tolerance = 9500
4967 \plainfrenchspacing
4968 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4970 % See if the index file exists and is nonempty.
4971 % Change catcode of @ here so that if the index file contains
4972 % \initial {@}
4973 % as its first line, TeX doesn't complain about mismatched braces
4974 % (because it thinks @} is a control sequence).
4975 \catcode`\@ = 11
4976 \openin 1 \jobname.#1s
4977 \ifeof 1
4978 % \enddoublecolumns gets confused if there is no text in the index,
4979 % and it loses the chapter title and the aux file entries for the
4980 % index. The easiest way to prevent this problem is to make sure
4981 % there is some text.
4982 \putwordIndexNonexistent
4983 \else
4985 % If the index file exists but is empty, then \openin leaves \ifeof
4986 % false. We have to make TeX try to read something from the file, so
4987 % it can discover if there is anything in it.
4988 \read 1 to \temp
4989 \ifeof 1
4990 \putwordIndexIsEmpty
4991 \else
4992 % Index files are almost Texinfo source, but we use \ as the escape
4993 % character. It would be better to use @, but that's too big a change
4994 % to make right now.
4995 \def\indexbackslash{\backslashcurfont}%
4996 \catcode`\\ = 0
4997 \escapechar = `\\
4998 \begindoublecolumns
4999 \input \jobname.#1s
5000 \enddoublecolumns
5003 \closein 1
5004 \endgroup}
5006 % These macros are used by the sorted index file itself.
5007 % Change them to control the appearance of the index.
5009 \def\initial#1{{%
5010 % Some minor font changes for the special characters.
5011 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
5013 % Remove any glue we may have, we'll be inserting our own.
5014 \removelastskip
5016 % We like breaks before the index initials, so insert a bonus.
5017 \nobreak
5018 \vskip 0pt plus 3\baselineskip
5019 \penalty 0
5020 \vskip 0pt plus -3\baselineskip
5022 % Typeset the initial. Making this add up to a whole number of
5023 % baselineskips increases the chance of the dots lining up from column
5024 % to column. It still won't often be perfect, because of the stretch
5025 % we need before each entry, but it's better.
5027 % No shrink because it confuses \balancecolumns.
5028 \vskip 1.67\baselineskip plus .5\baselineskip
5029 \leftline{\secbf #1}%
5030 % Do our best not to break after the initial.
5031 \nobreak
5032 \vskip .33\baselineskip plus .1\baselineskip
5035 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
5036 % then page number (#2) flushed to the right margin. It is used for index
5037 % and table of contents entries. The paragraph is indented by \leftskip.
5039 % A straightforward implementation would start like this:
5040 % \def\entry#1#2{...
5041 % But this freezes the catcodes in the argument, and can cause problems to
5042 % @code, which sets - active. This problem was fixed by a kludge---
5043 % ``-'' was active throughout whole index, but this isn't really right.
5044 % The right solution is to prevent \entry from swallowing the whole text.
5045 % --kasal, 21nov03
5046 \def\entry{%
5047 \begingroup
5049 % Start a new paragraph if necessary, so our assignments below can't
5050 % affect previous text.
5051 \par
5053 % Do not fill out the last line with white space.
5054 \parfillskip = 0in
5056 % No extra space above this paragraph.
5057 \parskip = 0in
5059 % Do not prefer a separate line ending with a hyphen to fewer lines.
5060 \finalhyphendemerits = 0
5062 % \hangindent is only relevant when the entry text and page number
5063 % don't both fit on one line. In that case, bob suggests starting the
5064 % dots pretty far over on the line. Unfortunately, a large
5065 % indentation looks wrong when the entry text itself is broken across
5066 % lines. So we use a small indentation and put up with long leaders.
5068 % \hangafter is reset to 1 (which is the value we want) at the start
5069 % of each paragraph, so we need not do anything with that.
5070 \hangindent = 2em
5072 % When the entry text needs to be broken, just fill out the first line
5073 % with blank space.
5074 \rightskip = 0pt plus1fil
5076 % A bit of stretch before each entry for the benefit of balancing
5077 % columns.
5078 \vskip 0pt plus1pt
5080 % When reading the text of entry, convert explicit line breaks
5081 % from @* into spaces. The user might give these in long section
5082 % titles, for instance.
5083 \def\*{\unskip\space\ignorespaces}%
5084 \def\entrybreak{\hfil\break}%
5086 % Swallow the left brace of the text (first parameter):
5087 \afterassignment\doentry
5088 \let\temp =
5090 \def\entrybreak{\unskip\space\ignorespaces}%
5091 \def\doentry{%
5092 \bgroup % Instead of the swallowed brace.
5093 \noindent
5094 \aftergroup\finishentry
5095 % And now comes the text of the entry.
5097 \def\finishentry#1{%
5098 % #1 is the page number.
5100 % The following is kludged to not output a line of dots in the index if
5101 % there are no page numbers. The next person who breaks this will be
5102 % cursed by a Unix daemon.
5103 \setbox\boxA = \hbox{#1}%
5104 \ifdim\wd\boxA = 0pt
5106 \else
5108 % If we must, put the page number on a line of its own, and fill out
5109 % this line with blank space. (The \hfil is overwhelmed with the
5110 % fill leaders glue in \indexdotfill if the page number does fit.)
5111 \hfil\penalty50
5112 \null\nobreak\indexdotfill % Have leaders before the page number.
5114 % The `\ ' here is removed by the implicit \unskip that TeX does as
5115 % part of (the primitive) \par. Without it, a spurious underfull
5116 % \hbox ensues.
5117 \ifpdf
5118 \pdfgettoks#1.%
5119 \ \the\toksA
5120 \else
5121 \ #1%
5124 \par
5125 \endgroup
5128 % Like plain.tex's \dotfill, except uses up at least 1 em.
5129 \def\indexdotfill{\cleaders
5130 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
5132 \def\primary #1{\line{#1\hfil}}
5134 \newskip\secondaryindent \secondaryindent=0.5cm
5135 \def\secondary#1#2{{%
5136 \parfillskip=0in
5137 \parskip=0in
5138 \hangindent=1in
5139 \hangafter=1
5140 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5141 \ifpdf
5142 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
5143 \else
5146 \par
5149 % Define two-column mode, which we use to typeset indexes.
5150 % Adapted from the TeXbook, page 416, which is to say,
5151 % the manmac.tex format used to print the TeXbook itself.
5152 \catcode`\@=11
5154 \newbox\partialpage
5155 \newdimen\doublecolumnhsize
5157 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5158 % Grab any single-column material above us.
5159 \output = {%
5161 % Here is a possibility not foreseen in manmac: if we accumulate a
5162 % whole lot of material, we might end up calling this \output
5163 % routine twice in a row (see the doublecol-lose test, which is
5164 % essentially a couple of indexes with @setchapternewpage off). In
5165 % that case we just ship out what is in \partialpage with the normal
5166 % output routine. Generally, \partialpage will be empty when this
5167 % runs and this will be a no-op. See the indexspread.tex test case.
5168 \ifvoid\partialpage \else
5169 \onepageout{\pagecontents\partialpage}%
5172 \global\setbox\partialpage = \vbox{%
5173 % Unvbox the main output page.
5174 \unvbox\PAGE
5175 \kern-\topskip \kern\baselineskip
5178 \eject % run that output routine to set \partialpage
5180 % Use the double-column output routine for subsequent pages.
5181 \output = {\doublecolumnout}%
5183 % Change the page size parameters. We could do this once outside this
5184 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5185 % format, but then we repeat the same computation. Repeating a couple
5186 % of assignments once per index is clearly meaningless for the
5187 % execution time, so we may as well do it in one place.
5189 % First we halve the line length, less a little for the gutter between
5190 % the columns. We compute the gutter based on the line length, so it
5191 % changes automatically with the paper format. The magic constant
5192 % below is chosen so that the gutter has the same value (well, +-<1pt)
5193 % as it did when we hard-coded it.
5195 % We put the result in a separate register, \doublecolumhsize, so we
5196 % can restore it in \pagesofar, after \hsize itself has (potentially)
5197 % been clobbered.
5199 \doublecolumnhsize = \hsize
5200 \advance\doublecolumnhsize by -.04154\hsize
5201 \divide\doublecolumnhsize by 2
5202 \hsize = \doublecolumnhsize
5204 % Double the \vsize as well. (We don't need a separate register here,
5205 % since nobody clobbers \vsize.)
5206 \vsize = 2\vsize
5209 % The double-column output routine for all double-column pages except
5210 % the last.
5212 \def\doublecolumnout{%
5213 \splittopskip=\topskip \splitmaxdepth=\maxdepth
5214 % Get the available space for the double columns -- the normal
5215 % (undoubled) page height minus any material left over from the
5216 % previous page.
5217 \dimen@ = \vsize
5218 \divide\dimen@ by 2
5219 \advance\dimen@ by -\ht\partialpage
5221 % box0 will be the left-hand column, box2 the right.
5222 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
5223 \onepageout\pagesofar
5224 \unvbox255
5225 \penalty\outputpenalty
5228 % Re-output the contents of the output page -- any previous material,
5229 % followed by the two boxes we just split, in box0 and box2.
5230 \def\pagesofar{%
5231 \unvbox\partialpage
5233 \hsize = \doublecolumnhsize
5234 \wd0=\hsize \wd2=\hsize
5235 \hbox to\pagewidth{\box0\hfil\box2}%
5238 % All done with double columns.
5239 \def\enddoublecolumns{%
5240 % The following penalty ensures that the page builder is exercised
5241 % _before_ we change the output routine. This is necessary in the
5242 % following situation:
5244 % The last section of the index consists only of a single entry.
5245 % Before this section, \pagetotal is less than \pagegoal, so no
5246 % break occurs before the last section starts. However, the last
5247 % section, consisting of \initial and the single \entry, does not
5248 % fit on the page and has to be broken off. Without the following
5249 % penalty the page builder will not be exercised until \eject
5250 % below, and by that time we'll already have changed the output
5251 % routine to the \balancecolumns version, so the next-to-last
5252 % double-column page will be processed with \balancecolumns, which
5253 % is wrong: The two columns will go to the main vertical list, with
5254 % the broken-off section in the recent contributions. As soon as
5255 % the output routine finishes, TeX starts reconsidering the page
5256 % break. The two columns and the broken-off section both fit on the
5257 % page, because the two columns now take up only half of the page
5258 % goal. When TeX sees \eject from below which follows the final
5259 % section, it invokes the new output routine that we've set after
5260 % \balancecolumns below; \onepageout will try to fit the two columns
5261 % and the final section into the vbox of \pageheight (see
5262 % \pagebody), causing an overfull box.
5264 % Note that glue won't work here, because glue does not exercise the
5265 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5266 \penalty0
5268 \output = {%
5269 % Split the last of the double-column material. Leave it on the
5270 % current page, no automatic page break.
5271 \balancecolumns
5273 % If we end up splitting too much material for the current page,
5274 % though, there will be another page break right after this \output
5275 % invocation ends. Having called \balancecolumns once, we do not
5276 % want to call it again. Therefore, reset \output to its normal
5277 % definition right away. (We hope \balancecolumns will never be
5278 % called on to balance too much material, but if it is, this makes
5279 % the output somewhat more palatable.)
5280 \global\output = {\onepageout{\pagecontents\PAGE}}%
5282 \eject
5283 \endgroup % started in \begindoublecolumns
5285 % \pagegoal was set to the doubled \vsize above, since we restarted
5286 % the current page. We're now back to normal single-column
5287 % typesetting, so reset \pagegoal to the normal \vsize (after the
5288 % \endgroup where \vsize got restored).
5289 \pagegoal = \vsize
5292 % Called at the end of the double column material.
5293 \def\balancecolumns{%
5294 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5295 \dimen@ = \ht0
5296 \advance\dimen@ by \topskip
5297 \advance\dimen@ by-\baselineskip
5298 \divide\dimen@ by 2 % target to split to
5299 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5300 \splittopskip = \topskip
5301 % Loop until we get a decent breakpoint.
5303 \vbadness = 10000
5304 \loop
5305 \global\setbox3 = \copy0
5306 \global\setbox1 = \vsplit3 to \dimen@
5307 \ifdim\ht3>\dimen@
5308 \global\advance\dimen@ by 1pt
5309 \repeat
5311 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5312 \setbox0=\vbox to\dimen@{\unvbox1}%
5313 \setbox2=\vbox to\dimen@{\unvbox3}%
5315 \pagesofar
5317 \catcode`\@ = \other
5320 \message{sectioning,}
5321 % Chapters, sections, etc.
5323 % Let's start with @part.
5324 \outer\parseargdef\part{\partzzz{#1}}
5325 \def\partzzz#1{%
5326 \chapoddpage
5327 \null
5328 \vskip.3\vsize % move it down on the page a bit
5329 \begingroup
5330 \noindent \titlefonts\rmisbold #1\par % the text
5331 \let\lastnode=\empty % no node to associate with
5332 \writetocentry{part}{#1}{}% but put it in the toc
5333 \headingsoff % no headline or footline on the part page
5334 \chapoddpage
5335 \endgroup
5338 % \unnumberedno is an oxymoron. But we count the unnumbered
5339 % sections so that we can refer to them unambiguously in the pdf
5340 % outlines by their "section number". We avoid collisions with chapter
5341 % numbers by starting them at 10000. (If a document ever has 10000
5342 % chapters, we're in trouble anyway, I'm sure.)
5343 \newcount\unnumberedno \unnumberedno = 10000
5344 \newcount\chapno
5345 \newcount\secno \secno=0
5346 \newcount\subsecno \subsecno=0
5347 \newcount\subsubsecno \subsubsecno=0
5349 % This counter is funny since it counts through charcodes of letters A, B, ...
5350 \newcount\appendixno \appendixno = `\@
5352 % \def\appendixletter{\char\the\appendixno}
5353 % We do the following ugly conditional instead of the above simple
5354 % construct for the sake of pdftex, which needs the actual
5355 % letter in the expansion, not just typeset.
5357 \def\appendixletter{%
5358 \ifnum\appendixno=`A A%
5359 \else\ifnum\appendixno=`B B%
5360 \else\ifnum\appendixno=`C C%
5361 \else\ifnum\appendixno=`D D%
5362 \else\ifnum\appendixno=`E E%
5363 \else\ifnum\appendixno=`F F%
5364 \else\ifnum\appendixno=`G G%
5365 \else\ifnum\appendixno=`H H%
5366 \else\ifnum\appendixno=`I I%
5367 \else\ifnum\appendixno=`J J%
5368 \else\ifnum\appendixno=`K K%
5369 \else\ifnum\appendixno=`L L%
5370 \else\ifnum\appendixno=`M M%
5371 \else\ifnum\appendixno=`N N%
5372 \else\ifnum\appendixno=`O O%
5373 \else\ifnum\appendixno=`P P%
5374 \else\ifnum\appendixno=`Q Q%
5375 \else\ifnum\appendixno=`R R%
5376 \else\ifnum\appendixno=`S S%
5377 \else\ifnum\appendixno=`T T%
5378 \else\ifnum\appendixno=`U U%
5379 \else\ifnum\appendixno=`V V%
5380 \else\ifnum\appendixno=`W W%
5381 \else\ifnum\appendixno=`X X%
5382 \else\ifnum\appendixno=`Y Y%
5383 \else\ifnum\appendixno=`Z Z%
5384 % The \the is necessary, despite appearances, because \appendixletter is
5385 % expanded while writing the .toc file. \char\appendixno is not
5386 % expandable, thus it is written literally, thus all appendixes come out
5387 % with the same letter (or @) in the toc without it.
5388 \else\char\the\appendixno
5389 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5390 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5392 % Each @chapter defines these (using marks) as the number+name, number
5393 % and name of the chapter. Page headings and footings can use
5394 % these. @section does likewise.
5395 \def\thischapter{}
5396 \def\thischapternum{}
5397 \def\thischaptername{}
5398 \def\thissection{}
5399 \def\thissectionnum{}
5400 \def\thissectionname{}
5402 \newcount\absseclevel % used to calculate proper heading level
5403 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5405 % @raisesections: treat @section as chapter, @subsection as section, etc.
5406 \def\raisesections{\global\advance\secbase by -1}
5407 \let\up=\raisesections % original BFox name
5409 % @lowersections: treat @chapter as section, @section as subsection, etc.
5410 \def\lowersections{\global\advance\secbase by 1}
5411 \let\down=\lowersections % original BFox name
5413 % we only have subsub.
5414 \chardef\maxseclevel = 3
5416 % A numbered section within an unnumbered changes to unnumbered too.
5417 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5418 \chardef\unnlevel = \maxseclevel
5420 % Trace whether the current chapter is an appendix or not:
5421 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5422 \def\chapheadtype{N}
5424 % Choose a heading macro
5425 % #1 is heading type
5426 % #2 is heading level
5427 % #3 is text for heading
5428 \def\genhead#1#2#3{%
5429 % Compute the abs. sec. level:
5430 \absseclevel=#2
5431 \advance\absseclevel by \secbase
5432 % Make sure \absseclevel doesn't fall outside the range:
5433 \ifnum \absseclevel < 0
5434 \absseclevel = 0
5435 \else
5436 \ifnum \absseclevel > 3
5437 \absseclevel = 3
5440 % The heading type:
5441 \def\headtype{#1}%
5442 \if \headtype U%
5443 \ifnum \absseclevel < \unnlevel
5444 \chardef\unnlevel = \absseclevel
5446 \else
5447 % Check for appendix sections:
5448 \ifnum \absseclevel = 0
5449 \edef\chapheadtype{\headtype}%
5450 \else
5451 \if \headtype A\if \chapheadtype N%
5452 \errmessage{@appendix... within a non-appendix chapter}%
5453 \fi\fi
5455 % Check for numbered within unnumbered:
5456 \ifnum \absseclevel > \unnlevel
5457 \def\headtype{U}%
5458 \else
5459 \chardef\unnlevel = 3
5462 % Now print the heading:
5463 \if \headtype U%
5464 \ifcase\absseclevel
5465 \unnumberedzzz{#3}%
5466 \or \unnumberedseczzz{#3}%
5467 \or \unnumberedsubseczzz{#3}%
5468 \or \unnumberedsubsubseczzz{#3}%
5470 \else
5471 \if \headtype A%
5472 \ifcase\absseclevel
5473 \appendixzzz{#3}%
5474 \or \appendixsectionzzz{#3}%
5475 \or \appendixsubseczzz{#3}%
5476 \or \appendixsubsubseczzz{#3}%
5478 \else
5479 \ifcase\absseclevel
5480 \chapterzzz{#3}%
5481 \or \seczzz{#3}%
5482 \or \numberedsubseczzz{#3}%
5483 \or \numberedsubsubseczzz{#3}%
5487 \suppressfirstparagraphindent
5490 % an interface:
5491 \def\numhead{\genhead N}
5492 \def\apphead{\genhead A}
5493 \def\unnmhead{\genhead U}
5495 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5496 % all lower-level sectioning counters to zero.
5498 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5499 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5500 \let\chaplevelprefix = \empty
5502 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5503 \def\chapterzzz#1{%
5504 % section resetting is \global in case the chapter is in a group, such
5505 % as an @include file.
5506 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5507 \global\advance\chapno by 1
5509 % Used for \float.
5510 \gdef\chaplevelprefix{\the\chapno.}%
5511 \resetallfloatnos
5513 % \putwordChapter can contain complex things in translations.
5514 \toks0=\expandafter{\putwordChapter}%
5515 \message{\the\toks0 \space \the\chapno}%
5517 % Write the actual heading.
5518 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5520 % So @section and the like are numbered underneath this chapter.
5521 \global\let\section = \numberedsec
5522 \global\let\subsection = \numberedsubsec
5523 \global\let\subsubsection = \numberedsubsubsec
5526 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5528 \def\appendixzzz#1{%
5529 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5530 \global\advance\appendixno by 1
5531 \gdef\chaplevelprefix{\appendixletter.}%
5532 \resetallfloatnos
5534 % \putwordAppendix can contain complex things in translations.
5535 \toks0=\expandafter{\putwordAppendix}%
5536 \message{\the\toks0 \space \appendixletter}%
5538 \chapmacro{#1}{Yappendix}{\appendixletter}%
5540 \global\let\section = \appendixsec
5541 \global\let\subsection = \appendixsubsec
5542 \global\let\subsubsection = \appendixsubsubsec
5545 % normally unnmhead0 calls unnumberedzzz:
5546 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5547 \def\unnumberedzzz#1{%
5548 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5549 \global\advance\unnumberedno by 1
5551 % Since an unnumbered has no number, no prefix for figures.
5552 \global\let\chaplevelprefix = \empty
5553 \resetallfloatnos
5555 % This used to be simply \message{#1}, but TeX fully expands the
5556 % argument to \message. Therefore, if #1 contained @-commands, TeX
5557 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5558 % expanded @cite (which turns out to cause errors because \cite is meant
5559 % to be executed, not expanded).
5561 % Anyway, we don't want the fully-expanded definition of @cite to appear
5562 % as a result of the \message, we just want `@cite' itself. We use
5563 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5564 % simply yielding the contents of <toks register>. (We also do this for
5565 % the toc entries.)
5566 \toks0 = {#1}%
5567 \message{(\the\toks0)}%
5569 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5571 \global\let\section = \unnumberedsec
5572 \global\let\subsection = \unnumberedsubsec
5573 \global\let\subsubsection = \unnumberedsubsubsec
5576 % @centerchap is like @unnumbered, but the heading is centered.
5577 \outer\parseargdef\centerchap{%
5578 % Well, we could do the following in a group, but that would break
5579 % an assumption that \chapmacro is called at the outermost level.
5580 % Thus we are safer this way: --kasal, 24feb04
5581 \let\centerparametersmaybe = \centerparameters
5582 \unnmhead0{#1}%
5583 \let\centerparametersmaybe = \relax
5586 % @top is like @unnumbered.
5587 \let\top\unnumbered
5589 % Sections.
5591 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5592 \def\seczzz#1{%
5593 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5594 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5597 % normally calls appendixsectionzzz:
5598 \outer\parseargdef\appendixsection{\apphead1{#1}}
5599 \def\appendixsectionzzz#1{%
5600 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5601 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5603 \let\appendixsec\appendixsection
5605 % normally calls unnumberedseczzz:
5606 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5607 \def\unnumberedseczzz#1{%
5608 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5609 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5612 % Subsections.
5614 % normally calls numberedsubseczzz:
5615 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5616 \def\numberedsubseczzz#1{%
5617 \global\subsubsecno=0 \global\advance\subsecno by 1
5618 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5621 % normally calls appendixsubseczzz:
5622 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5623 \def\appendixsubseczzz#1{%
5624 \global\subsubsecno=0 \global\advance\subsecno by 1
5625 \sectionheading{#1}{subsec}{Yappendix}%
5626 {\appendixletter.\the\secno.\the\subsecno}%
5629 % normally calls unnumberedsubseczzz:
5630 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5631 \def\unnumberedsubseczzz#1{%
5632 \global\subsubsecno=0 \global\advance\subsecno by 1
5633 \sectionheading{#1}{subsec}{Ynothing}%
5634 {\the\unnumberedno.\the\secno.\the\subsecno}%
5637 % Subsubsections.
5639 % normally numberedsubsubseczzz:
5640 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5641 \def\numberedsubsubseczzz#1{%
5642 \global\advance\subsubsecno by 1
5643 \sectionheading{#1}{subsubsec}{Ynumbered}%
5644 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5647 % normally appendixsubsubseczzz:
5648 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5649 \def\appendixsubsubseczzz#1{%
5650 \global\advance\subsubsecno by 1
5651 \sectionheading{#1}{subsubsec}{Yappendix}%
5652 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5655 % normally unnumberedsubsubseczzz:
5656 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5657 \def\unnumberedsubsubseczzz#1{%
5658 \global\advance\subsubsecno by 1
5659 \sectionheading{#1}{subsubsec}{Ynothing}%
5660 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5663 % These macros control what the section commands do, according
5664 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5665 % Define them by default for a numbered chapter.
5666 \let\section = \numberedsec
5667 \let\subsection = \numberedsubsec
5668 \let\subsubsection = \numberedsubsubsec
5670 % Define @majorheading, @heading and @subheading
5672 \def\majorheading{%
5673 {\advance\chapheadingskip by 10pt \chapbreak }%
5674 \parsearg\chapheadingzzz
5677 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5678 \def\chapheadingzzz#1{%
5679 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5680 \nobreak\bigskip \nobreak
5681 \suppressfirstparagraphindent
5684 % @heading, @subheading, @subsubheading.
5685 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5686 \suppressfirstparagraphindent}
5687 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5688 \suppressfirstparagraphindent}
5689 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5690 \suppressfirstparagraphindent}
5692 % These macros generate a chapter, section, etc. heading only
5693 % (including whitespace, linebreaking, etc. around it),
5694 % given all the information in convenient, parsed form.
5696 % Args are the skip and penalty (usually negative)
5697 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5699 % Parameter controlling skip before chapter headings (if needed)
5700 \newskip\chapheadingskip
5702 % Define plain chapter starts, and page on/off switching for it.
5703 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5704 \def\chappager{\par\vfill\supereject}
5705 % Because \domark is called before \chapoddpage, the filler page will
5706 % get the headings for the next chapter, which is wrong. But we don't
5707 % care -- we just disable all headings on the filler page.
5708 \def\chapoddpage{%
5709 \chappager
5710 \ifodd\pageno \else
5711 \begingroup
5712 \headingsoff
5713 \null
5714 \chappager
5715 \endgroup
5719 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5721 \def\CHAPPAGoff{%
5722 \global\let\contentsalignmacro = \chappager
5723 \global\let\pchapsepmacro=\chapbreak
5724 \global\let\pagealignmacro=\chappager}
5726 \def\CHAPPAGon{%
5727 \global\let\contentsalignmacro = \chappager
5728 \global\let\pchapsepmacro=\chappager
5729 \global\let\pagealignmacro=\chappager
5730 \global\def\HEADINGSon{\HEADINGSsingle}}
5732 \def\CHAPPAGodd{%
5733 \global\let\contentsalignmacro = \chapoddpage
5734 \global\let\pchapsepmacro=\chapoddpage
5735 \global\let\pagealignmacro=\chapoddpage
5736 \global\def\HEADINGSon{\HEADINGSdouble}}
5738 \CHAPPAGon
5740 % Chapter opening.
5742 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5743 % Yappendix, Yomitfromtoc), #3 the chapter number.
5744 % Not used for @heading series.
5746 % To test against our argument.
5747 \def\Ynothingkeyword{Ynothing}
5748 \def\Yappendixkeyword{Yappendix}
5749 \def\Yomitfromtockeyword{Yomitfromtoc}
5751 \def\chapmacro#1#2#3{%
5752 \checkenv{}% chapters, etc., should not start inside an environment.
5754 % Insert the first mark before the heading break (see notes for \domark).
5755 \let\prevchapterdefs=\lastchapterdefs
5756 \let\prevsectiondefs=\lastsectiondefs
5757 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5758 \gdef\thissection{}}%
5760 \def\temptype{#2}%
5761 \ifx\temptype\Ynothingkeyword
5762 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5763 \gdef\thischapter{\thischaptername}}%
5764 \else\ifx\temptype\Yomitfromtockeyword
5765 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5766 \gdef\thischapter{}}%
5767 \else\ifx\temptype\Yappendixkeyword
5768 \toks0={#1}%
5769 \xdef\lastchapterdefs{%
5770 \gdef\noexpand\thischaptername{\the\toks0}%
5771 \gdef\noexpand\thischapternum{\appendixletter}%
5772 % \noexpand\putwordAppendix avoids expanding indigestible
5773 % commands in some of the translations.
5774 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5775 \noexpand\thischapternum:
5776 \noexpand\thischaptername}%
5778 \else
5779 \toks0={#1}%
5780 \xdef\lastchapterdefs{%
5781 \gdef\noexpand\thischaptername{\the\toks0}%
5782 \gdef\noexpand\thischapternum{\the\chapno}%
5783 % \noexpand\putwordChapter avoids expanding indigestible
5784 % commands in some of the translations.
5785 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5786 \noexpand\thischapternum:
5787 \noexpand\thischaptername}%
5789 \fi\fi\fi
5791 % Output the mark. Pass it through \safewhatsit, to take care of
5792 % the preceding space.
5793 \safewhatsit\domark
5795 % Insert the chapter heading break.
5796 \pchapsepmacro
5798 % Now the second mark, after the heading break. No break points
5799 % between here and the heading.
5800 \let\prevchapterdefs=\lastchapterdefs
5801 \let\prevsectiondefs=\lastsectiondefs
5802 \domark
5805 \chapfonts \rmisbold
5806 \let\footnote=\errfootnoteheading % give better error message
5808 % Have to define \lastsection before calling \donoderef, because the
5809 % xref code eventually uses it. On the other hand, it has to be called
5810 % after \pchapsepmacro, or the headline will change too soon.
5811 \gdef\lastsection{#1}%
5813 % Only insert the separating space if we have a chapter/appendix
5814 % number, and don't print the unnumbered ``number''.
5815 \ifx\temptype\Ynothingkeyword
5816 \setbox0 = \hbox{}%
5817 \def\toctype{unnchap}%
5818 \else\ifx\temptype\Yomitfromtockeyword
5819 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5820 \def\toctype{omit}%
5821 \else\ifx\temptype\Yappendixkeyword
5822 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5823 \def\toctype{app}%
5824 \else
5825 \setbox0 = \hbox{#3\enspace}%
5826 \def\toctype{numchap}%
5827 \fi\fi\fi
5829 % Write the toc entry for this chapter. Must come before the
5830 % \donoderef, because we include the current node name in the toc
5831 % entry, and \donoderef resets it to empty.
5832 \writetocentry{\toctype}{#1}{#3}%
5834 % For pdftex, we have to write out the node definition (aka, make
5835 % the pdfdest) after any page break, but before the actual text has
5836 % been typeset. If the destination for the pdf outline is after the
5837 % text, then jumping from the outline may wind up with the text not
5838 % being visible, for instance under high magnification.
5839 \donoderef{#2}%
5841 % Typeset the actual heading.
5842 \nobreak % Avoid page breaks at the interline glue.
5843 \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe
5844 \unhbox0 #1\par}%
5846 \nobreak\bigskip % no page break after a chapter title
5847 \nobreak
5850 % @centerchap -- centered and unnumbered.
5851 \let\centerparametersmaybe = \relax
5852 \def\centerparameters{%
5853 \advance\rightskip by 3\rightskip
5854 \leftskip = \rightskip
5855 \parfillskip = 0pt
5859 % I don't think this chapter style is supported any more, so I'm not
5860 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5862 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5864 \def\unnchfopen #1{%
5865 \chapoddpage
5866 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5867 \nobreak\bigskip\nobreak
5869 \def\chfopen #1#2{\chapoddpage {\chapfonts
5870 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5871 \par\penalty 5000 %
5873 \def\centerchfopen #1{%
5874 \chapoddpage
5875 \vbox{\chapfonts \raggedtitlesettings \hfill #1\hfill}%
5876 \nobreak\bigskip \nobreak
5878 \def\CHAPFopen{%
5879 \global\let\chapmacro=\chfopen
5880 \global\let\centerchapmacro=\centerchfopen}
5883 % Section titles. These macros combine the section number parts and
5884 % call the generic \sectionheading to do the printing.
5886 \newskip\secheadingskip
5887 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5889 % Subsection titles.
5890 \newskip\subsecheadingskip
5891 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5893 % Subsubsection titles.
5894 \def\subsubsecheadingskip{\subsecheadingskip}
5895 \def\subsubsecheadingbreak{\subsecheadingbreak}
5898 % Print any size, any type, section title.
5900 % #1 is the text of the title,
5901 % #2 is the section level (sec/subsec/subsubsec),
5902 % #3 is the section type (Ynumbered, Ynothing, Yappendix, Yomitfromtoc),
5903 % #4 is the section number.
5905 \def\seckeyword{sec}
5907 \def\sectionheading#1#2#3#4{%
5909 \def\sectionlevel{#2}%
5910 \def\temptype{#3}%
5912 % It is ok for the @heading series commands to appear inside an
5913 % environment (it's been historically allowed, though the logic is
5914 % dubious), but not the others.
5915 \ifx\temptype\Yomitfromtockeyword\else
5916 \checkenv{}% non-@*heading should not be in an environment.
5918 \let\footnote=\errfootnoteheading
5920 % Switch to the right set of fonts.
5921 \csname #2fonts\endcsname \rmisbold
5923 % Insert first mark before the heading break (see notes for \domark).
5924 \let\prevsectiondefs=\lastsectiondefs
5925 \ifx\temptype\Ynothingkeyword
5926 \ifx\sectionlevel\seckeyword
5927 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5928 \gdef\thissection{\thissectionname}}%
5930 \else\ifx\temptype\Yomitfromtockeyword
5931 % Don't redefine \thissection.
5932 \else\ifx\temptype\Yappendixkeyword
5933 \ifx\sectionlevel\seckeyword
5934 \toks0={#1}%
5935 \xdef\lastsectiondefs{%
5936 \gdef\noexpand\thissectionname{\the\toks0}%
5937 \gdef\noexpand\thissectionnum{#4}%
5938 % \noexpand\putwordSection avoids expanding indigestible
5939 % commands in some of the translations.
5940 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5941 \noexpand\thissectionnum:
5942 \noexpand\thissectionname}%
5945 \else
5946 \ifx\sectionlevel\seckeyword
5947 \toks0={#1}%
5948 \xdef\lastsectiondefs{%
5949 \gdef\noexpand\thissectionname{\the\toks0}%
5950 \gdef\noexpand\thissectionnum{#4}%
5951 % \noexpand\putwordSection avoids expanding indigestible
5952 % commands in some of the translations.
5953 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5954 \noexpand\thissectionnum:
5955 \noexpand\thissectionname}%
5958 \fi\fi\fi
5960 % Go into vertical mode. Usually we'll already be there, but we
5961 % don't want the following whatsit to end up in a preceding paragraph
5962 % if the document didn't happen to have a blank line.
5963 \par
5965 % Output the mark. Pass it through \safewhatsit, to take care of
5966 % the preceding space.
5967 \safewhatsit\domark
5969 % Insert space above the heading.
5970 \csname #2headingbreak\endcsname
5972 % Now the second mark, after the heading break. No break points
5973 % between here and the heading.
5974 \global\let\prevsectiondefs=\lastsectiondefs
5975 \domark
5977 % Only insert the space after the number if we have a section number.
5978 \ifx\temptype\Ynothingkeyword
5979 \setbox0 = \hbox{}%
5980 \def\toctype{unn}%
5981 \gdef\lastsection{#1}%
5982 \else\ifx\temptype\Yomitfromtockeyword
5983 % for @headings -- no section number, don't include in toc,
5984 % and don't redefine \lastsection.
5985 \setbox0 = \hbox{}%
5986 \def\toctype{omit}%
5987 \let\sectionlevel=\empty
5988 \else\ifx\temptype\Yappendixkeyword
5989 \setbox0 = \hbox{#4\enspace}%
5990 \def\toctype{app}%
5991 \gdef\lastsection{#1}%
5992 \else
5993 \setbox0 = \hbox{#4\enspace}%
5994 \def\toctype{num}%
5995 \gdef\lastsection{#1}%
5996 \fi\fi\fi
5998 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5999 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
6001 % Write the node reference (= pdf destination for pdftex).
6002 % Again, see comments in \chapmacro.
6003 \donoderef{#3}%
6005 % Interline glue will be inserted when the vbox is completed.
6006 % That glue will be a valid breakpoint for the page, since it'll be
6007 % preceded by a whatsit (usually from the \donoderef, or from the
6008 % \writetocentry if there was no node). We don't want to allow that
6009 % break, since then the whatsits could end up on page n while the
6010 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
6011 \nobreak
6013 % Output the actual section heading.
6014 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
6015 \hangindent=\wd0 % zero if no section number
6016 \unhbox0 #1}%
6018 % Add extra space after the heading -- half of whatever came above it.
6019 % Don't allow stretch, though.
6020 \kern .5 \csname #2headingskip\endcsname
6022 % Do not let the kern be a potential breakpoint, as it would be if it
6023 % was followed by glue.
6024 \nobreak
6026 % We'll almost certainly start a paragraph next, so don't let that
6027 % glue accumulate. (Not a breakpoint because it's preceded by a
6028 % discardable item.) However, when a paragraph is not started next
6029 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
6030 % or the negative glue will cause weirdly wrong output, typically
6031 % obscuring the section heading with something else.
6032 \vskip-\parskip
6034 % This is so the last item on the main vertical list is a known
6035 % \penalty > 10000, so \startdefun, etc., can recognize the situation
6036 % and do the needful.
6037 \penalty 10001
6041 \message{toc,}
6042 % Table of contents.
6043 \newwrite\tocfile
6045 % Write an entry to the toc file, opening it if necessary.
6046 % Called from @chapter, etc.
6048 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
6049 % We append the current node name (if any) and page number as additional
6050 % arguments for the \{chap,sec,...}entry macros which will eventually
6051 % read this. The node name is used in the pdf outlines as the
6052 % destination to jump to.
6054 % We open the .toc file for writing here instead of at @setfilename (or
6055 % any other fixed time) so that @contents can be anywhere in the document.
6056 % But if #1 is `omit', then we don't do anything. This is used for the
6057 % table of contents chapter openings themselves.
6059 \newif\iftocfileopened
6060 \def\omitkeyword{omit}%
6062 \def\writetocentry#1#2#3{%
6063 \edef\writetoctype{#1}%
6064 \ifx\writetoctype\omitkeyword \else
6065 \iftocfileopened\else
6066 \immediate\openout\tocfile = \jobname.toc
6067 \global\tocfileopenedtrue
6070 \iflinks
6071 {\atdummies
6072 \edef\temp{%
6073 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
6074 \temp
6079 % Tell \shipout to create a pdf destination on each page, if we're
6080 % writing pdf. These are used in the table of contents. We can't
6081 % just write one on every page because the title pages are numbered
6082 % 1 and 2 (the page numbers aren't printed), and so are the first
6083 % two pages of the document. Thus, we'd have two destinations named
6084 % `1', and two named `2'.
6085 \ifpdf \global\pdfmakepagedesttrue \fi
6089 % These characters do not print properly in the Computer Modern roman
6090 % fonts, so we must take special care. This is more or less redundant
6091 % with the Texinfo input format setup at the end of this file.
6093 \def\activecatcodes{%
6094 \catcode`\"=\active
6095 \catcode`\$=\active
6096 \catcode`\<=\active
6097 \catcode`\>=\active
6098 \catcode`\\=\active
6099 \catcode`\^=\active
6100 \catcode`\_=\active
6101 \catcode`\|=\active
6102 \catcode`\~=\active
6106 % Read the toc file, which is essentially Texinfo input.
6107 \def\readtocfile{%
6108 \setupdatafile
6109 \activecatcodes
6110 \input \tocreadfilename
6113 \newskip\contentsrightmargin \contentsrightmargin=1in
6114 \newcount\savepageno
6115 \newcount\lastnegativepageno \lastnegativepageno = -1
6117 % Prepare to read what we've written to \tocfile.
6119 \def\startcontents#1{%
6120 % If @setchapternewpage on, and @headings double, the contents should
6121 % start on an odd page, unlike chapters. Thus, we maintain
6122 % \contentsalignmacro in parallel with \pagealignmacro.
6123 % From: Torbjorn Granlund <tege@matematik.su.se>
6124 \contentsalignmacro
6125 \immediate\closeout\tocfile
6127 % Don't need to put `Contents' or `Short Contents' in the headline.
6128 % It is abundantly clear what they are.
6129 \chapmacro{#1}{Yomitfromtoc}{}%
6131 \savepageno = \pageno
6132 \begingroup % Set up to handle contents files properly.
6133 \raggedbottom % Worry more about breakpoints than the bottom.
6134 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
6136 % Roman numerals for page numbers.
6137 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
6140 % redefined for the two-volume lispref. We always output on
6141 % \jobname.toc even if this is redefined.
6143 \def\tocreadfilename{\jobname.toc}
6145 % Normal (long) toc.
6147 \def\contents{%
6148 \startcontents{\putwordTOC}%
6149 \openin 1 \tocreadfilename\space
6150 \ifeof 1 \else
6151 \readtocfile
6153 \vfill \eject
6154 \contentsalignmacro % in case @setchapternewpage odd is in effect
6155 \ifeof 1 \else
6156 \pdfmakeoutlines
6158 \closein 1
6159 \endgroup
6160 \lastnegativepageno = \pageno
6161 \global\pageno = \savepageno
6164 % And just the chapters.
6165 \def\summarycontents{%
6166 \startcontents{\putwordShortTOC}%
6168 \let\partentry = \shortpartentry
6169 \let\numchapentry = \shortchapentry
6170 \let\appentry = \shortchapentry
6171 \let\unnchapentry = \shortunnchapentry
6172 % We want a true roman here for the page numbers.
6173 \secfonts
6174 \let\rm=\shortcontrm \let\bf=\shortcontbf
6175 \let\sl=\shortcontsl \let\tt=\shortconttt
6177 \hyphenpenalty = 10000
6178 \advance\baselineskip by 1pt % Open it up a little.
6179 \def\numsecentry##1##2##3##4{}
6180 \let\appsecentry = \numsecentry
6181 \let\unnsecentry = \numsecentry
6182 \let\numsubsecentry = \numsecentry
6183 \let\appsubsecentry = \numsecentry
6184 \let\unnsubsecentry = \numsecentry
6185 \let\numsubsubsecentry = \numsecentry
6186 \let\appsubsubsecentry = \numsecentry
6187 \let\unnsubsubsecentry = \numsecentry
6188 \openin 1 \tocreadfilename\space
6189 \ifeof 1 \else
6190 \readtocfile
6192 \closein 1
6193 \vfill \eject
6194 \contentsalignmacro % in case @setchapternewpage odd is in effect
6195 \endgroup
6196 \lastnegativepageno = \pageno
6197 \global\pageno = \savepageno
6199 \let\shortcontents = \summarycontents
6201 % Typeset the label for a chapter or appendix for the short contents.
6202 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6204 \def\shortchaplabel#1{%
6205 % This space should be enough, since a single number is .5em, and the
6206 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6207 % But use \hss just in case.
6208 % (This space doesn't include the extra space that gets added after
6209 % the label; that gets put in by \shortchapentry above.)
6211 % We'd like to right-justify chapter numbers, but that looks strange
6212 % with appendix letters. And right-justifying numbers and
6213 % left-justifying letters looks strange when there is less than 10
6214 % chapters. Have to read the whole toc once to know how many chapters
6215 % there are before deciding ...
6216 \hbox to 1em{#1\hss}%
6219 % These macros generate individual entries in the table of contents.
6220 % The first argument is the chapter or section name.
6221 % The last argument is the page number.
6222 % The arguments in between are the chapter number, section number, ...
6224 % Parts, in the main contents. Replace the part number, which doesn't
6225 % exist, with an empty box. Let's hope all the numbers have the same width.
6226 % Also ignore the page number, which is conventionally not printed.
6227 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6228 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6230 % Parts, in the short toc.
6231 \def\shortpartentry#1#2#3#4{%
6232 \penalty-300
6233 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6234 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6237 % Chapters, in the main contents.
6238 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6240 % Chapters, in the short toc.
6241 % See comments in \dochapentry re vbox and related settings.
6242 \def\shortchapentry#1#2#3#4{%
6243 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6246 % Appendices, in the main contents.
6247 % Need the word Appendix, and a fixed-size box.
6249 \def\appendixbox#1{%
6250 % We use M since it's probably the widest letter.
6251 \setbox0 = \hbox{\putwordAppendix{} M}%
6252 \hbox to \wd0{\putwordAppendix{} #1\hss}}
6254 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6256 % Unnumbered chapters.
6257 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6258 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6260 % Sections.
6261 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6262 \let\appsecentry=\numsecentry
6263 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6265 % Subsections.
6266 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6267 \let\appsubsecentry=\numsubsecentry
6268 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6270 % And subsubsections.
6271 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6272 \let\appsubsubsecentry=\numsubsubsecentry
6273 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6275 % This parameter controls the indentation of the various levels.
6276 % Same as \defaultparindent.
6277 \newdimen\tocindent \tocindent = 15pt
6279 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6280 % page number.
6282 % If the toc has to be broken over pages, we want it to be at chapters
6283 % if at all possible; hence the \penalty.
6284 \def\dochapentry#1#2{%
6285 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6286 \begingroup
6287 \chapentryfonts
6288 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6289 \endgroup
6290 \nobreak\vskip .25\baselineskip plus.1\baselineskip
6293 \def\dosecentry#1#2{\begingroup
6294 \secentryfonts \leftskip=\tocindent
6295 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6296 \endgroup}
6298 \def\dosubsecentry#1#2{\begingroup
6299 \subsecentryfonts \leftskip=2\tocindent
6300 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6301 \endgroup}
6303 \def\dosubsubsecentry#1#2{\begingroup
6304 \subsubsecentryfonts \leftskip=3\tocindent
6305 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6306 \endgroup}
6308 % We use the same \entry macro as for the index entries.
6309 \let\tocentry = \entry
6311 % Space between chapter (or whatever) number and the title.
6312 \def\labelspace{\hskip1em \relax}
6314 \def\dopageno#1{{\rm #1}}
6315 \def\doshortpageno#1{{\rm #1}}
6317 \def\chapentryfonts{\secfonts \rm}
6318 \def\secentryfonts{\textfonts}
6319 \def\subsecentryfonts{\textfonts}
6320 \def\subsubsecentryfonts{\textfonts}
6323 \message{environments,}
6324 % @foo ... @end foo.
6326 % @tex ... @end tex escapes into raw TeX temporarily.
6327 % One exception: @ is still an escape character, so that @end tex works.
6328 % But \@ or @@ will get a plain @ character.
6330 \envdef\tex{%
6331 \setupmarkupstyle{tex}%
6332 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6333 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6334 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6335 \catcode `\%=14
6336 \catcode `\+=\other
6337 \catcode `\"=\other
6338 \catcode `\|=\other
6339 \catcode `\<=\other
6340 \catcode `\>=\other
6341 \catcode `\`=\other
6342 \catcode `\'=\other
6343 \escapechar=`\\
6345 % ' is active in math mode (mathcode"8000). So reset it, and all our
6346 % other math active characters (just in case), to plain's definitions.
6347 \mathactive
6349 % Inverse of the list at the beginning of the file.
6350 \let\b=\ptexb
6351 \let\bullet=\ptexbullet
6352 \let\c=\ptexc
6353 \let\,=\ptexcomma
6354 \let\.=\ptexdot
6355 \let\dots=\ptexdots
6356 \let\equiv=\ptexequiv
6357 \let\!=\ptexexclam
6358 \let\i=\ptexi
6359 \let\indent=\ptexindent
6360 \let\noindent=\ptexnoindent
6361 \let\{=\ptexlbrace
6362 \let\+=\tabalign
6363 \let\}=\ptexrbrace
6364 \let\/=\ptexslash
6365 \let\sp=\ptexsp
6366 \let\*=\ptexstar
6367 %\let\sup=\ptexsup % do not redefine, we want @sup to work in math mode
6368 \let\t=\ptext
6369 \expandafter \let\csname top\endcsname=\ptextop % we've made it outer
6370 \let\frenchspacing=\plainfrenchspacing
6372 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6373 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6374 \def\@{@}%
6376 % There is no need to define \Etex.
6378 % Define @lisp ... @end lisp.
6379 % @lisp environment forms a group so it can rebind things,
6380 % including the definition of @end lisp (which normally is erroneous).
6382 % Amount to narrow the margins by for @lisp.
6383 \newskip\lispnarrowing \lispnarrowing=0.4in
6385 % This is the definition that ^^M gets inside @lisp, @example, and other
6386 % such environments. \null is better than a space, since it doesn't
6387 % have any width.
6388 \def\lisppar{\null\endgraf}
6390 % This space is always present above and below environments.
6391 \newskip\envskipamount \envskipamount = 0pt
6393 % Make spacing and below environment symmetrical. We use \parskip here
6394 % to help in doing that, since in @example-like environments \parskip
6395 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6396 % start of the next paragraph will insert \parskip.
6398 \def\aboveenvbreak{{%
6399 % =10000 instead of <10000 because of a special case in \itemzzz and
6400 % \sectionheading, q.v.
6401 \ifnum \lastpenalty=10000 \else
6402 \advance\envskipamount by \parskip
6403 \endgraf
6404 \ifdim\lastskip<\envskipamount
6405 \removelastskip
6406 % it's not a good place to break if the last penalty was \nobreak
6407 % or better ...
6408 \ifnum\lastpenalty<10000 \penalty-50 \fi
6409 \vskip\envskipamount
6414 \let\afterenvbreak = \aboveenvbreak
6416 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6417 % also clear it, so that its embedded environments do the narrowing again.
6418 \let\nonarrowing=\relax
6420 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6421 % environment contents.
6422 \font\circle=lcircle10
6423 \newdimen\circthick
6424 \newdimen\cartouter\newdimen\cartinner
6425 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6426 \circthick=\fontdimen8\circle
6428 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6429 \def\ctr{{\hskip 6pt\circle\char'010}}
6430 \def\cbl{{\circle\char'012\hskip -6pt}}
6431 \def\cbr{{\hskip 6pt\circle\char'011}}
6432 \def\carttop{\hbox to \cartouter{\hskip\lskip
6433 \ctl\leaders\hrule height\circthick\hfil\ctr
6434 \hskip\rskip}}
6435 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6436 \cbl\leaders\hrule height\circthick\hfil\cbr
6437 \hskip\rskip}}
6439 \newskip\lskip\newskip\rskip
6441 \envdef\cartouche{%
6442 \ifhmode\par\fi % can't be in the midst of a paragraph.
6443 \startsavinginserts
6444 \lskip=\leftskip \rskip=\rightskip
6445 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6446 \cartinner=\hsize \advance\cartinner by-\lskip
6447 \advance\cartinner by-\rskip
6448 \cartouter=\hsize
6449 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6450 % side, and for 6pt waste from
6451 % each corner char, and rule thickness
6452 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6454 % If this cartouche directly follows a sectioning command, we need the
6455 % \parskip glue (backspaced over by default) or the cartouche can
6456 % collide with the section heading.
6457 \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
6459 \vbox\bgroup
6460 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6461 \carttop
6462 \hbox\bgroup
6463 \hskip\lskip
6464 \vrule\kern3pt
6465 \vbox\bgroup
6466 \kern3pt
6467 \hsize=\cartinner
6468 \baselineskip=\normbskip
6469 \lineskip=\normlskip
6470 \parskip=\normpskip
6471 \vskip -\parskip
6472 \comment % For explanation, see the end of def\group.
6474 \def\Ecartouche{%
6475 \ifhmode\par\fi
6476 \kern3pt
6477 \egroup
6478 \kern3pt\vrule
6479 \hskip\rskip
6480 \egroup
6481 \cartbot
6482 \egroup
6483 \checkinserts
6487 % This macro is called at the beginning of all the @example variants,
6488 % inside a group.
6489 \newdimen\nonfillparindent
6490 \def\nonfillstart{%
6491 \aboveenvbreak
6492 \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy
6493 \sepspaces % Make spaces be word-separators rather than space tokens.
6494 \let\par = \lisppar % don't ignore blank lines
6495 \obeylines % each line of input is a line of output
6496 \parskip = 0pt
6497 % Turn off paragraph indentation but redefine \indent to emulate
6498 % the normal \indent.
6499 \nonfillparindent=\parindent
6500 \parindent = 0pt
6501 \let\indent\nonfillindent
6503 \emergencystretch = 0pt % don't try to avoid overfull boxes
6504 \ifx\nonarrowing\relax
6505 \advance \leftskip by \lispnarrowing
6506 \exdentamount=\lispnarrowing
6507 \else
6508 \let\nonarrowing = \relax
6510 \let\exdent=\nofillexdent
6513 \begingroup
6514 \obeyspaces
6515 % We want to swallow spaces (but not other tokens) after the fake
6516 % @indent in our nonfill-environments, where spaces are normally
6517 % active and set to @tie, resulting in them not being ignored after
6518 % @indent.
6519 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6520 \gdef\nonfillindentcheck{%
6521 \ifx\temp %
6522 \expandafter\nonfillindentgobble%
6523 \else%
6524 \leavevmode\nonfillindentbox%
6525 \fi%
6527 \endgroup
6528 \def\nonfillindentgobble#1{\nonfillindent}
6529 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6531 % If you want all examples etc. small: @set dispenvsize small.
6532 % If you want even small examples the full size: @set dispenvsize nosmall.
6533 % This affects the following displayed environments:
6534 % @example, @display, @format, @lisp
6536 \def\smallword{small}
6537 \def\nosmallword{nosmall}
6538 \let\SETdispenvsize\relax
6539 \def\setnormaldispenv{%
6540 \ifx\SETdispenvsize\smallword
6541 % end paragraph for sake of leading, in case document has no blank
6542 % line. This is redundant with what happens in \aboveenvbreak, but
6543 % we need to do it before changing the fonts, and it's inconvenient
6544 % to change the fonts afterward.
6545 \ifnum \lastpenalty=10000 \else \endgraf \fi
6546 \smallexamplefonts \rm
6549 \def\setsmalldispenv{%
6550 \ifx\SETdispenvsize\nosmallword
6551 \else
6552 \ifnum \lastpenalty=10000 \else \endgraf \fi
6553 \smallexamplefonts \rm
6557 % We often define two environments, @foo and @smallfoo.
6558 % Let's do it in one command. #1 is the env name, #2 the definition.
6559 \def\makedispenvdef#1#2{%
6560 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6561 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6562 \expandafter\let\csname E#1\endcsname \afterenvbreak
6563 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6566 % Define two environment synonyms (#1 and #2) for an environment.
6567 \def\maketwodispenvdef#1#2#3{%
6568 \makedispenvdef{#1}{#3}%
6569 \makedispenvdef{#2}{#3}%
6572 % @lisp: indented, narrowed, typewriter font;
6573 % @example: same as @lisp.
6575 % @smallexample and @smalllisp: use smaller fonts.
6576 % Originally contributed by Pavel@xerox.
6578 \maketwodispenvdef{lisp}{example}{%
6579 \nonfillstart
6580 \tt\setupmarkupstyle{example}%
6581 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6582 \gobble % eat return
6584 % @display/@smalldisplay: same as @lisp except keep current font.
6586 \makedispenvdef{display}{%
6587 \nonfillstart
6588 \gobble
6591 % @format/@smallformat: same as @display except don't narrow margins.
6593 \makedispenvdef{format}{%
6594 \let\nonarrowing = t%
6595 \nonfillstart
6596 \gobble
6599 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6600 \envdef\flushleft{%
6601 \let\nonarrowing = t%
6602 \nonfillstart
6603 \gobble
6605 \let\Eflushleft = \afterenvbreak
6607 % @flushright.
6609 \envdef\flushright{%
6610 \let\nonarrowing = t%
6611 \nonfillstart
6612 \advance\leftskip by 0pt plus 1fill\relax
6613 \gobble
6615 \let\Eflushright = \afterenvbreak
6618 % @raggedright does more-or-less normal line breaking but no right
6619 % justification. From plain.tex. Don't stretch around special
6620 % characters in urls in this environment, since the stretch at the right
6621 % should be enough.
6622 \envdef\raggedright{%
6623 \rightskip0pt plus2.4em \spaceskip.3333em \xspaceskip.5em\relax
6624 \def\urefprestretchamount{0pt}%
6625 \def\urefpoststretchamount{0pt}%
6627 \let\Eraggedright\par
6629 \envdef\raggedleft{%
6630 \parindent=0pt \leftskip0pt plus2em
6631 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6632 \hbadness=10000 % Last line will usually be underfull, so turn off
6633 % badness reporting.
6635 \let\Eraggedleft\par
6637 \envdef\raggedcenter{%
6638 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6639 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6640 \hbadness=10000 % Last line will usually be underfull, so turn off
6641 % badness reporting.
6643 \let\Eraggedcenter\par
6646 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6647 % and narrows the margins. We keep \parskip nonzero in general, since
6648 % we're doing normal filling. So, when using \aboveenvbreak and
6649 % \afterenvbreak, temporarily make \parskip 0.
6651 \makedispenvdef{quotation}{\quotationstart}
6653 \def\quotationstart{%
6654 \indentedblockstart % same as \indentedblock, but increase right margin too.
6655 \ifx\nonarrowing\relax
6656 \advance\rightskip by \lispnarrowing
6658 \parsearg\quotationlabel
6661 % We have retained a nonzero parskip for the environment, since we're
6662 % doing normal filling.
6664 \def\Equotation{%
6665 \par
6666 \ifx\quotationauthor\thisisundefined\else
6667 % indent a bit.
6668 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6670 {\parskip=0pt \afterenvbreak}%
6672 \def\Esmallquotation{\Equotation}
6674 % If we're given an argument, typeset it in bold with a colon after.
6675 \def\quotationlabel#1{%
6676 \def\temp{#1}%
6677 \ifx\temp\empty \else
6678 {\bf #1: }%
6682 % @indentedblock is like @quotation, but indents only on the left and
6683 % has no optional argument.
6685 \makedispenvdef{indentedblock}{\indentedblockstart}
6687 \def\indentedblockstart{%
6688 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6689 \parindent=0pt
6691 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6692 \ifx\nonarrowing\relax
6693 \advance\leftskip by \lispnarrowing
6694 \exdentamount = \lispnarrowing
6695 \else
6696 \let\nonarrowing = \relax
6700 % Keep a nonzero parskip for the environment, since we're doing normal filling.
6702 \def\Eindentedblock{%
6703 \par
6704 {\parskip=0pt \afterenvbreak}%
6706 \def\Esmallindentedblock{\Eindentedblock}
6709 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6710 % If we want to allow any <char> as delimiter,
6711 % we need the curly braces so that makeinfo sees the @verb command, eg:
6712 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6714 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6716 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6717 % active too. Otherwise, they get lost as the first character on a
6718 % verbatim line.
6719 \def\dospecials{%
6720 \do\ \do\\\do\{\do\}\do\$\do\&%
6721 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6722 \do\<\do\>\do\|\do\@\do+\do\"%
6723 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6724 % @set txicodequotebacktick will not have effect on @verb and
6725 % @verbatim, and ?` and !` ligatures won't get disabled.
6726 %\do\`\do\'%
6729 % [Knuth] p. 380
6730 \def\uncatcodespecials{%
6731 \def\do##1{\catcode`##1=\other}\dospecials}
6733 % Setup for the @verb command.
6735 % Eight spaces for a tab
6736 \begingroup
6737 \catcode`\^^I=\active
6738 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6739 \endgroup
6741 \def\setupverb{%
6742 \tt % easiest (and conventionally used) font for verbatim
6743 \def\par{\leavevmode\endgraf}%
6744 \setupmarkupstyle{verb}%
6745 \tabeightspaces
6746 % Respect line breaks,
6747 % print special symbols as themselves, and
6748 % make each space count
6749 % must do in this order:
6750 \obeylines \uncatcodespecials \sepspaces
6753 % Setup for the @verbatim environment
6755 % Real tab expansion.
6756 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6758 % We typeset each line of the verbatim in an \hbox, so we can handle
6759 % tabs. The \global is in case the verbatim line starts with an accent,
6760 % or some other command that starts with a begin-group. Otherwise, the
6761 % entire \verbbox would disappear at the corresponding end-group, before
6762 % it is typeset. Meanwhile, we can't have nested verbatim commands
6763 % (can we?), so the \global won't be overwriting itself.
6764 \newbox\verbbox
6765 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
6767 \begingroup
6768 \catcode`\^^I=\active
6769 \gdef\tabexpand{%
6770 \catcode`\^^I=\active
6771 \def^^I{\leavevmode\egroup
6772 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
6773 \divide\dimen\verbbox by\tabw
6774 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
6775 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
6776 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
6779 \endgroup
6781 % start the verbatim environment.
6782 \def\setupverbatim{%
6783 \let\nonarrowing = t%
6784 \nonfillstart
6785 \tt % easiest (and conventionally used) font for verbatim
6786 % The \leavevmode here is for blank lines. Otherwise, we would
6787 % never \starttabox and the \egroup would end verbatim mode.
6788 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6789 \tabexpand
6790 \setupmarkupstyle{verbatim}%
6791 % Respect line breaks,
6792 % print special symbols as themselves, and
6793 % make each space count.
6794 % Must do in this order:
6795 \obeylines \uncatcodespecials \sepspaces
6796 \everypar{\starttabbox}%
6799 % Do the @verb magic: verbatim text is quoted by unique
6800 % delimiter characters. Before first delimiter expect a
6801 % right brace, after last delimiter expect closing brace:
6803 % \def\doverb'{'<char>#1<char>'}'{#1}
6805 % [Knuth] p. 382; only eat outer {}
6806 \begingroup
6807 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6808 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6809 \endgroup
6811 \def\verb{\begingroup\setupverb\doverb}
6814 % Do the @verbatim magic: define the macro \doverbatim so that
6815 % the (first) argument ends when '@end verbatim' is reached, ie:
6817 % \def\doverbatim#1@end verbatim{#1}
6819 % For Texinfo it's a lot easier than for LaTeX,
6820 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6821 % we need not redefine '\', '{' and '}'.
6823 % Inspired by LaTeX's verbatim command set [latex.ltx]
6825 \begingroup
6826 \catcode`\ =\active
6827 \obeylines %
6828 % ignore everything up to the first ^^M, that's the newline at the end
6829 % of the @verbatim input line itself. Otherwise we get an extra blank
6830 % line in the output.
6831 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6832 % We really want {...\end verbatim} in the body of the macro, but
6833 % without the active space; thus we have to use \xdef and \gobble.
6834 \endgroup
6836 \envdef\verbatim{%
6837 \setupverbatim\doverbatim
6839 \let\Everbatim = \afterenvbreak
6842 % @verbatiminclude FILE - insert text of file in verbatim environment.
6844 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6846 \def\doverbatiminclude#1{%
6848 \makevalueexpandable
6849 \setupverbatim
6850 \indexnofonts % Allow `@@' and other weird things in file names.
6851 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
6852 \input #1
6853 \afterenvbreak
6857 % @copying ... @end copying.
6858 % Save the text away for @insertcopying later.
6860 % We save the uninterpreted tokens, rather than creating a box.
6861 % Saving the text in a box would be much easier, but then all the
6862 % typesetting commands (@smallbook, font changes, etc.) have to be done
6863 % beforehand -- and a) we want @copying to be done first in the source
6864 % file; b) letting users define the frontmatter in as flexible order as
6865 % possible is very desirable.
6867 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6868 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6870 \def\insertcopying{%
6871 \begingroup
6872 \parindent = 0pt % paragraph indentation looks wrong on title page
6873 \scanexp\copyingtext
6874 \endgroup
6878 \message{defuns,}
6879 % @defun etc.
6881 \newskip\defbodyindent \defbodyindent=.4in
6882 \newskip\defargsindent \defargsindent=50pt
6883 \newskip\deflastargmargin \deflastargmargin=18pt
6884 \newcount\defunpenalty
6886 % Start the processing of @deffn:
6887 \def\startdefun{%
6888 \ifnum\lastpenalty<10000
6889 \medbreak
6890 \defunpenalty=10003 % Will keep this @deffn together with the
6891 % following @def command, see below.
6892 \else
6893 % If there are two @def commands in a row, we'll have a \nobreak,
6894 % which is there to keep the function description together with its
6895 % header. But if there's nothing but headers, we need to allow a
6896 % break somewhere. Check specifically for penalty 10002, inserted
6897 % by \printdefunline, instead of 10000, since the sectioning
6898 % commands also insert a nobreak penalty, and we don't want to allow
6899 % a break between a section heading and a defun.
6901 % As a further refinement, we avoid "club" headers by signalling
6902 % with penalty of 10003 after the very first @deffn in the
6903 % sequence (see above), and penalty of 10002 after any following
6904 % @def command.
6905 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6907 % Similarly, after a section heading, do not allow a break.
6908 % But do insert the glue.
6909 \medskip % preceded by discardable penalty, so not a breakpoint
6912 \parindent=0in
6913 \advance\leftskip by \defbodyindent
6914 \exdentamount=\defbodyindent
6917 \def\dodefunx#1{%
6918 % First, check whether we are in the right environment:
6919 \checkenv#1%
6921 % As above, allow line break if we have multiple x headers in a row.
6922 % It's not a great place, though.
6923 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6925 % And now, it's time to reuse the body of the original defun:
6926 \expandafter\gobbledefun#1%
6928 \def\gobbledefun#1\startdefun{}
6930 % \printdefunline \deffnheader{text}
6932 \def\printdefunline#1#2{%
6933 \begingroup
6934 % call \deffnheader:
6935 #1#2 \endheader
6936 % common ending:
6937 \interlinepenalty = 10000
6938 \advance\rightskip by 0pt plus 1fil\relax
6939 \endgraf
6940 \nobreak\vskip -\parskip
6941 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6942 % Some of the @defun-type tags do not enable magic parentheses,
6943 % rendering the following check redundant. But we don't optimize.
6944 \checkparencounts
6945 \endgroup
6948 \def\Edefun{\endgraf\medbreak}
6950 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6951 % the only thing remaining is to define \deffnheader.
6953 \def\makedefun#1{%
6954 \expandafter\let\csname E#1\endcsname = \Edefun
6955 \edef\temp{\noexpand\domakedefun
6956 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6957 \temp
6960 % \domakedefun \deffn \deffnx \deffnheader
6962 % Define \deffn and \deffnx, without parameters.
6963 % \deffnheader has to be defined explicitly.
6965 \def\domakedefun#1#2#3{%
6966 \envdef#1{%
6967 \startdefun
6968 \doingtypefnfalse % distinguish typed functions from all else
6969 \parseargusing\activeparens{\printdefunline#3}%
6971 \def#2{\dodefunx#1}%
6972 \def#3%
6975 \newif\ifdoingtypefn % doing typed function?
6976 \newif\ifrettypeownline % typeset return type on its own line?
6978 % @deftypefnnewline on|off says whether the return type of typed functions
6979 % are printed on their own line. This affects @deftypefn, @deftypefun,
6980 % @deftypeop, and @deftypemethod.
6982 \parseargdef\deftypefnnewline{%
6983 \def\temp{#1}%
6984 \ifx\temp\onword
6985 \expandafter\let\csname SETtxideftypefnnl\endcsname
6986 = \empty
6987 \else\ifx\temp\offword
6988 \expandafter\let\csname SETtxideftypefnnl\endcsname
6989 = \relax
6990 \else
6991 \errhelp = \EMsimple
6992 \errmessage{Unknown @txideftypefnnl value `\temp',
6993 must be on|off}%
6994 \fi\fi
6997 % Untyped functions:
6999 % @deffn category name args
7000 \makedefun{deffn}{\deffngeneral{}}
7002 % @deffn category class name args
7003 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
7005 % \defopon {category on}class name args
7006 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7008 % \deffngeneral {subind}category name args
7010 \def\deffngeneral#1#2 #3 #4\endheader{%
7011 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
7012 \dosubind{fn}{\code{#3}}{#1}%
7013 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
7016 % Typed functions:
7018 % @deftypefn category type name args
7019 \makedefun{deftypefn}{\deftypefngeneral{}}
7021 % @deftypeop category class type name args
7022 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
7024 % \deftypeopon {category on}class type name args
7025 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7027 % \deftypefngeneral {subind}category type name args
7029 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
7030 \dosubind{fn}{\code{#4}}{#1}%
7031 \doingtypefntrue
7032 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7035 % Typed variables:
7037 % @deftypevr category type var args
7038 \makedefun{deftypevr}{\deftypecvgeneral{}}
7040 % @deftypecv category class type var args
7041 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
7043 % \deftypecvof {category of}class type var args
7044 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
7046 % \deftypecvgeneral {subind}category type var args
7048 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
7049 \dosubind{vr}{\code{#4}}{#1}%
7050 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7053 % Untyped variables:
7055 % @defvr category var args
7056 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
7058 % @defcv category class var args
7059 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
7061 % \defcvof {category of}class var args
7062 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
7064 % Types:
7066 % @deftp category name args
7067 \makedefun{deftp}#1 #2 #3\endheader{%
7068 \doind{tp}{\code{#2}}%
7069 \defname{#1}{}{#2}\defunargs{#3\unskip}%
7072 % Remaining @defun-like shortcuts:
7073 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
7074 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
7075 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
7076 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
7077 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
7078 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
7079 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
7080 \makedefun{defmethod}{\defopon\putwordMethodon}
7081 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
7082 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
7083 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
7085 % \defname, which formats the name of the @def (not the args).
7086 % #1 is the category, such as "Function".
7087 % #2 is the return type, if any.
7088 % #3 is the function name.
7090 % We are followed by (but not passed) the arguments, if any.
7092 \def\defname#1#2#3{%
7093 \par
7094 % Get the values of \leftskip and \rightskip as they were outside the @def...
7095 \advance\leftskip by -\defbodyindent
7097 % Determine if we are typesetting the return type of a typed function
7098 % on a line by itself.
7099 \rettypeownlinefalse
7100 \ifdoingtypefn % doing a typed function specifically?
7101 % then check user option for putting return type on its own line:
7102 \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
7103 \rettypeownlinetrue
7107 % How we'll format the category name. Putting it in brackets helps
7108 % distinguish it from the body text that may end up on the next line
7109 % just below it.
7110 \def\temp{#1}%
7111 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7113 % Figure out line sizes for the paragraph shape. We'll always have at
7114 % least two.
7115 \tempnum = 2
7117 % The first line needs space for \box0; but if \rightskip is nonzero,
7118 % we need only space for the part of \box0 which exceeds it:
7119 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
7121 % If doing a return type on its own line, we'll have another line.
7122 \ifrettypeownline
7123 \advance\tempnum by 1
7124 \def\maybeshapeline{0in \hsize}%
7125 \else
7126 \def\maybeshapeline{}%
7129 % The continuations:
7130 \dimen2=\hsize \advance\dimen2 by -\defargsindent
7132 % The final paragraph shape:
7133 \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2
7135 % Put the category name at the right margin.
7136 \noindent
7137 \hbox to 0pt{%
7138 \hfil\box0 \kern-\hsize
7139 % \hsize has to be shortened this way:
7140 \kern\leftskip
7141 % Intentionally do not respect \rightskip, since we need the space.
7144 % Allow all lines to be underfull without complaint:
7145 \tolerance=10000 \hbadness=10000
7146 \exdentamount=\defbodyindent
7148 % defun fonts. We use typewriter by default (used to be bold) because:
7149 % . we're printing identifiers, they should be in tt in principle.
7150 % . in languages with many accents, such as Czech or French, it's
7151 % common to leave accents off identifiers. The result looks ok in
7152 % tt, but exceedingly strange in rm.
7153 % . we don't want -- and --- to be treated as ligatures.
7154 % . this still does not fix the ?` and !` ligatures, but so far no
7155 % one has made identifiers using them :).
7156 \df \tt
7157 \def\temp{#2}% text of the return type
7158 \ifx\temp\empty\else
7159 \tclose{\temp}% typeset the return type
7160 \ifrettypeownline
7161 % put return type on its own line; prohibit line break following:
7162 \hfil\vadjust{\nobreak}\break
7163 \else
7164 \space % type on same line, so just followed by a space
7166 \fi % no return type
7167 #3% output function name
7169 {\rm\enskip}% hskip 0.5 em of \tenrm
7171 \boldbrax
7172 % arguments will be output next, if any.
7175 % Print arguments in slanted roman (not ttsl), inconsistently with using
7176 % tt for the name. This is because literal text is sometimes needed in
7177 % the argument list (groff manual), and ttsl and tt are not very
7178 % distinguishable. Prevent hyphenation at `-' chars.
7180 \def\defunargs#1{%
7181 % use sl by default (not ttsl),
7182 % tt for the names.
7183 \df \sl \hyphenchar\font=0
7185 % On the other hand, if an argument has two dashes (for instance), we
7186 % want a way to get ttsl. We used to recommend @var for that, so
7187 % leave the code in, but it's strange for @var to lead to typewriter.
7188 % Nowadays we recommend @code, since the difference between a ttsl hyphen
7189 % and a tt hyphen is pretty tiny. @code also disables ?` !`.
7190 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
7192 \sl\hyphenchar\font=45
7195 % We want ()&[] to print specially on the defun line.
7197 \def\activeparens{%
7198 \catcode`\(=\active \catcode`\)=\active
7199 \catcode`\[=\active \catcode`\]=\active
7200 \catcode`\&=\active
7203 % Make control sequences which act like normal parenthesis chars.
7204 \let\lparen = ( \let\rparen = )
7206 % Be sure that we always have a definition for `(', etc. For example,
7207 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7208 % so TeX would otherwise complain about undefined control sequence.
7210 \activeparens
7211 \global\let(=\lparen \global\let)=\rparen
7212 \global\let[=\lbrack \global\let]=\rbrack
7213 \global\let& = \&
7215 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7216 \gdef\magicamp{\let&=\amprm}
7219 \newcount\parencount
7221 % If we encounter &foo, then turn on ()-hacking afterwards
7222 \newif\ifampseen
7223 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
7225 \def\parenfont{%
7226 \ifampseen
7227 % At the first level, print parens in roman,
7228 % otherwise use the default font.
7229 \ifnum \parencount=1 \rm \fi
7230 \else
7231 % The \sf parens (in \boldbrax) actually are a little bolder than
7232 % the contained text. This is especially needed for [ and ] .
7236 \def\infirstlevel#1{%
7237 \ifampseen
7238 \ifnum\parencount=1
7243 \def\bfafterword#1 {#1 \bf}
7245 \def\opnr{%
7246 \global\advance\parencount by 1
7247 {\parenfont(}%
7248 \infirstlevel \bfafterword
7250 \def\clnr{%
7251 {\parenfont)}%
7252 \infirstlevel \sl
7253 \global\advance\parencount by -1
7256 \newcount\brackcount
7257 \def\lbrb{%
7258 \global\advance\brackcount by 1
7259 {\bf[}%
7261 \def\rbrb{%
7262 {\bf]}%
7263 \global\advance\brackcount by -1
7266 \def\checkparencounts{%
7267 \ifnum\parencount=0 \else \badparencount \fi
7268 \ifnum\brackcount=0 \else \badbrackcount \fi
7270 % these should not use \errmessage; the glibc manual, at least, actually
7271 % has such constructs (when documenting function pointers).
7272 \def\badparencount{%
7273 \message{Warning: unbalanced parentheses in @def...}%
7274 \global\parencount=0
7276 \def\badbrackcount{%
7277 \message{Warning: unbalanced square brackets in @def...}%
7278 \global\brackcount=0
7282 \message{macros,}
7283 % @macro.
7285 % To do this right we need a feature of e-TeX, \scantokens,
7286 % which we arrange to emulate with a temporary file in ordinary TeX.
7287 \ifx\eTeXversion\thisisundefined
7288 \newwrite\macscribble
7289 \def\scantokens#1{%
7290 \toks0={#1}%
7291 \immediate\openout\macscribble=\jobname.tmp
7292 \immediate\write\macscribble{\the\toks0}%
7293 \immediate\closeout\macscribble
7294 \input \jobname.tmp
7298 \def\scanmacro#1{\begingroup
7299 \newlinechar`\^^M
7300 \let\xeatspaces\eatspaces
7302 % Undo catcode changes of \startcontents and \doprintindex
7303 % When called from @insertcopying or (short)caption, we need active
7304 % backslash to get it printed correctly. Previously, we had
7305 % \catcode`\\=\other instead. We'll see whether a problem appears
7306 % with macro expansion. --kasal, 19aug04
7307 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
7309 % ... and for \example:
7310 \spaceisspace
7312 % The \empty here causes a following catcode 5 newline to be eaten as
7313 % part of reading whitespace after a control sequence. It does not
7314 % eat a catcode 13 newline. There's no good way to handle the two
7315 % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
7316 % would then have different behavior). See the Macro Details node in
7317 % the manual for the workaround we recommend for macros and
7318 % line-oriented commands.
7320 \scantokens{#1\empty}%
7321 \endgroup}
7323 \def\scanexp#1{%
7324 \edef\temp{\noexpand\scanmacro{#1}}%
7325 \temp
7328 \newcount\paramno % Count of parameters
7329 \newtoks\macname % Macro name
7330 \newif\ifrecursive % Is it recursive?
7332 % List of all defined macros in the form
7333 % \definedummyword\macro1\definedummyword\macro2...
7334 % Currently is also contains all @aliases; the list can be split
7335 % if there is a need.
7336 \def\macrolist{}
7338 % Add the macro to \macrolist
7339 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7340 \def\addtomacrolistxxx#1{%
7341 \toks0 = \expandafter{\macrolist\definedummyword#1}%
7342 \xdef\macrolist{\the\toks0}%
7345 % Utility routines.
7346 % This does \let #1 = #2, with \csnames; that is,
7347 % \let \csname#1\endcsname = \csname#2\endcsname
7348 % (except of course we have to play expansion games).
7350 \def\cslet#1#2{%
7351 \expandafter\let
7352 \csname#1\expandafter\endcsname
7353 \csname#2\endcsname
7356 % Trim leading and trailing spaces off a string.
7357 % Concepts from aro-bend problem 15 (see CTAN).
7358 {\catcode`\@=11
7359 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
7360 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
7361 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
7362 \def\unbrace#1{#1}
7363 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
7366 % Trim a single trailing ^^M off a string.
7367 {\catcode`\^^M=\other \catcode`\Q=3%
7368 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
7369 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
7370 \gdef\eatcrb#1Q#2Q{#1}%
7373 % Macro bodies are absorbed as an argument in a context where
7374 % all characters are catcode 10, 11 or 12, except \ which is active
7375 % (as in normal texinfo). It is necessary to change the definition of \
7376 % to recognize macro arguments; this is the job of \mbodybackslash.
7378 % Non-ASCII encodings make 8-bit characters active, so un-activate
7379 % them to avoid their expansion. Must do this non-globally, to
7380 % confine the change to the current group.
7382 % It's necessary to have hard CRs when the macro is executed. This is
7383 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7384 % body, and then making it the \newlinechar in \scanmacro.
7386 \def\scanctxt{% used as subroutine
7387 \catcode`\"=\other
7388 \catcode`\+=\other
7389 \catcode`\<=\other
7390 \catcode`\>=\other
7391 \catcode`\@=\other
7392 \catcode`\^=\other
7393 \catcode`\_=\other
7394 \catcode`\|=\other
7395 \catcode`\~=\other
7396 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7399 \def\scanargctxt{% used for copying and captions, not macros.
7400 \scanctxt
7401 \catcode`\\=\other
7402 \catcode`\^^M=\other
7405 \def\macrobodyctxt{% used for @macro definitions
7406 \scanctxt
7407 \catcode`\{=\other
7408 \catcode`\}=\other
7409 \catcode`\^^M=\other
7410 \usembodybackslash
7413 \def\macroargctxt{% used when scanning invocations
7414 \scanctxt
7415 \catcode`\\=0
7417 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
7418 % for the single characters \ { }. Thus, we end up with the "commands"
7419 % that would be written @\ @{ @} in a Texinfo document.
7421 % We already have @{ and @}. For @\, we define it here, and only for
7422 % this purpose, to produce a typewriter backslash (so, the @\ that we
7423 % define for @math can't be used with @macro calls):
7425 \def\\{\normalbackslash}%
7427 % We would like to do this for \, too, since that is what makeinfo does.
7428 % But it is not possible, because Texinfo already has a command @, for a
7429 % cedilla accent. Documents must use @comma{} instead.
7431 % \anythingelse will almost certainly be an error of some kind.
7433 % \mbodybackslash is the definition of \ in @macro bodies.
7434 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7435 % where N is the macro parameter number.
7436 % We define \csname macarg.\endcsname to be \realbackslash, so
7437 % \\ in macro replacement text gets you a backslash.
7439 {\catcode`@=0 @catcode`@\=@active
7440 @gdef@usembodybackslash{@let\=@mbodybackslash}
7441 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
7443 \expandafter\def\csname macarg.\endcsname{\realbackslash}
7445 \def\margbackslash#1{\char`\#1 }
7447 \def\macro{\recursivefalse\parsearg\macroxxx}
7448 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7450 \def\macroxxx#1{%
7451 \getargs{#1}% now \macname is the macname and \argl the arglist
7452 \ifx\argl\empty % no arguments
7453 \paramno=0\relax
7454 \else
7455 \expandafter\parsemargdef \argl;%
7456 \if\paramno>256\relax
7457 \ifx\eTeXversion\thisisundefined
7458 \errhelp = \EMsimple
7459 \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
7463 \if1\csname ismacro.\the\macname\endcsname
7464 \message{Warning: redefining \the\macname}%
7465 \else
7466 \expandafter\ifx\csname \the\macname\endcsname \relax
7467 \else \errmessage{Macro name \the\macname\space already defined}\fi
7468 \global\cslet{macsave.\the\macname}{\the\macname}%
7469 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7470 \addtomacrolist{\the\macname}%
7472 \begingroup \macrobodyctxt
7473 \ifrecursive \expandafter\parsermacbody
7474 \else \expandafter\parsemacbody
7475 \fi}
7477 \parseargdef\unmacro{%
7478 \if1\csname ismacro.#1\endcsname
7479 \global\cslet{#1}{macsave.#1}%
7480 \global\expandafter\let \csname ismacro.#1\endcsname=0%
7481 % Remove the macro name from \macrolist:
7482 \begingroup
7483 \expandafter\let\csname#1\endcsname \relax
7484 \let\definedummyword\unmacrodo
7485 \xdef\macrolist{\macrolist}%
7486 \endgroup
7487 \else
7488 \errmessage{Macro #1 not defined}%
7492 % Called by \do from \dounmacro on each macro. The idea is to omit any
7493 % macro definitions that have been changed to \relax.
7495 \def\unmacrodo#1{%
7496 \ifx #1\relax
7497 % remove this
7498 \else
7499 \noexpand\definedummyword \noexpand#1%
7503 % This makes use of the obscure feature that if the last token of a
7504 % <parameter list> is #, then the preceding argument is delimited by
7505 % an opening brace, and that opening brace is not consumed.
7506 \def\getargs#1{\getargsxxx#1{}}
7507 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7508 \def\getmacname#1 #2\relax{\macname={#1}}
7509 \def\getmacargs#1{\def\argl{#1}}
7511 % For macro processing make @ a letter so that we can make Texinfo private macro names.
7512 \edef\texiatcatcode{\the\catcode`\@}
7513 \catcode `@=11\relax
7515 % Parse the optional {params} list. Set up \paramno and \paramlist
7516 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
7517 % in the params list to some hook where the argument is to be expanded. If
7518 % there are less than 10 arguments that hook is to be replaced by ##N where N
7519 % is the position in that list, that is to say the macro arguments are to be
7520 % defined `a la TeX in the macro body.
7522 % That gets used by \mbodybackslash (above).
7524 % We need to get `macro parameter char #' into several definitions.
7525 % The technique used is stolen from LaTeX: let \hash be something
7526 % unexpandable, insert that wherever you need a #, and then redefine
7527 % it to # just before using the token list produced.
7529 % The same technique is used to protect \eatspaces till just before
7530 % the macro is used.
7532 % If there are 10 or more arguments, a different technique is used, where the
7533 % hook remains in the body, and when macro is to be expanded the body is
7534 % processed again to replace the arguments.
7536 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7537 % argument N value and then \edef the body (nothing else will expand because of
7538 % the catcode regime underwhich the body was input).
7540 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7541 % arguments, no macro can have more than 256 arguments (else error).
7542 \def\parsemargdef#1;{%
7543 \paramno=0\def\paramlist{}%
7544 \let\hash\relax
7545 \let\xeatspaces\relax
7546 \parsemargdefxxx#1,;,%
7547 % In case that there are 10 or more arguments we parse again the arguments
7548 % list to set new definitions for the \macarg.BLAH macros corresponding to
7549 % each BLAH argument. It was anyhow needed to parse already once this list
7550 % in order to count the arguments, and as macros with at most 9 arguments
7551 % are by far more frequent than macro with 10 or more arguments, defining
7552 % twice the \macarg.BLAH macros does not cost too much processing power.
7553 \ifnum\paramno<10\relax\else
7554 \paramno0\relax
7555 \parsemmanyargdef@@#1,;,% 10 or more arguments
7558 \def\parsemargdefxxx#1,{%
7559 \if#1;\let\next=\relax
7560 \else \let\next=\parsemargdefxxx
7561 \advance\paramno by 1
7562 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7563 {\xeatspaces{\hash\the\paramno}}%
7564 \edef\paramlist{\paramlist\hash\the\paramno,}%
7565 \fi\next}
7567 \def\parsemmanyargdef@@#1,{%
7568 \if#1;\let\next=\relax
7569 \else
7570 \let\next=\parsemmanyargdef@@
7571 \edef\tempb{\eatspaces{#1}}%
7572 \expandafter\def\expandafter\tempa
7573 \expandafter{\csname macarg.\tempb\endcsname}%
7574 % Note that we need some extra \noexpand\noexpand, this is because we
7575 % don't want \the to be expanded in the \parsermacbody as it uses an
7576 % \xdef .
7577 \expandafter\edef\tempa
7578 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7579 \advance\paramno by 1\relax
7580 \fi\next}
7582 % These two commands read recursive and nonrecursive macro bodies.
7583 % (They're different since rec and nonrec macros end differently.)
7586 \catcode `\@\texiatcatcode
7587 \long\def\parsemacbody#1@end macro%
7588 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7589 \long\def\parsermacbody#1@end rmacro%
7590 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7591 \catcode `\@=11\relax
7593 \let\endargs@\relax
7594 \let\nil@\relax
7595 \def\nilm@{\nil@}%
7596 \long\def\nillm@{\nil@}%
7598 % This macro is expanded during the Texinfo macro expansion, not during its
7599 % definition. It gets all the arguments values and assigns them to macros
7600 % macarg.ARGNAME
7602 % #1 is the macro name
7603 % #2 is the list of argument names
7604 % #3 is the list of argument values
7605 \def\getargvals@#1#2#3{%
7606 \def\macargdeflist@{}%
7607 \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
7608 \def\paramlist{#2,\nil@}%
7609 \def\macroname{#1}%
7610 \begingroup
7611 \macroargctxt
7612 \def\argvaluelist{#3,\nil@}%
7613 \def\@tempa{#3}%
7614 \ifx\@tempa\empty
7615 \setemptyargvalues@
7616 \else
7617 \getargvals@@
7622 \def\getargvals@@{%
7623 \ifx\paramlist\nilm@
7624 % Some sanity check needed here that \argvaluelist is also empty.
7625 \ifx\argvaluelist\nillm@
7626 \else
7627 \errhelp = \EMsimple
7628 \errmessage{Too many arguments in macro `\macroname'!}%
7630 \let\next\macargexpandinbody@
7631 \else
7632 \ifx\argvaluelist\nillm@
7633 % No more arguments values passed to macro. Set remaining named-arg
7634 % macros to empty.
7635 \let\next\setemptyargvalues@
7636 \else
7637 % pop current arg name into \@tempb
7638 \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
7639 \expandafter\@tempa\expandafter{\paramlist}%
7640 % pop current argument value into \@tempc
7641 \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
7642 \expandafter\@tempa\expandafter{\argvaluelist}%
7643 % Here \@tempb is the current arg name and \@tempc is the current arg value.
7644 % First place the new argument macro definition into \@tempd
7645 \expandafter\macname\expandafter{\@tempc}%
7646 \expandafter\let\csname macarg.\@tempb\endcsname\relax
7647 \expandafter\def\expandafter\@tempe\expandafter{%
7648 \csname macarg.\@tempb\endcsname}%
7649 \edef\@tempd{\long\def\@tempe{\the\macname}}%
7650 \push@\@tempd\macargdeflist@
7651 \let\next\getargvals@@
7654 \next
7657 \def\push@#1#2{%
7658 \expandafter\expandafter\expandafter\def
7659 \expandafter\expandafter\expandafter#2%
7660 \expandafter\expandafter\expandafter{%
7661 \expandafter#1#2}%
7664 % Replace arguments by their values in the macro body, and place the result
7665 % in macro \@tempa
7666 \def\macvalstoargs@{%
7667 % To do this we use the property that token registers that are \the'ed
7668 % within an \edef expand only once. So we are going to place all argument
7669 % values into respective token registers.
7671 % First we save the token context, and initialize argument numbering.
7672 \begingroup
7673 \paramno0\relax
7674 % Then, for each argument number #N, we place the corresponding argument
7675 % value into a new token list register \toks#N
7676 \expandafter\putargsintokens@\saveparamlist@,;,%
7677 % Then, we expand the body so that argument are replaced by their
7678 % values. The trick for values not to be expanded themselves is that they
7679 % are within tokens and that tokens expand only once in an \edef .
7680 \edef\@tempc{\csname mac.\macroname .body\endcsname}%
7681 % Now we restore the token stack pointer to free the token list registers
7682 % which we have used, but we make sure that expanded body is saved after
7683 % group.
7684 \expandafter
7685 \endgroup
7686 \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
7689 \def\macargexpandinbody@{%
7690 %% Define the named-macro outside of this group and then close this group.
7691 \expandafter
7692 \endgroup
7693 \macargdeflist@
7694 % First the replace in body the macro arguments by their values, the result
7695 % is in \@tempa .
7696 \macvalstoargs@
7697 % Then we point at the \norecurse or \gobble (for recursive) macro value
7698 % with \@tempb .
7699 \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
7700 % Depending on whether it is recursive or not, we need some tailing
7701 % \egroup .
7702 \ifx\@tempb\gobble
7703 \let\@tempc\relax
7704 \else
7705 \let\@tempc\egroup
7707 % And now we do the real job:
7708 \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
7709 \@tempd
7712 \def\putargsintokens@#1,{%
7713 \if#1;\let\next\relax
7714 \else
7715 \let\next\putargsintokens@
7716 % First we allocate the new token list register, and give it a temporary
7717 % alias \@tempb .
7718 \toksdef\@tempb\the\paramno
7719 % Then we place the argument value into that token list register.
7720 \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
7721 \expandafter\@tempb\expandafter{\@tempa}%
7722 \advance\paramno by 1\relax
7724 \next
7727 % Save the token stack pointer into macro #1
7728 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}}
7729 % Restore the token stack pointer from number in macro #1
7730 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax}
7731 % newtoks that can be used non \outer .
7732 \def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi}
7734 % Tailing missing arguments are set to empty
7735 \def\setemptyargvalues@{%
7736 \ifx\paramlist\nilm@
7737 \let\next\macargexpandinbody@
7738 \else
7739 \expandafter\setemptyargvaluesparser@\paramlist\endargs@
7740 \let\next\setemptyargvalues@
7742 \next
7745 \def\setemptyargvaluesparser@#1,#2\endargs@{%
7746 \expandafter\def\expandafter\@tempa\expandafter{%
7747 \expandafter\def\csname macarg.#1\endcsname{}}%
7748 \push@\@tempa\macargdeflist@
7749 \def\paramlist{#2}%
7752 % #1 is the element target macro
7753 % #2 is the list macro
7754 % #3,#4\endargs@ is the list value
7755 \def\pop@#1#2#3,#4\endargs@{%
7756 \def#1{#3}%
7757 \def#2{#4}%
7759 \long\def\longpop@#1#2#3,#4\endargs@{%
7760 \long\def#1{#3}%
7761 \long\def#2{#4}%
7764 % This defines a Texinfo @macro. There are eight cases: recursive and
7765 % nonrecursive macros of zero, one, up to nine, and many arguments.
7766 % Much magic with \expandafter here.
7767 % \xdef is used so that macro definitions will survive the file
7768 % they're defined in; @include reads the file inside a group.
7770 \def\defmacro{%
7771 \let\hash=##% convert placeholders to macro parameter chars
7772 \ifrecursive
7773 \ifcase\paramno
7775 \expandafter\xdef\csname\the\macname\endcsname{%
7776 \noexpand\scanmacro{\temp}}%
7777 \or % 1
7778 \expandafter\xdef\csname\the\macname\endcsname{%
7779 \bgroup\noexpand\macroargctxt
7780 \noexpand\braceorline
7781 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7782 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7783 \egroup\noexpand\scanmacro{\temp}}%
7784 \else
7785 \ifnum\paramno<10\relax % at most 9
7786 \expandafter\xdef\csname\the\macname\endcsname{%
7787 \bgroup\noexpand\macroargctxt
7788 \noexpand\csname\the\macname xx\endcsname}%
7789 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7790 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7791 \expandafter\expandafter
7792 \expandafter\xdef
7793 \expandafter\expandafter
7794 \csname\the\macname xxx\endcsname
7795 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7796 \else % 10 or more
7797 \expandafter\xdef\csname\the\macname\endcsname{%
7798 \noexpand\getargvals@{\the\macname}{\argl}%
7800 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7801 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
7804 \else
7805 \ifcase\paramno
7807 \expandafter\xdef\csname\the\macname\endcsname{%
7808 \noexpand\norecurse{\the\macname}%
7809 \noexpand\scanmacro{\temp}\egroup}%
7810 \or % 1
7811 \expandafter\xdef\csname\the\macname\endcsname{%
7812 \bgroup\noexpand\macroargctxt
7813 \noexpand\braceorline
7814 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7815 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7816 \egroup
7817 \noexpand\norecurse{\the\macname}%
7818 \noexpand\scanmacro{\temp}\egroup}%
7819 \else % at most 9
7820 \ifnum\paramno<10\relax
7821 \expandafter\xdef\csname\the\macname\endcsname{%
7822 \bgroup\noexpand\macroargctxt
7823 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7824 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7825 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7826 \expandafter\expandafter
7827 \expandafter\xdef
7828 \expandafter\expandafter
7829 \csname\the\macname xxx\endcsname
7830 \paramlist{%
7831 \egroup
7832 \noexpand\norecurse{\the\macname}%
7833 \noexpand\scanmacro{\temp}\egroup}%
7834 \else % 10 or more:
7835 \expandafter\xdef\csname\the\macname\endcsname{%
7836 \noexpand\getargvals@{\the\macname}{\argl}%
7838 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7839 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
7842 \fi}
7844 \catcode `\@\texiatcatcode\relax
7846 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7848 % \braceorline decides whether the next nonwhitespace character is a
7849 % {. If so it reads up to the closing }, if not, it reads the whole
7850 % line. Whatever was read is then fed to the next control sequence
7851 % as an argument (by \parsebrace or \parsearg).
7853 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7854 \def\braceorlinexxx{%
7855 \ifx\nchar\bgroup\else
7856 \expandafter\parsearg
7857 \fi \macnamexxx}
7860 % @alias.
7861 % We need some trickery to remove the optional spaces around the equal
7862 % sign. Make them active and then expand them all to nothing.
7864 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7865 \def\aliasxxx #1{\aliasyyy#1\relax}
7866 \def\aliasyyy #1=#2\relax{%
7868 \expandafter\let\obeyedspace=\empty
7869 \addtomacrolist{#1}%
7870 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7872 \next
7876 \message{cross references,}
7878 \newwrite\auxfile
7879 \newif\ifhavexrefs % True if xref values are known.
7880 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7882 % @inforef is relatively simple.
7883 \def\inforef #1{\inforefzzz #1,,,,**}
7884 \def\inforefzzz #1,#2,#3,#4**{%
7885 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7886 node \samp{\ignorespaces#1{}}}
7888 % @node's only job in TeX is to define \lastnode, which is used in
7889 % cross-references. The @node line might or might not have commas, and
7890 % might or might not have spaces before the first comma, like:
7891 % @node foo , bar , ...
7892 % We don't want such trailing spaces in the node name.
7894 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7896 % also remove a trailing comma, in case of something like this:
7897 % @node Help-Cross, , , Cross-refs
7898 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7899 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7901 \let\nwnode=\node
7902 \let\lastnode=\empty
7904 % Write a cross-reference definition for the current node. #1 is the
7905 % type (Ynumbered, Yappendix, Ynothing).
7907 \def\donoderef#1{%
7908 \ifx\lastnode\empty\else
7909 \setref{\lastnode}{#1}%
7910 \global\let\lastnode=\empty
7914 % @anchor{NAME} -- define xref target at arbitrary point.
7916 \newcount\savesfregister
7918 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7919 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7920 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7922 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7923 % anchor), which consists of three parts:
7924 % 1) NAME-title - the current sectioning name taken from \lastsection,
7925 % or the anchor name.
7926 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7927 % empty for anchors.
7928 % 3) NAME-pg - the page number.
7930 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7931 % floats, there is an additional part, which is not written here:
7932 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7934 \def\setref#1#2{%
7935 \pdfmkdest{#1}%
7936 \iflinks
7938 \atdummies % preserve commands, but don't expand them
7939 \edef\writexrdef##1##2{%
7940 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7941 ##1}{##2}}% these are parameters of \writexrdef
7943 \toks0 = \expandafter{\lastsection}%
7944 \immediate \writexrdef{title}{\the\toks0 }%
7945 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7946 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
7951 % @xrefautosectiontitle on|off says whether @section(ing) names are used
7952 % automatically in xrefs, if the third arg is not explicitly specified.
7953 % This was provided as a "secret" @set xref-automatic-section-title
7954 % variable, now it's official.
7956 \parseargdef\xrefautomaticsectiontitle{%
7957 \def\temp{#1}%
7958 \ifx\temp\onword
7959 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7960 = \empty
7961 \else\ifx\temp\offword
7962 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7963 = \relax
7964 \else
7965 \errhelp = \EMsimple
7966 \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
7967 must be on|off}%
7968 \fi\fi
7971 % \f
7972 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7973 % the node name, #2 the name of the Info cross-reference, #3 the printed
7974 % node name, #4 the name of the Info file, #5 the name of the printed
7975 % manual. All but the node name can be omitted.
7977 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7978 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7979 \def\ref#1{\xrefX[#1,,,,,,,]}
7981 \newbox\toprefbox
7982 \newbox\printedrefnamebox
7983 \newbox\infofilenamebox
7984 \newbox\printedmanualbox
7986 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7987 \unsepspaces
7989 % Get args without leading/trailing spaces.
7990 \def\printedrefname{\ignorespaces #3}%
7991 \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
7993 \def\infofilename{\ignorespaces #4}%
7994 \setbox\infofilenamebox = \hbox{\infofilename\unskip}%
7996 \def\printedmanual{\ignorespaces #5}%
7997 \setbox\printedmanualbox = \hbox{\printedmanual\unskip}%
7999 % If the printed reference name (arg #3) was not explicitly given in
8000 % the @xref, figure out what we want to use.
8001 \ifdim \wd\printedrefnamebox = 0pt
8002 % No printed node name was explicitly given.
8003 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
8004 % Not auto section-title: use node name inside the square brackets.
8005 \def\printedrefname{\ignorespaces #1}%
8006 \else
8007 % Auto section-title: use chapter/section title inside
8008 % the square brackets if we have it.
8009 \ifdim \wd\printedmanualbox > 0pt
8010 % It is in another manual, so we don't have it; use node name.
8011 \def\printedrefname{\ignorespaces #1}%
8012 \else
8013 \ifhavexrefs
8014 % We (should) know the real title if we have the xref values.
8015 \def\printedrefname{\refx{#1-title}{}}%
8016 \else
8017 % Otherwise just copy the Info node name.
8018 \def\printedrefname{\ignorespaces #1}%
8019 \fi%
8024 % Make link in pdf output.
8025 \ifpdf
8026 {\indexnofonts
8027 \turnoffactive
8028 \makevalueexpandable
8029 % This expands tokens, so do it after making catcode changes, so _
8030 % etc. don't get their TeX definitions. This ignores all spaces in
8031 % #4, including (wrongly) those in the middle of the filename.
8032 \getfilename{#4}%
8034 % This (wrongly) does not take account of leading or trailing
8035 % spaces in #1, which should be ignored.
8036 \edef\pdfxrefdest{#1}%
8037 \ifx\pdfxrefdest\empty
8038 \def\pdfxrefdest{Top}% no empty targets
8039 \else
8040 \txiescapepdf\pdfxrefdest % escape PDF special chars
8043 \leavevmode
8044 \startlink attr{/Border [0 0 0]}%
8045 \ifnum\filenamelength>0
8046 goto file{\the\filename.pdf} name{\pdfxrefdest}%
8047 \else
8048 goto name{\pdfmkpgn{\pdfxrefdest}}%
8051 \setcolor{\linkcolor}%
8054 % Float references are printed completely differently: "Figure 1.2"
8055 % instead of "[somenode], p.3". We distinguish them by the
8056 % LABEL-title being set to a magic string.
8058 % Have to otherify everything special to allow the \csname to
8059 % include an _ in the xref name, etc.
8060 \indexnofonts
8061 \turnoffactive
8062 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
8063 \csname XR#1-title\endcsname
8065 \iffloat\Xthisreftitle
8066 % If the user specified the print name (third arg) to the ref,
8067 % print it instead of our usual "Figure 1.2".
8068 \ifdim\wd\printedrefnamebox = 0pt
8069 \refx{#1-snt}{}%
8070 \else
8071 \printedrefname
8074 % If the user also gave the printed manual name (fifth arg), append
8075 % "in MANUALNAME".
8076 \ifdim \wd\printedmanualbox > 0pt
8077 \space \putwordin{} \cite{\printedmanual}%
8079 \else
8080 % node/anchor (non-float) references.
8082 % If we use \unhbox to print the node names, TeX does not insert
8083 % empty discretionaries after hyphens, which means that it will not
8084 % find a line break at a hyphen in a node names. Since some manuals
8085 % are best written with fairly long node names, containing hyphens,
8086 % this is a loss. Therefore, we give the text of the node name
8087 % again, so it is as if TeX is seeing it for the first time.
8089 \ifdim \wd\printedmanualbox > 0pt
8090 % Cross-manual reference with a printed manual name.
8092 \crossmanualxref{\cite{\printedmanual\unskip}}%
8094 \else\ifdim \wd\infofilenamebox > 0pt
8095 % Cross-manual reference with only an info filename (arg 4), no
8096 % printed manual name (arg 5). This is essentially the same as
8097 % the case above; we output the filename, since we have nothing else.
8099 \crossmanualxref{\code{\infofilename\unskip}}%
8101 \else
8102 % Reference within this manual.
8104 % _ (for example) has to be the character _ for the purposes of the
8105 % control sequence corresponding to the node, but it has to expand
8106 % into the usual \leavevmode...\vrule stuff for purposes of
8107 % printing. So we \turnoffactive for the \refx-snt, back on for the
8108 % printing, back off for the \refx-pg.
8109 {\turnoffactive
8110 % Only output a following space if the -snt ref is nonempty; for
8111 % @unnumbered and @anchor, it won't be.
8112 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
8113 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
8115 % output the `[mynode]' via the macro below so it can be overridden.
8116 \xrefprintnodename\printedrefname
8118 % But we always want a comma and a space:
8119 ,\space
8121 % output the `page 3'.
8122 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
8123 \fi\fi
8125 \endlink
8126 \endgroup}
8128 % Output a cross-manual xref to #1. Used just above (twice).
8130 % Only include the text "Section ``foo'' in" if the foo is neither
8131 % missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply
8132 % "see The Foo Manual", the idea being to refer to the whole manual.
8134 % But, this being TeX, we can't easily compare our node name against the
8135 % string "Top" while ignoring the possible spaces before and after in
8136 % the input. By adding the arbitrary 7sp below, we make it much less
8137 % likely that a real node name would have the same width as "Top" (e.g.,
8138 % in a monospaced font). Hopefully it will never happen in practice.
8140 % For the same basic reason, we retypeset the "Top" at every
8141 % reference, since the current font is indeterminate.
8143 \def\crossmanualxref#1{%
8144 \setbox\toprefbox = \hbox{Top\kern7sp}%
8145 \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8146 \ifdim \wd2 > 7sp % nonempty?
8147 \ifdim \wd2 = \wd\toprefbox \else % same as Top?
8148 \putwordSection{} ``\printedrefname'' \putwordin{}\space
8154 % This macro is called from \xrefX for the `[nodename]' part of xref
8155 % output. It's a separate macro only so it can be changed more easily,
8156 % since square brackets don't work well in some documents. Particularly
8157 % one that Bob is working on :).
8159 \def\xrefprintnodename#1{[#1]}
8161 % Things referred to by \setref.
8163 \def\Ynothing{}
8164 \def\Yomitfromtoc{}
8165 \def\Ynumbered{%
8166 \ifnum\secno=0
8167 \putwordChapter@tie \the\chapno
8168 \else \ifnum\subsecno=0
8169 \putwordSection@tie \the\chapno.\the\secno
8170 \else \ifnum\subsubsecno=0
8171 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
8172 \else
8173 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
8174 \fi\fi\fi
8176 \def\Yappendix{%
8177 \ifnum\secno=0
8178 \putwordAppendix@tie @char\the\appendixno{}%
8179 \else \ifnum\subsecno=0
8180 \putwordSection@tie @char\the\appendixno.\the\secno
8181 \else \ifnum\subsubsecno=0
8182 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
8183 \else
8184 \putwordSection@tie
8185 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
8186 \fi\fi\fi
8189 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
8190 % If its value is nonempty, SUFFIX is output afterward.
8192 \def\refx#1#2{%
8194 \indexnofonts
8195 \otherbackslash
8196 \expandafter\global\expandafter\let\expandafter\thisrefX
8197 \csname XR#1\endcsname
8199 \ifx\thisrefX\relax
8200 % If not defined, say something at least.
8201 \angleleft un\-de\-fined\angleright
8202 \iflinks
8203 \ifhavexrefs
8204 {\toks0 = {#1}% avoid expansion of possibly-complex value
8205 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
8206 \else
8207 \ifwarnedxrefs\else
8208 \global\warnedxrefstrue
8209 \message{Cross reference values unknown; you must run TeX again.}%
8213 \else
8214 % It's defined, so just use it.
8215 \thisrefX
8217 #2% Output the suffix in any case.
8220 % This is the macro invoked by entries in the aux file. Usually it's
8221 % just a \def (we prepend XR to the control sequence name to avoid
8222 % collisions). But if this is a float type, we have more work to do.
8224 \def\xrdef#1#2{%
8225 {% The node name might contain 8-bit characters, which in our current
8226 % implementation are changed to commands like @'e. Don't let these
8227 % mess up the control sequence name.
8228 \indexnofonts
8229 \turnoffactive
8230 \xdef\safexrefname{#1}%
8233 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
8235 % Was that xref control sequence that we just defined for a float?
8236 \expandafter\iffloat\csname XR\safexrefname\endcsname
8237 % it was a float, and we have the (safe) float type in \iffloattype.
8238 \expandafter\let\expandafter\floatlist
8239 \csname floatlist\iffloattype\endcsname
8241 % Is this the first time we've seen this float type?
8242 \expandafter\ifx\floatlist\relax
8243 \toks0 = {\do}% yes, so just \do
8244 \else
8245 % had it before, so preserve previous elements in list.
8246 \toks0 = \expandafter{\floatlist\do}%
8249 % Remember this xref in the control sequence \floatlistFLOATTYPE,
8250 % for later use in \listoffloats.
8251 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
8252 {\safexrefname}}%
8256 % Read the last existing aux file, if any. No error if none exists.
8258 \def\tryauxfile{%
8259 \openin 1 \jobname.aux
8260 \ifeof 1 \else
8261 \readdatafile{aux}%
8262 \global\havexrefstrue
8264 \closein 1
8267 \def\setupdatafile{%
8268 \catcode`\^^@=\other
8269 \catcode`\^^A=\other
8270 \catcode`\^^B=\other
8271 \catcode`\^^C=\other
8272 \catcode`\^^D=\other
8273 \catcode`\^^E=\other
8274 \catcode`\^^F=\other
8275 \catcode`\^^G=\other
8276 \catcode`\^^H=\other
8277 \catcode`\^^K=\other
8278 \catcode`\^^L=\other
8279 \catcode`\^^N=\other
8280 \catcode`\^^P=\other
8281 \catcode`\^^Q=\other
8282 \catcode`\^^R=\other
8283 \catcode`\^^S=\other
8284 \catcode`\^^T=\other
8285 \catcode`\^^U=\other
8286 \catcode`\^^V=\other
8287 \catcode`\^^W=\other
8288 \catcode`\^^X=\other
8289 \catcode`\^^Z=\other
8290 \catcode`\^^[=\other
8291 \catcode`\^^\=\other
8292 \catcode`\^^]=\other
8293 \catcode`\^^^=\other
8294 \catcode`\^^_=\other
8295 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8296 % in xref tags, i.e., node names. But since ^^e4 notation isn't
8297 % supported in the main text, it doesn't seem desirable. Furthermore,
8298 % that is not enough: for node names that actually contain a ^
8299 % character, we would end up writing a line like this: 'xrdef {'hat
8300 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8301 % argument, and \hat is not an expandable control sequence. It could
8302 % all be worked out, but why? Either we support ^^ or we don't.
8304 % The other change necessary for this was to define \auxhat:
8305 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8306 % and then to call \auxhat in \setq.
8308 \catcode`\^=\other
8310 % Special characters. Should be turned off anyway, but...
8311 \catcode`\~=\other
8312 \catcode`\[=\other
8313 \catcode`\]=\other
8314 \catcode`\"=\other
8315 \catcode`\_=\other
8316 \catcode`\|=\other
8317 \catcode`\<=\other
8318 \catcode`\>=\other
8319 \catcode`\$=\other
8320 \catcode`\#=\other
8321 \catcode`\&=\other
8322 \catcode`\%=\other
8323 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
8325 % This is to support \ in node names and titles, since the \
8326 % characters end up in a \csname. It's easier than
8327 % leaving it active and making its active definition an actual \
8328 % character. What I don't understand is why it works in the *value*
8329 % of the xrdef. Seems like it should be a catcode12 \, and that
8330 % should not typeset properly. But it works, so I'm moving on for
8331 % now. --karl, 15jan04.
8332 \catcode`\\=\other
8334 % Make the characters 128-255 be printing characters.
8336 \count1=128
8337 \def\loop{%
8338 \catcode\count1=\other
8339 \advance\count1 by 1
8340 \ifnum \count1<256 \loop \fi
8344 % @ is our escape character in .aux files, and we need braces.
8345 \catcode`\{=1
8346 \catcode`\}=2
8347 \catcode`\@=0
8350 \def\readdatafile#1{%
8351 \begingroup
8352 \setupdatafile
8353 \input\jobname.#1
8354 \endgroup}
8357 \message{insertions,}
8358 % including footnotes.
8360 \newcount \footnoteno
8362 % The trailing space in the following definition for supereject is
8363 % vital for proper filling; pages come out unaligned when you do a
8364 % pagealignmacro call if that space before the closing brace is
8365 % removed. (Generally, numeric constants should always be followed by a
8366 % space to prevent strange expansion errors.)
8367 \def\supereject{\par\penalty -20000\footnoteno =0 }
8369 % @footnotestyle is meaningful for Info output only.
8370 \let\footnotestyle=\comment
8372 {\catcode `\@=11
8374 % Auto-number footnotes. Otherwise like plain.
8375 \gdef\footnote{%
8376 \global\advance\footnoteno by \@ne
8377 \edef\thisfootno{$^{\the\footnoteno}$}%
8379 % In case the footnote comes at the end of a sentence, preserve the
8380 % extra spacing after we do the footnote number.
8381 \let\@sf\empty
8382 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
8384 % Remove inadvertent blank space before typesetting the footnote number.
8385 \unskip
8386 \thisfootno\@sf
8387 \dofootnote
8390 % Don't bother with the trickery in plain.tex to not require the
8391 % footnote text as a parameter. Our footnotes don't need to be so general.
8393 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8394 % \parseargline) fails inside footnotes because the tokens are fixed when
8395 % the footnote is read. --karl, 16nov96.
8397 \gdef\dofootnote{%
8398 \insert\footins\bgroup
8400 % Nested footnotes are not supported in TeX, that would take a lot
8401 % more work. (\startsavinginserts does not suffice.)
8402 \let\footnote=\errfootnotenest
8404 % We want to typeset this text as a normal paragraph, even if the
8405 % footnote reference occurs in (for example) a display environment.
8406 % So reset some parameters.
8407 \hsize=\pagewidth
8408 \interlinepenalty\interfootnotelinepenalty
8409 \splittopskip\ht\strutbox % top baseline for broken footnotes
8410 \splitmaxdepth\dp\strutbox
8411 \floatingpenalty\@MM
8412 \leftskip\z@skip
8413 \rightskip\z@skip
8414 \spaceskip\z@skip
8415 \xspaceskip\z@skip
8416 \parindent\defaultparindent
8418 \smallfonts \rm
8420 % Because we use hanging indentation in footnotes, a @noindent appears
8421 % to exdent this text, so make it be a no-op. makeinfo does not use
8422 % hanging indentation so @noindent can still be needed within footnote
8423 % text after an @example or the like (not that this is good style).
8424 \let\noindent = \relax
8426 % Hang the footnote text off the number. Use \everypar in case the
8427 % footnote extends for more than one paragraph.
8428 \everypar = {\hang}%
8429 \textindent{\thisfootno}%
8431 % Don't crash into the line above the footnote text. Since this
8432 % expands into a box, it must come within the paragraph, lest it
8433 % provide a place where TeX can split the footnote.
8434 \footstrut
8436 % Invoke rest of plain TeX footnote routine.
8437 \futurelet\next\fo@t
8439 }%end \catcode `\@=11
8441 \def\errfootnotenest{%
8442 \errhelp=\EMsimple
8443 \errmessage{Nested footnotes not supported in texinfo.tex,
8444 even though they work in makeinfo; sorry}
8447 \def\errfootnoteheading{%
8448 \errhelp=\EMsimple
8449 \errmessage{Footnotes in chapters, sections, etc., are not supported}
8452 % In case a @footnote appears in a vbox, save the footnote text and create
8453 % the real \insert just after the vbox finished. Otherwise, the insertion
8454 % would be lost.
8455 % Similarly, if a @footnote appears inside an alignment, save the footnote
8456 % text to a box and make the \insert when a row of the table is finished.
8457 % And the same can be done for other insert classes. --kasal, 16nov03.
8459 % Replace the \insert primitive by a cheating macro.
8460 % Deeper inside, just make sure that the saved insertions are not spilled
8461 % out prematurely.
8463 \def\startsavinginserts{%
8464 \ifx \insert\ptexinsert
8465 \let\insert\saveinsert
8466 \else
8467 \let\checkinserts\relax
8471 % This \insert replacement works for both \insert\footins{foo} and
8472 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8474 \def\saveinsert#1{%
8475 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8476 \afterassignment\next
8477 % swallow the left brace
8478 \let\temp =
8480 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
8481 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
8483 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8485 \def\placesaveins#1{%
8486 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8487 {\box#1}%
8490 % eat @SAVE -- beware, all of them have catcode \other:
8492 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
8493 \gdef\gobblesave @SAVE{}
8496 % initialization:
8497 \def\newsaveins #1{%
8498 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8499 \next
8501 \def\newsaveinsX #1{%
8502 \csname newbox\endcsname #1%
8503 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8504 \checksaveins #1}%
8507 % initialize:
8508 \let\checkinserts\empty
8509 \newsaveins\footins
8510 \newsaveins\margin
8513 % @image. We use the macros from epsf.tex to support this.
8514 % If epsf.tex is not installed and @image is used, we complain.
8516 % Check for and read epsf.tex up front. If we read it only at @image
8517 % time, we might be inside a group, and then its definitions would get
8518 % undone and the next image would fail.
8519 \openin 1 = epsf.tex
8520 \ifeof 1 \else
8521 % Do not bother showing banner with epsf.tex v2.7k (available in
8522 % doc/epsf.tex and on ctan).
8523 \def\epsfannounce{\toks0 = }%
8524 \input epsf.tex
8526 \closein 1
8528 % We will only complain once about lack of epsf.tex.
8529 \newif\ifwarnednoepsf
8530 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8531 work. It is also included in the Texinfo distribution, or you can get
8532 it from ftp://tug.org/tex/epsf.tex.}
8534 \def\image#1{%
8535 \ifx\epsfbox\thisisundefined
8536 \ifwarnednoepsf \else
8537 \errhelp = \noepsfhelp
8538 \errmessage{epsf.tex not found, images will be ignored}%
8539 \global\warnednoepsftrue
8541 \else
8542 \imagexxx #1,,,,,\finish
8546 % Arguments to @image:
8547 % #1 is (mandatory) image filename; we tack on .eps extension.
8548 % #2 is (optional) width, #3 is (optional) height.
8549 % #4 is (ignored optional) html alt text.
8550 % #5 is (ignored optional) extension.
8551 % #6 is just the usual extra ignored arg for parsing stuff.
8552 \newif\ifimagevmode
8553 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
8554 \catcode`\^^M = 5 % in case we're inside an example
8555 \normalturnoffactive % allow _ et al. in names
8556 % If the image is by itself, center it.
8557 \ifvmode
8558 \imagevmodetrue
8559 \else \ifx\centersub\centerV
8560 % for @center @image, we need a vbox so we can have our vertical space
8561 \imagevmodetrue
8562 \vbox\bgroup % vbox has better behavior than vtop herev
8563 \fi\fi
8565 \ifimagevmode
8566 \nobreak\medskip
8567 % Usually we'll have text after the image which will insert
8568 % \parskip glue, so insert it here too to equalize the space
8569 % above and below.
8570 \nobreak\vskip\parskip
8571 \nobreak
8574 % Leave vertical mode so that indentation from an enclosing
8575 % environment such as @quotation is respected.
8576 % However, if we're at the top level, we don't want the
8577 % normal paragraph indentation.
8578 % On the other hand, if we are in the case of @center @image, we don't
8579 % want to start a paragraph, which will create a hsize-width box and
8580 % eradicate the centering.
8581 \ifx\centersub\centerV\else \noindent \fi
8583 % Output the image.
8584 \ifpdf
8585 \dopdfimage{#1}{#2}{#3}%
8586 \else
8587 % \epsfbox itself resets \epsf?size at each figure.
8588 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
8589 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
8590 \epsfbox{#1.eps}%
8593 \ifimagevmode
8594 \medskip % space after a standalone image
8595 \fi
8596 \ifx\centersub\centerV \egroup \fi
8597 \endgroup}
8600 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8601 % etc. We don't actually implement floating yet, we always include the
8602 % float "here". But it seemed the best name for the future.
8604 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
8606 % There may be a space before second and/or third parameter; delete it.
8607 \def\eatcommaspace#1, {#1,}
8609 % #1 is the optional FLOATTYPE, the text label for this float, typically
8610 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
8611 % this float will not be numbered and cannot be referred to.
8613 % #2 is the optional xref label. Also must be present for the float to
8614 % be referable.
8616 % #3 is the optional positioning argument; for now, it is ignored. It
8617 % will somehow specify the positions allowed to float to (here, top, bottom).
8619 % We keep a separate counter for each FLOATTYPE, which we reset at each
8620 % chapter-level command.
8621 \let\resetallfloatnos=\empty
8623 \def\dofloat#1,#2,#3,#4\finish{%
8624 \let\thiscaption=\empty
8625 \let\thisshortcaption=\empty
8627 % don't lose footnotes inside @float.
8629 % BEWARE: when the floats start float, we have to issue warning whenever an
8630 % insert appears inside a float which could possibly float. --kasal, 26may04
8632 \startsavinginserts
8634 % We can't be used inside a paragraph.
8635 \par
8637 \vtop\bgroup
8638 \def\floattype{#1}%
8639 \def\floatlabel{#2}%
8640 \def\floatloc{#3}% we do nothing with this yet.
8642 \ifx\floattype\empty
8643 \let\safefloattype=\empty
8644 \else
8646 % the floattype might have accents or other special characters,
8647 % but we need to use it in a control sequence name.
8648 \indexnofonts
8649 \turnoffactive
8650 \xdef\safefloattype{\floattype}%
8654 % If label is given but no type, we handle that as the empty type.
8655 \ifx\floatlabel\empty \else
8656 % We want each FLOATTYPE to be numbered separately (Figure 1,
8657 % Table 1, Figure 2, ...). (And if no label, no number.)
8659 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
8660 \global\advance\floatno by 1
8663 % This magic value for \lastsection is output by \setref as the
8664 % XREFLABEL-title value. \xrefX uses it to distinguish float
8665 % labels (which have a completely different output format) from
8666 % node and anchor labels. And \xrdef uses it to construct the
8667 % lists of floats.
8669 \edef\lastsection{\floatmagic=\safefloattype}%
8670 \setref{\floatlabel}{Yfloat}%
8674 % start with \parskip glue, I guess.
8675 \vskip\parskip
8677 % Don't suppress indentation if a float happens to start a section.
8678 \restorefirstparagraphindent
8681 % we have these possibilities:
8682 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8683 % @float Foo,lbl & no caption: Foo 1.1
8684 % @float Foo & @caption{Cap}: Foo: Cap
8685 % @float Foo & no caption: Foo
8686 % @float ,lbl & Caption{Cap}: 1.1: Cap
8687 % @float ,lbl & no caption: 1.1
8688 % @float & @caption{Cap}: Cap
8689 % @float & no caption:
8691 \def\Efloat{%
8692 \let\floatident = \empty
8694 % In all cases, if we have a float type, it comes first.
8695 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8697 % If we have an xref label, the number comes next.
8698 \ifx\floatlabel\empty \else
8699 \ifx\floattype\empty \else % if also had float type, need tie first.
8700 \appendtomacro\floatident{\tie}%
8702 % the number.
8703 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8706 % Start the printed caption with what we've constructed in
8707 % \floatident, but keep it separate; we need \floatident again.
8708 \let\captionline = \floatident
8710 \ifx\thiscaption\empty \else
8711 \ifx\floatident\empty \else
8712 \appendtomacro\captionline{: }% had ident, so need a colon between
8715 % caption text.
8716 \appendtomacro\captionline{\scanexp\thiscaption}%
8719 % If we have anything to print, print it, with space before.
8720 % Eventually this needs to become an \insert.
8721 \ifx\captionline\empty \else
8722 \vskip.5\parskip
8723 \captionline
8725 % Space below caption.
8726 \vskip\parskip
8729 % If have an xref label, write the list of floats info. Do this
8730 % after the caption, to avoid chance of it being a breakpoint.
8731 \ifx\floatlabel\empty \else
8732 % Write the text that goes in the lof to the aux file as
8733 % \floatlabel-lof. Besides \floatident, we include the short
8734 % caption if specified, else the full caption if specified, else nothing.
8736 \atdummies
8738 % since we read the caption text in the macro world, where ^^M
8739 % is turned into a normal character, we have to scan it back, so
8740 % we don't write the literal three characters "^^M" into the aux file.
8741 \scanexp{%
8742 \xdef\noexpand\gtemp{%
8743 \ifx\thisshortcaption\empty
8744 \thiscaption
8745 \else
8746 \thisshortcaption
8750 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
8751 \ifx\gtemp\empty \else : \gtemp \fi}}%
8754 \egroup % end of \vtop
8756 % place the captured inserts
8758 % BEWARE: when the floats start floating, we have to issue warning
8759 % whenever an insert appears inside a float which could possibly
8760 % float. --kasal, 26may04
8762 \checkinserts
8765 % Append the tokens #2 to the definition of macro #1, not expanding either.
8767 \def\appendtomacro#1#2{%
8768 \expandafter\def\expandafter#1\expandafter{#1#2}%
8771 % @caption, @shortcaption
8773 \def\caption{\docaption\thiscaption}
8774 \def\shortcaption{\docaption\thisshortcaption}
8775 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8776 \def\defcaption#1#2{\egroup \def#1{#2}}
8778 % The parameter is the control sequence identifying the counter we are
8779 % going to use. Create it if it doesn't exist and assign it to \floatno.
8780 \def\getfloatno#1{%
8781 \ifx#1\relax
8782 % Haven't seen this figure type before.
8783 \csname newcount\endcsname #1%
8785 % Remember to reset this floatno at the next chap.
8786 \expandafter\gdef\expandafter\resetallfloatnos
8787 \expandafter{\resetallfloatnos #1=0 }%
8789 \let\floatno#1%
8792 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8793 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8794 % first read the @float command.
8796 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
8798 % Magic string used for the XREFLABEL-title value, so \xrefX can
8799 % distinguish floats from other xref types.
8800 \def\floatmagic{!!float!!}
8802 % #1 is the control sequence we are passed; we expand into a conditional
8803 % which is true if #1 represents a float ref. That is, the magic
8804 % \lastsection value which we \setref above.
8806 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
8808 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8809 % (safe) float type for this float. We set \iffloattype to #2.
8811 \def\doiffloat#1=#2=#3\finish{%
8812 \def\temp{#1}%
8813 \def\iffloattype{#2}%
8814 \ifx\temp\floatmagic
8817 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8819 \parseargdef\listoffloats{%
8820 \def\floattype{#1}% floattype
8822 % the floattype might have accents or other special characters,
8823 % but we need to use it in a control sequence name.
8824 \indexnofonts
8825 \turnoffactive
8826 \xdef\safefloattype{\floattype}%
8829 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8830 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8831 \ifhavexrefs
8832 % if the user said @listoffloats foo but never @float foo.
8833 \message{\linenumber No `\safefloattype' floats to list.}%
8835 \else
8836 \begingroup
8837 \leftskip=\tocindent % indent these entries like a toc
8838 \let\do=\listoffloatsdo
8839 \csname floatlist\safefloattype\endcsname
8840 \endgroup
8844 % This is called on each entry in a list of floats. We're passed the
8845 % xref label, in the form LABEL-title, which is how we save it in the
8846 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8847 % has the text we're supposed to typeset here.
8849 % Figures without xref labels will not be included in the list (since
8850 % they won't appear in the aux file).
8852 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8853 \def\listoffloatsdoentry#1-title\finish{{%
8854 % Can't fully expand XR#1-lof because it can contain anything. Just
8855 % pass the control sequence. On the other hand, XR#1-pg is just the
8856 % page number, and we want to fully expand that so we can get a link
8857 % in pdf output.
8858 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8860 % use the same \entry macro we use to generate the TOC and index.
8861 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8862 \writeentry
8866 \message{localization,}
8868 % For single-language documents, @documentlanguage is usually given very
8869 % early, just after @documentencoding. Single argument is the language
8870 % (de) or locale (de_DE) abbreviation.
8873 \catcode`\_ = \active
8874 \globaldefs=1
8875 \parseargdef\documentlanguage{%
8876 \tex % read txi-??.tex file in plain TeX.
8877 % Read the file by the name they passed if it exists.
8878 \let_ = \normalunderscore % normal _ character for filename test
8879 \openin 1 txi-#1.tex
8880 \ifeof 1
8881 \documentlanguagetrywithoutunderscore #1_\finish
8882 \else
8883 \globaldefs = 1 % everything in the txi-LL files needs to persist
8884 \input txi-#1.tex
8886 \closein 1
8887 \endgroup % end raw TeX
8890 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8891 % try txi-de.tex.
8893 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8894 \openin 1 txi-#1.tex
8895 \ifeof 1
8896 \errhelp = \nolanghelp
8897 \errmessage{Cannot read language file txi-#1.tex}%
8898 \else
8899 \globaldefs = 1 % everything in the txi-LL files needs to persist
8900 \input txi-#1.tex
8902 \closein 1
8904 }% end of special _ catcode
8906 \newhelp\nolanghelp{The given language definition file cannot be found or
8907 is empty. Maybe you need to install it? Putting it in the current
8908 directory should work if nowhere else does.}
8910 % This macro is called from txi-??.tex files; the first argument is the
8911 % \language name to set (without the "\lang@" prefix), the second and
8912 % third args are \{left,right}hyphenmin.
8914 % The language names to pass are determined when the format is built.
8915 % See the etex.log file created at that time, e.g.,
8916 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8918 % With TeX Live 2008, etex now includes hyphenation patterns for all
8919 % available languages. This means we can support hyphenation in
8920 % Texinfo, at least to some extent. (This still doesn't solve the
8921 % accented characters problem.)
8923 \catcode`@=11
8924 \def\txisetlanguage#1#2#3{%
8925 % do not set the language if the name is undefined in the current TeX.
8926 \expandafter\ifx\csname lang@#1\endcsname \relax
8927 \message{no patterns for #1}%
8928 \else
8929 \global\language = \csname lang@#1\endcsname
8931 % but there is no harm in adjusting the hyphenmin values regardless.
8932 \global\lefthyphenmin = #2\relax
8933 \global\righthyphenmin = #3\relax
8936 % Helpers for encodings.
8937 % Set the catcode of characters 128 through 255 to the specified number.
8939 \def\setnonasciicharscatcode#1{%
8940 \count255=128
8941 \loop\ifnum\count255<256
8942 \global\catcode\count255=#1\relax
8943 \advance\count255 by 1
8944 \repeat
8947 \def\setnonasciicharscatcodenonglobal#1{%
8948 \count255=128
8949 \loop\ifnum\count255<256
8950 \catcode\count255=#1\relax
8951 \advance\count255 by 1
8952 \repeat
8955 % @documentencoding sets the definition of non-ASCII characters
8956 % according to the specified encoding.
8958 \parseargdef\documentencoding{%
8959 % Encoding being declared for the document.
8960 \def\declaredencoding{\csname #1.enc\endcsname}%
8962 % Supported encodings: names converted to tokens in order to be able
8963 % to compare them with \ifx.
8964 \def\ascii{\csname US-ASCII.enc\endcsname}%
8965 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8966 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8967 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8968 \def\utfeight{\csname UTF-8.enc\endcsname}%
8970 \ifx \declaredencoding \ascii
8971 \asciichardefs
8973 \else \ifx \declaredencoding \lattwo
8974 \setnonasciicharscatcode\active
8975 \lattwochardefs
8977 \else \ifx \declaredencoding \latone
8978 \setnonasciicharscatcode\active
8979 \latonechardefs
8981 \else \ifx \declaredencoding \latnine
8982 \setnonasciicharscatcode\active
8983 \latninechardefs
8985 \else \ifx \declaredencoding \utfeight
8986 \setnonasciicharscatcode\active
8987 \utfeightchardefs
8989 \else
8990 \message{Unknown document encoding #1, ignoring.}%
8992 \fi % utfeight
8993 \fi % latnine
8994 \fi % latone
8995 \fi % lattwo
8996 \fi % ascii
8999 % A message to be logged when using a character that isn't available
9000 % the default font encoding (OT1).
9002 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
9004 % Take account of \c (plain) vs. \, (Texinfo) difference.
9005 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
9007 % First, make active non-ASCII characters in order for them to be
9008 % correctly categorized when TeX reads the replacement text of
9009 % macros containing the character definitions.
9010 \setnonasciicharscatcode\active
9012 % Latin1 (ISO-8859-1) character definitions.
9013 \def\latonechardefs{%
9014 \gdef^^a0{\tie}
9015 \gdef^^a1{\exclamdown}
9016 \gdef^^a2{\missingcharmsg{CENT SIGN}}
9017 \gdef^^a3{{\pounds}}
9018 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
9019 \gdef^^a5{\missingcharmsg{YEN SIGN}}
9020 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
9021 \gdef^^a7{\S}
9022 \gdef^^a8{\"{}}
9023 \gdef^^a9{\copyright}
9024 \gdef^^aa{\ordf}
9025 \gdef^^ab{\guillemetleft}
9026 \gdef^^ac{$\lnot$}
9027 \gdef^^ad{\-}
9028 \gdef^^ae{\registeredsymbol}
9029 \gdef^^af{\={}}
9031 \gdef^^b0{\textdegree}
9032 \gdef^^b1{$\pm$}
9033 \gdef^^b2{$^2$}
9034 \gdef^^b3{$^3$}
9035 \gdef^^b4{\'{}}
9036 \gdef^^b5{$\mu$}
9037 \gdef^^b6{\P}
9039 \gdef^^b7{$^.$}
9040 \gdef^^b8{\cedilla\ }
9041 \gdef^^b9{$^1$}
9042 \gdef^^ba{\ordm}
9044 \gdef^^bb{\guillemetright}
9045 \gdef^^bc{$1\over4$}
9046 \gdef^^bd{$1\over2$}
9047 \gdef^^be{$3\over4$}
9048 \gdef^^bf{\questiondown}
9050 \gdef^^c0{\`A}
9051 \gdef^^c1{\'A}
9052 \gdef^^c2{\^A}
9053 \gdef^^c3{\~A}
9054 \gdef^^c4{\"A}
9055 \gdef^^c5{\ringaccent A}
9056 \gdef^^c6{\AE}
9057 \gdef^^c7{\cedilla C}
9058 \gdef^^c8{\`E}
9059 \gdef^^c9{\'E}
9060 \gdef^^ca{\^E}
9061 \gdef^^cb{\"E}
9062 \gdef^^cc{\`I}
9063 \gdef^^cd{\'I}
9064 \gdef^^ce{\^I}
9065 \gdef^^cf{\"I}
9067 \gdef^^d0{\DH}
9068 \gdef^^d1{\~N}
9069 \gdef^^d2{\`O}
9070 \gdef^^d3{\'O}
9071 \gdef^^d4{\^O}
9072 \gdef^^d5{\~O}
9073 \gdef^^d6{\"O}
9074 \gdef^^d7{$\times$}
9075 \gdef^^d8{\O}
9076 \gdef^^d9{\`U}
9077 \gdef^^da{\'U}
9078 \gdef^^db{\^U}
9079 \gdef^^dc{\"U}
9080 \gdef^^dd{\'Y}
9081 \gdef^^de{\TH}
9082 \gdef^^df{\ss}
9084 \gdef^^e0{\`a}
9085 \gdef^^e1{\'a}
9086 \gdef^^e2{\^a}
9087 \gdef^^e3{\~a}
9088 \gdef^^e4{\"a}
9089 \gdef^^e5{\ringaccent a}
9090 \gdef^^e6{\ae}
9091 \gdef^^e7{\cedilla c}
9092 \gdef^^e8{\`e}
9093 \gdef^^e9{\'e}
9094 \gdef^^ea{\^e}
9095 \gdef^^eb{\"e}
9096 \gdef^^ec{\`{\dotless i}}
9097 \gdef^^ed{\'{\dotless i}}
9098 \gdef^^ee{\^{\dotless i}}
9099 \gdef^^ef{\"{\dotless i}}
9101 \gdef^^f0{\dh}
9102 \gdef^^f1{\~n}
9103 \gdef^^f2{\`o}
9104 \gdef^^f3{\'o}
9105 \gdef^^f4{\^o}
9106 \gdef^^f5{\~o}
9107 \gdef^^f6{\"o}
9108 \gdef^^f7{$\div$}
9109 \gdef^^f8{\o}
9110 \gdef^^f9{\`u}
9111 \gdef^^fa{\'u}
9112 \gdef^^fb{\^u}
9113 \gdef^^fc{\"u}
9114 \gdef^^fd{\'y}
9115 \gdef^^fe{\th}
9116 \gdef^^ff{\"y}
9119 % Latin9 (ISO-8859-15) encoding character definitions.
9120 \def\latninechardefs{%
9121 % Encoding is almost identical to Latin1.
9122 \latonechardefs
9124 \gdef^^a4{\euro}
9125 \gdef^^a6{\v S}
9126 \gdef^^a8{\v s}
9127 \gdef^^b4{\v Z}
9128 \gdef^^b8{\v z}
9129 \gdef^^bc{\OE}
9130 \gdef^^bd{\oe}
9131 \gdef^^be{\"Y}
9134 % Latin2 (ISO-8859-2) character definitions.
9135 \def\lattwochardefs{%
9136 \gdef^^a0{\tie}
9137 \gdef^^a1{\ogonek{A}}
9138 \gdef^^a2{\u{}}
9139 \gdef^^a3{\L}
9140 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
9141 \gdef^^a5{\v L}
9142 \gdef^^a6{\'S}
9143 \gdef^^a7{\S}
9144 \gdef^^a8{\"{}}
9145 \gdef^^a9{\v S}
9146 \gdef^^aa{\cedilla S}
9147 \gdef^^ab{\v T}
9148 \gdef^^ac{\'Z}
9149 \gdef^^ad{\-}
9150 \gdef^^ae{\v Z}
9151 \gdef^^af{\dotaccent Z}
9153 \gdef^^b0{\textdegree}
9154 \gdef^^b1{\ogonek{a}}
9155 \gdef^^b2{\ogonek{ }}
9156 \gdef^^b3{\l}
9157 \gdef^^b4{\'{}}
9158 \gdef^^b5{\v l}
9159 \gdef^^b6{\'s}
9160 \gdef^^b7{\v{}}
9161 \gdef^^b8{\cedilla\ }
9162 \gdef^^b9{\v s}
9163 \gdef^^ba{\cedilla s}
9164 \gdef^^bb{\v t}
9165 \gdef^^bc{\'z}
9166 \gdef^^bd{\H{}}
9167 \gdef^^be{\v z}
9168 \gdef^^bf{\dotaccent z}
9170 \gdef^^c0{\'R}
9171 \gdef^^c1{\'A}
9172 \gdef^^c2{\^A}
9173 \gdef^^c3{\u A}
9174 \gdef^^c4{\"A}
9175 \gdef^^c5{\'L}
9176 \gdef^^c6{\'C}
9177 \gdef^^c7{\cedilla C}
9178 \gdef^^c8{\v C}
9179 \gdef^^c9{\'E}
9180 \gdef^^ca{\ogonek{E}}
9181 \gdef^^cb{\"E}
9182 \gdef^^cc{\v E}
9183 \gdef^^cd{\'I}
9184 \gdef^^ce{\^I}
9185 \gdef^^cf{\v D}
9187 \gdef^^d0{\DH}
9188 \gdef^^d1{\'N}
9189 \gdef^^d2{\v N}
9190 \gdef^^d3{\'O}
9191 \gdef^^d4{\^O}
9192 \gdef^^d5{\H O}
9193 \gdef^^d6{\"O}
9194 \gdef^^d7{$\times$}
9195 \gdef^^d8{\v R}
9196 \gdef^^d9{\ringaccent U}
9197 \gdef^^da{\'U}
9198 \gdef^^db{\H U}
9199 \gdef^^dc{\"U}
9200 \gdef^^dd{\'Y}
9201 \gdef^^de{\cedilla T}
9202 \gdef^^df{\ss}
9204 \gdef^^e0{\'r}
9205 \gdef^^e1{\'a}
9206 \gdef^^e2{\^a}
9207 \gdef^^e3{\u a}
9208 \gdef^^e4{\"a}
9209 \gdef^^e5{\'l}
9210 \gdef^^e6{\'c}
9211 \gdef^^e7{\cedilla c}
9212 \gdef^^e8{\v c}
9213 \gdef^^e9{\'e}
9214 \gdef^^ea{\ogonek{e}}
9215 \gdef^^eb{\"e}
9216 \gdef^^ec{\v e}
9217 \gdef^^ed{\'{\dotless{i}}}
9218 \gdef^^ee{\^{\dotless{i}}}
9219 \gdef^^ef{\v d}
9221 \gdef^^f0{\dh}
9222 \gdef^^f1{\'n}
9223 \gdef^^f2{\v n}
9224 \gdef^^f3{\'o}
9225 \gdef^^f4{\^o}
9226 \gdef^^f5{\H o}
9227 \gdef^^f6{\"o}
9228 \gdef^^f7{$\div$}
9229 \gdef^^f8{\v r}
9230 \gdef^^f9{\ringaccent u}
9231 \gdef^^fa{\'u}
9232 \gdef^^fb{\H u}
9233 \gdef^^fc{\"u}
9234 \gdef^^fd{\'y}
9235 \gdef^^fe{\cedilla t}
9236 \gdef^^ff{\dotaccent{}}
9239 % UTF-8 character definitions.
9241 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
9242 % changes for Texinfo conventions. It is included here under the GPL by
9243 % permission from Frank Mittelbach and the LaTeX team.
9245 \newcount\countUTFx
9246 \newcount\countUTFy
9247 \newcount\countUTFz
9249 \gdef\UTFviiiTwoOctets#1#2{\expandafter
9250 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
9252 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
9253 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
9255 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
9256 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
9258 \gdef\UTFviiiDefined#1{%
9259 \ifx #1\relax
9260 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
9261 \else
9262 \expandafter #1%
9266 \begingroup
9267 \catcode`\~13
9268 \catcode`\"12
9270 \def\UTFviiiLoop{%
9271 \global\catcode\countUTFx\active
9272 \uccode`\~\countUTFx
9273 \uppercase\expandafter{\UTFviiiTmp}%
9274 \advance\countUTFx by 1
9275 \ifnum\countUTFx < \countUTFy
9276 \expandafter\UTFviiiLoop
9277 \fi}
9279 \countUTFx = "C2
9280 \countUTFy = "E0
9281 \def\UTFviiiTmp{%
9282 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
9283 \UTFviiiLoop
9285 \countUTFx = "E0
9286 \countUTFy = "F0
9287 \def\UTFviiiTmp{%
9288 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
9289 \UTFviiiLoop
9291 \countUTFx = "F0
9292 \countUTFy = "F4
9293 \def\UTFviiiTmp{%
9294 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
9295 \UTFviiiLoop
9296 \endgroup
9298 \def\globallet{\global\let} % save some \expandafter's below
9300 % @U{xxxx} to produce U+xxxx, if we support it.
9301 \def\U#1{%
9302 \expandafter\ifx\csname uni:#1\endcsname \relax
9303 \errhelp = \EMsimple
9304 \errmessage{Unicode character U+#1 not supported, sorry}%
9305 \else
9306 \csname uni:#1\endcsname
9310 \begingroup
9311 \catcode`\"=12
9312 \catcode`\<=12
9313 \catcode`\.=12
9314 \catcode`\,=12
9315 \catcode`\;=12
9316 \catcode`\!=12
9317 \catcode`\~=13
9318 \gdef\DeclareUnicodeCharacter#1#2{%
9319 \countUTFz = "#1\relax
9320 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9321 \begingroup
9322 \parseXMLCharref
9323 \def\UTFviiiTwoOctets##1##2{%
9324 \csname u8:##1\string ##2\endcsname}%
9325 \def\UTFviiiThreeOctets##1##2##3{%
9326 \csname u8:##1\string ##2\string ##3\endcsname}%
9327 \def\UTFviiiFourOctets##1##2##3##4{%
9328 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
9329 \expandafter\expandafter\expandafter\expandafter
9330 \expandafter\expandafter\expandafter
9331 \gdef\UTFviiiTmp{#2}%
9332 % define an additional control sequence for this code point.
9333 \expandafter\globallet\csname uni:#1\endcsname \UTFviiiTmp
9334 \endgroup}
9336 \gdef\parseXMLCharref{%
9337 \ifnum\countUTFz < "A0\relax
9338 \errhelp = \EMsimple
9339 \errmessage{Cannot define Unicode char value < 00A0}%
9340 \else\ifnum\countUTFz < "800\relax
9341 \parseUTFviiiA,%
9342 \parseUTFviiiB C\UTFviiiTwoOctets.,%
9343 \else\ifnum\countUTFz < "10000\relax
9344 \parseUTFviiiA;%
9345 \parseUTFviiiA,%
9346 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
9347 \else
9348 \parseUTFviiiA;%
9349 \parseUTFviiiA,%
9350 \parseUTFviiiA!%
9351 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
9352 \fi\fi\fi
9355 \gdef\parseUTFviiiA#1{%
9356 \countUTFx = \countUTFz
9357 \divide\countUTFz by 64
9358 \countUTFy = \countUTFz
9359 \multiply\countUTFz by 64
9360 \advance\countUTFx by -\countUTFz
9361 \advance\countUTFx by 128
9362 \uccode `#1\countUTFx
9363 \countUTFz = \countUTFy}
9365 \gdef\parseUTFviiiB#1#2#3#4{%
9366 \advance\countUTFz by "#10\relax
9367 \uccode `#3\countUTFz
9368 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9369 \endgroup
9371 \def\utfeightchardefs{%
9372 \DeclareUnicodeCharacter{00A0}{\tie}
9373 \DeclareUnicodeCharacter{00A1}{\exclamdown}
9374 \DeclareUnicodeCharacter{00A3}{\pounds}
9375 \DeclareUnicodeCharacter{00A8}{\"{ }}
9376 \DeclareUnicodeCharacter{00A9}{\copyright}
9377 \DeclareUnicodeCharacter{00AA}{\ordf}
9378 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
9379 \DeclareUnicodeCharacter{00AD}{\-}
9380 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
9381 \DeclareUnicodeCharacter{00AF}{\={ }}
9383 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
9384 \DeclareUnicodeCharacter{00B4}{\'{ }}
9385 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
9386 \DeclareUnicodeCharacter{00BA}{\ordm}
9387 \DeclareUnicodeCharacter{00BB}{\guillemetright}
9388 \DeclareUnicodeCharacter{00BF}{\questiondown}
9390 \DeclareUnicodeCharacter{00C0}{\`A}
9391 \DeclareUnicodeCharacter{00C1}{\'A}
9392 \DeclareUnicodeCharacter{00C2}{\^A}
9393 \DeclareUnicodeCharacter{00C3}{\~A}
9394 \DeclareUnicodeCharacter{00C4}{\"A}
9395 \DeclareUnicodeCharacter{00C5}{\AA}
9396 \DeclareUnicodeCharacter{00C6}{\AE}
9397 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
9398 \DeclareUnicodeCharacter{00C8}{\`E}
9399 \DeclareUnicodeCharacter{00C9}{\'E}
9400 \DeclareUnicodeCharacter{00CA}{\^E}
9401 \DeclareUnicodeCharacter{00CB}{\"E}
9402 \DeclareUnicodeCharacter{00CC}{\`I}
9403 \DeclareUnicodeCharacter{00CD}{\'I}
9404 \DeclareUnicodeCharacter{00CE}{\^I}
9405 \DeclareUnicodeCharacter{00CF}{\"I}
9407 \DeclareUnicodeCharacter{00D0}{\DH}
9408 \DeclareUnicodeCharacter{00D1}{\~N}
9409 \DeclareUnicodeCharacter{00D2}{\`O}
9410 \DeclareUnicodeCharacter{00D3}{\'O}
9411 \DeclareUnicodeCharacter{00D4}{\^O}
9412 \DeclareUnicodeCharacter{00D5}{\~O}
9413 \DeclareUnicodeCharacter{00D6}{\"O}
9414 \DeclareUnicodeCharacter{00D8}{\O}
9415 \DeclareUnicodeCharacter{00D9}{\`U}
9416 \DeclareUnicodeCharacter{00DA}{\'U}
9417 \DeclareUnicodeCharacter{00DB}{\^U}
9418 \DeclareUnicodeCharacter{00DC}{\"U}
9419 \DeclareUnicodeCharacter{00DD}{\'Y}
9420 \DeclareUnicodeCharacter{00DE}{\TH}
9421 \DeclareUnicodeCharacter{00DF}{\ss}
9423 \DeclareUnicodeCharacter{00E0}{\`a}
9424 \DeclareUnicodeCharacter{00E1}{\'a}
9425 \DeclareUnicodeCharacter{00E2}{\^a}
9426 \DeclareUnicodeCharacter{00E3}{\~a}
9427 \DeclareUnicodeCharacter{00E4}{\"a}
9428 \DeclareUnicodeCharacter{00E5}{\aa}
9429 \DeclareUnicodeCharacter{00E6}{\ae}
9430 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
9431 \DeclareUnicodeCharacter{00E8}{\`e}
9432 \DeclareUnicodeCharacter{00E9}{\'e}
9433 \DeclareUnicodeCharacter{00EA}{\^e}
9434 \DeclareUnicodeCharacter{00EB}{\"e}
9435 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
9436 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
9437 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
9438 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
9440 \DeclareUnicodeCharacter{00F0}{\dh}
9441 \DeclareUnicodeCharacter{00F1}{\~n}
9442 \DeclareUnicodeCharacter{00F2}{\`o}
9443 \DeclareUnicodeCharacter{00F3}{\'o}
9444 \DeclareUnicodeCharacter{00F4}{\^o}
9445 \DeclareUnicodeCharacter{00F5}{\~o}
9446 \DeclareUnicodeCharacter{00F6}{\"o}
9447 \DeclareUnicodeCharacter{00F8}{\o}
9448 \DeclareUnicodeCharacter{00F9}{\`u}
9449 \DeclareUnicodeCharacter{00FA}{\'u}
9450 \DeclareUnicodeCharacter{00FB}{\^u}
9451 \DeclareUnicodeCharacter{00FC}{\"u}
9452 \DeclareUnicodeCharacter{00FD}{\'y}
9453 \DeclareUnicodeCharacter{00FE}{\th}
9454 \DeclareUnicodeCharacter{00FF}{\"y}
9456 \DeclareUnicodeCharacter{0100}{\=A}
9457 \DeclareUnicodeCharacter{0101}{\=a}
9458 \DeclareUnicodeCharacter{0102}{\u{A}}
9459 \DeclareUnicodeCharacter{0103}{\u{a}}
9460 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
9461 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
9462 \DeclareUnicodeCharacter{0106}{\'C}
9463 \DeclareUnicodeCharacter{0107}{\'c}
9464 \DeclareUnicodeCharacter{0108}{\^C}
9465 \DeclareUnicodeCharacter{0109}{\^c}
9466 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
9467 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
9468 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
9469 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
9470 \DeclareUnicodeCharacter{010C}{\v{C}}
9471 \DeclareUnicodeCharacter{010D}{\v{c}}
9472 \DeclareUnicodeCharacter{010E}{\v{D}}
9474 \DeclareUnicodeCharacter{0112}{\=E}
9475 \DeclareUnicodeCharacter{0113}{\=e}
9476 \DeclareUnicodeCharacter{0114}{\u{E}}
9477 \DeclareUnicodeCharacter{0115}{\u{e}}
9478 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
9479 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
9480 \DeclareUnicodeCharacter{011A}{\v{E}}
9481 \DeclareUnicodeCharacter{011B}{\v{e}}
9482 \DeclareUnicodeCharacter{011C}{\^G}
9483 \DeclareUnicodeCharacter{011D}{\^g}
9484 \DeclareUnicodeCharacter{011E}{\u{G}}
9485 \DeclareUnicodeCharacter{011F}{\u{g}}
9487 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
9488 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
9489 \DeclareUnicodeCharacter{0124}{\^H}
9490 \DeclareUnicodeCharacter{0125}{\^h}
9491 \DeclareUnicodeCharacter{0128}{\~I}
9492 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
9493 \DeclareUnicodeCharacter{012A}{\=I}
9494 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
9495 \DeclareUnicodeCharacter{012C}{\u{I}}
9496 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
9498 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
9499 \DeclareUnicodeCharacter{0131}{\dotless{i}}
9500 \DeclareUnicodeCharacter{0132}{IJ}
9501 \DeclareUnicodeCharacter{0133}{ij}
9502 \DeclareUnicodeCharacter{0134}{\^J}
9503 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
9504 \DeclareUnicodeCharacter{0139}{\'L}
9505 \DeclareUnicodeCharacter{013A}{\'l}
9507 \DeclareUnicodeCharacter{0141}{\L}
9508 \DeclareUnicodeCharacter{0142}{\l}
9509 \DeclareUnicodeCharacter{0143}{\'N}
9510 \DeclareUnicodeCharacter{0144}{\'n}
9511 \DeclareUnicodeCharacter{0147}{\v{N}}
9512 \DeclareUnicodeCharacter{0148}{\v{n}}
9513 \DeclareUnicodeCharacter{014C}{\=O}
9514 \DeclareUnicodeCharacter{014D}{\=o}
9515 \DeclareUnicodeCharacter{014E}{\u{O}}
9516 \DeclareUnicodeCharacter{014F}{\u{o}}
9518 \DeclareUnicodeCharacter{0150}{\H{O}}
9519 \DeclareUnicodeCharacter{0151}{\H{o}}
9520 \DeclareUnicodeCharacter{0152}{\OE}
9521 \DeclareUnicodeCharacter{0153}{\oe}
9522 \DeclareUnicodeCharacter{0154}{\'R}
9523 \DeclareUnicodeCharacter{0155}{\'r}
9524 \DeclareUnicodeCharacter{0158}{\v{R}}
9525 \DeclareUnicodeCharacter{0159}{\v{r}}
9526 \DeclareUnicodeCharacter{015A}{\'S}
9527 \DeclareUnicodeCharacter{015B}{\'s}
9528 \DeclareUnicodeCharacter{015C}{\^S}
9529 \DeclareUnicodeCharacter{015D}{\^s}
9530 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
9531 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
9533 \DeclareUnicodeCharacter{0160}{\v{S}}
9534 \DeclareUnicodeCharacter{0161}{\v{s}}
9535 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
9536 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
9537 \DeclareUnicodeCharacter{0164}{\v{T}}
9539 \DeclareUnicodeCharacter{0168}{\~U}
9540 \DeclareUnicodeCharacter{0169}{\~u}
9541 \DeclareUnicodeCharacter{016A}{\=U}
9542 \DeclareUnicodeCharacter{016B}{\=u}
9543 \DeclareUnicodeCharacter{016C}{\u{U}}
9544 \DeclareUnicodeCharacter{016D}{\u{u}}
9545 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
9546 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
9548 \DeclareUnicodeCharacter{0170}{\H{U}}
9549 \DeclareUnicodeCharacter{0171}{\H{u}}
9550 \DeclareUnicodeCharacter{0174}{\^W}
9551 \DeclareUnicodeCharacter{0175}{\^w}
9552 \DeclareUnicodeCharacter{0176}{\^Y}
9553 \DeclareUnicodeCharacter{0177}{\^y}
9554 \DeclareUnicodeCharacter{0178}{\"Y}
9555 \DeclareUnicodeCharacter{0179}{\'Z}
9556 \DeclareUnicodeCharacter{017A}{\'z}
9557 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
9558 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
9559 \DeclareUnicodeCharacter{017D}{\v{Z}}
9560 \DeclareUnicodeCharacter{017E}{\v{z}}
9562 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
9563 \DeclareUnicodeCharacter{01C5}{D\v{z}}
9564 \DeclareUnicodeCharacter{01C6}{d\v{z}}
9565 \DeclareUnicodeCharacter{01C7}{LJ}
9566 \DeclareUnicodeCharacter{01C8}{Lj}
9567 \DeclareUnicodeCharacter{01C9}{lj}
9568 \DeclareUnicodeCharacter{01CA}{NJ}
9569 \DeclareUnicodeCharacter{01CB}{Nj}
9570 \DeclareUnicodeCharacter{01CC}{nj}
9571 \DeclareUnicodeCharacter{01CD}{\v{A}}
9572 \DeclareUnicodeCharacter{01CE}{\v{a}}
9573 \DeclareUnicodeCharacter{01CF}{\v{I}}
9575 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
9576 \DeclareUnicodeCharacter{01D1}{\v{O}}
9577 \DeclareUnicodeCharacter{01D2}{\v{o}}
9578 \DeclareUnicodeCharacter{01D3}{\v{U}}
9579 \DeclareUnicodeCharacter{01D4}{\v{u}}
9581 \DeclareUnicodeCharacter{01E2}{\={\AE}}
9582 \DeclareUnicodeCharacter{01E3}{\={\ae}}
9583 \DeclareUnicodeCharacter{01E6}{\v{G}}
9584 \DeclareUnicodeCharacter{01E7}{\v{g}}
9585 \DeclareUnicodeCharacter{01E8}{\v{K}}
9586 \DeclareUnicodeCharacter{01E9}{\v{k}}
9588 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
9589 \DeclareUnicodeCharacter{01F1}{DZ}
9590 \DeclareUnicodeCharacter{01F2}{Dz}
9591 \DeclareUnicodeCharacter{01F3}{dz}
9592 \DeclareUnicodeCharacter{01F4}{\'G}
9593 \DeclareUnicodeCharacter{01F5}{\'g}
9594 \DeclareUnicodeCharacter{01F8}{\`N}
9595 \DeclareUnicodeCharacter{01F9}{\`n}
9596 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
9597 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
9598 \DeclareUnicodeCharacter{01FE}{\'{\O}}
9599 \DeclareUnicodeCharacter{01FF}{\'{\o}}
9601 \DeclareUnicodeCharacter{021E}{\v{H}}
9602 \DeclareUnicodeCharacter{021F}{\v{h}}
9604 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
9605 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
9606 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
9607 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
9608 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
9609 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
9611 \DeclareUnicodeCharacter{0232}{\=Y}
9612 \DeclareUnicodeCharacter{0233}{\=y}
9613 \DeclareUnicodeCharacter{0237}{\dotless{j}}
9615 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
9617 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
9618 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
9619 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
9620 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
9621 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
9622 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
9623 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
9624 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
9625 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
9626 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
9627 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
9628 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
9630 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
9631 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
9633 \DeclareUnicodeCharacter{1E20}{\=G}
9634 \DeclareUnicodeCharacter{1E21}{\=g}
9635 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
9636 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
9637 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
9638 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
9639 \DeclareUnicodeCharacter{1E26}{\"H}
9640 \DeclareUnicodeCharacter{1E27}{\"h}
9642 \DeclareUnicodeCharacter{1E30}{\'K}
9643 \DeclareUnicodeCharacter{1E31}{\'k}
9644 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
9645 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
9646 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
9647 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
9648 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
9649 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
9650 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
9651 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
9652 \DeclareUnicodeCharacter{1E3E}{\'M}
9653 \DeclareUnicodeCharacter{1E3F}{\'m}
9655 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
9656 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
9657 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
9658 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
9659 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
9660 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
9661 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
9662 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
9663 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
9664 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
9666 \DeclareUnicodeCharacter{1E54}{\'P}
9667 \DeclareUnicodeCharacter{1E55}{\'p}
9668 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
9669 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
9670 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
9671 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
9672 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
9673 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
9674 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
9675 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
9677 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
9678 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
9679 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
9680 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
9681 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
9682 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
9683 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
9684 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
9685 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
9686 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
9688 \DeclareUnicodeCharacter{1E7C}{\~V}
9689 \DeclareUnicodeCharacter{1E7D}{\~v}
9690 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
9691 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
9693 \DeclareUnicodeCharacter{1E80}{\`W}
9694 \DeclareUnicodeCharacter{1E81}{\`w}
9695 \DeclareUnicodeCharacter{1E82}{\'W}
9696 \DeclareUnicodeCharacter{1E83}{\'w}
9697 \DeclareUnicodeCharacter{1E84}{\"W}
9698 \DeclareUnicodeCharacter{1E85}{\"w}
9699 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
9700 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
9701 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
9702 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
9703 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
9704 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
9705 \DeclareUnicodeCharacter{1E8C}{\"X}
9706 \DeclareUnicodeCharacter{1E8D}{\"x}
9707 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
9708 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
9710 \DeclareUnicodeCharacter{1E90}{\^Z}
9711 \DeclareUnicodeCharacter{1E91}{\^z}
9712 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
9713 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
9714 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
9715 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
9716 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
9717 \DeclareUnicodeCharacter{1E97}{\"t}
9718 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
9719 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
9721 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
9722 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
9724 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
9725 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
9726 \DeclareUnicodeCharacter{1EBC}{\~E}
9727 \DeclareUnicodeCharacter{1EBD}{\~e}
9729 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
9730 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
9731 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
9732 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
9734 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
9735 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
9737 \DeclareUnicodeCharacter{1EF2}{\`Y}
9738 \DeclareUnicodeCharacter{1EF3}{\`y}
9739 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
9741 \DeclareUnicodeCharacter{1EF8}{\~Y}
9742 \DeclareUnicodeCharacter{1EF9}{\~y}
9744 \DeclareUnicodeCharacter{2013}{--}
9745 \DeclareUnicodeCharacter{2014}{---}
9746 \DeclareUnicodeCharacter{2018}{\quoteleft}
9747 \DeclareUnicodeCharacter{2019}{\quoteright}
9748 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
9749 \DeclareUnicodeCharacter{201C}{\quotedblleft}
9750 \DeclareUnicodeCharacter{201D}{\quotedblright}
9751 \DeclareUnicodeCharacter{201E}{\quotedblbase}
9752 \DeclareUnicodeCharacter{2022}{\bullet}
9753 \DeclareUnicodeCharacter{2026}{\dots}
9754 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9755 \DeclareUnicodeCharacter{203A}{\guilsinglright}
9756 \DeclareUnicodeCharacter{20AC}{\euro}
9758 \DeclareUnicodeCharacter{2192}{\expansion}
9759 \DeclareUnicodeCharacter{21D2}{\result}
9761 \DeclareUnicodeCharacter{2212}{\minus}
9762 \DeclareUnicodeCharacter{2217}{\point}
9763 \DeclareUnicodeCharacter{2261}{\equiv}
9764 }% end of \utfeightchardefs
9767 % US-ASCII character definitions.
9768 \def\asciichardefs{% nothing need be done
9769 \relax
9772 % Make non-ASCII characters printable again for compatibility with
9773 % existing Texinfo documents that may use them, even without declaring a
9774 % document encoding.
9776 \setnonasciicharscatcode \other
9779 \message{formatting,}
9781 \newdimen\defaultparindent \defaultparindent = 15pt
9783 \chapheadingskip = 15pt plus 4pt minus 2pt
9784 \secheadingskip = 12pt plus 3pt minus 2pt
9785 \subsecheadingskip = 9pt plus 2pt minus 2pt
9787 % Prevent underfull vbox error messages.
9788 \vbadness = 10000
9790 % Don't be very finicky about underfull hboxes, either.
9791 \hbadness = 6666
9793 % Following George Bush, get rid of widows and orphans.
9794 \widowpenalty=10000
9795 \clubpenalty=10000
9797 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9798 % using an old version of TeX, don't do anything. We want the amount of
9799 % stretch added to depend on the line length, hence the dependence on
9800 % \hsize. We call this whenever the paper size is set.
9802 \def\setemergencystretch{%
9803 \ifx\emergencystretch\thisisundefined
9804 % Allow us to assign to \emergencystretch anyway.
9805 \def\emergencystretch{\dimen0}%
9806 \else
9807 \emergencystretch = .15\hsize
9811 % Parameters in order: 1) textheight; 2) textwidth;
9812 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9813 % 7) physical page height; 8) physical page width.
9815 % We also call \setleading{\textleading}, so the caller should define
9816 % \textleading. The caller should also set \parskip.
9818 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9819 \voffset = #3\relax
9820 \topskip = #6\relax
9821 \splittopskip = \topskip
9823 \vsize = #1\relax
9824 \advance\vsize by \topskip
9825 \outervsize = \vsize
9826 \advance\outervsize by 2\topandbottommargin
9827 \pageheight = \vsize
9829 \hsize = #2\relax
9830 \outerhsize = \hsize
9831 \advance\outerhsize by 0.5in
9832 \pagewidth = \hsize
9834 \normaloffset = #4\relax
9835 \bindingoffset = #5\relax
9837 \ifpdf
9838 \pdfpageheight #7\relax
9839 \pdfpagewidth #8\relax
9840 % if we don't reset these, they will remain at "1 true in" of
9841 % whatever layout pdftex was dumped with.
9842 \pdfhorigin = 1 true in
9843 \pdfvorigin = 1 true in
9846 \setleading{\textleading}
9848 \parindent = \defaultparindent
9849 \setemergencystretch
9852 % @letterpaper (the default).
9853 \def\letterpaper{{\globaldefs = 1
9854 \parskip = 3pt plus 2pt minus 1pt
9855 \textleading = 13.2pt
9857 % If page is nothing but text, make it come out even.
9858 \internalpagesizes{607.2pt}{6in}% that's 46 lines
9859 {\voffset}{.25in}%
9860 {\bindingoffset}{36pt}%
9861 {11in}{8.5in}%
9864 % Use @smallbook to reset parameters for 7x9.25 trim size.
9865 \def\smallbook{{\globaldefs = 1
9866 \parskip = 2pt plus 1pt
9867 \textleading = 12pt
9869 \internalpagesizes{7.5in}{5in}%
9870 {-.2in}{0in}%
9871 {\bindingoffset}{16pt}%
9872 {9.25in}{7in}%
9874 \lispnarrowing = 0.3in
9875 \tolerance = 700
9876 \hfuzz = 1pt
9877 \contentsrightmargin = 0pt
9878 \defbodyindent = .5cm
9881 % Use @smallerbook to reset parameters for 6x9 trim size.
9882 % (Just testing, parameters still in flux.)
9883 \def\smallerbook{{\globaldefs = 1
9884 \parskip = 1.5pt plus 1pt
9885 \textleading = 12pt
9887 \internalpagesizes{7.4in}{4.8in}%
9888 {-.2in}{-.4in}%
9889 {0pt}{14pt}%
9890 {9in}{6in}%
9892 \lispnarrowing = 0.25in
9893 \tolerance = 700
9894 \hfuzz = 1pt
9895 \contentsrightmargin = 0pt
9896 \defbodyindent = .4cm
9899 % Use @afourpaper to print on European A4 paper.
9900 \def\afourpaper{{\globaldefs = 1
9901 \parskip = 3pt plus 2pt minus 1pt
9902 \textleading = 13.2pt
9904 % Double-side printing via postscript on Laserjet 4050
9905 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9906 % To change the settings for a different printer or situation, adjust
9907 % \normaloffset until the front-side and back-side texts align. Then
9908 % do the same for \bindingoffset. You can set these for testing in
9909 % your texinfo source file like this:
9910 % @tex
9911 % \global\normaloffset = -6mm
9912 % \global\bindingoffset = 10mm
9913 % @end tex
9914 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9915 {\voffset}{\hoffset}%
9916 {\bindingoffset}{44pt}%
9917 {297mm}{210mm}%
9919 \tolerance = 700
9920 \hfuzz = 1pt
9921 \contentsrightmargin = 0pt
9922 \defbodyindent = 5mm
9925 % Use @afivepaper to print on European A5 paper.
9926 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9927 % He also recommends making @example and @lisp be small.
9928 \def\afivepaper{{\globaldefs = 1
9929 \parskip = 2pt plus 1pt minus 0.1pt
9930 \textleading = 12.5pt
9932 \internalpagesizes{160mm}{120mm}%
9933 {\voffset}{\hoffset}%
9934 {\bindingoffset}{8pt}%
9935 {210mm}{148mm}%
9937 \lispnarrowing = 0.2in
9938 \tolerance = 800
9939 \hfuzz = 1.2pt
9940 \contentsrightmargin = 0pt
9941 \defbodyindent = 2mm
9942 \tableindent = 12mm
9945 % A specific text layout, 24x15cm overall, intended for A4 paper.
9946 \def\afourlatex{{\globaldefs = 1
9947 \afourpaper
9948 \internalpagesizes{237mm}{150mm}%
9949 {\voffset}{4.6mm}%
9950 {\bindingoffset}{7mm}%
9951 {297mm}{210mm}%
9953 % Must explicitly reset to 0 because we call \afourpaper.
9954 \globaldefs = 0
9957 % Use @afourwide to print on A4 paper in landscape format.
9958 \def\afourwide{{\globaldefs = 1
9959 \afourpaper
9960 \internalpagesizes{241mm}{165mm}%
9961 {\voffset}{-2.95mm}%
9962 {\bindingoffset}{7mm}%
9963 {297mm}{210mm}%
9964 \globaldefs = 0
9967 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9968 % Perhaps we should allow setting the margins, \topskip, \parskip,
9969 % and/or leading, also. Or perhaps we should compute them somehow.
9971 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9972 \def\pagesizesyyy#1,#2,#3\finish{{%
9973 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9974 \globaldefs = 1
9976 \parskip = 3pt plus 2pt minus 1pt
9977 \setleading{\textleading}%
9979 \dimen0 = #1\relax
9980 \advance\dimen0 by \voffset
9982 \dimen2 = \hsize
9983 \advance\dimen2 by \normaloffset
9985 \internalpagesizes{#1}{\hsize}%
9986 {\voffset}{\normaloffset}%
9987 {\bindingoffset}{44pt}%
9988 {\dimen0}{\dimen2}%
9991 % Set default to letter.
9993 \letterpaper
9996 \message{and turning on texinfo input format.}
9998 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
10000 % DEL is a comment character, in case @c does not suffice.
10001 \catcode`\^^? = 14
10003 % Define macros to output various characters with catcode for normal text.
10004 \catcode`\"=\other \def\normaldoublequote{"}
10005 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
10006 \catcode`\+=\other \def\normalplus{+}
10007 \catcode`\<=\other \def\normalless{<}
10008 \catcode`\>=\other \def\normalgreater{>}
10009 \catcode`\^=\other \def\normalcaret{^}
10010 \catcode`\_=\other \def\normalunderscore{_}
10011 \catcode`\|=\other \def\normalverticalbar{|}
10012 \catcode`\~=\other \def\normaltilde{~}
10014 % This macro is used to make a character print one way in \tt
10015 % (where it can probably be output as-is), and another way in other fonts,
10016 % where something hairier probably needs to be done.
10018 % #1 is what to print if we are indeed using \tt; #2 is what to print
10019 % otherwise. Since all the Computer Modern typewriter fonts have zero
10020 % interword stretch (and shrink), and it is reasonable to expect all
10021 % typewriter fonts to have this, we can check that font parameter.
10023 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
10025 % Same as above, but check for italic font. Actually this also catches
10026 % non-italic slanted fonts since it is impossible to distinguish them from
10027 % italic fonts. But since this is only used by $ and it uses \sl anyway
10028 % this is not a problem.
10029 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
10031 % Turn off all special characters except @
10032 % (and those which the user can use as if they were ordinary).
10033 % Most of these we simply print from the \tt font, but for some, we can
10034 % use math or other variants that look better in normal text.
10036 \catcode`\"=\active
10037 \def\activedoublequote{{\tt\char34}}
10038 \let"=\activedoublequote
10039 \catcode`\~=\active \def\activetilde{{\tt\char126}} \let~ = \activetilde
10040 \chardef\hat=`\^
10041 \catcode`\^=\active \def\activehat{{\tt \hat}} \let^ = \activehat
10043 \catcode`\_=\active
10044 \def_{\ifusingtt\normalunderscore\_}
10045 \let\realunder=_
10046 % Subroutine for the previous macro.
10047 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
10049 \catcode`\|=\active
10050 \def|{{\tt\char124}}
10052 \chardef \less=`\<
10053 \catcode`\<=\active \def\activeless{{\tt \less}}\let< = \activeless
10054 \chardef \gtr=`\>
10055 \catcode`\>=\active \def\activegtr{{\tt \gtr}}\let> = \activegtr
10056 \catcode`\+=\active \def+{{\tt \char 43}}
10057 \catcode`\$=\active \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
10059 % used for headline/footline in the output routine, in case the page
10060 % breaks in the middle of an @tex block.
10061 \def\texinfochars{%
10062 \let< = \activeless
10063 \let> = \activegtr
10064 \let~ = \activetilde
10065 \let^ = \activehat
10066 \markupsetuplqdefault \markupsetuprqdefault
10067 \let\b = \strong
10068 \let\i = \smartitalic
10069 % in principle, all other definitions in \tex have to be undone too.
10072 % If a .fmt file is being used, characters that might appear in a file
10073 % name cannot be active until we have parsed the command line.
10074 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
10075 % \otherifyactive is called near the end of this file.
10076 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
10078 % Used sometimes to turn off (effectively) the active characters even after
10079 % parsing them.
10080 \def\turnoffactive{%
10081 \normalturnoffactive
10082 \otherbackslash
10085 \catcode`\@=0
10087 % \backslashcurfont outputs one backslash character in current font,
10088 % as in \char`\\.
10089 \global\chardef\backslashcurfont=`\\
10090 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
10092 % \realbackslash is an actual character `\' with catcode other, and
10093 % \doublebackslash is two of them (for the pdf outlines).
10094 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
10096 % In texinfo, backslash is an active character; it prints the backslash
10097 % in fixed width font.
10098 \catcode`\\=\active % @ for escape char from now on.
10100 % The story here is that in math mode, the \char of \backslashcurfont
10101 % ends up printing the roman \ from the math symbol font (because \char
10102 % in math mode uses the \mathcode, and plain.tex sets
10103 % \mathcode`\\="026E). It seems better for @backslashchar{} to always
10104 % print a typewriter backslash, hence we use an explicit \mathchar,
10105 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
10106 % ignored family value; char position "5C). We can't use " for the
10107 % usual hex value because it has already been made active.
10108 @def@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
10109 @let@backslashchar = @normalbackslash % @backslashchar{} is for user documents.
10111 % On startup, @fixbackslash assigns:
10112 % @let \ = @normalbackslash
10113 % \rawbackslash defines an active \ to do \backslashcurfont.
10114 % \otherbackslash defines an active \ to be a literal `\' character with
10115 % catcode other. We switch back and forth between these.
10116 @gdef@rawbackslash{@let\=@backslashcurfont}
10117 @gdef@otherbackslash{@let\=@realbackslash}
10119 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
10120 % the literal character `\'. Also revert - to its normal character, in
10121 % case the active - from code has slipped in.
10123 {@catcode`- = @active
10124 @gdef@normalturnoffactive{%
10125 @let-=@normaldash
10126 @let"=@normaldoublequote
10127 @let$=@normaldollar %$ font-lock fix
10128 @let+=@normalplus
10129 @let<=@normalless
10130 @let>=@normalgreater
10131 @let\=@normalbackslash
10132 @let^=@normalcaret
10133 @let_=@normalunderscore
10134 @let|=@normalverticalbar
10135 @let~=@normaltilde
10136 @markupsetuplqdefault
10137 @markupsetuprqdefault
10138 @unsepspaces
10142 % Make _ and + \other characters, temporarily.
10143 % This is canceled by @fixbackslash.
10144 @otherifyactive
10146 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
10147 % That is what \eatinput is for; after that, the `\' should revert to printing
10148 % a backslash.
10150 @gdef@eatinput input texinfo{@fixbackslash}
10151 @global@let\ = @eatinput
10153 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
10154 % the first `\' in the file would cause an error. This macro tries to fix
10155 % that, assuming it is called before the first `\' could plausibly occur.
10156 % Also turn back on active characters that might appear in the input
10157 % file name, in case not using a pre-dumped format.
10159 @gdef@fixbackslash{%
10160 @ifx\@eatinput @let\ = @normalbackslash @fi
10161 @catcode`+=@active
10162 @catcode`@_=@active
10165 % Say @foo, not \foo, in error messages.
10166 @escapechar = `@@
10168 % These (along with & and #) are made active for url-breaking, so need
10169 % active definitions as the normal characters.
10170 @def@normaldot{.}
10171 @def@normalquest{?}
10172 @def@normalslash{/}
10174 % These look ok in all fonts, so just make them not special.
10175 % @hashchar{} gets its own user-level command, because of #line.
10176 @catcode`@& = @other @def@normalamp{&}
10177 @catcode`@# = @other @def@normalhash{#}
10178 @catcode`@% = @other @def@normalpercent{%}
10180 @let @hashchar = @normalhash
10182 @c Finally, make ` and ' active, so that txicodequoteundirected and
10183 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
10184 @c don't make ` and ' active, @code will not get them as active chars.
10185 @c Do this last of all since we use ` in the previous @catcode assignments.
10186 @catcode`@'=@active
10187 @catcode`@`=@active
10188 @markupsetuplqdefault
10189 @markupsetuprqdefault
10191 @c Local variables:
10192 @c eval: (add-hook 'write-file-hooks 'time-stamp)
10193 @c page-delimiter: "^\\\\message"
10194 @c time-stamp-start: "def\\\\texinfoversion{"
10195 @c time-stamp-format: "%:y-%02m-%02d.%02H"
10196 @c time-stamp-end: "}"
10197 @c End:
10199 @c vim:sw=2:
10201 @ignore
10202 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
10203 @end ignore