m68k: regenerate libm test ULPs
[glibc.git] / manual / texinfo.tex
bloba06709bedc6e8a98696b5bd0ecdbc63ac518a36e
1 % texinfo.tex -- TeX macros to handle Texinfo files.
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
6 \def\texinfoversion{2013-11-26.10}
8 % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007, 2008, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc.
12 % This texinfo.tex file is free software: you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation, either version 3 of the
15 % License, or (at your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this program. If not, see <http://www.gnu.org/licenses/>.
25 % As a special exception, when this file is read by TeX when processing
26 % a Texinfo source document, you may use the result without
27 % restriction. This Exception is an additional permission under section 7
28 % of the GNU General Public License, version 3 ("GPLv3").
30 % Please try the latest version of texinfo.tex before submitting bug
31 % reports; you can get the latest version from:
32 % http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
33 % http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
34 % http://www.gnu.org/software/texinfo/ (the Texinfo home page)
35 % The texinfo.tex in any given distribution could well be out
36 % of date, so if that's what you're using, please check.
38 % Send bug reports to bug-texinfo@gnu.org. Please include including a
39 % complete document in each bug report with which we can reproduce the
40 % problem. Patches are, of course, greatly appreciated.
42 % To process a Texinfo manual with TeX, it's most reliable to use the
43 % texi2dvi shell script that comes with the distribution. For a simple
44 % manual foo.texi, however, you can get away with this:
45 % tex foo.texi
46 % texindex foo.??
47 % tex foo.texi
48 % tex foo.texi
49 % dvips foo.dvi -o # or whatever; this makes foo.ps.
50 % The extra TeX runs get the cross-reference information correct.
51 % Sometimes one run after texindex suffices, and sometimes you need more
52 % than two; texi2dvi does it as many times as necessary.
54 % It is possible to adapt texinfo.tex for other languages, to some
55 % extent. You can get the existing language-specific files from the
56 % full Texinfo distribution.
58 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
61 \message{Loading texinfo [version \texinfoversion]:}
63 % If in a .fmt file, print the version number
64 % and turn on active characters that we couldn't do earlier because
65 % they might have appeared in the input file name.
66 \everyjob{\message{[Texinfo version \texinfoversion]}%
67 \catcode`+=\active \catcode`\_=\active}
69 \chardef\other=12
71 % We never want plain's \outer definition of \+ in Texinfo.
72 % For @tex, we can use \tabalign.
73 \let\+ = \relax
75 % Save some plain tex macros whose names we will redefine.
76 \let\ptexb=\b
77 \let\ptexbullet=\bullet
78 \let\ptexc=\c
79 \let\ptexcomma=\,
80 \let\ptexdot=\.
81 \let\ptexdots=\dots
82 \let\ptexend=\end
83 \let\ptexequiv=\equiv
84 \let\ptexexclam=\!
85 \let\ptexfootnote=\footnote
86 \let\ptexgtr=>
87 \let\ptexhat=^
88 \let\ptexi=\i
89 \let\ptexindent=\indent
90 \let\ptexinsert=\insert
91 \let\ptexlbrace=\{
92 \let\ptexless=<
93 \let\ptexnewwrite\newwrite
94 \let\ptexnoindent=\noindent
95 \let\ptexplus=+
96 \let\ptexraggedright=\raggedright
97 \let\ptexrbrace=\}
98 \let\ptexslash=\/
99 \let\ptexstar=\*
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{%
1014 \restorefirstparagraphindent
1015 \indent
1017 \gdef\noindent{%
1018 \restorefirstparagraphindent
1019 \noindent
1021 \global\everypar = {%
1022 \kern -\parindent
1023 \restorefirstparagraphindent
1027 \gdef\restorefirstparagraphindent{%
1028 \global \let \indent = \ptexindent
1029 \global \let \noindent = \ptexnoindent
1030 \global \everypar = {}%
1034 % @refill is a no-op.
1035 \let\refill=\relax
1037 % If working on a large document in chapters, it is convenient to
1038 % be able to disable indexing, cross-referencing, and contents, for test runs.
1039 % This is done with @novalidate (before @setfilename).
1041 \newif\iflinks \linkstrue % by default we want the aux files.
1042 \let\novalidate = \linksfalse
1044 % @setfilename is done at the beginning of every texinfo file.
1045 % So open here the files we need to have open while reading the input.
1046 % This makes it possible to make a .fmt file for texinfo.
1047 \def\setfilename{%
1048 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1049 \iflinks
1050 \tryauxfile
1051 % Open the new aux file. TeX will close it automatically at exit.
1052 \immediate\openout\auxfile=\jobname.aux
1053 \fi % \openindices needs to do some work in any case.
1054 \openindices
1055 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1057 % If texinfo.cnf is present on the system, read it.
1058 % Useful for site-wide @afourpaper, etc.
1059 \openin 1 texinfo.cnf
1060 \ifeof 1 \else \input texinfo.cnf \fi
1061 \closein 1
1063 \comment % Ignore the actual filename.
1066 % Called from \setfilename.
1068 \def\openindices{%
1069 \newindex{cp}%
1070 \newcodeindex{fn}%
1071 \newcodeindex{vr}%
1072 \newcodeindex{tp}%
1073 \newcodeindex{ky}%
1074 \newcodeindex{pg}%
1077 % @bye.
1078 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1081 \message{pdf,}
1082 % adobe `portable' document format
1083 \newcount\tempnum
1084 \newcount\lnkcount
1085 \newtoks\filename
1086 \newcount\filenamelength
1087 \newcount\pgn
1088 \newtoks\toksA
1089 \newtoks\toksB
1090 \newtoks\toksC
1091 \newtoks\toksD
1092 \newbox\boxA
1093 \newcount\countA
1094 \newif\ifpdf
1095 \newif\ifpdfmakepagedest
1097 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1098 % can be set). So we test for \relax and 0 as well as being undefined.
1099 \ifx\pdfoutput\thisisundefined
1100 \else
1101 \ifx\pdfoutput\relax
1102 \else
1103 \ifcase\pdfoutput
1104 \else
1105 \pdftrue
1110 % PDF uses PostScript string constants for the names of xref targets,
1111 % for display in the outlines, and in other places. Thus, we have to
1112 % double any backslashes. Otherwise, a name like "\node" will be
1113 % interpreted as a newline (\n), followed by o, d, e. Not good.
1115 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1116 % related messages. The final outcome is that it is up to the TeX user
1117 % to double the backslashes and otherwise make the string valid, so
1118 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1119 % do this reliably, so we use it.
1121 % #1 is a control sequence in which to do the replacements,
1122 % which we \xdef.
1123 \def\txiescapepdf#1{%
1124 \ifx\pdfescapestring\thisisundefined
1125 % No primitive available; should we give a warning or log?
1126 % Many times it won't matter.
1127 \else
1128 % The expandable \pdfescapestring primitive escapes parentheses,
1129 % backslashes, and other special chars.
1130 \xdef#1{\pdfescapestring{#1}}%
1134 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1135 with PDF output, and none of those formats could be found. (.eps cannot
1136 be supported due to the design of the PDF format; use regular TeX (DVI
1137 output) for that.)}
1139 \ifpdf
1141 % Color manipulation macros based on pdfcolor.tex,
1142 % except using rgb instead of cmyk; the latter is said to render as a
1143 % very dark gray on-screen and a very dark halftone in print, instead
1144 % of actual black. The dark red here is dark enough to print on paper as
1145 % nearly black, but still distinguishable for online viewing. We use
1146 % black by default, though.
1147 \def\rgbDarkRed{0.50 0.09 0.12}
1148 \def\rgbBlack{0 0 0}
1150 % k sets the color for filling (usual text, etc.);
1151 % K sets the color for stroking (thin rules, e.g., normal _'s).
1152 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1154 % Set color, and create a mark which defines \thiscolor accordingly,
1155 % so that \makeheadline knows which color to restore.
1156 \def\setcolor#1{%
1157 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1158 \domark
1159 \pdfsetcolor{#1}%
1162 \def\maincolor{\rgbBlack}
1163 \pdfsetcolor{\maincolor}
1164 \edef\thiscolor{\maincolor}
1165 \def\lastcolordefs{}
1167 \def\makefootline{%
1168 \baselineskip24pt
1169 \line{\pdfsetcolor{\maincolor}\the\footline}%
1172 \def\makeheadline{%
1173 \vbox to 0pt{%
1174 \vskip-22.5pt
1175 \line{%
1176 \vbox to8.5pt{}%
1177 % Extract \thiscolor definition from the marks.
1178 \getcolormarks
1179 % Typeset the headline with \maincolor, then restore the color.
1180 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1182 \vss
1184 \nointerlineskip
1188 \pdfcatalog{/PageMode /UseOutlines}
1190 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1191 \def\dopdfimage#1#2#3{%
1192 \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1193 \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1195 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1196 % others). Let's try in that order, PDF first since if
1197 % someone has a scalable image, presumably better to use that than a
1198 % bitmap.
1199 \let\pdfimgext=\empty
1200 \begingroup
1201 \openin 1 #1.pdf \ifeof 1
1202 \openin 1 #1.PDF \ifeof 1
1203 \openin 1 #1.png \ifeof 1
1204 \openin 1 #1.jpg \ifeof 1
1205 \openin 1 #1.jpeg \ifeof 1
1206 \openin 1 #1.JPG \ifeof 1
1207 \errhelp = \nopdfimagehelp
1208 \errmessage{Could not find image file #1 for pdf}%
1209 \else \gdef\pdfimgext{JPG}%
1211 \else \gdef\pdfimgext{jpeg}%
1213 \else \gdef\pdfimgext{jpg}%
1215 \else \gdef\pdfimgext{png}%
1217 \else \gdef\pdfimgext{PDF}%
1219 \else \gdef\pdfimgext{pdf}%
1221 \closein 1
1222 \endgroup
1224 % without \immediate, ancient pdftex seg faults when the same image is
1225 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1226 \ifnum\pdftexversion < 14
1227 \immediate\pdfimage
1228 \else
1229 \immediate\pdfximage
1231 \ifdim \wd0 >0pt width \pdfimagewidth \fi
1232 \ifdim \wd2 >0pt height \pdfimageheight \fi
1233 \ifnum\pdftexversion<13
1234 #1.\pdfimgext
1235 \else
1236 {#1.\pdfimgext}%
1238 \ifnum\pdftexversion < 14 \else
1239 \pdfrefximage \pdflastximage
1240 \fi}
1242 \def\pdfmkdest#1{{%
1243 % We have to set dummies so commands such as @code, and characters
1244 % such as \, aren't expanded when present in a section title.
1245 \indexnofonts
1246 \turnoffactive
1247 \makevalueexpandable
1248 \def\pdfdestname{#1}%
1249 \txiescapepdf\pdfdestname
1250 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1253 % used to mark target names; must be expandable.
1254 \def\pdfmkpgn#1{#1}
1256 % by default, use black for everything.
1257 \def\urlcolor{\rgbBlack}
1258 \def\linkcolor{\rgbBlack}
1259 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1261 % Adding outlines to PDF; macros for calculating structure of outlines
1262 % come from Petr Olsak
1263 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1264 \else \csname#1\endcsname \fi}
1265 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1266 \advance\tempnum by 1
1267 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1269 % #1 is the section text, which is what will be displayed in the
1270 % outline by the pdf viewer. #2 is the pdf expression for the number
1271 % of subentries (or empty, for subsubsections). #3 is the node text,
1272 % which might be empty if this toc entry had no corresponding node.
1273 % #4 is the page number
1275 \def\dopdfoutline#1#2#3#4{%
1276 % Generate a link to the node text if that exists; else, use the
1277 % page number. We could generate a destination for the section
1278 % text in the case where a section has no node, but it doesn't
1279 % seem worth the trouble, since most documents are normally structured.
1280 \edef\pdfoutlinedest{#3}%
1281 \ifx\pdfoutlinedest\empty
1282 \def\pdfoutlinedest{#4}%
1283 \else
1284 \txiescapepdf\pdfoutlinedest
1287 % Also escape PDF chars in the display string.
1288 \edef\pdfoutlinetext{#1}%
1289 \txiescapepdf\pdfoutlinetext
1291 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1294 \def\pdfmakeoutlines{%
1295 \begingroup
1296 % Read toc silently, to get counts of subentries for \pdfoutline.
1297 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1298 \def\numchapentry##1##2##3##4{%
1299 \def\thischapnum{##2}%
1300 \def\thissecnum{0}%
1301 \def\thissubsecnum{0}%
1303 \def\numsecentry##1##2##3##4{%
1304 \advancenumber{chap\thischapnum}%
1305 \def\thissecnum{##2}%
1306 \def\thissubsecnum{0}%
1308 \def\numsubsecentry##1##2##3##4{%
1309 \advancenumber{sec\thissecnum}%
1310 \def\thissubsecnum{##2}%
1312 \def\numsubsubsecentry##1##2##3##4{%
1313 \advancenumber{subsec\thissubsecnum}%
1315 \def\thischapnum{0}%
1316 \def\thissecnum{0}%
1317 \def\thissubsecnum{0}%
1319 % use \def rather than \let here because we redefine \chapentry et
1320 % al. a second time, below.
1321 \def\appentry{\numchapentry}%
1322 \def\appsecentry{\numsecentry}%
1323 \def\appsubsecentry{\numsubsecentry}%
1324 \def\appsubsubsecentry{\numsubsubsecentry}%
1325 \def\unnchapentry{\numchapentry}%
1326 \def\unnsecentry{\numsecentry}%
1327 \def\unnsubsecentry{\numsubsecentry}%
1328 \def\unnsubsubsecentry{\numsubsubsecentry}%
1329 \readdatafile{toc}%
1331 % Read toc second time, this time actually producing the outlines.
1332 % The `-' means take the \expnumber as the absolute number of
1333 % subentries, which we calculated on our first read of the .toc above.
1335 % We use the node names as the destinations.
1336 \def\numchapentry##1##2##3##4{%
1337 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1338 \def\numsecentry##1##2##3##4{%
1339 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1340 \def\numsubsecentry##1##2##3##4{%
1341 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1342 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1343 \dopdfoutline{##1}{}{##3}{##4}}%
1345 % PDF outlines are displayed using system fonts, instead of
1346 % document fonts. Therefore we cannot use special characters,
1347 % since the encoding is unknown. For example, the eogonek from
1348 % Latin 2 (0xea) gets translated to a | character. Info from
1349 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1351 % TODO this right, we have to translate 8-bit characters to
1352 % their "best" equivalent, based on the @documentencoding. Too
1353 % much work for too little return. Just use the ASCII equivalents
1354 % we use for the index sort strings.
1356 \indexnofonts
1357 \setupdatafile
1358 % We can have normal brace characters in the PDF outlines, unlike
1359 % Texinfo index files. So set that up.
1360 \def\{{\lbracecharliteral}%
1361 \def\}{\rbracecharliteral}%
1362 \catcode`\\=\active \otherbackslash
1363 \input \tocreadfilename
1364 \endgroup
1366 {\catcode`[=1 \catcode`]=2
1367 \catcode`{=\other \catcode`}=\other
1368 \gdef\lbracecharliteral[{]%
1369 \gdef\rbracecharliteral[}]%
1372 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1373 \ifx\PP\D\let\nextsp\relax
1374 \else\let\nextsp\skipspaces
1375 \addtokens{\filename}{\PP}%
1376 \advance\filenamelength by 1
1378 \nextsp}
1379 \def\getfilename#1{%
1380 \filenamelength=0
1381 % If we don't expand the argument now, \skipspaces will get
1382 % snagged on things like "@value{foo}".
1383 \edef\temp{#1}%
1384 \expandafter\skipspaces\temp|\relax
1386 \ifnum\pdftexversion < 14
1387 \let \startlink \pdfannotlink
1388 \else
1389 \let \startlink \pdfstartlink
1391 % make a live url in pdf output.
1392 \def\pdfurl#1{%
1393 \begingroup
1394 % it seems we really need yet another set of dummies; have not
1395 % tried to figure out what each command should do in the context
1396 % of @url. for now, just make @/ a no-op, that's the only one
1397 % people have actually reported a problem with.
1399 \normalturnoffactive
1400 \def\@{@}%
1401 \let\/=\empty
1402 \makevalueexpandable
1403 % do we want to go so far as to use \indexnofonts instead of just
1404 % special-casing \var here?
1405 \def\var##1{##1}%
1407 \leavevmode\setcolor{\urlcolor}%
1408 \startlink attr{/Border [0 0 0]}%
1409 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1410 \endgroup}
1411 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1412 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1413 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1414 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1415 \def\maketoks{%
1416 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1417 \ifx\first0\adn0
1418 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1419 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1420 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1421 \else
1422 \ifnum0=\countA\else\makelink\fi
1423 \ifx\first.\let\next=\done\else
1424 \let\next=\maketoks
1425 \addtokens{\toksB}{\the\toksD}
1426 \ifx\first,\addtokens{\toksB}{\space}\fi
1428 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1429 \next}
1430 \def\makelink{\addtokens{\toksB}%
1431 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1432 \def\pdflink#1{%
1433 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1434 \setcolor{\linkcolor}#1\endlink}
1435 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1436 \else
1437 % non-pdf mode
1438 \let\pdfmkdest = \gobble
1439 \let\pdfurl = \gobble
1440 \let\endlink = \relax
1441 \let\setcolor = \gobble
1442 \let\pdfsetcolor = \gobble
1443 \let\pdfmakeoutlines = \relax
1444 \fi % \ifx\pdfoutput
1447 \message{fonts,}
1449 % Change the current font style to #1, remembering it in \curfontstyle.
1450 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1451 % italics, not bold italics.
1453 \def\setfontstyle#1{%
1454 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1455 \csname ten#1\endcsname % change the current font
1458 % Select #1 fonts with the current style.
1460 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1462 \def\rm{\fam=0 \setfontstyle{rm}}
1463 \def\it{\fam=\itfam \setfontstyle{it}}
1464 \def\sl{\fam=\slfam \setfontstyle{sl}}
1465 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1466 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1468 % Unfortunately, we have to override this for titles and the like, since
1469 % in those cases "rm" is bold. Sigh.
1470 \def\rmisbold{\rm\def\curfontstyle{bf}}
1472 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1473 % So we set up a \sf.
1474 \newfam\sffam
1475 \def\sf{\fam=\sffam \setfontstyle{sf}}
1476 \let\li = \sf % Sometimes we call it \li, not \sf.
1478 % We don't need math for this font style.
1479 \def\ttsl{\setfontstyle{ttsl}}
1482 % Set the baselineskip to #1, and the lineskip and strut size
1483 % correspondingly. There is no deep meaning behind these magic numbers
1484 % used as factors; they just match (closely enough) what Knuth defined.
1486 \def\lineskipfactor{.08333}
1487 \def\strutheightpercent{.70833}
1488 \def\strutdepthpercent {.29167}
1490 % can get a sort of poor man's double spacing by redefining this.
1491 \def\baselinefactor{1}
1493 \newdimen\textleading
1494 \def\setleading#1{%
1495 \dimen0 = #1\relax
1496 \normalbaselineskip = \baselinefactor\dimen0
1497 \normallineskip = \lineskipfactor\normalbaselineskip
1498 \normalbaselines
1499 \setbox\strutbox =\hbox{%
1500 \vrule width0pt height\strutheightpercent\baselineskip
1501 depth \strutdepthpercent \baselineskip
1505 % PDF CMaps. See also LaTeX's t1.cmap.
1507 % do nothing with this by default.
1508 \expandafter\let\csname cmapOT1\endcsname\gobble
1509 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1510 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1512 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1513 % (\pdffontattr was introduced many years ago, but people still run
1514 % older pdftex's; it's easy to conditionalize, so we do.)
1515 \ifpdf \ifx\pdffontattr\thisisundefined \else
1516 \begingroup
1517 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1518 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1519 %%DocumentNeededResources: ProcSet (CIDInit)
1520 %%IncludeResource: ProcSet (CIDInit)
1521 %%BeginResource: CMap (TeX-OT1-0)
1522 %%Title: (TeX-OT1-0 TeX OT1 0)
1523 %%Version: 1.000
1524 %%EndComments
1525 /CIDInit /ProcSet findresource begin
1526 12 dict begin
1527 begincmap
1528 /CIDSystemInfo
1529 << /Registry (TeX)
1530 /Ordering (OT1)
1531 /Supplement 0
1532 >> def
1533 /CMapName /TeX-OT1-0 def
1534 /CMapType 2 def
1535 1 begincodespacerange
1536 <00> <7F>
1537 endcodespacerange
1538 8 beginbfrange
1539 <00> <01> <0393>
1540 <09> <0A> <03A8>
1541 <23> <26> <0023>
1542 <28> <3B> <0028>
1543 <3F> <5B> <003F>
1544 <5D> <5E> <005D>
1545 <61> <7A> <0061>
1546 <7B> <7C> <2013>
1547 endbfrange
1548 40 beginbfchar
1549 <02> <0398>
1550 <03> <039B>
1551 <04> <039E>
1552 <05> <03A0>
1553 <06> <03A3>
1554 <07> <03D2>
1555 <08> <03A6>
1556 <0B> <00660066>
1557 <0C> <00660069>
1558 <0D> <0066006C>
1559 <0E> <006600660069>
1560 <0F> <00660066006C>
1561 <10> <0131>
1562 <11> <0237>
1563 <12> <0060>
1564 <13> <00B4>
1565 <14> <02C7>
1566 <15> <02D8>
1567 <16> <00AF>
1568 <17> <02DA>
1569 <18> <00B8>
1570 <19> <00DF>
1571 <1A> <00E6>
1572 <1B> <0153>
1573 <1C> <00F8>
1574 <1D> <00C6>
1575 <1E> <0152>
1576 <1F> <00D8>
1577 <21> <0021>
1578 <22> <201D>
1579 <27> <2019>
1580 <3C> <00A1>
1581 <3D> <003D>
1582 <3E> <00BF>
1583 <5C> <201C>
1584 <5F> <02D9>
1585 <60> <2018>
1586 <7D> <02DD>
1587 <7E> <007E>
1588 <7F> <00A8>
1589 endbfchar
1590 endcmap
1591 CMapName currentdict /CMap defineresource pop
1594 %%EndResource
1595 %%EOF
1596 }\endgroup
1597 \expandafter\edef\csname cmapOT1\endcsname#1{%
1598 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1601 % \cmapOT1IT
1602 \begingroup
1603 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1604 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1605 %%DocumentNeededResources: ProcSet (CIDInit)
1606 %%IncludeResource: ProcSet (CIDInit)
1607 %%BeginResource: CMap (TeX-OT1IT-0)
1608 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1609 %%Version: 1.000
1610 %%EndComments
1611 /CIDInit /ProcSet findresource begin
1612 12 dict begin
1613 begincmap
1614 /CIDSystemInfo
1615 << /Registry (TeX)
1616 /Ordering (OT1IT)
1617 /Supplement 0
1618 >> def
1619 /CMapName /TeX-OT1IT-0 def
1620 /CMapType 2 def
1621 1 begincodespacerange
1622 <00> <7F>
1623 endcodespacerange
1624 8 beginbfrange
1625 <00> <01> <0393>
1626 <09> <0A> <03A8>
1627 <25> <26> <0025>
1628 <28> <3B> <0028>
1629 <3F> <5B> <003F>
1630 <5D> <5E> <005D>
1631 <61> <7A> <0061>
1632 <7B> <7C> <2013>
1633 endbfrange
1634 42 beginbfchar
1635 <02> <0398>
1636 <03> <039B>
1637 <04> <039E>
1638 <05> <03A0>
1639 <06> <03A3>
1640 <07> <03D2>
1641 <08> <03A6>
1642 <0B> <00660066>
1643 <0C> <00660069>
1644 <0D> <0066006C>
1645 <0E> <006600660069>
1646 <0F> <00660066006C>
1647 <10> <0131>
1648 <11> <0237>
1649 <12> <0060>
1650 <13> <00B4>
1651 <14> <02C7>
1652 <15> <02D8>
1653 <16> <00AF>
1654 <17> <02DA>
1655 <18> <00B8>
1656 <19> <00DF>
1657 <1A> <00E6>
1658 <1B> <0153>
1659 <1C> <00F8>
1660 <1D> <00C6>
1661 <1E> <0152>
1662 <1F> <00D8>
1663 <21> <0021>
1664 <22> <201D>
1665 <23> <0023>
1666 <24> <00A3>
1667 <27> <2019>
1668 <3C> <00A1>
1669 <3D> <003D>
1670 <3E> <00BF>
1671 <5C> <201C>
1672 <5F> <02D9>
1673 <60> <2018>
1674 <7D> <02DD>
1675 <7E> <007E>
1676 <7F> <00A8>
1677 endbfchar
1678 endcmap
1679 CMapName currentdict /CMap defineresource pop
1682 %%EndResource
1683 %%EOF
1684 }\endgroup
1685 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1686 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1689 % \cmapOT1TT
1690 \begingroup
1691 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1692 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1693 %%DocumentNeededResources: ProcSet (CIDInit)
1694 %%IncludeResource: ProcSet (CIDInit)
1695 %%BeginResource: CMap (TeX-OT1TT-0)
1696 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1697 %%Version: 1.000
1698 %%EndComments
1699 /CIDInit /ProcSet findresource begin
1700 12 dict begin
1701 begincmap
1702 /CIDSystemInfo
1703 << /Registry (TeX)
1704 /Ordering (OT1TT)
1705 /Supplement 0
1706 >> def
1707 /CMapName /TeX-OT1TT-0 def
1708 /CMapType 2 def
1709 1 begincodespacerange
1710 <00> <7F>
1711 endcodespacerange
1712 5 beginbfrange
1713 <00> <01> <0393>
1714 <09> <0A> <03A8>
1715 <21> <26> <0021>
1716 <28> <5F> <0028>
1717 <61> <7E> <0061>
1718 endbfrange
1719 32 beginbfchar
1720 <02> <0398>
1721 <03> <039B>
1722 <04> <039E>
1723 <05> <03A0>
1724 <06> <03A3>
1725 <07> <03D2>
1726 <08> <03A6>
1727 <0B> <2191>
1728 <0C> <2193>
1729 <0D> <0027>
1730 <0E> <00A1>
1731 <0F> <00BF>
1732 <10> <0131>
1733 <11> <0237>
1734 <12> <0060>
1735 <13> <00B4>
1736 <14> <02C7>
1737 <15> <02D8>
1738 <16> <00AF>
1739 <17> <02DA>
1740 <18> <00B8>
1741 <19> <00DF>
1742 <1A> <00E6>
1743 <1B> <0153>
1744 <1C> <00F8>
1745 <1D> <00C6>
1746 <1E> <0152>
1747 <1F> <00D8>
1748 <20> <2423>
1749 <27> <2019>
1750 <60> <2018>
1751 <7F> <00A8>
1752 endbfchar
1753 endcmap
1754 CMapName currentdict /CMap defineresource pop
1757 %%EndResource
1758 %%EOF
1759 }\endgroup
1760 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1761 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1763 \fi\fi
1766 % Set the font macro #1 to the font named \fontprefix#2.
1767 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1768 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
1769 % Example:
1770 % #1 = \textrm
1771 % #2 = \rmshape
1772 % #3 = 10
1773 % #4 = \mainmagstep
1774 % #5 = OT1
1776 \def\setfont#1#2#3#4#5{%
1777 \font#1=\fontprefix#2#3 scaled #4
1778 \csname cmap#5\endcsname#1%
1780 % This is what gets called when #5 of \setfont is empty.
1781 \let\cmap\gobble
1783 % (end of cmaps)
1785 % Use cm as the default font prefix.
1786 % To specify the font prefix, you must define \fontprefix
1787 % before you read in texinfo.tex.
1788 \ifx\fontprefix\thisisundefined
1789 \def\fontprefix{cm}
1791 % Support font families that don't use the same naming scheme as CM.
1792 \def\rmshape{r}
1793 \def\rmbshape{bx} % where the normal face is bold
1794 \def\bfshape{b}
1795 \def\bxshape{bx}
1796 \def\ttshape{tt}
1797 \def\ttbshape{tt}
1798 \def\ttslshape{sltt}
1799 \def\itshape{ti}
1800 \def\itbshape{bxti}
1801 \def\slshape{sl}
1802 \def\slbshape{bxsl}
1803 \def\sfshape{ss}
1804 \def\sfbshape{ss}
1805 \def\scshape{csc}
1806 \def\scbshape{csc}
1808 % Definitions for a main text size of 11pt. (The default in Texinfo.)
1810 \def\definetextfontsizexi{%
1811 % Text fonts (11.2pt, magstep1).
1812 \def\textnominalsize{11pt}
1813 \edef\mainmagstep{\magstephalf}
1814 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1815 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1816 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1817 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1818 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1819 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1820 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1821 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1822 \font\texti=cmmi10 scaled \mainmagstep
1823 \font\textsy=cmsy10 scaled \mainmagstep
1824 \def\textecsize{1095}
1826 % A few fonts for @defun names and args.
1827 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1828 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1829 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1830 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1832 % Fonts for indices, footnotes, small examples (9pt).
1833 \def\smallnominalsize{9pt}
1834 \setfont\smallrm\rmshape{9}{1000}{OT1}
1835 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1836 \setfont\smallbf\bfshape{10}{900}{OT1}
1837 \setfont\smallit\itshape{9}{1000}{OT1IT}
1838 \setfont\smallsl\slshape{9}{1000}{OT1}
1839 \setfont\smallsf\sfshape{9}{1000}{OT1}
1840 \setfont\smallsc\scshape{10}{900}{OT1}
1841 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1842 \font\smalli=cmmi9
1843 \font\smallsy=cmsy9
1844 \def\smallecsize{0900}
1846 % Fonts for small examples (8pt).
1847 \def\smallernominalsize{8pt}
1848 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1849 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1850 \setfont\smallerbf\bfshape{10}{800}{OT1}
1851 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1852 \setfont\smallersl\slshape{8}{1000}{OT1}
1853 \setfont\smallersf\sfshape{8}{1000}{OT1}
1854 \setfont\smallersc\scshape{10}{800}{OT1}
1855 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1856 \font\smalleri=cmmi8
1857 \font\smallersy=cmsy8
1858 \def\smallerecsize{0800}
1860 % Fonts for title page (20.4pt):
1861 \def\titlenominalsize{20pt}
1862 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1863 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1864 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1865 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1866 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1867 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1868 \let\titlebf=\titlerm
1869 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1870 \font\titlei=cmmi12 scaled \magstep3
1871 \font\titlesy=cmsy10 scaled \magstep4
1872 \def\titleecsize{2074}
1874 % Chapter (and unnumbered) fonts (17.28pt).
1875 \def\chapnominalsize{17pt}
1876 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1877 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1878 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1879 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1880 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1881 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1882 \let\chapbf=\chaprm
1883 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1884 \font\chapi=cmmi12 scaled \magstep2
1885 \font\chapsy=cmsy10 scaled \magstep3
1886 \def\chapecsize{1728}
1888 % Section fonts (14.4pt).
1889 \def\secnominalsize{14pt}
1890 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1891 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1892 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1893 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1894 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1895 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1896 \let\secbf\secrm
1897 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1898 \font\seci=cmmi12 scaled \magstep1
1899 \font\secsy=cmsy10 scaled \magstep2
1900 \def\sececsize{1440}
1902 % Subsection fonts (13.15pt).
1903 \def\ssecnominalsize{13pt}
1904 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1905 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1906 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1907 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1908 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1909 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1910 \let\ssecbf\ssecrm
1911 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1912 \font\sseci=cmmi12 scaled \magstephalf
1913 \font\ssecsy=cmsy10 scaled 1315
1914 \def\ssececsize{1200}
1916 % Reduced fonts for @acro in text (10pt).
1917 \def\reducednominalsize{10pt}
1918 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1919 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1920 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1921 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1922 \setfont\reducedsl\slshape{10}{1000}{OT1}
1923 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1924 \setfont\reducedsc\scshape{10}{1000}{OT1}
1925 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1926 \font\reducedi=cmmi10
1927 \font\reducedsy=cmsy10
1928 \def\reducedecsize{1000}
1930 \textleading = 13.2pt % line spacing for 11pt CM
1931 \textfonts % reset the current fonts
1933 } % end of 11pt text font size definitions, \definetextfontsizexi
1936 % Definitions to make the main text be 10pt Computer Modern, with
1937 % section, chapter, etc., sizes following suit. This is for the GNU
1938 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1939 % future. Used with @smallbook, which sets the leading to 12pt.
1941 \def\definetextfontsizex{%
1942 % Text fonts (10pt).
1943 \def\textnominalsize{10pt}
1944 \edef\mainmagstep{1000}
1945 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1946 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1947 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1948 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1949 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1950 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1951 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1952 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1953 \font\texti=cmmi10 scaled \mainmagstep
1954 \font\textsy=cmsy10 scaled \mainmagstep
1955 \def\textecsize{1000}
1957 % A few fonts for @defun names and args.
1958 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
1959 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
1960 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
1961 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1963 % Fonts for indices, footnotes, small examples (9pt).
1964 \def\smallnominalsize{9pt}
1965 \setfont\smallrm\rmshape{9}{1000}{OT1}
1966 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1967 \setfont\smallbf\bfshape{10}{900}{OT1}
1968 \setfont\smallit\itshape{9}{1000}{OT1IT}
1969 \setfont\smallsl\slshape{9}{1000}{OT1}
1970 \setfont\smallsf\sfshape{9}{1000}{OT1}
1971 \setfont\smallsc\scshape{10}{900}{OT1}
1972 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1973 \font\smalli=cmmi9
1974 \font\smallsy=cmsy9
1975 \def\smallecsize{0900}
1977 % Fonts for small examples (8pt).
1978 \def\smallernominalsize{8pt}
1979 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1980 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1981 \setfont\smallerbf\bfshape{10}{800}{OT1}
1982 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1983 \setfont\smallersl\slshape{8}{1000}{OT1}
1984 \setfont\smallersf\sfshape{8}{1000}{OT1}
1985 \setfont\smallersc\scshape{10}{800}{OT1}
1986 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1987 \font\smalleri=cmmi8
1988 \font\smallersy=cmsy8
1989 \def\smallerecsize{0800}
1991 % Fonts for title page (20.4pt):
1992 \def\titlenominalsize{20pt}
1993 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1994 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1995 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1996 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1997 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1998 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1999 \let\titlebf=\titlerm
2000 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2001 \font\titlei=cmmi12 scaled \magstep3
2002 \font\titlesy=cmsy10 scaled \magstep4
2003 \def\titleecsize{2074}
2005 % Chapter fonts (14.4pt).
2006 \def\chapnominalsize{14pt}
2007 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2008 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2009 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2010 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2011 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2012 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2013 \let\chapbf\chaprm
2014 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2015 \font\chapi=cmmi12 scaled \magstep1
2016 \font\chapsy=cmsy10 scaled \magstep2
2017 \def\chapecsize{1440}
2019 % Section fonts (12pt).
2020 \def\secnominalsize{12pt}
2021 \setfont\secrm\rmbshape{12}{1000}{OT1}
2022 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2023 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2024 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2025 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2026 \setfont\secsf\sfbshape{12}{1000}{OT1}
2027 \let\secbf\secrm
2028 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2029 \font\seci=cmmi12
2030 \font\secsy=cmsy10 scaled \magstep1
2031 \def\sececsize{1200}
2033 % Subsection fonts (10pt).
2034 \def\ssecnominalsize{10pt}
2035 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2036 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2037 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2038 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2039 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2040 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2041 \let\ssecbf\ssecrm
2042 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2043 \font\sseci=cmmi10
2044 \font\ssecsy=cmsy10
2045 \def\ssececsize{1000}
2047 % Reduced fonts for @acro in text (9pt).
2048 \def\reducednominalsize{9pt}
2049 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2050 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2051 \setfont\reducedbf\bfshape{10}{900}{OT1}
2052 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2053 \setfont\reducedsl\slshape{9}{1000}{OT1}
2054 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2055 \setfont\reducedsc\scshape{10}{900}{OT1}
2056 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2057 \font\reducedi=cmmi9
2058 \font\reducedsy=cmsy9
2059 \def\reducedecsize{0900}
2061 \divide\parskip by 2 % reduce space between paragraphs
2062 \textleading = 12pt % line spacing for 10pt CM
2063 \textfonts % reset the current fonts
2065 } % end of 10pt text font size definitions, \definetextfontsizex
2068 % We provide the user-level command
2069 % @fonttextsize 10
2070 % (or 11) to redefine the text font size. pt is assumed.
2072 \def\xiword{11}
2073 \def\xword{10}
2074 \def\xwordpt{10pt}
2076 \parseargdef\fonttextsize{%
2077 \def\textsizearg{#1}%
2078 %\wlog{doing @fonttextsize \textsizearg}%
2080 % Set \globaldefs so that documents can use this inside @tex, since
2081 % makeinfo 4.8 does not support it, but we need it nonetheless.
2083 \begingroup \globaldefs=1
2084 \ifx\textsizearg\xword \definetextfontsizex
2085 \else \ifx\textsizearg\xiword \definetextfontsizexi
2086 \else
2087 \errhelp=\EMsimple
2088 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2089 \fi\fi
2090 \endgroup
2094 % In order for the font changes to affect most math symbols and letters,
2095 % we have to define the \textfont of the standard families. Since
2096 % texinfo doesn't allow for producing subscripts and superscripts except
2097 % in the main text, we don't bother to reset \scriptfont and
2098 % \scriptscriptfont (which would also require loading a lot more fonts).
2100 \def\resetmathfonts{%
2101 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2102 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2103 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2106 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2107 % of just \STYLE. We do this because \STYLE needs to also set the
2108 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2109 % \tenSTYLE to set the current font.
2111 % Each font-changing command also sets the names \lsize (one size lower)
2112 % and \lllsize (three sizes lower). These relative commands are used in
2113 % the LaTeX logo and acronyms.
2115 % This all needs generalizing, badly.
2117 \def\textfonts{%
2118 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2119 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2120 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2121 \let\tenttsl=\textttsl
2122 \def\curfontsize{text}%
2123 \def\lsize{reduced}\def\lllsize{smaller}%
2124 \resetmathfonts \setleading{\textleading}}
2125 \def\titlefonts{%
2126 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2127 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2128 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2129 \let\tenttsl=\titlettsl
2130 \def\curfontsize{title}%
2131 \def\lsize{chap}\def\lllsize{subsec}%
2132 \resetmathfonts \setleading{27pt}}
2133 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2134 \def\chapfonts{%
2135 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2136 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2137 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2138 \let\tenttsl=\chapttsl
2139 \def\curfontsize{chap}%
2140 \def\lsize{sec}\def\lllsize{text}%
2141 \resetmathfonts \setleading{19pt}}
2142 \def\secfonts{%
2143 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2144 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2145 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2146 \let\tenttsl=\secttsl
2147 \def\curfontsize{sec}%
2148 \def\lsize{subsec}\def\lllsize{reduced}%
2149 \resetmathfonts \setleading{16pt}}
2150 \def\subsecfonts{%
2151 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2152 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2153 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2154 \let\tenttsl=\ssecttsl
2155 \def\curfontsize{ssec}%
2156 \def\lsize{text}\def\lllsize{small}%
2157 \resetmathfonts \setleading{15pt}}
2158 \let\subsubsecfonts = \subsecfonts
2159 \def\reducedfonts{%
2160 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2161 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2162 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2163 \let\tenttsl=\reducedttsl
2164 \def\curfontsize{reduced}%
2165 \def\lsize{small}\def\lllsize{smaller}%
2166 \resetmathfonts \setleading{10.5pt}}
2167 \def\smallfonts{%
2168 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2169 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2170 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2171 \let\tenttsl=\smallttsl
2172 \def\curfontsize{small}%
2173 \def\lsize{smaller}\def\lllsize{smaller}%
2174 \resetmathfonts \setleading{10.5pt}}
2175 \def\smallerfonts{%
2176 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2177 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2178 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2179 \let\tenttsl=\smallerttsl
2180 \def\curfontsize{smaller}%
2181 \def\lsize{smaller}\def\lllsize{smaller}%
2182 \resetmathfonts \setleading{9.5pt}}
2184 % Fonts for short table of contents.
2185 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2186 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2187 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2188 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2190 % Define these just so they can be easily changed for other fonts.
2191 \def\angleleft{$\langle$}
2192 \def\angleright{$\rangle$}
2194 % Set the fonts to use with the @small... environments.
2195 \let\smallexamplefonts = \smallfonts
2197 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2198 % can fit this many characters:
2199 % 8.5x11=86 smallbook=72 a4=90 a5=69
2200 % If we use \scriptfonts (8pt), then we can fit this many characters:
2201 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2202 % For me, subjectively, the few extra characters that fit aren't worth
2203 % the additional smallness of 8pt. So I'm making the default 9pt.
2205 % By the way, for comparison, here's what fits with @example (10pt):
2206 % 8.5x11=71 smallbook=60 a4=75 a5=58
2207 % --karl, 24jan03.
2209 % Set up the default fonts, so we can use them for creating boxes.
2211 \definetextfontsizexi
2214 \message{markup,}
2216 % Check if we are currently using a typewriter font. Since all the
2217 % Computer Modern typewriter fonts have zero interword stretch (and
2218 % shrink), and it is reasonable to expect all typewriter fonts to have
2219 % this property, we can check that font parameter.
2221 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2223 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2224 % define and register \INITMACRO to be called on markup style changes.
2225 % \INITMACRO can check \currentmarkupstyle for the innermost
2226 % style and the set of \ifmarkupSTYLE switches for all styles
2227 % currently in effect.
2228 \newif\ifmarkupvar
2229 \newif\ifmarkupsamp
2230 \newif\ifmarkupkey
2231 %\newif\ifmarkupfile % @file == @samp.
2232 %\newif\ifmarkupoption % @option == @samp.
2233 \newif\ifmarkupcode
2234 \newif\ifmarkupkbd
2235 %\newif\ifmarkupenv % @env == @code.
2236 %\newif\ifmarkupcommand % @command == @code.
2237 \newif\ifmarkuptex % @tex (and part of @math, for now).
2238 \newif\ifmarkupexample
2239 \newif\ifmarkupverb
2240 \newif\ifmarkupverbatim
2242 \let\currentmarkupstyle\empty
2244 \def\setupmarkupstyle#1{%
2245 \csname markup#1true\endcsname
2246 \def\currentmarkupstyle{#1}%
2247 \markupstylesetup
2250 \let\markupstylesetup\empty
2252 \def\defmarkupstylesetup#1{%
2253 \expandafter\def\expandafter\markupstylesetup
2254 \expandafter{\markupstylesetup #1}%
2255 \def#1%
2258 % Markup style setup for left and right quotes.
2259 \defmarkupstylesetup\markupsetuplq{%
2260 \expandafter\let\expandafter \temp
2261 \csname markupsetuplq\currentmarkupstyle\endcsname
2262 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2265 \defmarkupstylesetup\markupsetuprq{%
2266 \expandafter\let\expandafter \temp
2267 \csname markupsetuprq\currentmarkupstyle\endcsname
2268 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2272 \catcode`\'=\active
2273 \catcode`\`=\active
2275 \gdef\markupsetuplqdefault{\let`\lq}
2276 \gdef\markupsetuprqdefault{\let'\rq}
2278 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2279 \gdef\markupsetcodequoteright{\let'\codequoteright}
2282 \let\markupsetuplqcode \markupsetcodequoteleft
2283 \let\markupsetuprqcode \markupsetcodequoteright
2285 \let\markupsetuplqexample \markupsetcodequoteleft
2286 \let\markupsetuprqexample \markupsetcodequoteright
2288 \let\markupsetuplqkbd \markupsetcodequoteleft
2289 \let\markupsetuprqkbd \markupsetcodequoteright
2291 \let\markupsetuplqsamp \markupsetcodequoteleft
2292 \let\markupsetuprqsamp \markupsetcodequoteright
2294 \let\markupsetuplqverb \markupsetcodequoteleft
2295 \let\markupsetuprqverb \markupsetcodequoteright
2297 \let\markupsetuplqverbatim \markupsetcodequoteleft
2298 \let\markupsetuprqverbatim \markupsetcodequoteright
2300 % Allow an option to not use regular directed right quote/apostrophe
2301 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2302 % The undirected quote is ugly, so don't make it the default, but it
2303 % works for pasting with more pdf viewers (at least evince), the
2304 % lilypond developers report. xpdf does work with the regular 0x27.
2306 \def\codequoteright{%
2307 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2308 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2310 \else \char'15 \fi
2311 \else \char'15 \fi
2314 % and a similar option for the left quote char vs. a grave accent.
2315 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2316 % the code environments to do likewise.
2318 \def\codequoteleft{%
2319 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2320 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2321 % [Knuth] pp. 380,381,391
2322 % \relax disables Spanish ligatures ?` and !` of \tt font.
2323 \relax`%
2324 \else \char'22 \fi
2325 \else \char'22 \fi
2328 % Commands to set the quote options.
2330 \parseargdef\codequoteundirected{%
2331 \def\temp{#1}%
2332 \ifx\temp\onword
2333 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2334 = t%
2335 \else\ifx\temp\offword
2336 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2337 = \relax
2338 \else
2339 \errhelp = \EMsimple
2340 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2341 \fi\fi
2344 \parseargdef\codequotebacktick{%
2345 \def\temp{#1}%
2346 \ifx\temp\onword
2347 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2348 = t%
2349 \else\ifx\temp\offword
2350 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2351 = \relax
2352 \else
2353 \errhelp = \EMsimple
2354 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2355 \fi\fi
2358 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2359 \def\noligaturesquoteleft{\relax\lq}
2361 % Count depth in font-changes, for error checks
2362 \newcount\fontdepth \fontdepth=0
2364 % Font commands.
2366 % #1 is the font command (\sl or \it), #2 is the text to slant.
2367 % If we are in a monospaced environment, however, 1) always use \ttsl,
2368 % and 2) do not add an italic correction.
2369 \def\dosmartslant#1#2{%
2370 \ifusingtt
2371 {{\ttsl #2}\let\next=\relax}%
2372 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2373 \next
2375 \def\smartslanted{\dosmartslant\sl}
2376 \def\smartitalic{\dosmartslant\it}
2378 % Output an italic correction unless \next (presumed to be the following
2379 % character) is such as not to need one.
2380 \def\smartitaliccorrection{%
2381 \ifx\next,%
2382 \else\ifx\next-%
2383 \else\ifx\next.%
2384 \else\ifx\next\.%
2385 \else\ifx\next\comma%
2386 \else\ptexslash
2387 \fi\fi\fi\fi\fi
2388 \aftersmartic
2391 % Unconditional use \ttsl, and no ic. @var is set to this for defuns.
2392 \def\ttslanted#1{{\ttsl #1}}
2394 % @cite is like \smartslanted except unconditionally use \sl. We never want
2395 % ttsl for book titles, do we?
2396 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2398 \def\aftersmartic{}
2399 \def\var#1{%
2400 \let\saveaftersmartic = \aftersmartic
2401 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2402 \smartslanted{#1}%
2405 \let\i=\smartitalic
2406 \let\slanted=\smartslanted
2407 \let\dfn=\smartslanted
2408 \let\emph=\smartitalic
2410 % Explicit font changes: @r, @sc, undocumented @ii.
2411 \def\r#1{{\rm #1}} % roman font
2412 \def\sc#1{{\smallcaps#1}} % smallcaps font
2413 \def\ii#1{{\it #1}} % italic font
2415 % @b, explicit bold. Also @strong.
2416 \def\b#1{{\bf #1}}
2417 \let\strong=\b
2419 % @sansserif, explicit sans.
2420 \def\sansserif#1{{\sf #1}}
2422 % We can't just use \exhyphenpenalty, because that only has effect at
2423 % the end of a paragraph. Restore normal hyphenation at the end of the
2424 % group within which \nohyphenation is presumably called.
2426 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2427 \def\restorehyphenation{\hyphenchar\font = `- }
2429 % Set sfcode to normal for the chars that usually have another value.
2430 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2431 % sometimes \x has an active definition that messes things up.
2433 \catcode`@=11
2434 \def\plainfrenchspacing{%
2435 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2436 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2437 \def\endofsentencespacefactor{1000}% for @. and friends
2439 \def\plainnonfrenchspacing{%
2440 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2441 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2442 \def\endofsentencespacefactor{3000}% for @. and friends
2444 \catcode`@=\other
2445 \def\endofsentencespacefactor{3000}% default
2447 % @t, explicit typewriter.
2448 \def\t#1{%
2449 {\tt \rawbackslash \plainfrenchspacing #1}%
2450 \null
2453 % @samp.
2454 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2456 % @indicateurl is \samp, that is, with quotes.
2457 \let\indicateurl=\samp
2459 % @code (and similar) prints in typewriter, but with spaces the same
2460 % size as normal in the surrounding text, without hyphenation, etc.
2461 % This is a subroutine for that.
2462 \def\tclose#1{%
2464 % Change normal interword space to be same as for the current font.
2465 \spaceskip = \fontdimen2\font
2467 % Switch to typewriter.
2470 % But `\ ' produces the large typewriter interword space.
2471 \def\ {{\spaceskip = 0pt{} }}%
2473 % Turn off hyphenation.
2474 \nohyphenation
2476 \rawbackslash
2477 \plainfrenchspacing
2480 \null % reset spacefactor to 1000
2483 % We *must* turn on hyphenation at `-' and `_' in @code.
2484 % (But see \codedashfinish below.)
2485 % Otherwise, it is too hard to avoid overfull hboxes
2486 % in the Emacs manual, the Library manual, etc.
2488 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2489 % both hyphenation at - and hyphenation within words.
2490 % We must therefore turn them both off (\tclose does that)
2491 % and arrange explicitly to hyphenate at a dash. -- rms.
2493 \catcode`\-=\active \catcode`\_=\active
2494 \catcode`\'=\active \catcode`\`=\active
2495 \global\let'=\rq \global\let`=\lq % default definitions
2497 \global\def\code{\begingroup
2498 \setupmarkupstyle{code}%
2499 % The following should really be moved into \setupmarkupstyle handlers.
2500 \catcode\dashChar=\active \catcode\underChar=\active
2501 \ifallowcodebreaks
2502 \let-\codedash
2503 \let_\codeunder
2504 \else
2505 \let-\normaldash
2506 \let_\realunder
2508 % Given -foo (with a single dash), we do not want to allow a break
2509 % after the hyphen.
2510 \global\let\codedashprev=\codedash
2512 \codex
2515 \gdef\codedash{\futurelet\next\codedashfinish}
2516 \gdef\codedashfinish{%
2517 \normaldash % always output the dash character itself.
2519 % Now, output a discretionary to allow a line break, unless
2520 % (a) the next character is a -, or
2521 % (b) the preceding character is a -.
2522 % E.g., given --posix, we do not want to allow a break after either -.
2523 % Given --foo-bar, we do want to allow a break between the - and the b.
2524 \ifx\next\codedash \else
2525 \ifx\codedashprev\codedash
2526 \else \discretionary{}{}{}\fi
2528 % we need the space after the = for the case when \next itself is a
2529 % space token; it would get swallowed otherwise. As in @code{- a}.
2530 \global\let\codedashprev= \next
2533 \def\normaldash{-}
2535 \def\codex #1{\tclose{#1}\endgroup}
2537 \def\codeunder{%
2538 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2539 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2540 % will therefore expand the active definition of _, which is us
2541 % (inside @code that is), therefore an endless loop.
2542 \ifusingtt{\ifmmode
2543 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2544 \else\normalunderscore \fi
2545 \discretionary{}{}{}}%
2546 {\_}%
2549 % An additional complication: the above will allow breaks after, e.g.,
2550 % each of the four underscores in __typeof__. This is bad.
2551 % @allowcodebreaks provides a document-level way to turn breaking at -
2552 % and _ on and off.
2554 \newif\ifallowcodebreaks \allowcodebreakstrue
2556 \def\keywordtrue{true}
2557 \def\keywordfalse{false}
2559 \parseargdef\allowcodebreaks{%
2560 \def\txiarg{#1}%
2561 \ifx\txiarg\keywordtrue
2562 \allowcodebreakstrue
2563 \else\ifx\txiarg\keywordfalse
2564 \allowcodebreaksfalse
2565 \else
2566 \errhelp = \EMsimple
2567 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2568 \fi\fi
2571 % For @command, @env, @file, @option quotes seem unnecessary,
2572 % so use \code rather than \samp.
2573 \let\command=\code
2574 \let\env=\code
2575 \let\file=\code
2576 \let\option=\code
2578 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2579 % second argument specifying the text to display and an optional third
2580 % arg as text to display instead of (rather than in addition to) the url
2581 % itself. First (mandatory) arg is the url.
2583 % secret option to allow changing PDF output to show only the second
2584 % arg (if given), and not the url (which is then just the link target).
2585 \newif\ifurefurlonlylink
2587 % The main macro is \urefbreak, which allows breaking at expected
2588 % places within the url. (There used to be another version, which
2589 % didn't support automatic breaking.)
2590 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2591 \let\uref=\urefbreak
2593 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
2594 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
2595 \unsepspaces
2596 \pdfurl{#1}%
2597 \setbox0 = \hbox{\ignorespaces #3}%
2598 \ifdim\wd0 > 0pt
2599 \unhbox0 % third arg given, show only that
2600 \else
2601 \setbox0 = \hbox{\ignorespaces #2}% look for second arg
2602 \ifdim\wd0 > 0pt
2603 \ifpdf
2604 \ifurefurlonlylink
2605 % PDF plus option to not display url, show just arg
2606 \unhbox0
2607 \else
2608 % PDF, normally display both arg and url for consistency,
2609 % visibility, if the pdf is eventually used to print, etc.
2610 \unhbox0\ (\urefcode{#1})%
2612 \else
2613 \unhbox0\ (\urefcode{#1})% DVI, always show arg and url
2615 \else
2616 \urefcode{#1}% only url given, so show it
2619 \endlink
2620 \endgroup}
2622 % Allow line breaks around only a few characters (only).
2623 \def\urefcatcodes{%
2624 \catcode\ampChar=\active \catcode\dotChar=\active
2625 \catcode\hashChar=\active \catcode\questChar=\active
2626 \catcode\slashChar=\active
2629 \urefcatcodes
2631 \global\def\urefcode{\begingroup
2632 \setupmarkupstyle{code}%
2633 \urefcatcodes
2634 \let&\urefcodeamp
2635 \let.\urefcodedot
2636 \let#\urefcodehash
2637 \let?\urefcodequest
2638 \let/\urefcodeslash
2639 \codex
2642 % By default, they are just regular characters.
2643 \global\def&{\normalamp}
2644 \global\def.{\normaldot}
2645 \global\def#{\normalhash}
2646 \global\def?{\normalquest}
2647 \global\def/{\normalslash}
2650 % we put a little stretch before and after the breakable chars, to help
2651 % line breaking of long url's. The unequal skips make look better in
2652 % cmtt at least, especially for dots.
2653 \def\urefprestretch{\urefprebreak \hskip0pt plus.13em }
2654 \def\urefpoststretch{\urefpostbreak \hskip0pt plus.1em }
2656 \def\urefcodeamp{\urefprestretch \&\urefpoststretch}
2657 \def\urefcodedot{\urefprestretch .\urefpoststretch}
2658 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
2659 \def\urefcodequest{\urefprestretch ?\urefpoststretch}
2660 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2662 \catcode`\/=\active
2663 \global\def\urefcodeslashfinish{%
2664 \urefprestretch \slashChar
2665 % Allow line break only after the final / in a sequence of
2666 % slashes, to avoid line break between the slashes in http://.
2667 \ifx\next/\else \urefpoststretch \fi
2671 % One more complication: by default we'll break after the special
2672 % characters, but some people like to break before the special chars, so
2673 % allow that. Also allow no breaking at all, for manual control.
2675 \parseargdef\urefbreakstyle{%
2676 \def\txiarg{#1}%
2677 \ifx\txiarg\wordnone
2678 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2679 \else\ifx\txiarg\wordbefore
2680 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2681 \else\ifx\txiarg\wordafter
2682 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2683 \else
2684 \errhelp = \EMsimple
2685 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
2686 \fi\fi\fi
2688 \def\wordafter{after}
2689 \def\wordbefore{before}
2690 \def\wordnone{none}
2692 \urefbreakstyle after
2694 % @url synonym for @uref, since that's how everyone uses it.
2696 \let\url=\uref
2698 % rms does not like angle brackets --karl, 17may97.
2699 % So now @email is just like @uref, unless we are pdf.
2701 %\def\email#1{\angleleft{\tt #1}\angleright}
2702 \ifpdf
2703 \def\email#1{\doemail#1,,\finish}
2704 \def\doemail#1,#2,#3\finish{\begingroup
2705 \unsepspaces
2706 \pdfurl{mailto:#1}%
2707 \setbox0 = \hbox{\ignorespaces #2}%
2708 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2709 \endlink
2710 \endgroup}
2711 \else
2712 \let\email=\uref
2715 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2716 % `example' (@kbd uses ttsl only inside of @example and friends),
2717 % or `code' (@kbd uses normal tty font always).
2718 \parseargdef\kbdinputstyle{%
2719 \def\txiarg{#1}%
2720 \ifx\txiarg\worddistinct
2721 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2722 \else\ifx\txiarg\wordexample
2723 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2724 \else\ifx\txiarg\wordcode
2725 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2726 \else
2727 \errhelp = \EMsimple
2728 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
2729 \fi\fi\fi
2731 \def\worddistinct{distinct}
2732 \def\wordexample{example}
2733 \def\wordcode{code}
2735 % Default is `distinct'.
2736 \kbdinputstyle distinct
2738 % @kbd is like @code, except that if the argument is just one @key command,
2739 % then @kbd has no effect.
2740 \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}}
2742 \def\xkey{\key}
2743 \def\kbdsub#1#2#3\par{%
2744 \def\one{#1}\def\three{#3}\def\threex{??}%
2745 \ifx\one\xkey\ifx\threex\three \key{#2}%
2746 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2747 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2750 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2751 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2752 %\font\keysy=cmsy9
2753 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2754 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2755 % \vbox{\hrule\kern-0.4pt
2756 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2757 % \kern-0.4pt\hrule}%
2758 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2760 % definition of @key with no lozenge. If the current font is already
2761 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2762 % if it isn't monospace, then use \tt.
2764 \def\key#1{{\setupmarkupstyle{key}%
2765 \nohyphenation
2766 \ifmonospace\else\tt\fi
2767 #1}\null}
2769 % @clicksequence{File @click{} Open ...}
2770 \def\clicksequence#1{\begingroup #1\endgroup}
2772 % @clickstyle @arrow (by default)
2773 \parseargdef\clickstyle{\def\click{#1}}
2774 \def\click{\arrow}
2776 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2777 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2779 \def\dmn#1{\thinspace #1}
2781 % @l was never documented to mean ``switch to the Lisp font'',
2782 % and it is not used as such in any manual I can find. We need it for
2783 % Polish suppressed-l. --karl, 22sep96.
2784 %\def\l#1{{\li #1}\null}
2786 % @acronym for "FBI", "NATO", and the like.
2787 % We print this one point size smaller, since it's intended for
2788 % all-uppercase.
2790 \def\acronym#1{\doacronym #1,,\finish}
2791 \def\doacronym#1,#2,#3\finish{%
2792 {\selectfonts\lsize #1}%
2793 \def\temp{#2}%
2794 \ifx\temp\empty \else
2795 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2797 \null % reset \spacefactor=1000
2800 % @abbr for "Comput. J." and the like.
2801 % No font change, but don't do end-of-sentence spacing.
2803 \def\abbr#1{\doabbr #1,,\finish}
2804 \def\doabbr#1,#2,#3\finish{%
2805 {\plainfrenchspacing #1}%
2806 \def\temp{#2}%
2807 \ifx\temp\empty \else
2808 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2810 \null % reset \spacefactor=1000
2813 % @asis just yields its argument. Used with @table, for example.
2815 \def\asis#1{#1}
2817 % @math outputs its argument in math mode.
2819 % One complication: _ usually means subscripts, but it could also mean
2820 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2821 % _ active, and distinguish by seeing if the current family is \slfam,
2822 % which is what @var uses.
2824 \catcode`\_ = \active
2825 \gdef\mathunderscore{%
2826 \catcode`\_=\active
2827 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
2830 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2831 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2832 % particular reason), but this is not advertised and we don't care.
2834 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2835 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
2837 \def\math{%
2838 \tex
2839 \mathunderscore
2840 \let\\ = \mathbackslash
2841 \mathactive
2842 % make the texinfo accent commands work in math mode
2843 \let\"=\ddot
2844 \let\'=\acute
2845 \let\==\bar
2846 \let\^=\hat
2847 \let\`=\grave
2848 \let\u=\breve
2849 \let\v=\check
2850 \let\~=\tilde
2851 \let\dotaccent=\dot
2852 $\finishmath
2854 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
2856 % Some active characters (such as <) are spaced differently in math.
2857 % We have to reset their definitions in case the @math was an argument
2858 % to a command which sets the catcodes (such as @item or @section).
2861 \catcode`^ = \active
2862 \catcode`< = \active
2863 \catcode`> = \active
2864 \catcode`+ = \active
2865 \catcode`' = \active
2866 \gdef\mathactive{%
2867 \let^ = \ptexhat
2868 \let< = \ptexless
2869 \let> = \ptexgtr
2870 \let+ = \ptexplus
2871 \let' = \ptexquoteright
2875 % ctrl is no longer a Texinfo command, but leave this definition for fun.
2876 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2878 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
2879 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
2880 % except specified as a normal braced arg, so no newlines to worry about.
2882 \def\outfmtnametex{tex}
2884 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
2885 \long\def\doinlinefmt#1,#2,\finish{%
2886 \def\inlinefmtname{#1}%
2887 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
2890 % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
2891 % FMTNAME is tex, else ELSE-TEXT.
2892 \long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,\finish}
2893 \long\def\doinlinefmtifelse#1,#2,#3,#4,\finish{%
2894 \def\inlinefmtname{#1}%
2895 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
2898 % For raw, must switch into @tex before parsing the argument, to avoid
2899 % setting catcodes prematurely. Doing it this way means that, for
2900 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
2901 % ignored. But this isn't important because if people want a literal
2902 % *right* brace they would have to use a command anyway, so they may as
2903 % well use a command to get a left brace too. We could re-use the
2904 % delimiter character idea from \verb, but it seems like overkill.
2906 \long\def\inlineraw{\tex \doinlineraw}
2907 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
2908 \def\doinlinerawtwo#1,#2,\finish{%
2909 \def\inlinerawname{#1}%
2910 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
2911 \endgroup % close group opened by \tex.
2914 % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
2916 \long\def\inlineifset#1{\doinlineifset #1,\finish}
2917 \long\def\doinlineifset#1,#2,\finish{%
2918 \def\inlinevarname{#1}%
2919 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax
2920 \else\ignorespaces#2\fi
2923 % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
2925 \long\def\inlineifclear#1{\doinlineifclear #1,\finish}
2926 \long\def\doinlineifclear#1,#2,\finish{%
2927 \def\inlinevarname{#1}%
2928 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \ignorespaces#2\fi
2932 \message{glyphs,}
2933 % and logos.
2935 % @@ prints an @, as does @atchar{}.
2936 \def\@{\char64 }
2937 \let\atchar=\@
2939 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
2940 % Unless we're in typewriter, use \ecfont because the CM text fonts do
2941 % not have braces, and we don't want to switch into math.
2942 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2943 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2944 \let\{=\mylbrace \let\lbracechar=\{
2945 \let\}=\myrbrace \let\rbracechar=\}
2946 \begingroup
2947 % Definitions to produce \{ and \} commands for indices,
2948 % and @{ and @} for the aux/toc files.
2949 \catcode`\{ = \other \catcode`\} = \other
2950 \catcode`\[ = 1 \catcode`\] = 2
2951 \catcode`\! = 0 \catcode`\\ = \other
2952 !gdef!lbracecmd[\{]%
2953 !gdef!rbracecmd[\}]%
2954 !gdef!lbraceatcmd[@{]%
2955 !gdef!rbraceatcmd[@}]%
2956 !endgroup
2958 % @comma{} to avoid , parsing problems.
2959 \let\comma = ,
2961 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2962 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2963 \let\, = \ptexc
2964 \let\dotaccent = \ptexdot
2965 \def\ringaccent#1{{\accent23 #1}}
2966 \let\tieaccent = \ptext
2967 \let\ubaraccent = \ptexb
2968 \let\udotaccent = \d
2970 % Other special characters: @questiondown @exclamdown @ordf @ordm
2971 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2972 \def\questiondown{?`}
2973 \def\exclamdown{!`}
2974 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
2975 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
2977 % Dotless i and dotless j, used for accents.
2978 \def\imacro{i}
2979 \def\jmacro{j}
2980 \def\dotless#1{%
2981 \def\temp{#1}%
2982 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2983 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2984 \else \errmessage{@dotless can be used only with i or j}%
2985 \fi\fi
2988 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2989 % period following counts as ending a sentence. (Idea found in latex.)
2991 \edef\TeX{\TeX \spacefactor=1000 }
2993 % @LaTeX{} logo. Not quite the same results as the definition in
2994 % latex.ltx, since we use a different font for the raised A; it's most
2995 % convenient for us to use an explicitly smaller font, rather than using
2996 % the \scriptstyle font (since we don't reset \scriptstyle and
2997 % \scriptscriptstyle).
2999 \def\LaTeX{%
3000 L\kern-.36em
3001 {\setbox0=\hbox{T}%
3002 \vbox to \ht0{\hbox{%
3003 \ifx\textnominalsize\xwordpt
3004 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
3005 % Revert to plain's \scriptsize, which is 7pt.
3006 \count255=\the\fam $\fam\count255 \scriptstyle A$%
3007 \else
3008 % For 11pt, we can use our lllsize.
3009 \selectfonts\lllsize A%
3012 \vss
3014 \kern-.15em
3015 \TeX
3018 % Some math mode symbols.
3019 \def\bullet{$\ptexbullet$}
3020 \def\geq{\ifmmode \ge\else $\ge$\fi}
3021 \def\leq{\ifmmode \le\else $\le$\fi}
3022 \def\minus{\ifmmode -\else $-$\fi}
3024 % @dots{} outputs an ellipsis using the current font.
3025 % We do .5em per period so that it has the same spacing in the cm
3026 % typewriter fonts as three actual period characters; on the other hand,
3027 % in other typewriter fonts three periods are wider than 1.5em. So do
3028 % whichever is larger.
3030 \def\dots{%
3031 \leavevmode
3032 \setbox0=\hbox{...}% get width of three periods
3033 \ifdim\wd0 > 1.5em
3034 \dimen0 = \wd0
3035 \else
3036 \dimen0 = 1.5em
3038 \hbox to \dimen0{%
3039 \hskip 0pt plus.25fil
3040 .\hskip 0pt plus1fil
3041 .\hskip 0pt plus1fil
3042 .\hskip 0pt plus.5fil
3046 % @enddots{} is an end-of-sentence ellipsis.
3048 \def\enddots{%
3049 \dots
3050 \spacefactor=\endofsentencespacefactor
3053 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3055 % Since these characters are used in examples, they should be an even number of
3056 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3058 \def\point{$\star$}
3059 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3060 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3061 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3062 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3063 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3065 % The @error{} command.
3066 % Adapted from the TeXbook's \boxit.
3068 \newbox\errorbox
3070 {\tentt \global\dimen0 = 3em}% Width of the box.
3071 \dimen2 = .55pt % Thickness of rules
3072 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3073 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
3075 \setbox\errorbox=\hbox to \dimen0{\hfil
3076 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3077 \advance\hsize by -2\dimen2 % Rules.
3078 \vbox{%
3079 \hrule height\dimen2
3080 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3081 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3082 \kern3pt\vrule width\dimen2}% Space to right.
3083 \hrule height\dimen2}
3084 \hfil}
3086 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3088 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3090 \def\pounds{{\it\$}}
3092 % @euro{} comes from a separate font, depending on the current style.
3093 % We use the free feym* fonts from the eurosym package by Henrik
3094 % Theiling, which support regular, slanted, bold and bold slanted (and
3095 % "outlined" (blackboard board, sort of) versions, which we don't need).
3096 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3098 % Although only regular is the truly official Euro symbol, we ignore
3099 % that. The Euro is designed to be slightly taller than the regular
3100 % font height.
3102 % feymr - regular
3103 % feymo - slanted
3104 % feybr - bold
3105 % feybo - bold slanted
3107 % There is no good (free) typewriter version, to my knowledge.
3108 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3109 % Hmm.
3111 % Also doesn't work in math. Do we need to do math with euro symbols?
3112 % Hope not.
3115 \def\euro{{\eurofont e}}
3116 \def\eurofont{%
3117 % We set the font at each command, rather than predefining it in
3118 % \textfonts and the other font-switching commands, so that
3119 % installations which never need the symbol don't have to have the
3120 % font installed.
3122 % There is only one designed size (nominal 10pt), so we always scale
3123 % that to the current nominal size.
3125 % By the way, simply using "at 1em" works for cmr10 and the like, but
3126 % does not work for cmbx10 and other extended/shrunken fonts.
3128 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3130 \ifx\curfontstyle\bfstylename
3131 % bold:
3132 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3133 \else
3134 % regular:
3135 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3137 \thiseurofont
3140 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3141 % sometimes we redefine the original macro, and the alias should reflect
3142 % the redefinition.
3144 % Use LaTeX names for the Icelandic letters.
3145 \def\DH{{\ecfont \char"D0}} % Eth
3146 \def\dh{{\ecfont \char"F0}} % eth
3147 \def\TH{{\ecfont \char"DE}} % Thorn
3148 \def\th{{\ecfont \char"FE}} % thorn
3150 \def\guillemetleft{{\ecfont \char"13}}
3151 \def\guillemotleft{\guillemetleft}
3152 \def\guillemetright{{\ecfont \char"14}}
3153 \def\guillemotright{\guillemetright}
3154 \def\guilsinglleft{{\ecfont \char"0E}}
3155 \def\guilsinglright{{\ecfont \char"0F}}
3156 \def\quotedblbase{{\ecfont \char"12}}
3157 \def\quotesinglbase{{\ecfont \char"0D}}
3159 % This positioning is not perfect (see the ogonek LaTeX package), but
3160 % we have the precomposed glyphs for the most common cases. We put the
3161 % tests to use those glyphs in the single \ogonek macro so we have fewer
3162 % dummy definitions to worry about for index entries, etc.
3164 % ogonek is also used with other letters in Lithuanian (IOU), but using
3165 % the precomposed glyphs for those is not so easy since they aren't in
3166 % the same EC font.
3167 \def\ogonek#1{{%
3168 \def\temp{#1}%
3169 \ifx\temp\macrocharA\Aogonek
3170 \else\ifx\temp\macrochara\aogonek
3171 \else\ifx\temp\macrocharE\Eogonek
3172 \else\ifx\temp\macrochare\eogonek
3173 \else
3174 \ecfont \setbox0=\hbox{#1}%
3175 \ifdim\ht0=1ex\accent"0C #1%
3176 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3178 \fi\fi\fi\fi
3181 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3182 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3183 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3184 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3186 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
3187 \def\ecfont{%
3188 % We can't distinguish serif/sans and italic/slanted, but this
3189 % is used for crude hacks anyway (like adding French and German
3190 % quotes to documents typeset with CM, where we lose kerning), so
3191 % hopefully nobody will notice/care.
3192 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3193 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3194 \ifmonospace
3195 % typewriter:
3196 \font\thisecfont = ectt\ecsize \space at \nominalsize
3197 \else
3198 \ifx\curfontstyle\bfstylename
3199 % bold:
3200 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
3201 \else
3202 % regular:
3203 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3206 \thisecfont
3209 % @registeredsymbol - R in a circle. The font for the R should really
3210 % be smaller yet, but lllsize is the best we can do for now.
3211 % Adapted from the plain.tex definition of \copyright.
3213 \def\registeredsymbol{%
3214 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
3215 \hfil\crcr\Orb}}%
3219 % @textdegree - the normal degrees sign.
3221 \def\textdegree{$^\circ$}
3223 % Laurent Siebenmann reports \Orb undefined with:
3224 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3225 % so we'll define it if necessary.
3227 \ifx\Orb\thisisundefined
3228 \def\Orb{\mathhexbox20D}
3231 % Quotes.
3232 \chardef\quotedblleft="5C
3233 \chardef\quotedblright=`\"
3234 \chardef\quoteleft=`\`
3235 \chardef\quoteright=`\'
3238 \message{page headings,}
3240 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3241 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3243 % First the title page. Must do @settitle before @titlepage.
3244 \newif\ifseenauthor
3245 \newif\iffinishedtitlepage
3247 % Do an implicit @contents or @shortcontents after @end titlepage if the
3248 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3250 \newif\ifsetcontentsaftertitlepage
3251 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3252 \newif\ifsetshortcontentsaftertitlepage
3253 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3255 \parseargdef\shorttitlepage{%
3256 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3257 \endgroup\page\hbox{}\page}
3259 \envdef\titlepage{%
3260 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3261 \begingroup
3262 \parindent=0pt \textfonts
3263 % Leave some space at the very top of the page.
3264 \vglue\titlepagetopglue
3265 % No rule at page bottom unless we print one at the top with @title.
3266 \finishedtitlepagetrue
3268 % Most title ``pages'' are actually two pages long, with space
3269 % at the top of the second. We don't want the ragged left on the second.
3270 \let\oldpage = \page
3271 \def\page{%
3272 \iffinishedtitlepage\else
3273 \finishtitlepage
3275 \let\page = \oldpage
3276 \page
3277 \null
3281 \def\Etitlepage{%
3282 \iffinishedtitlepage\else
3283 \finishtitlepage
3285 % It is important to do the page break before ending the group,
3286 % because the headline and footline are only empty inside the group.
3287 % If we use the new definition of \page, we always get a blank page
3288 % after the title page, which we certainly don't want.
3289 \oldpage
3290 \endgroup
3292 % Need this before the \...aftertitlepage checks so that if they are
3293 % in effect the toc pages will come out with page numbers.
3294 \HEADINGSon
3296 % If they want short, they certainly want long too.
3297 \ifsetshortcontentsaftertitlepage
3298 \shortcontents
3299 \contents
3300 \global\let\shortcontents = \relax
3301 \global\let\contents = \relax
3304 \ifsetcontentsaftertitlepage
3305 \contents
3306 \global\let\contents = \relax
3307 \global\let\shortcontents = \relax
3311 \def\finishtitlepage{%
3312 \vskip4pt \hrule height 2pt width \hsize
3313 \vskip\titlepagebottomglue
3314 \finishedtitlepagetrue
3317 % Settings used for typesetting titles: no hyphenation, no indentation,
3318 % don't worry much about spacing, ragged right. This should be used
3319 % inside a \vbox, and fonts need to be set appropriately first. Because
3320 % it is always used for titles, nothing else, we call \rmisbold. \par
3321 % should be specified before the end of the \vbox, since a vbox is a group.
3323 \def\raggedtitlesettings{%
3324 \rmisbold
3325 \hyphenpenalty=10000
3326 \parindent=0pt
3327 \tolerance=5000
3328 \ptexraggedright
3331 % Macros to be used within @titlepage:
3333 \let\subtitlerm=\tenrm
3334 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3336 \parseargdef\title{%
3337 \checkenv\titlepage
3338 \vbox{\titlefonts \raggedtitlesettings #1\par}%
3339 % print a rule at the page bottom also.
3340 \finishedtitlepagefalse
3341 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3344 \parseargdef\subtitle{%
3345 \checkenv\titlepage
3346 {\subtitlefont \rightline{#1}}%
3349 % @author should come last, but may come many times.
3350 % It can also be used inside @quotation.
3352 \parseargdef\author{%
3353 \def\temp{\quotation}%
3354 \ifx\thisenv\temp
3355 \def\quotationauthor{#1}% printed in \Equotation.
3356 \else
3357 \checkenv\titlepage
3358 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3359 {\secfonts\rmisbold \leftline{#1}}%
3364 % Set up page headings and footings.
3366 \let\thispage=\folio
3368 \newtoks\evenheadline % headline on even pages
3369 \newtoks\oddheadline % headline on odd pages
3370 \newtoks\evenfootline % footline on even pages
3371 \newtoks\oddfootline % footline on odd pages
3373 % Now make TeX use those variables
3374 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3375 \else \the\evenheadline \fi}}
3376 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3377 \else \the\evenfootline \fi}\HEADINGShook}
3378 \let\HEADINGShook=\relax
3380 % Commands to set those variables.
3381 % For example, this is what @headings on does
3382 % @evenheading @thistitle|@thispage|@thischapter
3383 % @oddheading @thischapter|@thispage|@thistitle
3384 % @evenfooting @thisfile||
3385 % @oddfooting ||@thisfile
3388 \def\evenheading{\parsearg\evenheadingxxx}
3389 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3390 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3391 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3393 \def\oddheading{\parsearg\oddheadingxxx}
3394 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3395 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3396 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3398 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3400 \def\evenfooting{\parsearg\evenfootingxxx}
3401 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3402 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3403 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3405 \def\oddfooting{\parsearg\oddfootingxxx}
3406 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3407 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3408 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3410 % Leave some space for the footline. Hopefully ok to assume
3411 % @evenfooting will not be used by itself.
3412 \global\advance\pageheight by -12pt
3413 \global\advance\vsize by -12pt
3416 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3418 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3419 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3421 % The same set of arguments for:
3423 % @oddheadingmarks
3424 % @evenfootingmarks
3425 % @oddfootingmarks
3426 % @everyheadingmarks
3427 % @everyfootingmarks
3429 \def\evenheadingmarks{\headingmarks{even}{heading}}
3430 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3431 \def\evenfootingmarks{\headingmarks{even}{footing}}
3432 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3433 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3434 \headingmarks{odd}{heading}{#1} }
3435 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3436 \headingmarks{odd}{footing}{#1} }
3437 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3438 \def\headingmarks#1#2#3 {%
3439 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3440 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3443 \everyheadingmarks bottom
3444 \everyfootingmarks bottom
3446 % @headings double turns headings on for double-sided printing.
3447 % @headings single turns headings on for single-sided printing.
3448 % @headings off turns them off.
3449 % @headings on same as @headings double, retained for compatibility.
3450 % @headings after turns on double-sided headings after this page.
3451 % @headings doubleafter turns on double-sided headings after this page.
3452 % @headings singleafter turns on single-sided headings after this page.
3453 % By default, they are off at the start of a document,
3454 % and turned `on' after @end titlepage.
3456 \def\headings #1 {\csname HEADINGS#1\endcsname}
3458 \def\headingsoff{% non-global headings elimination
3459 \evenheadline={\hfil}\evenfootline={\hfil}%
3460 \oddheadline={\hfil}\oddfootline={\hfil}%
3463 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3464 \HEADINGSoff % it's the default
3466 % When we turn headings on, set the page number to 1.
3467 % For double-sided printing, put current file name in lower left corner,
3468 % chapter name on inside top of right hand pages, document
3469 % title on inside top of left hand pages, and page numbers on outside top
3470 % edge of all pages.
3471 \def\HEADINGSdouble{%
3472 \global\pageno=1
3473 \global\evenfootline={\hfil}
3474 \global\oddfootline={\hfil}
3475 \global\evenheadline={\line{\folio\hfil\thistitle}}
3476 \global\oddheadline={\line{\thischapter\hfil\folio}}
3477 \global\let\contentsalignmacro = \chapoddpage
3479 \let\contentsalignmacro = \chappager
3481 % For single-sided printing, chapter title goes across top left of page,
3482 % page number on top right.
3483 \def\HEADINGSsingle{%
3484 \global\pageno=1
3485 \global\evenfootline={\hfil}
3486 \global\oddfootline={\hfil}
3487 \global\evenheadline={\line{\thischapter\hfil\folio}}
3488 \global\oddheadline={\line{\thischapter\hfil\folio}}
3489 \global\let\contentsalignmacro = \chappager
3491 \def\HEADINGSon{\HEADINGSdouble}
3493 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3494 \let\HEADINGSdoubleafter=\HEADINGSafter
3495 \def\HEADINGSdoublex{%
3496 \global\evenfootline={\hfil}
3497 \global\oddfootline={\hfil}
3498 \global\evenheadline={\line{\folio\hfil\thistitle}}
3499 \global\oddheadline={\line{\thischapter\hfil\folio}}
3500 \global\let\contentsalignmacro = \chapoddpage
3503 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3504 \def\HEADINGSsinglex{%
3505 \global\evenfootline={\hfil}
3506 \global\oddfootline={\hfil}
3507 \global\evenheadline={\line{\thischapter\hfil\folio}}
3508 \global\oddheadline={\line{\thischapter\hfil\folio}}
3509 \global\let\contentsalignmacro = \chappager
3512 % Subroutines used in generating headings
3513 % This produces Day Month Year style of output.
3514 % Only define if not already defined, in case a txi-??.tex file has set
3515 % up a different format (e.g., txi-cs.tex does this).
3516 \ifx\today\thisisundefined
3517 \def\today{%
3518 \number\day\space
3519 \ifcase\month
3520 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3521 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3522 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3524 \space\number\year}
3527 % @settitle line... specifies the title of the document, for headings.
3528 % It generates no output of its own.
3529 \def\thistitle{\putwordNoTitle}
3530 \def\settitle{\parsearg{\gdef\thistitle}}
3533 \message{tables,}
3534 % Tables -- @table, @ftable, @vtable, @item(x).
3536 % default indentation of table text
3537 \newdimen\tableindent \tableindent=.8in
3538 % default indentation of @itemize and @enumerate text
3539 \newdimen\itemindent \itemindent=.3in
3540 % margin between end of table item and start of table text.
3541 \newdimen\itemmargin \itemmargin=.1in
3543 % used internally for \itemindent minus \itemmargin
3544 \newdimen\itemmax
3546 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3547 % these defs.
3548 % They also define \itemindex
3549 % to index the item name in whatever manner is desired (perhaps none).
3551 \newif\ifitemxneedsnegativevskip
3553 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3555 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3556 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3558 \def\itemzzz #1{\begingroup %
3559 \advance\hsize by -\rightskip
3560 \advance\hsize by -\tableindent
3561 \setbox0=\hbox{\itemindicate{#1}}%
3562 \itemindex{#1}%
3563 \nobreak % This prevents a break before @itemx.
3565 % If the item text does not fit in the space we have, put it on a line
3566 % by itself, and do not allow a page break either before or after that
3567 % line. We do not start a paragraph here because then if the next
3568 % command is, e.g., @kindex, the whatsit would get put into the
3569 % horizontal list on a line by itself, resulting in extra blank space.
3570 \ifdim \wd0>\itemmax
3572 % Make this a paragraph so we get the \parskip glue and wrapping,
3573 % but leave it ragged-right.
3574 \begingroup
3575 \advance\leftskip by-\tableindent
3576 \advance\hsize by\tableindent
3577 \advance\rightskip by0pt plus1fil\relax
3578 \leavevmode\unhbox0\par
3579 \endgroup
3581 % We're going to be starting a paragraph, but we don't want the
3582 % \parskip glue -- logically it's part of the @item we just started.
3583 \nobreak \vskip-\parskip
3585 % Stop a page break at the \parskip glue coming up. However, if
3586 % what follows is an environment such as @example, there will be no
3587 % \parskip glue; then the negative vskip we just inserted would
3588 % cause the example and the item to crash together. So we use this
3589 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3590 % \parskip glue after all. Section titles are handled this way also.
3592 \penalty 10001
3593 \endgroup
3594 \itemxneedsnegativevskipfalse
3595 \else
3596 % The item text fits into the space. Start a paragraph, so that the
3597 % following text (if any) will end up on the same line.
3598 \noindent
3599 % Do this with kerns and \unhbox so that if there is a footnote in
3600 % the item text, it can migrate to the main vertical list and
3601 % eventually be printed.
3602 \nobreak\kern-\tableindent
3603 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3604 \unhbox0
3605 \nobreak\kern\dimen0
3606 \endgroup
3607 \itemxneedsnegativevskiptrue
3611 \def\item{\errmessage{@item while not in a list environment}}
3612 \def\itemx{\errmessage{@itemx while not in a list environment}}
3614 % @table, @ftable, @vtable.
3615 \envdef\table{%
3616 \let\itemindex\gobble
3617 \tablecheck{table}%
3619 \envdef\ftable{%
3620 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3621 \tablecheck{ftable}%
3623 \envdef\vtable{%
3624 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3625 \tablecheck{vtable}%
3627 \def\tablecheck#1{%
3628 \ifnum \the\catcode`\^^M=\active
3629 \endgroup
3630 \errmessage{This command won't work in this context; perhaps the problem is
3631 that we are \inenvironment\thisenv}%
3632 \def\next{\doignore{#1}}%
3633 \else
3634 \let\next\tablex
3636 \next
3638 \def\tablex#1{%
3639 \def\itemindicate{#1}%
3640 \parsearg\tabley
3642 \def\tabley#1{%
3644 \makevalueexpandable
3645 \edef\temp{\noexpand\tablez #1\space\space\space}%
3646 \expandafter
3647 }\temp \endtablez
3649 \def\tablez #1 #2 #3 #4\endtablez{%
3650 \aboveenvbreak
3651 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3652 \ifnum 0#2>0 \tableindent=#2\mil \fi
3653 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3654 \itemmax=\tableindent
3655 \advance \itemmax by -\itemmargin
3656 \advance \leftskip by \tableindent
3657 \exdentamount=\tableindent
3658 \parindent = 0pt
3659 \parskip = \smallskipamount
3660 \ifdim \parskip=0pt \parskip=2pt \fi
3661 \let\item = \internalBitem
3662 \let\itemx = \internalBitemx
3664 \def\Etable{\endgraf\afterenvbreak}
3665 \let\Eftable\Etable
3666 \let\Evtable\Etable
3667 \let\Eitemize\Etable
3668 \let\Eenumerate\Etable
3670 % This is the counter used by @enumerate, which is really @itemize
3672 \newcount \itemno
3674 \envdef\itemize{\parsearg\doitemize}
3676 \def\doitemize#1{%
3677 \aboveenvbreak
3678 \itemmax=\itemindent
3679 \advance\itemmax by -\itemmargin
3680 \advance\leftskip by \itemindent
3681 \exdentamount=\itemindent
3682 \parindent=0pt
3683 \parskip=\smallskipamount
3684 \ifdim\parskip=0pt \parskip=2pt \fi
3686 % Try typesetting the item mark so that if the document erroneously says
3687 % something like @itemize @samp (intending @table), there's an error
3688 % right away at the @itemize. It's not the best error message in the
3689 % world, but it's better than leaving it to the @item. This means if
3690 % the user wants an empty mark, they have to say @w{} not just @w.
3691 \def\itemcontents{#1}%
3692 \setbox0 = \hbox{\itemcontents}%
3694 % @itemize with no arg is equivalent to @itemize @bullet.
3695 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3697 \let\item=\itemizeitem
3700 % Definition of @item while inside @itemize and @enumerate.
3702 \def\itemizeitem{%
3703 \advance\itemno by 1 % for enumerations
3704 {\let\par=\endgraf \smallbreak}% reasonable place to break
3706 % If the document has an @itemize directly after a section title, a
3707 % \nobreak will be last on the list, and \sectionheading will have
3708 % done a \vskip-\parskip. In that case, we don't want to zero
3709 % parskip, or the item text will crash with the heading. On the
3710 % other hand, when there is normal text preceding the item (as there
3711 % usually is), we do want to zero parskip, or there would be too much
3712 % space. In that case, we won't have a \nobreak before. At least
3713 % that's the theory.
3714 \ifnum\lastpenalty<10000 \parskip=0in \fi
3715 \noindent
3716 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3718 \vadjust{\penalty 1200}}% not good to break after first line of item.
3719 \flushcr
3722 % \splitoff TOKENS\endmark defines \first to be the first token in
3723 % TOKENS, and \rest to be the remainder.
3725 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3727 % Allow an optional argument of an uppercase letter, lowercase letter,
3728 % or number, to specify the first label in the enumerated list. No
3729 % argument is the same as `1'.
3731 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3732 \def\enumeratey #1 #2\endenumeratey{%
3733 % If we were given no argument, pretend we were given `1'.
3734 \def\thearg{#1}%
3735 \ifx\thearg\empty \def\thearg{1}\fi
3737 % Detect if the argument is a single token. If so, it might be a
3738 % letter. Otherwise, the only valid thing it can be is a number.
3739 % (We will always have one token, because of the test we just made.
3740 % This is a good thing, since \splitoff doesn't work given nothing at
3741 % all -- the first parameter is undelimited.)
3742 \expandafter\splitoff\thearg\endmark
3743 \ifx\rest\empty
3744 % Only one token in the argument. It could still be anything.
3745 % A ``lowercase letter'' is one whose \lccode is nonzero.
3746 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3747 % not equal to itself.
3748 % Otherwise, we assume it's a number.
3750 % We need the \relax at the end of the \ifnum lines to stop TeX from
3751 % continuing to look for a <number>.
3753 \ifnum\lccode\expandafter`\thearg=0\relax
3754 \numericenumerate % a number (we hope)
3755 \else
3756 % It's a letter.
3757 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3758 \lowercaseenumerate % lowercase letter
3759 \else
3760 \uppercaseenumerate % uppercase letter
3763 \else
3764 % Multiple tokens in the argument. We hope it's a number.
3765 \numericenumerate
3769 % An @enumerate whose labels are integers. The starting integer is
3770 % given in \thearg.
3772 \def\numericenumerate{%
3773 \itemno = \thearg
3774 \startenumeration{\the\itemno}%
3777 % The starting (lowercase) letter is in \thearg.
3778 \def\lowercaseenumerate{%
3779 \itemno = \expandafter`\thearg
3780 \startenumeration{%
3781 % Be sure we're not beyond the end of the alphabet.
3782 \ifnum\itemno=0
3783 \errmessage{No more lowercase letters in @enumerate; get a bigger
3784 alphabet}%
3786 \char\lccode\itemno
3790 % The starting (uppercase) letter is in \thearg.
3791 \def\uppercaseenumerate{%
3792 \itemno = \expandafter`\thearg
3793 \startenumeration{%
3794 % Be sure we're not beyond the end of the alphabet.
3795 \ifnum\itemno=0
3796 \errmessage{No more uppercase letters in @enumerate; get a bigger
3797 alphabet}
3799 \char\uccode\itemno
3803 % Call \doitemize, adding a period to the first argument and supplying the
3804 % common last two arguments. Also subtract one from the initial value in
3805 % \itemno, since @item increments \itemno.
3807 \def\startenumeration#1{%
3808 \advance\itemno by -1
3809 \doitemize{#1.}\flushcr
3812 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3813 % to @enumerate.
3815 \def\alphaenumerate{\enumerate{a}}
3816 \def\capsenumerate{\enumerate{A}}
3817 \def\Ealphaenumerate{\Eenumerate}
3818 \def\Ecapsenumerate{\Eenumerate}
3821 % @multitable macros
3822 % Amy Hendrickson, 8/18/94, 3/6/96
3824 % @multitable ... @end multitable will make as many columns as desired.
3825 % Contents of each column will wrap at width given in preamble. Width
3826 % can be specified either with sample text given in a template line,
3827 % or in percent of \hsize, the current width of text on page.
3829 % Table can continue over pages but will only break between lines.
3831 % To make preamble:
3833 % Either define widths of columns in terms of percent of \hsize:
3834 % @multitable @columnfractions .25 .3 .45
3835 % @item ...
3837 % Numbers following @columnfractions are the percent of the total
3838 % current hsize to be used for each column. You may use as many
3839 % columns as desired.
3842 % Or use a template:
3843 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3844 % @item ...
3845 % using the widest term desired in each column.
3847 % Each new table line starts with @item, each subsequent new column
3848 % starts with @tab. Empty columns may be produced by supplying @tab's
3849 % with nothing between them for as many times as empty columns are needed,
3850 % ie, @tab@tab@tab will produce two empty columns.
3852 % @item, @tab do not need to be on their own lines, but it will not hurt
3853 % if they are.
3855 % Sample multitable:
3857 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3858 % @item first col stuff @tab second col stuff @tab third col
3859 % @item
3860 % first col stuff
3861 % @tab
3862 % second col stuff
3863 % @tab
3864 % third col
3865 % @item first col stuff @tab second col stuff
3866 % @tab Many paragraphs of text may be used in any column.
3868 % They will wrap at the width determined by the template.
3869 % @item@tab@tab This will be in third column.
3870 % @end multitable
3872 % Default dimensions may be reset by user.
3873 % @multitableparskip is vertical space between paragraphs in table.
3874 % @multitableparindent is paragraph indent in table.
3875 % @multitablecolmargin is horizontal space to be left between columns.
3876 % @multitablelinespace is space to leave between table items, baseline
3877 % to baseline.
3878 % 0pt means it depends on current normal line spacing.
3880 \newskip\multitableparskip
3881 \newskip\multitableparindent
3882 \newdimen\multitablecolspace
3883 \newskip\multitablelinespace
3884 \multitableparskip=0pt
3885 \multitableparindent=6pt
3886 \multitablecolspace=12pt
3887 \multitablelinespace=0pt
3889 % Macros used to set up halign preamble:
3891 \let\endsetuptable\relax
3892 \def\xendsetuptable{\endsetuptable}
3893 \let\columnfractions\relax
3894 \def\xcolumnfractions{\columnfractions}
3895 \newif\ifsetpercent
3897 % #1 is the @columnfraction, usually a decimal number like .5, but might
3898 % be just 1. We just use it, whatever it is.
3900 \def\pickupwholefraction#1 {%
3901 \global\advance\colcount by 1
3902 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3903 \setuptable
3906 \newcount\colcount
3907 \def\setuptable#1{%
3908 \def\firstarg{#1}%
3909 \ifx\firstarg\xendsetuptable
3910 \let\go = \relax
3911 \else
3912 \ifx\firstarg\xcolumnfractions
3913 \global\setpercenttrue
3914 \else
3915 \ifsetpercent
3916 \let\go\pickupwholefraction
3917 \else
3918 \global\advance\colcount by 1
3919 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3920 % separator; typically that is always in the input, anyway.
3921 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3924 \ifx\go\pickupwholefraction
3925 % Put the argument back for the \pickupwholefraction call, so
3926 % we'll always have a period there to be parsed.
3927 \def\go{\pickupwholefraction#1}%
3928 \else
3929 \let\go = \setuptable
3930 \fi%
3935 % multitable-only commands.
3937 % @headitem starts a heading row, which we typeset in bold.
3938 % Assignments have to be global since we are inside the implicit group
3939 % of an alignment entry. \everycr resets \everytab so we don't have to
3940 % undo it ourselves.
3941 \def\headitemfont{\b}% for people to use in the template row; not changeable
3942 \def\headitem{%
3943 \checkenv\multitable
3944 \crcr
3945 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3946 \the\everytab % for the first item
3949 % A \tab used to include \hskip1sp. But then the space in a template
3950 % line is not enough. That is bad. So let's go back to just `&' until
3951 % we again encounter the problem the 1sp was intended to solve.
3952 % --karl, nathan@acm.org, 20apr99.
3953 \def\tab{\checkenv\multitable &\the\everytab}%
3955 % @multitable ... @end multitable definitions:
3957 \newtoks\everytab % insert after every tab.
3959 \envdef\multitable{%
3960 \vskip\parskip
3961 \startsavinginserts
3963 % @item within a multitable starts a normal row.
3964 % We use \def instead of \let so that if one of the multitable entries
3965 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3966 % \endtemplate) expanding \doitemize.
3967 \def\item{\crcr}%
3969 \tolerance=9500
3970 \hbadness=9500
3971 \setmultitablespacing
3972 \parskip=\multitableparskip
3973 \parindent=\multitableparindent
3974 \overfullrule=0pt
3975 \global\colcount=0
3977 \everycr = {%
3978 \noalign{%
3979 \global\everytab={}%
3980 \global\colcount=0 % Reset the column counter.
3981 % Check for saved footnotes, etc.
3982 \checkinserts
3983 % Keeps underfull box messages off when table breaks over pages.
3984 %\filbreak
3985 % Maybe so, but it also creates really weird page breaks when the
3986 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3987 % problem manifests itself, so it can be fixed for real --karl.
3991 \parsearg\domultitable
3993 \def\domultitable#1{%
3994 % To parse everything between @multitable and @item:
3995 \setuptable#1 \endsetuptable
3997 % This preamble sets up a generic column definition, which will
3998 % be used as many times as user calls for columns.
3999 % \vtop will set a single line and will also let text wrap and
4000 % continue for many paragraphs if desired.
4001 \halign\bgroup &%
4002 \global\advance\colcount by 1
4003 \multistrut
4004 \vtop{%
4005 % Use the current \colcount to find the correct column width:
4006 \hsize=\expandafter\csname col\the\colcount\endcsname
4008 % In order to keep entries from bumping into each other
4009 % we will add a \leftskip of \multitablecolspace to all columns after
4010 % the first one.
4012 % If a template has been used, we will add \multitablecolspace
4013 % to the width of each template entry.
4015 % If the user has set preamble in terms of percent of \hsize we will
4016 % use that dimension as the width of the column, and the \leftskip
4017 % will keep entries from bumping into each other. Table will start at
4018 % left margin and final column will justify at right margin.
4020 % Make sure we don't inherit \rightskip from the outer environment.
4021 \rightskip=0pt
4022 \ifnum\colcount=1
4023 % The first column will be indented with the surrounding text.
4024 \advance\hsize by\leftskip
4025 \else
4026 \ifsetpercent \else
4027 % If user has not set preamble in terms of percent of \hsize
4028 % we will advance \hsize by \multitablecolspace.
4029 \advance\hsize by \multitablecolspace
4031 % In either case we will make \leftskip=\multitablecolspace:
4032 \leftskip=\multitablecolspace
4034 % Ignoring space at the beginning and end avoids an occasional spurious
4035 % blank line, when TeX decides to break the line at the space before the
4036 % box from the multistrut, so the strut ends up on a line by itself.
4037 % For example:
4038 % @multitable @columnfractions .11 .89
4039 % @item @code{#}
4040 % @tab Legal holiday which is valid in major parts of the whole country.
4041 % Is automatically provided with highlighting sequences respectively
4042 % marking characters.
4043 \noindent\ignorespaces##\unskip\multistrut
4044 }\cr
4046 \def\Emultitable{%
4047 \crcr
4048 \egroup % end the \halign
4049 \global\setpercentfalse
4052 \def\setmultitablespacing{%
4053 \def\multistrut{\strut}% just use the standard line spacing
4055 % Compute \multitablelinespace (if not defined by user) for use in
4056 % \multitableparskip calculation. We used define \multistrut based on
4057 % this, but (ironically) that caused the spacing to be off.
4058 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
4059 \ifdim\multitablelinespace=0pt
4060 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
4061 \global\advance\multitablelinespace by-\ht0
4063 % Test to see if parskip is larger than space between lines of
4064 % table. If not, do nothing.
4065 % If so, set to same dimension as multitablelinespace.
4066 \ifdim\multitableparskip>\multitablelinespace
4067 \global\multitableparskip=\multitablelinespace
4068 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4069 % than skip between lines in the table.
4070 \fi%
4071 \ifdim\multitableparskip=0pt
4072 \global\multitableparskip=\multitablelinespace
4073 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4074 % than skip between lines in the table.
4075 \fi}
4078 \message{conditionals,}
4080 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4081 % @ifnotxml always succeed. They currently do nothing; we don't
4082 % attempt to check whether the conditionals are properly nested. But we
4083 % have to remember that they are conditionals, so that @end doesn't
4084 % attempt to close an environment group.
4086 \def\makecond#1{%
4087 \expandafter\let\csname #1\endcsname = \relax
4088 \expandafter\let\csname iscond.#1\endcsname = 1
4090 \makecond{iftex}
4091 \makecond{ifnotdocbook}
4092 \makecond{ifnothtml}
4093 \makecond{ifnotinfo}
4094 \makecond{ifnotplaintext}
4095 \makecond{ifnotxml}
4097 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4099 \def\direntry{\doignore{direntry}}
4100 \def\documentdescription{\doignore{documentdescription}}
4101 \def\docbook{\doignore{docbook}}
4102 \def\html{\doignore{html}}
4103 \def\ifdocbook{\doignore{ifdocbook}}
4104 \def\ifhtml{\doignore{ifhtml}}
4105 \def\ifinfo{\doignore{ifinfo}}
4106 \def\ifnottex{\doignore{ifnottex}}
4107 \def\ifplaintext{\doignore{ifplaintext}}
4108 \def\ifxml{\doignore{ifxml}}
4109 \def\ignore{\doignore{ignore}}
4110 \def\menu{\doignore{menu}}
4111 \def\xml{\doignore{xml}}
4113 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4115 % A count to remember the depth of nesting.
4116 \newcount\doignorecount
4118 \def\doignore#1{\begingroup
4119 % Scan in ``verbatim'' mode:
4120 \obeylines
4121 \catcode`\@ = \other
4122 \catcode`\{ = \other
4123 \catcode`\} = \other
4125 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4126 \spaceisspace
4128 % Count number of #1's that we've seen.
4129 \doignorecount = 0
4131 % Swallow text until we reach the matching `@end #1'.
4132 \dodoignore{#1}%
4135 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4136 \obeylines %
4138 \gdef\dodoignore#1{%
4139 % #1 contains the command name as a string, e.g., `ifinfo'.
4141 % Define a command to find the next `@end #1'.
4142 \long\def\doignoretext##1^^M@end #1{%
4143 \doignoretextyyy##1^^M@#1\_STOP_}%
4145 % And this command to find another #1 command, at the beginning of a
4146 % line. (Otherwise, we would consider a line `@c @ifset', for
4147 % example, to count as an @ifset for nesting.)
4148 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4150 % And now expand that command.
4151 \doignoretext ^^M%
4155 \def\doignoreyyy#1{%
4156 \def\temp{#1}%
4157 \ifx\temp\empty % Nothing found.
4158 \let\next\doignoretextzzz
4159 \else % Found a nested condition, ...
4160 \advance\doignorecount by 1
4161 \let\next\doignoretextyyy % ..., look for another.
4162 % If we're here, #1 ends with ^^M\ifinfo (for example).
4164 \next #1% the token \_STOP_ is present just after this macro.
4167 % We have to swallow the remaining "\_STOP_".
4169 \def\doignoretextzzz#1{%
4170 \ifnum\doignorecount = 0 % We have just found the outermost @end.
4171 \let\next\enddoignore
4172 \else % Still inside a nested condition.
4173 \advance\doignorecount by -1
4174 \let\next\doignoretext % Look for the next @end.
4176 \next
4179 % Finish off ignored text.
4180 { \obeylines%
4181 % Ignore anything after the last `@end #1'; this matters in verbatim
4182 % environments, where otherwise the newline after an ignored conditional
4183 % would result in a blank line in the output.
4184 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4188 % @set VAR sets the variable VAR to an empty value.
4189 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4191 % Since we want to separate VAR from REST-OF-LINE (which might be
4192 % empty), we can't just use \parsearg; we have to insert a space of our
4193 % own to delimit the rest of the line, and then take it out again if we
4194 % didn't need it.
4195 % We rely on the fact that \parsearg sets \catcode`\ =10.
4197 \parseargdef\set{\setyyy#1 \endsetyyy}
4198 \def\setyyy#1 #2\endsetyyy{%
4200 \makevalueexpandable
4201 \def\temp{#2}%
4202 \edef\next{\gdef\makecsname{SET#1}}%
4203 \ifx\temp\empty
4204 \next{}%
4205 \else
4206 \setzzz#2\endsetzzz
4210 % Remove the trailing space \setxxx inserted.
4211 \def\setzzz#1 \endsetzzz{\next{#1}}
4213 % @clear VAR clears (i.e., unsets) the variable VAR.
4215 \parseargdef\clear{%
4217 \makevalueexpandable
4218 \global\expandafter\let\csname SET#1\endcsname=\relax
4222 % @value{foo} gets the text saved in variable foo.
4223 \def\value{\begingroup\makevalueexpandable\valuexxx}
4224 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4226 \catcode`\-=\active \catcode`\_=\active
4228 \gdef\makevalueexpandable{%
4229 \let\value = \expandablevalue
4230 % We don't want these characters active, ...
4231 \catcode`\-=\other \catcode`\_=\other
4232 % ..., but we might end up with active ones in the argument if
4233 % we're called from @code, as @code{@value{foo-bar_}}, though.
4234 % So \let them to their normal equivalents.
4235 \let-\normaldash \let_\normalunderscore
4239 % We have this subroutine so that we can handle at least some @value's
4240 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4241 % The command has to be fully expandable (if the variable is set), since
4242 % the result winds up in the index file. This means that if the
4243 % variable's value contains other Texinfo commands, it's almost certain
4244 % it will fail (although perhaps we could fix that with sufficient work
4245 % to do a one-level expansion on the result, instead of complete).
4247 % Unfortunately, this has the consequence that when _ is in the *value*
4248 % of an @set, it does not print properly in the roman fonts (get the cmr
4249 % dot accent at position 126 instead). No fix comes to mind, and it's
4250 % been this way since 2003 or earlier, so just ignore it.
4252 \def\expandablevalue#1{%
4253 \expandafter\ifx\csname SET#1\endcsname\relax
4254 {[No value for ``#1'']}%
4255 \message{Variable `#1', used in @value, is not set.}%
4256 \else
4257 \csname SET#1\endcsname
4261 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4262 % with @set.
4264 % To get the special treatment we need for `@end ifset,' we call
4265 % \makecond and then redefine.
4267 \makecond{ifset}
4268 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4269 \def\doifset#1#2{%
4271 \makevalueexpandable
4272 \let\next=\empty
4273 \expandafter\ifx\csname SET#2\endcsname\relax
4274 #1% If not set, redefine \next.
4276 \expandafter
4277 }\next
4279 \def\ifsetfail{\doignore{ifset}}
4281 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4282 % defined with @set, or has been undefined with @clear.
4284 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4285 % above code: if the variable is not set, do nothing, if it is set,
4286 % then redefine \next to \ifclearfail.
4288 \makecond{ifclear}
4289 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4290 \def\ifclearfail{\doignore{ifclear}}
4292 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4293 % without the @) is in fact defined. We can only feasibly check at the
4294 % TeX level, so something like `mathcode' is going to considered
4295 % defined even though it is not a Texinfo command.
4297 \makecond{ifcommanddefined}
4298 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
4300 \def\doifcmddefined#1#2{{%
4301 \makevalueexpandable
4302 \let\next=\empty
4303 \expandafter\ifx\csname #2\endcsname\relax
4304 #1% If not defined, \let\next as above.
4306 \expandafter
4307 }\next
4309 \def\ifcmddefinedfail{\doignore{ifcommanddefined}}
4311 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4312 \makecond{ifcommandnotdefined}
4313 \def\ifcommandnotdefined{%
4314 \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
4315 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
4317 % Set the `txicommandconditionals' variable, so documents have a way to
4318 % test if the @ifcommand...defined conditionals are available.
4319 \set txicommandconditionals
4321 % @dircategory CATEGORY -- specify a category of the dir file
4322 % which this file should belong to. Ignore this in TeX.
4323 \let\dircategory=\comment
4325 % @defininfoenclose.
4326 \let\definfoenclose=\comment
4329 \message{indexing,}
4330 % Index generation facilities
4332 % Define \newwrite to be identical to plain tex's \newwrite
4333 % except not \outer, so it can be used within macros and \if's.
4334 \edef\newwrite{\makecsname{ptexnewwrite}}
4336 % \newindex {foo} defines an index named foo.
4337 % It automatically defines \fooindex such that
4338 % \fooindex ...rest of line... puts an entry in the index foo.
4339 % It also defines \fooindfile to be the number of the output channel for
4340 % the file that accumulates this index. The file's extension is foo.
4341 % The name of an index should be no more than 2 characters long
4342 % for the sake of vms.
4344 \def\newindex#1{%
4345 \iflinks
4346 \expandafter\newwrite \csname#1indfile\endcsname
4347 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4349 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4350 \noexpand\doindex{#1}}
4353 % @defindex foo == \newindex{foo}
4355 \def\defindex{\parsearg\newindex}
4357 % Define @defcodeindex, like @defindex except put all entries in @code.
4359 \def\defcodeindex{\parsearg\newcodeindex}
4361 \def\newcodeindex#1{%
4362 \iflinks
4363 \expandafter\newwrite \csname#1indfile\endcsname
4364 \openout \csname#1indfile\endcsname \jobname.#1
4366 \expandafter\xdef\csname#1index\endcsname{%
4367 \noexpand\docodeindex{#1}}%
4371 % @synindex foo bar makes index foo feed into index bar.
4372 % Do this instead of @defindex foo if you don't want it as a separate index.
4374 % @syncodeindex foo bar similar, but put all entries made for index foo
4375 % inside @code.
4377 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4378 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4380 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4381 % #3 the target index (bar).
4382 \def\dosynindex#1#2#3{%
4383 % Only do \closeout if we haven't already done it, else we'll end up
4384 % closing the target index.
4385 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4386 % The \closeout helps reduce unnecessary open files; the limit on the
4387 % Acorn RISC OS is a mere 16 files.
4388 \expandafter\closeout\csname#2indfile\endcsname
4389 \expandafter\let\csname donesynindex#2\endcsname = 1
4391 % redefine \fooindfile:
4392 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4393 \expandafter\let\csname#2indfile\endcsname=\temp
4394 % redefine \fooindex:
4395 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4398 % Define \doindex, the driver for all \fooindex macros.
4399 % Argument #1 is generated by the calling \fooindex macro,
4400 % and it is "foo", the name of the index.
4402 % \doindex just uses \parsearg; it calls \doind for the actual work.
4403 % This is because \doind is more useful to call from other macros.
4405 % There is also \dosubind {index}{topic}{subtopic}
4406 % which makes an entry in a two-level index such as the operation index.
4408 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4409 \def\singleindexer #1{\doind{\indexname}{#1}}
4411 % like the previous two, but they put @code around the argument.
4412 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4413 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4415 % Take care of Texinfo commands that can appear in an index entry.
4416 % Since there are some commands we want to expand, and others we don't,
4417 % we have to laboriously prevent expansion for those that we don't.
4419 \def\indexdummies{%
4420 \escapechar = `\\ % use backslash in output files.
4421 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4422 \def\ {\realbackslash\space }%
4424 % Need these unexpandable (because we define \tt as a dummy)
4425 % definitions when @{ or @} appear in index entry text. Also, more
4426 % complicated, when \tex is in effect and \{ is a \delimiter again.
4427 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4428 % braces and backslashes are used only as delimiters. Perhaps we
4429 % should define @lbrace and @rbrace commands a la @comma.
4430 \def\{{{\tt\char123}}%
4431 \def\}{{\tt\char125}}%
4433 % I don't entirely understand this, but when an index entry is
4434 % generated from a macro call, the \endinput which \scanmacro inserts
4435 % causes processing to be prematurely terminated. This is,
4436 % apparently, because \indexsorttmp is fully expanded, and \endinput
4437 % is an expandable command. The redefinition below makes \endinput
4438 % disappear altogether for that purpose -- although logging shows that
4439 % processing continues to some further point. On the other hand, it
4440 % seems \endinput does not hurt in the printed index arg, since that
4441 % is still getting written without apparent harm.
4443 % Sample source (mac-idx3.tex, reported by Graham Percival to
4444 % help-texinfo, 22may06):
4445 % @macro funindex {WORD}
4446 % @findex xyz
4447 % @end macro
4448 % ...
4449 % @funindex commtest
4451 % The above is not enough to reproduce the bug, but it gives the flavor.
4453 % Sample whatsit resulting:
4454 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4456 % So:
4457 \let\endinput = \empty
4459 % Do the redefinitions.
4460 \commondummies
4463 % For the aux and toc files, @ is the escape character. So we want to
4464 % redefine everything using @ as the escape character (instead of
4465 % \realbackslash, still used for index files). When everything uses @,
4466 % this will be simpler.
4468 \def\atdummies{%
4469 \def\@{@@}%
4470 \def\ {@ }%
4471 \let\{ = \lbraceatcmd
4472 \let\} = \rbraceatcmd
4474 % Do the redefinitions.
4475 \commondummies
4476 \otherbackslash
4479 % Called from \indexdummies and \atdummies.
4481 \def\commondummies{%
4483 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4484 % preventing its expansion. This is used only for control words,
4485 % not control letters, because the \space would be incorrect for
4486 % control characters, but is needed to separate the control word
4487 % from whatever follows.
4489 % For control letters, we have \definedummyletter, which omits the
4490 % space.
4492 % These can be used both for control words that take an argument and
4493 % those that do not. If it is followed by {arg} in the input, then
4494 % that will dutifully get written to the index (or wherever).
4496 \def\definedummyword ##1{\def##1{\string##1\space}}%
4497 \def\definedummyletter##1{\def##1{\string##1}}%
4498 \let\definedummyaccent\definedummyletter
4500 \commondummiesnofonts
4502 \definedummyletter\_%
4503 \definedummyletter\-%
4505 % Non-English letters.
4506 \definedummyword\AA
4507 \definedummyword\AE
4508 \definedummyword\DH
4509 \definedummyword\L
4510 \definedummyword\O
4511 \definedummyword\OE
4512 \definedummyword\TH
4513 \definedummyword\aa
4514 \definedummyword\ae
4515 \definedummyword\dh
4516 \definedummyword\exclamdown
4517 \definedummyword\l
4518 \definedummyword\o
4519 \definedummyword\oe
4520 \definedummyword\ordf
4521 \definedummyword\ordm
4522 \definedummyword\questiondown
4523 \definedummyword\ss
4524 \definedummyword\th
4526 % Although these internal commands shouldn't show up, sometimes they do.
4527 \definedummyword\bf
4528 \definedummyword\gtr
4529 \definedummyword\hat
4530 \definedummyword\less
4531 \definedummyword\sf
4532 \definedummyword\sl
4533 \definedummyword\tclose
4534 \definedummyword\tt
4536 \definedummyword\LaTeX
4537 \definedummyword\TeX
4539 % Assorted special characters.
4540 \definedummyword\arrow
4541 \definedummyword\bullet
4542 \definedummyword\comma
4543 \definedummyword\copyright
4544 \definedummyword\registeredsymbol
4545 \definedummyword\dots
4546 \definedummyword\enddots
4547 \definedummyword\entrybreak
4548 \definedummyword\equiv
4549 \definedummyword\error
4550 \definedummyword\euro
4551 \definedummyword\expansion
4552 \definedummyword\geq
4553 \definedummyword\guillemetleft
4554 \definedummyword\guillemetright
4555 \definedummyword\guilsinglleft
4556 \definedummyword\guilsinglright
4557 \definedummyword\lbracechar
4558 \definedummyword\leq
4559 \definedummyword\minus
4560 \definedummyword\ogonek
4561 \definedummyword\pounds
4562 \definedummyword\point
4563 \definedummyword\print
4564 \definedummyword\quotedblbase
4565 \definedummyword\quotedblleft
4566 \definedummyword\quotedblright
4567 \definedummyword\quoteleft
4568 \definedummyword\quoteright
4569 \definedummyword\quotesinglbase
4570 \definedummyword\rbracechar
4571 \definedummyword\result
4572 \definedummyword\textdegree
4574 % We want to disable all macros so that they are not expanded by \write.
4575 \macrolist
4577 \normalturnoffactive
4579 % Handle some cases of @value -- where it does not contain any
4580 % (non-fully-expandable) commands.
4581 \makevalueexpandable
4584 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4586 \def\commondummiesnofonts{%
4587 % Control letters and accents.
4588 \definedummyletter\!%
4589 \definedummyaccent\"%
4590 \definedummyaccent\'%
4591 \definedummyletter\*%
4592 \definedummyaccent\,%
4593 \definedummyletter\.%
4594 \definedummyletter\/%
4595 \definedummyletter\:%
4596 \definedummyaccent\=%
4597 \definedummyletter\?%
4598 \definedummyaccent\^%
4599 \definedummyaccent\`%
4600 \definedummyaccent\~%
4601 \definedummyword\u
4602 \definedummyword\v
4603 \definedummyword\H
4604 \definedummyword\dotaccent
4605 \definedummyword\ogonek
4606 \definedummyword\ringaccent
4607 \definedummyword\tieaccent
4608 \definedummyword\ubaraccent
4609 \definedummyword\udotaccent
4610 \definedummyword\dotless
4612 % Texinfo font commands.
4613 \definedummyword\b
4614 \definedummyword\i
4615 \definedummyword\r
4616 \definedummyword\sansserif
4617 \definedummyword\sc
4618 \definedummyword\slanted
4619 \definedummyword\t
4621 % Commands that take arguments.
4622 \definedummyword\abbr
4623 \definedummyword\acronym
4624 \definedummyword\anchor
4625 \definedummyword\cite
4626 \definedummyword\code
4627 \definedummyword\command
4628 \definedummyword\dfn
4629 \definedummyword\dmn
4630 \definedummyword\email
4631 \definedummyword\emph
4632 \definedummyword\env
4633 \definedummyword\file
4634 \definedummyword\image
4635 \definedummyword\indicateurl
4636 \definedummyword\inforef
4637 \definedummyword\kbd
4638 \definedummyword\key
4639 \definedummyword\math
4640 \definedummyword\option
4641 \definedummyword\pxref
4642 \definedummyword\ref
4643 \definedummyword\samp
4644 \definedummyword\strong
4645 \definedummyword\tie
4646 \definedummyword\uref
4647 \definedummyword\url
4648 \definedummyword\var
4649 \definedummyword\verb
4650 \definedummyword\w
4651 \definedummyword\xref
4654 % \indexnofonts is used when outputting the strings to sort the index
4655 % by, and when constructing control sequence names. It eliminates all
4656 % control sequences and just writes whatever the best ASCII sort string
4657 % would be for a given command (usually its argument).
4659 \def\indexnofonts{%
4660 % Accent commands should become @asis.
4661 \def\definedummyaccent##1{\let##1\asis}%
4662 % We can just ignore other control letters.
4663 \def\definedummyletter##1{\let##1\empty}%
4664 % All control words become @asis by default; overrides below.
4665 \let\definedummyword\definedummyaccent
4667 \commondummiesnofonts
4669 % Don't no-op \tt, since it isn't a user-level command
4670 % and is used in the definitions of the active chars like <, >, |, etc.
4671 % Likewise with the other plain tex font commands.
4672 %\let\tt=\asis
4674 \def\ { }%
4675 \def\@{@}%
4676 \def\_{\normalunderscore}%
4677 \def\-{}% @- shouldn't affect sorting
4679 % Unfortunately, texindex is not prepared to handle braces in the
4680 % content at all. So for index sorting, we map @{ and @} to strings
4681 % starting with |, since that ASCII character is between ASCII { and }.
4682 \def\{{|a}%
4683 \def\lbracechar{|a}%
4685 \def\}{|b}%
4686 \def\rbracechar{|b}%
4688 % Non-English letters.
4689 \def\AA{AA}%
4690 \def\AE{AE}%
4691 \def\DH{DZZ}%
4692 \def\L{L}%
4693 \def\OE{OE}%
4694 \def\O{O}%
4695 \def\TH{ZZZ}%
4696 \def\aa{aa}%
4697 \def\ae{ae}%
4698 \def\dh{dzz}%
4699 \def\exclamdown{!}%
4700 \def\l{l}%
4701 \def\oe{oe}%
4702 \def\ordf{a}%
4703 \def\ordm{o}%
4704 \def\o{o}%
4705 \def\questiondown{?}%
4706 \def\ss{ss}%
4707 \def\th{zzz}%
4709 \def\LaTeX{LaTeX}%
4710 \def\TeX{TeX}%
4712 % Assorted special characters.
4713 % (The following {} will end up in the sort string, but that's ok.)
4714 \def\arrow{->}%
4715 \def\bullet{bullet}%
4716 \def\comma{,}%
4717 \def\copyright{copyright}%
4718 \def\dots{...}%
4719 \def\enddots{...}%
4720 \def\equiv{==}%
4721 \def\error{error}%
4722 \def\euro{euro}%
4723 \def\expansion{==>}%
4724 \def\geq{>=}%
4725 \def\guillemetleft{<<}%
4726 \def\guillemetright{>>}%
4727 \def\guilsinglleft{<}%
4728 \def\guilsinglright{>}%
4729 \def\leq{<=}%
4730 \def\minus{-}%
4731 \def\point{.}%
4732 \def\pounds{pounds}%
4733 \def\print{-|}%
4734 \def\quotedblbase{"}%
4735 \def\quotedblleft{"}%
4736 \def\quotedblright{"}%
4737 \def\quoteleft{`}%
4738 \def\quoteright{'}%
4739 \def\quotesinglbase{,}%
4740 \def\registeredsymbol{R}%
4741 \def\result{=>}%
4742 \def\textdegree{o}%
4744 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4745 \else \indexlquoteignore \fi
4747 % We need to get rid of all macros, leaving only the arguments (if present).
4748 % Of course this is not nearly correct, but it is the best we can do for now.
4749 % makeinfo does not expand macros in the argument to @deffn, which ends up
4750 % writing an index entry, and texindex isn't prepared for an index sort entry
4751 % that starts with \.
4753 % Since macro invocations are followed by braces, we can just redefine them
4754 % to take a single TeX argument. The case of a macro invocation that
4755 % goes to end-of-line is not handled.
4757 \macrolist
4760 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4761 % ignore left quotes in the sort term.
4762 {\catcode`\`=\active
4763 \gdef\indexlquoteignore{\let`=\empty}}
4765 \let\indexbackslash=0 %overridden during \printindex.
4766 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4768 % Most index entries go through here, but \dosubind is the general case.
4769 % #1 is the index name, #2 is the entry text.
4770 \def\doind#1#2{\dosubind{#1}{#2}{}}
4772 % Workhorse for all \fooindexes.
4773 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4774 % empty if called from \doind, as we usually are (the main exception
4775 % is with most defuns, which call us directly).
4777 \def\dosubind#1#2#3{%
4778 \iflinks
4780 % Store the main index entry text (including the third arg).
4781 \toks0 = {#2}%
4782 % If third arg is present, precede it with a space.
4783 \def\thirdarg{#3}%
4784 \ifx\thirdarg\empty \else
4785 \toks0 = \expandafter{\the\toks0 \space #3}%
4788 \edef\writeto{\csname#1indfile\endcsname}%
4790 \safewhatsit\dosubindwrite
4795 % Write the entry in \toks0 to the index file:
4797 \def\dosubindwrite{%
4798 % Put the index entry in the margin if desired.
4799 \ifx\SETmarginindex\relax\else
4800 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4803 % Remember, we are within a group.
4804 \indexdummies % Must do this here, since \bf, etc expand at this stage
4805 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4806 % so it will be output as is; and it will print as backslash.
4808 % Process the index entry with all font commands turned off, to
4809 % get the string to sort by.
4810 {\indexnofonts
4811 \edef\temp{\the\toks0}% need full expansion
4812 \xdef\indexsorttmp{\temp}%
4815 % Set up the complete index entry, with both the sort key and
4816 % the original text, including any font commands. We write
4817 % three arguments to \entry to the .?? file (four in the
4818 % subentry case), texindex reduces to two when writing the .??s
4819 % sorted result.
4820 \edef\temp{%
4821 \write\writeto{%
4822 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4824 \temp
4827 % Take care of unwanted page breaks/skips around a whatsit:
4829 % If a skip is the last thing on the list now, preserve it
4830 % by backing up by \lastskip, doing the \write, then inserting
4831 % the skip again. Otherwise, the whatsit generated by the
4832 % \write or \pdfdest will make \lastskip zero. The result is that
4833 % sequences like this:
4834 % @end defun
4835 % @tindex whatever
4836 % @defun ...
4837 % will have extra space inserted, because the \medbreak in the
4838 % start of the @defun won't see the skip inserted by the @end of
4839 % the previous defun.
4841 % But don't do any of this if we're not in vertical mode. We
4842 % don't want to do a \vskip and prematurely end a paragraph.
4844 % Avoid page breaks due to these extra skips, too.
4846 % But wait, there is a catch there:
4847 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4848 % sufficient for this purpose, as it ignores stretch and shrink parts
4849 % of the skip. The only way seems to be to check the textual
4850 % representation of the skip.
4852 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4853 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4855 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4857 \newskip\whatsitskip
4858 \newcount\whatsitpenalty
4860 % ..., ready, GO:
4862 \def\safewhatsit#1{\ifhmode
4864 \else
4865 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4866 \whatsitskip = \lastskip
4867 \edef\lastskipmacro{\the\lastskip}%
4868 \whatsitpenalty = \lastpenalty
4870 % If \lastskip is nonzero, that means the last item was a
4871 % skip. And since a skip is discardable, that means this
4872 % -\whatsitskip glue we're inserting is preceded by a
4873 % non-discardable item, therefore it is not a potential
4874 % breakpoint, therefore no \nobreak needed.
4875 \ifx\lastskipmacro\zeroskipmacro
4876 \else
4877 \vskip-\whatsitskip
4882 \ifx\lastskipmacro\zeroskipmacro
4883 % If \lastskip was zero, perhaps the last item was a penalty, and
4884 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4885 % to re-insert the same penalty (values >10000 are used for various
4886 % signals); since we just inserted a non-discardable item, any
4887 % following glue (such as a \parskip) would be a breakpoint. For example:
4888 % @deffn deffn-whatever
4889 % @vindex index-whatever
4890 % Description.
4891 % would allow a break between the index-whatever whatsit
4892 % and the "Description." paragraph.
4893 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4894 \else
4895 % On the other hand, if we had a nonzero \lastskip,
4896 % this make-up glue would be preceded by a non-discardable item
4897 % (the whatsit from the \write), so we must insert a \nobreak.
4898 \nobreak\vskip\whatsitskip
4900 \fi}
4902 % The index entry written in the file actually looks like
4903 % \entry {sortstring}{page}{topic}
4904 % or
4905 % \entry {sortstring}{page}{topic}{subtopic}
4906 % The texindex program reads in these files and writes files
4907 % containing these kinds of lines:
4908 % \initial {c}
4909 % before the first topic whose initial is c
4910 % \entry {topic}{pagelist}
4911 % for a topic that is used without subtopics
4912 % \primary {topic}
4913 % for the beginning of a topic that is used with subtopics
4914 % \secondary {subtopic}{pagelist}
4915 % for each subtopic.
4917 % Define the user-accessible indexing commands
4918 % @findex, @vindex, @kindex, @cindex.
4920 \def\findex {\fnindex}
4921 \def\kindex {\kyindex}
4922 \def\cindex {\cpindex}
4923 \def\vindex {\vrindex}
4924 \def\tindex {\tpindex}
4925 \def\pindex {\pgindex}
4927 \def\cindexsub {\begingroup\obeylines\cindexsub}
4928 {\obeylines %
4929 \gdef\cindexsub "#1" #2^^M{\endgroup %
4930 \dosubind{cp}{#2}{#1}}}
4932 % Define the macros used in formatting output of the sorted index material.
4934 % @printindex causes a particular index (the ??s file) to get printed.
4935 % It does not print any chapter heading (usually an @unnumbered).
4937 \parseargdef\printindex{\begingroup
4938 \dobreak \chapheadingskip{10000}%
4940 \smallfonts \rm
4941 \tolerance = 9500
4942 \plainfrenchspacing
4943 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4945 % See if the index file exists and is nonempty.
4946 % Change catcode of @ here so that if the index file contains
4947 % \initial {@}
4948 % as its first line, TeX doesn't complain about mismatched braces
4949 % (because it thinks @} is a control sequence).
4950 \catcode`\@ = 11
4951 \openin 1 \jobname.#1s
4952 \ifeof 1
4953 % \enddoublecolumns gets confused if there is no text in the index,
4954 % and it loses the chapter title and the aux file entries for the
4955 % index. The easiest way to prevent this problem is to make sure
4956 % there is some text.
4957 \putwordIndexNonexistent
4958 \else
4960 % If the index file exists but is empty, then \openin leaves \ifeof
4961 % false. We have to make TeX try to read something from the file, so
4962 % it can discover if there is anything in it.
4963 \read 1 to \temp
4964 \ifeof 1
4965 \putwordIndexIsEmpty
4966 \else
4967 % Index files are almost Texinfo source, but we use \ as the escape
4968 % character. It would be better to use @, but that's too big a change
4969 % to make right now.
4970 \def\indexbackslash{\backslashcurfont}%
4971 \catcode`\\ = 0
4972 \escapechar = `\\
4973 \begindoublecolumns
4974 \input \jobname.#1s
4975 \enddoublecolumns
4978 \closein 1
4979 \endgroup}
4981 % These macros are used by the sorted index file itself.
4982 % Change them to control the appearance of the index.
4984 \def\initial#1{{%
4985 % Some minor font changes for the special characters.
4986 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4988 % Remove any glue we may have, we'll be inserting our own.
4989 \removelastskip
4991 % We like breaks before the index initials, so insert a bonus.
4992 \nobreak
4993 \vskip 0pt plus 3\baselineskip
4994 \penalty 0
4995 \vskip 0pt plus -3\baselineskip
4997 % Typeset the initial. Making this add up to a whole number of
4998 % baselineskips increases the chance of the dots lining up from column
4999 % to column. It still won't often be perfect, because of the stretch
5000 % we need before each entry, but it's better.
5002 % No shrink because it confuses \balancecolumns.
5003 \vskip 1.67\baselineskip plus .5\baselineskip
5004 \leftline{\secbf #1}%
5005 % Do our best not to break after the initial.
5006 \nobreak
5007 \vskip .33\baselineskip plus .1\baselineskip
5010 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
5011 % then page number (#2) flushed to the right margin. It is used for index
5012 % and table of contents entries. The paragraph is indented by \leftskip.
5014 % A straightforward implementation would start like this:
5015 % \def\entry#1#2{...
5016 % But this freezes the catcodes in the argument, and can cause problems to
5017 % @code, which sets - active. This problem was fixed by a kludge---
5018 % ``-'' was active throughout whole index, but this isn't really right.
5019 % The right solution is to prevent \entry from swallowing the whole text.
5020 % --kasal, 21nov03
5021 \def\entry{%
5022 \begingroup
5024 % Start a new paragraph if necessary, so our assignments below can't
5025 % affect previous text.
5026 \par
5028 % Do not fill out the last line with white space.
5029 \parfillskip = 0in
5031 % No extra space above this paragraph.
5032 \parskip = 0in
5034 % Do not prefer a separate line ending with a hyphen to fewer lines.
5035 \finalhyphendemerits = 0
5037 % \hangindent is only relevant when the entry text and page number
5038 % don't both fit on one line. In that case, bob suggests starting the
5039 % dots pretty far over on the line. Unfortunately, a large
5040 % indentation looks wrong when the entry text itself is broken across
5041 % lines. So we use a small indentation and put up with long leaders.
5043 % \hangafter is reset to 1 (which is the value we want) at the start
5044 % of each paragraph, so we need not do anything with that.
5045 \hangindent = 2em
5047 % When the entry text needs to be broken, just fill out the first line
5048 % with blank space.
5049 \rightskip = 0pt plus1fil
5051 % A bit of stretch before each entry for the benefit of balancing
5052 % columns.
5053 \vskip 0pt plus1pt
5055 % When reading the text of entry, convert explicit line breaks
5056 % from @* into spaces. The user might give these in long section
5057 % titles, for instance.
5058 \def\*{\unskip\space\ignorespaces}%
5059 \def\entrybreak{\hfil\break}%
5061 % Swallow the left brace of the text (first parameter):
5062 \afterassignment\doentry
5063 \let\temp =
5065 \def\entrybreak{\unskip\space\ignorespaces}%
5066 \def\doentry{%
5067 \bgroup % Instead of the swallowed brace.
5068 \noindent
5069 \aftergroup\finishentry
5070 % And now comes the text of the entry.
5072 \def\finishentry#1{%
5073 % #1 is the page number.
5075 % The following is kludged to not output a line of dots in the index if
5076 % there are no page numbers. The next person who breaks this will be
5077 % cursed by a Unix daemon.
5078 \setbox\boxA = \hbox{#1}%
5079 \ifdim\wd\boxA = 0pt
5081 \else
5083 % If we must, put the page number on a line of its own, and fill out
5084 % this line with blank space. (The \hfil is overwhelmed with the
5085 % fill leaders glue in \indexdotfill if the page number does fit.)
5086 \hfil\penalty50
5087 \null\nobreak\indexdotfill % Have leaders before the page number.
5089 % The `\ ' here is removed by the implicit \unskip that TeX does as
5090 % part of (the primitive) \par. Without it, a spurious underfull
5091 % \hbox ensues.
5092 \ifpdf
5093 \pdfgettoks#1.%
5094 \ \the\toksA
5095 \else
5096 \ #1%
5099 \par
5100 \endgroup
5103 % Like plain.tex's \dotfill, except uses up at least 1 em.
5104 \def\indexdotfill{\cleaders
5105 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
5107 \def\primary #1{\line{#1\hfil}}
5109 \newskip\secondaryindent \secondaryindent=0.5cm
5110 \def\secondary#1#2{{%
5111 \parfillskip=0in
5112 \parskip=0in
5113 \hangindent=1in
5114 \hangafter=1
5115 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5116 \ifpdf
5117 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
5118 \else
5121 \par
5124 % Define two-column mode, which we use to typeset indexes.
5125 % Adapted from the TeXbook, page 416, which is to say,
5126 % the manmac.tex format used to print the TeXbook itself.
5127 \catcode`\@=11
5129 \newbox\partialpage
5130 \newdimen\doublecolumnhsize
5132 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5133 % Grab any single-column material above us.
5134 \output = {%
5136 % Here is a possibility not foreseen in manmac: if we accumulate a
5137 % whole lot of material, we might end up calling this \output
5138 % routine twice in a row (see the doublecol-lose test, which is
5139 % essentially a couple of indexes with @setchapternewpage off). In
5140 % that case we just ship out what is in \partialpage with the normal
5141 % output routine. Generally, \partialpage will be empty when this
5142 % runs and this will be a no-op. See the indexspread.tex test case.
5143 \ifvoid\partialpage \else
5144 \onepageout{\pagecontents\partialpage}%
5147 \global\setbox\partialpage = \vbox{%
5148 % Unvbox the main output page.
5149 \unvbox\PAGE
5150 \kern-\topskip \kern\baselineskip
5153 \eject % run that output routine to set \partialpage
5155 % Use the double-column output routine for subsequent pages.
5156 \output = {\doublecolumnout}%
5158 % Change the page size parameters. We could do this once outside this
5159 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5160 % format, but then we repeat the same computation. Repeating a couple
5161 % of assignments once per index is clearly meaningless for the
5162 % execution time, so we may as well do it in one place.
5164 % First we halve the line length, less a little for the gutter between
5165 % the columns. We compute the gutter based on the line length, so it
5166 % changes automatically with the paper format. The magic constant
5167 % below is chosen so that the gutter has the same value (well, +-<1pt)
5168 % as it did when we hard-coded it.
5170 % We put the result in a separate register, \doublecolumhsize, so we
5171 % can restore it in \pagesofar, after \hsize itself has (potentially)
5172 % been clobbered.
5174 \doublecolumnhsize = \hsize
5175 \advance\doublecolumnhsize by -.04154\hsize
5176 \divide\doublecolumnhsize by 2
5177 \hsize = \doublecolumnhsize
5179 % Double the \vsize as well. (We don't need a separate register here,
5180 % since nobody clobbers \vsize.)
5181 \vsize = 2\vsize
5184 % The double-column output routine for all double-column pages except
5185 % the last.
5187 \def\doublecolumnout{%
5188 \splittopskip=\topskip \splitmaxdepth=\maxdepth
5189 % Get the available space for the double columns -- the normal
5190 % (undoubled) page height minus any material left over from the
5191 % previous page.
5192 \dimen@ = \vsize
5193 \divide\dimen@ by 2
5194 \advance\dimen@ by -\ht\partialpage
5196 % box0 will be the left-hand column, box2 the right.
5197 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
5198 \onepageout\pagesofar
5199 \unvbox255
5200 \penalty\outputpenalty
5203 % Re-output the contents of the output page -- any previous material,
5204 % followed by the two boxes we just split, in box0 and box2.
5205 \def\pagesofar{%
5206 \unvbox\partialpage
5208 \hsize = \doublecolumnhsize
5209 \wd0=\hsize \wd2=\hsize
5210 \hbox to\pagewidth{\box0\hfil\box2}%
5213 % All done with double columns.
5214 \def\enddoublecolumns{%
5215 % The following penalty ensures that the page builder is exercised
5216 % _before_ we change the output routine. This is necessary in the
5217 % following situation:
5219 % The last section of the index consists only of a single entry.
5220 % Before this section, \pagetotal is less than \pagegoal, so no
5221 % break occurs before the last section starts. However, the last
5222 % section, consisting of \initial and the single \entry, does not
5223 % fit on the page and has to be broken off. Without the following
5224 % penalty the page builder will not be exercised until \eject
5225 % below, and by that time we'll already have changed the output
5226 % routine to the \balancecolumns version, so the next-to-last
5227 % double-column page will be processed with \balancecolumns, which
5228 % is wrong: The two columns will go to the main vertical list, with
5229 % the broken-off section in the recent contributions. As soon as
5230 % the output routine finishes, TeX starts reconsidering the page
5231 % break. The two columns and the broken-off section both fit on the
5232 % page, because the two columns now take up only half of the page
5233 % goal. When TeX sees \eject from below which follows the final
5234 % section, it invokes the new output routine that we've set after
5235 % \balancecolumns below; \onepageout will try to fit the two columns
5236 % and the final section into the vbox of \pageheight (see
5237 % \pagebody), causing an overfull box.
5239 % Note that glue won't work here, because glue does not exercise the
5240 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5241 \penalty0
5243 \output = {%
5244 % Split the last of the double-column material. Leave it on the
5245 % current page, no automatic page break.
5246 \balancecolumns
5248 % If we end up splitting too much material for the current page,
5249 % though, there will be another page break right after this \output
5250 % invocation ends. Having called \balancecolumns once, we do not
5251 % want to call it again. Therefore, reset \output to its normal
5252 % definition right away. (We hope \balancecolumns will never be
5253 % called on to balance too much material, but if it is, this makes
5254 % the output somewhat more palatable.)
5255 \global\output = {\onepageout{\pagecontents\PAGE}}%
5257 \eject
5258 \endgroup % started in \begindoublecolumns
5260 % \pagegoal was set to the doubled \vsize above, since we restarted
5261 % the current page. We're now back to normal single-column
5262 % typesetting, so reset \pagegoal to the normal \vsize (after the
5263 % \endgroup where \vsize got restored).
5264 \pagegoal = \vsize
5267 % Called at the end of the double column material.
5268 \def\balancecolumns{%
5269 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5270 \dimen@ = \ht0
5271 \advance\dimen@ by \topskip
5272 \advance\dimen@ by-\baselineskip
5273 \divide\dimen@ by 2 % target to split to
5274 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5275 \splittopskip = \topskip
5276 % Loop until we get a decent breakpoint.
5278 \vbadness = 10000
5279 \loop
5280 \global\setbox3 = \copy0
5281 \global\setbox1 = \vsplit3 to \dimen@
5282 \ifdim\ht3>\dimen@
5283 \global\advance\dimen@ by 1pt
5284 \repeat
5286 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5287 \setbox0=\vbox to\dimen@{\unvbox1}%
5288 \setbox2=\vbox to\dimen@{\unvbox3}%
5290 \pagesofar
5292 \catcode`\@ = \other
5295 \message{sectioning,}
5296 % Chapters, sections, etc.
5298 % Let's start with @part.
5299 \outer\parseargdef\part{\partzzz{#1}}
5300 \def\partzzz#1{%
5301 \chapoddpage
5302 \null
5303 \vskip.3\vsize % move it down on the page a bit
5304 \begingroup
5305 \noindent \titlefonts\rmisbold #1\par % the text
5306 \let\lastnode=\empty % no node to associate with
5307 \writetocentry{part}{#1}{}% but put it in the toc
5308 \headingsoff % no headline or footline on the part page
5309 \chapoddpage
5310 \endgroup
5313 % \unnumberedno is an oxymoron. But we count the unnumbered
5314 % sections so that we can refer to them unambiguously in the pdf
5315 % outlines by their "section number". We avoid collisions with chapter
5316 % numbers by starting them at 10000. (If a document ever has 10000
5317 % chapters, we're in trouble anyway, I'm sure.)
5318 \newcount\unnumberedno \unnumberedno = 10000
5319 \newcount\chapno
5320 \newcount\secno \secno=0
5321 \newcount\subsecno \subsecno=0
5322 \newcount\subsubsecno \subsubsecno=0
5324 % This counter is funny since it counts through charcodes of letters A, B, ...
5325 \newcount\appendixno \appendixno = `\@
5327 % \def\appendixletter{\char\the\appendixno}
5328 % We do the following ugly conditional instead of the above simple
5329 % construct for the sake of pdftex, which needs the actual
5330 % letter in the expansion, not just typeset.
5332 \def\appendixletter{%
5333 \ifnum\appendixno=`A A%
5334 \else\ifnum\appendixno=`B B%
5335 \else\ifnum\appendixno=`C C%
5336 \else\ifnum\appendixno=`D D%
5337 \else\ifnum\appendixno=`E E%
5338 \else\ifnum\appendixno=`F F%
5339 \else\ifnum\appendixno=`G G%
5340 \else\ifnum\appendixno=`H H%
5341 \else\ifnum\appendixno=`I I%
5342 \else\ifnum\appendixno=`J J%
5343 \else\ifnum\appendixno=`K K%
5344 \else\ifnum\appendixno=`L L%
5345 \else\ifnum\appendixno=`M M%
5346 \else\ifnum\appendixno=`N N%
5347 \else\ifnum\appendixno=`O O%
5348 \else\ifnum\appendixno=`P P%
5349 \else\ifnum\appendixno=`Q Q%
5350 \else\ifnum\appendixno=`R R%
5351 \else\ifnum\appendixno=`S S%
5352 \else\ifnum\appendixno=`T T%
5353 \else\ifnum\appendixno=`U U%
5354 \else\ifnum\appendixno=`V V%
5355 \else\ifnum\appendixno=`W W%
5356 \else\ifnum\appendixno=`X X%
5357 \else\ifnum\appendixno=`Y Y%
5358 \else\ifnum\appendixno=`Z Z%
5359 % The \the is necessary, despite appearances, because \appendixletter is
5360 % expanded while writing the .toc file. \char\appendixno is not
5361 % expandable, thus it is written literally, thus all appendixes come out
5362 % with the same letter (or @) in the toc without it.
5363 \else\char\the\appendixno
5364 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5365 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5367 % Each @chapter defines these (using marks) as the number+name, number
5368 % and name of the chapter. Page headings and footings can use
5369 % these. @section does likewise.
5370 \def\thischapter{}
5371 \def\thischapternum{}
5372 \def\thischaptername{}
5373 \def\thissection{}
5374 \def\thissectionnum{}
5375 \def\thissectionname{}
5377 \newcount\absseclevel % used to calculate proper heading level
5378 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5380 % @raisesections: treat @section as chapter, @subsection as section, etc.
5381 \def\raisesections{\global\advance\secbase by -1}
5382 \let\up=\raisesections % original BFox name
5384 % @lowersections: treat @chapter as section, @section as subsection, etc.
5385 \def\lowersections{\global\advance\secbase by 1}
5386 \let\down=\lowersections % original BFox name
5388 % we only have subsub.
5389 \chardef\maxseclevel = 3
5391 % A numbered section within an unnumbered changes to unnumbered too.
5392 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5393 \chardef\unnlevel = \maxseclevel
5395 % Trace whether the current chapter is an appendix or not:
5396 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5397 \def\chapheadtype{N}
5399 % Choose a heading macro
5400 % #1 is heading type
5401 % #2 is heading level
5402 % #3 is text for heading
5403 \def\genhead#1#2#3{%
5404 % Compute the abs. sec. level:
5405 \absseclevel=#2
5406 \advance\absseclevel by \secbase
5407 % Make sure \absseclevel doesn't fall outside the range:
5408 \ifnum \absseclevel < 0
5409 \absseclevel = 0
5410 \else
5411 \ifnum \absseclevel > 3
5412 \absseclevel = 3
5415 % The heading type:
5416 \def\headtype{#1}%
5417 \if \headtype U%
5418 \ifnum \absseclevel < \unnlevel
5419 \chardef\unnlevel = \absseclevel
5421 \else
5422 % Check for appendix sections:
5423 \ifnum \absseclevel = 0
5424 \edef\chapheadtype{\headtype}%
5425 \else
5426 \if \headtype A\if \chapheadtype N%
5427 \errmessage{@appendix... within a non-appendix chapter}%
5428 \fi\fi
5430 % Check for numbered within unnumbered:
5431 \ifnum \absseclevel > \unnlevel
5432 \def\headtype{U}%
5433 \else
5434 \chardef\unnlevel = 3
5437 % Now print the heading:
5438 \if \headtype U%
5439 \ifcase\absseclevel
5440 \unnumberedzzz{#3}%
5441 \or \unnumberedseczzz{#3}%
5442 \or \unnumberedsubseczzz{#3}%
5443 \or \unnumberedsubsubseczzz{#3}%
5445 \else
5446 \if \headtype A%
5447 \ifcase\absseclevel
5448 \appendixzzz{#3}%
5449 \or \appendixsectionzzz{#3}%
5450 \or \appendixsubseczzz{#3}%
5451 \or \appendixsubsubseczzz{#3}%
5453 \else
5454 \ifcase\absseclevel
5455 \chapterzzz{#3}%
5456 \or \seczzz{#3}%
5457 \or \numberedsubseczzz{#3}%
5458 \or \numberedsubsubseczzz{#3}%
5462 \suppressfirstparagraphindent
5465 % an interface:
5466 \def\numhead{\genhead N}
5467 \def\apphead{\genhead A}
5468 \def\unnmhead{\genhead U}
5470 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5471 % all lower-level sectioning counters to zero.
5473 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5474 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5475 \let\chaplevelprefix = \empty
5477 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5478 \def\chapterzzz#1{%
5479 % section resetting is \global in case the chapter is in a group, such
5480 % as an @include file.
5481 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5482 \global\advance\chapno by 1
5484 % Used for \float.
5485 \gdef\chaplevelprefix{\the\chapno.}%
5486 \resetallfloatnos
5488 % \putwordChapter can contain complex things in translations.
5489 \toks0=\expandafter{\putwordChapter}%
5490 \message{\the\toks0 \space \the\chapno}%
5492 % Write the actual heading.
5493 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5495 % So @section and the like are numbered underneath this chapter.
5496 \global\let\section = \numberedsec
5497 \global\let\subsection = \numberedsubsec
5498 \global\let\subsubsection = \numberedsubsubsec
5501 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5503 \def\appendixzzz#1{%
5504 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5505 \global\advance\appendixno by 1
5506 \gdef\chaplevelprefix{\appendixletter.}%
5507 \resetallfloatnos
5509 % \putwordAppendix can contain complex things in translations.
5510 \toks0=\expandafter{\putwordAppendix}%
5511 \message{\the\toks0 \space \appendixletter}%
5513 \chapmacro{#1}{Yappendix}{\appendixletter}%
5515 \global\let\section = \appendixsec
5516 \global\let\subsection = \appendixsubsec
5517 \global\let\subsubsection = \appendixsubsubsec
5520 % normally unnmhead0 calls unnumberedzzz:
5521 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5522 \def\unnumberedzzz#1{%
5523 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5524 \global\advance\unnumberedno by 1
5526 % Since an unnumbered has no number, no prefix for figures.
5527 \global\let\chaplevelprefix = \empty
5528 \resetallfloatnos
5530 % This used to be simply \message{#1}, but TeX fully expands the
5531 % argument to \message. Therefore, if #1 contained @-commands, TeX
5532 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5533 % expanded @cite (which turns out to cause errors because \cite is meant
5534 % to be executed, not expanded).
5536 % Anyway, we don't want the fully-expanded definition of @cite to appear
5537 % as a result of the \message, we just want `@cite' itself. We use
5538 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5539 % simply yielding the contents of <toks register>. (We also do this for
5540 % the toc entries.)
5541 \toks0 = {#1}%
5542 \message{(\the\toks0)}%
5544 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5546 \global\let\section = \unnumberedsec
5547 \global\let\subsection = \unnumberedsubsec
5548 \global\let\subsubsection = \unnumberedsubsubsec
5551 % @centerchap is like @unnumbered, but the heading is centered.
5552 \outer\parseargdef\centerchap{%
5553 % Well, we could do the following in a group, but that would break
5554 % an assumption that \chapmacro is called at the outermost level.
5555 % Thus we are safer this way: --kasal, 24feb04
5556 \let\centerparametersmaybe = \centerparameters
5557 \unnmhead0{#1}%
5558 \let\centerparametersmaybe = \relax
5561 % @top is like @unnumbered.
5562 \let\top\unnumbered
5564 % Sections.
5566 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5567 \def\seczzz#1{%
5568 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5569 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5572 % normally calls appendixsectionzzz:
5573 \outer\parseargdef\appendixsection{\apphead1{#1}}
5574 \def\appendixsectionzzz#1{%
5575 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5576 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5578 \let\appendixsec\appendixsection
5580 % normally calls unnumberedseczzz:
5581 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5582 \def\unnumberedseczzz#1{%
5583 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5584 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5587 % Subsections.
5589 % normally calls numberedsubseczzz:
5590 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5591 \def\numberedsubseczzz#1{%
5592 \global\subsubsecno=0 \global\advance\subsecno by 1
5593 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5596 % normally calls appendixsubseczzz:
5597 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5598 \def\appendixsubseczzz#1{%
5599 \global\subsubsecno=0 \global\advance\subsecno by 1
5600 \sectionheading{#1}{subsec}{Yappendix}%
5601 {\appendixletter.\the\secno.\the\subsecno}%
5604 % normally calls unnumberedsubseczzz:
5605 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5606 \def\unnumberedsubseczzz#1{%
5607 \global\subsubsecno=0 \global\advance\subsecno by 1
5608 \sectionheading{#1}{subsec}{Ynothing}%
5609 {\the\unnumberedno.\the\secno.\the\subsecno}%
5612 % Subsubsections.
5614 % normally numberedsubsubseczzz:
5615 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5616 \def\numberedsubsubseczzz#1{%
5617 \global\advance\subsubsecno by 1
5618 \sectionheading{#1}{subsubsec}{Ynumbered}%
5619 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5622 % normally appendixsubsubseczzz:
5623 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5624 \def\appendixsubsubseczzz#1{%
5625 \global\advance\subsubsecno by 1
5626 \sectionheading{#1}{subsubsec}{Yappendix}%
5627 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5630 % normally unnumberedsubsubseczzz:
5631 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5632 \def\unnumberedsubsubseczzz#1{%
5633 \global\advance\subsubsecno by 1
5634 \sectionheading{#1}{subsubsec}{Ynothing}%
5635 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5638 % These macros control what the section commands do, according
5639 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5640 % Define them by default for a numbered chapter.
5641 \let\section = \numberedsec
5642 \let\subsection = \numberedsubsec
5643 \let\subsubsection = \numberedsubsubsec
5645 % Define @majorheading, @heading and @subheading
5647 \def\majorheading{%
5648 {\advance\chapheadingskip by 10pt \chapbreak }%
5649 \parsearg\chapheadingzzz
5652 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5653 \def\chapheadingzzz#1{%
5654 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5655 \nobreak\bigskip \nobreak
5656 \suppressfirstparagraphindent
5659 % @heading, @subheading, @subsubheading.
5660 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5661 \suppressfirstparagraphindent}
5662 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5663 \suppressfirstparagraphindent}
5664 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5665 \suppressfirstparagraphindent}
5667 % These macros generate a chapter, section, etc. heading only
5668 % (including whitespace, linebreaking, etc. around it),
5669 % given all the information in convenient, parsed form.
5671 % Args are the skip and penalty (usually negative)
5672 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5674 % Parameter controlling skip before chapter headings (if needed)
5675 \newskip\chapheadingskip
5677 % Define plain chapter starts, and page on/off switching for it.
5678 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5679 \def\chappager{\par\vfill\supereject}
5680 % Because \domark is called before \chapoddpage, the filler page will
5681 % get the headings for the next chapter, which is wrong. But we don't
5682 % care -- we just disable all headings on the filler page.
5683 \def\chapoddpage{%
5684 \chappager
5685 \ifodd\pageno \else
5686 \begingroup
5687 \headingsoff
5688 \null
5689 \chappager
5690 \endgroup
5694 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5696 \def\CHAPPAGoff{%
5697 \global\let\contentsalignmacro = \chappager
5698 \global\let\pchapsepmacro=\chapbreak
5699 \global\let\pagealignmacro=\chappager}
5701 \def\CHAPPAGon{%
5702 \global\let\contentsalignmacro = \chappager
5703 \global\let\pchapsepmacro=\chappager
5704 \global\let\pagealignmacro=\chappager
5705 \global\def\HEADINGSon{\HEADINGSsingle}}
5707 \def\CHAPPAGodd{%
5708 \global\let\contentsalignmacro = \chapoddpage
5709 \global\let\pchapsepmacro=\chapoddpage
5710 \global\let\pagealignmacro=\chapoddpage
5711 \global\def\HEADINGSon{\HEADINGSdouble}}
5713 \CHAPPAGon
5715 % Chapter opening.
5717 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5718 % Yappendix, Yomitfromtoc), #3 the chapter number.
5720 % To test against our argument.
5721 \def\Ynothingkeyword{Ynothing}
5722 \def\Yomitfromtockeyword{Yomitfromtoc}
5723 \def\Yappendixkeyword{Yappendix}
5725 \def\chapmacro#1#2#3{%
5726 % Insert the first mark before the heading break (see notes for \domark).
5727 \let\prevchapterdefs=\lastchapterdefs
5728 \let\prevsectiondefs=\lastsectiondefs
5729 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5730 \gdef\thissection{}}%
5732 \def\temptype{#2}%
5733 \ifx\temptype\Ynothingkeyword
5734 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5735 \gdef\thischapter{\thischaptername}}%
5736 \else\ifx\temptype\Yomitfromtockeyword
5737 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5738 \gdef\thischapter{}}%
5739 \else\ifx\temptype\Yappendixkeyword
5740 \toks0={#1}%
5741 \xdef\lastchapterdefs{%
5742 \gdef\noexpand\thischaptername{\the\toks0}%
5743 \gdef\noexpand\thischapternum{\appendixletter}%
5744 % \noexpand\putwordAppendix avoids expanding indigestible
5745 % commands in some of the translations.
5746 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5747 \noexpand\thischapternum:
5748 \noexpand\thischaptername}%
5750 \else
5751 \toks0={#1}%
5752 \xdef\lastchapterdefs{%
5753 \gdef\noexpand\thischaptername{\the\toks0}%
5754 \gdef\noexpand\thischapternum{\the\chapno}%
5755 % \noexpand\putwordChapter avoids expanding indigestible
5756 % commands in some of the translations.
5757 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5758 \noexpand\thischapternum:
5759 \noexpand\thischaptername}%
5761 \fi\fi\fi
5763 % Output the mark. Pass it through \safewhatsit, to take care of
5764 % the preceding space.
5765 \safewhatsit\domark
5767 % Insert the chapter heading break.
5768 \pchapsepmacro
5770 % Now the second mark, after the heading break. No break points
5771 % between here and the heading.
5772 \let\prevchapterdefs=\lastchapterdefs
5773 \let\prevsectiondefs=\lastsectiondefs
5774 \domark
5777 \chapfonts \rmisbold
5779 % Have to define \lastsection before calling \donoderef, because the
5780 % xref code eventually uses it. On the other hand, it has to be called
5781 % after \pchapsepmacro, or the headline will change too soon.
5782 \gdef\lastsection{#1}%
5784 % Only insert the separating space if we have a chapter/appendix
5785 % number, and don't print the unnumbered ``number''.
5786 \ifx\temptype\Ynothingkeyword
5787 \setbox0 = \hbox{}%
5788 \def\toctype{unnchap}%
5789 \else\ifx\temptype\Yomitfromtockeyword
5790 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5791 \def\toctype{omit}%
5792 \else\ifx\temptype\Yappendixkeyword
5793 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5794 \def\toctype{app}%
5795 \else
5796 \setbox0 = \hbox{#3\enspace}%
5797 \def\toctype{numchap}%
5798 \fi\fi\fi
5800 % Write the toc entry for this chapter. Must come before the
5801 % \donoderef, because we include the current node name in the toc
5802 % entry, and \donoderef resets it to empty.
5803 \writetocentry{\toctype}{#1}{#3}%
5805 % For pdftex, we have to write out the node definition (aka, make
5806 % the pdfdest) after any page break, but before the actual text has
5807 % been typeset. If the destination for the pdf outline is after the
5808 % text, then jumping from the outline may wind up with the text not
5809 % being visible, for instance under high magnification.
5810 \donoderef{#2}%
5812 % Typeset the actual heading.
5813 \nobreak % Avoid page breaks at the interline glue.
5814 \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe
5815 \unhbox0 #1\par}%
5817 \nobreak\bigskip % no page break after a chapter title
5818 \nobreak
5821 % @centerchap -- centered and unnumbered.
5822 \let\centerparametersmaybe = \relax
5823 \def\centerparameters{%
5824 \advance\rightskip by 3\rightskip
5825 \leftskip = \rightskip
5826 \parfillskip = 0pt
5830 % I don't think this chapter style is supported any more, so I'm not
5831 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5833 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5835 \def\unnchfopen #1{%
5836 \chapoddpage
5837 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5838 \nobreak\bigskip\nobreak
5840 \def\chfopen #1#2{\chapoddpage {\chapfonts
5841 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5842 \par\penalty 5000 %
5844 \def\centerchfopen #1{%
5845 \chapoddpage
5846 \vbox{\chapfonts \raggedtitlesettings \hfill #1\hfill}%
5847 \nobreak\bigskip \nobreak
5849 \def\CHAPFopen{%
5850 \global\let\chapmacro=\chfopen
5851 \global\let\centerchapmacro=\centerchfopen}
5854 % Section titles. These macros combine the section number parts and
5855 % call the generic \sectionheading to do the printing.
5857 \newskip\secheadingskip
5858 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5860 % Subsection titles.
5861 \newskip\subsecheadingskip
5862 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5864 % Subsubsection titles.
5865 \def\subsubsecheadingskip{\subsecheadingskip}
5866 \def\subsubsecheadingbreak{\subsecheadingbreak}
5869 % Print any size, any type, section title.
5871 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5872 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5873 % section number.
5875 \def\seckeyword{sec}
5877 \def\sectionheading#1#2#3#4{%
5879 \checkenv{}% should not be in an environment.
5881 % Switch to the right set of fonts.
5882 \csname #2fonts\endcsname \rmisbold
5884 \def\sectionlevel{#2}%
5885 \def\temptype{#3}%
5887 % Insert first mark before the heading break (see notes for \domark).
5888 \let\prevsectiondefs=\lastsectiondefs
5889 \ifx\temptype\Ynothingkeyword
5890 \ifx\sectionlevel\seckeyword
5891 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5892 \gdef\thissection{\thissectionname}}%
5894 \else\ifx\temptype\Yomitfromtockeyword
5895 % Don't redefine \thissection.
5896 \else\ifx\temptype\Yappendixkeyword
5897 \ifx\sectionlevel\seckeyword
5898 \toks0={#1}%
5899 \xdef\lastsectiondefs{%
5900 \gdef\noexpand\thissectionname{\the\toks0}%
5901 \gdef\noexpand\thissectionnum{#4}%
5902 % \noexpand\putwordSection avoids expanding indigestible
5903 % commands in some of the translations.
5904 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5905 \noexpand\thissectionnum:
5906 \noexpand\thissectionname}%
5909 \else
5910 \ifx\sectionlevel\seckeyword
5911 \toks0={#1}%
5912 \xdef\lastsectiondefs{%
5913 \gdef\noexpand\thissectionname{\the\toks0}%
5914 \gdef\noexpand\thissectionnum{#4}%
5915 % \noexpand\putwordSection avoids expanding indigestible
5916 % commands in some of the translations.
5917 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5918 \noexpand\thissectionnum:
5919 \noexpand\thissectionname}%
5922 \fi\fi\fi
5924 % Go into vertical mode. Usually we'll already be there, but we
5925 % don't want the following whatsit to end up in a preceding paragraph
5926 % if the document didn't happen to have a blank line.
5927 \par
5929 % Output the mark. Pass it through \safewhatsit, to take care of
5930 % the preceding space.
5931 \safewhatsit\domark
5933 % Insert space above the heading.
5934 \csname #2headingbreak\endcsname
5936 % Now the second mark, after the heading break. No break points
5937 % between here and the heading.
5938 \global\let\prevsectiondefs=\lastsectiondefs
5939 \domark
5941 % Only insert the space after the number if we have a section number.
5942 \ifx\temptype\Ynothingkeyword
5943 \setbox0 = \hbox{}%
5944 \def\toctype{unn}%
5945 \gdef\lastsection{#1}%
5946 \else\ifx\temptype\Yomitfromtockeyword
5947 % for @headings -- no section number, don't include in toc,
5948 % and don't redefine \lastsection.
5949 \setbox0 = \hbox{}%
5950 \def\toctype{omit}%
5951 \let\sectionlevel=\empty
5952 \else\ifx\temptype\Yappendixkeyword
5953 \setbox0 = \hbox{#4\enspace}%
5954 \def\toctype{app}%
5955 \gdef\lastsection{#1}%
5956 \else
5957 \setbox0 = \hbox{#4\enspace}%
5958 \def\toctype{num}%
5959 \gdef\lastsection{#1}%
5960 \fi\fi\fi
5962 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5963 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5965 % Write the node reference (= pdf destination for pdftex).
5966 % Again, see comments in \chapmacro.
5967 \donoderef{#3}%
5969 % Interline glue will be inserted when the vbox is completed.
5970 % That glue will be a valid breakpoint for the page, since it'll be
5971 % preceded by a whatsit (usually from the \donoderef, or from the
5972 % \writetocentry if there was no node). We don't want to allow that
5973 % break, since then the whatsits could end up on page n while the
5974 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5975 \nobreak
5977 % Output the actual section heading.
5978 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5979 \hangindent=\wd0 % zero if no section number
5980 \unhbox0 #1}%
5982 % Add extra space after the heading -- half of whatever came above it.
5983 % Don't allow stretch, though.
5984 \kern .5 \csname #2headingskip\endcsname
5986 % Do not let the kern be a potential breakpoint, as it would be if it
5987 % was followed by glue.
5988 \nobreak
5990 % We'll almost certainly start a paragraph next, so don't let that
5991 % glue accumulate. (Not a breakpoint because it's preceded by a
5992 % discardable item.) However, when a paragraph is not started next
5993 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
5994 % or the negative glue will cause weirdly wrong output, typically
5995 % obscuring the section heading with something else.
5996 \vskip-\parskip
5998 % This is so the last item on the main vertical list is a known
5999 % \penalty > 10000, so \startdefun, etc., can recognize the situation
6000 % and do the needful.
6001 \penalty 10001
6005 \message{toc,}
6006 % Table of contents.
6007 \newwrite\tocfile
6009 % Write an entry to the toc file, opening it if necessary.
6010 % Called from @chapter, etc.
6012 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
6013 % We append the current node name (if any) and page number as additional
6014 % arguments for the \{chap,sec,...}entry macros which will eventually
6015 % read this. The node name is used in the pdf outlines as the
6016 % destination to jump to.
6018 % We open the .toc file for writing here instead of at @setfilename (or
6019 % any other fixed time) so that @contents can be anywhere in the document.
6020 % But if #1 is `omit', then we don't do anything. This is used for the
6021 % table of contents chapter openings themselves.
6023 \newif\iftocfileopened
6024 \def\omitkeyword{omit}%
6026 \def\writetocentry#1#2#3{%
6027 \edef\writetoctype{#1}%
6028 \ifx\writetoctype\omitkeyword \else
6029 \iftocfileopened\else
6030 \immediate\openout\tocfile = \jobname.toc
6031 \global\tocfileopenedtrue
6034 \iflinks
6035 {\atdummies
6036 \edef\temp{%
6037 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
6038 \temp
6043 % Tell \shipout to create a pdf destination on each page, if we're
6044 % writing pdf. These are used in the table of contents. We can't
6045 % just write one on every page because the title pages are numbered
6046 % 1 and 2 (the page numbers aren't printed), and so are the first
6047 % two pages of the document. Thus, we'd have two destinations named
6048 % `1', and two named `2'.
6049 \ifpdf \global\pdfmakepagedesttrue \fi
6053 % These characters do not print properly in the Computer Modern roman
6054 % fonts, so we must take special care. This is more or less redundant
6055 % with the Texinfo input format setup at the end of this file.
6057 \def\activecatcodes{%
6058 \catcode`\"=\active
6059 \catcode`\$=\active
6060 \catcode`\<=\active
6061 \catcode`\>=\active
6062 \catcode`\\=\active
6063 \catcode`\^=\active
6064 \catcode`\_=\active
6065 \catcode`\|=\active
6066 \catcode`\~=\active
6070 % Read the toc file, which is essentially Texinfo input.
6071 \def\readtocfile{%
6072 \setupdatafile
6073 \activecatcodes
6074 \input \tocreadfilename
6077 \newskip\contentsrightmargin \contentsrightmargin=1in
6078 \newcount\savepageno
6079 \newcount\lastnegativepageno \lastnegativepageno = -1
6081 % Prepare to read what we've written to \tocfile.
6083 \def\startcontents#1{%
6084 % If @setchapternewpage on, and @headings double, the contents should
6085 % start on an odd page, unlike chapters. Thus, we maintain
6086 % \contentsalignmacro in parallel with \pagealignmacro.
6087 % From: Torbjorn Granlund <tege@matematik.su.se>
6088 \contentsalignmacro
6089 \immediate\closeout\tocfile
6091 % Don't need to put `Contents' or `Short Contents' in the headline.
6092 % It is abundantly clear what they are.
6093 \chapmacro{#1}{Yomitfromtoc}{}%
6095 \savepageno = \pageno
6096 \begingroup % Set up to handle contents files properly.
6097 \raggedbottom % Worry more about breakpoints than the bottom.
6098 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
6100 % Roman numerals for page numbers.
6101 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
6104 % redefined for the two-volume lispref. We always output on
6105 % \jobname.toc even if this is redefined.
6107 \def\tocreadfilename{\jobname.toc}
6109 % Normal (long) toc.
6111 \def\contents{%
6112 \startcontents{\putwordTOC}%
6113 \openin 1 \tocreadfilename\space
6114 \ifeof 1 \else
6115 \readtocfile
6117 \vfill \eject
6118 \contentsalignmacro % in case @setchapternewpage odd is in effect
6119 \ifeof 1 \else
6120 \pdfmakeoutlines
6122 \closein 1
6123 \endgroup
6124 \lastnegativepageno = \pageno
6125 \global\pageno = \savepageno
6128 % And just the chapters.
6129 \def\summarycontents{%
6130 \startcontents{\putwordShortTOC}%
6132 \let\partentry = \shortpartentry
6133 \let\numchapentry = \shortchapentry
6134 \let\appentry = \shortchapentry
6135 \let\unnchapentry = \shortunnchapentry
6136 % We want a true roman here for the page numbers.
6137 \secfonts
6138 \let\rm=\shortcontrm \let\bf=\shortcontbf
6139 \let\sl=\shortcontsl \let\tt=\shortconttt
6141 \hyphenpenalty = 10000
6142 \advance\baselineskip by 1pt % Open it up a little.
6143 \def\numsecentry##1##2##3##4{}
6144 \let\appsecentry = \numsecentry
6145 \let\unnsecentry = \numsecentry
6146 \let\numsubsecentry = \numsecentry
6147 \let\appsubsecentry = \numsecentry
6148 \let\unnsubsecentry = \numsecentry
6149 \let\numsubsubsecentry = \numsecentry
6150 \let\appsubsubsecentry = \numsecentry
6151 \let\unnsubsubsecentry = \numsecentry
6152 \openin 1 \tocreadfilename\space
6153 \ifeof 1 \else
6154 \readtocfile
6156 \closein 1
6157 \vfill \eject
6158 \contentsalignmacro % in case @setchapternewpage odd is in effect
6159 \endgroup
6160 \lastnegativepageno = \pageno
6161 \global\pageno = \savepageno
6163 \let\shortcontents = \summarycontents
6165 % Typeset the label for a chapter or appendix for the short contents.
6166 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6168 \def\shortchaplabel#1{%
6169 % This space should be enough, since a single number is .5em, and the
6170 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6171 % But use \hss just in case.
6172 % (This space doesn't include the extra space that gets added after
6173 % the label; that gets put in by \shortchapentry above.)
6175 % We'd like to right-justify chapter numbers, but that looks strange
6176 % with appendix letters. And right-justifying numbers and
6177 % left-justifying letters looks strange when there is less than 10
6178 % chapters. Have to read the whole toc once to know how many chapters
6179 % there are before deciding ...
6180 \hbox to 1em{#1\hss}%
6183 % These macros generate individual entries in the table of contents.
6184 % The first argument is the chapter or section name.
6185 % The last argument is the page number.
6186 % The arguments in between are the chapter number, section number, ...
6188 % Parts, in the main contents. Replace the part number, which doesn't
6189 % exist, with an empty box. Let's hope all the numbers have the same width.
6190 % Also ignore the page number, which is conventionally not printed.
6191 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6192 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6194 % Parts, in the short toc.
6195 \def\shortpartentry#1#2#3#4{%
6196 \penalty-300
6197 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6198 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6201 % Chapters, in the main contents.
6202 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6204 % Chapters, in the short toc.
6205 % See comments in \dochapentry re vbox and related settings.
6206 \def\shortchapentry#1#2#3#4{%
6207 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6210 % Appendices, in the main contents.
6211 % Need the word Appendix, and a fixed-size box.
6213 \def\appendixbox#1{%
6214 % We use M since it's probably the widest letter.
6215 \setbox0 = \hbox{\putwordAppendix{} M}%
6216 \hbox to \wd0{\putwordAppendix{} #1\hss}}
6218 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6220 % Unnumbered chapters.
6221 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6222 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6224 % Sections.
6225 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6226 \let\appsecentry=\numsecentry
6227 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6229 % Subsections.
6230 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6231 \let\appsubsecentry=\numsubsecentry
6232 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6234 % And subsubsections.
6235 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6236 \let\appsubsubsecentry=\numsubsubsecentry
6237 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6239 % This parameter controls the indentation of the various levels.
6240 % Same as \defaultparindent.
6241 \newdimen\tocindent \tocindent = 15pt
6243 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6244 % page number.
6246 % If the toc has to be broken over pages, we want it to be at chapters
6247 % if at all possible; hence the \penalty.
6248 \def\dochapentry#1#2{%
6249 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6250 \begingroup
6251 \chapentryfonts
6252 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6253 \endgroup
6254 \nobreak\vskip .25\baselineskip plus.1\baselineskip
6257 \def\dosecentry#1#2{\begingroup
6258 \secentryfonts \leftskip=\tocindent
6259 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6260 \endgroup}
6262 \def\dosubsecentry#1#2{\begingroup
6263 \subsecentryfonts \leftskip=2\tocindent
6264 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6265 \endgroup}
6267 \def\dosubsubsecentry#1#2{\begingroup
6268 \subsubsecentryfonts \leftskip=3\tocindent
6269 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6270 \endgroup}
6272 % We use the same \entry macro as for the index entries.
6273 \let\tocentry = \entry
6275 % Space between chapter (or whatever) number and the title.
6276 \def\labelspace{\hskip1em \relax}
6278 \def\dopageno#1{{\rm #1}}
6279 \def\doshortpageno#1{{\rm #1}}
6281 \def\chapentryfonts{\secfonts \rm}
6282 \def\secentryfonts{\textfonts}
6283 \def\subsecentryfonts{\textfonts}
6284 \def\subsubsecentryfonts{\textfonts}
6287 \message{environments,}
6288 % @foo ... @end foo.
6290 % @tex ... @end tex escapes into raw TeX temporarily.
6291 % One exception: @ is still an escape character, so that @end tex works.
6292 % But \@ or @@ will get a plain @ character.
6294 \envdef\tex{%
6295 \setupmarkupstyle{tex}%
6296 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6297 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6298 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6299 \catcode `\%=14
6300 \catcode `\+=\other
6301 \catcode `\"=\other
6302 \catcode `\|=\other
6303 \catcode `\<=\other
6304 \catcode `\>=\other
6305 \catcode `\`=\other
6306 \catcode `\'=\other
6307 \escapechar=`\\
6309 % ' is active in math mode (mathcode"8000). So reset it, and all our
6310 % other math active characters (just in case), to plain's definitions.
6311 \mathactive
6313 \let\b=\ptexb
6314 \let\bullet=\ptexbullet
6315 \let\c=\ptexc
6316 \let\,=\ptexcomma
6317 \let\.=\ptexdot
6318 \let\dots=\ptexdots
6319 \let\equiv=\ptexequiv
6320 \let\!=\ptexexclam
6321 \let\i=\ptexi
6322 \let\indent=\ptexindent
6323 \let\noindent=\ptexnoindent
6324 \let\{=\ptexlbrace
6325 \let\+=\tabalign
6326 \let\}=\ptexrbrace
6327 \let\/=\ptexslash
6328 \let\*=\ptexstar
6329 \let\t=\ptext
6330 \expandafter \let\csname top\endcsname=\ptextop % we've made it outer
6331 \let\frenchspacing=\plainfrenchspacing
6333 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6334 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6335 \def\@{@}%
6337 % There is no need to define \Etex.
6339 % Define @lisp ... @end lisp.
6340 % @lisp environment forms a group so it can rebind things,
6341 % including the definition of @end lisp (which normally is erroneous).
6343 % Amount to narrow the margins by for @lisp.
6344 \newskip\lispnarrowing \lispnarrowing=0.4in
6346 % This is the definition that ^^M gets inside @lisp, @example, and other
6347 % such environments. \null is better than a space, since it doesn't
6348 % have any width.
6349 \def\lisppar{\null\endgraf}
6351 % This space is always present above and below environments.
6352 \newskip\envskipamount \envskipamount = 0pt
6354 % Make spacing and below environment symmetrical. We use \parskip here
6355 % to help in doing that, since in @example-like environments \parskip
6356 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6357 % start of the next paragraph will insert \parskip.
6359 \def\aboveenvbreak{{%
6360 % =10000 instead of <10000 because of a special case in \itemzzz and
6361 % \sectionheading, q.v.
6362 \ifnum \lastpenalty=10000 \else
6363 \advance\envskipamount by \parskip
6364 \endgraf
6365 \ifdim\lastskip<\envskipamount
6366 \removelastskip
6367 % it's not a good place to break if the last penalty was \nobreak
6368 % or better ...
6369 \ifnum\lastpenalty<10000 \penalty-50 \fi
6370 \vskip\envskipamount
6375 \let\afterenvbreak = \aboveenvbreak
6377 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6378 % also clear it, so that its embedded environments do the narrowing again.
6379 \let\nonarrowing=\relax
6381 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6382 % environment contents.
6383 \font\circle=lcircle10
6384 \newdimen\circthick
6385 \newdimen\cartouter\newdimen\cartinner
6386 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6387 \circthick=\fontdimen8\circle
6389 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6390 \def\ctr{{\hskip 6pt\circle\char'010}}
6391 \def\cbl{{\circle\char'012\hskip -6pt}}
6392 \def\cbr{{\hskip 6pt\circle\char'011}}
6393 \def\carttop{\hbox to \cartouter{\hskip\lskip
6394 \ctl\leaders\hrule height\circthick\hfil\ctr
6395 \hskip\rskip}}
6396 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6397 \cbl\leaders\hrule height\circthick\hfil\cbr
6398 \hskip\rskip}}
6400 \newskip\lskip\newskip\rskip
6402 \envdef\cartouche{%
6403 \ifhmode\par\fi % can't be in the midst of a paragraph.
6404 \startsavinginserts
6405 \lskip=\leftskip \rskip=\rightskip
6406 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6407 \cartinner=\hsize \advance\cartinner by-\lskip
6408 \advance\cartinner by-\rskip
6409 \cartouter=\hsize
6410 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6411 % side, and for 6pt waste from
6412 % each corner char, and rule thickness
6413 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6414 % Flag to tell @lisp, etc., not to narrow margin.
6415 \let\nonarrowing = t%
6417 % If this cartouche directly follows a sectioning command, we need the
6418 % \parskip glue (backspaced over by default) or the cartouche can
6419 % collide with the section heading.
6420 \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
6422 \vbox\bgroup
6423 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6424 \carttop
6425 \hbox\bgroup
6426 \hskip\lskip
6427 \vrule\kern3pt
6428 \vbox\bgroup
6429 \kern3pt
6430 \hsize=\cartinner
6431 \baselineskip=\normbskip
6432 \lineskip=\normlskip
6433 \parskip=\normpskip
6434 \vskip -\parskip
6435 \comment % For explanation, see the end of def\group.
6437 \def\Ecartouche{%
6438 \ifhmode\par\fi
6439 \kern3pt
6440 \egroup
6441 \kern3pt\vrule
6442 \hskip\rskip
6443 \egroup
6444 \cartbot
6445 \egroup
6446 \checkinserts
6450 % This macro is called at the beginning of all the @example variants,
6451 % inside a group.
6452 \newdimen\nonfillparindent
6453 \def\nonfillstart{%
6454 \aboveenvbreak
6455 \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy
6456 \sepspaces % Make spaces be word-separators rather than space tokens.
6457 \let\par = \lisppar % don't ignore blank lines
6458 \obeylines % each line of input is a line of output
6459 \parskip = 0pt
6460 % Turn off paragraph indentation but redefine \indent to emulate
6461 % the normal \indent.
6462 \nonfillparindent=\parindent
6463 \parindent = 0pt
6464 \let\indent\nonfillindent
6466 \emergencystretch = 0pt % don't try to avoid overfull boxes
6467 \ifx\nonarrowing\relax
6468 \advance \leftskip by \lispnarrowing
6469 \exdentamount=\lispnarrowing
6470 \else
6471 \let\nonarrowing = \relax
6473 \let\exdent=\nofillexdent
6476 \begingroup
6477 \obeyspaces
6478 % We want to swallow spaces (but not other tokens) after the fake
6479 % @indent in our nonfill-environments, where spaces are normally
6480 % active and set to @tie, resulting in them not being ignored after
6481 % @indent.
6482 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6483 \gdef\nonfillindentcheck{%
6484 \ifx\temp %
6485 \expandafter\nonfillindentgobble%
6486 \else%
6487 \leavevmode\nonfillindentbox%
6488 \fi%
6490 \endgroup
6491 \def\nonfillindentgobble#1{\nonfillindent}
6492 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6494 % If you want all examples etc. small: @set dispenvsize small.
6495 % If you want even small examples the full size: @set dispenvsize nosmall.
6496 % This affects the following displayed environments:
6497 % @example, @display, @format, @lisp
6499 \def\smallword{small}
6500 \def\nosmallword{nosmall}
6501 \let\SETdispenvsize\relax
6502 \def\setnormaldispenv{%
6503 \ifx\SETdispenvsize\smallword
6504 % end paragraph for sake of leading, in case document has no blank
6505 % line. This is redundant with what happens in \aboveenvbreak, but
6506 % we need to do it before changing the fonts, and it's inconvenient
6507 % to change the fonts afterward.
6508 \ifnum \lastpenalty=10000 \else \endgraf \fi
6509 \smallexamplefonts \rm
6512 \def\setsmalldispenv{%
6513 \ifx\SETdispenvsize\nosmallword
6514 \else
6515 \ifnum \lastpenalty=10000 \else \endgraf \fi
6516 \smallexamplefonts \rm
6520 % We often define two environments, @foo and @smallfoo.
6521 % Let's do it in one command. #1 is the env name, #2 the definition.
6522 \def\makedispenvdef#1#2{%
6523 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6524 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6525 \expandafter\let\csname E#1\endcsname \afterenvbreak
6526 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6529 % Define two environment synonyms (#1 and #2) for an environment.
6530 \def\maketwodispenvdef#1#2#3{%
6531 \makedispenvdef{#1}{#3}%
6532 \makedispenvdef{#2}{#3}%
6535 % @lisp: indented, narrowed, typewriter font;
6536 % @example: same as @lisp.
6538 % @smallexample and @smalllisp: use smaller fonts.
6539 % Originally contributed by Pavel@xerox.
6541 \maketwodispenvdef{lisp}{example}{%
6542 \nonfillstart
6543 \tt\setupmarkupstyle{example}%
6544 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6545 \gobble % eat return
6547 % @display/@smalldisplay: same as @lisp except keep current font.
6549 \makedispenvdef{display}{%
6550 \nonfillstart
6551 \gobble
6554 % @format/@smallformat: same as @display except don't narrow margins.
6556 \makedispenvdef{format}{%
6557 \let\nonarrowing = t%
6558 \nonfillstart
6559 \gobble
6562 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6563 \envdef\flushleft{%
6564 \let\nonarrowing = t%
6565 \nonfillstart
6566 \gobble
6568 \let\Eflushleft = \afterenvbreak
6570 % @flushright.
6572 \envdef\flushright{%
6573 \let\nonarrowing = t%
6574 \nonfillstart
6575 \advance\leftskip by 0pt plus 1fill\relax
6576 \gobble
6578 \let\Eflushright = \afterenvbreak
6581 % @raggedright does more-or-less normal line breaking but no right
6582 % justification. From plain.tex.
6583 \envdef\raggedright{%
6584 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6586 \let\Eraggedright\par
6588 \envdef\raggedleft{%
6589 \parindent=0pt \leftskip0pt plus2em
6590 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6591 \hbadness=10000 % Last line will usually be underfull, so turn off
6592 % badness reporting.
6594 \let\Eraggedleft\par
6596 \envdef\raggedcenter{%
6597 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6598 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6599 \hbadness=10000 % Last line will usually be underfull, so turn off
6600 % badness reporting.
6602 \let\Eraggedcenter\par
6605 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6606 % and narrows the margins. We keep \parskip nonzero in general, since
6607 % we're doing normal filling. So, when using \aboveenvbreak and
6608 % \afterenvbreak, temporarily make \parskip 0.
6610 \makedispenvdef{quotation}{\quotationstart}
6612 \def\quotationstart{%
6613 \indentedblockstart % same as \indentedblock, but increase right margin too.
6614 \ifx\nonarrowing\relax
6615 \advance\rightskip by \lispnarrowing
6617 \parsearg\quotationlabel
6620 % We have retained a nonzero parskip for the environment, since we're
6621 % doing normal filling.
6623 \def\Equotation{%
6624 \par
6625 \ifx\quotationauthor\thisisundefined\else
6626 % indent a bit.
6627 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6629 {\parskip=0pt \afterenvbreak}%
6631 \def\Esmallquotation{\Equotation}
6633 % If we're given an argument, typeset it in bold with a colon after.
6634 \def\quotationlabel#1{%
6635 \def\temp{#1}%
6636 \ifx\temp\empty \else
6637 {\bf #1: }%
6641 % @indentedblock is like @quotation, but indents only on the left and
6642 % has no optional argument.
6644 \makedispenvdef{indentedblock}{\indentedblockstart}
6646 \def\indentedblockstart{%
6647 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6648 \parindent=0pt
6650 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6651 \ifx\nonarrowing\relax
6652 \advance\leftskip by \lispnarrowing
6653 \exdentamount = \lispnarrowing
6654 \else
6655 \let\nonarrowing = \relax
6659 % Keep a nonzero parskip for the environment, since we're doing normal filling.
6661 \def\Eindentedblock{%
6662 \par
6663 {\parskip=0pt \afterenvbreak}%
6665 \def\Esmallindentedblock{\Eindentedblock}
6668 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6669 % If we want to allow any <char> as delimiter,
6670 % we need the curly braces so that makeinfo sees the @verb command, eg:
6671 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6673 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6675 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6676 % active too. Otherwise, they get lost as the first character on a
6677 % verbatim line.
6678 \def\dospecials{%
6679 \do\ \do\\\do\{\do\}\do\$\do\&%
6680 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6681 \do\<\do\>\do\|\do\@\do+\do\"%
6682 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6683 % @set txicodequotebacktick will not have effect on @verb and
6684 % @verbatim, and ?` and !` ligatures won't get disabled.
6685 %\do\`\do\'%
6688 % [Knuth] p. 380
6689 \def\uncatcodespecials{%
6690 \def\do##1{\catcode`##1=\other}\dospecials}
6692 % Setup for the @verb command.
6694 % Eight spaces for a tab
6695 \begingroup
6696 \catcode`\^^I=\active
6697 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6698 \endgroup
6700 \def\setupverb{%
6701 \tt % easiest (and conventionally used) font for verbatim
6702 \def\par{\leavevmode\endgraf}%
6703 \setupmarkupstyle{verb}%
6704 \tabeightspaces
6705 % Respect line breaks,
6706 % print special symbols as themselves, and
6707 % make each space count
6708 % must do in this order:
6709 \obeylines \uncatcodespecials \sepspaces
6712 % Setup for the @verbatim environment
6714 % Real tab expansion.
6715 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6717 % We typeset each line of the verbatim in an \hbox, so we can handle
6718 % tabs. The \global is in case the verbatim line starts with an accent,
6719 % or some other command that starts with a begin-group. Otherwise, the
6720 % entire \verbbox would disappear at the corresponding end-group, before
6721 % it is typeset. Meanwhile, we can't have nested verbatim commands
6722 % (can we?), so the \global won't be overwriting itself.
6723 \newbox\verbbox
6724 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
6726 \begingroup
6727 \catcode`\^^I=\active
6728 \gdef\tabexpand{%
6729 \catcode`\^^I=\active
6730 \def^^I{\leavevmode\egroup
6731 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
6732 \divide\dimen\verbbox by\tabw
6733 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
6734 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
6735 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
6738 \endgroup
6740 % start the verbatim environment.
6741 \def\setupverbatim{%
6742 \let\nonarrowing = t%
6743 \nonfillstart
6744 \tt % easiest (and conventionally used) font for verbatim
6745 % The \leavevmode here is for blank lines. Otherwise, we would
6746 % never \starttabox and the \egroup would end verbatim mode.
6747 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6748 \tabexpand
6749 \setupmarkupstyle{verbatim}%
6750 % Respect line breaks,
6751 % print special symbols as themselves, and
6752 % make each space count.
6753 % Must do in this order:
6754 \obeylines \uncatcodespecials \sepspaces
6755 \everypar{\starttabbox}%
6758 % Do the @verb magic: verbatim text is quoted by unique
6759 % delimiter characters. Before first delimiter expect a
6760 % right brace, after last delimiter expect closing brace:
6762 % \def\doverb'{'<char>#1<char>'}'{#1}
6764 % [Knuth] p. 382; only eat outer {}
6765 \begingroup
6766 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6767 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6768 \endgroup
6770 \def\verb{\begingroup\setupverb\doverb}
6773 % Do the @verbatim magic: define the macro \doverbatim so that
6774 % the (first) argument ends when '@end verbatim' is reached, ie:
6776 % \def\doverbatim#1@end verbatim{#1}
6778 % For Texinfo it's a lot easier than for LaTeX,
6779 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6780 % we need not redefine '\', '{' and '}'.
6782 % Inspired by LaTeX's verbatim command set [latex.ltx]
6784 \begingroup
6785 \catcode`\ =\active
6786 \obeylines %
6787 % ignore everything up to the first ^^M, that's the newline at the end
6788 % of the @verbatim input line itself. Otherwise we get an extra blank
6789 % line in the output.
6790 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6791 % We really want {...\end verbatim} in the body of the macro, but
6792 % without the active space; thus we have to use \xdef and \gobble.
6793 \endgroup
6795 \envdef\verbatim{%
6796 \setupverbatim\doverbatim
6798 \let\Everbatim = \afterenvbreak
6801 % @verbatiminclude FILE - insert text of file in verbatim environment.
6803 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6805 \def\doverbatiminclude#1{%
6807 \makevalueexpandable
6808 \setupverbatim
6809 \indexnofonts % Allow `@@' and other weird things in file names.
6810 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
6811 \input #1
6812 \afterenvbreak
6816 % @copying ... @end copying.
6817 % Save the text away for @insertcopying later.
6819 % We save the uninterpreted tokens, rather than creating a box.
6820 % Saving the text in a box would be much easier, but then all the
6821 % typesetting commands (@smallbook, font changes, etc.) have to be done
6822 % beforehand -- and a) we want @copying to be done first in the source
6823 % file; b) letting users define the frontmatter in as flexible order as
6824 % possible is very desirable.
6826 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6827 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6829 \def\insertcopying{%
6830 \begingroup
6831 \parindent = 0pt % paragraph indentation looks wrong on title page
6832 \scanexp\copyingtext
6833 \endgroup
6837 \message{defuns,}
6838 % @defun etc.
6840 \newskip\defbodyindent \defbodyindent=.4in
6841 \newskip\defargsindent \defargsindent=50pt
6842 \newskip\deflastargmargin \deflastargmargin=18pt
6843 \newcount\defunpenalty
6845 % Start the processing of @deffn:
6846 \def\startdefun{%
6847 \ifnum\lastpenalty<10000
6848 \medbreak
6849 \defunpenalty=10003 % Will keep this @deffn together with the
6850 % following @def command, see below.
6851 \else
6852 % If there are two @def commands in a row, we'll have a \nobreak,
6853 % which is there to keep the function description together with its
6854 % header. But if there's nothing but headers, we need to allow a
6855 % break somewhere. Check specifically for penalty 10002, inserted
6856 % by \printdefunline, instead of 10000, since the sectioning
6857 % commands also insert a nobreak penalty, and we don't want to allow
6858 % a break between a section heading and a defun.
6860 % As a further refinement, we avoid "club" headers by signalling
6861 % with penalty of 10003 after the very first @deffn in the
6862 % sequence (see above), and penalty of 10002 after any following
6863 % @def command.
6864 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6866 % Similarly, after a section heading, do not allow a break.
6867 % But do insert the glue.
6868 \medskip % preceded by discardable penalty, so not a breakpoint
6871 \parindent=0in
6872 \advance\leftskip by \defbodyindent
6873 \exdentamount=\defbodyindent
6876 \def\dodefunx#1{%
6877 % First, check whether we are in the right environment:
6878 \checkenv#1%
6880 % As above, allow line break if we have multiple x headers in a row.
6881 % It's not a great place, though.
6882 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6884 % And now, it's time to reuse the body of the original defun:
6885 \expandafter\gobbledefun#1%
6887 \def\gobbledefun#1\startdefun{}
6889 % \printdefunline \deffnheader{text}
6891 \def\printdefunline#1#2{%
6892 \begingroup
6893 % call \deffnheader:
6894 #1#2 \endheader
6895 % common ending:
6896 \interlinepenalty = 10000
6897 \advance\rightskip by 0pt plus 1fil\relax
6898 \endgraf
6899 \nobreak\vskip -\parskip
6900 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6901 % Some of the @defun-type tags do not enable magic parentheses,
6902 % rendering the following check redundant. But we don't optimize.
6903 \checkparencounts
6904 \endgroup
6907 \def\Edefun{\endgraf\medbreak}
6909 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6910 % the only thing remaining is to define \deffnheader.
6912 \def\makedefun#1{%
6913 \expandafter\let\csname E#1\endcsname = \Edefun
6914 \edef\temp{\noexpand\domakedefun
6915 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6916 \temp
6919 % \domakedefun \deffn \deffnx \deffnheader
6921 % Define \deffn and \deffnx, without parameters.
6922 % \deffnheader has to be defined explicitly.
6924 \def\domakedefun#1#2#3{%
6925 \envdef#1{%
6926 \startdefun
6927 \doingtypefnfalse % distinguish typed functions from all else
6928 \parseargusing\activeparens{\printdefunline#3}%
6930 \def#2{\dodefunx#1}%
6931 \def#3%
6934 \newif\ifdoingtypefn % doing typed function?
6935 \newif\ifrettypeownline % typeset return type on its own line?
6937 % @deftypefnnewline on|off says whether the return type of typed functions
6938 % are printed on their own line. This affects @deftypefn, @deftypefun,
6939 % @deftypeop, and @deftypemethod.
6941 \parseargdef\deftypefnnewline{%
6942 \def\temp{#1}%
6943 \ifx\temp\onword
6944 \expandafter\let\csname SETtxideftypefnnl\endcsname
6945 = \empty
6946 \else\ifx\temp\offword
6947 \expandafter\let\csname SETtxideftypefnnl\endcsname
6948 = \relax
6949 \else
6950 \errhelp = \EMsimple
6951 \errmessage{Unknown @txideftypefnnl value `\temp',
6952 must be on|off}%
6953 \fi\fi
6956 % Untyped functions:
6958 % @deffn category name args
6959 \makedefun{deffn}{\deffngeneral{}}
6961 % @deffn category class name args
6962 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6964 % \defopon {category on}class name args
6965 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6967 % \deffngeneral {subind}category name args
6969 \def\deffngeneral#1#2 #3 #4\endheader{%
6970 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6971 \dosubind{fn}{\code{#3}}{#1}%
6972 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6975 % Typed functions:
6977 % @deftypefn category type name args
6978 \makedefun{deftypefn}{\deftypefngeneral{}}
6980 % @deftypeop category class type name args
6981 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6983 % \deftypeopon {category on}class type name args
6984 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6986 % \deftypefngeneral {subind}category type name args
6988 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6989 \dosubind{fn}{\code{#4}}{#1}%
6990 \doingtypefntrue
6991 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6994 % Typed variables:
6996 % @deftypevr category type var args
6997 \makedefun{deftypevr}{\deftypecvgeneral{}}
6999 % @deftypecv category class type var args
7000 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
7002 % \deftypecvof {category of}class type var args
7003 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
7005 % \deftypecvgeneral {subind}category type var args
7007 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
7008 \dosubind{vr}{\code{#4}}{#1}%
7009 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7012 % Untyped variables:
7014 % @defvr category var args
7015 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
7017 % @defcv category class var args
7018 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
7020 % \defcvof {category of}class var args
7021 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
7023 % Types:
7025 % @deftp category name args
7026 \makedefun{deftp}#1 #2 #3\endheader{%
7027 \doind{tp}{\code{#2}}%
7028 \defname{#1}{}{#2}\defunargs{#3\unskip}%
7031 % Remaining @defun-like shortcuts:
7032 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
7033 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
7034 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
7035 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
7036 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
7037 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
7038 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
7039 \makedefun{defmethod}{\defopon\putwordMethodon}
7040 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
7041 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
7042 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
7044 % \defname, which formats the name of the @def (not the args).
7045 % #1 is the category, such as "Function".
7046 % #2 is the return type, if any.
7047 % #3 is the function name.
7049 % We are followed by (but not passed) the arguments, if any.
7051 \def\defname#1#2#3{%
7052 \par
7053 % Get the values of \leftskip and \rightskip as they were outside the @def...
7054 \advance\leftskip by -\defbodyindent
7056 % Determine if we are typesetting the return type of a typed function
7057 % on a line by itself.
7058 \rettypeownlinefalse
7059 \ifdoingtypefn % doing a typed function specifically?
7060 % then check user option for putting return type on its own line:
7061 \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
7062 \rettypeownlinetrue
7066 % How we'll format the category name. Putting it in brackets helps
7067 % distinguish it from the body text that may end up on the next line
7068 % just below it.
7069 \def\temp{#1}%
7070 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7072 % Figure out line sizes for the paragraph shape. We'll always have at
7073 % least two.
7074 \tempnum = 2
7076 % The first line needs space for \box0; but if \rightskip is nonzero,
7077 % we need only space for the part of \box0 which exceeds it:
7078 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
7080 % If doing a return type on its own line, we'll have another line.
7081 \ifrettypeownline
7082 \advance\tempnum by 1
7083 \def\maybeshapeline{0in \hsize}%
7084 \else
7085 \def\maybeshapeline{}%
7088 % The continuations:
7089 \dimen2=\hsize \advance\dimen2 by -\defargsindent
7091 % The final paragraph shape:
7092 \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2
7094 % Put the category name at the right margin.
7095 \noindent
7096 \hbox to 0pt{%
7097 \hfil\box0 \kern-\hsize
7098 % \hsize has to be shortened this way:
7099 \kern\leftskip
7100 % Intentionally do not respect \rightskip, since we need the space.
7103 % Allow all lines to be underfull without complaint:
7104 \tolerance=10000 \hbadness=10000
7105 \exdentamount=\defbodyindent
7107 % defun fonts. We use typewriter by default (used to be bold) because:
7108 % . we're printing identifiers, they should be in tt in principle.
7109 % . in languages with many accents, such as Czech or French, it's
7110 % common to leave accents off identifiers. The result looks ok in
7111 % tt, but exceedingly strange in rm.
7112 % . we don't want -- and --- to be treated as ligatures.
7113 % . this still does not fix the ?` and !` ligatures, but so far no
7114 % one has made identifiers using them :).
7115 \df \tt
7116 \def\temp{#2}% text of the return type
7117 \ifx\temp\empty\else
7118 \tclose{\temp}% typeset the return type
7119 \ifrettypeownline
7120 % put return type on its own line; prohibit line break following:
7121 \hfil\vadjust{\nobreak}\break
7122 \else
7123 \space % type on same line, so just followed by a space
7125 \fi % no return type
7126 #3% output function name
7128 {\rm\enskip}% hskip 0.5 em of \tenrm
7130 \boldbrax
7131 % arguments will be output next, if any.
7134 % Print arguments in slanted roman (not ttsl), inconsistently with using
7135 % tt for the name. This is because literal text is sometimes needed in
7136 % the argument list (groff manual), and ttsl and tt are not very
7137 % distinguishable. Prevent hyphenation at `-' chars.
7139 \def\defunargs#1{%
7140 % use sl by default (not ttsl),
7141 % tt for the names.
7142 \df \sl \hyphenchar\font=0
7144 % On the other hand, if an argument has two dashes (for instance), we
7145 % want a way to get ttsl. We used to recommend @var for that, so
7146 % leave the code in, but it's strange for @var to lead to typewriter.
7147 % Nowadays we recommend @code, since the difference between a ttsl hyphen
7148 % and a tt hyphen is pretty tiny. @code also disables ?` !`.
7149 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
7151 \sl\hyphenchar\font=45
7154 % We want ()&[] to print specially on the defun line.
7156 \def\activeparens{%
7157 \catcode`\(=\active \catcode`\)=\active
7158 \catcode`\[=\active \catcode`\]=\active
7159 \catcode`\&=\active
7162 % Make control sequences which act like normal parenthesis chars.
7163 \let\lparen = ( \let\rparen = )
7165 % Be sure that we always have a definition for `(', etc. For example,
7166 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7167 % so TeX would otherwise complain about undefined control sequence.
7169 \activeparens
7170 \global\let(=\lparen \global\let)=\rparen
7171 \global\let[=\lbrack \global\let]=\rbrack
7172 \global\let& = \&
7174 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7175 \gdef\magicamp{\let&=\amprm}
7178 \newcount\parencount
7180 % If we encounter &foo, then turn on ()-hacking afterwards
7181 \newif\ifampseen
7182 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
7184 \def\parenfont{%
7185 \ifampseen
7186 % At the first level, print parens in roman,
7187 % otherwise use the default font.
7188 \ifnum \parencount=1 \rm \fi
7189 \else
7190 % The \sf parens (in \boldbrax) actually are a little bolder than
7191 % the contained text. This is especially needed for [ and ] .
7195 \def\infirstlevel#1{%
7196 \ifampseen
7197 \ifnum\parencount=1
7202 \def\bfafterword#1 {#1 \bf}
7204 \def\opnr{%
7205 \global\advance\parencount by 1
7206 {\parenfont(}%
7207 \infirstlevel \bfafterword
7209 \def\clnr{%
7210 {\parenfont)}%
7211 \infirstlevel \sl
7212 \global\advance\parencount by -1
7215 \newcount\brackcount
7216 \def\lbrb{%
7217 \global\advance\brackcount by 1
7218 {\bf[}%
7220 \def\rbrb{%
7221 {\bf]}%
7222 \global\advance\brackcount by -1
7225 \def\checkparencounts{%
7226 \ifnum\parencount=0 \else \badparencount \fi
7227 \ifnum\brackcount=0 \else \badbrackcount \fi
7229 % these should not use \errmessage; the glibc manual, at least, actually
7230 % has such constructs (when documenting function pointers).
7231 \def\badparencount{%
7232 \message{Warning: unbalanced parentheses in @def...}%
7233 \global\parencount=0
7235 \def\badbrackcount{%
7236 \message{Warning: unbalanced square brackets in @def...}%
7237 \global\brackcount=0
7241 \message{macros,}
7242 % @macro.
7244 % To do this right we need a feature of e-TeX, \scantokens,
7245 % which we arrange to emulate with a temporary file in ordinary TeX.
7246 \ifx\eTeXversion\thisisundefined
7247 \newwrite\macscribble
7248 \def\scantokens#1{%
7249 \toks0={#1}%
7250 \immediate\openout\macscribble=\jobname.tmp
7251 \immediate\write\macscribble{\the\toks0}%
7252 \immediate\closeout\macscribble
7253 \input \jobname.tmp
7257 \def\scanmacro#1{\begingroup
7258 \newlinechar`\^^M
7259 \let\xeatspaces\eatspaces
7261 % Undo catcode changes of \startcontents and \doprintindex
7262 % When called from @insertcopying or (short)caption, we need active
7263 % backslash to get it printed correctly. Previously, we had
7264 % \catcode`\\=\other instead. We'll see whether a problem appears
7265 % with macro expansion. --kasal, 19aug04
7266 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
7268 % ... and for \example:
7269 \spaceisspace
7271 % The \empty here causes a following catcode 5 newline to be eaten as
7272 % part of reading whitespace after a control sequence. It does not
7273 % eat a catcode 13 newline. There's no good way to handle the two
7274 % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
7275 % would then have different behavior). See the Macro Details node in
7276 % the manual for the workaround we recommend for macros and
7277 % line-oriented commands.
7279 \scantokens{#1\empty}%
7280 \endgroup}
7282 \def\scanexp#1{%
7283 \edef\temp{\noexpand\scanmacro{#1}}%
7284 \temp
7287 \newcount\paramno % Count of parameters
7288 \newtoks\macname % Macro name
7289 \newif\ifrecursive % Is it recursive?
7291 % List of all defined macros in the form
7292 % \definedummyword\macro1\definedummyword\macro2...
7293 % Currently is also contains all @aliases; the list can be split
7294 % if there is a need.
7295 \def\macrolist{}
7297 % Add the macro to \macrolist
7298 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7299 \def\addtomacrolistxxx#1{%
7300 \toks0 = \expandafter{\macrolist\definedummyword#1}%
7301 \xdef\macrolist{\the\toks0}%
7304 % Utility routines.
7305 % This does \let #1 = #2, with \csnames; that is,
7306 % \let \csname#1\endcsname = \csname#2\endcsname
7307 % (except of course we have to play expansion games).
7309 \def\cslet#1#2{%
7310 \expandafter\let
7311 \csname#1\expandafter\endcsname
7312 \csname#2\endcsname
7315 % Trim leading and trailing spaces off a string.
7316 % Concepts from aro-bend problem 15 (see CTAN).
7317 {\catcode`\@=11
7318 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
7319 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
7320 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
7321 \def\unbrace#1{#1}
7322 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
7325 % Trim a single trailing ^^M off a string.
7326 {\catcode`\^^M=\other \catcode`\Q=3%
7327 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
7328 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
7329 \gdef\eatcrb#1Q#2Q{#1}%
7332 % Macro bodies are absorbed as an argument in a context where
7333 % all characters are catcode 10, 11 or 12, except \ which is active
7334 % (as in normal texinfo). It is necessary to change the definition of \
7335 % to recognize macro arguments; this is the job of \mbodybackslash.
7337 % Non-ASCII encodings make 8-bit characters active, so un-activate
7338 % them to avoid their expansion. Must do this non-globally, to
7339 % confine the change to the current group.
7341 % It's necessary to have hard CRs when the macro is executed. This is
7342 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7343 % body, and then making it the \newlinechar in \scanmacro.
7345 \def\scanctxt{% used as subroutine
7346 \catcode`\"=\other
7347 \catcode`\+=\other
7348 \catcode`\<=\other
7349 \catcode`\>=\other
7350 \catcode`\@=\other
7351 \catcode`\^=\other
7352 \catcode`\_=\other
7353 \catcode`\|=\other
7354 \catcode`\~=\other
7355 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7358 \def\scanargctxt{% used for copying and captions, not macros.
7359 \scanctxt
7360 \catcode`\\=\other
7361 \catcode`\^^M=\other
7364 \def\macrobodyctxt{% used for @macro definitions
7365 \scanctxt
7366 \catcode`\{=\other
7367 \catcode`\}=\other
7368 \catcode`\^^M=\other
7369 \usembodybackslash
7372 \def\macroargctxt{% used when scanning invocations
7373 \scanctxt
7374 \catcode`\\=0
7376 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
7377 % for the single characters \ { }. Thus, we end up with the "commands"
7378 % that would be written @\ @{ @} in a Texinfo document.
7380 % We already have @{ and @}. For @\, we define it here, and only for
7381 % this purpose, to produce a typewriter backslash (so, the @\ that we
7382 % define for @math can't be used with @macro calls):
7384 \def\\{\normalbackslash}%
7386 % We would like to do this for \, too, since that is what makeinfo does.
7387 % But it is not possible, because Texinfo already has a command @, for a
7388 % cedilla accent. Documents must use @comma{} instead.
7390 % \anythingelse will almost certainly be an error of some kind.
7393 % \mbodybackslash is the definition of \ in @macro bodies.
7394 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7395 % where N is the macro parameter number.
7396 % We define \csname macarg.\endcsname to be \realbackslash, so
7397 % \\ in macro replacement text gets you a backslash.
7399 {\catcode`@=0 @catcode`@\=@active
7400 @gdef@usembodybackslash{@let\=@mbodybackslash}
7401 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
7403 \expandafter\def\csname macarg.\endcsname{\realbackslash}
7405 \def\margbackslash#1{\char`\#1 }
7407 \def\macro{\recursivefalse\parsearg\macroxxx}
7408 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7410 \def\macroxxx#1{%
7411 \getargs{#1}% now \macname is the macname and \argl the arglist
7412 \ifx\argl\empty % no arguments
7413 \paramno=0\relax
7414 \else
7415 \expandafter\parsemargdef \argl;%
7416 \if\paramno>256\relax
7417 \ifx\eTeXversion\thisisundefined
7418 \errhelp = \EMsimple
7419 \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
7423 \if1\csname ismacro.\the\macname\endcsname
7424 \message{Warning: redefining \the\macname}%
7425 \else
7426 \expandafter\ifx\csname \the\macname\endcsname \relax
7427 \else \errmessage{Macro name \the\macname\space already defined}\fi
7428 \global\cslet{macsave.\the\macname}{\the\macname}%
7429 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7430 \addtomacrolist{\the\macname}%
7432 \begingroup \macrobodyctxt
7433 \ifrecursive \expandafter\parsermacbody
7434 \else \expandafter\parsemacbody
7435 \fi}
7437 \parseargdef\unmacro{%
7438 \if1\csname ismacro.#1\endcsname
7439 \global\cslet{#1}{macsave.#1}%
7440 \global\expandafter\let \csname ismacro.#1\endcsname=0%
7441 % Remove the macro name from \macrolist:
7442 \begingroup
7443 \expandafter\let\csname#1\endcsname \relax
7444 \let\definedummyword\unmacrodo
7445 \xdef\macrolist{\macrolist}%
7446 \endgroup
7447 \else
7448 \errmessage{Macro #1 not defined}%
7452 % Called by \do from \dounmacro on each macro. The idea is to omit any
7453 % macro definitions that have been changed to \relax.
7455 \def\unmacrodo#1{%
7456 \ifx #1\relax
7457 % remove this
7458 \else
7459 \noexpand\definedummyword \noexpand#1%
7463 % This makes use of the obscure feature that if the last token of a
7464 % <parameter list> is #, then the preceding argument is delimited by
7465 % an opening brace, and that opening brace is not consumed.
7466 \def\getargs#1{\getargsxxx#1{}}
7467 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7468 \def\getmacname#1 #2\relax{\macname={#1}}
7469 \def\getmacargs#1{\def\argl{#1}}
7471 % For macro processing make @ a letter so that we can make Texinfo private macro names.
7472 \edef\texiatcatcode{\the\catcode`\@}
7473 \catcode `@=11\relax
7475 % Parse the optional {params} list. Set up \paramno and \paramlist
7476 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
7477 % in the params list to some hook where the argument si to be expanded. If
7478 % there are less than 10 arguments that hook is to be replaced by ##N where N
7479 % is the position in that list, that is to say the macro arguments are to be
7480 % defined `a la TeX in the macro body.
7482 % That gets used by \mbodybackslash (above).
7484 % We need to get `macro parameter char #' into several definitions.
7485 % The technique used is stolen from LaTeX: let \hash be something
7486 % unexpandable, insert that wherever you need a #, and then redefine
7487 % it to # just before using the token list produced.
7489 % The same technique is used to protect \eatspaces till just before
7490 % the macro is used.
7492 % If there are 10 or more arguments, a different technique is used, where the
7493 % hook remains in the body, and when macro is to be expanded the body is
7494 % processed again to replace the arguments.
7496 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7497 % argument N value and then \edef the body (nothing else will expand because of
7498 % the catcode regime underwhich the body was input).
7500 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7501 % arguments, you need that no macro has more than 256 arguments, otherwise an
7502 % error is produced.
7503 \def\parsemargdef#1;{%
7504 \paramno=0\def\paramlist{}%
7505 \let\hash\relax
7506 \let\xeatspaces\relax
7507 \parsemargdefxxx#1,;,%
7508 % In case that there are 10 or more arguments we parse again the arguments
7509 % list to set new definitions for the \macarg.BLAH macros corresponding to
7510 % each BLAH argument. It was anyhow needed to parse already once this list
7511 % in order to count the arguments, and as macros with at most 9 arguments
7512 % are by far more frequent than macro with 10 or more arguments, defining
7513 % twice the \macarg.BLAH macros does not cost too much processing power.
7514 \ifnum\paramno<10\relax\else
7515 \paramno0\relax
7516 \parsemmanyargdef@@#1,;,% 10 or more arguments
7519 \def\parsemargdefxxx#1,{%
7520 \if#1;\let\next=\relax
7521 \else \let\next=\parsemargdefxxx
7522 \advance\paramno by 1
7523 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7524 {\xeatspaces{\hash\the\paramno}}%
7525 \edef\paramlist{\paramlist\hash\the\paramno,}%
7526 \fi\next}
7528 \def\parsemmanyargdef@@#1,{%
7529 \if#1;\let\next=\relax
7530 \else
7531 \let\next=\parsemmanyargdef@@
7532 \edef\tempb{\eatspaces{#1}}%
7533 \expandafter\def\expandafter\tempa
7534 \expandafter{\csname macarg.\tempb\endcsname}%
7535 % Note that we need some extra \noexpand\noexpand, this is because we
7536 % don't want \the to be expanded in the \parsermacbody as it uses an
7537 % \xdef .
7538 \expandafter\edef\tempa
7539 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7540 \advance\paramno by 1\relax
7541 \fi\next}
7543 % These two commands read recursive and nonrecursive macro bodies.
7544 % (They're different since rec and nonrec macros end differently.)
7547 \catcode `\@\texiatcatcode
7548 \long\def\parsemacbody#1@end macro%
7549 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7550 \long\def\parsermacbody#1@end rmacro%
7551 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7552 \catcode `\@=11\relax
7554 \let\endargs@\relax
7555 \let\nil@\relax
7556 \def\nilm@{\nil@}%
7557 \long\def\nillm@{\nil@}%
7559 % This macro is expanded during the Texinfo macro expansion, not during its
7560 % definition. It gets all the arguments values and assigns them to macros
7561 % macarg.ARGNAME
7563 % #1 is the macro name
7564 % #2 is the list of argument names
7565 % #3 is the list of argument values
7566 \def\getargvals@#1#2#3{%
7567 \def\macargdeflist@{}%
7568 \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
7569 \def\paramlist{#2,\nil@}%
7570 \def\macroname{#1}%
7571 \begingroup
7572 \macroargctxt
7573 \def\argvaluelist{#3,\nil@}%
7574 \def\@tempa{#3}%
7575 \ifx\@tempa\empty
7576 \setemptyargvalues@
7577 \else
7578 \getargvals@@
7583 \def\getargvals@@{%
7584 \ifx\paramlist\nilm@
7585 % Some sanity check needed here that \argvaluelist is also empty.
7586 \ifx\argvaluelist\nillm@
7587 \else
7588 \errhelp = \EMsimple
7589 \errmessage{Too many arguments in macro `\macroname'!}%
7591 \let\next\macargexpandinbody@
7592 \else
7593 \ifx\argvaluelist\nillm@
7594 % No more arguments values passed to macro. Set remaining named-arg
7595 % macros to empty.
7596 \let\next\setemptyargvalues@
7597 \else
7598 % pop current arg name into \@tempb
7599 \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
7600 \expandafter\@tempa\expandafter{\paramlist}%
7601 % pop current argument value into \@tempc
7602 \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
7603 \expandafter\@tempa\expandafter{\argvaluelist}%
7604 % Here \@tempb is the current arg name and \@tempc is the current arg value.
7605 % First place the new argument macro definition into \@tempd
7606 \expandafter\macname\expandafter{\@tempc}%
7607 \expandafter\let\csname macarg.\@tempb\endcsname\relax
7608 \expandafter\def\expandafter\@tempe\expandafter{%
7609 \csname macarg.\@tempb\endcsname}%
7610 \edef\@tempd{\long\def\@tempe{\the\macname}}%
7611 \push@\@tempd\macargdeflist@
7612 \let\next\getargvals@@
7615 \next
7618 \def\push@#1#2{%
7619 \expandafter\expandafter\expandafter\def
7620 \expandafter\expandafter\expandafter#2%
7621 \expandafter\expandafter\expandafter{%
7622 \expandafter#1#2}%
7625 % Replace arguments by their values in the macro body, and place the result
7626 % in macro \@tempa
7627 \def\macvalstoargs@{%
7628 % To do this we use the property that token registers that are \the'ed
7629 % within an \edef expand only once. So we are going to place all argument
7630 % values into respective token registers.
7632 % First we save the token context, and initialize argument numbering.
7633 \begingroup
7634 \paramno0\relax
7635 % Then, for each argument number #N, we place the corresponding argument
7636 % value into a new token list register \toks#N
7637 \expandafter\putargsintokens@\saveparamlist@,;,%
7638 % Then, we expand the body so that argument are replaced by their
7639 % values. The trick for values not to be expanded themselves is that they
7640 % are within tokens and that tokens expand only once in an \edef .
7641 \edef\@tempc{\csname mac.\macroname .body\endcsname}%
7642 % Now we restore the token stack pointer to free the token list registers
7643 % which we have used, but we make sure that expanded body is saved after
7644 % group.
7645 \expandafter
7646 \endgroup
7647 \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
7650 \def\macargexpandinbody@{%
7651 %% Define the named-macro outside of this group and then close this group.
7652 \expandafter
7653 \endgroup
7654 \macargdeflist@
7655 % First the replace in body the macro arguments by their values, the result
7656 % is in \@tempa .
7657 \macvalstoargs@
7658 % Then we point at the \norecurse or \gobble (for recursive) macro value
7659 % with \@tempb .
7660 \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
7661 % Depending on whether it is recursive or not, we need some tailing
7662 % \egroup .
7663 \ifx\@tempb\gobble
7664 \let\@tempc\relax
7665 \else
7666 \let\@tempc\egroup
7668 % And now we do the real job:
7669 \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
7670 \@tempd
7673 \def\putargsintokens@#1,{%
7674 \if#1;\let\next\relax
7675 \else
7676 \let\next\putargsintokens@
7677 % First we allocate the new token list register, and give it a temporary
7678 % alias \@tempb .
7679 \toksdef\@tempb\the\paramno
7680 % Then we place the argument value into that token list register.
7681 \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
7682 \expandafter\@tempb\expandafter{\@tempa}%
7683 \advance\paramno by 1\relax
7685 \next
7688 % Save the token stack pointer into macro #1
7689 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}}
7690 % Restore the token stack pointer from number in macro #1
7691 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax}
7692 % newtoks that can be used non \outer .
7693 \def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi}
7695 % Tailing missing arguments are set to empty
7696 \def\setemptyargvalues@{%
7697 \ifx\paramlist\nilm@
7698 \let\next\macargexpandinbody@
7699 \else
7700 \expandafter\setemptyargvaluesparser@\paramlist\endargs@
7701 \let\next\setemptyargvalues@
7703 \next
7706 \def\setemptyargvaluesparser@#1,#2\endargs@{%
7707 \expandafter\def\expandafter\@tempa\expandafter{%
7708 \expandafter\def\csname macarg.#1\endcsname{}}%
7709 \push@\@tempa\macargdeflist@
7710 \def\paramlist{#2}%
7713 % #1 is the element target macro
7714 % #2 is the list macro
7715 % #3,#4\endargs@ is the list value
7716 \def\pop@#1#2#3,#4\endargs@{%
7717 \def#1{#3}%
7718 \def#2{#4}%
7720 \long\def\longpop@#1#2#3,#4\endargs@{%
7721 \long\def#1{#3}%
7722 \long\def#2{#4}%
7725 % This defines a Texinfo @macro. There are eight cases: recursive and
7726 % nonrecursive macros of zero, one, up to nine, and many arguments.
7727 % Much magic with \expandafter here.
7728 % \xdef is used so that macro definitions will survive the file
7729 % they're defined in; @include reads the file inside a group.
7731 \def\defmacro{%
7732 \let\hash=##% convert placeholders to macro parameter chars
7733 \ifrecursive
7734 \ifcase\paramno
7736 \expandafter\xdef\csname\the\macname\endcsname{%
7737 \noexpand\scanmacro{\temp}}%
7738 \or % 1
7739 \expandafter\xdef\csname\the\macname\endcsname{%
7740 \bgroup\noexpand\macroargctxt
7741 \noexpand\braceorline
7742 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7743 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7744 \egroup\noexpand\scanmacro{\temp}}%
7745 \else
7746 \ifnum\paramno<10\relax % at most 9
7747 \expandafter\xdef\csname\the\macname\endcsname{%
7748 \bgroup\noexpand\macroargctxt
7749 \noexpand\csname\the\macname xx\endcsname}%
7750 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7751 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7752 \expandafter\expandafter
7753 \expandafter\xdef
7754 \expandafter\expandafter
7755 \csname\the\macname xxx\endcsname
7756 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7757 \else % 10 or more
7758 \expandafter\xdef\csname\the\macname\endcsname{%
7759 \noexpand\getargvals@{\the\macname}{\argl}%
7761 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7762 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
7765 \else
7766 \ifcase\paramno
7768 \expandafter\xdef\csname\the\macname\endcsname{%
7769 \noexpand\norecurse{\the\macname}%
7770 \noexpand\scanmacro{\temp}\egroup}%
7771 \or % 1
7772 \expandafter\xdef\csname\the\macname\endcsname{%
7773 \bgroup\noexpand\macroargctxt
7774 \noexpand\braceorline
7775 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7776 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7777 \egroup
7778 \noexpand\norecurse{\the\macname}%
7779 \noexpand\scanmacro{\temp}\egroup}%
7780 \else % at most 9
7781 \ifnum\paramno<10\relax
7782 \expandafter\xdef\csname\the\macname\endcsname{%
7783 \bgroup\noexpand\macroargctxt
7784 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7785 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7786 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7787 \expandafter\expandafter
7788 \expandafter\xdef
7789 \expandafter\expandafter
7790 \csname\the\macname xxx\endcsname
7791 \paramlist{%
7792 \egroup
7793 \noexpand\norecurse{\the\macname}%
7794 \noexpand\scanmacro{\temp}\egroup}%
7795 \else % 10 or more:
7796 \expandafter\xdef\csname\the\macname\endcsname{%
7797 \noexpand\getargvals@{\the\macname}{\argl}%
7799 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7800 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
7803 \fi}
7805 \catcode `\@\texiatcatcode\relax
7807 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7809 % \braceorline decides whether the next nonwhitespace character is a
7810 % {. If so it reads up to the closing }, if not, it reads the whole
7811 % line. Whatever was read is then fed to the next control sequence
7812 % as an argument (by \parsebrace or \parsearg).
7814 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7815 \def\braceorlinexxx{%
7816 \ifx\nchar\bgroup\else
7817 \expandafter\parsearg
7818 \fi \macnamexxx}
7821 % @alias.
7822 % We need some trickery to remove the optional spaces around the equal
7823 % sign. Make them active and then expand them all to nothing.
7825 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7826 \def\aliasxxx #1{\aliasyyy#1\relax}
7827 \def\aliasyyy #1=#2\relax{%
7829 \expandafter\let\obeyedspace=\empty
7830 \addtomacrolist{#1}%
7831 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7833 \next
7837 \message{cross references,}
7839 \newwrite\auxfile
7840 \newif\ifhavexrefs % True if xref values are known.
7841 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7843 % @inforef is relatively simple.
7844 \def\inforef #1{\inforefzzz #1,,,,**}
7845 \def\inforefzzz #1,#2,#3,#4**{%
7846 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7847 node \samp{\ignorespaces#1{}}}
7849 % @node's only job in TeX is to define \lastnode, which is used in
7850 % cross-references. The @node line might or might not have commas, and
7851 % might or might not have spaces before the first comma, like:
7852 % @node foo , bar , ...
7853 % We don't want such trailing spaces in the node name.
7855 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7857 % also remove a trailing comma, in case of something like this:
7858 % @node Help-Cross, , , Cross-refs
7859 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7860 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7862 \let\nwnode=\node
7863 \let\lastnode=\empty
7865 % Write a cross-reference definition for the current node. #1 is the
7866 % type (Ynumbered, Yappendix, Ynothing).
7868 \def\donoderef#1{%
7869 \ifx\lastnode\empty\else
7870 \setref{\lastnode}{#1}%
7871 \global\let\lastnode=\empty
7875 % @anchor{NAME} -- define xref target at arbitrary point.
7877 \newcount\savesfregister
7879 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7880 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7881 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7883 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7884 % anchor), which consists of three parts:
7885 % 1) NAME-title - the current sectioning name taken from \lastsection,
7886 % or the anchor name.
7887 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7888 % empty for anchors.
7889 % 3) NAME-pg - the page number.
7891 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7892 % floats, there is an additional part, which is not written here:
7893 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7895 \def\setref#1#2{%
7896 \pdfmkdest{#1}%
7897 \iflinks
7899 \atdummies % preserve commands, but don't expand them
7900 \edef\writexrdef##1##2{%
7901 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7902 ##1}{##2}}% these are parameters of \writexrdef
7904 \toks0 = \expandafter{\lastsection}%
7905 \immediate \writexrdef{title}{\the\toks0 }%
7906 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7907 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
7912 % @xrefautosectiontitle on|off says whether @section(ing) names are used
7913 % automatically in xrefs, if the third arg is not explicitly specified.
7914 % This was provided as a "secret" @set xref-automatic-section-title
7915 % variable, now it's official.
7917 \parseargdef\xrefautomaticsectiontitle{%
7918 \def\temp{#1}%
7919 \ifx\temp\onword
7920 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7921 = \empty
7922 \else\ifx\temp\offword
7923 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7924 = \relax
7925 \else
7926 \errhelp = \EMsimple
7927 \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
7928 must be on|off}%
7929 \fi\fi
7932 % \f
7933 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7934 % the node name, #2 the name of the Info cross-reference, #3 the printed
7935 % node name, #4 the name of the Info file, #5 the name of the printed
7936 % manual. All but the node name can be omitted.
7938 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7939 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7940 \def\ref#1{\xrefX[#1,,,,,,,]}
7942 \newbox\toprefbox
7943 \newbox\printedrefnamebox
7944 \newbox\infofilenamebox
7945 \newbox\printedmanualbox
7947 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7948 \unsepspaces
7950 % Get args without leading/trailing spaces.
7951 \def\printedrefname{\ignorespaces #3}%
7952 \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
7954 \def\infofilename{\ignorespaces #4}%
7955 \setbox\infofilenamebox = \hbox{\infofilename\unskip}%
7957 \def\printedmanual{\ignorespaces #5}%
7958 \setbox\printedmanualbox = \hbox{\printedmanual\unskip}%
7960 % If the printed reference name (arg #3) was not explicitly given in
7961 % the @xref, figure out what we want to use.
7962 \ifdim \wd\printedrefnamebox = 0pt
7963 % No printed node name was explicitly given.
7964 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
7965 % Not auto section-title: use node name inside the square brackets.
7966 \def\printedrefname{\ignorespaces #1}%
7967 \else
7968 % Auto section-title: use chapter/section title inside
7969 % the square brackets if we have it.
7970 \ifdim \wd\printedmanualbox > 0pt
7971 % It is in another manual, so we don't have it; use node name.
7972 \def\printedrefname{\ignorespaces #1}%
7973 \else
7974 \ifhavexrefs
7975 % We (should) know the real title if we have the xref values.
7976 \def\printedrefname{\refx{#1-title}{}}%
7977 \else
7978 % Otherwise just copy the Info node name.
7979 \def\printedrefname{\ignorespaces #1}%
7980 \fi%
7985 % Make link in pdf output.
7986 \ifpdf
7987 {\indexnofonts
7988 \turnoffactive
7989 \makevalueexpandable
7990 % This expands tokens, so do it after making catcode changes, so _
7991 % etc. don't get their TeX definitions. This ignores all spaces in
7992 % #4, including (wrongly) those in the middle of the filename.
7993 \getfilename{#4}%
7995 % This (wrongly) does not take account of leading or trailing
7996 % spaces in #1, which should be ignored.
7997 \edef\pdfxrefdest{#1}%
7998 \ifx\pdfxrefdest\empty
7999 \def\pdfxrefdest{Top}% no empty targets
8000 \else
8001 \txiescapepdf\pdfxrefdest % escape PDF special chars
8004 \leavevmode
8005 \startlink attr{/Border [0 0 0]}%
8006 \ifnum\filenamelength>0
8007 goto file{\the\filename.pdf} name{\pdfxrefdest}%
8008 \else
8009 goto name{\pdfmkpgn{\pdfxrefdest}}%
8012 \setcolor{\linkcolor}%
8015 % Float references are printed completely differently: "Figure 1.2"
8016 % instead of "[somenode], p.3". We distinguish them by the
8017 % LABEL-title being set to a magic string.
8019 % Have to otherify everything special to allow the \csname to
8020 % include an _ in the xref name, etc.
8021 \indexnofonts
8022 \turnoffactive
8023 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
8024 \csname XR#1-title\endcsname
8026 \iffloat\Xthisreftitle
8027 % If the user specified the print name (third arg) to the ref,
8028 % print it instead of our usual "Figure 1.2".
8029 \ifdim\wd\printedrefnamebox = 0pt
8030 \refx{#1-snt}{}%
8031 \else
8032 \printedrefname
8035 % If the user also gave the printed manual name (fifth arg), append
8036 % "in MANUALNAME".
8037 \ifdim \wd\printedmanualbox > 0pt
8038 \space \putwordin{} \cite{\printedmanual}%
8040 \else
8041 % node/anchor (non-float) references.
8043 % If we use \unhbox to print the node names, TeX does not insert
8044 % empty discretionaries after hyphens, which means that it will not
8045 % find a line break at a hyphen in a node names. Since some manuals
8046 % are best written with fairly long node names, containing hyphens,
8047 % this is a loss. Therefore, we give the text of the node name
8048 % again, so it is as if TeX is seeing it for the first time.
8050 \ifdim \wd\printedmanualbox > 0pt
8051 % Cross-manual reference with a printed manual name.
8053 \crossmanualxref{\cite{\printedmanual\unskip}}%
8055 \else\ifdim \wd\infofilenamebox > 0pt
8056 % Cross-manual reference with only an info filename (arg 4), no
8057 % printed manual name (arg 5). This is essentially the same as
8058 % the case above; we output the filename, since we have nothing else.
8060 \crossmanualxref{\code{\infofilename\unskip}}%
8062 \else
8063 % Reference within this manual.
8065 % _ (for example) has to be the character _ for the purposes of the
8066 % control sequence corresponding to the node, but it has to expand
8067 % into the usual \leavevmode...\vrule stuff for purposes of
8068 % printing. So we \turnoffactive for the \refx-snt, back on for the
8069 % printing, back off for the \refx-pg.
8070 {\turnoffactive
8071 % Only output a following space if the -snt ref is nonempty; for
8072 % @unnumbered and @anchor, it won't be.
8073 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
8074 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
8076 % output the `[mynode]' via the macro below so it can be overridden.
8077 \xrefprintnodename\printedrefname
8079 % But we always want a comma and a space:
8080 ,\space
8082 % output the `page 3'.
8083 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
8084 \fi\fi
8086 \endlink
8087 \endgroup}
8089 % Output a cross-manual xref to #1. Used just above (twice).
8091 % Only include the text "Section ``foo'' in" if the foo is neither
8092 % missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply
8093 % "see The Foo Manual", the idea being to refer to the whole manual.
8095 % But, this being TeX, we can't easily compare our node name against the
8096 % string "Top" while ignoring the possible spaces before and after in
8097 % the input. By adding the arbitrary 7sp below, we make it much less
8098 % likely that a real node name would have the same width as "Top" (e.g.,
8099 % in a monospaced font). Hopefully it will never happen in practice.
8101 % For the same basic reason, we retypeset the "Top" at every
8102 % reference, since the current font is indeterminate.
8104 \def\crossmanualxref#1{%
8105 \setbox\toprefbox = \hbox{Top\kern7sp}%
8106 \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8107 \ifdim \wd2 > 7sp % nonempty?
8108 \ifdim \wd2 = \wd\toprefbox \else % same as Top?
8109 \putwordSection{} ``\printedrefname'' \putwordin{}\space
8115 % This macro is called from \xrefX for the `[nodename]' part of xref
8116 % output. It's a separate macro only so it can be changed more easily,
8117 % since square brackets don't work well in some documents. Particularly
8118 % one that Bob is working on :).
8120 \def\xrefprintnodename#1{[#1]}
8122 % Things referred to by \setref.
8124 \def\Ynothing{}
8125 \def\Yomitfromtoc{}
8126 \def\Ynumbered{%
8127 \ifnum\secno=0
8128 \putwordChapter@tie \the\chapno
8129 \else \ifnum\subsecno=0
8130 \putwordSection@tie \the\chapno.\the\secno
8131 \else \ifnum\subsubsecno=0
8132 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
8133 \else
8134 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
8135 \fi\fi\fi
8137 \def\Yappendix{%
8138 \ifnum\secno=0
8139 \putwordAppendix@tie @char\the\appendixno{}%
8140 \else \ifnum\subsecno=0
8141 \putwordSection@tie @char\the\appendixno.\the\secno
8142 \else \ifnum\subsubsecno=0
8143 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
8144 \else
8145 \putwordSection@tie
8146 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
8147 \fi\fi\fi
8150 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
8151 % If its value is nonempty, SUFFIX is output afterward.
8153 \def\refx#1#2{%
8155 \indexnofonts
8156 \otherbackslash
8157 \expandafter\global\expandafter\let\expandafter\thisrefX
8158 \csname XR#1\endcsname
8160 \ifx\thisrefX\relax
8161 % If not defined, say something at least.
8162 \angleleft un\-de\-fined\angleright
8163 \iflinks
8164 \ifhavexrefs
8165 {\toks0 = {#1}% avoid expansion of possibly-complex value
8166 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
8167 \else
8168 \ifwarnedxrefs\else
8169 \global\warnedxrefstrue
8170 \message{Cross reference values unknown; you must run TeX again.}%
8174 \else
8175 % It's defined, so just use it.
8176 \thisrefX
8178 #2% Output the suffix in any case.
8181 % This is the macro invoked by entries in the aux file. Usually it's
8182 % just a \def (we prepend XR to the control sequence name to avoid
8183 % collisions). But if this is a float type, we have more work to do.
8185 \def\xrdef#1#2{%
8186 {% The node name might contain 8-bit characters, which in our current
8187 % implementation are changed to commands like @'e. Don't let these
8188 % mess up the control sequence name.
8189 \indexnofonts
8190 \turnoffactive
8191 \xdef\safexrefname{#1}%
8194 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
8196 % Was that xref control sequence that we just defined for a float?
8197 \expandafter\iffloat\csname XR\safexrefname\endcsname
8198 % it was a float, and we have the (safe) float type in \iffloattype.
8199 \expandafter\let\expandafter\floatlist
8200 \csname floatlist\iffloattype\endcsname
8202 % Is this the first time we've seen this float type?
8203 \expandafter\ifx\floatlist\relax
8204 \toks0 = {\do}% yes, so just \do
8205 \else
8206 % had it before, so preserve previous elements in list.
8207 \toks0 = \expandafter{\floatlist\do}%
8210 % Remember this xref in the control sequence \floatlistFLOATTYPE,
8211 % for later use in \listoffloats.
8212 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
8213 {\safexrefname}}%
8217 % Read the last existing aux file, if any. No error if none exists.
8219 \def\tryauxfile{%
8220 \openin 1 \jobname.aux
8221 \ifeof 1 \else
8222 \readdatafile{aux}%
8223 \global\havexrefstrue
8225 \closein 1
8228 \def\setupdatafile{%
8229 \catcode`\^^@=\other
8230 \catcode`\^^A=\other
8231 \catcode`\^^B=\other
8232 \catcode`\^^C=\other
8233 \catcode`\^^D=\other
8234 \catcode`\^^E=\other
8235 \catcode`\^^F=\other
8236 \catcode`\^^G=\other
8237 \catcode`\^^H=\other
8238 \catcode`\^^K=\other
8239 \catcode`\^^L=\other
8240 \catcode`\^^N=\other
8241 \catcode`\^^P=\other
8242 \catcode`\^^Q=\other
8243 \catcode`\^^R=\other
8244 \catcode`\^^S=\other
8245 \catcode`\^^T=\other
8246 \catcode`\^^U=\other
8247 \catcode`\^^V=\other
8248 \catcode`\^^W=\other
8249 \catcode`\^^X=\other
8250 \catcode`\^^Z=\other
8251 \catcode`\^^[=\other
8252 \catcode`\^^\=\other
8253 \catcode`\^^]=\other
8254 \catcode`\^^^=\other
8255 \catcode`\^^_=\other
8256 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8257 % in xref tags, i.e., node names. But since ^^e4 notation isn't
8258 % supported in the main text, it doesn't seem desirable. Furthermore,
8259 % that is not enough: for node names that actually contain a ^
8260 % character, we would end up writing a line like this: 'xrdef {'hat
8261 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8262 % argument, and \hat is not an expandable control sequence. It could
8263 % all be worked out, but why? Either we support ^^ or we don't.
8265 % The other change necessary for this was to define \auxhat:
8266 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8267 % and then to call \auxhat in \setq.
8269 \catcode`\^=\other
8271 % Special characters. Should be turned off anyway, but...
8272 \catcode`\~=\other
8273 \catcode`\[=\other
8274 \catcode`\]=\other
8275 \catcode`\"=\other
8276 \catcode`\_=\other
8277 \catcode`\|=\other
8278 \catcode`\<=\other
8279 \catcode`\>=\other
8280 \catcode`\$=\other
8281 \catcode`\#=\other
8282 \catcode`\&=\other
8283 \catcode`\%=\other
8284 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
8286 % This is to support \ in node names and titles, since the \
8287 % characters end up in a \csname. It's easier than
8288 % leaving it active and making its active definition an actual \
8289 % character. What I don't understand is why it works in the *value*
8290 % of the xrdef. Seems like it should be a catcode12 \, and that
8291 % should not typeset properly. But it works, so I'm moving on for
8292 % now. --karl, 15jan04.
8293 \catcode`\\=\other
8295 % Make the characters 128-255 be printing characters.
8297 \count1=128
8298 \def\loop{%
8299 \catcode\count1=\other
8300 \advance\count1 by 1
8301 \ifnum \count1<256 \loop \fi
8305 % @ is our escape character in .aux files, and we need braces.
8306 \catcode`\{=1
8307 \catcode`\}=2
8308 \catcode`\@=0
8311 \def\readdatafile#1{%
8312 \begingroup
8313 \setupdatafile
8314 \input\jobname.#1
8315 \endgroup}
8318 \message{insertions,}
8319 % including footnotes.
8321 \newcount \footnoteno
8323 % The trailing space in the following definition for supereject is
8324 % vital for proper filling; pages come out unaligned when you do a
8325 % pagealignmacro call if that space before the closing brace is
8326 % removed. (Generally, numeric constants should always be followed by a
8327 % space to prevent strange expansion errors.)
8328 \def\supereject{\par\penalty -20000\footnoteno =0 }
8330 % @footnotestyle is meaningful for Info output only.
8331 \let\footnotestyle=\comment
8333 {\catcode `\@=11
8335 % Auto-number footnotes. Otherwise like plain.
8336 \gdef\footnote{%
8337 \let\indent=\ptexindent
8338 \let\noindent=\ptexnoindent
8339 \global\advance\footnoteno by \@ne
8340 \edef\thisfootno{$^{\the\footnoteno}$}%
8342 % In case the footnote comes at the end of a sentence, preserve the
8343 % extra spacing after we do the footnote number.
8344 \let\@sf\empty
8345 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
8347 % Remove inadvertent blank space before typesetting the footnote number.
8348 \unskip
8349 \thisfootno\@sf
8350 \dofootnote
8353 % Don't bother with the trickery in plain.tex to not require the
8354 % footnote text as a parameter. Our footnotes don't need to be so general.
8356 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8357 % \parseargline) fails inside footnotes because the tokens are fixed when
8358 % the footnote is read. --karl, 16nov96.
8360 \gdef\dofootnote{%
8361 \insert\footins\bgroup
8362 % We want to typeset this text as a normal paragraph, even if the
8363 % footnote reference occurs in (for example) a display environment.
8364 % So reset some parameters.
8365 \hsize=\pagewidth
8366 \interlinepenalty\interfootnotelinepenalty
8367 \splittopskip\ht\strutbox % top baseline for broken footnotes
8368 \splitmaxdepth\dp\strutbox
8369 \floatingpenalty\@MM
8370 \leftskip\z@skip
8371 \rightskip\z@skip
8372 \spaceskip\z@skip
8373 \xspaceskip\z@skip
8374 \parindent\defaultparindent
8376 \smallfonts \rm
8378 % Because we use hanging indentation in footnotes, a @noindent appears
8379 % to exdent this text, so make it be a no-op. makeinfo does not use
8380 % hanging indentation so @noindent can still be needed within footnote
8381 % text after an @example or the like (not that this is good style).
8382 \let\noindent = \relax
8384 % Hang the footnote text off the number. Use \everypar in case the
8385 % footnote extends for more than one paragraph.
8386 \everypar = {\hang}%
8387 \textindent{\thisfootno}%
8389 % Don't crash into the line above the footnote text. Since this
8390 % expands into a box, it must come within the paragraph, lest it
8391 % provide a place where TeX can split the footnote.
8392 \footstrut
8394 % Invoke rest of plain TeX footnote routine.
8395 \futurelet\next\fo@t
8397 }%end \catcode `\@=11
8399 % In case a @footnote appears in a vbox, save the footnote text and create
8400 % the real \insert just after the vbox finished. Otherwise, the insertion
8401 % would be lost.
8402 % Similarly, if a @footnote appears inside an alignment, save the footnote
8403 % text to a box and make the \insert when a row of the table is finished.
8404 % And the same can be done for other insert classes. --kasal, 16nov03.
8406 % Replace the \insert primitive by a cheating macro.
8407 % Deeper inside, just make sure that the saved insertions are not spilled
8408 % out prematurely.
8410 \def\startsavinginserts{%
8411 \ifx \insert\ptexinsert
8412 \let\insert\saveinsert
8413 \else
8414 \let\checkinserts\relax
8418 % This \insert replacement works for both \insert\footins{foo} and
8419 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8421 \def\saveinsert#1{%
8422 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8423 \afterassignment\next
8424 % swallow the left brace
8425 \let\temp =
8427 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
8428 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
8430 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8432 \def\placesaveins#1{%
8433 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8434 {\box#1}%
8437 % eat @SAVE -- beware, all of them have catcode \other:
8439 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
8440 \gdef\gobblesave @SAVE{}
8443 % initialization:
8444 \def\newsaveins #1{%
8445 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8446 \next
8448 \def\newsaveinsX #1{%
8449 \csname newbox\endcsname #1%
8450 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8451 \checksaveins #1}%
8454 % initialize:
8455 \let\checkinserts\empty
8456 \newsaveins\footins
8457 \newsaveins\margin
8460 % @image. We use the macros from epsf.tex to support this.
8461 % If epsf.tex is not installed and @image is used, we complain.
8463 % Check for and read epsf.tex up front. If we read it only at @image
8464 % time, we might be inside a group, and then its definitions would get
8465 % undone and the next image would fail.
8466 \openin 1 = epsf.tex
8467 \ifeof 1 \else
8468 % Do not bother showing banner with epsf.tex v2.7k (available in
8469 % doc/epsf.tex and on ctan).
8470 \def\epsfannounce{\toks0 = }%
8471 \input epsf.tex
8473 \closein 1
8475 % We will only complain once about lack of epsf.tex.
8476 \newif\ifwarnednoepsf
8477 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8478 work. It is also included in the Texinfo distribution, or you can get
8479 it from ftp://tug.org/tex/epsf.tex.}
8481 \def\image#1{%
8482 \ifx\epsfbox\thisisundefined
8483 \ifwarnednoepsf \else
8484 \errhelp = \noepsfhelp
8485 \errmessage{epsf.tex not found, images will be ignored}%
8486 \global\warnednoepsftrue
8488 \else
8489 \imagexxx #1,,,,,\finish
8493 % Arguments to @image:
8494 % #1 is (mandatory) image filename; we tack on .eps extension.
8495 % #2 is (optional) width, #3 is (optional) height.
8496 % #4 is (ignored optional) html alt text.
8497 % #5 is (ignored optional) extension.
8498 % #6 is just the usual extra ignored arg for parsing stuff.
8499 \newif\ifimagevmode
8500 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
8501 \catcode`\^^M = 5 % in case we're inside an example
8502 \normalturnoffactive % allow _ et al. in names
8503 % If the image is by itself, center it.
8504 \ifvmode
8505 \imagevmodetrue
8506 \else \ifx\centersub\centerV
8507 % for @center @image, we need a vbox so we can have our vertical space
8508 \imagevmodetrue
8509 \vbox\bgroup % vbox has better behavior than vtop herev
8510 \fi\fi
8512 \ifimagevmode
8513 \nobreak\medskip
8514 % Usually we'll have text after the image which will insert
8515 % \parskip glue, so insert it here too to equalize the space
8516 % above and below.
8517 \nobreak\vskip\parskip
8518 \nobreak
8521 % Leave vertical mode so that indentation from an enclosing
8522 % environment such as @quotation is respected.
8523 % However, if we're at the top level, we don't want the
8524 % normal paragraph indentation.
8525 % On the other hand, if we are in the case of @center @image, we don't
8526 % want to start a paragraph, which will create a hsize-width box and
8527 % eradicate the centering.
8528 \ifx\centersub\centerV\else \noindent \fi
8530 % Output the image.
8531 \ifpdf
8532 \dopdfimage{#1}{#2}{#3}%
8533 \else
8534 % \epsfbox itself resets \epsf?size at each figure.
8535 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
8536 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
8537 \epsfbox{#1.eps}%
8540 \ifimagevmode
8541 \medskip % space after a standalone image
8543 \ifx\centersub\centerV \egroup \fi
8544 \endgroup}
8547 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8548 % etc. We don't actually implement floating yet, we always include the
8549 % float "here". But it seemed the best name for the future.
8551 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
8553 % There may be a space before second and/or third parameter; delete it.
8554 \def\eatcommaspace#1, {#1,}
8556 % #1 is the optional FLOATTYPE, the text label for this float, typically
8557 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
8558 % this float will not be numbered and cannot be referred to.
8560 % #2 is the optional xref label. Also must be present for the float to
8561 % be referable.
8563 % #3 is the optional positioning argument; for now, it is ignored. It
8564 % will somehow specify the positions allowed to float to (here, top, bottom).
8566 % We keep a separate counter for each FLOATTYPE, which we reset at each
8567 % chapter-level command.
8568 \let\resetallfloatnos=\empty
8570 \def\dofloat#1,#2,#3,#4\finish{%
8571 \let\thiscaption=\empty
8572 \let\thisshortcaption=\empty
8574 % don't lose footnotes inside @float.
8576 % BEWARE: when the floats start float, we have to issue warning whenever an
8577 % insert appears inside a float which could possibly float. --kasal, 26may04
8579 \startsavinginserts
8581 % We can't be used inside a paragraph.
8582 \par
8584 \vtop\bgroup
8585 \def\floattype{#1}%
8586 \def\floatlabel{#2}%
8587 \def\floatloc{#3}% we do nothing with this yet.
8589 \ifx\floattype\empty
8590 \let\safefloattype=\empty
8591 \else
8593 % the floattype might have accents or other special characters,
8594 % but we need to use it in a control sequence name.
8595 \indexnofonts
8596 \turnoffactive
8597 \xdef\safefloattype{\floattype}%
8601 % If label is given but no type, we handle that as the empty type.
8602 \ifx\floatlabel\empty \else
8603 % We want each FLOATTYPE to be numbered separately (Figure 1,
8604 % Table 1, Figure 2, ...). (And if no label, no number.)
8606 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
8607 \global\advance\floatno by 1
8610 % This magic value for \lastsection is output by \setref as the
8611 % XREFLABEL-title value. \xrefX uses it to distinguish float
8612 % labels (which have a completely different output format) from
8613 % node and anchor labels. And \xrdef uses it to construct the
8614 % lists of floats.
8616 \edef\lastsection{\floatmagic=\safefloattype}%
8617 \setref{\floatlabel}{Yfloat}%
8621 % start with \parskip glue, I guess.
8622 \vskip\parskip
8624 % Don't suppress indentation if a float happens to start a section.
8625 \restorefirstparagraphindent
8628 % we have these possibilities:
8629 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8630 % @float Foo,lbl & no caption: Foo 1.1
8631 % @float Foo & @caption{Cap}: Foo: Cap
8632 % @float Foo & no caption: Foo
8633 % @float ,lbl & Caption{Cap}: 1.1: Cap
8634 % @float ,lbl & no caption: 1.1
8635 % @float & @caption{Cap}: Cap
8636 % @float & no caption:
8638 \def\Efloat{%
8639 \let\floatident = \empty
8641 % In all cases, if we have a float type, it comes first.
8642 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8644 % If we have an xref label, the number comes next.
8645 \ifx\floatlabel\empty \else
8646 \ifx\floattype\empty \else % if also had float type, need tie first.
8647 \appendtomacro\floatident{\tie}%
8649 % the number.
8650 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8653 % Start the printed caption with what we've constructed in
8654 % \floatident, but keep it separate; we need \floatident again.
8655 \let\captionline = \floatident
8657 \ifx\thiscaption\empty \else
8658 \ifx\floatident\empty \else
8659 \appendtomacro\captionline{: }% had ident, so need a colon between
8662 % caption text.
8663 \appendtomacro\captionline{\scanexp\thiscaption}%
8666 % If we have anything to print, print it, with space before.
8667 % Eventually this needs to become an \insert.
8668 \ifx\captionline\empty \else
8669 \vskip.5\parskip
8670 \captionline
8672 % Space below caption.
8673 \vskip\parskip
8676 % If have an xref label, write the list of floats info. Do this
8677 % after the caption, to avoid chance of it being a breakpoint.
8678 \ifx\floatlabel\empty \else
8679 % Write the text that goes in the lof to the aux file as
8680 % \floatlabel-lof. Besides \floatident, we include the short
8681 % caption if specified, else the full caption if specified, else nothing.
8683 \atdummies
8685 % since we read the caption text in the macro world, where ^^M
8686 % is turned into a normal character, we have to scan it back, so
8687 % we don't write the literal three characters "^^M" into the aux file.
8688 \scanexp{%
8689 \xdef\noexpand\gtemp{%
8690 \ifx\thisshortcaption\empty
8691 \thiscaption
8692 \else
8693 \thisshortcaption
8697 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
8698 \ifx\gtemp\empty \else : \gtemp \fi}}%
8701 \egroup % end of \vtop
8703 % place the captured inserts
8705 % BEWARE: when the floats start floating, we have to issue warning
8706 % whenever an insert appears inside a float which could possibly
8707 % float. --kasal, 26may04
8709 \checkinserts
8712 % Append the tokens #2 to the definition of macro #1, not expanding either.
8714 \def\appendtomacro#1#2{%
8715 \expandafter\def\expandafter#1\expandafter{#1#2}%
8718 % @caption, @shortcaption
8720 \def\caption{\docaption\thiscaption}
8721 \def\shortcaption{\docaption\thisshortcaption}
8722 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8723 \def\defcaption#1#2{\egroup \def#1{#2}}
8725 % The parameter is the control sequence identifying the counter we are
8726 % going to use. Create it if it doesn't exist and assign it to \floatno.
8727 \def\getfloatno#1{%
8728 \ifx#1\relax
8729 % Haven't seen this figure type before.
8730 \csname newcount\endcsname #1%
8732 % Remember to reset this floatno at the next chap.
8733 \expandafter\gdef\expandafter\resetallfloatnos
8734 \expandafter{\resetallfloatnos #1=0 }%
8736 \let\floatno#1%
8739 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8740 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8741 % first read the @float command.
8743 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
8745 % Magic string used for the XREFLABEL-title value, so \xrefX can
8746 % distinguish floats from other xref types.
8747 \def\floatmagic{!!float!!}
8749 % #1 is the control sequence we are passed; we expand into a conditional
8750 % which is true if #1 represents a float ref. That is, the magic
8751 % \lastsection value which we \setref above.
8753 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
8755 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8756 % (safe) float type for this float. We set \iffloattype to #2.
8758 \def\doiffloat#1=#2=#3\finish{%
8759 \def\temp{#1}%
8760 \def\iffloattype{#2}%
8761 \ifx\temp\floatmagic
8764 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8766 \parseargdef\listoffloats{%
8767 \def\floattype{#1}% floattype
8769 % the floattype might have accents or other special characters,
8770 % but we need to use it in a control sequence name.
8771 \indexnofonts
8772 \turnoffactive
8773 \xdef\safefloattype{\floattype}%
8776 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8777 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8778 \ifhavexrefs
8779 % if the user said @listoffloats foo but never @float foo.
8780 \message{\linenumber No `\safefloattype' floats to list.}%
8782 \else
8783 \begingroup
8784 \leftskip=\tocindent % indent these entries like a toc
8785 \let\do=\listoffloatsdo
8786 \csname floatlist\safefloattype\endcsname
8787 \endgroup
8791 % This is called on each entry in a list of floats. We're passed the
8792 % xref label, in the form LABEL-title, which is how we save it in the
8793 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8794 % has the text we're supposed to typeset here.
8796 % Figures without xref labels will not be included in the list (since
8797 % they won't appear in the aux file).
8799 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8800 \def\listoffloatsdoentry#1-title\finish{{%
8801 % Can't fully expand XR#1-lof because it can contain anything. Just
8802 % pass the control sequence. On the other hand, XR#1-pg is just the
8803 % page number, and we want to fully expand that so we can get a link
8804 % in pdf output.
8805 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8807 % use the same \entry macro we use to generate the TOC and index.
8808 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8809 \writeentry
8813 \message{localization,}
8815 % For single-language documents, @documentlanguage is usually given very
8816 % early, just after @documentencoding. Single argument is the language
8817 % (de) or locale (de_DE) abbreviation.
8820 \catcode`\_ = \active
8821 \globaldefs=1
8822 \parseargdef\documentlanguage{\begingroup
8823 \let_=\normalunderscore % normal _ character for filenames
8824 \tex % read txi-??.tex file in plain TeX.
8825 % Read the file by the name they passed if it exists.
8826 \openin 1 txi-#1.tex
8827 \ifeof 1
8828 \documentlanguagetrywithoutunderscore{#1_\finish}%
8829 \else
8830 \globaldefs = 1 % everything in the txi-LL files needs to persist
8831 \input txi-#1.tex
8833 \closein 1
8834 \endgroup % end raw TeX
8835 \endgroup}
8837 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8838 % try txi-de.tex.
8840 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8841 \openin 1 txi-#1.tex
8842 \ifeof 1
8843 \errhelp = \nolanghelp
8844 \errmessage{Cannot read language file txi-#1.tex}%
8845 \else
8846 \globaldefs = 1 % everything in the txi-LL files needs to persist
8847 \input txi-#1.tex
8849 \closein 1
8851 }% end of special _ catcode
8853 \newhelp\nolanghelp{The given language definition file cannot be found or
8854 is empty. Maybe you need to install it? Putting it in the current
8855 directory should work if nowhere else does.}
8857 % This macro is called from txi-??.tex files; the first argument is the
8858 % \language name to set (without the "\lang@" prefix), the second and
8859 % third args are \{left,right}hyphenmin.
8861 % The language names to pass are determined when the format is built.
8862 % See the etex.log file created at that time, e.g.,
8863 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8865 % With TeX Live 2008, etex now includes hyphenation patterns for all
8866 % available languages. This means we can support hyphenation in
8867 % Texinfo, at least to some extent. (This still doesn't solve the
8868 % accented characters problem.)
8870 \catcode`@=11
8871 \def\txisetlanguage#1#2#3{%
8872 % do not set the language if the name is undefined in the current TeX.
8873 \expandafter\ifx\csname lang@#1\endcsname \relax
8874 \message{no patterns for #1}%
8875 \else
8876 \global\language = \csname lang@#1\endcsname
8878 % but there is no harm in adjusting the hyphenmin values regardless.
8879 \global\lefthyphenmin = #2\relax
8880 \global\righthyphenmin = #3\relax
8883 % Helpers for encodings.
8884 % Set the catcode of characters 128 through 255 to the specified number.
8886 \def\setnonasciicharscatcode#1{%
8887 \count255=128
8888 \loop\ifnum\count255<256
8889 \global\catcode\count255=#1\relax
8890 \advance\count255 by 1
8891 \repeat
8894 \def\setnonasciicharscatcodenonglobal#1{%
8895 \count255=128
8896 \loop\ifnum\count255<256
8897 \catcode\count255=#1\relax
8898 \advance\count255 by 1
8899 \repeat
8902 % @documentencoding sets the definition of non-ASCII characters
8903 % according to the specified encoding.
8905 \parseargdef\documentencoding{%
8906 % Encoding being declared for the document.
8907 \def\declaredencoding{\csname #1.enc\endcsname}%
8909 % Supported encodings: names converted to tokens in order to be able
8910 % to compare them with \ifx.
8911 \def\ascii{\csname US-ASCII.enc\endcsname}%
8912 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8913 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8914 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8915 \def\utfeight{\csname UTF-8.enc\endcsname}%
8917 \ifx \declaredencoding \ascii
8918 \asciichardefs
8920 \else \ifx \declaredencoding \lattwo
8921 \setnonasciicharscatcode\active
8922 \lattwochardefs
8924 \else \ifx \declaredencoding \latone
8925 \setnonasciicharscatcode\active
8926 \latonechardefs
8928 \else \ifx \declaredencoding \latnine
8929 \setnonasciicharscatcode\active
8930 \latninechardefs
8932 \else \ifx \declaredencoding \utfeight
8933 \setnonasciicharscatcode\active
8934 \utfeightchardefs
8936 \else
8937 \message{Unknown document encoding #1, ignoring.}%
8939 \fi % utfeight
8940 \fi % latnine
8941 \fi % latone
8942 \fi % lattwo
8943 \fi % ascii
8946 % A message to be logged when using a character that isn't available
8947 % the default font encoding (OT1).
8949 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8951 % Take account of \c (plain) vs. \, (Texinfo) difference.
8952 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8954 % First, make active non-ASCII characters in order for them to be
8955 % correctly categorized when TeX reads the replacement text of
8956 % macros containing the character definitions.
8957 \setnonasciicharscatcode\active
8959 % Latin1 (ISO-8859-1) character definitions.
8960 \def\latonechardefs{%
8961 \gdef^^a0{\tie}
8962 \gdef^^a1{\exclamdown}
8963 \gdef^^a2{\missingcharmsg{CENT SIGN}}
8964 \gdef^^a3{{\pounds}}
8965 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8966 \gdef^^a5{\missingcharmsg{YEN SIGN}}
8967 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8968 \gdef^^a7{\S}
8969 \gdef^^a8{\"{}}
8970 \gdef^^a9{\copyright}
8971 \gdef^^aa{\ordf}
8972 \gdef^^ab{\guillemetleft}
8973 \gdef^^ac{$\lnot$}
8974 \gdef^^ad{\-}
8975 \gdef^^ae{\registeredsymbol}
8976 \gdef^^af{\={}}
8978 \gdef^^b0{\textdegree}
8979 \gdef^^b1{$\pm$}
8980 \gdef^^b2{$^2$}
8981 \gdef^^b3{$^3$}
8982 \gdef^^b4{\'{}}
8983 \gdef^^b5{$\mu$}
8984 \gdef^^b6{\P}
8986 \gdef^^b7{$^.$}
8987 \gdef^^b8{\cedilla\ }
8988 \gdef^^b9{$^1$}
8989 \gdef^^ba{\ordm}
8991 \gdef^^bb{\guillemetright}
8992 \gdef^^bc{$1\over4$}
8993 \gdef^^bd{$1\over2$}
8994 \gdef^^be{$3\over4$}
8995 \gdef^^bf{\questiondown}
8997 \gdef^^c0{\`A}
8998 \gdef^^c1{\'A}
8999 \gdef^^c2{\^A}
9000 \gdef^^c3{\~A}
9001 \gdef^^c4{\"A}
9002 \gdef^^c5{\ringaccent A}
9003 \gdef^^c6{\AE}
9004 \gdef^^c7{\cedilla C}
9005 \gdef^^c8{\`E}
9006 \gdef^^c9{\'E}
9007 \gdef^^ca{\^E}
9008 \gdef^^cb{\"E}
9009 \gdef^^cc{\`I}
9010 \gdef^^cd{\'I}
9011 \gdef^^ce{\^I}
9012 \gdef^^cf{\"I}
9014 \gdef^^d0{\DH}
9015 \gdef^^d1{\~N}
9016 \gdef^^d2{\`O}
9017 \gdef^^d3{\'O}
9018 \gdef^^d4{\^O}
9019 \gdef^^d5{\~O}
9020 \gdef^^d6{\"O}
9021 \gdef^^d7{$\times$}
9022 \gdef^^d8{\O}
9023 \gdef^^d9{\`U}
9024 \gdef^^da{\'U}
9025 \gdef^^db{\^U}
9026 \gdef^^dc{\"U}
9027 \gdef^^dd{\'Y}
9028 \gdef^^de{\TH}
9029 \gdef^^df{\ss}
9031 \gdef^^e0{\`a}
9032 \gdef^^e1{\'a}
9033 \gdef^^e2{\^a}
9034 \gdef^^e3{\~a}
9035 \gdef^^e4{\"a}
9036 \gdef^^e5{\ringaccent a}
9037 \gdef^^e6{\ae}
9038 \gdef^^e7{\cedilla c}
9039 \gdef^^e8{\`e}
9040 \gdef^^e9{\'e}
9041 \gdef^^ea{\^e}
9042 \gdef^^eb{\"e}
9043 \gdef^^ec{\`{\dotless i}}
9044 \gdef^^ed{\'{\dotless i}}
9045 \gdef^^ee{\^{\dotless i}}
9046 \gdef^^ef{\"{\dotless i}}
9048 \gdef^^f0{\dh}
9049 \gdef^^f1{\~n}
9050 \gdef^^f2{\`o}
9051 \gdef^^f3{\'o}
9052 \gdef^^f4{\^o}
9053 \gdef^^f5{\~o}
9054 \gdef^^f6{\"o}
9055 \gdef^^f7{$\div$}
9056 \gdef^^f8{\o}
9057 \gdef^^f9{\`u}
9058 \gdef^^fa{\'u}
9059 \gdef^^fb{\^u}
9060 \gdef^^fc{\"u}
9061 \gdef^^fd{\'y}
9062 \gdef^^fe{\th}
9063 \gdef^^ff{\"y}
9066 % Latin9 (ISO-8859-15) encoding character definitions.
9067 \def\latninechardefs{%
9068 % Encoding is almost identical to Latin1.
9069 \latonechardefs
9071 \gdef^^a4{\euro}
9072 \gdef^^a6{\v S}
9073 \gdef^^a8{\v s}
9074 \gdef^^b4{\v Z}
9075 \gdef^^b8{\v z}
9076 \gdef^^bc{\OE}
9077 \gdef^^bd{\oe}
9078 \gdef^^be{\"Y}
9081 % Latin2 (ISO-8859-2) character definitions.
9082 \def\lattwochardefs{%
9083 \gdef^^a0{\tie}
9084 \gdef^^a1{\ogonek{A}}
9085 \gdef^^a2{\u{}}
9086 \gdef^^a3{\L}
9087 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
9088 \gdef^^a5{\v L}
9089 \gdef^^a6{\'S}
9090 \gdef^^a7{\S}
9091 \gdef^^a8{\"{}}
9092 \gdef^^a9{\v S}
9093 \gdef^^aa{\cedilla S}
9094 \gdef^^ab{\v T}
9095 \gdef^^ac{\'Z}
9096 \gdef^^ad{\-}
9097 \gdef^^ae{\v Z}
9098 \gdef^^af{\dotaccent Z}
9100 \gdef^^b0{\textdegree}
9101 \gdef^^b1{\ogonek{a}}
9102 \gdef^^b2{\ogonek{ }}
9103 \gdef^^b3{\l}
9104 \gdef^^b4{\'{}}
9105 \gdef^^b5{\v l}
9106 \gdef^^b6{\'s}
9107 \gdef^^b7{\v{}}
9108 \gdef^^b8{\cedilla\ }
9109 \gdef^^b9{\v s}
9110 \gdef^^ba{\cedilla s}
9111 \gdef^^bb{\v t}
9112 \gdef^^bc{\'z}
9113 \gdef^^bd{\H{}}
9114 \gdef^^be{\v z}
9115 \gdef^^bf{\dotaccent z}
9117 \gdef^^c0{\'R}
9118 \gdef^^c1{\'A}
9119 \gdef^^c2{\^A}
9120 \gdef^^c3{\u A}
9121 \gdef^^c4{\"A}
9122 \gdef^^c5{\'L}
9123 \gdef^^c6{\'C}
9124 \gdef^^c7{\cedilla C}
9125 \gdef^^c8{\v C}
9126 \gdef^^c9{\'E}
9127 \gdef^^ca{\ogonek{E}}
9128 \gdef^^cb{\"E}
9129 \gdef^^cc{\v E}
9130 \gdef^^cd{\'I}
9131 \gdef^^ce{\^I}
9132 \gdef^^cf{\v D}
9134 \gdef^^d0{\DH}
9135 \gdef^^d1{\'N}
9136 \gdef^^d2{\v N}
9137 \gdef^^d3{\'O}
9138 \gdef^^d4{\^O}
9139 \gdef^^d5{\H O}
9140 \gdef^^d6{\"O}
9141 \gdef^^d7{$\times$}
9142 \gdef^^d8{\v R}
9143 \gdef^^d9{\ringaccent U}
9144 \gdef^^da{\'U}
9145 \gdef^^db{\H U}
9146 \gdef^^dc{\"U}
9147 \gdef^^dd{\'Y}
9148 \gdef^^de{\cedilla T}
9149 \gdef^^df{\ss}
9151 \gdef^^e0{\'r}
9152 \gdef^^e1{\'a}
9153 \gdef^^e2{\^a}
9154 \gdef^^e3{\u a}
9155 \gdef^^e4{\"a}
9156 \gdef^^e5{\'l}
9157 \gdef^^e6{\'c}
9158 \gdef^^e7{\cedilla c}
9159 \gdef^^e8{\v c}
9160 \gdef^^e9{\'e}
9161 \gdef^^ea{\ogonek{e}}
9162 \gdef^^eb{\"e}
9163 \gdef^^ec{\v e}
9164 \gdef^^ed{\'{\dotless{i}}}
9165 \gdef^^ee{\^{\dotless{i}}}
9166 \gdef^^ef{\v d}
9168 \gdef^^f0{\dh}
9169 \gdef^^f1{\'n}
9170 \gdef^^f2{\v n}
9171 \gdef^^f3{\'o}
9172 \gdef^^f4{\^o}
9173 \gdef^^f5{\H o}
9174 \gdef^^f6{\"o}
9175 \gdef^^f7{$\div$}
9176 \gdef^^f8{\v r}
9177 \gdef^^f9{\ringaccent u}
9178 \gdef^^fa{\'u}
9179 \gdef^^fb{\H u}
9180 \gdef^^fc{\"u}
9181 \gdef^^fd{\'y}
9182 \gdef^^fe{\cedilla t}
9183 \gdef^^ff{\dotaccent{}}
9186 % UTF-8 character definitions.
9188 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
9189 % changes for Texinfo conventions. It is included here under the GPL by
9190 % permission from Frank Mittelbach and the LaTeX team.
9192 \newcount\countUTFx
9193 \newcount\countUTFy
9194 \newcount\countUTFz
9196 \gdef\UTFviiiTwoOctets#1#2{\expandafter
9197 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
9199 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
9200 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
9202 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
9203 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
9205 \gdef\UTFviiiDefined#1{%
9206 \ifx #1\relax
9207 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
9208 \else
9209 \expandafter #1%
9213 \begingroup
9214 \catcode`\~13
9215 \catcode`\"12
9217 \def\UTFviiiLoop{%
9218 \global\catcode\countUTFx\active
9219 \uccode`\~\countUTFx
9220 \uppercase\expandafter{\UTFviiiTmp}%
9221 \advance\countUTFx by 1
9222 \ifnum\countUTFx < \countUTFy
9223 \expandafter\UTFviiiLoop
9224 \fi}
9226 \countUTFx = "C2
9227 \countUTFy = "E0
9228 \def\UTFviiiTmp{%
9229 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
9230 \UTFviiiLoop
9232 \countUTFx = "E0
9233 \countUTFy = "F0
9234 \def\UTFviiiTmp{%
9235 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
9236 \UTFviiiLoop
9238 \countUTFx = "F0
9239 \countUTFy = "F4
9240 \def\UTFviiiTmp{%
9241 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
9242 \UTFviiiLoop
9243 \endgroup
9245 \begingroup
9246 \catcode`\"=12
9247 \catcode`\<=12
9248 \catcode`\.=12
9249 \catcode`\,=12
9250 \catcode`\;=12
9251 \catcode`\!=12
9252 \catcode`\~=13
9254 \gdef\DeclareUnicodeCharacter#1#2{%
9255 \countUTFz = "#1\relax
9256 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9257 \begingroup
9258 \parseXMLCharref
9259 \def\UTFviiiTwoOctets##1##2{%
9260 \csname u8:##1\string ##2\endcsname}%
9261 \def\UTFviiiThreeOctets##1##2##3{%
9262 \csname u8:##1\string ##2\string ##3\endcsname}%
9263 \def\UTFviiiFourOctets##1##2##3##4{%
9264 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
9265 \expandafter\expandafter\expandafter\expandafter
9266 \expandafter\expandafter\expandafter
9267 \gdef\UTFviiiTmp{#2}%
9268 \endgroup}
9270 \gdef\parseXMLCharref{%
9271 \ifnum\countUTFz < "A0\relax
9272 \errhelp = \EMsimple
9273 \errmessage{Cannot define Unicode char value < 00A0}%
9274 \else\ifnum\countUTFz < "800\relax
9275 \parseUTFviiiA,%
9276 \parseUTFviiiB C\UTFviiiTwoOctets.,%
9277 \else\ifnum\countUTFz < "10000\relax
9278 \parseUTFviiiA;%
9279 \parseUTFviiiA,%
9280 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
9281 \else
9282 \parseUTFviiiA;%
9283 \parseUTFviiiA,%
9284 \parseUTFviiiA!%
9285 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
9286 \fi\fi\fi
9289 \gdef\parseUTFviiiA#1{%
9290 \countUTFx = \countUTFz
9291 \divide\countUTFz by 64
9292 \countUTFy = \countUTFz
9293 \multiply\countUTFz by 64
9294 \advance\countUTFx by -\countUTFz
9295 \advance\countUTFx by 128
9296 \uccode `#1\countUTFx
9297 \countUTFz = \countUTFy}
9299 \gdef\parseUTFviiiB#1#2#3#4{%
9300 \advance\countUTFz by "#10\relax
9301 \uccode `#3\countUTFz
9302 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9303 \endgroup
9305 \def\utfeightchardefs{%
9306 \DeclareUnicodeCharacter{00A0}{\tie}
9307 \DeclareUnicodeCharacter{00A1}{\exclamdown}
9308 \DeclareUnicodeCharacter{00A3}{\pounds}
9309 \DeclareUnicodeCharacter{00A8}{\"{ }}
9310 \DeclareUnicodeCharacter{00A9}{\copyright}
9311 \DeclareUnicodeCharacter{00AA}{\ordf}
9312 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
9313 \DeclareUnicodeCharacter{00AD}{\-}
9314 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
9315 \DeclareUnicodeCharacter{00AF}{\={ }}
9317 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
9318 \DeclareUnicodeCharacter{00B4}{\'{ }}
9319 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
9320 \DeclareUnicodeCharacter{00BA}{\ordm}
9321 \DeclareUnicodeCharacter{00BB}{\guillemetright}
9322 \DeclareUnicodeCharacter{00BF}{\questiondown}
9324 \DeclareUnicodeCharacter{00C0}{\`A}
9325 \DeclareUnicodeCharacter{00C1}{\'A}
9326 \DeclareUnicodeCharacter{00C2}{\^A}
9327 \DeclareUnicodeCharacter{00C3}{\~A}
9328 \DeclareUnicodeCharacter{00C4}{\"A}
9329 \DeclareUnicodeCharacter{00C5}{\AA}
9330 \DeclareUnicodeCharacter{00C6}{\AE}
9331 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
9332 \DeclareUnicodeCharacter{00C8}{\`E}
9333 \DeclareUnicodeCharacter{00C9}{\'E}
9334 \DeclareUnicodeCharacter{00CA}{\^E}
9335 \DeclareUnicodeCharacter{00CB}{\"E}
9336 \DeclareUnicodeCharacter{00CC}{\`I}
9337 \DeclareUnicodeCharacter{00CD}{\'I}
9338 \DeclareUnicodeCharacter{00CE}{\^I}
9339 \DeclareUnicodeCharacter{00CF}{\"I}
9341 \DeclareUnicodeCharacter{00D0}{\DH}
9342 \DeclareUnicodeCharacter{00D1}{\~N}
9343 \DeclareUnicodeCharacter{00D2}{\`O}
9344 \DeclareUnicodeCharacter{00D3}{\'O}
9345 \DeclareUnicodeCharacter{00D4}{\^O}
9346 \DeclareUnicodeCharacter{00D5}{\~O}
9347 \DeclareUnicodeCharacter{00D6}{\"O}
9348 \DeclareUnicodeCharacter{00D8}{\O}
9349 \DeclareUnicodeCharacter{00D9}{\`U}
9350 \DeclareUnicodeCharacter{00DA}{\'U}
9351 \DeclareUnicodeCharacter{00DB}{\^U}
9352 \DeclareUnicodeCharacter{00DC}{\"U}
9353 \DeclareUnicodeCharacter{00DD}{\'Y}
9354 \DeclareUnicodeCharacter{00DE}{\TH}
9355 \DeclareUnicodeCharacter{00DF}{\ss}
9357 \DeclareUnicodeCharacter{00E0}{\`a}
9358 \DeclareUnicodeCharacter{00E1}{\'a}
9359 \DeclareUnicodeCharacter{00E2}{\^a}
9360 \DeclareUnicodeCharacter{00E3}{\~a}
9361 \DeclareUnicodeCharacter{00E4}{\"a}
9362 \DeclareUnicodeCharacter{00E5}{\aa}
9363 \DeclareUnicodeCharacter{00E6}{\ae}
9364 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
9365 \DeclareUnicodeCharacter{00E8}{\`e}
9366 \DeclareUnicodeCharacter{00E9}{\'e}
9367 \DeclareUnicodeCharacter{00EA}{\^e}
9368 \DeclareUnicodeCharacter{00EB}{\"e}
9369 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
9370 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
9371 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
9372 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
9374 \DeclareUnicodeCharacter{00F0}{\dh}
9375 \DeclareUnicodeCharacter{00F1}{\~n}
9376 \DeclareUnicodeCharacter{00F2}{\`o}
9377 \DeclareUnicodeCharacter{00F3}{\'o}
9378 \DeclareUnicodeCharacter{00F4}{\^o}
9379 \DeclareUnicodeCharacter{00F5}{\~o}
9380 \DeclareUnicodeCharacter{00F6}{\"o}
9381 \DeclareUnicodeCharacter{00F8}{\o}
9382 \DeclareUnicodeCharacter{00F9}{\`u}
9383 \DeclareUnicodeCharacter{00FA}{\'u}
9384 \DeclareUnicodeCharacter{00FB}{\^u}
9385 \DeclareUnicodeCharacter{00FC}{\"u}
9386 \DeclareUnicodeCharacter{00FD}{\'y}
9387 \DeclareUnicodeCharacter{00FE}{\th}
9388 \DeclareUnicodeCharacter{00FF}{\"y}
9390 \DeclareUnicodeCharacter{0100}{\=A}
9391 \DeclareUnicodeCharacter{0101}{\=a}
9392 \DeclareUnicodeCharacter{0102}{\u{A}}
9393 \DeclareUnicodeCharacter{0103}{\u{a}}
9394 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
9395 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
9396 \DeclareUnicodeCharacter{0106}{\'C}
9397 \DeclareUnicodeCharacter{0107}{\'c}
9398 \DeclareUnicodeCharacter{0108}{\^C}
9399 \DeclareUnicodeCharacter{0109}{\^c}
9400 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
9401 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
9402 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
9403 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
9404 \DeclareUnicodeCharacter{010C}{\v{C}}
9405 \DeclareUnicodeCharacter{010D}{\v{c}}
9406 \DeclareUnicodeCharacter{010E}{\v{D}}
9408 \DeclareUnicodeCharacter{0112}{\=E}
9409 \DeclareUnicodeCharacter{0113}{\=e}
9410 \DeclareUnicodeCharacter{0114}{\u{E}}
9411 \DeclareUnicodeCharacter{0115}{\u{e}}
9412 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
9413 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
9414 \DeclareUnicodeCharacter{011A}{\v{E}}
9415 \DeclareUnicodeCharacter{011B}{\v{e}}
9416 \DeclareUnicodeCharacter{011C}{\^G}
9417 \DeclareUnicodeCharacter{011D}{\^g}
9418 \DeclareUnicodeCharacter{011E}{\u{G}}
9419 \DeclareUnicodeCharacter{011F}{\u{g}}
9421 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
9422 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
9423 \DeclareUnicodeCharacter{0124}{\^H}
9424 \DeclareUnicodeCharacter{0125}{\^h}
9425 \DeclareUnicodeCharacter{0128}{\~I}
9426 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
9427 \DeclareUnicodeCharacter{012A}{\=I}
9428 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
9429 \DeclareUnicodeCharacter{012C}{\u{I}}
9430 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
9432 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
9433 \DeclareUnicodeCharacter{0131}{\dotless{i}}
9434 \DeclareUnicodeCharacter{0132}{IJ}
9435 \DeclareUnicodeCharacter{0133}{ij}
9436 \DeclareUnicodeCharacter{0134}{\^J}
9437 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
9438 \DeclareUnicodeCharacter{0139}{\'L}
9439 \DeclareUnicodeCharacter{013A}{\'l}
9441 \DeclareUnicodeCharacter{0141}{\L}
9442 \DeclareUnicodeCharacter{0142}{\l}
9443 \DeclareUnicodeCharacter{0143}{\'N}
9444 \DeclareUnicodeCharacter{0144}{\'n}
9445 \DeclareUnicodeCharacter{0147}{\v{N}}
9446 \DeclareUnicodeCharacter{0148}{\v{n}}
9447 \DeclareUnicodeCharacter{014C}{\=O}
9448 \DeclareUnicodeCharacter{014D}{\=o}
9449 \DeclareUnicodeCharacter{014E}{\u{O}}
9450 \DeclareUnicodeCharacter{014F}{\u{o}}
9452 \DeclareUnicodeCharacter{0150}{\H{O}}
9453 \DeclareUnicodeCharacter{0151}{\H{o}}
9454 \DeclareUnicodeCharacter{0152}{\OE}
9455 \DeclareUnicodeCharacter{0153}{\oe}
9456 \DeclareUnicodeCharacter{0154}{\'R}
9457 \DeclareUnicodeCharacter{0155}{\'r}
9458 \DeclareUnicodeCharacter{0158}{\v{R}}
9459 \DeclareUnicodeCharacter{0159}{\v{r}}
9460 \DeclareUnicodeCharacter{015A}{\'S}
9461 \DeclareUnicodeCharacter{015B}{\'s}
9462 \DeclareUnicodeCharacter{015C}{\^S}
9463 \DeclareUnicodeCharacter{015D}{\^s}
9464 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
9465 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
9467 \DeclareUnicodeCharacter{0160}{\v{S}}
9468 \DeclareUnicodeCharacter{0161}{\v{s}}
9469 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
9470 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
9471 \DeclareUnicodeCharacter{0164}{\v{T}}
9473 \DeclareUnicodeCharacter{0168}{\~U}
9474 \DeclareUnicodeCharacter{0169}{\~u}
9475 \DeclareUnicodeCharacter{016A}{\=U}
9476 \DeclareUnicodeCharacter{016B}{\=u}
9477 \DeclareUnicodeCharacter{016C}{\u{U}}
9478 \DeclareUnicodeCharacter{016D}{\u{u}}
9479 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
9480 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
9482 \DeclareUnicodeCharacter{0170}{\H{U}}
9483 \DeclareUnicodeCharacter{0171}{\H{u}}
9484 \DeclareUnicodeCharacter{0174}{\^W}
9485 \DeclareUnicodeCharacter{0175}{\^w}
9486 \DeclareUnicodeCharacter{0176}{\^Y}
9487 \DeclareUnicodeCharacter{0177}{\^y}
9488 \DeclareUnicodeCharacter{0178}{\"Y}
9489 \DeclareUnicodeCharacter{0179}{\'Z}
9490 \DeclareUnicodeCharacter{017A}{\'z}
9491 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
9492 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
9493 \DeclareUnicodeCharacter{017D}{\v{Z}}
9494 \DeclareUnicodeCharacter{017E}{\v{z}}
9496 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
9497 \DeclareUnicodeCharacter{01C5}{D\v{z}}
9498 \DeclareUnicodeCharacter{01C6}{d\v{z}}
9499 \DeclareUnicodeCharacter{01C7}{LJ}
9500 \DeclareUnicodeCharacter{01C8}{Lj}
9501 \DeclareUnicodeCharacter{01C9}{lj}
9502 \DeclareUnicodeCharacter{01CA}{NJ}
9503 \DeclareUnicodeCharacter{01CB}{Nj}
9504 \DeclareUnicodeCharacter{01CC}{nj}
9505 \DeclareUnicodeCharacter{01CD}{\v{A}}
9506 \DeclareUnicodeCharacter{01CE}{\v{a}}
9507 \DeclareUnicodeCharacter{01CF}{\v{I}}
9509 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
9510 \DeclareUnicodeCharacter{01D1}{\v{O}}
9511 \DeclareUnicodeCharacter{01D2}{\v{o}}
9512 \DeclareUnicodeCharacter{01D3}{\v{U}}
9513 \DeclareUnicodeCharacter{01D4}{\v{u}}
9515 \DeclareUnicodeCharacter{01E2}{\={\AE}}
9516 \DeclareUnicodeCharacter{01E3}{\={\ae}}
9517 \DeclareUnicodeCharacter{01E6}{\v{G}}
9518 \DeclareUnicodeCharacter{01E7}{\v{g}}
9519 \DeclareUnicodeCharacter{01E8}{\v{K}}
9520 \DeclareUnicodeCharacter{01E9}{\v{k}}
9522 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
9523 \DeclareUnicodeCharacter{01F1}{DZ}
9524 \DeclareUnicodeCharacter{01F2}{Dz}
9525 \DeclareUnicodeCharacter{01F3}{dz}
9526 \DeclareUnicodeCharacter{01F4}{\'G}
9527 \DeclareUnicodeCharacter{01F5}{\'g}
9528 \DeclareUnicodeCharacter{01F8}{\`N}
9529 \DeclareUnicodeCharacter{01F9}{\`n}
9530 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
9531 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
9532 \DeclareUnicodeCharacter{01FE}{\'{\O}}
9533 \DeclareUnicodeCharacter{01FF}{\'{\o}}
9535 \DeclareUnicodeCharacter{021E}{\v{H}}
9536 \DeclareUnicodeCharacter{021F}{\v{h}}
9538 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
9539 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
9540 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
9541 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
9542 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
9543 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
9545 \DeclareUnicodeCharacter{0232}{\=Y}
9546 \DeclareUnicodeCharacter{0233}{\=y}
9547 \DeclareUnicodeCharacter{0237}{\dotless{j}}
9549 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
9551 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
9552 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
9553 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
9554 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
9555 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
9556 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
9557 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
9558 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
9559 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
9560 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
9561 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
9562 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
9564 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
9565 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
9567 \DeclareUnicodeCharacter{1E20}{\=G}
9568 \DeclareUnicodeCharacter{1E21}{\=g}
9569 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
9570 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
9571 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
9572 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
9573 \DeclareUnicodeCharacter{1E26}{\"H}
9574 \DeclareUnicodeCharacter{1E27}{\"h}
9576 \DeclareUnicodeCharacter{1E30}{\'K}
9577 \DeclareUnicodeCharacter{1E31}{\'k}
9578 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
9579 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
9580 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
9581 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
9582 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
9583 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
9584 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
9585 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
9586 \DeclareUnicodeCharacter{1E3E}{\'M}
9587 \DeclareUnicodeCharacter{1E3F}{\'m}
9589 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
9590 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
9591 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
9592 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
9593 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
9594 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
9595 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
9596 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
9597 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
9598 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
9600 \DeclareUnicodeCharacter{1E54}{\'P}
9601 \DeclareUnicodeCharacter{1E55}{\'p}
9602 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
9603 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
9604 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
9605 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
9606 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
9607 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
9608 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
9609 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
9611 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
9612 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
9613 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
9614 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
9615 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
9616 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
9617 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
9618 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
9619 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
9620 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
9622 \DeclareUnicodeCharacter{1E7C}{\~V}
9623 \DeclareUnicodeCharacter{1E7D}{\~v}
9624 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
9625 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
9627 \DeclareUnicodeCharacter{1E80}{\`W}
9628 \DeclareUnicodeCharacter{1E81}{\`w}
9629 \DeclareUnicodeCharacter{1E82}{\'W}
9630 \DeclareUnicodeCharacter{1E83}{\'w}
9631 \DeclareUnicodeCharacter{1E84}{\"W}
9632 \DeclareUnicodeCharacter{1E85}{\"w}
9633 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
9634 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
9635 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
9636 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
9637 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
9638 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
9639 \DeclareUnicodeCharacter{1E8C}{\"X}
9640 \DeclareUnicodeCharacter{1E8D}{\"x}
9641 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
9642 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
9644 \DeclareUnicodeCharacter{1E90}{\^Z}
9645 \DeclareUnicodeCharacter{1E91}{\^z}
9646 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
9647 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
9648 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
9649 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
9650 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
9651 \DeclareUnicodeCharacter{1E97}{\"t}
9652 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
9653 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
9655 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
9656 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
9658 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
9659 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
9660 \DeclareUnicodeCharacter{1EBC}{\~E}
9661 \DeclareUnicodeCharacter{1EBD}{\~e}
9663 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
9664 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
9665 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
9666 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
9668 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
9669 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
9671 \DeclareUnicodeCharacter{1EF2}{\`Y}
9672 \DeclareUnicodeCharacter{1EF3}{\`y}
9673 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
9675 \DeclareUnicodeCharacter{1EF8}{\~Y}
9676 \DeclareUnicodeCharacter{1EF9}{\~y}
9678 \DeclareUnicodeCharacter{2013}{--}
9679 \DeclareUnicodeCharacter{2014}{---}
9680 \DeclareUnicodeCharacter{2018}{\quoteleft}
9681 \DeclareUnicodeCharacter{2019}{\quoteright}
9682 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
9683 \DeclareUnicodeCharacter{201C}{\quotedblleft}
9684 \DeclareUnicodeCharacter{201D}{\quotedblright}
9685 \DeclareUnicodeCharacter{201E}{\quotedblbase}
9686 \DeclareUnicodeCharacter{2022}{\bullet}
9687 \DeclareUnicodeCharacter{2026}{\dots}
9688 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9689 \DeclareUnicodeCharacter{203A}{\guilsinglright}
9690 \DeclareUnicodeCharacter{20AC}{\euro}
9692 \DeclareUnicodeCharacter{2192}{\expansion}
9693 \DeclareUnicodeCharacter{21D2}{\result}
9695 \DeclareUnicodeCharacter{2212}{\minus}
9696 \DeclareUnicodeCharacter{2217}{\point}
9697 \DeclareUnicodeCharacter{2261}{\equiv}
9698 }% end of \utfeightchardefs
9701 % US-ASCII character definitions.
9702 \def\asciichardefs{% nothing need be done
9703 \relax
9706 % Make non-ASCII characters printable again for compatibility with
9707 % existing Texinfo documents that may use them, even without declaring a
9708 % document encoding.
9710 \setnonasciicharscatcode \other
9713 \message{formatting,}
9715 \newdimen\defaultparindent \defaultparindent = 15pt
9717 \chapheadingskip = 15pt plus 4pt minus 2pt
9718 \secheadingskip = 12pt plus 3pt minus 2pt
9719 \subsecheadingskip = 9pt plus 2pt minus 2pt
9721 % Prevent underfull vbox error messages.
9722 \vbadness = 10000
9724 % Don't be very finicky about underfull hboxes, either.
9725 \hbadness = 6666
9727 % Following George Bush, get rid of widows and orphans.
9728 \widowpenalty=10000
9729 \clubpenalty=10000
9731 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9732 % using an old version of TeX, don't do anything. We want the amount of
9733 % stretch added to depend on the line length, hence the dependence on
9734 % \hsize. We call this whenever the paper size is set.
9736 \def\setemergencystretch{%
9737 \ifx\emergencystretch\thisisundefined
9738 % Allow us to assign to \emergencystretch anyway.
9739 \def\emergencystretch{\dimen0}%
9740 \else
9741 \emergencystretch = .15\hsize
9745 % Parameters in order: 1) textheight; 2) textwidth;
9746 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9747 % 7) physical page height; 8) physical page width.
9749 % We also call \setleading{\textleading}, so the caller should define
9750 % \textleading. The caller should also set \parskip.
9752 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9753 \voffset = #3\relax
9754 \topskip = #6\relax
9755 \splittopskip = \topskip
9757 \vsize = #1\relax
9758 \advance\vsize by \topskip
9759 \outervsize = \vsize
9760 \advance\outervsize by 2\topandbottommargin
9761 \pageheight = \vsize
9763 \hsize = #2\relax
9764 \outerhsize = \hsize
9765 \advance\outerhsize by 0.5in
9766 \pagewidth = \hsize
9768 \normaloffset = #4\relax
9769 \bindingoffset = #5\relax
9771 \ifpdf
9772 \pdfpageheight #7\relax
9773 \pdfpagewidth #8\relax
9774 % if we don't reset these, they will remain at "1 true in" of
9775 % whatever layout pdftex was dumped with.
9776 \pdfhorigin = 1 true in
9777 \pdfvorigin = 1 true in
9780 \setleading{\textleading}
9782 \parindent = \defaultparindent
9783 \setemergencystretch
9786 % @letterpaper (the default).
9787 \def\letterpaper{{\globaldefs = 1
9788 \parskip = 3pt plus 2pt minus 1pt
9789 \textleading = 13.2pt
9791 % If page is nothing but text, make it come out even.
9792 \internalpagesizes{607.2pt}{6in}% that's 46 lines
9793 {\voffset}{.25in}%
9794 {\bindingoffset}{36pt}%
9795 {11in}{8.5in}%
9798 % Use @smallbook to reset parameters for 7x9.25 trim size.
9799 \def\smallbook{{\globaldefs = 1
9800 \parskip = 2pt plus 1pt
9801 \textleading = 12pt
9803 \internalpagesizes{7.5in}{5in}%
9804 {-.2in}{0in}%
9805 {\bindingoffset}{16pt}%
9806 {9.25in}{7in}%
9808 \lispnarrowing = 0.3in
9809 \tolerance = 700
9810 \hfuzz = 1pt
9811 \contentsrightmargin = 0pt
9812 \defbodyindent = .5cm
9815 % Use @smallerbook to reset parameters for 6x9 trim size.
9816 % (Just testing, parameters still in flux.)
9817 \def\smallerbook{{\globaldefs = 1
9818 \parskip = 1.5pt plus 1pt
9819 \textleading = 12pt
9821 \internalpagesizes{7.4in}{4.8in}%
9822 {-.2in}{-.4in}%
9823 {0pt}{14pt}%
9824 {9in}{6in}%
9826 \lispnarrowing = 0.25in
9827 \tolerance = 700
9828 \hfuzz = 1pt
9829 \contentsrightmargin = 0pt
9830 \defbodyindent = .4cm
9833 % Use @afourpaper to print on European A4 paper.
9834 \def\afourpaper{{\globaldefs = 1
9835 \parskip = 3pt plus 2pt minus 1pt
9836 \textleading = 13.2pt
9838 % Double-side printing via postscript on Laserjet 4050
9839 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9840 % To change the settings for a different printer or situation, adjust
9841 % \normaloffset until the front-side and back-side texts align. Then
9842 % do the same for \bindingoffset. You can set these for testing in
9843 % your texinfo source file like this:
9844 % @tex
9845 % \global\normaloffset = -6mm
9846 % \global\bindingoffset = 10mm
9847 % @end tex
9848 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9849 {\voffset}{\hoffset}%
9850 {\bindingoffset}{44pt}%
9851 {297mm}{210mm}%
9853 \tolerance = 700
9854 \hfuzz = 1pt
9855 \contentsrightmargin = 0pt
9856 \defbodyindent = 5mm
9859 % Use @afivepaper to print on European A5 paper.
9860 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9861 % He also recommends making @example and @lisp be small.
9862 \def\afivepaper{{\globaldefs = 1
9863 \parskip = 2pt plus 1pt minus 0.1pt
9864 \textleading = 12.5pt
9866 \internalpagesizes{160mm}{120mm}%
9867 {\voffset}{\hoffset}%
9868 {\bindingoffset}{8pt}%
9869 {210mm}{148mm}%
9871 \lispnarrowing = 0.2in
9872 \tolerance = 800
9873 \hfuzz = 1.2pt
9874 \contentsrightmargin = 0pt
9875 \defbodyindent = 2mm
9876 \tableindent = 12mm
9879 % A specific text layout, 24x15cm overall, intended for A4 paper.
9880 \def\afourlatex{{\globaldefs = 1
9881 \afourpaper
9882 \internalpagesizes{237mm}{150mm}%
9883 {\voffset}{4.6mm}%
9884 {\bindingoffset}{7mm}%
9885 {297mm}{210mm}%
9887 % Must explicitly reset to 0 because we call \afourpaper.
9888 \globaldefs = 0
9891 % Use @afourwide to print on A4 paper in landscape format.
9892 \def\afourwide{{\globaldefs = 1
9893 \afourpaper
9894 \internalpagesizes{241mm}{165mm}%
9895 {\voffset}{-2.95mm}%
9896 {\bindingoffset}{7mm}%
9897 {297mm}{210mm}%
9898 \globaldefs = 0
9901 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9902 % Perhaps we should allow setting the margins, \topskip, \parskip,
9903 % and/or leading, also. Or perhaps we should compute them somehow.
9905 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9906 \def\pagesizesyyy#1,#2,#3\finish{{%
9907 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9908 \globaldefs = 1
9910 \parskip = 3pt plus 2pt minus 1pt
9911 \setleading{\textleading}%
9913 \dimen0 = #1\relax
9914 \advance\dimen0 by \voffset
9916 \dimen2 = \hsize
9917 \advance\dimen2 by \normaloffset
9919 \internalpagesizes{#1}{\hsize}%
9920 {\voffset}{\normaloffset}%
9921 {\bindingoffset}{44pt}%
9922 {\dimen0}{\dimen2}%
9925 % Set default to letter.
9927 \letterpaper
9930 \message{and turning on texinfo input format.}
9932 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
9934 % DEL is a comment character, in case @c does not suffice.
9935 \catcode`\^^? = 14
9937 % Define macros to output various characters with catcode for normal text.
9938 \catcode`\"=\other \def\normaldoublequote{"}
9939 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
9940 \catcode`\+=\other \def\normalplus{+}
9941 \catcode`\<=\other \def\normalless{<}
9942 \catcode`\>=\other \def\normalgreater{>}
9943 \catcode`\^=\other \def\normalcaret{^}
9944 \catcode`\_=\other \def\normalunderscore{_}
9945 \catcode`\|=\other \def\normalverticalbar{|}
9946 \catcode`\~=\other \def\normaltilde{~}
9948 % This macro is used to make a character print one way in \tt
9949 % (where it can probably be output as-is), and another way in other fonts,
9950 % where something hairier probably needs to be done.
9952 % #1 is what to print if we are indeed using \tt; #2 is what to print
9953 % otherwise. Since all the Computer Modern typewriter fonts have zero
9954 % interword stretch (and shrink), and it is reasonable to expect all
9955 % typewriter fonts to have this, we can check that font parameter.
9957 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9959 % Same as above, but check for italic font. Actually this also catches
9960 % non-italic slanted fonts since it is impossible to distinguish them from
9961 % italic fonts. But since this is only used by $ and it uses \sl anyway
9962 % this is not a problem.
9963 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9965 % Turn off all special characters except @
9966 % (and those which the user can use as if they were ordinary).
9967 % Most of these we simply print from the \tt font, but for some, we can
9968 % use math or other variants that look better in normal text.
9970 \catcode`\"=\active
9971 \def\activedoublequote{{\tt\char34}}
9972 \let"=\activedoublequote
9973 \catcode`\~=\active \def\activetilde{{\tt\char126}} \let~ = \activetilde
9974 \chardef\hat=`\^
9975 \catcode`\^=\active \def\activehat{{\tt \hat}} \let^ = \activehat
9977 \catcode`\_=\active
9978 \def_{\ifusingtt\normalunderscore\_}
9979 \let\realunder=_
9980 % Subroutine for the previous macro.
9981 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9983 \catcode`\|=\active
9984 \def|{{\tt\char124}}
9986 \chardef \less=`\<
9987 \catcode`\<=\active \def\activeless{{\tt \less}}\let< = \activeless
9988 \chardef \gtr=`\>
9989 \catcode`\>=\active \def\activegtr{{\tt \gtr}}\let> = \activegtr
9990 \catcode`\+=\active \def+{{\tt \char 43}}
9991 \catcode`\$=\active \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9993 % used for headline/footline in the output routine, in case the page
9994 % breaks in the middle of an @tex block.
9995 \def\texinfochars{%
9996 \let< = \activeless
9997 \let> = \activegtr
9998 \let~ = \activetilde
9999 \let^ = \activehat
10000 \markupsetuplqdefault \markupsetuprqdefault
10001 \let\b = \strong
10002 \let\i = \smartitalic
10003 % in principle, all other definitions in \tex have to be undone too.
10006 % If a .fmt file is being used, characters that might appear in a file
10007 % name cannot be active until we have parsed the command line.
10008 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
10009 % \otherifyactive is called near the end of this file.
10010 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
10012 % Used sometimes to turn off (effectively) the active characters even after
10013 % parsing them.
10014 \def\turnoffactive{%
10015 \normalturnoffactive
10016 \otherbackslash
10019 \catcode`\@=0
10021 % \backslashcurfont outputs one backslash character in current font,
10022 % as in \char`\\.
10023 \global\chardef\backslashcurfont=`\\
10024 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
10026 % \realbackslash is an actual character `\' with catcode other, and
10027 % \doublebackslash is two of them (for the pdf outlines).
10028 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
10030 % In texinfo, backslash is an active character; it prints the backslash
10031 % in fixed width font.
10032 \catcode`\\=\active % @ for escape char from now on.
10034 % The story here is that in math mode, the \char of \backslashcurfont
10035 % ends up printing the roman \ from the math symbol font (because \char
10036 % in math mode uses the \mathcode, and plain.tex sets
10037 % \mathcode`\\="026E). It seems better for @backslashchar{} to always
10038 % print a typewriter backslash, hence we use an explicit \mathchar,
10039 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
10040 % ignored family value; char position "5C). We can't use " for the
10041 % usual hex value because it has already been made active.
10042 @def@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
10043 @let@backslashchar = @normalbackslash % @backslashchar{} is for user documents.
10045 % On startup, @fixbackslash assigns:
10046 % @let \ = @normalbackslash
10047 % \rawbackslash defines an active \ to do \backslashcurfont.
10048 % \otherbackslash defines an active \ to be a literal `\' character with
10049 % catcode other. We switch back and forth between these.
10050 @gdef@rawbackslash{@let\=@backslashcurfont}
10051 @gdef@otherbackslash{@let\=@realbackslash}
10053 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
10054 % the literal character `\'. Also revert - to its normal character, in
10055 % case the active - from code has slipped in.
10057 {@catcode`- = @active
10058 @gdef@normalturnoffactive{%
10059 @let-=@normaldash
10060 @let"=@normaldoublequote
10061 @let$=@normaldollar %$ font-lock fix
10062 @let+=@normalplus
10063 @let<=@normalless
10064 @let>=@normalgreater
10065 @let\=@normalbackslash
10066 @let^=@normalcaret
10067 @let_=@normalunderscore
10068 @let|=@normalverticalbar
10069 @let~=@normaltilde
10070 @markupsetuplqdefault
10071 @markupsetuprqdefault
10072 @unsepspaces
10076 % Make _ and + \other characters, temporarily.
10077 % This is canceled by @fixbackslash.
10078 @otherifyactive
10080 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
10081 % That is what \eatinput is for; after that, the `\' should revert to printing
10082 % a backslash.
10084 @gdef@eatinput input texinfo{@fixbackslash}
10085 @global@let\ = @eatinput
10087 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
10088 % the first `\' in the file would cause an error. This macro tries to fix
10089 % that, assuming it is called before the first `\' could plausibly occur.
10090 % Also turn back on active characters that might appear in the input
10091 % file name, in case not using a pre-dumped format.
10093 @gdef@fixbackslash{%
10094 @ifx\@eatinput @let\ = @normalbackslash @fi
10095 @catcode`+=@active
10096 @catcode`@_=@active
10099 % Say @foo, not \foo, in error messages.
10100 @escapechar = `@@
10102 % These (along with & and #) are made active for url-breaking, so need
10103 % active definitions as the normal characters.
10104 @def@normaldot{.}
10105 @def@normalquest{?}
10106 @def@normalslash{/}
10108 % These look ok in all fonts, so just make them not special.
10109 % @hashchar{} gets its own user-level command, because of #line.
10110 @catcode`@& = @other @def@normalamp{&}
10111 @catcode`@# = @other @def@normalhash{#}
10112 @catcode`@% = @other @def@normalpercent{%}
10114 @let @hashchar = @normalhash
10116 @c Finally, make ` and ' active, so that txicodequoteundirected and
10117 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
10118 @c don't make ` and ' active, @code will not get them as active chars.
10119 @c Do this last of all since we use ` in the previous @catcode assignments.
10120 @catcode`@'=@active
10121 @catcode`@`=@active
10122 @markupsetuplqdefault
10123 @markupsetuprqdefault
10125 @c Local variables:
10126 @c eval: (add-hook 'write-file-hooks 'time-stamp)
10127 @c page-delimiter: "^\\\\message"
10128 @c time-stamp-start: "def\\\\texinfoversion{"
10129 @c time-stamp-format: "%:y-%02m-%02d.%02H"
10130 @c time-stamp-end: "}"
10131 @c End:
10133 @c vim:sw=2:
10135 @ignore
10136 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
10137 @end ignore