* Makefile.in (removenullpaths): Remove adjacent null paths.
[emacs.git] / doc / misc / texinfo.tex
blob3427d2ad0e3e9e0a7acf0d69a5c66d1423df5ce4
1 % texinfo.tex -- TeX macros to handle Texinfo files.
2 %
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
6 \def\texinfoversion{2013-06-23.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
285 \noexpand\or \the\toks4 \the\toks6
286 \noexpand\else \the\toks8
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 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
326 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
327 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
328 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
331 % Have to do this stuff outside the \shipout because we want it to
332 % take effect in \write's, yet the group defined by the \vbox ends
333 % before the \shipout runs.
335 \indexdummies % don't expand commands in the output.
336 \normalturnoffactive % \ in index entries must not stay \, e.g., if
337 % the page break happens to be in the middle of an example.
338 % We don't want .vr (or whatever) entries like this:
339 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
340 % "\acronym" won't work when it's read back in;
341 % it needs to be
342 % {\code {{\tt \backslashcurfont }acronym}
343 \shipout\vbox{%
344 % Do this early so pdf references go to the beginning of the page.
345 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
347 \ifcropmarks \vbox to \outervsize\bgroup
348 \hsize = \outerhsize
349 \vskip-\topandbottommargin
350 \vtop to0pt{%
351 \line{\ewtop\hfil\ewtop}%
352 \nointerlineskip
353 \line{%
354 \vbox{\moveleft\cornerthick\nstop}%
355 \hfill
356 \vbox{\moveright\cornerthick\nstop}%
358 \vss}%
359 \vskip\topandbottommargin
360 \line\bgroup
361 \hfil % center the page within the outer (page) hsize.
362 \ifodd\pageno\hskip\bindingoffset\fi
363 \vbox\bgroup
366 \unvbox\headlinebox
367 \pagebody{#1}%
368 \ifdim\ht\footlinebox > 0pt
369 % Only leave this space if the footline is nonempty.
370 % (We lessened \vsize for it in \oddfootingyyy.)
371 % The \baselineskip=24pt in plain's \makefootline has no effect.
372 \vskip 24pt
373 \unvbox\footlinebox
376 \ifcropmarks
377 \egroup % end of \vbox\bgroup
378 \hfil\egroup % end of (centering) \line\bgroup
379 \vskip\topandbottommargin plus1fill minus1fill
380 \boxmaxdepth = \cornerthick
381 \vbox to0pt{\vss
382 \line{%
383 \vbox{\moveleft\cornerthick\nsbot}%
384 \hfill
385 \vbox{\moveright\cornerthick\nsbot}%
387 \nointerlineskip
388 \line{\ewbot\hfil\ewbot}%
390 \egroup % \vbox from first cropmarks clause
392 }% end of \shipout\vbox
393 }% end of group with \indexdummies
394 \advancepageno
395 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
398 \newinsert\margin \dimen\margin=\maxdimen
400 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
401 {\catcode`\@ =11
402 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
403 % marginal hacks, juha@viisa.uucp (Juha Takala)
404 \ifvoid\margin\else % marginal info is present
405 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
406 \dimen@=\dp#1\relax \unvbox#1\relax
407 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
408 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
411 % Here are the rules for the cropmarks. Note that they are
412 % offset so that the space between them is truly \outerhsize or \outervsize
413 % (P. A. MacKay, 12 November, 1986)
415 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
416 \def\nstop{\vbox
417 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
418 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
419 \def\nsbot{\vbox
420 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
422 % Parse an argument, then pass it to #1. The argument is the rest of
423 % the input line (except we remove a trailing comment). #1 should be a
424 % macro which expects an ordinary undelimited TeX argument.
426 \def\parsearg{\parseargusing{}}
427 \def\parseargusing#1#2{%
428 \def\argtorun{#2}%
429 \begingroup
430 \obeylines
431 \spaceisspace
433 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
436 {\obeylines %
437 \gdef\parseargline#1^^M{%
438 \endgroup % End of the group started in \parsearg.
439 \argremovecomment #1\comment\ArgTerm%
443 % First remove any @comment, then any @c comment.
444 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
445 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
447 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
449 % \argremovec might leave us with trailing space, e.g.,
450 % @end itemize @c foo
451 % This space token undergoes the same procedure and is eventually removed
452 % by \finishparsearg.
454 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
455 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
456 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
457 \def\temp{#3}%
458 \ifx\temp\empty
459 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
460 \let\temp\finishparsearg
461 \else
462 \let\temp\argcheckspaces
464 % Put the space token in:
465 \temp#1 #3\ArgTerm
468 % If a _delimited_ argument is enclosed in braces, they get stripped; so
469 % to get _exactly_ the rest of the line, we had to prevent such situation.
470 % We prepended an \empty token at the very beginning and we expand it now,
471 % just before passing the control to \argtorun.
472 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
473 % either the null string, or it ends with \^^M---thus there is no danger
474 % that a pair of braces would be stripped.
476 % But first, we have to remove the trailing space token.
478 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
480 % \parseargdef\foo{...}
481 % is roughly equivalent to
482 % \def\foo{\parsearg\Xfoo}
483 % \def\Xfoo#1{...}
485 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
486 % favourite TeX trick. --kasal, 16nov03
488 \def\parseargdef#1{%
489 \expandafter \doparseargdef \csname\string#1\endcsname #1%
491 \def\doparseargdef#1#2{%
492 \def#2{\parsearg#1}%
493 \def#1##1%
496 % Several utility definitions with active space:
498 \obeyspaces
499 \gdef\obeyedspace{ }
501 % Make each space character in the input produce a normal interword
502 % space in the output. Don't allow a line break at this space, as this
503 % is used only in environments like @example, where each line of input
504 % should produce a line of output anyway.
506 \gdef\sepspaces{\obeyspaces\let =\tie}
508 % If an index command is used in an @example environment, any spaces
509 % therein should become regular spaces in the raw index file, not the
510 % expansion of \tie (\leavevmode \penalty \@M \ ).
511 \gdef\unsepspaces{\let =\space}
515 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
517 % Define the framework for environments in texinfo.tex. It's used like this:
519 % \envdef\foo{...}
520 % \def\Efoo{...}
522 % It's the responsibility of \envdef to insert \begingroup before the
523 % actual body; @end closes the group after calling \Efoo. \envdef also
524 % defines \thisenv, so the current environment is known; @end checks
525 % whether the environment name matches. The \checkenv macro can also be
526 % used to check whether the current environment is the one expected.
528 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
529 % are not treated as environments; they don't open a group. (The
530 % implementation of @end takes care not to call \endgroup in this
531 % special case.)
534 % At run-time, environments start with this:
535 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
536 % initialize
537 \let\thisenv\empty
539 % ... but they get defined via ``\envdef\foo{...}'':
540 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
541 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
543 % Check whether we're in the right environment:
544 \def\checkenv#1{%
545 \def\temp{#1}%
546 \ifx\thisenv\temp
547 \else
548 \badenverr
552 % Environment mismatch, #1 expected:
553 \def\badenverr{%
554 \errhelp = \EMsimple
555 \errmessage{This command can appear only \inenvironment\temp,
556 not \inenvironment\thisenv}%
558 \def\inenvironment#1{%
559 \ifx#1\empty
560 outside of any environment%
561 \else
562 in environment \expandafter\string#1%
566 % @end foo executes the definition of \Efoo.
567 % But first, it executes a specialized version of \checkenv
569 \parseargdef\end{%
570 \if 1\csname iscond.#1\endcsname
571 \else
572 % The general wording of \badenverr may not be ideal.
573 \expandafter\checkenv\csname#1\endcsname
574 \csname E#1\endcsname
575 \endgroup
579 \newhelp\EMsimple{Press RETURN to continue.}
582 % Be sure we're in horizontal mode when doing a tie, since we make space
583 % equivalent to this in @example-like environments. Otherwise, a space
584 % at the beginning of a line will start with \penalty -- and
585 % since \penalty is valid in vertical mode, we'd end up putting the
586 % penalty on the vertical list instead of in the new paragraph.
587 {\catcode`@ = 11
588 % Avoid using \@M directly, because that causes trouble
589 % if the definition is written into an index file.
590 \global\let\tiepenalty = \@M
591 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
594 % @: forces normal size whitespace following.
595 \def\:{\spacefactor=1000 }
597 % @* forces a line break.
598 \def\*{\unskip\hfil\break\hbox{}\ignorespaces}
600 % @/ allows a line break.
601 \let\/=\allowbreak
603 % @. is an end-of-sentence period.
604 \def\.{.\spacefactor=\endofsentencespacefactor\space}
606 % @! is an end-of-sentence bang.
607 \def\!{!\spacefactor=\endofsentencespacefactor\space}
609 % @? is an end-of-sentence query.
610 \def\?{?\spacefactor=\endofsentencespacefactor\space}
612 % @frenchspacing on|off says whether to put extra space after punctuation.
614 \def\onword{on}
615 \def\offword{off}
617 \parseargdef\frenchspacing{%
618 \def\temp{#1}%
619 \ifx\temp\onword \plainfrenchspacing
620 \else\ifx\temp\offword \plainnonfrenchspacing
621 \else
622 \errhelp = \EMsimple
623 \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
624 \fi\fi
627 % @w prevents a word break. Without the \leavevmode, @w at the
628 % beginning of a paragraph, when TeX is still in vertical mode, would
629 % produce a whole line of output instead of starting the paragraph.
630 \def\w#1{\leavevmode\hbox{#1}}
632 % @group ... @end group forces ... to be all on one page, by enclosing
633 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
634 % to keep its height that of a normal line. According to the rules for
635 % \topskip (p.114 of the TeXbook), the glue inserted is
636 % max (\topskip - \ht (first item), 0). If that height is large,
637 % therefore, no glue is inserted, and the space between the headline and
638 % the text is small, which looks bad.
640 % Another complication is that the group might be very large. This can
641 % cause the glue on the previous page to be unduly stretched, because it
642 % does not have much material. In this case, it's better to add an
643 % explicit \vfill so that the extra space is at the bottom. The
644 % threshold for doing this is if the group is more than \vfilllimit
645 % percent of a page (\vfilllimit can be changed inside of @tex).
647 \newbox\groupbox
648 \def\vfilllimit{0.7}
650 \envdef\group{%
651 \ifnum\catcode`\^^M=\active \else
652 \errhelp = \groupinvalidhelp
653 \errmessage{@group invalid in context where filling is enabled}%
655 \startsavinginserts
657 \setbox\groupbox = \vtop\bgroup
658 % Do @comment since we are called inside an environment such as
659 % @example, where each end-of-line in the input causes an
660 % end-of-line in the output. We don't want the end-of-line after
661 % the `@group' to put extra space in the output. Since @group
662 % should appear on a line by itself (according to the Texinfo
663 % manual), we don't worry about eating any user text.
664 \comment
667 % The \vtop produces a box with normal height and large depth; thus, TeX puts
668 % \baselineskip glue before it, and (when the next line of text is done)
669 % \lineskip glue after it. Thus, space below is not quite equal to space
670 % above. But it's pretty close.
671 \def\Egroup{%
672 % To get correct interline space between the last line of the group
673 % and the first line afterwards, we have to propagate \prevdepth.
674 \endgraf % Not \par, as it may have been set to \lisppar.
675 \global\dimen1 = \prevdepth
676 \egroup % End the \vtop.
677 % \dimen0 is the vertical size of the group's box.
678 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
679 % \dimen2 is how much space is left on the page (more or less).
680 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
681 % if the group doesn't fit on the current page, and it's a big big
682 % group, force a page break.
683 \ifdim \dimen0 > \dimen2
684 \ifdim \pagetotal < \vfilllimit\pageheight
685 \page
688 \box\groupbox
689 \prevdepth = \dimen1
690 \checkinserts
693 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
694 % message, so this ends up printing `@group can only ...'.
696 \newhelp\groupinvalidhelp{%
697 group can only be used in environments such as @example,^^J%
698 where each line of input produces a line of output.}
700 % @need space-in-mils
701 % forces a page break if there is not space-in-mils remaining.
703 \newdimen\mil \mil=0.001in
705 \parseargdef\need{%
706 % Ensure vertical mode, so we don't make a big box in the middle of a
707 % paragraph.
708 \par
710 % If the @need value is less than one line space, it's useless.
711 \dimen0 = #1\mil
712 \dimen2 = \ht\strutbox
713 \advance\dimen2 by \dp\strutbox
714 \ifdim\dimen0 > \dimen2
716 % Do a \strut just to make the height of this box be normal, so the
717 % normal leading is inserted relative to the preceding line.
718 % And a page break here is fine.
719 \vtop to #1\mil{\strut\vfil}%
721 % TeX does not even consider page breaks if a penalty added to the
722 % main vertical list is 10000 or more. But in order to see if the
723 % empty box we just added fits on the page, we must make it consider
724 % page breaks. On the other hand, we don't want to actually break the
725 % page after the empty box. So we use a penalty of 9999.
727 % There is an extremely small chance that TeX will actually break the
728 % page at this \penalty, if there are no other feasible breakpoints in
729 % sight. (If the user is using lots of big @group commands, which
730 % almost-but-not-quite fill up a page, TeX will have a hard time doing
731 % good page breaking, for example.) However, I could not construct an
732 % example where a page broke at this \penalty; if it happens in a real
733 % document, then we can reconsider our strategy.
734 \penalty9999
736 % Back up by the size of the box, whether we did a page break or not.
737 \kern -#1\mil
739 % Do not allow a page break right after this kern.
740 \nobreak
744 % @br forces paragraph break (and is undocumented).
746 \let\br = \par
748 % @page forces the start of a new page.
750 \def\page{\par\vfill\supereject}
752 % @exdent text....
753 % outputs text on separate line in roman font, starting at standard page margin
755 % This records the amount of indent in the innermost environment.
756 % That's how much \exdent should take out.
757 \newskip\exdentamount
759 % This defn is used inside fill environments such as @defun.
760 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
762 % This defn is used inside nofill environments such as @example.
763 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
764 \leftline{\hskip\leftskip{\rm#1}}}}
766 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
767 % paragraph. For more general purposes, use the \margin insertion
768 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
770 \newskip\inmarginspacing \inmarginspacing=1cm
771 \def\strutdepth{\dp\strutbox}
773 \def\doinmargin#1#2{\strut\vadjust{%
774 \nobreak
775 \kern-\strutdepth
776 \vtop to \strutdepth{%
777 \baselineskip=\strutdepth
778 \vss
779 % if you have multiple lines of stuff to put here, you'll need to
780 % make the vbox yourself of the appropriate size.
781 \ifx#1l%
782 \llap{\ignorespaces #2\hskip\inmarginspacing}%
783 \else
784 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
786 \null
789 \def\inleftmargin{\doinmargin l}
790 \def\inrightmargin{\doinmargin r}
792 % @inmargin{TEXT [, RIGHT-TEXT]}
793 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
794 % else use TEXT for both).
796 \def\inmargin#1{\parseinmargin #1,,\finish}
797 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
798 \setbox0 = \hbox{\ignorespaces #2}%
799 \ifdim\wd0 > 0pt
800 \def\lefttext{#1}% have both texts
801 \def\righttext{#2}%
802 \else
803 \def\lefttext{#1}% have only one text
804 \def\righttext{#1}%
807 \ifodd\pageno
808 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
809 \else
810 \def\temp{\inleftmargin\lefttext}%
812 \temp
815 % @| inserts a changebar to the left of the current line. It should
816 % surround any changed text. This approach does *not* work if the
817 % change spans more than two lines of output. To handle that, we would
818 % have adopt a much more difficult approach (putting marks into the main
819 % vertical list for the beginning and end of each change). This command
820 % is not documented, not supported, and doesn't work.
822 \def\|{%
823 % \vadjust can only be used in horizontal mode.
824 \leavevmode
826 % Append this vertical mode material after the current line in the output.
827 \vadjust{%
828 % We want to insert a rule with the height and depth of the current
829 % leading; that is exactly what \strutbox is supposed to record.
830 \vskip-\baselineskip
832 % \vadjust-items are inserted at the left edge of the type. So
833 % the \llap here moves out into the left-hand margin.
834 \llap{%
836 % For a thicker or thinner bar, change the `1pt'.
837 \vrule height\baselineskip width1pt
839 % This is the space between the bar and the text.
840 \hskip 12pt
845 % @include FILE -- \input text of FILE.
847 \def\include{\parseargusing\filenamecatcodes\includezzz}
848 \def\includezzz#1{%
849 \pushthisfilestack
850 \def\thisfile{#1}%
852 \makevalueexpandable % we want to expand any @value in FILE.
853 \turnoffactive % and allow special characters in the expansion
854 \indexnofonts % Allow `@@' and other weird things in file names.
855 \wlog{texinfo.tex: doing @include of #1^^J}%
856 \edef\temp{\noexpand\input #1 }%
858 % This trickery is to read FILE outside of a group, in case it makes
859 % definitions, etc.
860 \expandafter
861 }\temp
862 \popthisfilestack
864 \def\filenamecatcodes{%
865 \catcode`\\=\other
866 \catcode`~=\other
867 \catcode`^=\other
868 \catcode`_=\other
869 \catcode`|=\other
870 \catcode`<=\other
871 \catcode`>=\other
872 \catcode`+=\other
873 \catcode`-=\other
874 \catcode`\`=\other
875 \catcode`\'=\other
878 \def\pushthisfilestack{%
879 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
881 \def\pushthisfilestackX{%
882 \expandafter\pushthisfilestackY\thisfile\StackTerm
884 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
885 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
888 \def\popthisfilestack{\errthisfilestackempty}
889 \def\errthisfilestackempty{\errmessage{Internal error:
890 the stack of filenames is empty.}}
892 \def\thisfile{}
894 % @center line
895 % outputs that line, centered.
897 \parseargdef\center{%
898 \ifhmode
899 \let\centersub\centerH
900 \else
901 \let\centersub\centerV
903 \centersub{\hfil \ignorespaces#1\unskip \hfil}%
904 \let\centersub\relax % don't let the definition persist, just in case
906 \def\centerH#1{{%
907 \hfil\break
908 \advance\hsize by -\leftskip
909 \advance\hsize by -\rightskip
910 \line{#1}%
911 \break
914 \newcount\centerpenalty
915 \def\centerV#1{%
916 % The idea here is the same as in \startdefun, \cartouche, etc.: if
917 % @center is the first thing after a section heading, we need to wipe
918 % out the negative parskip inserted by \sectionheading, but still
919 % prevent a page break here.
920 \centerpenalty = \lastpenalty
921 \ifnum\centerpenalty>10000 \vskip\parskip \fi
922 \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi
923 \line{\kern\leftskip #1\kern\rightskip}%
926 % @sp n outputs n lines of vertical space
928 \parseargdef\sp{\vskip #1\baselineskip}
930 % @comment ...line which is ignored...
931 % @c is the same as @comment
932 % @ignore ... @end ignore is another way to write a comment
934 \def\comment{\begingroup \catcode`\^^M=\other%
935 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
936 \commentxxx}
937 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
939 \let\c=\comment
941 % @paragraphindent NCHARS
942 % We'll use ems for NCHARS, close enough.
943 % NCHARS can also be the word `asis' or `none'.
944 % We cannot feasibly implement @paragraphindent asis, though.
946 \def\asisword{asis} % no translation, these are keywords
947 \def\noneword{none}
949 \parseargdef\paragraphindent{%
950 \def\temp{#1}%
951 \ifx\temp\asisword
952 \else
953 \ifx\temp\noneword
954 \defaultparindent = 0pt
955 \else
956 \defaultparindent = #1em
959 \parindent = \defaultparindent
962 % @exampleindent NCHARS
963 % We'll use ems for NCHARS like @paragraphindent.
964 % It seems @exampleindent asis isn't necessary, but
965 % I preserve it to make it similar to @paragraphindent.
966 \parseargdef\exampleindent{%
967 \def\temp{#1}%
968 \ifx\temp\asisword
969 \else
970 \ifx\temp\noneword
971 \lispnarrowing = 0pt
972 \else
973 \lispnarrowing = #1em
978 % @firstparagraphindent WORD
979 % If WORD is `none', then suppress indentation of the first paragraph
980 % after a section heading. If WORD is `insert', then do indent at such
981 % paragraphs.
983 % The paragraph indentation is suppressed or not by calling
984 % \suppressfirstparagraphindent, which the sectioning commands do.
985 % We switch the definition of this back and forth according to WORD.
986 % By default, we suppress indentation.
988 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
989 \def\insertword{insert}
991 \parseargdef\firstparagraphindent{%
992 \def\temp{#1}%
993 \ifx\temp\noneword
994 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
995 \else\ifx\temp\insertword
996 \let\suppressfirstparagraphindent = \relax
997 \else
998 \errhelp = \EMsimple
999 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1000 \fi\fi
1003 % Here is how we actually suppress indentation. Redefine \everypar to
1004 % \kern backwards by \parindent, and then reset itself to empty.
1006 % We also make \indent itself not actually do anything until the next
1007 % paragraph.
1009 \gdef\dosuppressfirstparagraphindent{%
1010 \gdef\indent{%
1011 \restorefirstparagraphindent
1012 \indent
1014 \gdef\noindent{%
1015 \restorefirstparagraphindent
1016 \noindent
1018 \global\everypar = {%
1019 \kern -\parindent
1020 \restorefirstparagraphindent
1024 \gdef\restorefirstparagraphindent{%
1025 \global \let \indent = \ptexindent
1026 \global \let \noindent = \ptexnoindent
1027 \global \everypar = {}%
1031 % @refill is a no-op.
1032 \let\refill=\relax
1034 % If working on a large document in chapters, it is convenient to
1035 % be able to disable indexing, cross-referencing, and contents, for test runs.
1036 % This is done with @novalidate (before @setfilename).
1038 \newif\iflinks \linkstrue % by default we want the aux files.
1039 \let\novalidate = \linksfalse
1041 % @setfilename is done at the beginning of every texinfo file.
1042 % So open here the files we need to have open while reading the input.
1043 % This makes it possible to make a .fmt file for texinfo.
1044 \def\setfilename{%
1045 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1046 \iflinks
1047 \tryauxfile
1048 % Open the new aux file. TeX will close it automatically at exit.
1049 \immediate\openout\auxfile=\jobname.aux
1050 \fi % \openindices needs to do some work in any case.
1051 \openindices
1052 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1054 % If texinfo.cnf is present on the system, read it.
1055 % Useful for site-wide @afourpaper, etc.
1056 \openin 1 texinfo.cnf
1057 \ifeof 1 \else \input texinfo.cnf \fi
1058 \closein 1
1060 \comment % Ignore the actual filename.
1063 % Called from \setfilename.
1065 \def\openindices{%
1066 \newindex{cp}%
1067 \newcodeindex{fn}%
1068 \newcodeindex{vr}%
1069 \newcodeindex{tp}%
1070 \newcodeindex{ky}%
1071 \newcodeindex{pg}%
1074 % @bye.
1075 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1078 \message{pdf,}
1079 % adobe `portable' document format
1080 \newcount\tempnum
1081 \newcount\lnkcount
1082 \newtoks\filename
1083 \newcount\filenamelength
1084 \newcount\pgn
1085 \newtoks\toksA
1086 \newtoks\toksB
1087 \newtoks\toksC
1088 \newtoks\toksD
1089 \newbox\boxA
1090 \newcount\countA
1091 \newif\ifpdf
1092 \newif\ifpdfmakepagedest
1094 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1095 % can be set). So we test for \relax and 0 as well as being undefined.
1096 \ifx\pdfoutput\thisisundefined
1097 \else
1098 \ifx\pdfoutput\relax
1099 \else
1100 \ifcase\pdfoutput
1101 \else
1102 \pdftrue
1107 % PDF uses PostScript string constants for the names of xref targets,
1108 % for display in the outlines, and in other places. Thus, we have to
1109 % double any backslashes. Otherwise, a name like "\node" will be
1110 % interpreted as a newline (\n), followed by o, d, e. Not good.
1112 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1113 % related messages. The final outcome is that it is up to the TeX user
1114 % to double the backslashes and otherwise make the string valid, so
1115 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1116 % do this reliably, so we use it.
1118 % #1 is a control sequence in which to do the replacements,
1119 % which we \xdef.
1120 \def\txiescapepdf#1{%
1121 \ifx\pdfescapestring\thisisundefined
1122 % No primitive available; should we give a warning or log?
1123 % Many times it won't matter.
1124 \else
1125 % The expandable \pdfescapestring primitive escapes parentheses,
1126 % backslashes, and other special chars.
1127 \xdef#1{\pdfescapestring{#1}}%
1131 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1132 with PDF output, and none of those formats could be found. (.eps cannot
1133 be supported due to the design of the PDF format; use regular TeX (DVI
1134 output) for that.)}
1136 \ifpdf
1138 % Color manipulation macros based on pdfcolor.tex,
1139 % except using rgb instead of cmyk; the latter is said to render as a
1140 % very dark gray on-screen and a very dark halftone in print, instead
1141 % of actual black.
1142 \def\rgbDarkRed{0.50 0.09 0.12}
1143 \def\rgbBlack{0 0 0}
1145 % k sets the color for filling (usual text, etc.);
1146 % K sets the color for stroking (thin rules, e.g., normal _'s).
1147 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1149 % Set color, and create a mark which defines \thiscolor accordingly,
1150 % so that \makeheadline knows which color to restore.
1151 \def\setcolor#1{%
1152 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1153 \domark
1154 \pdfsetcolor{#1}%
1157 \def\maincolor{\rgbBlack}
1158 \pdfsetcolor{\maincolor}
1159 \edef\thiscolor{\maincolor}
1160 \def\lastcolordefs{}
1162 \def\makefootline{%
1163 \baselineskip24pt
1164 \line{\pdfsetcolor{\maincolor}\the\footline}%
1167 \def\makeheadline{%
1168 \vbox to 0pt{%
1169 \vskip-22.5pt
1170 \line{%
1171 \vbox to8.5pt{}%
1172 % Extract \thiscolor definition from the marks.
1173 \getcolormarks
1174 % Typeset the headline with \maincolor, then restore the color.
1175 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1177 \vss
1179 \nointerlineskip
1183 \pdfcatalog{/PageMode /UseOutlines}
1185 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1186 \def\dopdfimage#1#2#3{%
1187 \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1188 \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1190 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1191 % others). Let's try in that order, PDF first since if
1192 % someone has a scalable image, presumably better to use that than a
1193 % bitmap.
1194 \let\pdfimgext=\empty
1195 \begingroup
1196 \openin 1 #1.pdf \ifeof 1
1197 \openin 1 #1.PDF \ifeof 1
1198 \openin 1 #1.png \ifeof 1
1199 \openin 1 #1.jpg \ifeof 1
1200 \openin 1 #1.jpeg \ifeof 1
1201 \openin 1 #1.JPG \ifeof 1
1202 \errhelp = \nopdfimagehelp
1203 \errmessage{Could not find image file #1 for pdf}%
1204 \else \gdef\pdfimgext{JPG}%
1206 \else \gdef\pdfimgext{jpeg}%
1208 \else \gdef\pdfimgext{jpg}%
1210 \else \gdef\pdfimgext{png}%
1212 \else \gdef\pdfimgext{PDF}%
1214 \else \gdef\pdfimgext{pdf}%
1216 \closein 1
1217 \endgroup
1219 % without \immediate, ancient pdftex seg faults when the same image is
1220 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1221 \ifnum\pdftexversion < 14
1222 \immediate\pdfimage
1223 \else
1224 \immediate\pdfximage
1226 \ifdim \wd0 >0pt width \pdfimagewidth \fi
1227 \ifdim \wd2 >0pt height \pdfimageheight \fi
1228 \ifnum\pdftexversion<13
1229 #1.\pdfimgext
1230 \else
1231 {#1.\pdfimgext}%
1233 \ifnum\pdftexversion < 14 \else
1234 \pdfrefximage \pdflastximage
1235 \fi}
1237 \def\pdfmkdest#1{{%
1238 % We have to set dummies so commands such as @code, and characters
1239 % such as \, aren't expanded when present in a section title.
1240 \indexnofonts
1241 \turnoffactive
1242 \makevalueexpandable
1243 \def\pdfdestname{#1}%
1244 \txiescapepdf\pdfdestname
1245 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1248 % used to mark target names; must be expandable.
1249 \def\pdfmkpgn#1{#1}
1251 % by default, use a color that is dark enough to print on paper as
1252 % nearly black, but still distinguishable for online viewing.
1253 \def\urlcolor{\rgbDarkRed}
1254 \def\linkcolor{\rgbDarkRed}
1255 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1257 % Adding outlines to PDF; macros for calculating structure of outlines
1258 % come from Petr Olsak
1259 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1260 \else \csname#1\endcsname \fi}
1261 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1262 \advance\tempnum by 1
1263 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1265 % #1 is the section text, which is what will be displayed in the
1266 % outline by the pdf viewer. #2 is the pdf expression for the number
1267 % of subentries (or empty, for subsubsections). #3 is the node text,
1268 % which might be empty if this toc entry had no corresponding node.
1269 % #4 is the page number
1271 \def\dopdfoutline#1#2#3#4{%
1272 % Generate a link to the node text if that exists; else, use the
1273 % page number. We could generate a destination for the section
1274 % text in the case where a section has no node, but it doesn't
1275 % seem worth the trouble, since most documents are normally structured.
1276 \edef\pdfoutlinedest{#3}%
1277 \ifx\pdfoutlinedest\empty
1278 \def\pdfoutlinedest{#4}%
1279 \else
1280 \txiescapepdf\pdfoutlinedest
1283 % Also escape PDF chars in the display string.
1284 \edef\pdfoutlinetext{#1}%
1285 \txiescapepdf\pdfoutlinetext
1287 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1290 \def\pdfmakeoutlines{%
1291 \begingroup
1292 % Read toc silently, to get counts of subentries for \pdfoutline.
1293 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1294 \def\numchapentry##1##2##3##4{%
1295 \def\thischapnum{##2}%
1296 \def\thissecnum{0}%
1297 \def\thissubsecnum{0}%
1299 \def\numsecentry##1##2##3##4{%
1300 \advancenumber{chap\thischapnum}%
1301 \def\thissecnum{##2}%
1302 \def\thissubsecnum{0}%
1304 \def\numsubsecentry##1##2##3##4{%
1305 \advancenumber{sec\thissecnum}%
1306 \def\thissubsecnum{##2}%
1308 \def\numsubsubsecentry##1##2##3##4{%
1309 \advancenumber{subsec\thissubsecnum}%
1311 \def\thischapnum{0}%
1312 \def\thissecnum{0}%
1313 \def\thissubsecnum{0}%
1315 % use \def rather than \let here because we redefine \chapentry et
1316 % al. a second time, below.
1317 \def\appentry{\numchapentry}%
1318 \def\appsecentry{\numsecentry}%
1319 \def\appsubsecentry{\numsubsecentry}%
1320 \def\appsubsubsecentry{\numsubsubsecentry}%
1321 \def\unnchapentry{\numchapentry}%
1322 \def\unnsecentry{\numsecentry}%
1323 \def\unnsubsecentry{\numsubsecentry}%
1324 \def\unnsubsubsecentry{\numsubsubsecentry}%
1325 \readdatafile{toc}%
1327 % Read toc second time, this time actually producing the outlines.
1328 % The `-' means take the \expnumber as the absolute number of
1329 % subentries, which we calculated on our first read of the .toc above.
1331 % We use the node names as the destinations.
1332 \def\numchapentry##1##2##3##4{%
1333 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1334 \def\numsecentry##1##2##3##4{%
1335 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1336 \def\numsubsecentry##1##2##3##4{%
1337 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1338 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1339 \dopdfoutline{##1}{}{##3}{##4}}%
1341 % PDF outlines are displayed using system fonts, instead of
1342 % document fonts. Therefore we cannot use special characters,
1343 % since the encoding is unknown. For example, the eogonek from
1344 % Latin 2 (0xea) gets translated to a | character. Info from
1345 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1347 % TODO this right, we have to translate 8-bit characters to
1348 % their "best" equivalent, based on the @documentencoding. Too
1349 % much work for too little return. Just use the ASCII equivalents
1350 % we use for the index sort strings.
1352 \indexnofonts
1353 \setupdatafile
1354 % We can have normal brace characters in the PDF outlines, unlike
1355 % Texinfo index files. So set that up.
1356 \def\{{\lbracecharliteral}%
1357 \def\}{\rbracecharliteral}%
1358 \catcode`\\=\active \otherbackslash
1359 \input \tocreadfilename
1360 \endgroup
1362 {\catcode`[=1 \catcode`]=2
1363 \catcode`{=\other \catcode`}=\other
1364 \gdef\lbracecharliteral[{]%
1365 \gdef\rbracecharliteral[}]%
1368 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1369 \ifx\PP\D\let\nextsp\relax
1370 \else\let\nextsp\skipspaces
1371 \addtokens{\filename}{\PP}%
1372 \advance\filenamelength by 1
1374 \nextsp}
1375 \def\getfilename#1{%
1376 \filenamelength=0
1377 % If we don't expand the argument now, \skipspaces will get
1378 % snagged on things like "@value{foo}".
1379 \edef\temp{#1}%
1380 \expandafter\skipspaces\temp|\relax
1382 \ifnum\pdftexversion < 14
1383 \let \startlink \pdfannotlink
1384 \else
1385 \let \startlink \pdfstartlink
1387 % make a live url in pdf output.
1388 \def\pdfurl#1{%
1389 \begingroup
1390 % it seems we really need yet another set of dummies; have not
1391 % tried to figure out what each command should do in the context
1392 % of @url. for now, just make @/ a no-op, that's the only one
1393 % people have actually reported a problem with.
1395 \normalturnoffactive
1396 \def\@{@}%
1397 \let\/=\empty
1398 \makevalueexpandable
1399 % do we want to go so far as to use \indexnofonts instead of just
1400 % special-casing \var here?
1401 \def\var##1{##1}%
1403 \leavevmode\setcolor{\urlcolor}%
1404 \startlink attr{/Border [0 0 0]}%
1405 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1406 \endgroup}
1407 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1408 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1409 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1410 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1411 \def\maketoks{%
1412 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1413 \ifx\first0\adn0
1414 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1415 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1416 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1417 \else
1418 \ifnum0=\countA\else\makelink\fi
1419 \ifx\first.\let\next=\done\else
1420 \let\next=\maketoks
1421 \addtokens{\toksB}{\the\toksD}
1422 \ifx\first,\addtokens{\toksB}{\space}\fi
1424 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1425 \next}
1426 \def\makelink{\addtokens{\toksB}%
1427 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1428 \def\pdflink#1{%
1429 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1430 \setcolor{\linkcolor}#1\endlink}
1431 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1432 \else
1433 % non-pdf mode
1434 \let\pdfmkdest = \gobble
1435 \let\pdfurl = \gobble
1436 \let\endlink = \relax
1437 \let\setcolor = \gobble
1438 \let\pdfsetcolor = \gobble
1439 \let\pdfmakeoutlines = \relax
1440 \fi % \ifx\pdfoutput
1443 \message{fonts,}
1445 % Change the current font style to #1, remembering it in \curfontstyle.
1446 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1447 % italics, not bold italics.
1449 \def\setfontstyle#1{%
1450 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1451 \csname ten#1\endcsname % change the current font
1454 % Select #1 fonts with the current style.
1456 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1458 \def\rm{\fam=0 \setfontstyle{rm}}
1459 \def\it{\fam=\itfam \setfontstyle{it}}
1460 \def\sl{\fam=\slfam \setfontstyle{sl}}
1461 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1462 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1464 % Unfortunately, we have to override this for titles and the like, since
1465 % in those cases "rm" is bold. Sigh.
1466 \def\rmisbold{\rm\def\curfontstyle{bf}}
1468 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1469 % So we set up a \sf.
1470 \newfam\sffam
1471 \def\sf{\fam=\sffam \setfontstyle{sf}}
1472 \let\li = \sf % Sometimes we call it \li, not \sf.
1474 % We don't need math for this font style.
1475 \def\ttsl{\setfontstyle{ttsl}}
1478 % Set the baselineskip to #1, and the lineskip and strut size
1479 % correspondingly. There is no deep meaning behind these magic numbers
1480 % used as factors; they just match (closely enough) what Knuth defined.
1482 \def\lineskipfactor{.08333}
1483 \def\strutheightpercent{.70833}
1484 \def\strutdepthpercent {.29167}
1486 % can get a sort of poor man's double spacing by redefining this.
1487 \def\baselinefactor{1}
1489 \newdimen\textleading
1490 \def\setleading#1{%
1491 \dimen0 = #1\relax
1492 \normalbaselineskip = \baselinefactor\dimen0
1493 \normallineskip = \lineskipfactor\normalbaselineskip
1494 \normalbaselines
1495 \setbox\strutbox =\hbox{%
1496 \vrule width0pt height\strutheightpercent\baselineskip
1497 depth \strutdepthpercent \baselineskip
1501 % PDF CMaps. See also LaTeX's t1.cmap.
1503 % do nothing with this by default.
1504 \expandafter\let\csname cmapOT1\endcsname\gobble
1505 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1506 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1508 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1509 % (\pdffontattr was introduced many years ago, but people still run
1510 % older pdftex's; it's easy to conditionalize, so we do.)
1511 \ifpdf \ifx\pdffontattr\thisisundefined \else
1512 \begingroup
1513 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1514 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1515 %%DocumentNeededResources: ProcSet (CIDInit)
1516 %%IncludeResource: ProcSet (CIDInit)
1517 %%BeginResource: CMap (TeX-OT1-0)
1518 %%Title: (TeX-OT1-0 TeX OT1 0)
1519 %%Version: 1.000
1520 %%EndComments
1521 /CIDInit /ProcSet findresource begin
1522 12 dict begin
1523 begincmap
1524 /CIDSystemInfo
1525 << /Registry (TeX)
1526 /Ordering (OT1)
1527 /Supplement 0
1528 >> def
1529 /CMapName /TeX-OT1-0 def
1530 /CMapType 2 def
1531 1 begincodespacerange
1532 <00> <7F>
1533 endcodespacerange
1534 8 beginbfrange
1535 <00> <01> <0393>
1536 <09> <0A> <03A8>
1537 <23> <26> <0023>
1538 <28> <3B> <0028>
1539 <3F> <5B> <003F>
1540 <5D> <5E> <005D>
1541 <61> <7A> <0061>
1542 <7B> <7C> <2013>
1543 endbfrange
1544 40 beginbfchar
1545 <02> <0398>
1546 <03> <039B>
1547 <04> <039E>
1548 <05> <03A0>
1549 <06> <03A3>
1550 <07> <03D2>
1551 <08> <03A6>
1552 <0B> <00660066>
1553 <0C> <00660069>
1554 <0D> <0066006C>
1555 <0E> <006600660069>
1556 <0F> <00660066006C>
1557 <10> <0131>
1558 <11> <0237>
1559 <12> <0060>
1560 <13> <00B4>
1561 <14> <02C7>
1562 <15> <02D8>
1563 <16> <00AF>
1564 <17> <02DA>
1565 <18> <00B8>
1566 <19> <00DF>
1567 <1A> <00E6>
1568 <1B> <0153>
1569 <1C> <00F8>
1570 <1D> <00C6>
1571 <1E> <0152>
1572 <1F> <00D8>
1573 <21> <0021>
1574 <22> <201D>
1575 <27> <2019>
1576 <3C> <00A1>
1577 <3D> <003D>
1578 <3E> <00BF>
1579 <5C> <201C>
1580 <5F> <02D9>
1581 <60> <2018>
1582 <7D> <02DD>
1583 <7E> <007E>
1584 <7F> <00A8>
1585 endbfchar
1586 endcmap
1587 CMapName currentdict /CMap defineresource pop
1590 %%EndResource
1591 %%EOF
1592 }\endgroup
1593 \expandafter\edef\csname cmapOT1\endcsname#1{%
1594 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1597 % \cmapOT1IT
1598 \begingroup
1599 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1600 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1601 %%DocumentNeededResources: ProcSet (CIDInit)
1602 %%IncludeResource: ProcSet (CIDInit)
1603 %%BeginResource: CMap (TeX-OT1IT-0)
1604 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1605 %%Version: 1.000
1606 %%EndComments
1607 /CIDInit /ProcSet findresource begin
1608 12 dict begin
1609 begincmap
1610 /CIDSystemInfo
1611 << /Registry (TeX)
1612 /Ordering (OT1IT)
1613 /Supplement 0
1614 >> def
1615 /CMapName /TeX-OT1IT-0 def
1616 /CMapType 2 def
1617 1 begincodespacerange
1618 <00> <7F>
1619 endcodespacerange
1620 8 beginbfrange
1621 <00> <01> <0393>
1622 <09> <0A> <03A8>
1623 <25> <26> <0025>
1624 <28> <3B> <0028>
1625 <3F> <5B> <003F>
1626 <5D> <5E> <005D>
1627 <61> <7A> <0061>
1628 <7B> <7C> <2013>
1629 endbfrange
1630 42 beginbfchar
1631 <02> <0398>
1632 <03> <039B>
1633 <04> <039E>
1634 <05> <03A0>
1635 <06> <03A3>
1636 <07> <03D2>
1637 <08> <03A6>
1638 <0B> <00660066>
1639 <0C> <00660069>
1640 <0D> <0066006C>
1641 <0E> <006600660069>
1642 <0F> <00660066006C>
1643 <10> <0131>
1644 <11> <0237>
1645 <12> <0060>
1646 <13> <00B4>
1647 <14> <02C7>
1648 <15> <02D8>
1649 <16> <00AF>
1650 <17> <02DA>
1651 <18> <00B8>
1652 <19> <00DF>
1653 <1A> <00E6>
1654 <1B> <0153>
1655 <1C> <00F8>
1656 <1D> <00C6>
1657 <1E> <0152>
1658 <1F> <00D8>
1659 <21> <0021>
1660 <22> <201D>
1661 <23> <0023>
1662 <24> <00A3>
1663 <27> <2019>
1664 <3C> <00A1>
1665 <3D> <003D>
1666 <3E> <00BF>
1667 <5C> <201C>
1668 <5F> <02D9>
1669 <60> <2018>
1670 <7D> <02DD>
1671 <7E> <007E>
1672 <7F> <00A8>
1673 endbfchar
1674 endcmap
1675 CMapName currentdict /CMap defineresource pop
1678 %%EndResource
1679 %%EOF
1680 }\endgroup
1681 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1682 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1685 % \cmapOT1TT
1686 \begingroup
1687 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1688 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1689 %%DocumentNeededResources: ProcSet (CIDInit)
1690 %%IncludeResource: ProcSet (CIDInit)
1691 %%BeginResource: CMap (TeX-OT1TT-0)
1692 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1693 %%Version: 1.000
1694 %%EndComments
1695 /CIDInit /ProcSet findresource begin
1696 12 dict begin
1697 begincmap
1698 /CIDSystemInfo
1699 << /Registry (TeX)
1700 /Ordering (OT1TT)
1701 /Supplement 0
1702 >> def
1703 /CMapName /TeX-OT1TT-0 def
1704 /CMapType 2 def
1705 1 begincodespacerange
1706 <00> <7F>
1707 endcodespacerange
1708 5 beginbfrange
1709 <00> <01> <0393>
1710 <09> <0A> <03A8>
1711 <21> <26> <0021>
1712 <28> <5F> <0028>
1713 <61> <7E> <0061>
1714 endbfrange
1715 32 beginbfchar
1716 <02> <0398>
1717 <03> <039B>
1718 <04> <039E>
1719 <05> <03A0>
1720 <06> <03A3>
1721 <07> <03D2>
1722 <08> <03A6>
1723 <0B> <2191>
1724 <0C> <2193>
1725 <0D> <0027>
1726 <0E> <00A1>
1727 <0F> <00BF>
1728 <10> <0131>
1729 <11> <0237>
1730 <12> <0060>
1731 <13> <00B4>
1732 <14> <02C7>
1733 <15> <02D8>
1734 <16> <00AF>
1735 <17> <02DA>
1736 <18> <00B8>
1737 <19> <00DF>
1738 <1A> <00E6>
1739 <1B> <0153>
1740 <1C> <00F8>
1741 <1D> <00C6>
1742 <1E> <0152>
1743 <1F> <00D8>
1744 <20> <2423>
1745 <27> <2019>
1746 <60> <2018>
1747 <7F> <00A8>
1748 endbfchar
1749 endcmap
1750 CMapName currentdict /CMap defineresource pop
1753 %%EndResource
1754 %%EOF
1755 }\endgroup
1756 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1757 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1759 \fi\fi
1762 % Set the font macro #1 to the font named \fontprefix#2.
1763 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1764 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
1765 % Example:
1766 % #1 = \textrm
1767 % #2 = \rmshape
1768 % #3 = 10
1769 % #4 = \mainmagstep
1770 % #5 = OT1
1772 \def\setfont#1#2#3#4#5{%
1773 \font#1=\fontprefix#2#3 scaled #4
1774 \csname cmap#5\endcsname#1%
1776 % This is what gets called when #5 of \setfont is empty.
1777 \let\cmap\gobble
1779 % (end of cmaps)
1781 % Use cm as the default font prefix.
1782 % To specify the font prefix, you must define \fontprefix
1783 % before you read in texinfo.tex.
1784 \ifx\fontprefix\thisisundefined
1785 \def\fontprefix{cm}
1787 % Support font families that don't use the same naming scheme as CM.
1788 \def\rmshape{r}
1789 \def\rmbshape{bx} % where the normal face is bold
1790 \def\bfshape{b}
1791 \def\bxshape{bx}
1792 \def\ttshape{tt}
1793 \def\ttbshape{tt}
1794 \def\ttslshape{sltt}
1795 \def\itshape{ti}
1796 \def\itbshape{bxti}
1797 \def\slshape{sl}
1798 \def\slbshape{bxsl}
1799 \def\sfshape{ss}
1800 \def\sfbshape{ss}
1801 \def\scshape{csc}
1802 \def\scbshape{csc}
1804 % Definitions for a main text size of 11pt. (The default in Texinfo.)
1806 \def\definetextfontsizexi{%
1807 % Text fonts (11.2pt, magstep1).
1808 \def\textnominalsize{11pt}
1809 \edef\mainmagstep{\magstephalf}
1810 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1811 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1812 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1813 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1814 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1815 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1816 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1817 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1818 \font\texti=cmmi10 scaled \mainmagstep
1819 \font\textsy=cmsy10 scaled \mainmagstep
1820 \def\textecsize{1095}
1822 % A few fonts for @defun names and args.
1823 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1824 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1825 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1826 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1828 % Fonts for indices, footnotes, small examples (9pt).
1829 \def\smallnominalsize{9pt}
1830 \setfont\smallrm\rmshape{9}{1000}{OT1}
1831 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1832 \setfont\smallbf\bfshape{10}{900}{OT1}
1833 \setfont\smallit\itshape{9}{1000}{OT1IT}
1834 \setfont\smallsl\slshape{9}{1000}{OT1}
1835 \setfont\smallsf\sfshape{9}{1000}{OT1}
1836 \setfont\smallsc\scshape{10}{900}{OT1}
1837 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1838 \font\smalli=cmmi9
1839 \font\smallsy=cmsy9
1840 \def\smallecsize{0900}
1842 % Fonts for small examples (8pt).
1843 \def\smallernominalsize{8pt}
1844 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1845 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1846 \setfont\smallerbf\bfshape{10}{800}{OT1}
1847 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1848 \setfont\smallersl\slshape{8}{1000}{OT1}
1849 \setfont\smallersf\sfshape{8}{1000}{OT1}
1850 \setfont\smallersc\scshape{10}{800}{OT1}
1851 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1852 \font\smalleri=cmmi8
1853 \font\smallersy=cmsy8
1854 \def\smallerecsize{0800}
1856 % Fonts for title page (20.4pt):
1857 \def\titlenominalsize{20pt}
1858 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1859 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1860 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1861 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1862 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1863 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1864 \let\titlebf=\titlerm
1865 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1866 \font\titlei=cmmi12 scaled \magstep3
1867 \font\titlesy=cmsy10 scaled \magstep4
1868 \def\titleecsize{2074}
1870 % Chapter (and unnumbered) fonts (17.28pt).
1871 \def\chapnominalsize{17pt}
1872 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1873 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1874 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1875 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1876 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1877 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1878 \let\chapbf=\chaprm
1879 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1880 \font\chapi=cmmi12 scaled \magstep2
1881 \font\chapsy=cmsy10 scaled \magstep3
1882 \def\chapecsize{1728}
1884 % Section fonts (14.4pt).
1885 \def\secnominalsize{14pt}
1886 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1887 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1888 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1889 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1890 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1891 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1892 \let\secbf\secrm
1893 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1894 \font\seci=cmmi12 scaled \magstep1
1895 \font\secsy=cmsy10 scaled \magstep2
1896 \def\sececsize{1440}
1898 % Subsection fonts (13.15pt).
1899 \def\ssecnominalsize{13pt}
1900 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1901 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1902 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1903 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1904 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1905 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1906 \let\ssecbf\ssecrm
1907 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1908 \font\sseci=cmmi12 scaled \magstephalf
1909 \font\ssecsy=cmsy10 scaled 1315
1910 \def\ssececsize{1200}
1912 % Reduced fonts for @acro in text (10pt).
1913 \def\reducednominalsize{10pt}
1914 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1915 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1916 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1917 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1918 \setfont\reducedsl\slshape{10}{1000}{OT1}
1919 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1920 \setfont\reducedsc\scshape{10}{1000}{OT1}
1921 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1922 \font\reducedi=cmmi10
1923 \font\reducedsy=cmsy10
1924 \def\reducedecsize{1000}
1926 \textleading = 13.2pt % line spacing for 11pt CM
1927 \textfonts % reset the current fonts
1929 } % end of 11pt text font size definitions, \definetextfontsizexi
1932 % Definitions to make the main text be 10pt Computer Modern, with
1933 % section, chapter, etc., sizes following suit. This is for the GNU
1934 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1935 % future. Used with @smallbook, which sets the leading to 12pt.
1937 \def\definetextfontsizex{%
1938 % Text fonts (10pt).
1939 \def\textnominalsize{10pt}
1940 \edef\mainmagstep{1000}
1941 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1942 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1943 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1944 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1945 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1946 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1947 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1948 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1949 \font\texti=cmmi10 scaled \mainmagstep
1950 \font\textsy=cmsy10 scaled \mainmagstep
1951 \def\textecsize{1000}
1953 % A few fonts for @defun names and args.
1954 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
1955 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
1956 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
1957 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1959 % Fonts for indices, footnotes, small examples (9pt).
1960 \def\smallnominalsize{9pt}
1961 \setfont\smallrm\rmshape{9}{1000}{OT1}
1962 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1963 \setfont\smallbf\bfshape{10}{900}{OT1}
1964 \setfont\smallit\itshape{9}{1000}{OT1IT}
1965 \setfont\smallsl\slshape{9}{1000}{OT1}
1966 \setfont\smallsf\sfshape{9}{1000}{OT1}
1967 \setfont\smallsc\scshape{10}{900}{OT1}
1968 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1969 \font\smalli=cmmi9
1970 \font\smallsy=cmsy9
1971 \def\smallecsize{0900}
1973 % Fonts for small examples (8pt).
1974 \def\smallernominalsize{8pt}
1975 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1976 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1977 \setfont\smallerbf\bfshape{10}{800}{OT1}
1978 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1979 \setfont\smallersl\slshape{8}{1000}{OT1}
1980 \setfont\smallersf\sfshape{8}{1000}{OT1}
1981 \setfont\smallersc\scshape{10}{800}{OT1}
1982 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1983 \font\smalleri=cmmi8
1984 \font\smallersy=cmsy8
1985 \def\smallerecsize{0800}
1987 % Fonts for title page (20.4pt):
1988 \def\titlenominalsize{20pt}
1989 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1990 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1991 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1992 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1993 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1994 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1995 \let\titlebf=\titlerm
1996 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1997 \font\titlei=cmmi12 scaled \magstep3
1998 \font\titlesy=cmsy10 scaled \magstep4
1999 \def\titleecsize{2074}
2001 % Chapter fonts (14.4pt).
2002 \def\chapnominalsize{14pt}
2003 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2004 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2005 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2006 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2007 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2008 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2009 \let\chapbf\chaprm
2010 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2011 \font\chapi=cmmi12 scaled \magstep1
2012 \font\chapsy=cmsy10 scaled \magstep2
2013 \def\chapecsize{1440}
2015 % Section fonts (12pt).
2016 \def\secnominalsize{12pt}
2017 \setfont\secrm\rmbshape{12}{1000}{OT1}
2018 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2019 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2020 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2021 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2022 \setfont\secsf\sfbshape{12}{1000}{OT1}
2023 \let\secbf\secrm
2024 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2025 \font\seci=cmmi12
2026 \font\secsy=cmsy10 scaled \magstep1
2027 \def\sececsize{1200}
2029 % Subsection fonts (10pt).
2030 \def\ssecnominalsize{10pt}
2031 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2032 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2033 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2034 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2035 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2036 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2037 \let\ssecbf\ssecrm
2038 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2039 \font\sseci=cmmi10
2040 \font\ssecsy=cmsy10
2041 \def\ssececsize{1000}
2043 % Reduced fonts for @acro in text (9pt).
2044 \def\reducednominalsize{9pt}
2045 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2046 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2047 \setfont\reducedbf\bfshape{10}{900}{OT1}
2048 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2049 \setfont\reducedsl\slshape{9}{1000}{OT1}
2050 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2051 \setfont\reducedsc\scshape{10}{900}{OT1}
2052 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2053 \font\reducedi=cmmi9
2054 \font\reducedsy=cmsy9
2055 \def\reducedecsize{0900}
2057 \divide\parskip by 2 % reduce space between paragraphs
2058 \textleading = 12pt % line spacing for 10pt CM
2059 \textfonts % reset the current fonts
2061 } % end of 10pt text font size definitions, \definetextfontsizex
2064 % We provide the user-level command
2065 % @fonttextsize 10
2066 % (or 11) to redefine the text font size. pt is assumed.
2068 \def\xiword{11}
2069 \def\xword{10}
2070 \def\xwordpt{10pt}
2072 \parseargdef\fonttextsize{%
2073 \def\textsizearg{#1}%
2074 %\wlog{doing @fonttextsize \textsizearg}%
2076 % Set \globaldefs so that documents can use this inside @tex, since
2077 % makeinfo 4.8 does not support it, but we need it nonetheless.
2079 \begingroup \globaldefs=1
2080 \ifx\textsizearg\xword \definetextfontsizex
2081 \else \ifx\textsizearg\xiword \definetextfontsizexi
2082 \else
2083 \errhelp=\EMsimple
2084 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2085 \fi\fi
2086 \endgroup
2090 % In order for the font changes to affect most math symbols and letters,
2091 % we have to define the \textfont of the standard families. Since
2092 % texinfo doesn't allow for producing subscripts and superscripts except
2093 % in the main text, we don't bother to reset \scriptfont and
2094 % \scriptscriptfont (which would also require loading a lot more fonts).
2096 \def\resetmathfonts{%
2097 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2098 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2099 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2102 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2103 % of just \STYLE. We do this because \STYLE needs to also set the
2104 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2105 % \tenSTYLE to set the current font.
2107 % Each font-changing command also sets the names \lsize (one size lower)
2108 % and \lllsize (three sizes lower). These relative commands are used in
2109 % the LaTeX logo and acronyms.
2111 % This all needs generalizing, badly.
2113 \def\textfonts{%
2114 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2115 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2116 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2117 \let\tenttsl=\textttsl
2118 \def\curfontsize{text}%
2119 \def\lsize{reduced}\def\lllsize{smaller}%
2120 \resetmathfonts \setleading{\textleading}}
2121 \def\titlefonts{%
2122 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2123 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2124 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2125 \let\tenttsl=\titlettsl
2126 \def\curfontsize{title}%
2127 \def\lsize{chap}\def\lllsize{subsec}%
2128 \resetmathfonts \setleading{27pt}}
2129 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2130 \def\chapfonts{%
2131 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2132 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2133 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2134 \let\tenttsl=\chapttsl
2135 \def\curfontsize{chap}%
2136 \def\lsize{sec}\def\lllsize{text}%
2137 \resetmathfonts \setleading{19pt}}
2138 \def\secfonts{%
2139 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2140 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2141 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2142 \let\tenttsl=\secttsl
2143 \def\curfontsize{sec}%
2144 \def\lsize{subsec}\def\lllsize{reduced}%
2145 \resetmathfonts \setleading{16pt}}
2146 \def\subsecfonts{%
2147 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2148 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2149 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2150 \let\tenttsl=\ssecttsl
2151 \def\curfontsize{ssec}%
2152 \def\lsize{text}\def\lllsize{small}%
2153 \resetmathfonts \setleading{15pt}}
2154 \let\subsubsecfonts = \subsecfonts
2155 \def\reducedfonts{%
2156 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2157 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2158 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2159 \let\tenttsl=\reducedttsl
2160 \def\curfontsize{reduced}%
2161 \def\lsize{small}\def\lllsize{smaller}%
2162 \resetmathfonts \setleading{10.5pt}}
2163 \def\smallfonts{%
2164 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2165 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2166 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2167 \let\tenttsl=\smallttsl
2168 \def\curfontsize{small}%
2169 \def\lsize{smaller}\def\lllsize{smaller}%
2170 \resetmathfonts \setleading{10.5pt}}
2171 \def\smallerfonts{%
2172 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2173 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2174 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2175 \let\tenttsl=\smallerttsl
2176 \def\curfontsize{smaller}%
2177 \def\lsize{smaller}\def\lllsize{smaller}%
2178 \resetmathfonts \setleading{9.5pt}}
2180 % Fonts for short table of contents.
2181 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2182 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2183 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2184 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2186 % Define these just so they can be easily changed for other fonts.
2187 \def\angleleft{$\langle$}
2188 \def\angleright{$\rangle$}
2190 % Set the fonts to use with the @small... environments.
2191 \let\smallexamplefonts = \smallfonts
2193 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2194 % can fit this many characters:
2195 % 8.5x11=86 smallbook=72 a4=90 a5=69
2196 % If we use \scriptfonts (8pt), then we can fit this many characters:
2197 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2198 % For me, subjectively, the few extra characters that fit aren't worth
2199 % the additional smallness of 8pt. So I'm making the default 9pt.
2201 % By the way, for comparison, here's what fits with @example (10pt):
2202 % 8.5x11=71 smallbook=60 a4=75 a5=58
2203 % --karl, 24jan03.
2205 % Set up the default fonts, so we can use them for creating boxes.
2207 \definetextfontsizexi
2210 \message{markup,}
2212 % Check if we are currently using a typewriter font. Since all the
2213 % Computer Modern typewriter fonts have zero interword stretch (and
2214 % shrink), and it is reasonable to expect all typewriter fonts to have
2215 % this property, we can check that font parameter.
2217 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2219 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2220 % define and register \INITMACRO to be called on markup style changes.
2221 % \INITMACRO can check \currentmarkupstyle for the innermost
2222 % style and the set of \ifmarkupSTYLE switches for all styles
2223 % currently in effect.
2224 \newif\ifmarkupvar
2225 \newif\ifmarkupsamp
2226 \newif\ifmarkupkey
2227 %\newif\ifmarkupfile % @file == @samp.
2228 %\newif\ifmarkupoption % @option == @samp.
2229 \newif\ifmarkupcode
2230 \newif\ifmarkupkbd
2231 %\newif\ifmarkupenv % @env == @code.
2232 %\newif\ifmarkupcommand % @command == @code.
2233 \newif\ifmarkuptex % @tex (and part of @math, for now).
2234 \newif\ifmarkupexample
2235 \newif\ifmarkupverb
2236 \newif\ifmarkupverbatim
2238 \let\currentmarkupstyle\empty
2240 \def\setupmarkupstyle#1{%
2241 \csname markup#1true\endcsname
2242 \def\currentmarkupstyle{#1}%
2243 \markupstylesetup
2246 \let\markupstylesetup\empty
2248 \def\defmarkupstylesetup#1{%
2249 \expandafter\def\expandafter\markupstylesetup
2250 \expandafter{\markupstylesetup #1}%
2251 \def#1%
2254 % Markup style setup for left and right quotes.
2255 \defmarkupstylesetup\markupsetuplq{%
2256 \expandafter\let\expandafter \temp
2257 \csname markupsetuplq\currentmarkupstyle\endcsname
2258 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2261 \defmarkupstylesetup\markupsetuprq{%
2262 \expandafter\let\expandafter \temp
2263 \csname markupsetuprq\currentmarkupstyle\endcsname
2264 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2268 \catcode`\'=\active
2269 \catcode`\`=\active
2271 \gdef\markupsetuplqdefault{\let`\lq}
2272 \gdef\markupsetuprqdefault{\let'\rq}
2274 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2275 \gdef\markupsetcodequoteright{\let'\codequoteright}
2278 \let\markupsetuplqcode \markupsetcodequoteleft
2279 \let\markupsetuprqcode \markupsetcodequoteright
2281 \let\markupsetuplqexample \markupsetcodequoteleft
2282 \let\markupsetuprqexample \markupsetcodequoteright
2284 \let\markupsetuplqkbd \markupsetcodequoteleft
2285 \let\markupsetuprqkbd \markupsetcodequoteright
2287 \let\markupsetuplqsamp \markupsetcodequoteleft
2288 \let\markupsetuprqsamp \markupsetcodequoteright
2290 \let\markupsetuplqverb \markupsetcodequoteleft
2291 \let\markupsetuprqverb \markupsetcodequoteright
2293 \let\markupsetuplqverbatim \markupsetcodequoteleft
2294 \let\markupsetuprqverbatim \markupsetcodequoteright
2296 % Allow an option to not use regular directed right quote/apostrophe
2297 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2298 % The undirected quote is ugly, so don't make it the default, but it
2299 % works for pasting with more pdf viewers (at least evince), the
2300 % lilypond developers report. xpdf does work with the regular 0x27.
2302 \def\codequoteright{%
2303 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2304 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2306 \else \char'15 \fi
2307 \else \char'15 \fi
2310 % and a similar option for the left quote char vs. a grave accent.
2311 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2312 % the code environments to do likewise.
2314 \def\codequoteleft{%
2315 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2316 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2317 % [Knuth] pp. 380,381,391
2318 % \relax disables Spanish ligatures ?` and !` of \tt font.
2319 \relax`%
2320 \else \char'22 \fi
2321 \else \char'22 \fi
2324 % Commands to set the quote options.
2326 \parseargdef\codequoteundirected{%
2327 \def\temp{#1}%
2328 \ifx\temp\onword
2329 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2330 = t%
2331 \else\ifx\temp\offword
2332 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2333 = \relax
2334 \else
2335 \errhelp = \EMsimple
2336 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2337 \fi\fi
2340 \parseargdef\codequotebacktick{%
2341 \def\temp{#1}%
2342 \ifx\temp\onword
2343 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2344 = t%
2345 \else\ifx\temp\offword
2346 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2347 = \relax
2348 \else
2349 \errhelp = \EMsimple
2350 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2351 \fi\fi
2354 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2355 \def\noligaturesquoteleft{\relax\lq}
2357 % Count depth in font-changes, for error checks
2358 \newcount\fontdepth \fontdepth=0
2360 % Font commands.
2362 % #1 is the font command (\sl or \it), #2 is the text to slant.
2363 % If we are in a monospaced environment, however, 1) always use \ttsl,
2364 % and 2) do not add an italic correction.
2365 \def\dosmartslant#1#2{%
2366 \ifusingtt
2367 {{\ttsl #2}\let\next=\relax}%
2368 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2369 \next
2371 \def\smartslanted{\dosmartslant\sl}
2372 \def\smartitalic{\dosmartslant\it}
2374 % Output an italic correction unless \next (presumed to be the following
2375 % character) is such as not to need one.
2376 \def\smartitaliccorrection{%
2377 \ifx\next,%
2378 \else\ifx\next-%
2379 \else\ifx\next.%
2380 \else\ptexslash
2381 \fi\fi\fi
2382 \aftersmartic
2385 % Unconditional use \ttsl, and no ic. @var is set to this for defuns.
2386 \def\ttslanted#1{{\ttsl #1}}
2388 % @cite is like \smartslanted except unconditionally use \sl. We never want
2389 % ttsl for book titles, do we?
2390 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2392 \def\aftersmartic{}
2393 \def\var#1{%
2394 \let\saveaftersmartic = \aftersmartic
2395 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2396 \smartslanted{#1}%
2399 \let\i=\smartitalic
2400 \let\slanted=\smartslanted
2401 \let\dfn=\smartslanted
2402 \let\emph=\smartitalic
2404 % Explicit font changes: @r, @sc, undocumented @ii.
2405 \def\r#1{{\rm #1}} % roman font
2406 \def\sc#1{{\smallcaps#1}} % smallcaps font
2407 \def\ii#1{{\it #1}} % italic font
2409 % @b, explicit bold. Also @strong.
2410 \def\b#1{{\bf #1}}
2411 \let\strong=\b
2413 % @sansserif, explicit sans.
2414 \def\sansserif#1{{\sf #1}}
2416 % We can't just use \exhyphenpenalty, because that only has effect at
2417 % the end of a paragraph. Restore normal hyphenation at the end of the
2418 % group within which \nohyphenation is presumably called.
2420 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2421 \def\restorehyphenation{\hyphenchar\font = `- }
2423 % Set sfcode to normal for the chars that usually have another value.
2424 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2425 % sometimes \x has an active definition that messes things up.
2427 \catcode`@=11
2428 \def\plainfrenchspacing{%
2429 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2430 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2431 \def\endofsentencespacefactor{1000}% for @. and friends
2433 \def\plainnonfrenchspacing{%
2434 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2435 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2436 \def\endofsentencespacefactor{3000}% for @. and friends
2438 \catcode`@=\other
2439 \def\endofsentencespacefactor{3000}% default
2441 % @t, explicit typewriter.
2442 \def\t#1{%
2443 {\tt \rawbackslash \plainfrenchspacing #1}%
2444 \null
2447 % @samp.
2448 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2450 % @indicateurl is \samp, that is, with quotes.
2451 \let\indicateurl=\samp
2453 % @code (and similar) prints in typewriter, but with spaces the same
2454 % size as normal in the surrounding text, without hyphenation, etc.
2455 % This is a subroutine for that.
2456 \def\tclose#1{%
2458 % Change normal interword space to be same as for the current font.
2459 \spaceskip = \fontdimen2\font
2461 % Switch to typewriter.
2464 % But `\ ' produces the large typewriter interword space.
2465 \def\ {{\spaceskip = 0pt{} }}%
2467 % Turn off hyphenation.
2468 \nohyphenation
2470 \rawbackslash
2471 \plainfrenchspacing
2474 \null % reset spacefactor to 1000
2477 % We *must* turn on hyphenation at `-' and `_' in @code.
2478 % (But see \codedashfinish below.)
2479 % Otherwise, it is too hard to avoid overfull hboxes
2480 % in the Emacs manual, the Library manual, etc.
2482 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2483 % both hyphenation at - and hyphenation within words.
2484 % We must therefore turn them both off (\tclose does that)
2485 % and arrange explicitly to hyphenate at a dash. -- rms.
2487 \catcode`\-=\active \catcode`\_=\active
2488 \catcode`\'=\active \catcode`\`=\active
2489 \global\let'=\rq \global\let`=\lq % default definitions
2491 \global\def\code{\begingroup
2492 \setupmarkupstyle{code}%
2493 % The following should really be moved into \setupmarkupstyle handlers.
2494 \catcode\dashChar=\active \catcode\underChar=\active
2495 \ifallowcodebreaks
2496 \let-\codedash
2497 \let_\codeunder
2498 \else
2499 \let-\normaldash
2500 \let_\realunder
2502 % Given -foo (with a single dash), we do not want to allow a break
2503 % after the hyphen.
2504 \global\let\codedashprev=\codedash
2506 \codex
2509 \gdef\codedash{\futurelet\next\codedashfinish}
2510 \gdef\codedashfinish{%
2511 \normaldash % always output the dash character itself.
2513 % Now, output a discretionary to allow a line break, unless
2514 % (a) the next character is a -, or
2515 % (b) the preceding character is a -.
2516 % E.g., given --posix, we do not want to allow a break after either -.
2517 % Given --foo-bar, we do want to allow a break between the - and the b.
2518 \ifx\next\codedash \else
2519 \ifx\codedashprev\codedash
2520 \else \discretionary{}{}{}\fi
2522 \global\let\codedashprev=\next
2525 \def\normaldash{-}
2527 \def\codex #1{\tclose{#1}\endgroup}
2529 \def\codeunder{%
2530 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2531 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2532 % will therefore expand the active definition of _, which is us
2533 % (inside @code that is), therefore an endless loop.
2534 \ifusingtt{\ifmmode
2535 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2536 \else\normalunderscore \fi
2537 \discretionary{}{}{}}%
2538 {\_}%
2541 % An additional complication: the above will allow breaks after, e.g.,
2542 % each of the four underscores in __typeof__. This is bad.
2543 % @allowcodebreaks provides a document-level way to turn breaking at -
2544 % and _ on and off.
2546 \newif\ifallowcodebreaks \allowcodebreakstrue
2548 \def\keywordtrue{true}
2549 \def\keywordfalse{false}
2551 \parseargdef\allowcodebreaks{%
2552 \def\txiarg{#1}%
2553 \ifx\txiarg\keywordtrue
2554 \allowcodebreakstrue
2555 \else\ifx\txiarg\keywordfalse
2556 \allowcodebreaksfalse
2557 \else
2558 \errhelp = \EMsimple
2559 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2560 \fi\fi
2563 % For @command, @env, @file, @option quotes seem unnecessary,
2564 % so use \code rather than \samp.
2565 \let\command=\code
2566 \let\env=\code
2567 \let\file=\code
2568 \let\option=\code
2570 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2571 % second argument specifying the text to display and an optional third
2572 % arg as text to display instead of (rather than in addition to) the url
2573 % itself. First (mandatory) arg is the url.
2574 % (This \urefnobreak definition isn't used now, leaving it for a while
2575 % for comparison.)
2576 \def\urefnobreak#1{\dourefnobreak #1,,,\finish}
2577 \def\dourefnobreak#1,#2,#3,#4\finish{\begingroup
2578 \unsepspaces
2579 \pdfurl{#1}%
2580 \setbox0 = \hbox{\ignorespaces #3}%
2581 \ifdim\wd0 > 0pt
2582 \unhbox0 % third arg given, show only that
2583 \else
2584 \setbox0 = \hbox{\ignorespaces #2}%
2585 \ifdim\wd0 > 0pt
2586 \ifpdf
2587 \unhbox0 % PDF: 2nd arg given, show only it
2588 \else
2589 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2591 \else
2592 \code{#1}% only url given, so show it
2595 \endlink
2596 \endgroup}
2598 % This \urefbreak definition is the active one.
2599 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2600 \let\uref=\urefbreak
2601 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
2602 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
2603 \unsepspaces
2604 \pdfurl{#1}%
2605 \setbox0 = \hbox{\ignorespaces #3}%
2606 \ifdim\wd0 > 0pt
2607 \unhbox0 % third arg given, show only that
2608 \else
2609 \setbox0 = \hbox{\ignorespaces #2}%
2610 \ifdim\wd0 > 0pt
2611 \ifpdf
2612 \unhbox0 % PDF: 2nd arg given, show only it
2613 \else
2614 \unhbox0\ (\urefcode{#1})% DVI: 2nd arg given, show both it and url
2616 \else
2617 \urefcode{#1}% only url given, so show it
2620 \endlink
2621 \endgroup}
2623 % Allow line breaks around only a few characters (only).
2624 \def\urefcatcodes{%
2625 \catcode\ampChar=\active \catcode\dotChar=\active
2626 \catcode\hashChar=\active \catcode\questChar=\active
2627 \catcode\slashChar=\active
2630 \urefcatcodes
2632 \global\def\urefcode{\begingroup
2633 \setupmarkupstyle{code}%
2634 \urefcatcodes
2635 \let&\urefcodeamp
2636 \let.\urefcodedot
2637 \let#\urefcodehash
2638 \let?\urefcodequest
2639 \let/\urefcodeslash
2640 \codex
2643 % By default, they are just regular characters.
2644 \global\def&{\normalamp}
2645 \global\def.{\normaldot}
2646 \global\def#{\normalhash}
2647 \global\def?{\normalquest}
2648 \global\def/{\normalslash}
2651 % we put a little stretch before and after the breakable chars, to help
2652 % line breaking of long url's. The unequal skips make look better in
2653 % cmtt at least, especially for dots.
2654 \def\urefprestretch{\urefprebreak \hskip0pt plus.13em }
2655 \def\urefpoststretch{\urefpostbreak \hskip0pt plus.1em }
2657 \def\urefcodeamp{\urefprestretch \&\urefpoststretch}
2658 \def\urefcodedot{\urefprestretch .\urefpoststretch}
2659 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
2660 \def\urefcodequest{\urefprestretch ?\urefpoststretch}
2661 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2663 \catcode`\/=\active
2664 \global\def\urefcodeslashfinish{%
2665 \urefprestretch \slashChar
2666 % Allow line break only after the final / in a sequence of
2667 % slashes, to avoid line break between the slashes in http://.
2668 \ifx\next/\else \urefpoststretch \fi
2672 % One more complication: by default we'll break after the special
2673 % characters, but some people like to break before the special chars, so
2674 % allow that. Also allow no breaking at all, for manual control.
2676 \parseargdef\urefbreakstyle{%
2677 \def\txiarg{#1}%
2678 \ifx\txiarg\wordnone
2679 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2680 \else\ifx\txiarg\wordbefore
2681 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2682 \else\ifx\txiarg\wordafter
2683 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2684 \else
2685 \errhelp = \EMsimple
2686 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
2687 \fi\fi\fi
2689 \def\wordafter{after}
2690 \def\wordbefore{before}
2691 \def\wordnone{none}
2693 \urefbreakstyle after
2695 % @url synonym for @uref, since that's how everyone uses it.
2697 \let\url=\uref
2699 % rms does not like angle brackets --karl, 17may97.
2700 % So now @email is just like @uref, unless we are pdf.
2702 %\def\email#1{\angleleft{\tt #1}\angleright}
2703 \ifpdf
2704 \def\email#1{\doemail#1,,\finish}
2705 \def\doemail#1,#2,#3\finish{\begingroup
2706 \unsepspaces
2707 \pdfurl{mailto:#1}%
2708 \setbox0 = \hbox{\ignorespaces #2}%
2709 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2710 \endlink
2711 \endgroup}
2712 \else
2713 \let\email=\uref
2716 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2717 % `example' (@kbd uses ttsl only inside of @example and friends),
2718 % or `code' (@kbd uses normal tty font always).
2719 \parseargdef\kbdinputstyle{%
2720 \def\txiarg{#1}%
2721 \ifx\txiarg\worddistinct
2722 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2723 \else\ifx\txiarg\wordexample
2724 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2725 \else\ifx\txiarg\wordcode
2726 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2727 \else
2728 \errhelp = \EMsimple
2729 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
2730 \fi\fi\fi
2732 \def\worddistinct{distinct}
2733 \def\wordexample{example}
2734 \def\wordcode{code}
2736 % Default is `distinct'.
2737 \kbdinputstyle distinct
2739 % @kbd is like @code, except that if the argument is just one @key command,
2740 % then @kbd has no effect.
2741 \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}}
2743 \def\xkey{\key}
2744 \def\kbdsub#1#2#3\par{%
2745 \def\one{#1}\def\three{#3}\def\threex{??}%
2746 \ifx\one\xkey\ifx\threex\three \key{#2}%
2747 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2748 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2751 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2752 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2753 %\font\keysy=cmsy9
2754 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2755 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2756 % \vbox{\hrule\kern-0.4pt
2757 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2758 % \kern-0.4pt\hrule}%
2759 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2761 % definition of @key with no lozenge. If the current font is already
2762 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2763 % if it isn't monospace, then use \tt.
2765 \def\key#1{{\setupmarkupstyle{key}%
2766 \nohyphenation
2767 \ifmonospace\else\tt\fi
2768 #1}\null}
2770 % @clicksequence{File @click{} Open ...}
2771 \def\clicksequence#1{\begingroup #1\endgroup}
2773 % @clickstyle @arrow (by default)
2774 \parseargdef\clickstyle{\def\click{#1}}
2775 \def\click{\arrow}
2777 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2778 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2780 \def\dmn#1{\thinspace #1}
2782 % @l was never documented to mean ``switch to the Lisp font'',
2783 % and it is not used as such in any manual I can find. We need it for
2784 % Polish suppressed-l. --karl, 22sep96.
2785 %\def\l#1{{\li #1}\null}
2787 % @acronym for "FBI", "NATO", and the like.
2788 % We print this one point size smaller, since it's intended for
2789 % all-uppercase.
2791 \def\acronym#1{\doacronym #1,,\finish}
2792 \def\doacronym#1,#2,#3\finish{%
2793 {\selectfonts\lsize #1}%
2794 \def\temp{#2}%
2795 \ifx\temp\empty \else
2796 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2798 \null % reset \spacefactor=1000
2801 % @abbr for "Comput. J." and the like.
2802 % No font change, but don't do end-of-sentence spacing.
2804 \def\abbr#1{\doabbr #1,,\finish}
2805 \def\doabbr#1,#2,#3\finish{%
2806 {\plainfrenchspacing #1}%
2807 \def\temp{#2}%
2808 \ifx\temp\empty \else
2809 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2811 \null % reset \spacefactor=1000
2814 % @asis just yields its argument. Used with @table, for example.
2816 \def\asis#1{#1}
2818 % @math outputs its argument in math mode.
2820 % One complication: _ usually means subscripts, but it could also mean
2821 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2822 % _ active, and distinguish by seeing if the current family is \slfam,
2823 % which is what @var uses.
2825 \catcode`\_ = \active
2826 \gdef\mathunderscore{%
2827 \catcode`\_=\active
2828 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
2831 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2832 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2833 % particular reason), but this is not advertised and we don't care.
2835 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2836 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
2838 \def\math{%
2839 \tex
2840 \mathunderscore
2841 \let\\ = \mathbackslash
2842 \mathactive
2843 % make the texinfo accent commands work in math mode
2844 \let\"=\ddot
2845 \let\'=\acute
2846 \let\==\bar
2847 \let\^=\hat
2848 \let\`=\grave
2849 \let\u=\breve
2850 \let\v=\check
2851 \let\~=\tilde
2852 \let\dotaccent=\dot
2853 $\finishmath
2855 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
2857 % Some active characters (such as <) are spaced differently in math.
2858 % We have to reset their definitions in case the @math was an argument
2859 % to a command which sets the catcodes (such as @item or @section).
2862 \catcode`^ = \active
2863 \catcode`< = \active
2864 \catcode`> = \active
2865 \catcode`+ = \active
2866 \catcode`' = \active
2867 \gdef\mathactive{%
2868 \let^ = \ptexhat
2869 \let< = \ptexless
2870 \let> = \ptexgtr
2871 \let+ = \ptexplus
2872 \let' = \ptexquoteright
2876 % ctrl is no longer a Texinfo command, but leave this definition for fun.
2877 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2879 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
2880 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
2881 % except specified as a normal braced arg, so no newlines to worry about.
2883 \def\outfmtnametex{tex}
2885 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
2886 \long\def\doinlinefmt#1,#2,\finish{%
2887 \def\inlinefmtname{#1}%
2888 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
2890 % For raw, must switch into @tex before parsing the argument, to avoid
2891 % setting catcodes prematurely. Doing it this way means that, for
2892 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
2893 % ignored. But this isn't important because if people want a literal
2894 % *right* brace they would have to use a command anyway, so they may as
2895 % well use a command to get a left brace too. We could re-use the
2896 % delimiter character idea from \verb, but it seems like overkill.
2898 \long\def\inlineraw{\tex \doinlineraw}
2899 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
2900 \def\doinlinerawtwo#1,#2,\finish{%
2901 \def\inlinerawname{#1}%
2902 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
2903 \endgroup % close group opened by \tex.
2907 \message{glyphs,}
2908 % and logos.
2910 % @@ prints an @, as does @atchar{}.
2911 \def\@{\char64 }
2912 \let\atchar=\@
2914 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
2915 % Unless we're in typewriter, use \ecfont because the CM text fonts do
2916 % not have braces, and we don't want to switch into math.
2917 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2918 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2919 \let\{=\mylbrace \let\lbracechar=\{
2920 \let\}=\myrbrace \let\rbracechar=\}
2921 \begingroup
2922 % Definitions to produce \{ and \} commands for indices,
2923 % and @{ and @} for the aux/toc files.
2924 \catcode`\{ = \other \catcode`\} = \other
2925 \catcode`\[ = 1 \catcode`\] = 2
2926 \catcode`\! = 0 \catcode`\\ = \other
2927 !gdef!lbracecmd[\{]%
2928 !gdef!rbracecmd[\}]%
2929 !gdef!lbraceatcmd[@{]%
2930 !gdef!rbraceatcmd[@}]%
2931 !endgroup
2933 % @comma{} to avoid , parsing problems.
2934 \let\comma = ,
2936 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2937 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2938 \let\, = \ptexc
2939 \let\dotaccent = \ptexdot
2940 \def\ringaccent#1{{\accent23 #1}}
2941 \let\tieaccent = \ptext
2942 \let\ubaraccent = \ptexb
2943 \let\udotaccent = \d
2945 % Other special characters: @questiondown @exclamdown @ordf @ordm
2946 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2947 \def\questiondown{?`}
2948 \def\exclamdown{!`}
2949 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
2950 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
2952 % Dotless i and dotless j, used for accents.
2953 \def\imacro{i}
2954 \def\jmacro{j}
2955 \def\dotless#1{%
2956 \def\temp{#1}%
2957 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2958 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2959 \else \errmessage{@dotless can be used only with i or j}%
2960 \fi\fi
2963 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2964 % period following counts as ending a sentence. (Idea found in latex.)
2966 \edef\TeX{\TeX \spacefactor=1000 }
2968 % @LaTeX{} logo. Not quite the same results as the definition in
2969 % latex.ltx, since we use a different font for the raised A; it's most
2970 % convenient for us to use an explicitly smaller font, rather than using
2971 % the \scriptstyle font (since we don't reset \scriptstyle and
2972 % \scriptscriptstyle).
2974 \def\LaTeX{%
2975 L\kern-.36em
2976 {\setbox0=\hbox{T}%
2977 \vbox to \ht0{\hbox{%
2978 \ifx\textnominalsize\xwordpt
2979 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
2980 % Revert to plain's \scriptsize, which is 7pt.
2981 \count255=\the\fam $\fam\count255 \scriptstyle A$%
2982 \else
2983 % For 11pt, we can use our lllsize.
2984 \selectfonts\lllsize A%
2987 \vss
2989 \kern-.15em
2990 \TeX
2993 % Some math mode symbols.
2994 \def\bullet{$\ptexbullet$}
2995 \def\geq{\ifmmode \ge\else $\ge$\fi}
2996 \def\leq{\ifmmode \le\else $\le$\fi}
2997 \def\minus{\ifmmode -\else $-$\fi}
2999 % @dots{} outputs an ellipsis using the current font.
3000 % We do .5em per period so that it has the same spacing in the cm
3001 % typewriter fonts as three actual period characters; on the other hand,
3002 % in other typewriter fonts three periods are wider than 1.5em. So do
3003 % whichever is larger.
3005 \def\dots{%
3006 \leavevmode
3007 \setbox0=\hbox{...}% get width of three periods
3008 \ifdim\wd0 > 1.5em
3009 \dimen0 = \wd0
3010 \else
3011 \dimen0 = 1.5em
3013 \hbox to \dimen0{%
3014 \hskip 0pt plus.25fil
3015 .\hskip 0pt plus1fil
3016 .\hskip 0pt plus1fil
3017 .\hskip 0pt plus.5fil
3021 % @enddots{} is an end-of-sentence ellipsis.
3023 \def\enddots{%
3024 \dots
3025 \spacefactor=\endofsentencespacefactor
3028 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3030 % Since these characters are used in examples, they should be an even number of
3031 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3033 \def\point{$\star$}
3034 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3035 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3036 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3037 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3038 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3040 % The @error{} command.
3041 % Adapted from the TeXbook's \boxit.
3043 \newbox\errorbox
3045 {\tentt \global\dimen0 = 3em}% Width of the box.
3046 \dimen2 = .55pt % Thickness of rules
3047 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3048 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
3050 \setbox\errorbox=\hbox to \dimen0{\hfil
3051 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3052 \advance\hsize by -2\dimen2 % Rules.
3053 \vbox{%
3054 \hrule height\dimen2
3055 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3056 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3057 \kern3pt\vrule width\dimen2}% Space to right.
3058 \hrule height\dimen2}
3059 \hfil}
3061 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3063 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3065 \def\pounds{{\it\$}}
3067 % @euro{} comes from a separate font, depending on the current style.
3068 % We use the free feym* fonts from the eurosym package by Henrik
3069 % Theiling, which support regular, slanted, bold and bold slanted (and
3070 % "outlined" (blackboard board, sort of) versions, which we don't need).
3071 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3073 % Although only regular is the truly official Euro symbol, we ignore
3074 % that. The Euro is designed to be slightly taller than the regular
3075 % font height.
3077 % feymr - regular
3078 % feymo - slanted
3079 % feybr - bold
3080 % feybo - bold slanted
3082 % There is no good (free) typewriter version, to my knowledge.
3083 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3084 % Hmm.
3086 % Also doesn't work in math. Do we need to do math with euro symbols?
3087 % Hope not.
3090 \def\euro{{\eurofont e}}
3091 \def\eurofont{%
3092 % We set the font at each command, rather than predefining it in
3093 % \textfonts and the other font-switching commands, so that
3094 % installations which never need the symbol don't have to have the
3095 % font installed.
3097 % There is only one designed size (nominal 10pt), so we always scale
3098 % that to the current nominal size.
3100 % By the way, simply using "at 1em" works for cmr10 and the like, but
3101 % does not work for cmbx10 and other extended/shrunken fonts.
3103 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3105 \ifx\curfontstyle\bfstylename
3106 % bold:
3107 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3108 \else
3109 % regular:
3110 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3112 \thiseurofont
3115 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3116 % sometimes we redefine the original macro, and the alias should reflect
3117 % the redefinition.
3119 % Use LaTeX names for the Icelandic letters.
3120 \def\DH{{\ecfont \char"D0}} % Eth
3121 \def\dh{{\ecfont \char"F0}} % eth
3122 \def\TH{{\ecfont \char"DE}} % Thorn
3123 \def\th{{\ecfont \char"FE}} % thorn
3125 \def\guillemetleft{{\ecfont \char"13}}
3126 \def\guillemotleft{\guillemetleft}
3127 \def\guillemetright{{\ecfont \char"14}}
3128 \def\guillemotright{\guillemetright}
3129 \def\guilsinglleft{{\ecfont \char"0E}}
3130 \def\guilsinglright{{\ecfont \char"0F}}
3131 \def\quotedblbase{{\ecfont \char"12}}
3132 \def\quotesinglbase{{\ecfont \char"0D}}
3134 % This positioning is not perfect (see the ogonek LaTeX package), but
3135 % we have the precomposed glyphs for the most common cases. We put the
3136 % tests to use those glyphs in the single \ogonek macro so we have fewer
3137 % dummy definitions to worry about for index entries, etc.
3139 % ogonek is also used with other letters in Lithuanian (IOU), but using
3140 % the precomposed glyphs for those is not so easy since they aren't in
3141 % the same EC font.
3142 \def\ogonek#1{{%
3143 \def\temp{#1}%
3144 \ifx\temp\macrocharA\Aogonek
3145 \else\ifx\temp\macrochara\aogonek
3146 \else\ifx\temp\macrocharE\Eogonek
3147 \else\ifx\temp\macrochare\eogonek
3148 \else
3149 \ecfont \setbox0=\hbox{#1}%
3150 \ifdim\ht0=1ex\accent"0C #1%
3151 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3153 \fi\fi\fi\fi
3156 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3157 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3158 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3159 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3161 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
3162 \def\ecfont{%
3163 % We can't distinguish serif/sans and italic/slanted, but this
3164 % is used for crude hacks anyway (like adding French and German
3165 % quotes to documents typeset with CM, where we lose kerning), so
3166 % hopefully nobody will notice/care.
3167 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3168 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3169 \ifmonospace
3170 % typewriter:
3171 \font\thisecfont = ectt\ecsize \space at \nominalsize
3172 \else
3173 \ifx\curfontstyle\bfstylename
3174 % bold:
3175 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
3176 \else
3177 % regular:
3178 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3181 \thisecfont
3184 % @registeredsymbol - R in a circle. The font for the R should really
3185 % be smaller yet, but lllsize is the best we can do for now.
3186 % Adapted from the plain.tex definition of \copyright.
3188 \def\registeredsymbol{%
3189 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
3190 \hfil\crcr\Orb}}%
3194 % @textdegree - the normal degrees sign.
3196 \def\textdegree{$^\circ$}
3198 % Laurent Siebenmann reports \Orb undefined with:
3199 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3200 % so we'll define it if necessary.
3202 \ifx\Orb\thisisundefined
3203 \def\Orb{\mathhexbox20D}
3206 % Quotes.
3207 \chardef\quotedblleft="5C
3208 \chardef\quotedblright=`\"
3209 \chardef\quoteleft=`\`
3210 \chardef\quoteright=`\'
3213 \message{page headings,}
3215 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3216 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3218 % First the title page. Must do @settitle before @titlepage.
3219 \newif\ifseenauthor
3220 \newif\iffinishedtitlepage
3222 % Do an implicit @contents or @shortcontents after @end titlepage if the
3223 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3225 \newif\ifsetcontentsaftertitlepage
3226 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3227 \newif\ifsetshortcontentsaftertitlepage
3228 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3230 \parseargdef\shorttitlepage{%
3231 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3232 \endgroup\page\hbox{}\page}
3234 \envdef\titlepage{%
3235 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3236 \begingroup
3237 \parindent=0pt \textfonts
3238 % Leave some space at the very top of the page.
3239 \vglue\titlepagetopglue
3240 % No rule at page bottom unless we print one at the top with @title.
3241 \finishedtitlepagetrue
3243 % Most title ``pages'' are actually two pages long, with space
3244 % at the top of the second. We don't want the ragged left on the second.
3245 \let\oldpage = \page
3246 \def\page{%
3247 \iffinishedtitlepage\else
3248 \finishtitlepage
3250 \let\page = \oldpage
3251 \page
3252 \null
3256 \def\Etitlepage{%
3257 \iffinishedtitlepage\else
3258 \finishtitlepage
3260 % It is important to do the page break before ending the group,
3261 % because the headline and footline are only empty inside the group.
3262 % If we use the new definition of \page, we always get a blank page
3263 % after the title page, which we certainly don't want.
3264 \oldpage
3265 \endgroup
3267 % Need this before the \...aftertitlepage checks so that if they are
3268 % in effect the toc pages will come out with page numbers.
3269 \HEADINGSon
3271 % If they want short, they certainly want long too.
3272 \ifsetshortcontentsaftertitlepage
3273 \shortcontents
3274 \contents
3275 \global\let\shortcontents = \relax
3276 \global\let\contents = \relax
3279 \ifsetcontentsaftertitlepage
3280 \contents
3281 \global\let\contents = \relax
3282 \global\let\shortcontents = \relax
3286 \def\finishtitlepage{%
3287 \vskip4pt \hrule height 2pt width \hsize
3288 \vskip\titlepagebottomglue
3289 \finishedtitlepagetrue
3292 % Settings used for typesetting titles: no hyphenation, no indentation,
3293 % don't worry much about spacing, ragged right. This should be used
3294 % inside a \vbox, and fonts need to be set appropriately first. Because
3295 % it is always used for titles, nothing else, we call \rmisbold. \par
3296 % should be specified before the end of the \vbox, since a vbox is a group.
3298 \def\raggedtitlesettings{%
3299 \rmisbold
3300 \hyphenpenalty=10000
3301 \parindent=0pt
3302 \tolerance=5000
3303 \ptexraggedright
3306 % Macros to be used within @titlepage:
3308 \let\subtitlerm=\tenrm
3309 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3311 \parseargdef\title{%
3312 \checkenv\titlepage
3313 \vbox{\titlefonts \raggedtitlesettings #1\par}%
3314 % print a rule at the page bottom also.
3315 \finishedtitlepagefalse
3316 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3319 \parseargdef\subtitle{%
3320 \checkenv\titlepage
3321 {\subtitlefont \rightline{#1}}%
3324 % @author should come last, but may come many times.
3325 % It can also be used inside @quotation.
3327 \parseargdef\author{%
3328 \def\temp{\quotation}%
3329 \ifx\thisenv\temp
3330 \def\quotationauthor{#1}% printed in \Equotation.
3331 \else
3332 \checkenv\titlepage
3333 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3334 {\secfonts\rmisbold \leftline{#1}}%
3339 % Set up page headings and footings.
3341 \let\thispage=\folio
3343 \newtoks\evenheadline % headline on even pages
3344 \newtoks\oddheadline % headline on odd pages
3345 \newtoks\evenfootline % footline on even pages
3346 \newtoks\oddfootline % footline on odd pages
3348 % Now make TeX use those variables
3349 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3350 \else \the\evenheadline \fi}}
3351 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3352 \else \the\evenfootline \fi}\HEADINGShook}
3353 \let\HEADINGShook=\relax
3355 % Commands to set those variables.
3356 % For example, this is what @headings on does
3357 % @evenheading @thistitle|@thispage|@thischapter
3358 % @oddheading @thischapter|@thispage|@thistitle
3359 % @evenfooting @thisfile||
3360 % @oddfooting ||@thisfile
3363 \def\evenheading{\parsearg\evenheadingxxx}
3364 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3365 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3366 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3368 \def\oddheading{\parsearg\oddheadingxxx}
3369 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3370 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3371 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3373 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3375 \def\evenfooting{\parsearg\evenfootingxxx}
3376 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3377 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3378 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3380 \def\oddfooting{\parsearg\oddfootingxxx}
3381 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3382 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3383 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3385 % Leave some space for the footline. Hopefully ok to assume
3386 % @evenfooting will not be used by itself.
3387 \global\advance\pageheight by -12pt
3388 \global\advance\vsize by -12pt
3391 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3393 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3394 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3396 % The same set of arguments for:
3398 % @oddheadingmarks
3399 % @evenfootingmarks
3400 % @oddfootingmarks
3401 % @everyheadingmarks
3402 % @everyfootingmarks
3404 \def\evenheadingmarks{\headingmarks{even}{heading}}
3405 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3406 \def\evenfootingmarks{\headingmarks{even}{footing}}
3407 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3408 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3409 \headingmarks{odd}{heading}{#1} }
3410 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3411 \headingmarks{odd}{footing}{#1} }
3412 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3413 \def\headingmarks#1#2#3 {%
3414 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3415 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3418 \everyheadingmarks bottom
3419 \everyfootingmarks bottom
3421 % @headings double turns headings on for double-sided printing.
3422 % @headings single turns headings on for single-sided printing.
3423 % @headings off turns them off.
3424 % @headings on same as @headings double, retained for compatibility.
3425 % @headings after turns on double-sided headings after this page.
3426 % @headings doubleafter turns on double-sided headings after this page.
3427 % @headings singleafter turns on single-sided headings after this page.
3428 % By default, they are off at the start of a document,
3429 % and turned `on' after @end titlepage.
3431 \def\headings #1 {\csname HEADINGS#1\endcsname}
3433 \def\headingsoff{% non-global headings elimination
3434 \evenheadline={\hfil}\evenfootline={\hfil}%
3435 \oddheadline={\hfil}\oddfootline={\hfil}%
3438 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3439 \HEADINGSoff % it's the default
3441 % When we turn headings on, set the page number to 1.
3442 % For double-sided printing, put current file name in lower left corner,
3443 % chapter name on inside top of right hand pages, document
3444 % title on inside top of left hand pages, and page numbers on outside top
3445 % edge of all pages.
3446 \def\HEADINGSdouble{%
3447 \global\pageno=1
3448 \global\evenfootline={\hfil}
3449 \global\oddfootline={\hfil}
3450 \global\evenheadline={\line{\folio\hfil\thistitle}}
3451 \global\oddheadline={\line{\thischapter\hfil\folio}}
3452 \global\let\contentsalignmacro = \chapoddpage
3454 \let\contentsalignmacro = \chappager
3456 % For single-sided printing, chapter title goes across top left of page,
3457 % page number on top right.
3458 \def\HEADINGSsingle{%
3459 \global\pageno=1
3460 \global\evenfootline={\hfil}
3461 \global\oddfootline={\hfil}
3462 \global\evenheadline={\line{\thischapter\hfil\folio}}
3463 \global\oddheadline={\line{\thischapter\hfil\folio}}
3464 \global\let\contentsalignmacro = \chappager
3466 \def\HEADINGSon{\HEADINGSdouble}
3468 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3469 \let\HEADINGSdoubleafter=\HEADINGSafter
3470 \def\HEADINGSdoublex{%
3471 \global\evenfootline={\hfil}
3472 \global\oddfootline={\hfil}
3473 \global\evenheadline={\line{\folio\hfil\thistitle}}
3474 \global\oddheadline={\line{\thischapter\hfil\folio}}
3475 \global\let\contentsalignmacro = \chapoddpage
3478 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3479 \def\HEADINGSsinglex{%
3480 \global\evenfootline={\hfil}
3481 \global\oddfootline={\hfil}
3482 \global\evenheadline={\line{\thischapter\hfil\folio}}
3483 \global\oddheadline={\line{\thischapter\hfil\folio}}
3484 \global\let\contentsalignmacro = \chappager
3487 % Subroutines used in generating headings
3488 % This produces Day Month Year style of output.
3489 % Only define if not already defined, in case a txi-??.tex file has set
3490 % up a different format (e.g., txi-cs.tex does this).
3491 \ifx\today\thisisundefined
3492 \def\today{%
3493 \number\day\space
3494 \ifcase\month
3495 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3496 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3497 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3499 \space\number\year}
3502 % @settitle line... specifies the title of the document, for headings.
3503 % It generates no output of its own.
3504 \def\thistitle{\putwordNoTitle}
3505 \def\settitle{\parsearg{\gdef\thistitle}}
3508 \message{tables,}
3509 % Tables -- @table, @ftable, @vtable, @item(x).
3511 % default indentation of table text
3512 \newdimen\tableindent \tableindent=.8in
3513 % default indentation of @itemize and @enumerate text
3514 \newdimen\itemindent \itemindent=.3in
3515 % margin between end of table item and start of table text.
3516 \newdimen\itemmargin \itemmargin=.1in
3518 % used internally for \itemindent minus \itemmargin
3519 \newdimen\itemmax
3521 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3522 % these defs.
3523 % They also define \itemindex
3524 % to index the item name in whatever manner is desired (perhaps none).
3526 \newif\ifitemxneedsnegativevskip
3528 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3530 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3531 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3533 \def\itemzzz #1{\begingroup %
3534 \advance\hsize by -\rightskip
3535 \advance\hsize by -\tableindent
3536 \setbox0=\hbox{\itemindicate{#1}}%
3537 \itemindex{#1}%
3538 \nobreak % This prevents a break before @itemx.
3540 % If the item text does not fit in the space we have, put it on a line
3541 % by itself, and do not allow a page break either before or after that
3542 % line. We do not start a paragraph here because then if the next
3543 % command is, e.g., @kindex, the whatsit would get put into the
3544 % horizontal list on a line by itself, resulting in extra blank space.
3545 \ifdim \wd0>\itemmax
3547 % Make this a paragraph so we get the \parskip glue and wrapping,
3548 % but leave it ragged-right.
3549 \begingroup
3550 \advance\leftskip by-\tableindent
3551 \advance\hsize by\tableindent
3552 \advance\rightskip by0pt plus1fil\relax
3553 \leavevmode\unhbox0\par
3554 \endgroup
3556 % We're going to be starting a paragraph, but we don't want the
3557 % \parskip glue -- logically it's part of the @item we just started.
3558 \nobreak \vskip-\parskip
3560 % Stop a page break at the \parskip glue coming up. However, if
3561 % what follows is an environment such as @example, there will be no
3562 % \parskip glue; then the negative vskip we just inserted would
3563 % cause the example and the item to crash together. So we use this
3564 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3565 % \parskip glue after all. Section titles are handled this way also.
3567 \penalty 10001
3568 \endgroup
3569 \itemxneedsnegativevskipfalse
3570 \else
3571 % The item text fits into the space. Start a paragraph, so that the
3572 % following text (if any) will end up on the same line.
3573 \noindent
3574 % Do this with kerns and \unhbox so that if there is a footnote in
3575 % the item text, it can migrate to the main vertical list and
3576 % eventually be printed.
3577 \nobreak\kern-\tableindent
3578 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3579 \unhbox0
3580 \nobreak\kern\dimen0
3581 \endgroup
3582 \itemxneedsnegativevskiptrue
3586 \def\item{\errmessage{@item while not in a list environment}}
3587 \def\itemx{\errmessage{@itemx while not in a list environment}}
3589 % @table, @ftable, @vtable.
3590 \envdef\table{%
3591 \let\itemindex\gobble
3592 \tablecheck{table}%
3594 \envdef\ftable{%
3595 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3596 \tablecheck{ftable}%
3598 \envdef\vtable{%
3599 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3600 \tablecheck{vtable}%
3602 \def\tablecheck#1{%
3603 \ifnum \the\catcode`\^^M=\active
3604 \endgroup
3605 \errmessage{This command won't work in this context; perhaps the problem is
3606 that we are \inenvironment\thisenv}%
3607 \def\next{\doignore{#1}}%
3608 \else
3609 \let\next\tablex
3611 \next
3613 \def\tablex#1{%
3614 \def\itemindicate{#1}%
3615 \parsearg\tabley
3617 \def\tabley#1{%
3619 \makevalueexpandable
3620 \edef\temp{\noexpand\tablez #1\space\space\space}%
3621 \expandafter
3622 }\temp \endtablez
3624 \def\tablez #1 #2 #3 #4\endtablez{%
3625 \aboveenvbreak
3626 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3627 \ifnum 0#2>0 \tableindent=#2\mil \fi
3628 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3629 \itemmax=\tableindent
3630 \advance \itemmax by -\itemmargin
3631 \advance \leftskip by \tableindent
3632 \exdentamount=\tableindent
3633 \parindent = 0pt
3634 \parskip = \smallskipamount
3635 \ifdim \parskip=0pt \parskip=2pt \fi
3636 \let\item = \internalBitem
3637 \let\itemx = \internalBitemx
3639 \def\Etable{\endgraf\afterenvbreak}
3640 \let\Eftable\Etable
3641 \let\Evtable\Etable
3642 \let\Eitemize\Etable
3643 \let\Eenumerate\Etable
3645 % This is the counter used by @enumerate, which is really @itemize
3647 \newcount \itemno
3649 \envdef\itemize{\parsearg\doitemize}
3651 \def\doitemize#1{%
3652 \aboveenvbreak
3653 \itemmax=\itemindent
3654 \advance\itemmax by -\itemmargin
3655 \advance\leftskip by \itemindent
3656 \exdentamount=\itemindent
3657 \parindent=0pt
3658 \parskip=\smallskipamount
3659 \ifdim\parskip=0pt \parskip=2pt \fi
3661 % Try typesetting the item mark that if the document erroneously says
3662 % something like @itemize @samp (intending @table), there's an error
3663 % right away at the @itemize. It's not the best error message in the
3664 % world, but it's better than leaving it to the @item. This means if
3665 % the user wants an empty mark, they have to say @w{} not just @w.
3666 \def\itemcontents{#1}%
3667 \setbox0 = \hbox{\itemcontents}%
3669 % @itemize with no arg is equivalent to @itemize @bullet.
3670 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3672 \let\item=\itemizeitem
3675 % Definition of @item while inside @itemize and @enumerate.
3677 \def\itemizeitem{%
3678 \advance\itemno by 1 % for enumerations
3679 {\let\par=\endgraf \smallbreak}% reasonable place to break
3681 % If the document has an @itemize directly after a section title, a
3682 % \nobreak will be last on the list, and \sectionheading will have
3683 % done a \vskip-\parskip. In that case, we don't want to zero
3684 % parskip, or the item text will crash with the heading. On the
3685 % other hand, when there is normal text preceding the item (as there
3686 % usually is), we do want to zero parskip, or there would be too much
3687 % space. In that case, we won't have a \nobreak before. At least
3688 % that's the theory.
3689 \ifnum\lastpenalty<10000 \parskip=0in \fi
3690 \noindent
3691 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3693 \vadjust{\penalty 1200}}% not good to break after first line of item.
3694 \flushcr
3697 % \splitoff TOKENS\endmark defines \first to be the first token in
3698 % TOKENS, and \rest to be the remainder.
3700 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3702 % Allow an optional argument of an uppercase letter, lowercase letter,
3703 % or number, to specify the first label in the enumerated list. No
3704 % argument is the same as `1'.
3706 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3707 \def\enumeratey #1 #2\endenumeratey{%
3708 % If we were given no argument, pretend we were given `1'.
3709 \def\thearg{#1}%
3710 \ifx\thearg\empty \def\thearg{1}\fi
3712 % Detect if the argument is a single token. If so, it might be a
3713 % letter. Otherwise, the only valid thing it can be is a number.
3714 % (We will always have one token, because of the test we just made.
3715 % This is a good thing, since \splitoff doesn't work given nothing at
3716 % all -- the first parameter is undelimited.)
3717 \expandafter\splitoff\thearg\endmark
3718 \ifx\rest\empty
3719 % Only one token in the argument. It could still be anything.
3720 % A ``lowercase letter'' is one whose \lccode is nonzero.
3721 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3722 % not equal to itself.
3723 % Otherwise, we assume it's a number.
3725 % We need the \relax at the end of the \ifnum lines to stop TeX from
3726 % continuing to look for a <number>.
3728 \ifnum\lccode\expandafter`\thearg=0\relax
3729 \numericenumerate % a number (we hope)
3730 \else
3731 % It's a letter.
3732 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3733 \lowercaseenumerate % lowercase letter
3734 \else
3735 \uppercaseenumerate % uppercase letter
3738 \else
3739 % Multiple tokens in the argument. We hope it's a number.
3740 \numericenumerate
3744 % An @enumerate whose labels are integers. The starting integer is
3745 % given in \thearg.
3747 \def\numericenumerate{%
3748 \itemno = \thearg
3749 \startenumeration{\the\itemno}%
3752 % The starting (lowercase) letter is in \thearg.
3753 \def\lowercaseenumerate{%
3754 \itemno = \expandafter`\thearg
3755 \startenumeration{%
3756 % Be sure we're not beyond the end of the alphabet.
3757 \ifnum\itemno=0
3758 \errmessage{No more lowercase letters in @enumerate; get a bigger
3759 alphabet}%
3761 \char\lccode\itemno
3765 % The starting (uppercase) letter is in \thearg.
3766 \def\uppercaseenumerate{%
3767 \itemno = \expandafter`\thearg
3768 \startenumeration{%
3769 % Be sure we're not beyond the end of the alphabet.
3770 \ifnum\itemno=0
3771 \errmessage{No more uppercase letters in @enumerate; get a bigger
3772 alphabet}
3774 \char\uccode\itemno
3778 % Call \doitemize, adding a period to the first argument and supplying the
3779 % common last two arguments. Also subtract one from the initial value in
3780 % \itemno, since @item increments \itemno.
3782 \def\startenumeration#1{%
3783 \advance\itemno by -1
3784 \doitemize{#1.}\flushcr
3787 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3788 % to @enumerate.
3790 \def\alphaenumerate{\enumerate{a}}
3791 \def\capsenumerate{\enumerate{A}}
3792 \def\Ealphaenumerate{\Eenumerate}
3793 \def\Ecapsenumerate{\Eenumerate}
3796 % @multitable macros
3797 % Amy Hendrickson, 8/18/94, 3/6/96
3799 % @multitable ... @end multitable will make as many columns as desired.
3800 % Contents of each column will wrap at width given in preamble. Width
3801 % can be specified either with sample text given in a template line,
3802 % or in percent of \hsize, the current width of text on page.
3804 % Table can continue over pages but will only break between lines.
3806 % To make preamble:
3808 % Either define widths of columns in terms of percent of \hsize:
3809 % @multitable @columnfractions .25 .3 .45
3810 % @item ...
3812 % Numbers following @columnfractions are the percent of the total
3813 % current hsize to be used for each column. You may use as many
3814 % columns as desired.
3817 % Or use a template:
3818 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3819 % @item ...
3820 % using the widest term desired in each column.
3822 % Each new table line starts with @item, each subsequent new column
3823 % starts with @tab. Empty columns may be produced by supplying @tab's
3824 % with nothing between them for as many times as empty columns are needed,
3825 % ie, @tab@tab@tab will produce two empty columns.
3827 % @item, @tab do not need to be on their own lines, but it will not hurt
3828 % if they are.
3830 % Sample multitable:
3832 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3833 % @item first col stuff @tab second col stuff @tab third col
3834 % @item
3835 % first col stuff
3836 % @tab
3837 % second col stuff
3838 % @tab
3839 % third col
3840 % @item first col stuff @tab second col stuff
3841 % @tab Many paragraphs of text may be used in any column.
3843 % They will wrap at the width determined by the template.
3844 % @item@tab@tab This will be in third column.
3845 % @end multitable
3847 % Default dimensions may be reset by user.
3848 % @multitableparskip is vertical space between paragraphs in table.
3849 % @multitableparindent is paragraph indent in table.
3850 % @multitablecolmargin is horizontal space to be left between columns.
3851 % @multitablelinespace is space to leave between table items, baseline
3852 % to baseline.
3853 % 0pt means it depends on current normal line spacing.
3855 \newskip\multitableparskip
3856 \newskip\multitableparindent
3857 \newdimen\multitablecolspace
3858 \newskip\multitablelinespace
3859 \multitableparskip=0pt
3860 \multitableparindent=6pt
3861 \multitablecolspace=12pt
3862 \multitablelinespace=0pt
3864 % Macros used to set up halign preamble:
3866 \let\endsetuptable\relax
3867 \def\xendsetuptable{\endsetuptable}
3868 \let\columnfractions\relax
3869 \def\xcolumnfractions{\columnfractions}
3870 \newif\ifsetpercent
3872 % #1 is the @columnfraction, usually a decimal number like .5, but might
3873 % be just 1. We just use it, whatever it is.
3875 \def\pickupwholefraction#1 {%
3876 \global\advance\colcount by 1
3877 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3878 \setuptable
3881 \newcount\colcount
3882 \def\setuptable#1{%
3883 \def\firstarg{#1}%
3884 \ifx\firstarg\xendsetuptable
3885 \let\go = \relax
3886 \else
3887 \ifx\firstarg\xcolumnfractions
3888 \global\setpercenttrue
3889 \else
3890 \ifsetpercent
3891 \let\go\pickupwholefraction
3892 \else
3893 \global\advance\colcount by 1
3894 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3895 % separator; typically that is always in the input, anyway.
3896 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3899 \ifx\go\pickupwholefraction
3900 % Put the argument back for the \pickupwholefraction call, so
3901 % we'll always have a period there to be parsed.
3902 \def\go{\pickupwholefraction#1}%
3903 \else
3904 \let\go = \setuptable
3905 \fi%
3910 % multitable-only commands.
3912 % @headitem starts a heading row, which we typeset in bold.
3913 % Assignments have to be global since we are inside the implicit group
3914 % of an alignment entry. \everycr resets \everytab so we don't have to
3915 % undo it ourselves.
3916 \def\headitemfont{\b}% for people to use in the template row; not changeable
3917 \def\headitem{%
3918 \checkenv\multitable
3919 \crcr
3920 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3921 \the\everytab % for the first item
3924 % A \tab used to include \hskip1sp. But then the space in a template
3925 % line is not enough. That is bad. So let's go back to just `&' until
3926 % we again encounter the problem the 1sp was intended to solve.
3927 % --karl, nathan@acm.org, 20apr99.
3928 \def\tab{\checkenv\multitable &\the\everytab}%
3930 % @multitable ... @end multitable definitions:
3932 \newtoks\everytab % insert after every tab.
3934 \envdef\multitable{%
3935 \vskip\parskip
3936 \startsavinginserts
3938 % @item within a multitable starts a normal row.
3939 % We use \def instead of \let so that if one of the multitable entries
3940 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3941 % \endtemplate) expanding \doitemize.
3942 \def\item{\crcr}%
3944 \tolerance=9500
3945 \hbadness=9500
3946 \setmultitablespacing
3947 \parskip=\multitableparskip
3948 \parindent=\multitableparindent
3949 \overfullrule=0pt
3950 \global\colcount=0
3952 \everycr = {%
3953 \noalign{%
3954 \global\everytab={}%
3955 \global\colcount=0 % Reset the column counter.
3956 % Check for saved footnotes, etc.
3957 \checkinserts
3958 % Keeps underfull box messages off when table breaks over pages.
3959 %\filbreak
3960 % Maybe so, but it also creates really weird page breaks when the
3961 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3962 % problem manifests itself, so it can be fixed for real --karl.
3966 \parsearg\domultitable
3968 \def\domultitable#1{%
3969 % To parse everything between @multitable and @item:
3970 \setuptable#1 \endsetuptable
3972 % This preamble sets up a generic column definition, which will
3973 % be used as many times as user calls for columns.
3974 % \vtop will set a single line and will also let text wrap and
3975 % continue for many paragraphs if desired.
3976 \halign\bgroup &%
3977 \global\advance\colcount by 1
3978 \multistrut
3979 \vtop{%
3980 % Use the current \colcount to find the correct column width:
3981 \hsize=\expandafter\csname col\the\colcount\endcsname
3983 % In order to keep entries from bumping into each other
3984 % we will add a \leftskip of \multitablecolspace to all columns after
3985 % the first one.
3987 % If a template has been used, we will add \multitablecolspace
3988 % to the width of each template entry.
3990 % If the user has set preamble in terms of percent of \hsize we will
3991 % use that dimension as the width of the column, and the \leftskip
3992 % will keep entries from bumping into each other. Table will start at
3993 % left margin and final column will justify at right margin.
3995 % Make sure we don't inherit \rightskip from the outer environment.
3996 \rightskip=0pt
3997 \ifnum\colcount=1
3998 % The first column will be indented with the surrounding text.
3999 \advance\hsize by\leftskip
4000 \else
4001 \ifsetpercent \else
4002 % If user has not set preamble in terms of percent of \hsize
4003 % we will advance \hsize by \multitablecolspace.
4004 \advance\hsize by \multitablecolspace
4006 % In either case we will make \leftskip=\multitablecolspace:
4007 \leftskip=\multitablecolspace
4009 % Ignoring space at the beginning and end avoids an occasional spurious
4010 % blank line, when TeX decides to break the line at the space before the
4011 % box from the multistrut, so the strut ends up on a line by itself.
4012 % For example:
4013 % @multitable @columnfractions .11 .89
4014 % @item @code{#}
4015 % @tab Legal holiday which is valid in major parts of the whole country.
4016 % Is automatically provided with highlighting sequences respectively
4017 % marking characters.
4018 \noindent\ignorespaces##\unskip\multistrut
4019 }\cr
4021 \def\Emultitable{%
4022 \crcr
4023 \egroup % end the \halign
4024 \global\setpercentfalse
4027 \def\setmultitablespacing{%
4028 \def\multistrut{\strut}% just use the standard line spacing
4030 % Compute \multitablelinespace (if not defined by user) for use in
4031 % \multitableparskip calculation. We used define \multistrut based on
4032 % this, but (ironically) that caused the spacing to be off.
4033 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
4034 \ifdim\multitablelinespace=0pt
4035 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
4036 \global\advance\multitablelinespace by-\ht0
4038 % Test to see if parskip is larger than space between lines of
4039 % table. If not, do nothing.
4040 % If so, set to same dimension as multitablelinespace.
4041 \ifdim\multitableparskip>\multitablelinespace
4042 \global\multitableparskip=\multitablelinespace
4043 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4044 % than skip between lines in the table.
4045 \fi%
4046 \ifdim\multitableparskip=0pt
4047 \global\multitableparskip=\multitablelinespace
4048 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4049 % than skip between lines in the table.
4050 \fi}
4053 \message{conditionals,}
4055 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4056 % @ifnotxml always succeed. They currently do nothing; we don't
4057 % attempt to check whether the conditionals are properly nested. But we
4058 % have to remember that they are conditionals, so that @end doesn't
4059 % attempt to close an environment group.
4061 \def\makecond#1{%
4062 \expandafter\let\csname #1\endcsname = \relax
4063 \expandafter\let\csname iscond.#1\endcsname = 1
4065 \makecond{iftex}
4066 \makecond{ifnotdocbook}
4067 \makecond{ifnothtml}
4068 \makecond{ifnotinfo}
4069 \makecond{ifnotplaintext}
4070 \makecond{ifnotxml}
4072 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4074 \def\direntry{\doignore{direntry}}
4075 \def\documentdescription{\doignore{documentdescription}}
4076 \def\docbook{\doignore{docbook}}
4077 \def\html{\doignore{html}}
4078 \def\ifdocbook{\doignore{ifdocbook}}
4079 \def\ifhtml{\doignore{ifhtml}}
4080 \def\ifinfo{\doignore{ifinfo}}
4081 \def\ifnottex{\doignore{ifnottex}}
4082 \def\ifplaintext{\doignore{ifplaintext}}
4083 \def\ifxml{\doignore{ifxml}}
4084 \def\ignore{\doignore{ignore}}
4085 \def\menu{\doignore{menu}}
4086 \def\xml{\doignore{xml}}
4088 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4090 % A count to remember the depth of nesting.
4091 \newcount\doignorecount
4093 \def\doignore#1{\begingroup
4094 % Scan in ``verbatim'' mode:
4095 \obeylines
4096 \catcode`\@ = \other
4097 \catcode`\{ = \other
4098 \catcode`\} = \other
4100 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4101 \spaceisspace
4103 % Count number of #1's that we've seen.
4104 \doignorecount = 0
4106 % Swallow text until we reach the matching `@end #1'.
4107 \dodoignore{#1}%
4110 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4111 \obeylines %
4113 \gdef\dodoignore#1{%
4114 % #1 contains the command name as a string, e.g., `ifinfo'.
4116 % Define a command to find the next `@end #1'.
4117 \long\def\doignoretext##1^^M@end #1{%
4118 \doignoretextyyy##1^^M@#1\_STOP_}%
4120 % And this command to find another #1 command, at the beginning of a
4121 % line. (Otherwise, we would consider a line `@c @ifset', for
4122 % example, to count as an @ifset for nesting.)
4123 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4125 % And now expand that command.
4126 \doignoretext ^^M%
4130 \def\doignoreyyy#1{%
4131 \def\temp{#1}%
4132 \ifx\temp\empty % Nothing found.
4133 \let\next\doignoretextzzz
4134 \else % Found a nested condition, ...
4135 \advance\doignorecount by 1
4136 \let\next\doignoretextyyy % ..., look for another.
4137 % If we're here, #1 ends with ^^M\ifinfo (for example).
4139 \next #1% the token \_STOP_ is present just after this macro.
4142 % We have to swallow the remaining "\_STOP_".
4144 \def\doignoretextzzz#1{%
4145 \ifnum\doignorecount = 0 % We have just found the outermost @end.
4146 \let\next\enddoignore
4147 \else % Still inside a nested condition.
4148 \advance\doignorecount by -1
4149 \let\next\doignoretext % Look for the next @end.
4151 \next
4154 % Finish off ignored text.
4155 { \obeylines%
4156 % Ignore anything after the last `@end #1'; this matters in verbatim
4157 % environments, where otherwise the newline after an ignored conditional
4158 % would result in a blank line in the output.
4159 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4163 % @set VAR sets the variable VAR to an empty value.
4164 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4166 % Since we want to separate VAR from REST-OF-LINE (which might be
4167 % empty), we can't just use \parsearg; we have to insert a space of our
4168 % own to delimit the rest of the line, and then take it out again if we
4169 % didn't need it.
4170 % We rely on the fact that \parsearg sets \catcode`\ =10.
4172 \parseargdef\set{\setyyy#1 \endsetyyy}
4173 \def\setyyy#1 #2\endsetyyy{%
4175 \makevalueexpandable
4176 \def\temp{#2}%
4177 \edef\next{\gdef\makecsname{SET#1}}%
4178 \ifx\temp\empty
4179 \next{}%
4180 \else
4181 \setzzz#2\endsetzzz
4185 % Remove the trailing space \setxxx inserted.
4186 \def\setzzz#1 \endsetzzz{\next{#1}}
4188 % @clear VAR clears (i.e., unsets) the variable VAR.
4190 \parseargdef\clear{%
4192 \makevalueexpandable
4193 \global\expandafter\let\csname SET#1\endcsname=\relax
4197 % @value{foo} gets the text saved in variable foo.
4198 \def\value{\begingroup\makevalueexpandable\valuexxx}
4199 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4201 \catcode`\- = \active \catcode`\_ = \active
4203 \gdef\makevalueexpandable{%
4204 \let\value = \expandablevalue
4205 % We don't want these characters active, ...
4206 \catcode`\-=\other \catcode`\_=\other
4207 % ..., but we might end up with active ones in the argument if
4208 % we're called from @code, as @code{@value{foo-bar_}}, though.
4209 % So \let them to their normal equivalents.
4210 \let-\normaldash \let_\normalunderscore
4214 % We have this subroutine so that we can handle at least some @value's
4215 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4216 % The command has to be fully expandable (if the variable is set), since
4217 % the result winds up in the index file. This means that if the
4218 % variable's value contains other Texinfo commands, it's almost certain
4219 % it will fail (although perhaps we could fix that with sufficient work
4220 % to do a one-level expansion on the result, instead of complete).
4222 \def\expandablevalue#1{%
4223 \expandafter\ifx\csname SET#1\endcsname\relax
4224 {[No value for ``#1'']}%
4225 \message{Variable `#1', used in @value, is not set.}%
4226 \else
4227 \csname SET#1\endcsname
4231 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4232 % with @set.
4234 % To get the special treatment we need for `@end ifset,' we call
4235 % \makecond and then redefine.
4237 \makecond{ifset}
4238 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4239 \def\doifset#1#2{%
4241 \makevalueexpandable
4242 \let\next=\empty
4243 \expandafter\ifx\csname SET#2\endcsname\relax
4244 #1% If not set, redefine \next.
4246 \expandafter
4247 }\next
4249 \def\ifsetfail{\doignore{ifset}}
4251 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4252 % defined with @set, or has been undefined with @clear.
4254 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4255 % above code: if the variable is not set, do nothing, if it is set,
4256 % then redefine \next to \ifclearfail.
4258 \makecond{ifclear}
4259 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4260 \def\ifclearfail{\doignore{ifclear}}
4262 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4263 % without the @) is in fact defined. We can only feasibly check at the
4264 % TeX level, so something like `mathcode' is going to considered
4265 % defined even though it is not a Texinfo command.
4267 \makecond{ifcommanddefined}
4268 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
4270 \def\doifcmddefined#1#2{{%
4271 \makevalueexpandable
4272 \let\next=\empty
4273 \expandafter\ifx\csname #2\endcsname\relax
4274 #1% If not defined, \let\next as above.
4276 \expandafter
4277 }\next
4279 \def\ifcmddefinedfail{\doignore{ifcommanddefined}}
4281 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4282 \makecond{ifcommandnotdefined}
4283 \def\ifcommandnotdefined{%
4284 \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
4285 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
4287 % Set the `txicommandconditionals' variable, so documents have a way to
4288 % test if the @ifcommand...defined conditionals are available.
4289 \set txicommandconditionals
4291 % @dircategory CATEGORY -- specify a category of the dir file
4292 % which this file should belong to. Ignore this in TeX.
4293 \let\dircategory=\comment
4295 % @defininfoenclose.
4296 \let\definfoenclose=\comment
4299 \message{indexing,}
4300 % Index generation facilities
4302 % Define \newwrite to be identical to plain tex's \newwrite
4303 % except not \outer, so it can be used within macros and \if's.
4304 \edef\newwrite{\makecsname{ptexnewwrite}}
4306 % \newindex {foo} defines an index named foo.
4307 % It automatically defines \fooindex such that
4308 % \fooindex ...rest of line... puts an entry in the index foo.
4309 % It also defines \fooindfile to be the number of the output channel for
4310 % the file that accumulates this index. The file's extension is foo.
4311 % The name of an index should be no more than 2 characters long
4312 % for the sake of vms.
4314 \def\newindex#1{%
4315 \iflinks
4316 \expandafter\newwrite \csname#1indfile\endcsname
4317 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4319 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4320 \noexpand\doindex{#1}}
4323 % @defindex foo == \newindex{foo}
4325 \def\defindex{\parsearg\newindex}
4327 % Define @defcodeindex, like @defindex except put all entries in @code.
4329 \def\defcodeindex{\parsearg\newcodeindex}
4331 \def\newcodeindex#1{%
4332 \iflinks
4333 \expandafter\newwrite \csname#1indfile\endcsname
4334 \openout \csname#1indfile\endcsname \jobname.#1
4336 \expandafter\xdef\csname#1index\endcsname{%
4337 \noexpand\docodeindex{#1}}%
4341 % @synindex foo bar makes index foo feed into index bar.
4342 % Do this instead of @defindex foo if you don't want it as a separate index.
4344 % @syncodeindex foo bar similar, but put all entries made for index foo
4345 % inside @code.
4347 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4348 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4350 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4351 % #3 the target index (bar).
4352 \def\dosynindex#1#2#3{%
4353 % Only do \closeout if we haven't already done it, else we'll end up
4354 % closing the target index.
4355 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4356 % The \closeout helps reduce unnecessary open files; the limit on the
4357 % Acorn RISC OS is a mere 16 files.
4358 \expandafter\closeout\csname#2indfile\endcsname
4359 \expandafter\let\csname donesynindex#2\endcsname = 1
4361 % redefine \fooindfile:
4362 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4363 \expandafter\let\csname#2indfile\endcsname=\temp
4364 % redefine \fooindex:
4365 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4368 % Define \doindex, the driver for all \fooindex macros.
4369 % Argument #1 is generated by the calling \fooindex macro,
4370 % and it is "foo", the name of the index.
4372 % \doindex just uses \parsearg; it calls \doind for the actual work.
4373 % This is because \doind is more useful to call from other macros.
4375 % There is also \dosubind {index}{topic}{subtopic}
4376 % which makes an entry in a two-level index such as the operation index.
4378 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4379 \def\singleindexer #1{\doind{\indexname}{#1}}
4381 % like the previous two, but they put @code around the argument.
4382 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4383 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4385 % Take care of Texinfo commands that can appear in an index entry.
4386 % Since there are some commands we want to expand, and others we don't,
4387 % we have to laboriously prevent expansion for those that we don't.
4389 \def\indexdummies{%
4390 \escapechar = `\\ % use backslash in output files.
4391 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4392 \def\ {\realbackslash\space }%
4394 % Need these unexpandable (because we define \tt as a dummy)
4395 % definitions when @{ or @} appear in index entry text. Also, more
4396 % complicated, when \tex is in effect and \{ is a \delimiter again.
4397 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4398 % braces and backslashes are used only as delimiters. Perhaps we
4399 % should define @lbrace and @rbrace commands a la @comma.
4400 \def\{{{\tt\char123}}%
4401 \def\}{{\tt\char125}}%
4403 % I don't entirely understand this, but when an index entry is
4404 % generated from a macro call, the \endinput which \scanmacro inserts
4405 % causes processing to be prematurely terminated. This is,
4406 % apparently, because \indexsorttmp is fully expanded, and \endinput
4407 % is an expandable command. The redefinition below makes \endinput
4408 % disappear altogether for that purpose -- although logging shows that
4409 % processing continues to some further point. On the other hand, it
4410 % seems \endinput does not hurt in the printed index arg, since that
4411 % is still getting written without apparent harm.
4413 % Sample source (mac-idx3.tex, reported by Graham Percival to
4414 % help-texinfo, 22may06):
4415 % @macro funindex {WORD}
4416 % @findex xyz
4417 % @end macro
4418 % ...
4419 % @funindex commtest
4421 % The above is not enough to reproduce the bug, but it gives the flavor.
4423 % Sample whatsit resulting:
4424 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4426 % So:
4427 \let\endinput = \empty
4429 % Do the redefinitions.
4430 \commondummies
4433 % For the aux and toc files, @ is the escape character. So we want to
4434 % redefine everything using @ as the escape character (instead of
4435 % \realbackslash, still used for index files). When everything uses @,
4436 % this will be simpler.
4438 \def\atdummies{%
4439 \def\@{@@}%
4440 \def\ {@ }%
4441 \let\{ = \lbraceatcmd
4442 \let\} = \rbraceatcmd
4444 % Do the redefinitions.
4445 \commondummies
4446 \otherbackslash
4449 % Called from \indexdummies and \atdummies.
4451 \def\commondummies{%
4453 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4454 % preventing its expansion. This is used only for control words,
4455 % not control letters, because the \space would be incorrect for
4456 % control characters, but is needed to separate the control word
4457 % from whatever follows.
4459 % For control letters, we have \definedummyletter, which omits the
4460 % space.
4462 % These can be used both for control words that take an argument and
4463 % those that do not. If it is followed by {arg} in the input, then
4464 % that will dutifully get written to the index (or wherever).
4466 \def\definedummyword ##1{\def##1{\string##1\space}}%
4467 \def\definedummyletter##1{\def##1{\string##1}}%
4468 \let\definedummyaccent\definedummyletter
4470 \commondummiesnofonts
4472 \definedummyletter\_%
4473 \definedummyletter\-%
4475 % Non-English letters.
4476 \definedummyword\AA
4477 \definedummyword\AE
4478 \definedummyword\DH
4479 \definedummyword\L
4480 \definedummyword\O
4481 \definedummyword\OE
4482 \definedummyword\TH
4483 \definedummyword\aa
4484 \definedummyword\ae
4485 \definedummyword\dh
4486 \definedummyword\exclamdown
4487 \definedummyword\l
4488 \definedummyword\o
4489 \definedummyword\oe
4490 \definedummyword\ordf
4491 \definedummyword\ordm
4492 \definedummyword\questiondown
4493 \definedummyword\ss
4494 \definedummyword\th
4496 % Although these internal commands shouldn't show up, sometimes they do.
4497 \definedummyword\bf
4498 \definedummyword\gtr
4499 \definedummyword\hat
4500 \definedummyword\less
4501 \definedummyword\sf
4502 \definedummyword\sl
4503 \definedummyword\tclose
4504 \definedummyword\tt
4506 \definedummyword\LaTeX
4507 \definedummyword\TeX
4509 % Assorted special characters.
4510 \definedummyword\arrow
4511 \definedummyword\bullet
4512 \definedummyword\comma
4513 \definedummyword\copyright
4514 \definedummyword\registeredsymbol
4515 \definedummyword\dots
4516 \definedummyword\enddots
4517 \definedummyword\entrybreak
4518 \definedummyword\equiv
4519 \definedummyword\error
4520 \definedummyword\euro
4521 \definedummyword\expansion
4522 \definedummyword\geq
4523 \definedummyword\guillemetleft
4524 \definedummyword\guillemetright
4525 \definedummyword\guilsinglleft
4526 \definedummyword\guilsinglright
4527 \definedummyword\lbracechar
4528 \definedummyword\leq
4529 \definedummyword\minus
4530 \definedummyword\ogonek
4531 \definedummyword\pounds
4532 \definedummyword\point
4533 \definedummyword\print
4534 \definedummyword\quotedblbase
4535 \definedummyword\quotedblleft
4536 \definedummyword\quotedblright
4537 \definedummyword\quoteleft
4538 \definedummyword\quoteright
4539 \definedummyword\quotesinglbase
4540 \definedummyword\rbracechar
4541 \definedummyword\result
4542 \definedummyword\textdegree
4544 % We want to disable all macros so that they are not expanded by \write.
4545 \macrolist
4547 \normalturnoffactive
4549 % Handle some cases of @value -- where it does not contain any
4550 % (non-fully-expandable) commands.
4551 \makevalueexpandable
4554 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4556 \def\commondummiesnofonts{%
4557 % Control letters and accents.
4558 \definedummyletter\!%
4559 \definedummyaccent\"%
4560 \definedummyaccent\'%
4561 \definedummyletter\*%
4562 \definedummyaccent\,%
4563 \definedummyletter\.%
4564 \definedummyletter\/%
4565 \definedummyletter\:%
4566 \definedummyaccent\=%
4567 \definedummyletter\?%
4568 \definedummyaccent\^%
4569 \definedummyaccent\`%
4570 \definedummyaccent\~%
4571 \definedummyword\u
4572 \definedummyword\v
4573 \definedummyword\H
4574 \definedummyword\dotaccent
4575 \definedummyword\ogonek
4576 \definedummyword\ringaccent
4577 \definedummyword\tieaccent
4578 \definedummyword\ubaraccent
4579 \definedummyword\udotaccent
4580 \definedummyword\dotless
4582 % Texinfo font commands.
4583 \definedummyword\b
4584 \definedummyword\i
4585 \definedummyword\r
4586 \definedummyword\sansserif
4587 \definedummyword\sc
4588 \definedummyword\slanted
4589 \definedummyword\t
4591 % Commands that take arguments.
4592 \definedummyword\abbr
4593 \definedummyword\acronym
4594 \definedummyword\anchor
4595 \definedummyword\cite
4596 \definedummyword\code
4597 \definedummyword\command
4598 \definedummyword\dfn
4599 \definedummyword\dmn
4600 \definedummyword\email
4601 \definedummyword\emph
4602 \definedummyword\env
4603 \definedummyword\file
4604 \definedummyword\image
4605 \definedummyword\indicateurl
4606 \definedummyword\inforef
4607 \definedummyword\kbd
4608 \definedummyword\key
4609 \definedummyword\math
4610 \definedummyword\option
4611 \definedummyword\pxref
4612 \definedummyword\ref
4613 \definedummyword\samp
4614 \definedummyword\strong
4615 \definedummyword\tie
4616 \definedummyword\uref
4617 \definedummyword\url
4618 \definedummyword\var
4619 \definedummyword\verb
4620 \definedummyword\w
4621 \definedummyword\xref
4624 % \indexnofonts is used when outputting the strings to sort the index
4625 % by, and when constructing control sequence names. It eliminates all
4626 % control sequences and just writes whatever the best ASCII sort string
4627 % would be for a given command (usually its argument).
4629 \def\indexnofonts{%
4630 % Accent commands should become @asis.
4631 \def\definedummyaccent##1{\let##1\asis}%
4632 % We can just ignore other control letters.
4633 \def\definedummyletter##1{\let##1\empty}%
4634 % All control words become @asis by default; overrides below.
4635 \let\definedummyword\definedummyaccent
4637 \commondummiesnofonts
4639 % Don't no-op \tt, since it isn't a user-level command
4640 % and is used in the definitions of the active chars like <, >, |, etc.
4641 % Likewise with the other plain tex font commands.
4642 %\let\tt=\asis
4644 \def\ { }%
4645 \def\@{@}%
4646 \def\_{\normalunderscore}%
4647 \def\-{}% @- shouldn't affect sorting
4649 % Unfortunately, texindex is not prepared to handle braces in the
4650 % content at all. So for index sorting, we map @{ and @} to strings
4651 % starting with |, since that ASCII character is between ASCII { and }.
4652 \def\{{|a}%
4653 \def\lbracechar{|a}%
4655 \def\}{|b}%
4656 \def\rbracechar{|b}%
4658 % Non-English letters.
4659 \def\AA{AA}%
4660 \def\AE{AE}%
4661 \def\DH{DZZ}%
4662 \def\L{L}%
4663 \def\OE{OE}%
4664 \def\O{O}%
4665 \def\TH{ZZZ}%
4666 \def\aa{aa}%
4667 \def\ae{ae}%
4668 \def\dh{dzz}%
4669 \def\exclamdown{!}%
4670 \def\l{l}%
4671 \def\oe{oe}%
4672 \def\ordf{a}%
4673 \def\ordm{o}%
4674 \def\o{o}%
4675 \def\questiondown{?}%
4676 \def\ss{ss}%
4677 \def\th{zzz}%
4679 \def\LaTeX{LaTeX}%
4680 \def\TeX{TeX}%
4682 % Assorted special characters.
4683 % (The following {} will end up in the sort string, but that's ok.)
4684 \def\arrow{->}%
4685 \def\bullet{bullet}%
4686 \def\comma{,}%
4687 \def\copyright{copyright}%
4688 \def\dots{...}%
4689 \def\enddots{...}%
4690 \def\equiv{==}%
4691 \def\error{error}%
4692 \def\euro{euro}%
4693 \def\expansion{==>}%
4694 \def\geq{>=}%
4695 \def\guillemetleft{<<}%
4696 \def\guillemetright{>>}%
4697 \def\guilsinglleft{<}%
4698 \def\guilsinglright{>}%
4699 \def\leq{<=}%
4700 \def\minus{-}%
4701 \def\point{.}%
4702 \def\pounds{pounds}%
4703 \def\print{-|}%
4704 \def\quotedblbase{"}%
4705 \def\quotedblleft{"}%
4706 \def\quotedblright{"}%
4707 \def\quoteleft{`}%
4708 \def\quoteright{'}%
4709 \def\quotesinglbase{,}%
4710 \def\registeredsymbol{R}%
4711 \def\result{=>}%
4712 \def\textdegree{o}%
4714 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4715 \else \indexlquoteignore \fi
4717 % We need to get rid of all macros, leaving only the arguments (if present).
4718 % Of course this is not nearly correct, but it is the best we can do for now.
4719 % makeinfo does not expand macros in the argument to @deffn, which ends up
4720 % writing an index entry, and texindex isn't prepared for an index sort entry
4721 % that starts with \.
4723 % Since macro invocations are followed by braces, we can just redefine them
4724 % to take a single TeX argument. The case of a macro invocation that
4725 % goes to end-of-line is not handled.
4727 \macrolist
4730 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4731 % ignore left quotes in the sort term.
4732 {\catcode`\`=\active
4733 \gdef\indexlquoteignore{\let`=\empty}}
4735 \let\indexbackslash=0 %overridden during \printindex.
4736 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4738 % Most index entries go through here, but \dosubind is the general case.
4739 % #1 is the index name, #2 is the entry text.
4740 \def\doind#1#2{\dosubind{#1}{#2}{}}
4742 % Workhorse for all \fooindexes.
4743 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4744 % empty if called from \doind, as we usually are (the main exception
4745 % is with most defuns, which call us directly).
4747 \def\dosubind#1#2#3{%
4748 \iflinks
4750 % Store the main index entry text (including the third arg).
4751 \toks0 = {#2}%
4752 % If third arg is present, precede it with a space.
4753 \def\thirdarg{#3}%
4754 \ifx\thirdarg\empty \else
4755 \toks0 = \expandafter{\the\toks0 \space #3}%
4758 \edef\writeto{\csname#1indfile\endcsname}%
4760 \safewhatsit\dosubindwrite
4765 % Write the entry in \toks0 to the index file:
4767 \def\dosubindwrite{%
4768 % Put the index entry in the margin if desired.
4769 \ifx\SETmarginindex\relax\else
4770 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4773 % Remember, we are within a group.
4774 \indexdummies % Must do this here, since \bf, etc expand at this stage
4775 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4776 % so it will be output as is; and it will print as backslash.
4778 % Process the index entry with all font commands turned off, to
4779 % get the string to sort by.
4780 {\indexnofonts
4781 \edef\temp{\the\toks0}% need full expansion
4782 \xdef\indexsorttmp{\temp}%
4785 % Set up the complete index entry, with both the sort key and
4786 % the original text, including any font commands. We write
4787 % three arguments to \entry to the .?? file (four in the
4788 % subentry case), texindex reduces to two when writing the .??s
4789 % sorted result.
4790 \edef\temp{%
4791 \write\writeto{%
4792 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4794 \temp
4797 % Take care of unwanted page breaks/skips around a whatsit:
4799 % If a skip is the last thing on the list now, preserve it
4800 % by backing up by \lastskip, doing the \write, then inserting
4801 % the skip again. Otherwise, the whatsit generated by the
4802 % \write or \pdfdest will make \lastskip zero. The result is that
4803 % sequences like this:
4804 % @end defun
4805 % @tindex whatever
4806 % @defun ...
4807 % will have extra space inserted, because the \medbreak in the
4808 % start of the @defun won't see the skip inserted by the @end of
4809 % the previous defun.
4811 % But don't do any of this if we're not in vertical mode. We
4812 % don't want to do a \vskip and prematurely end a paragraph.
4814 % Avoid page breaks due to these extra skips, too.
4816 % But wait, there is a catch there:
4817 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4818 % sufficient for this purpose, as it ignores stretch and shrink parts
4819 % of the skip. The only way seems to be to check the textual
4820 % representation of the skip.
4822 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4823 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4825 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4827 \newskip\whatsitskip
4828 \newcount\whatsitpenalty
4830 % ..., ready, GO:
4832 \def\safewhatsit#1{\ifhmode
4834 \else
4835 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4836 \whatsitskip = \lastskip
4837 \edef\lastskipmacro{\the\lastskip}%
4838 \whatsitpenalty = \lastpenalty
4840 % If \lastskip is nonzero, that means the last item was a
4841 % skip. And since a skip is discardable, that means this
4842 % -\whatsitskip glue we're inserting is preceded by a
4843 % non-discardable item, therefore it is not a potential
4844 % breakpoint, therefore no \nobreak needed.
4845 \ifx\lastskipmacro\zeroskipmacro
4846 \else
4847 \vskip-\whatsitskip
4852 \ifx\lastskipmacro\zeroskipmacro
4853 % If \lastskip was zero, perhaps the last item was a penalty, and
4854 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4855 % to re-insert the same penalty (values >10000 are used for various
4856 % signals); since we just inserted a non-discardable item, any
4857 % following glue (such as a \parskip) would be a breakpoint. For example:
4858 % @deffn deffn-whatever
4859 % @vindex index-whatever
4860 % Description.
4861 % would allow a break between the index-whatever whatsit
4862 % and the "Description." paragraph.
4863 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4864 \else
4865 % On the other hand, if we had a nonzero \lastskip,
4866 % this make-up glue would be preceded by a non-discardable item
4867 % (the whatsit from the \write), so we must insert a \nobreak.
4868 \nobreak\vskip\whatsitskip
4870 \fi}
4872 % The index entry written in the file actually looks like
4873 % \entry {sortstring}{page}{topic}
4874 % or
4875 % \entry {sortstring}{page}{topic}{subtopic}
4876 % The texindex program reads in these files and writes files
4877 % containing these kinds of lines:
4878 % \initial {c}
4879 % before the first topic whose initial is c
4880 % \entry {topic}{pagelist}
4881 % for a topic that is used without subtopics
4882 % \primary {topic}
4883 % for the beginning of a topic that is used with subtopics
4884 % \secondary {subtopic}{pagelist}
4885 % for each subtopic.
4887 % Define the user-accessible indexing commands
4888 % @findex, @vindex, @kindex, @cindex.
4890 \def\findex {\fnindex}
4891 \def\kindex {\kyindex}
4892 \def\cindex {\cpindex}
4893 \def\vindex {\vrindex}
4894 \def\tindex {\tpindex}
4895 \def\pindex {\pgindex}
4897 \def\cindexsub {\begingroup\obeylines\cindexsub}
4898 {\obeylines %
4899 \gdef\cindexsub "#1" #2^^M{\endgroup %
4900 \dosubind{cp}{#2}{#1}}}
4902 % Define the macros used in formatting output of the sorted index material.
4904 % @printindex causes a particular index (the ??s file) to get printed.
4905 % It does not print any chapter heading (usually an @unnumbered).
4907 \parseargdef\printindex{\begingroup
4908 \dobreak \chapheadingskip{10000}%
4910 \smallfonts \rm
4911 \tolerance = 9500
4912 \plainfrenchspacing
4913 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4915 % See if the index file exists and is nonempty.
4916 % Change catcode of @ here so that if the index file contains
4917 % \initial {@}
4918 % as its first line, TeX doesn't complain about mismatched braces
4919 % (because it thinks @} is a control sequence).
4920 \catcode`\@ = 11
4921 \openin 1 \jobname.#1s
4922 \ifeof 1
4923 % \enddoublecolumns gets confused if there is no text in the index,
4924 % and it loses the chapter title and the aux file entries for the
4925 % index. The easiest way to prevent this problem is to make sure
4926 % there is some text.
4927 \putwordIndexNonexistent
4928 \else
4930 % If the index file exists but is empty, then \openin leaves \ifeof
4931 % false. We have to make TeX try to read something from the file, so
4932 % it can discover if there is anything in it.
4933 \read 1 to \temp
4934 \ifeof 1
4935 \putwordIndexIsEmpty
4936 \else
4937 % Index files are almost Texinfo source, but we use \ as the escape
4938 % character. It would be better to use @, but that's too big a change
4939 % to make right now.
4940 \def\indexbackslash{\backslashcurfont}%
4941 \catcode`\\ = 0
4942 \escapechar = `\\
4943 \begindoublecolumns
4944 \input \jobname.#1s
4945 \enddoublecolumns
4948 \closein 1
4949 \endgroup}
4951 % These macros are used by the sorted index file itself.
4952 % Change them to control the appearance of the index.
4954 \def\initial#1{{%
4955 % Some minor font changes for the special characters.
4956 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4958 % Remove any glue we may have, we'll be inserting our own.
4959 \removelastskip
4961 % We like breaks before the index initials, so insert a bonus.
4962 \nobreak
4963 \vskip 0pt plus 3\baselineskip
4964 \penalty 0
4965 \vskip 0pt plus -3\baselineskip
4967 % Typeset the initial. Making this add up to a whole number of
4968 % baselineskips increases the chance of the dots lining up from column
4969 % to column. It still won't often be perfect, because of the stretch
4970 % we need before each entry, but it's better.
4972 % No shrink because it confuses \balancecolumns.
4973 \vskip 1.67\baselineskip plus .5\baselineskip
4974 \leftline{\secbf #1}%
4975 % Do our best not to break after the initial.
4976 \nobreak
4977 \vskip .33\baselineskip plus .1\baselineskip
4980 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4981 % then page number (#2) flushed to the right margin. It is used for index
4982 % and table of contents entries. The paragraph is indented by \leftskip.
4984 % A straightforward implementation would start like this:
4985 % \def\entry#1#2{...
4986 % But this freezes the catcodes in the argument, and can cause problems to
4987 % @code, which sets - active. This problem was fixed by a kludge---
4988 % ``-'' was active throughout whole index, but this isn't really right.
4989 % The right solution is to prevent \entry from swallowing the whole text.
4990 % --kasal, 21nov03
4991 \def\entry{%
4992 \begingroup
4994 % Start a new paragraph if necessary, so our assignments below can't
4995 % affect previous text.
4996 \par
4998 % Do not fill out the last line with white space.
4999 \parfillskip = 0in
5001 % No extra space above this paragraph.
5002 \parskip = 0in
5004 % Do not prefer a separate line ending with a hyphen to fewer lines.
5005 \finalhyphendemerits = 0
5007 % \hangindent is only relevant when the entry text and page number
5008 % don't both fit on one line. In that case, bob suggests starting the
5009 % dots pretty far over on the line. Unfortunately, a large
5010 % indentation looks wrong when the entry text itself is broken across
5011 % lines. So we use a small indentation and put up with long leaders.
5013 % \hangafter is reset to 1 (which is the value we want) at the start
5014 % of each paragraph, so we need not do anything with that.
5015 \hangindent = 2em
5017 % When the entry text needs to be broken, just fill out the first line
5018 % with blank space.
5019 \rightskip = 0pt plus1fil
5021 % A bit of stretch before each entry for the benefit of balancing
5022 % columns.
5023 \vskip 0pt plus1pt
5025 % When reading the text of entry, convert explicit line breaks
5026 % from @* into spaces. The user might give these in long section
5027 % titles, for instance.
5028 \def\*{\unskip\space\ignorespaces}%
5029 \def\entrybreak{\hfil\break}%
5031 % Swallow the left brace of the text (first parameter):
5032 \afterassignment\doentry
5033 \let\temp =
5035 \def\entrybreak{\unskip\space\ignorespaces}%
5036 \def\doentry{%
5037 \bgroup % Instead of the swallowed brace.
5038 \noindent
5039 \aftergroup\finishentry
5040 % And now comes the text of the entry.
5042 \def\finishentry#1{%
5043 % #1 is the page number.
5045 % The following is kludged to not output a line of dots in the index if
5046 % there are no page numbers. The next person who breaks this will be
5047 % cursed by a Unix daemon.
5048 \setbox\boxA = \hbox{#1}%
5049 \ifdim\wd\boxA = 0pt
5051 \else
5053 % If we must, put the page number on a line of its own, and fill out
5054 % this line with blank space. (The \hfil is overwhelmed with the
5055 % fill leaders glue in \indexdotfill if the page number does fit.)
5056 \hfil\penalty50
5057 \null\nobreak\indexdotfill % Have leaders before the page number.
5059 % The `\ ' here is removed by the implicit \unskip that TeX does as
5060 % part of (the primitive) \par. Without it, a spurious underfull
5061 % \hbox ensues.
5062 \ifpdf
5063 \pdfgettoks#1.%
5064 \ \the\toksA
5065 \else
5066 \ #1%
5069 \par
5070 \endgroup
5073 % Like plain.tex's \dotfill, except uses up at least 1 em.
5074 \def\indexdotfill{\cleaders
5075 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
5077 \def\primary #1{\line{#1\hfil}}
5079 \newskip\secondaryindent \secondaryindent=0.5cm
5080 \def\secondary#1#2{{%
5081 \parfillskip=0in
5082 \parskip=0in
5083 \hangindent=1in
5084 \hangafter=1
5085 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5086 \ifpdf
5087 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
5088 \else
5091 \par
5094 % Define two-column mode, which we use to typeset indexes.
5095 % Adapted from the TeXbook, page 416, which is to say,
5096 % the manmac.tex format used to print the TeXbook itself.
5097 \catcode`\@=11
5099 \newbox\partialpage
5100 \newdimen\doublecolumnhsize
5102 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5103 % Grab any single-column material above us.
5104 \output = {%
5106 % Here is a possibility not foreseen in manmac: if we accumulate a
5107 % whole lot of material, we might end up calling this \output
5108 % routine twice in a row (see the doublecol-lose test, which is
5109 % essentially a couple of indexes with @setchapternewpage off). In
5110 % that case we just ship out what is in \partialpage with the normal
5111 % output routine. Generally, \partialpage will be empty when this
5112 % runs and this will be a no-op. See the indexspread.tex test case.
5113 \ifvoid\partialpage \else
5114 \onepageout{\pagecontents\partialpage}%
5117 \global\setbox\partialpage = \vbox{%
5118 % Unvbox the main output page.
5119 \unvbox\PAGE
5120 \kern-\topskip \kern\baselineskip
5123 \eject % run that output routine to set \partialpage
5125 % Use the double-column output routine for subsequent pages.
5126 \output = {\doublecolumnout}%
5128 % Change the page size parameters. We could do this once outside this
5129 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5130 % format, but then we repeat the same computation. Repeating a couple
5131 % of assignments once per index is clearly meaningless for the
5132 % execution time, so we may as well do it in one place.
5134 % First we halve the line length, less a little for the gutter between
5135 % the columns. We compute the gutter based on the line length, so it
5136 % changes automatically with the paper format. The magic constant
5137 % below is chosen so that the gutter has the same value (well, +-<1pt)
5138 % as it did when we hard-coded it.
5140 % We put the result in a separate register, \doublecolumhsize, so we
5141 % can restore it in \pagesofar, after \hsize itself has (potentially)
5142 % been clobbered.
5144 \doublecolumnhsize = \hsize
5145 \advance\doublecolumnhsize by -.04154\hsize
5146 \divide\doublecolumnhsize by 2
5147 \hsize = \doublecolumnhsize
5149 % Double the \vsize as well. (We don't need a separate register here,
5150 % since nobody clobbers \vsize.)
5151 \vsize = 2\vsize
5154 % The double-column output routine for all double-column pages except
5155 % the last.
5157 \def\doublecolumnout{%
5158 \splittopskip=\topskip \splitmaxdepth=\maxdepth
5159 % Get the available space for the double columns -- the normal
5160 % (undoubled) page height minus any material left over from the
5161 % previous page.
5162 \dimen@ = \vsize
5163 \divide\dimen@ by 2
5164 \advance\dimen@ by -\ht\partialpage
5166 % box0 will be the left-hand column, box2 the right.
5167 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
5168 \onepageout\pagesofar
5169 \unvbox255
5170 \penalty\outputpenalty
5173 % Re-output the contents of the output page -- any previous material,
5174 % followed by the two boxes we just split, in box0 and box2.
5175 \def\pagesofar{%
5176 \unvbox\partialpage
5178 \hsize = \doublecolumnhsize
5179 \wd0=\hsize \wd2=\hsize
5180 \hbox to\pagewidth{\box0\hfil\box2}%
5183 % All done with double columns.
5184 \def\enddoublecolumns{%
5185 % The following penalty ensures that the page builder is exercised
5186 % _before_ we change the output routine. This is necessary in the
5187 % following situation:
5189 % The last section of the index consists only of a single entry.
5190 % Before this section, \pagetotal is less than \pagegoal, so no
5191 % break occurs before the last section starts. However, the last
5192 % section, consisting of \initial and the single \entry, does not
5193 % fit on the page and has to be broken off. Without the following
5194 % penalty the page builder will not be exercised until \eject
5195 % below, and by that time we'll already have changed the output
5196 % routine to the \balancecolumns version, so the next-to-last
5197 % double-column page will be processed with \balancecolumns, which
5198 % is wrong: The two columns will go to the main vertical list, with
5199 % the broken-off section in the recent contributions. As soon as
5200 % the output routine finishes, TeX starts reconsidering the page
5201 % break. The two columns and the broken-off section both fit on the
5202 % page, because the two columns now take up only half of the page
5203 % goal. When TeX sees \eject from below which follows the final
5204 % section, it invokes the new output routine that we've set after
5205 % \balancecolumns below; \onepageout will try to fit the two columns
5206 % and the final section into the vbox of \pageheight (see
5207 % \pagebody), causing an overfull box.
5209 % Note that glue won't work here, because glue does not exercise the
5210 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5211 \penalty0
5213 \output = {%
5214 % Split the last of the double-column material. Leave it on the
5215 % current page, no automatic page break.
5216 \balancecolumns
5218 % If we end up splitting too much material for the current page,
5219 % though, there will be another page break right after this \output
5220 % invocation ends. Having called \balancecolumns once, we do not
5221 % want to call it again. Therefore, reset \output to its normal
5222 % definition right away. (We hope \balancecolumns will never be
5223 % called on to balance too much material, but if it is, this makes
5224 % the output somewhat more palatable.)
5225 \global\output = {\onepageout{\pagecontents\PAGE}}%
5227 \eject
5228 \endgroup % started in \begindoublecolumns
5230 % \pagegoal was set to the doubled \vsize above, since we restarted
5231 % the current page. We're now back to normal single-column
5232 % typesetting, so reset \pagegoal to the normal \vsize (after the
5233 % \endgroup where \vsize got restored).
5234 \pagegoal = \vsize
5237 % Called at the end of the double column material.
5238 \def\balancecolumns{%
5239 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5240 \dimen@ = \ht0
5241 \advance\dimen@ by \topskip
5242 \advance\dimen@ by-\baselineskip
5243 \divide\dimen@ by 2 % target to split to
5244 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5245 \splittopskip = \topskip
5246 % Loop until we get a decent breakpoint.
5248 \vbadness = 10000
5249 \loop
5250 \global\setbox3 = \copy0
5251 \global\setbox1 = \vsplit3 to \dimen@
5252 \ifdim\ht3>\dimen@
5253 \global\advance\dimen@ by 1pt
5254 \repeat
5256 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5257 \setbox0=\vbox to\dimen@{\unvbox1}%
5258 \setbox2=\vbox to\dimen@{\unvbox3}%
5260 \pagesofar
5262 \catcode`\@ = \other
5265 \message{sectioning,}
5266 % Chapters, sections, etc.
5268 % Let's start with @part.
5269 \outer\parseargdef\part{\partzzz{#1}}
5270 \def\partzzz#1{%
5271 \chapoddpage
5272 \null
5273 \vskip.3\vsize % move it down on the page a bit
5274 \begingroup
5275 \noindent \titlefonts\rmisbold #1\par % the text
5276 \let\lastnode=\empty % no node to associate with
5277 \writetocentry{part}{#1}{}% but put it in the toc
5278 \headingsoff % no headline or footline on the part page
5279 \chapoddpage
5280 \endgroup
5283 % \unnumberedno is an oxymoron. But we count the unnumbered
5284 % sections so that we can refer to them unambiguously in the pdf
5285 % outlines by their "section number". We avoid collisions with chapter
5286 % numbers by starting them at 10000. (If a document ever has 10000
5287 % chapters, we're in trouble anyway, I'm sure.)
5288 \newcount\unnumberedno \unnumberedno = 10000
5289 \newcount\chapno
5290 \newcount\secno \secno=0
5291 \newcount\subsecno \subsecno=0
5292 \newcount\subsubsecno \subsubsecno=0
5294 % This counter is funny since it counts through charcodes of letters A, B, ...
5295 \newcount\appendixno \appendixno = `\@
5297 % \def\appendixletter{\char\the\appendixno}
5298 % We do the following ugly conditional instead of the above simple
5299 % construct for the sake of pdftex, which needs the actual
5300 % letter in the expansion, not just typeset.
5302 \def\appendixletter{%
5303 \ifnum\appendixno=`A A%
5304 \else\ifnum\appendixno=`B B%
5305 \else\ifnum\appendixno=`C C%
5306 \else\ifnum\appendixno=`D D%
5307 \else\ifnum\appendixno=`E E%
5308 \else\ifnum\appendixno=`F F%
5309 \else\ifnum\appendixno=`G G%
5310 \else\ifnum\appendixno=`H H%
5311 \else\ifnum\appendixno=`I I%
5312 \else\ifnum\appendixno=`J J%
5313 \else\ifnum\appendixno=`K K%
5314 \else\ifnum\appendixno=`L L%
5315 \else\ifnum\appendixno=`M M%
5316 \else\ifnum\appendixno=`N N%
5317 \else\ifnum\appendixno=`O O%
5318 \else\ifnum\appendixno=`P P%
5319 \else\ifnum\appendixno=`Q Q%
5320 \else\ifnum\appendixno=`R R%
5321 \else\ifnum\appendixno=`S S%
5322 \else\ifnum\appendixno=`T T%
5323 \else\ifnum\appendixno=`U U%
5324 \else\ifnum\appendixno=`V V%
5325 \else\ifnum\appendixno=`W W%
5326 \else\ifnum\appendixno=`X X%
5327 \else\ifnum\appendixno=`Y Y%
5328 \else\ifnum\appendixno=`Z Z%
5329 % The \the is necessary, despite appearances, because \appendixletter is
5330 % expanded while writing the .toc file. \char\appendixno is not
5331 % expandable, thus it is written literally, thus all appendixes come out
5332 % with the same letter (or @) in the toc without it.
5333 \else\char\the\appendixno
5334 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5335 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5337 % Each @chapter defines these (using marks) as the number+name, number
5338 % and name of the chapter. Page headings and footings can use
5339 % these. @section does likewise.
5340 \def\thischapter{}
5341 \def\thischapternum{}
5342 \def\thischaptername{}
5343 \def\thissection{}
5344 \def\thissectionnum{}
5345 \def\thissectionname{}
5347 \newcount\absseclevel % used to calculate proper heading level
5348 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5350 % @raisesections: treat @section as chapter, @subsection as section, etc.
5351 \def\raisesections{\global\advance\secbase by -1}
5352 \let\up=\raisesections % original BFox name
5354 % @lowersections: treat @chapter as section, @section as subsection, etc.
5355 \def\lowersections{\global\advance\secbase by 1}
5356 \let\down=\lowersections % original BFox name
5358 % we only have subsub.
5359 \chardef\maxseclevel = 3
5361 % A numbered section within an unnumbered changes to unnumbered too.
5362 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5363 \chardef\unnlevel = \maxseclevel
5365 % Trace whether the current chapter is an appendix or not:
5366 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5367 \def\chapheadtype{N}
5369 % Choose a heading macro
5370 % #1 is heading type
5371 % #2 is heading level
5372 % #3 is text for heading
5373 \def\genhead#1#2#3{%
5374 % Compute the abs. sec. level:
5375 \absseclevel=#2
5376 \advance\absseclevel by \secbase
5377 % Make sure \absseclevel doesn't fall outside the range:
5378 \ifnum \absseclevel < 0
5379 \absseclevel = 0
5380 \else
5381 \ifnum \absseclevel > 3
5382 \absseclevel = 3
5385 % The heading type:
5386 \def\headtype{#1}%
5387 \if \headtype U%
5388 \ifnum \absseclevel < \unnlevel
5389 \chardef\unnlevel = \absseclevel
5391 \else
5392 % Check for appendix sections:
5393 \ifnum \absseclevel = 0
5394 \edef\chapheadtype{\headtype}%
5395 \else
5396 \if \headtype A\if \chapheadtype N%
5397 \errmessage{@appendix... within a non-appendix chapter}%
5398 \fi\fi
5400 % Check for numbered within unnumbered:
5401 \ifnum \absseclevel > \unnlevel
5402 \def\headtype{U}%
5403 \else
5404 \chardef\unnlevel = 3
5407 % Now print the heading:
5408 \if \headtype U%
5409 \ifcase\absseclevel
5410 \unnumberedzzz{#3}%
5411 \or \unnumberedseczzz{#3}%
5412 \or \unnumberedsubseczzz{#3}%
5413 \or \unnumberedsubsubseczzz{#3}%
5415 \else
5416 \if \headtype A%
5417 \ifcase\absseclevel
5418 \appendixzzz{#3}%
5419 \or \appendixsectionzzz{#3}%
5420 \or \appendixsubseczzz{#3}%
5421 \or \appendixsubsubseczzz{#3}%
5423 \else
5424 \ifcase\absseclevel
5425 \chapterzzz{#3}%
5426 \or \seczzz{#3}%
5427 \or \numberedsubseczzz{#3}%
5428 \or \numberedsubsubseczzz{#3}%
5432 \suppressfirstparagraphindent
5435 % an interface:
5436 \def\numhead{\genhead N}
5437 \def\apphead{\genhead A}
5438 \def\unnmhead{\genhead U}
5440 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5441 % all lower-level sectioning counters to zero.
5443 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5444 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5445 \let\chaplevelprefix = \empty
5447 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5448 \def\chapterzzz#1{%
5449 % section resetting is \global in case the chapter is in a group, such
5450 % as an @include file.
5451 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5452 \global\advance\chapno by 1
5454 % Used for \float.
5455 \gdef\chaplevelprefix{\the\chapno.}%
5456 \resetallfloatnos
5458 % \putwordChapter can contain complex things in translations.
5459 \toks0=\expandafter{\putwordChapter}%
5460 \message{\the\toks0 \space \the\chapno}%
5462 % Write the actual heading.
5463 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5465 % So @section and the like are numbered underneath this chapter.
5466 \global\let\section = \numberedsec
5467 \global\let\subsection = \numberedsubsec
5468 \global\let\subsubsection = \numberedsubsubsec
5471 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5473 \def\appendixzzz#1{%
5474 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5475 \global\advance\appendixno by 1
5476 \gdef\chaplevelprefix{\appendixletter.}%
5477 \resetallfloatnos
5479 % \putwordAppendix can contain complex things in translations.
5480 \toks0=\expandafter{\putwordAppendix}%
5481 \message{\the\toks0 \space \appendixletter}%
5483 \chapmacro{#1}{Yappendix}{\appendixletter}%
5485 \global\let\section = \appendixsec
5486 \global\let\subsection = \appendixsubsec
5487 \global\let\subsubsection = \appendixsubsubsec
5490 % normally unnmhead0 calls unnumberedzzz:
5491 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5492 \def\unnumberedzzz#1{%
5493 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5494 \global\advance\unnumberedno by 1
5496 % Since an unnumbered has no number, no prefix for figures.
5497 \global\let\chaplevelprefix = \empty
5498 \resetallfloatnos
5500 % This used to be simply \message{#1}, but TeX fully expands the
5501 % argument to \message. Therefore, if #1 contained @-commands, TeX
5502 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5503 % expanded @cite (which turns out to cause errors because \cite is meant
5504 % to be executed, not expanded).
5506 % Anyway, we don't want the fully-expanded definition of @cite to appear
5507 % as a result of the \message, we just want `@cite' itself. We use
5508 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5509 % simply yielding the contents of <toks register>. (We also do this for
5510 % the toc entries.)
5511 \toks0 = {#1}%
5512 \message{(\the\toks0)}%
5514 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5516 \global\let\section = \unnumberedsec
5517 \global\let\subsection = \unnumberedsubsec
5518 \global\let\subsubsection = \unnumberedsubsubsec
5521 % @centerchap is like @unnumbered, but the heading is centered.
5522 \outer\parseargdef\centerchap{%
5523 % Well, we could do the following in a group, but that would break
5524 % an assumption that \chapmacro is called at the outermost level.
5525 % Thus we are safer this way: --kasal, 24feb04
5526 \let\centerparametersmaybe = \centerparameters
5527 \unnmhead0{#1}%
5528 \let\centerparametersmaybe = \relax
5531 % @top is like @unnumbered.
5532 \let\top\unnumbered
5534 % Sections.
5536 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5537 \def\seczzz#1{%
5538 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5539 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5542 % normally calls appendixsectionzzz:
5543 \outer\parseargdef\appendixsection{\apphead1{#1}}
5544 \def\appendixsectionzzz#1{%
5545 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5546 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5548 \let\appendixsec\appendixsection
5550 % normally calls unnumberedseczzz:
5551 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5552 \def\unnumberedseczzz#1{%
5553 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5554 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5557 % Subsections.
5559 % normally calls numberedsubseczzz:
5560 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5561 \def\numberedsubseczzz#1{%
5562 \global\subsubsecno=0 \global\advance\subsecno by 1
5563 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5566 % normally calls appendixsubseczzz:
5567 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5568 \def\appendixsubseczzz#1{%
5569 \global\subsubsecno=0 \global\advance\subsecno by 1
5570 \sectionheading{#1}{subsec}{Yappendix}%
5571 {\appendixletter.\the\secno.\the\subsecno}%
5574 % normally calls unnumberedsubseczzz:
5575 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5576 \def\unnumberedsubseczzz#1{%
5577 \global\subsubsecno=0 \global\advance\subsecno by 1
5578 \sectionheading{#1}{subsec}{Ynothing}%
5579 {\the\unnumberedno.\the\secno.\the\subsecno}%
5582 % Subsubsections.
5584 % normally numberedsubsubseczzz:
5585 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5586 \def\numberedsubsubseczzz#1{%
5587 \global\advance\subsubsecno by 1
5588 \sectionheading{#1}{subsubsec}{Ynumbered}%
5589 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5592 % normally appendixsubsubseczzz:
5593 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5594 \def\appendixsubsubseczzz#1{%
5595 \global\advance\subsubsecno by 1
5596 \sectionheading{#1}{subsubsec}{Yappendix}%
5597 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5600 % normally unnumberedsubsubseczzz:
5601 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5602 \def\unnumberedsubsubseczzz#1{%
5603 \global\advance\subsubsecno by 1
5604 \sectionheading{#1}{subsubsec}{Ynothing}%
5605 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5608 % These macros control what the section commands do, according
5609 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5610 % Define them by default for a numbered chapter.
5611 \let\section = \numberedsec
5612 \let\subsection = \numberedsubsec
5613 \let\subsubsection = \numberedsubsubsec
5615 % Define @majorheading, @heading and @subheading
5617 \def\majorheading{%
5618 {\advance\chapheadingskip by 10pt \chapbreak }%
5619 \parsearg\chapheadingzzz
5622 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5623 \def\chapheadingzzz#1{%
5624 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5625 \nobreak\bigskip \nobreak
5626 \suppressfirstparagraphindent
5629 % @heading, @subheading, @subsubheading.
5630 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5631 \suppressfirstparagraphindent}
5632 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5633 \suppressfirstparagraphindent}
5634 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5635 \suppressfirstparagraphindent}
5637 % These macros generate a chapter, section, etc. heading only
5638 % (including whitespace, linebreaking, etc. around it),
5639 % given all the information in convenient, parsed form.
5641 % Args are the skip and penalty (usually negative)
5642 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5644 % Parameter controlling skip before chapter headings (if needed)
5645 \newskip\chapheadingskip
5647 % Define plain chapter starts, and page on/off switching for it.
5648 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5649 \def\chappager{\par\vfill\supereject}
5650 % Because \domark is called before \chapoddpage, the filler page will
5651 % get the headings for the next chapter, which is wrong. But we don't
5652 % care -- we just disable all headings on the filler page.
5653 \def\chapoddpage{%
5654 \chappager
5655 \ifodd\pageno \else
5656 \begingroup
5657 \headingsoff
5658 \null
5659 \chappager
5660 \endgroup
5664 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5666 \def\CHAPPAGoff{%
5667 \global\let\contentsalignmacro = \chappager
5668 \global\let\pchapsepmacro=\chapbreak
5669 \global\let\pagealignmacro=\chappager}
5671 \def\CHAPPAGon{%
5672 \global\let\contentsalignmacro = \chappager
5673 \global\let\pchapsepmacro=\chappager
5674 \global\let\pagealignmacro=\chappager
5675 \global\def\HEADINGSon{\HEADINGSsingle}}
5677 \def\CHAPPAGodd{%
5678 \global\let\contentsalignmacro = \chapoddpage
5679 \global\let\pchapsepmacro=\chapoddpage
5680 \global\let\pagealignmacro=\chapoddpage
5681 \global\def\HEADINGSon{\HEADINGSdouble}}
5683 \CHAPPAGon
5685 % Chapter opening.
5687 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5688 % Yappendix, Yomitfromtoc), #3 the chapter number.
5690 % To test against our argument.
5691 \def\Ynothingkeyword{Ynothing}
5692 \def\Yomitfromtockeyword{Yomitfromtoc}
5693 \def\Yappendixkeyword{Yappendix}
5695 \def\chapmacro#1#2#3{%
5696 % Insert the first mark before the heading break (see notes for \domark).
5697 \let\prevchapterdefs=\lastchapterdefs
5698 \let\prevsectiondefs=\lastsectiondefs
5699 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5700 \gdef\thissection{}}%
5702 \def\temptype{#2}%
5703 \ifx\temptype\Ynothingkeyword
5704 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5705 \gdef\thischapter{\thischaptername}}%
5706 \else\ifx\temptype\Yomitfromtockeyword
5707 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5708 \gdef\thischapter{}}%
5709 \else\ifx\temptype\Yappendixkeyword
5710 \toks0={#1}%
5711 \xdef\lastchapterdefs{%
5712 \gdef\noexpand\thischaptername{\the\toks0}%
5713 \gdef\noexpand\thischapternum{\appendixletter}%
5714 % \noexpand\putwordAppendix avoids expanding indigestible
5715 % commands in some of the translations.
5716 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5717 \noexpand\thischapternum:
5718 \noexpand\thischaptername}%
5720 \else
5721 \toks0={#1}%
5722 \xdef\lastchapterdefs{%
5723 \gdef\noexpand\thischaptername{\the\toks0}%
5724 \gdef\noexpand\thischapternum{\the\chapno}%
5725 % \noexpand\putwordChapter avoids expanding indigestible
5726 % commands in some of the translations.
5727 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5728 \noexpand\thischapternum:
5729 \noexpand\thischaptername}%
5731 \fi\fi\fi
5733 % Output the mark. Pass it through \safewhatsit, to take care of
5734 % the preceding space.
5735 \safewhatsit\domark
5737 % Insert the chapter heading break.
5738 \pchapsepmacro
5740 % Now the second mark, after the heading break. No break points
5741 % between here and the heading.
5742 \let\prevchapterdefs=\lastchapterdefs
5743 \let\prevsectiondefs=\lastsectiondefs
5744 \domark
5747 \chapfonts \rmisbold
5749 % Have to define \lastsection before calling \donoderef, because the
5750 % xref code eventually uses it. On the other hand, it has to be called
5751 % after \pchapsepmacro, or the headline will change too soon.
5752 \gdef\lastsection{#1}%
5754 % Only insert the separating space if we have a chapter/appendix
5755 % number, and don't print the unnumbered ``number''.
5756 \ifx\temptype\Ynothingkeyword
5757 \setbox0 = \hbox{}%
5758 \def\toctype{unnchap}%
5759 \else\ifx\temptype\Yomitfromtockeyword
5760 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5761 \def\toctype{omit}%
5762 \else\ifx\temptype\Yappendixkeyword
5763 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5764 \def\toctype{app}%
5765 \else
5766 \setbox0 = \hbox{#3\enspace}%
5767 \def\toctype{numchap}%
5768 \fi\fi\fi
5770 % Write the toc entry for this chapter. Must come before the
5771 % \donoderef, because we include the current node name in the toc
5772 % entry, and \donoderef resets it to empty.
5773 \writetocentry{\toctype}{#1}{#3}%
5775 % For pdftex, we have to write out the node definition (aka, make
5776 % the pdfdest) after any page break, but before the actual text has
5777 % been typeset. If the destination for the pdf outline is after the
5778 % text, then jumping from the outline may wind up with the text not
5779 % being visible, for instance under high magnification.
5780 \donoderef{#2}%
5782 % Typeset the actual heading.
5783 \nobreak % Avoid page breaks at the interline glue.
5784 \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe
5785 \unhbox0 #1\par}%
5787 \nobreak\bigskip % no page break after a chapter title
5788 \nobreak
5791 % @centerchap -- centered and unnumbered.
5792 \let\centerparametersmaybe = \relax
5793 \def\centerparameters{%
5794 \advance\rightskip by 3\rightskip
5795 \leftskip = \rightskip
5796 \parfillskip = 0pt
5800 % I don't think this chapter style is supported any more, so I'm not
5801 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5803 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5805 \def\unnchfopen #1{%
5806 \chapoddpage
5807 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5808 \nobreak\bigskip\nobreak
5810 \def\chfopen #1#2{\chapoddpage {\chapfonts
5811 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5812 \par\penalty 5000 %
5814 \def\centerchfopen #1{%
5815 \chapoddpage
5816 \vbox{\chapfonts \raggedtitlesettings \hfill #1\hfill}%
5817 \nobreak\bigskip \nobreak
5819 \def\CHAPFopen{%
5820 \global\let\chapmacro=\chfopen
5821 \global\let\centerchapmacro=\centerchfopen}
5824 % Section titles. These macros combine the section number parts and
5825 % call the generic \sectionheading to do the printing.
5827 \newskip\secheadingskip
5828 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5830 % Subsection titles.
5831 \newskip\subsecheadingskip
5832 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5834 % Subsubsection titles.
5835 \def\subsubsecheadingskip{\subsecheadingskip}
5836 \def\subsubsecheadingbreak{\subsecheadingbreak}
5839 % Print any size, any type, section title.
5841 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5842 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5843 % section number.
5845 \def\seckeyword{sec}
5847 \def\sectionheading#1#2#3#4{%
5849 \checkenv{}% should not be in an environment.
5851 % Switch to the right set of fonts.
5852 \csname #2fonts\endcsname \rmisbold
5854 \def\sectionlevel{#2}%
5855 \def\temptype{#3}%
5857 % Insert first mark before the heading break (see notes for \domark).
5858 \let\prevsectiondefs=\lastsectiondefs
5859 \ifx\temptype\Ynothingkeyword
5860 \ifx\sectionlevel\seckeyword
5861 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5862 \gdef\thissection{\thissectionname}}%
5864 \else\ifx\temptype\Yomitfromtockeyword
5865 % Don't redefine \thissection.
5866 \else\ifx\temptype\Yappendixkeyword
5867 \ifx\sectionlevel\seckeyword
5868 \toks0={#1}%
5869 \xdef\lastsectiondefs{%
5870 \gdef\noexpand\thissectionname{\the\toks0}%
5871 \gdef\noexpand\thissectionnum{#4}%
5872 % \noexpand\putwordSection avoids expanding indigestible
5873 % commands in some of the translations.
5874 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5875 \noexpand\thissectionnum:
5876 \noexpand\thissectionname}%
5879 \else
5880 \ifx\sectionlevel\seckeyword
5881 \toks0={#1}%
5882 \xdef\lastsectiondefs{%
5883 \gdef\noexpand\thissectionname{\the\toks0}%
5884 \gdef\noexpand\thissectionnum{#4}%
5885 % \noexpand\putwordSection avoids expanding indigestible
5886 % commands in some of the translations.
5887 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5888 \noexpand\thissectionnum:
5889 \noexpand\thissectionname}%
5892 \fi\fi\fi
5894 % Go into vertical mode. Usually we'll already be there, but we
5895 % don't want the following whatsit to end up in a preceding paragraph
5896 % if the document didn't happen to have a blank line.
5897 \par
5899 % Output the mark. Pass it through \safewhatsit, to take care of
5900 % the preceding space.
5901 \safewhatsit\domark
5903 % Insert space above the heading.
5904 \csname #2headingbreak\endcsname
5906 % Now the second mark, after the heading break. No break points
5907 % between here and the heading.
5908 \let\prevsectiondefs=\lastsectiondefs
5909 \domark
5911 % Only insert the space after the number if we have a section number.
5912 \ifx\temptype\Ynothingkeyword
5913 \setbox0 = \hbox{}%
5914 \def\toctype{unn}%
5915 \gdef\lastsection{#1}%
5916 \else\ifx\temptype\Yomitfromtockeyword
5917 % for @headings -- no section number, don't include in toc,
5918 % and don't redefine \lastsection.
5919 \setbox0 = \hbox{}%
5920 \def\toctype{omit}%
5921 \let\sectionlevel=\empty
5922 \else\ifx\temptype\Yappendixkeyword
5923 \setbox0 = \hbox{#4\enspace}%
5924 \def\toctype{app}%
5925 \gdef\lastsection{#1}%
5926 \else
5927 \setbox0 = \hbox{#4\enspace}%
5928 \def\toctype{num}%
5929 \gdef\lastsection{#1}%
5930 \fi\fi\fi
5932 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5933 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5935 % Write the node reference (= pdf destination for pdftex).
5936 % Again, see comments in \chapmacro.
5937 \donoderef{#3}%
5939 % Interline glue will be inserted when the vbox is completed.
5940 % That glue will be a valid breakpoint for the page, since it'll be
5941 % preceded by a whatsit (usually from the \donoderef, or from the
5942 % \writetocentry if there was no node). We don't want to allow that
5943 % break, since then the whatsits could end up on page n while the
5944 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5945 \nobreak
5947 % Output the actual section heading.
5948 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5949 \hangindent=\wd0 % zero if no section number
5950 \unhbox0 #1}%
5952 % Add extra space after the heading -- half of whatever came above it.
5953 % Don't allow stretch, though.
5954 \kern .5 \csname #2headingskip\endcsname
5956 % Do not let the kern be a potential breakpoint, as it would be if it
5957 % was followed by glue.
5958 \nobreak
5960 % We'll almost certainly start a paragraph next, so don't let that
5961 % glue accumulate. (Not a breakpoint because it's preceded by a
5962 % discardable item.) However, when a paragraph is not started next
5963 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
5964 % or the negative glue will cause weirdly wrong output, typically
5965 % obscuring the section heading with something else.
5966 \vskip-\parskip
5968 % This is so the last item on the main vertical list is a known
5969 % \penalty > 10000, so \startdefun, etc., can recognize the situation
5970 % and do the needful.
5971 \penalty 10001
5975 \message{toc,}
5976 % Table of contents.
5977 \newwrite\tocfile
5979 % Write an entry to the toc file, opening it if necessary.
5980 % Called from @chapter, etc.
5982 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5983 % We append the current node name (if any) and page number as additional
5984 % arguments for the \{chap,sec,...}entry macros which will eventually
5985 % read this. The node name is used in the pdf outlines as the
5986 % destination to jump to.
5988 % We open the .toc file for writing here instead of at @setfilename (or
5989 % any other fixed time) so that @contents can be anywhere in the document.
5990 % But if #1 is `omit', then we don't do anything. This is used for the
5991 % table of contents chapter openings themselves.
5993 \newif\iftocfileopened
5994 \def\omitkeyword{omit}%
5996 \def\writetocentry#1#2#3{%
5997 \edef\writetoctype{#1}%
5998 \ifx\writetoctype\omitkeyword \else
5999 \iftocfileopened\else
6000 \immediate\openout\tocfile = \jobname.toc
6001 \global\tocfileopenedtrue
6004 \iflinks
6005 {\atdummies
6006 \edef\temp{%
6007 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
6008 \temp
6013 % Tell \shipout to create a pdf destination on each page, if we're
6014 % writing pdf. These are used in the table of contents. We can't
6015 % just write one on every page because the title pages are numbered
6016 % 1 and 2 (the page numbers aren't printed), and so are the first
6017 % two pages of the document. Thus, we'd have two destinations named
6018 % `1', and two named `2'.
6019 \ifpdf \global\pdfmakepagedesttrue \fi
6023 % These characters do not print properly in the Computer Modern roman
6024 % fonts, so we must take special care. This is more or less redundant
6025 % with the Texinfo input format setup at the end of this file.
6027 \def\activecatcodes{%
6028 \catcode`\"=\active
6029 \catcode`\$=\active
6030 \catcode`\<=\active
6031 \catcode`\>=\active
6032 \catcode`\\=\active
6033 \catcode`\^=\active
6034 \catcode`\_=\active
6035 \catcode`\|=\active
6036 \catcode`\~=\active
6040 % Read the toc file, which is essentially Texinfo input.
6041 \def\readtocfile{%
6042 \setupdatafile
6043 \activecatcodes
6044 \input \tocreadfilename
6047 \newskip\contentsrightmargin \contentsrightmargin=1in
6048 \newcount\savepageno
6049 \newcount\lastnegativepageno \lastnegativepageno = -1
6051 % Prepare to read what we've written to \tocfile.
6053 \def\startcontents#1{%
6054 % If @setchapternewpage on, and @headings double, the contents should
6055 % start on an odd page, unlike chapters. Thus, we maintain
6056 % \contentsalignmacro in parallel with \pagealignmacro.
6057 % From: Torbjorn Granlund <tege@matematik.su.se>
6058 \contentsalignmacro
6059 \immediate\closeout\tocfile
6061 % Don't need to put `Contents' or `Short Contents' in the headline.
6062 % It is abundantly clear what they are.
6063 \chapmacro{#1}{Yomitfromtoc}{}%
6065 \savepageno = \pageno
6066 \begingroup % Set up to handle contents files properly.
6067 \raggedbottom % Worry more about breakpoints than the bottom.
6068 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
6070 % Roman numerals for page numbers.
6071 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
6074 % redefined for the two-volume lispref. We always output on
6075 % \jobname.toc even if this is redefined.
6077 \def\tocreadfilename{\jobname.toc}
6079 % Normal (long) toc.
6081 \def\contents{%
6082 \startcontents{\putwordTOC}%
6083 \openin 1 \tocreadfilename\space
6084 \ifeof 1 \else
6085 \readtocfile
6087 \vfill \eject
6088 \contentsalignmacro % in case @setchapternewpage odd is in effect
6089 \ifeof 1 \else
6090 \pdfmakeoutlines
6092 \closein 1
6093 \endgroup
6094 \lastnegativepageno = \pageno
6095 \global\pageno = \savepageno
6098 % And just the chapters.
6099 \def\summarycontents{%
6100 \startcontents{\putwordShortTOC}%
6102 \let\partentry = \shortpartentry
6103 \let\numchapentry = \shortchapentry
6104 \let\appentry = \shortchapentry
6105 \let\unnchapentry = \shortunnchapentry
6106 % We want a true roman here for the page numbers.
6107 \secfonts
6108 \let\rm=\shortcontrm \let\bf=\shortcontbf
6109 \let\sl=\shortcontsl \let\tt=\shortconttt
6111 \hyphenpenalty = 10000
6112 \advance\baselineskip by 1pt % Open it up a little.
6113 \def\numsecentry##1##2##3##4{}
6114 \let\appsecentry = \numsecentry
6115 \let\unnsecentry = \numsecentry
6116 \let\numsubsecentry = \numsecentry
6117 \let\appsubsecentry = \numsecentry
6118 \let\unnsubsecentry = \numsecentry
6119 \let\numsubsubsecentry = \numsecentry
6120 \let\appsubsubsecentry = \numsecentry
6121 \let\unnsubsubsecentry = \numsecentry
6122 \openin 1 \tocreadfilename\space
6123 \ifeof 1 \else
6124 \readtocfile
6126 \closein 1
6127 \vfill \eject
6128 \contentsalignmacro % in case @setchapternewpage odd is in effect
6129 \endgroup
6130 \lastnegativepageno = \pageno
6131 \global\pageno = \savepageno
6133 \let\shortcontents = \summarycontents
6135 % Typeset the label for a chapter or appendix for the short contents.
6136 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6138 \def\shortchaplabel#1{%
6139 % This space should be enough, since a single number is .5em, and the
6140 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6141 % But use \hss just in case.
6142 % (This space doesn't include the extra space that gets added after
6143 % the label; that gets put in by \shortchapentry above.)
6145 % We'd like to right-justify chapter numbers, but that looks strange
6146 % with appendix letters. And right-justifying numbers and
6147 % left-justifying letters looks strange when there is less than 10
6148 % chapters. Have to read the whole toc once to know how many chapters
6149 % there are before deciding ...
6150 \hbox to 1em{#1\hss}%
6153 % These macros generate individual entries in the table of contents.
6154 % The first argument is the chapter or section name.
6155 % The last argument is the page number.
6156 % The arguments in between are the chapter number, section number, ...
6158 % Parts, in the main contents. Replace the part number, which doesn't
6159 % exist, with an empty box. Let's hope all the numbers have the same width.
6160 % Also ignore the page number, which is conventionally not printed.
6161 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6162 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6164 % Parts, in the short toc.
6165 \def\shortpartentry#1#2#3#4{%
6166 \penalty-300
6167 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6168 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6171 % Chapters, in the main contents.
6172 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6174 % Chapters, in the short toc.
6175 % See comments in \dochapentry re vbox and related settings.
6176 \def\shortchapentry#1#2#3#4{%
6177 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6180 % Appendices, in the main contents.
6181 % Need the word Appendix, and a fixed-size box.
6183 \def\appendixbox#1{%
6184 % We use M since it's probably the widest letter.
6185 \setbox0 = \hbox{\putwordAppendix{} M}%
6186 \hbox to \wd0{\putwordAppendix{} #1\hss}}
6188 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6190 % Unnumbered chapters.
6191 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6192 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6194 % Sections.
6195 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6196 \let\appsecentry=\numsecentry
6197 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6199 % Subsections.
6200 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6201 \let\appsubsecentry=\numsubsecentry
6202 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6204 % And subsubsections.
6205 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6206 \let\appsubsubsecentry=\numsubsubsecentry
6207 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6209 % This parameter controls the indentation of the various levels.
6210 % Same as \defaultparindent.
6211 \newdimen\tocindent \tocindent = 15pt
6213 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6214 % page number.
6216 % If the toc has to be broken over pages, we want it to be at chapters
6217 % if at all possible; hence the \penalty.
6218 \def\dochapentry#1#2{%
6219 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6220 \begingroup
6221 \chapentryfonts
6222 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6223 \endgroup
6224 \nobreak\vskip .25\baselineskip plus.1\baselineskip
6227 \def\dosecentry#1#2{\begingroup
6228 \secentryfonts \leftskip=\tocindent
6229 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6230 \endgroup}
6232 \def\dosubsecentry#1#2{\begingroup
6233 \subsecentryfonts \leftskip=2\tocindent
6234 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6235 \endgroup}
6237 \def\dosubsubsecentry#1#2{\begingroup
6238 \subsubsecentryfonts \leftskip=3\tocindent
6239 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6240 \endgroup}
6242 % We use the same \entry macro as for the index entries.
6243 \let\tocentry = \entry
6245 % Space between chapter (or whatever) number and the title.
6246 \def\labelspace{\hskip1em \relax}
6248 \def\dopageno#1{{\rm #1}}
6249 \def\doshortpageno#1{{\rm #1}}
6251 \def\chapentryfonts{\secfonts \rm}
6252 \def\secentryfonts{\textfonts}
6253 \def\subsecentryfonts{\textfonts}
6254 \def\subsubsecentryfonts{\textfonts}
6257 \message{environments,}
6258 % @foo ... @end foo.
6260 % @tex ... @end tex escapes into raw TeX temporarily.
6261 % One exception: @ is still an escape character, so that @end tex works.
6262 % But \@ or @@ will get a plain @ character.
6264 \envdef\tex{%
6265 \setupmarkupstyle{tex}%
6266 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6267 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6268 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6269 \catcode `\%=14
6270 \catcode `\+=\other
6271 \catcode `\"=\other
6272 \catcode `\|=\other
6273 \catcode `\<=\other
6274 \catcode `\>=\other
6275 \catcode`\`=\other
6276 \catcode`\'=\other
6277 \escapechar=`\\
6279 % ' is active in math mode (mathcode"8000). So reset it, and all our
6280 % other math active characters (just in case), to plain's definitions.
6281 \mathactive
6283 \let\b=\ptexb
6284 \let\bullet=\ptexbullet
6285 \let\c=\ptexc
6286 \let\,=\ptexcomma
6287 \let\.=\ptexdot
6288 \let\dots=\ptexdots
6289 \let\equiv=\ptexequiv
6290 \let\!=\ptexexclam
6291 \let\i=\ptexi
6292 \let\indent=\ptexindent
6293 \let\noindent=\ptexnoindent
6294 \let\{=\ptexlbrace
6295 \let\+=\tabalign
6296 \let\}=\ptexrbrace
6297 \let\/=\ptexslash
6298 \let\*=\ptexstar
6299 \let\t=\ptext
6300 \expandafter \let\csname top\endcsname=\ptextop % outer
6301 \let\frenchspacing=\plainfrenchspacing
6303 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6304 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6305 \def\@{@}%
6307 % There is no need to define \Etex.
6309 % Define @lisp ... @end lisp.
6310 % @lisp environment forms a group so it can rebind things,
6311 % including the definition of @end lisp (which normally is erroneous).
6313 % Amount to narrow the margins by for @lisp.
6314 \newskip\lispnarrowing \lispnarrowing=0.4in
6316 % This is the definition that ^^M gets inside @lisp, @example, and other
6317 % such environments. \null is better than a space, since it doesn't
6318 % have any width.
6319 \def\lisppar{\null\endgraf}
6321 % This space is always present above and below environments.
6322 \newskip\envskipamount \envskipamount = 0pt
6324 % Make spacing and below environment symmetrical. We use \parskip here
6325 % to help in doing that, since in @example-like environments \parskip
6326 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6327 % start of the next paragraph will insert \parskip.
6329 \def\aboveenvbreak{{%
6330 % =10000 instead of <10000 because of a special case in \itemzzz and
6331 % \sectionheading, q.v.
6332 \ifnum \lastpenalty=10000 \else
6333 \advance\envskipamount by \parskip
6334 \endgraf
6335 \ifdim\lastskip<\envskipamount
6336 \removelastskip
6337 % it's not a good place to break if the last penalty was \nobreak
6338 % or better ...
6339 \ifnum\lastpenalty<10000 \penalty-50 \fi
6340 \vskip\envskipamount
6345 \let\afterenvbreak = \aboveenvbreak
6347 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6348 % also clear it, so that its embedded environments do the narrowing again.
6349 \let\nonarrowing=\relax
6351 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6352 % environment contents.
6353 \font\circle=lcircle10
6354 \newdimen\circthick
6355 \newdimen\cartouter\newdimen\cartinner
6356 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6357 \circthick=\fontdimen8\circle
6359 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6360 \def\ctr{{\hskip 6pt\circle\char'010}}
6361 \def\cbl{{\circle\char'012\hskip -6pt}}
6362 \def\cbr{{\hskip 6pt\circle\char'011}}
6363 \def\carttop{\hbox to \cartouter{\hskip\lskip
6364 \ctl\leaders\hrule height\circthick\hfil\ctr
6365 \hskip\rskip}}
6366 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6367 \cbl\leaders\hrule height\circthick\hfil\cbr
6368 \hskip\rskip}}
6370 \newskip\lskip\newskip\rskip
6372 \envdef\cartouche{%
6373 \ifhmode\par\fi % can't be in the midst of a paragraph.
6374 \startsavinginserts
6375 \lskip=\leftskip \rskip=\rightskip
6376 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6377 \cartinner=\hsize \advance\cartinner by-\lskip
6378 \advance\cartinner by-\rskip
6379 \cartouter=\hsize
6380 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6381 % side, and for 6pt waste from
6382 % each corner char, and rule thickness
6383 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6384 % Flag to tell @lisp, etc., not to narrow margin.
6385 \let\nonarrowing = t%
6387 % If this cartouche directly follows a sectioning command, we need the
6388 % \parskip glue (backspaced over by default) or the cartouche can
6389 % collide with the section heading.
6390 \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
6392 \vbox\bgroup
6393 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6394 \carttop
6395 \hbox\bgroup
6396 \hskip\lskip
6397 \vrule\kern3pt
6398 \vbox\bgroup
6399 \kern3pt
6400 \hsize=\cartinner
6401 \baselineskip=\normbskip
6402 \lineskip=\normlskip
6403 \parskip=\normpskip
6404 \vskip -\parskip
6405 \comment % For explanation, see the end of def\group.
6407 \def\Ecartouche{%
6408 \ifhmode\par\fi
6409 \kern3pt
6410 \egroup
6411 \kern3pt\vrule
6412 \hskip\rskip
6413 \egroup
6414 \cartbot
6415 \egroup
6416 \checkinserts
6420 % This macro is called at the beginning of all the @example variants,
6421 % inside a group.
6422 \newdimen\nonfillparindent
6423 \def\nonfillstart{%
6424 \aboveenvbreak
6425 \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy
6426 \sepspaces % Make spaces be word-separators rather than space tokens.
6427 \let\par = \lisppar % don't ignore blank lines
6428 \obeylines % each line of input is a line of output
6429 \parskip = 0pt
6430 % Turn off paragraph indentation but redefine \indent to emulate
6431 % the normal \indent.
6432 \nonfillparindent=\parindent
6433 \parindent = 0pt
6434 \let\indent\nonfillindent
6436 \emergencystretch = 0pt % don't try to avoid overfull boxes
6437 \ifx\nonarrowing\relax
6438 \advance \leftskip by \lispnarrowing
6439 \exdentamount=\lispnarrowing
6440 \else
6441 \let\nonarrowing = \relax
6443 \let\exdent=\nofillexdent
6446 \begingroup
6447 \obeyspaces
6448 % We want to swallow spaces (but not other tokens) after the fake
6449 % @indent in our nonfill-environments, where spaces are normally
6450 % active and set to @tie, resulting in them not being ignored after
6451 % @indent.
6452 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6453 \gdef\nonfillindentcheck{%
6454 \ifx\temp %
6455 \expandafter\nonfillindentgobble%
6456 \else%
6457 \leavevmode\nonfillindentbox%
6458 \fi%
6460 \endgroup
6461 \def\nonfillindentgobble#1{\nonfillindent}
6462 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6464 % If you want all examples etc. small: @set dispenvsize small.
6465 % If you want even small examples the full size: @set dispenvsize nosmall.
6466 % This affects the following displayed environments:
6467 % @example, @display, @format, @lisp
6469 \def\smallword{small}
6470 \def\nosmallword{nosmall}
6471 \let\SETdispenvsize\relax
6472 \def\setnormaldispenv{%
6473 \ifx\SETdispenvsize\smallword
6474 % end paragraph for sake of leading, in case document has no blank
6475 % line. This is redundant with what happens in \aboveenvbreak, but
6476 % we need to do it before changing the fonts, and it's inconvenient
6477 % to change the fonts afterward.
6478 \ifnum \lastpenalty=10000 \else \endgraf \fi
6479 \smallexamplefonts \rm
6482 \def\setsmalldispenv{%
6483 \ifx\SETdispenvsize\nosmallword
6484 \else
6485 \ifnum \lastpenalty=10000 \else \endgraf \fi
6486 \smallexamplefonts \rm
6490 % We often define two environments, @foo and @smallfoo.
6491 % Let's do it in one command. #1 is the env name, #2 the definition.
6492 \def\makedispenvdef#1#2{%
6493 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6494 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6495 \expandafter\let\csname E#1\endcsname \afterenvbreak
6496 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6499 % Define two environment synonyms (#1 and #2) for an environment.
6500 \def\maketwodispenvdef#1#2#3{%
6501 \makedispenvdef{#1}{#3}%
6502 \makedispenvdef{#2}{#3}%
6505 % @lisp: indented, narrowed, typewriter font;
6506 % @example: same as @lisp.
6508 % @smallexample and @smalllisp: use smaller fonts.
6509 % Originally contributed by Pavel@xerox.
6511 \maketwodispenvdef{lisp}{example}{%
6512 \nonfillstart
6513 \tt\setupmarkupstyle{example}%
6514 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6515 \gobble % eat return
6517 % @display/@smalldisplay: same as @lisp except keep current font.
6519 \makedispenvdef{display}{%
6520 \nonfillstart
6521 \gobble
6524 % @format/@smallformat: same as @display except don't narrow margins.
6526 \makedispenvdef{format}{%
6527 \let\nonarrowing = t%
6528 \nonfillstart
6529 \gobble
6532 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6533 \envdef\flushleft{%
6534 \let\nonarrowing = t%
6535 \nonfillstart
6536 \gobble
6538 \let\Eflushleft = \afterenvbreak
6540 % @flushright.
6542 \envdef\flushright{%
6543 \let\nonarrowing = t%
6544 \nonfillstart
6545 \advance\leftskip by 0pt plus 1fill\relax
6546 \gobble
6548 \let\Eflushright = \afterenvbreak
6551 % @raggedright does more-or-less normal line breaking but no right
6552 % justification. From plain.tex.
6553 \envdef\raggedright{%
6554 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6556 \let\Eraggedright\par
6558 \envdef\raggedleft{%
6559 \parindent=0pt \leftskip0pt plus2em
6560 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6561 \hbadness=10000 % Last line will usually be underfull, so turn off
6562 % badness reporting.
6564 \let\Eraggedleft\par
6566 \envdef\raggedcenter{%
6567 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6568 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6569 \hbadness=10000 % Last line will usually be underfull, so turn off
6570 % badness reporting.
6572 \let\Eraggedcenter\par
6575 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6576 % and narrows the margins. We keep \parskip nonzero in general, since
6577 % we're doing normal filling. So, when using \aboveenvbreak and
6578 % \afterenvbreak, temporarily make \parskip 0.
6580 \makedispenvdef{quotation}{\quotationstart}
6582 \def\quotationstart{%
6583 \indentedblockstart % same as \indentedblock, but increase right margin too.
6584 \ifx\nonarrowing\relax
6585 \advance\rightskip by \lispnarrowing
6587 \parsearg\quotationlabel
6590 % We have retained a nonzero parskip for the environment, since we're
6591 % doing normal filling.
6593 \def\Equotation{%
6594 \par
6595 \ifx\quotationauthor\thisisundefined\else
6596 % indent a bit.
6597 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6599 {\parskip=0pt \afterenvbreak}%
6601 \def\Esmallquotation{\Equotation}
6603 % If we're given an argument, typeset it in bold with a colon after.
6604 \def\quotationlabel#1{%
6605 \def\temp{#1}%
6606 \ifx\temp\empty \else
6607 {\bf #1: }%
6611 % @indentedblock is like @quotation, but indents only on the left and
6612 % has no optional argument.
6614 \makedispenvdef{indentedblock}{\indentedblockstart}
6616 \def\indentedblockstart{%
6617 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6618 \parindent=0pt
6620 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6621 \ifx\nonarrowing\relax
6622 \advance\leftskip by \lispnarrowing
6623 \exdentamount = \lispnarrowing
6624 \else
6625 \let\nonarrowing = \relax
6629 % Keep a nonzero parskip for the environment, since we're doing normal filling.
6631 \def\Eindentedblock{%
6632 \par
6633 {\parskip=0pt \afterenvbreak}%
6635 \def\Esmallindentedblock{\Eindentedblock}
6638 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6639 % If we want to allow any <char> as delimiter,
6640 % we need the curly braces so that makeinfo sees the @verb command, eg:
6641 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6643 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6645 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6646 % active too. Otherwise, they get lost as the first character on a
6647 % verbatim line.
6648 \def\dospecials{%
6649 \do\ \do\\\do\{\do\}\do\$\do\&%
6650 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6651 \do\<\do\>\do\|\do\@\do+\do\"%
6652 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6653 % @set txicodequotebacktick will not have effect on @verb and
6654 % @verbatim, and ?` and !` ligatures won't get disabled.
6655 %\do\`\do\'%
6658 % [Knuth] p. 380
6659 \def\uncatcodespecials{%
6660 \def\do##1{\catcode`##1=\other}\dospecials}
6662 % Setup for the @verb command.
6664 % Eight spaces for a tab
6665 \begingroup
6666 \catcode`\^^I=\active
6667 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6668 \endgroup
6670 \def\setupverb{%
6671 \tt % easiest (and conventionally used) font for verbatim
6672 \def\par{\leavevmode\endgraf}%
6673 \setupmarkupstyle{verb}%
6674 \tabeightspaces
6675 % Respect line breaks,
6676 % print special symbols as themselves, and
6677 % make each space count
6678 % must do in this order:
6679 \obeylines \uncatcodespecials \sepspaces
6682 % Setup for the @verbatim environment
6684 % Real tab expansion.
6685 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6687 % We typeset each line of the verbatim in an \hbox, so we can handle
6688 % tabs. The \global is in case the verbatim line starts with an accent,
6689 % or some other command that starts with a begin-group. Otherwise, the
6690 % entire \verbbox would disappear at the corresponding end-group, before
6691 % it is typeset. Meanwhile, we can't have nested verbatim commands
6692 % (can we?), so the \global won't be overwriting itself.
6693 \newbox\verbbox
6694 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
6696 \begingroup
6697 \catcode`\^^I=\active
6698 \gdef\tabexpand{%
6699 \catcode`\^^I=\active
6700 \def^^I{\leavevmode\egroup
6701 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
6702 \divide\dimen\verbbox by\tabw
6703 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
6704 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
6705 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
6708 \endgroup
6710 % start the verbatim environment.
6711 \def\setupverbatim{%
6712 \let\nonarrowing = t%
6713 \nonfillstart
6714 \tt % easiest (and conventionally used) font for verbatim
6715 % The \leavevmode here is for blank lines. Otherwise, we would
6716 % never \starttabox and the \egroup would end verbatim mode.
6717 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6718 \tabexpand
6719 \setupmarkupstyle{verbatim}%
6720 % Respect line breaks,
6721 % print special symbols as themselves, and
6722 % make each space count.
6723 % Must do in this order:
6724 \obeylines \uncatcodespecials \sepspaces
6725 \everypar{\starttabbox}%
6728 % Do the @verb magic: verbatim text is quoted by unique
6729 % delimiter characters. Before first delimiter expect a
6730 % right brace, after last delimiter expect closing brace:
6732 % \def\doverb'{'<char>#1<char>'}'{#1}
6734 % [Knuth] p. 382; only eat outer {}
6735 \begingroup
6736 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6737 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6738 \endgroup
6740 \def\verb{\begingroup\setupverb\doverb}
6743 % Do the @verbatim magic: define the macro \doverbatim so that
6744 % the (first) argument ends when '@end verbatim' is reached, ie:
6746 % \def\doverbatim#1@end verbatim{#1}
6748 % For Texinfo it's a lot easier than for LaTeX,
6749 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6750 % we need not redefine '\', '{' and '}'.
6752 % Inspired by LaTeX's verbatim command set [latex.ltx]
6754 \begingroup
6755 \catcode`\ =\active
6756 \obeylines %
6757 % ignore everything up to the first ^^M, that's the newline at the end
6758 % of the @verbatim input line itself. Otherwise we get an extra blank
6759 % line in the output.
6760 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6761 % We really want {...\end verbatim} in the body of the macro, but
6762 % without the active space; thus we have to use \xdef and \gobble.
6763 \endgroup
6765 \envdef\verbatim{%
6766 \setupverbatim\doverbatim
6768 \let\Everbatim = \afterenvbreak
6771 % @verbatiminclude FILE - insert text of file in verbatim environment.
6773 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6775 \def\doverbatiminclude#1{%
6777 \makevalueexpandable
6778 \setupverbatim
6779 \indexnofonts % Allow `@@' and other weird things in file names.
6780 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
6781 \input #1
6782 \afterenvbreak
6786 % @copying ... @end copying.
6787 % Save the text away for @insertcopying later.
6789 % We save the uninterpreted tokens, rather than creating a box.
6790 % Saving the text in a box would be much easier, but then all the
6791 % typesetting commands (@smallbook, font changes, etc.) have to be done
6792 % beforehand -- and a) we want @copying to be done first in the source
6793 % file; b) letting users define the frontmatter in as flexible order as
6794 % possible is very desirable.
6796 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6797 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6799 \def\insertcopying{%
6800 \begingroup
6801 \parindent = 0pt % paragraph indentation looks wrong on title page
6802 \scanexp\copyingtext
6803 \endgroup
6807 \message{defuns,}
6808 % @defun etc.
6810 \newskip\defbodyindent \defbodyindent=.4in
6811 \newskip\defargsindent \defargsindent=50pt
6812 \newskip\deflastargmargin \deflastargmargin=18pt
6813 \newcount\defunpenalty
6815 % Start the processing of @deffn:
6816 \def\startdefun{%
6817 \ifnum\lastpenalty<10000
6818 \medbreak
6819 \defunpenalty=10003 % Will keep this @deffn together with the
6820 % following @def command, see below.
6821 \else
6822 % If there are two @def commands in a row, we'll have a \nobreak,
6823 % which is there to keep the function description together with its
6824 % header. But if there's nothing but headers, we need to allow a
6825 % break somewhere. Check specifically for penalty 10002, inserted
6826 % by \printdefunline, instead of 10000, since the sectioning
6827 % commands also insert a nobreak penalty, and we don't want to allow
6828 % a break between a section heading and a defun.
6830 % As a further refinement, we avoid "club" headers by signalling
6831 % with penalty of 10003 after the very first @deffn in the
6832 % sequence (see above), and penalty of 10002 after any following
6833 % @def command.
6834 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6836 % Similarly, after a section heading, do not allow a break.
6837 % But do insert the glue.
6838 \medskip % preceded by discardable penalty, so not a breakpoint
6841 \parindent=0in
6842 \advance\leftskip by \defbodyindent
6843 \exdentamount=\defbodyindent
6846 \def\dodefunx#1{%
6847 % First, check whether we are in the right environment:
6848 \checkenv#1%
6850 % As above, allow line break if we have multiple x headers in a row.
6851 % It's not a great place, though.
6852 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6854 % And now, it's time to reuse the body of the original defun:
6855 \expandafter\gobbledefun#1%
6857 \def\gobbledefun#1\startdefun{}
6859 % \printdefunline \deffnheader{text}
6861 \def\printdefunline#1#2{%
6862 \begingroup
6863 % call \deffnheader:
6864 #1#2 \endheader
6865 % common ending:
6866 \interlinepenalty = 10000
6867 \advance\rightskip by 0pt plus 1fil\relax
6868 \endgraf
6869 \nobreak\vskip -\parskip
6870 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6871 % Some of the @defun-type tags do not enable magic parentheses,
6872 % rendering the following check redundant. But we don't optimize.
6873 \checkparencounts
6874 \endgroup
6877 \def\Edefun{\endgraf\medbreak}
6879 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6880 % the only thing remaining is to define \deffnheader.
6882 \def\makedefun#1{%
6883 \expandafter\let\csname E#1\endcsname = \Edefun
6884 \edef\temp{\noexpand\domakedefun
6885 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6886 \temp
6889 % \domakedefun \deffn \deffnx \deffnheader
6891 % Define \deffn and \deffnx, without parameters.
6892 % \deffnheader has to be defined explicitly.
6894 \def\domakedefun#1#2#3{%
6895 \envdef#1{%
6896 \startdefun
6897 \doingtypefnfalse % distinguish typed functions from all else
6898 \parseargusing\activeparens{\printdefunline#3}%
6900 \def#2{\dodefunx#1}%
6901 \def#3%
6904 \newif\ifdoingtypefn % doing typed function?
6905 \newif\ifrettypeownline % typeset return type on its own line?
6907 % @deftypefnnewline on|off says whether the return type of typed functions
6908 % are printed on their own line. This affects @deftypefn, @deftypefun,
6909 % @deftypeop, and @deftypemethod.
6911 \parseargdef\deftypefnnewline{%
6912 \def\temp{#1}%
6913 \ifx\temp\onword
6914 \expandafter\let\csname SETtxideftypefnnl\endcsname
6915 = \empty
6916 \else\ifx\temp\offword
6917 \expandafter\let\csname SETtxideftypefnnl\endcsname
6918 = \relax
6919 \else
6920 \errhelp = \EMsimple
6921 \errmessage{Unknown @txideftypefnnl value `\temp',
6922 must be on|off}%
6923 \fi\fi
6926 % Untyped functions:
6928 % @deffn category name args
6929 \makedefun{deffn}{\deffngeneral{}}
6931 % @deffn category class name args
6932 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6934 % \defopon {category on}class name args
6935 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6937 % \deffngeneral {subind}category name args
6939 \def\deffngeneral#1#2 #3 #4\endheader{%
6940 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6941 \dosubind{fn}{\code{#3}}{#1}%
6942 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6945 % Typed functions:
6947 % @deftypefn category type name args
6948 \makedefun{deftypefn}{\deftypefngeneral{}}
6950 % @deftypeop category class type name args
6951 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6953 % \deftypeopon {category on}class type name args
6954 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6956 % \deftypefngeneral {subind}category type name args
6958 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6959 \dosubind{fn}{\code{#4}}{#1}%
6960 \doingtypefntrue
6961 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6964 % Typed variables:
6966 % @deftypevr category type var args
6967 \makedefun{deftypevr}{\deftypecvgeneral{}}
6969 % @deftypecv category class type var args
6970 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6972 % \deftypecvof {category of}class type var args
6973 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6975 % \deftypecvgeneral {subind}category type var args
6977 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6978 \dosubind{vr}{\code{#4}}{#1}%
6979 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6982 % Untyped variables:
6984 % @defvr category var args
6985 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6987 % @defcv category class var args
6988 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6990 % \defcvof {category of}class var args
6991 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6993 % Types:
6995 % @deftp category name args
6996 \makedefun{deftp}#1 #2 #3\endheader{%
6997 \doind{tp}{\code{#2}}%
6998 \defname{#1}{}{#2}\defunargs{#3\unskip}%
7001 % Remaining @defun-like shortcuts:
7002 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
7003 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
7004 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
7005 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
7006 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
7007 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
7008 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
7009 \makedefun{defmethod}{\defopon\putwordMethodon}
7010 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
7011 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
7012 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
7014 % \defname, which formats the name of the @def (not the args).
7015 % #1 is the category, such as "Function".
7016 % #2 is the return type, if any.
7017 % #3 is the function name.
7019 % We are followed by (but not passed) the arguments, if any.
7021 \def\defname#1#2#3{%
7022 \par
7023 % Get the values of \leftskip and \rightskip as they were outside the @def...
7024 \advance\leftskip by -\defbodyindent
7026 % Determine if we are typesetting the return type of a typed function
7027 % on a line by itself.
7028 \rettypeownlinefalse
7029 \ifdoingtypefn % doing a typed function specifically?
7030 % then check user option for putting return type on its own line:
7031 \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
7032 \rettypeownlinetrue
7036 % How we'll format the category name. Putting it in brackets helps
7037 % distinguish it from the body text that may end up on the next line
7038 % just below it.
7039 \def\temp{#1}%
7040 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7042 % Figure out line sizes for the paragraph shape. We'll always have at
7043 % least two.
7044 \tempnum = 2
7046 % The first line needs space for \box0; but if \rightskip is nonzero,
7047 % we need only space for the part of \box0 which exceeds it:
7048 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
7050 % If doing a return type on its own line, we'll have another line.
7051 \ifrettypeownline
7052 \advance\tempnum by 1
7053 \def\maybeshapeline{0in \hsize}%
7054 \else
7055 \def\maybeshapeline{}%
7058 % The continuations:
7059 \dimen2=\hsize \advance\dimen2 by -\defargsindent
7061 % The final paragraph shape:
7062 \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2
7064 % Put the category name at the right margin.
7065 \noindent
7066 \hbox to 0pt{%
7067 \hfil\box0 \kern-\hsize
7068 % \hsize has to be shortened this way:
7069 \kern\leftskip
7070 % Intentionally do not respect \rightskip, since we need the space.
7073 % Allow all lines to be underfull without complaint:
7074 \tolerance=10000 \hbadness=10000
7075 \exdentamount=\defbodyindent
7077 % defun fonts. We use typewriter by default (used to be bold) because:
7078 % . we're printing identifiers, they should be in tt in principle.
7079 % . in languages with many accents, such as Czech or French, it's
7080 % common to leave accents off identifiers. The result looks ok in
7081 % tt, but exceedingly strange in rm.
7082 % . we don't want -- and --- to be treated as ligatures.
7083 % . this still does not fix the ?` and !` ligatures, but so far no
7084 % one has made identifiers using them :).
7085 \df \tt
7086 \def\temp{#2}% text of the return type
7087 \ifx\temp\empty\else
7088 \tclose{\temp}% typeset the return type
7089 \ifrettypeownline
7090 % put return type on its own line; prohibit line break following:
7091 \hfil\vadjust{\nobreak}\break
7092 \else
7093 \space % type on same line, so just followed by a space
7095 \fi % no return type
7096 #3% output function name
7098 {\rm\enskip}% hskip 0.5 em of \tenrm
7100 \boldbrax
7101 % arguments will be output next, if any.
7104 % Print arguments in slanted roman (not ttsl), inconsistently with using
7105 % tt for the name. This is because literal text is sometimes needed in
7106 % the argument list (groff manual), and ttsl and tt are not very
7107 % distinguishable. Prevent hyphenation at `-' chars.
7109 \def\defunargs#1{%
7110 % use sl by default (not ttsl),
7111 % tt for the names.
7112 \df \sl \hyphenchar\font=0
7114 % On the other hand, if an argument has two dashes (for instance), we
7115 % want a way to get ttsl. We used to recommend @var for that, so
7116 % leave the code in, but it's strange for @var to lead to typewriter.
7117 % Nowadays we recommend @code, since the difference between a ttsl hyphen
7118 % and a tt hyphen is pretty tiny. @code also disables ?` !`.
7119 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
7121 \sl\hyphenchar\font=45
7124 % We want ()&[] to print specially on the defun line.
7126 \def\activeparens{%
7127 \catcode`\(=\active \catcode`\)=\active
7128 \catcode`\[=\active \catcode`\]=\active
7129 \catcode`\&=\active
7132 % Make control sequences which act like normal parenthesis chars.
7133 \let\lparen = ( \let\rparen = )
7135 % Be sure that we always have a definition for `(', etc. For example,
7136 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7137 % so TeX would otherwise complain about undefined control sequence.
7139 \activeparens
7140 \global\let(=\lparen \global\let)=\rparen
7141 \global\let[=\lbrack \global\let]=\rbrack
7142 \global\let& = \&
7144 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7145 \gdef\magicamp{\let&=\amprm}
7148 \newcount\parencount
7150 % If we encounter &foo, then turn on ()-hacking afterwards
7151 \newif\ifampseen
7152 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
7154 \def\parenfont{%
7155 \ifampseen
7156 % At the first level, print parens in roman,
7157 % otherwise use the default font.
7158 \ifnum \parencount=1 \rm \fi
7159 \else
7160 % The \sf parens (in \boldbrax) actually are a little bolder than
7161 % the contained text. This is especially needed for [ and ] .
7165 \def\infirstlevel#1{%
7166 \ifampseen
7167 \ifnum\parencount=1
7172 \def\bfafterword#1 {#1 \bf}
7174 \def\opnr{%
7175 \global\advance\parencount by 1
7176 {\parenfont(}%
7177 \infirstlevel \bfafterword
7179 \def\clnr{%
7180 {\parenfont)}%
7181 \infirstlevel \sl
7182 \global\advance\parencount by -1
7185 \newcount\brackcount
7186 \def\lbrb{%
7187 \global\advance\brackcount by 1
7188 {\bf[}%
7190 \def\rbrb{%
7191 {\bf]}%
7192 \global\advance\brackcount by -1
7195 \def\checkparencounts{%
7196 \ifnum\parencount=0 \else \badparencount \fi
7197 \ifnum\brackcount=0 \else \badbrackcount \fi
7199 % these should not use \errmessage; the glibc manual, at least, actually
7200 % has such constructs (when documenting function pointers).
7201 \def\badparencount{%
7202 \message{Warning: unbalanced parentheses in @def...}%
7203 \global\parencount=0
7205 \def\badbrackcount{%
7206 \message{Warning: unbalanced square brackets in @def...}%
7207 \global\brackcount=0
7211 \message{macros,}
7212 % @macro.
7214 % To do this right we need a feature of e-TeX, \scantokens,
7215 % which we arrange to emulate with a temporary file in ordinary TeX.
7216 \ifx\eTeXversion\thisisundefined
7217 \newwrite\macscribble
7218 \def\scantokens#1{%
7219 \toks0={#1}%
7220 \immediate\openout\macscribble=\jobname.tmp
7221 \immediate\write\macscribble{\the\toks0}%
7222 \immediate\closeout\macscribble
7223 \input \jobname.tmp
7227 \def\scanmacro#1{\begingroup
7228 \newlinechar`\^^M
7229 \let\xeatspaces\eatspaces
7231 % Undo catcode changes of \startcontents and \doprintindex
7232 % When called from @insertcopying or (short)caption, we need active
7233 % backslash to get it printed correctly. Previously, we had
7234 % \catcode`\\=\other instead. We'll see whether a problem appears
7235 % with macro expansion. --kasal, 19aug04
7236 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
7238 % ... and for \example:
7239 \spaceisspace
7241 % The \empty here causes a following catcode 5 newline to be eaten as
7242 % part of reading whitespace after a control sequence. It does not
7243 % eat a catcode 13 newline. There's no good way to handle the two
7244 % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
7245 % would then have different behavior). See the Macro Details node in
7246 % the manual for the workaround we recommend for macros and
7247 % line-oriented commands.
7249 \scantokens{#1\empty}%
7250 \endgroup}
7252 \def\scanexp#1{%
7253 \edef\temp{\noexpand\scanmacro{#1}}%
7254 \temp
7257 \newcount\paramno % Count of parameters
7258 \newtoks\macname % Macro name
7259 \newif\ifrecursive % Is it recursive?
7261 % List of all defined macros in the form
7262 % \definedummyword\macro1\definedummyword\macro2...
7263 % Currently is also contains all @aliases; the list can be split
7264 % if there is a need.
7265 \def\macrolist{}
7267 % Add the macro to \macrolist
7268 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7269 \def\addtomacrolistxxx#1{%
7270 \toks0 = \expandafter{\macrolist\definedummyword#1}%
7271 \xdef\macrolist{\the\toks0}%
7274 % Utility routines.
7275 % This does \let #1 = #2, with \csnames; that is,
7276 % \let \csname#1\endcsname = \csname#2\endcsname
7277 % (except of course we have to play expansion games).
7279 \def\cslet#1#2{%
7280 \expandafter\let
7281 \csname#1\expandafter\endcsname
7282 \csname#2\endcsname
7285 % Trim leading and trailing spaces off a string.
7286 % Concepts from aro-bend problem 15 (see CTAN).
7287 {\catcode`\@=11
7288 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
7289 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
7290 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
7291 \def\unbrace#1{#1}
7292 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
7295 % Trim a single trailing ^^M off a string.
7296 {\catcode`\^^M=\other \catcode`\Q=3%
7297 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
7298 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
7299 \gdef\eatcrb#1Q#2Q{#1}%
7302 % Macro bodies are absorbed as an argument in a context where
7303 % all characters are catcode 10, 11 or 12, except \ which is active
7304 % (as in normal texinfo). It is necessary to change the definition of \
7305 % to recognize macro arguments; this is the job of \mbodybackslash.
7307 % Non-ASCII encodings make 8-bit characters active, so un-activate
7308 % them to avoid their expansion. Must do this non-globally, to
7309 % confine the change to the current group.
7311 % It's necessary to have hard CRs when the macro is executed. This is
7312 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7313 % body, and then making it the \newlinechar in \scanmacro.
7315 \def\scanctxt{% used as subroutine
7316 \catcode`\"=\other
7317 \catcode`\+=\other
7318 \catcode`\<=\other
7319 \catcode`\>=\other
7320 \catcode`\@=\other
7321 \catcode`\^=\other
7322 \catcode`\_=\other
7323 \catcode`\|=\other
7324 \catcode`\~=\other
7325 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7328 \def\scanargctxt{% used for copying and captions, not macros.
7329 \scanctxt
7330 \catcode`\\=\other
7331 \catcode`\^^M=\other
7334 \def\macrobodyctxt{% used for @macro definitions
7335 \scanctxt
7336 \catcode`\{=\other
7337 \catcode`\}=\other
7338 \catcode`\^^M=\other
7339 \usembodybackslash
7342 \def\macroargctxt{% used when scanning invocations
7343 \scanctxt
7344 \catcode`\\=0
7346 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
7347 % for the single characters \ { }. Thus, we end up with the "commands"
7348 % that would be written @\ @{ @} in a Texinfo document.
7350 % We already have @{ and @}. For @\, we define it here, and only for
7351 % this purpose, to produce a typewriter backslash (so, the @\ that we
7352 % define for @math can't be used with @macro calls):
7354 \def\\{\normalbackslash}%
7356 % We would like to do this for \, too, since that is what makeinfo does.
7357 % But it is not possible, because Texinfo already has a command @, for a
7358 % cedilla accent. Documents must use @comma{} instead.
7360 % \anythingelse will almost certainly be an error of some kind.
7363 % \mbodybackslash is the definition of \ in @macro bodies.
7364 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7365 % where N is the macro parameter number.
7366 % We define \csname macarg.\endcsname to be \realbackslash, so
7367 % \\ in macro replacement text gets you a backslash.
7369 {\catcode`@=0 @catcode`@\=@active
7370 @gdef@usembodybackslash{@let\=@mbodybackslash}
7371 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
7373 \expandafter\def\csname macarg.\endcsname{\realbackslash}
7375 \def\margbackslash#1{\char`\#1 }
7377 \def\macro{\recursivefalse\parsearg\macroxxx}
7378 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7380 \def\macroxxx#1{%
7381 \getargs{#1}% now \macname is the macname and \argl the arglist
7382 \ifx\argl\empty % no arguments
7383 \paramno=0\relax
7384 \else
7385 \expandafter\parsemargdef \argl;%
7386 \if\paramno>256\relax
7387 \ifx\eTeXversion\thisisundefined
7388 \errhelp = \EMsimple
7389 \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
7393 \if1\csname ismacro.\the\macname\endcsname
7394 \message{Warning: redefining \the\macname}%
7395 \else
7396 \expandafter\ifx\csname \the\macname\endcsname \relax
7397 \else \errmessage{Macro name \the\macname\space already defined}\fi
7398 \global\cslet{macsave.\the\macname}{\the\macname}%
7399 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7400 \addtomacrolist{\the\macname}%
7402 \begingroup \macrobodyctxt
7403 \ifrecursive \expandafter\parsermacbody
7404 \else \expandafter\parsemacbody
7405 \fi}
7407 \parseargdef\unmacro{%
7408 \if1\csname ismacro.#1\endcsname
7409 \global\cslet{#1}{macsave.#1}%
7410 \global\expandafter\let \csname ismacro.#1\endcsname=0%
7411 % Remove the macro name from \macrolist:
7412 \begingroup
7413 \expandafter\let\csname#1\endcsname \relax
7414 \let\definedummyword\unmacrodo
7415 \xdef\macrolist{\macrolist}%
7416 \endgroup
7417 \else
7418 \errmessage{Macro #1 not defined}%
7422 % Called by \do from \dounmacro on each macro. The idea is to omit any
7423 % macro definitions that have been changed to \relax.
7425 \def\unmacrodo#1{%
7426 \ifx #1\relax
7427 % remove this
7428 \else
7429 \noexpand\definedummyword \noexpand#1%
7433 % This makes use of the obscure feature that if the last token of a
7434 % <parameter list> is #, then the preceding argument is delimited by
7435 % an opening brace, and that opening brace is not consumed.
7436 \def\getargs#1{\getargsxxx#1{}}
7437 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7438 \def\getmacname#1 #2\relax{\macname={#1}}
7439 \def\getmacargs#1{\def\argl{#1}}
7441 % For macro processing make @ a letter so that we can make Texinfo private macro names.
7442 \edef\texiatcatcode{\the\catcode`\@}
7443 \catcode `@=11\relax
7445 % Parse the optional {params} list. Set up \paramno and \paramlist
7446 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
7447 % in the params list to some hook where the argument si to be expanded. If
7448 % there are less than 10 arguments that hook is to be replaced by ##N where N
7449 % is the position in that list, that is to say the macro arguments are to be
7450 % defined `a la TeX in the macro body.
7452 % That gets used by \mbodybackslash (above).
7454 % We need to get `macro parameter char #' into several definitions.
7455 % The technique used is stolen from LaTeX: let \hash be something
7456 % unexpandable, insert that wherever you need a #, and then redefine
7457 % it to # just before using the token list produced.
7459 % The same technique is used to protect \eatspaces till just before
7460 % the macro is used.
7462 % If there are 10 or more arguments, a different technique is used, where the
7463 % hook remains in the body, and when macro is to be expanded the body is
7464 % processed again to replace the arguments.
7466 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7467 % argument N value and then \edef the body (nothing else will expand because of
7468 % the catcode regime underwhich the body was input).
7470 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7471 % arguments, you need that no macro has more than 256 arguments, otherwise an
7472 % error is produced.
7473 \def\parsemargdef#1;{%
7474 \paramno=0\def\paramlist{}%
7475 \let\hash\relax
7476 \let\xeatspaces\relax
7477 \parsemargdefxxx#1,;,%
7478 % In case that there are 10 or more arguments we parse again the arguments
7479 % list to set new definitions for the \macarg.BLAH macros corresponding to
7480 % each BLAH argument. It was anyhow needed to parse already once this list
7481 % in order to count the arguments, and as macros with at most 9 arguments
7482 % are by far more frequent than macro with 10 or more arguments, defining
7483 % twice the \macarg.BLAH macros does not cost too much processing power.
7484 \ifnum\paramno<10\relax\else
7485 \paramno0\relax
7486 \parsemmanyargdef@@#1,;,% 10 or more arguments
7489 \def\parsemargdefxxx#1,{%
7490 \if#1;\let\next=\relax
7491 \else \let\next=\parsemargdefxxx
7492 \advance\paramno by 1
7493 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7494 {\xeatspaces{\hash\the\paramno}}%
7495 \edef\paramlist{\paramlist\hash\the\paramno,}%
7496 \fi\next}
7498 \def\parsemmanyargdef@@#1,{%
7499 \if#1;\let\next=\relax
7500 \else
7501 \let\next=\parsemmanyargdef@@
7502 \edef\tempb{\eatspaces{#1}}%
7503 \expandafter\def\expandafter\tempa
7504 \expandafter{\csname macarg.\tempb\endcsname}%
7505 % Note that we need some extra \noexpand\noexpand, this is because we
7506 % don't want \the to be expanded in the \parsermacbody as it uses an
7507 % \xdef .
7508 \expandafter\edef\tempa
7509 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7510 \advance\paramno by 1\relax
7511 \fi\next}
7513 % These two commands read recursive and nonrecursive macro bodies.
7514 % (They're different since rec and nonrec macros end differently.)
7517 \catcode `\@\texiatcatcode
7518 \long\def\parsemacbody#1@end macro%
7519 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7520 \long\def\parsermacbody#1@end rmacro%
7521 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7522 \catcode `\@=11\relax
7524 \let\endargs@\relax
7525 \let\nil@\relax
7526 \def\nilm@{\nil@}%
7527 \long\def\nillm@{\nil@}%
7529 % This macro is expanded during the Texinfo macro expansion, not during its
7530 % definition. It gets all the arguments values and assigns them to macros
7531 % macarg.ARGNAME
7533 % #1 is the macro name
7534 % #2 is the list of argument names
7535 % #3 is the list of argument values
7536 \def\getargvals@#1#2#3{%
7537 \def\macargdeflist@{}%
7538 \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
7539 \def\paramlist{#2,\nil@}%
7540 \def\macroname{#1}%
7541 \begingroup
7542 \macroargctxt
7543 \def\argvaluelist{#3,\nil@}%
7544 \def\@tempa{#3}%
7545 \ifx\@tempa\empty
7546 \setemptyargvalues@
7547 \else
7548 \getargvals@@
7553 \def\getargvals@@{%
7554 \ifx\paramlist\nilm@
7555 % Some sanity check needed here that \argvaluelist is also empty.
7556 \ifx\argvaluelist\nillm@
7557 \else
7558 \errhelp = \EMsimple
7559 \errmessage{Too many arguments in macro `\macroname'!}%
7561 \let\next\macargexpandinbody@
7562 \else
7563 \ifx\argvaluelist\nillm@
7564 % No more arguments values passed to macro. Set remaining named-arg
7565 % macros to empty.
7566 \let\next\setemptyargvalues@
7567 \else
7568 % pop current arg name into \@tempb
7569 \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
7570 \expandafter\@tempa\expandafter{\paramlist}%
7571 % pop current argument value into \@tempc
7572 \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
7573 \expandafter\@tempa\expandafter{\argvaluelist}%
7574 % Here \@tempb is the current arg name and \@tempc is the current arg value.
7575 % First place the new argument macro definition into \@tempd
7576 \expandafter\macname\expandafter{\@tempc}%
7577 \expandafter\let\csname macarg.\@tempb\endcsname\relax
7578 \expandafter\def\expandafter\@tempe\expandafter{%
7579 \csname macarg.\@tempb\endcsname}%
7580 \edef\@tempd{\long\def\@tempe{\the\macname}}%
7581 \push@\@tempd\macargdeflist@
7582 \let\next\getargvals@@
7585 \next
7588 \def\push@#1#2{%
7589 \expandafter\expandafter\expandafter\def
7590 \expandafter\expandafter\expandafter#2%
7591 \expandafter\expandafter\expandafter{%
7592 \expandafter#1#2}%
7595 % Replace arguments by their values in the macro body, and place the result
7596 % in macro \@tempa
7597 \def\macvalstoargs@{%
7598 % To do this we use the property that token registers that are \the'ed
7599 % within an \edef expand only once. So we are going to place all argument
7600 % values into respective token registers.
7602 % First we save the token context, and initialize argument numbering.
7603 \begingroup
7604 \paramno0\relax
7605 % Then, for each argument number #N, we place the corresponding argument
7606 % value into a new token list register \toks#N
7607 \expandafter\putargsintokens@\saveparamlist@,;,%
7608 % Then, we expand the body so that argument are replaced by their
7609 % values. The trick for values not to be expanded themselves is that they
7610 % are within tokens and that tokens expand only once in an \edef .
7611 \edef\@tempc{\csname mac.\macroname .body\endcsname}%
7612 % Now we restore the token stack pointer to free the token list registers
7613 % which we have used, but we make sure that expanded body is saved after
7614 % group.
7615 \expandafter
7616 \endgroup
7617 \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
7620 \def\macargexpandinbody@{%
7621 %% Define the named-macro outside of this group and then close this group.
7622 \expandafter
7623 \endgroup
7624 \macargdeflist@
7625 % First the replace in body the macro arguments by their values, the result
7626 % is in \@tempa .
7627 \macvalstoargs@
7628 % Then we point at the \norecurse or \gobble (for recursive) macro value
7629 % with \@tempb .
7630 \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
7631 % Depending on whether it is recursive or not, we need some tailing
7632 % \egroup .
7633 \ifx\@tempb\gobble
7634 \let\@tempc\relax
7635 \else
7636 \let\@tempc\egroup
7638 % And now we do the real job:
7639 \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
7640 \@tempd
7643 \def\putargsintokens@#1,{%
7644 \if#1;\let\next\relax
7645 \else
7646 \let\next\putargsintokens@
7647 % First we allocate the new token list register, and give it a temporary
7648 % alias \@tempb .
7649 \toksdef\@tempb\the\paramno
7650 % Then we place the argument value into that token list register.
7651 \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
7652 \expandafter\@tempb\expandafter{\@tempa}%
7653 \advance\paramno by 1\relax
7655 \next
7658 % Save the token stack pointer into macro #1
7659 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}}
7660 % Restore the token stack pointer from number in macro #1
7661 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax}
7662 % newtoks that can be used non \outer .
7663 \def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi}
7665 % Tailing missing arguments are set to empty
7666 \def\setemptyargvalues@{%
7667 \ifx\paramlist\nilm@
7668 \let\next\macargexpandinbody@
7669 \else
7670 \expandafter\setemptyargvaluesparser@\paramlist\endargs@
7671 \let\next\setemptyargvalues@
7673 \next
7676 \def\setemptyargvaluesparser@#1,#2\endargs@{%
7677 \expandafter\def\expandafter\@tempa\expandafter{%
7678 \expandafter\def\csname macarg.#1\endcsname{}}%
7679 \push@\@tempa\macargdeflist@
7680 \def\paramlist{#2}%
7683 % #1 is the element target macro
7684 % #2 is the list macro
7685 % #3,#4\endargs@ is the list value
7686 \def\pop@#1#2#3,#4\endargs@{%
7687 \def#1{#3}%
7688 \def#2{#4}%
7690 \long\def\longpop@#1#2#3,#4\endargs@{%
7691 \long\def#1{#3}%
7692 \long\def#2{#4}%
7695 % This defines a Texinfo @macro. There are eight cases: recursive and
7696 % nonrecursive macros of zero, one, up to nine, and many arguments.
7697 % Much magic with \expandafter here.
7698 % \xdef is used so that macro definitions will survive the file
7699 % they're defined in; @include reads the file inside a group.
7701 \def\defmacro{%
7702 \let\hash=##% convert placeholders to macro parameter chars
7703 \ifrecursive
7704 \ifcase\paramno
7706 \expandafter\xdef\csname\the\macname\endcsname{%
7707 \noexpand\scanmacro{\temp}}%
7708 \or % 1
7709 \expandafter\xdef\csname\the\macname\endcsname{%
7710 \bgroup\noexpand\macroargctxt
7711 \noexpand\braceorline
7712 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7713 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7714 \egroup\noexpand\scanmacro{\temp}}%
7715 \else
7716 \ifnum\paramno<10\relax % at most 9
7717 \expandafter\xdef\csname\the\macname\endcsname{%
7718 \bgroup\noexpand\macroargctxt
7719 \noexpand\csname\the\macname xx\endcsname}%
7720 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7721 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7722 \expandafter\expandafter
7723 \expandafter\xdef
7724 \expandafter\expandafter
7725 \csname\the\macname xxx\endcsname
7726 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7727 \else % 10 or more
7728 \expandafter\xdef\csname\the\macname\endcsname{%
7729 \noexpand\getargvals@{\the\macname}{\argl}%
7731 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7732 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
7735 \else
7736 \ifcase\paramno
7738 \expandafter\xdef\csname\the\macname\endcsname{%
7739 \noexpand\norecurse{\the\macname}%
7740 \noexpand\scanmacro{\temp}\egroup}%
7741 \or % 1
7742 \expandafter\xdef\csname\the\macname\endcsname{%
7743 \bgroup\noexpand\macroargctxt
7744 \noexpand\braceorline
7745 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7746 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7747 \egroup
7748 \noexpand\norecurse{\the\macname}%
7749 \noexpand\scanmacro{\temp}\egroup}%
7750 \else % at most 9
7751 \ifnum\paramno<10\relax
7752 \expandafter\xdef\csname\the\macname\endcsname{%
7753 \bgroup\noexpand\macroargctxt
7754 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7755 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7756 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7757 \expandafter\expandafter
7758 \expandafter\xdef
7759 \expandafter\expandafter
7760 \csname\the\macname xxx\endcsname
7761 \paramlist{%
7762 \egroup
7763 \noexpand\norecurse{\the\macname}%
7764 \noexpand\scanmacro{\temp}\egroup}%
7765 \else % 10 or more:
7766 \expandafter\xdef\csname\the\macname\endcsname{%
7767 \noexpand\getargvals@{\the\macname}{\argl}%
7769 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7770 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
7773 \fi}
7775 \catcode `\@\texiatcatcode\relax
7777 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7779 % \braceorline decides whether the next nonwhitespace character is a
7780 % {. If so it reads up to the closing }, if not, it reads the whole
7781 % line. Whatever was read is then fed to the next control sequence
7782 % as an argument (by \parsebrace or \parsearg).
7784 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7785 \def\braceorlinexxx{%
7786 \ifx\nchar\bgroup\else
7787 \expandafter\parsearg
7788 \fi \macnamexxx}
7791 % @alias.
7792 % We need some trickery to remove the optional spaces around the equal
7793 % sign. Make them active and then expand them all to nothing.
7795 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7796 \def\aliasxxx #1{\aliasyyy#1\relax}
7797 \def\aliasyyy #1=#2\relax{%
7799 \expandafter\let\obeyedspace=\empty
7800 \addtomacrolist{#1}%
7801 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7803 \next
7807 \message{cross references,}
7809 \newwrite\auxfile
7810 \newif\ifhavexrefs % True if xref values are known.
7811 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7813 % @inforef is relatively simple.
7814 \def\inforef #1{\inforefzzz #1,,,,**}
7815 \def\inforefzzz #1,#2,#3,#4**{%
7816 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7817 node \samp{\ignorespaces#1{}}}
7819 % @node's only job in TeX is to define \lastnode, which is used in
7820 % cross-references. The @node line might or might not have commas, and
7821 % might or might not have spaces before the first comma, like:
7822 % @node foo , bar , ...
7823 % We don't want such trailing spaces in the node name.
7825 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7827 % also remove a trailing comma, in case of something like this:
7828 % @node Help-Cross, , , Cross-refs
7829 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7830 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7832 \let\nwnode=\node
7833 \let\lastnode=\empty
7835 % Write a cross-reference definition for the current node. #1 is the
7836 % type (Ynumbered, Yappendix, Ynothing).
7838 \def\donoderef#1{%
7839 \ifx\lastnode\empty\else
7840 \setref{\lastnode}{#1}%
7841 \global\let\lastnode=\empty
7845 % @anchor{NAME} -- define xref target at arbitrary point.
7847 \newcount\savesfregister
7849 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7850 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7851 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7853 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7854 % anchor), which consists of three parts:
7855 % 1) NAME-title - the current sectioning name taken from \lastsection,
7856 % or the anchor name.
7857 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7858 % empty for anchors.
7859 % 3) NAME-pg - the page number.
7861 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7862 % floats, there is an additional part, which is not written here:
7863 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7865 \def\setref#1#2{%
7866 \pdfmkdest{#1}%
7867 \iflinks
7869 \atdummies % preserve commands, but don't expand them
7870 \edef\writexrdef##1##2{%
7871 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7872 ##1}{##2}}% these are parameters of \writexrdef
7874 \toks0 = \expandafter{\lastsection}%
7875 \immediate \writexrdef{title}{\the\toks0 }%
7876 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7877 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
7882 % @xrefautosectiontitle on|off says whether @section(ing) names are used
7883 % automatically in xrefs, if the third arg is not explicitly specified.
7884 % This was provided as a "secret" @set xref-automatic-section-title
7885 % variable, now it's official.
7887 \parseargdef\xrefautomaticsectiontitle{%
7888 \def\temp{#1}%
7889 \ifx\temp\onword
7890 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7891 = \empty
7892 \else\ifx\temp\offword
7893 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7894 = \relax
7895 \else
7896 \errhelp = \EMsimple
7897 \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
7898 must be on|off}%
7899 \fi\fi
7902 % \f
7903 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7904 % the node name, #2 the name of the Info cross-reference, #3 the printed
7905 % node name, #4 the name of the Info file, #5 the name of the printed
7906 % manual. All but the node name can be omitted.
7908 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7909 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7910 \def\ref#1{\xrefX[#1,,,,,,,]}
7912 \newbox\toprefbox
7913 \newbox\printedrefnamebox
7914 \newbox\infofilenamebox
7915 \newbox\printedmanualbox
7917 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7918 \unsepspaces
7920 % Get args without leading/trailing spaces.
7921 \def\printedrefname{\ignorespaces #3}%
7922 \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
7924 \def\infofilename{\ignorespaces #4}%
7925 \setbox\infofilenamebox = \hbox{\infofilename\unskip}%
7927 \def\printedmanual{\ignorespaces #5}%
7928 \setbox\printedmanualbox = \hbox{\printedmanual\unskip}%
7930 % If the printed reference name (arg #3) was not explicitly given in
7931 % the @xref, figure out what we want to use.
7932 \ifdim \wd\printedrefnamebox = 0pt
7933 % No printed node name was explicitly given.
7934 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
7935 % Not auto section-title: use node name inside the square brackets.
7936 \def\printedrefname{\ignorespaces #1}%
7937 \else
7938 % Auto section-title: use chapter/section title inside
7939 % the square brackets if we have it.
7940 \ifdim \wd\printedmanualbox > 0pt
7941 % It is in another manual, so we don't have it; use node name.
7942 \def\printedrefname{\ignorespaces #1}%
7943 \else
7944 \ifhavexrefs
7945 % We (should) know the real title if we have the xref values.
7946 \def\printedrefname{\refx{#1-title}{}}%
7947 \else
7948 % Otherwise just copy the Info node name.
7949 \def\printedrefname{\ignorespaces #1}%
7950 \fi%
7955 % Make link in pdf output.
7956 \ifpdf
7957 {\indexnofonts
7958 \turnoffactive
7959 \makevalueexpandable
7960 % This expands tokens, so do it after making catcode changes, so _
7961 % etc. don't get their TeX definitions. This ignores all spaces in
7962 % #4, including (wrongly) those in the middle of the filename.
7963 \getfilename{#4}%
7965 % This (wrongly) does not take account of leading or trailing
7966 % spaces in #1, which should be ignored.
7967 \edef\pdfxrefdest{#1}%
7968 \ifx\pdfxrefdest\empty
7969 \def\pdfxrefdest{Top}% no empty targets
7970 \else
7971 \txiescapepdf\pdfxrefdest % escape PDF special chars
7974 \leavevmode
7975 \startlink attr{/Border [0 0 0]}%
7976 \ifnum\filenamelength>0
7977 goto file{\the\filename.pdf} name{\pdfxrefdest}%
7978 \else
7979 goto name{\pdfmkpgn{\pdfxrefdest}}%
7982 \setcolor{\linkcolor}%
7985 % Float references are printed completely differently: "Figure 1.2"
7986 % instead of "[somenode], p.3". We distinguish them by the
7987 % LABEL-title being set to a magic string.
7989 % Have to otherify everything special to allow the \csname to
7990 % include an _ in the xref name, etc.
7991 \indexnofonts
7992 \turnoffactive
7993 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7994 \csname XR#1-title\endcsname
7996 \iffloat\Xthisreftitle
7997 % If the user specified the print name (third arg) to the ref,
7998 % print it instead of our usual "Figure 1.2".
7999 \ifdim\wd\printedrefnamebox = 0pt
8000 \refx{#1-snt}{}%
8001 \else
8002 \printedrefname
8005 % If the user also gave the printed manual name (fifth arg), append
8006 % "in MANUALNAME".
8007 \ifdim \wd\printedmanualbox > 0pt
8008 \space \putwordin{} \cite{\printedmanual}%
8010 \else
8011 % node/anchor (non-float) references.
8013 % If we use \unhbox to print the node names, TeX does not insert
8014 % empty discretionaries after hyphens, which means that it will not
8015 % find a line break at a hyphen in a node names. Since some manuals
8016 % are best written with fairly long node names, containing hyphens,
8017 % this is a loss. Therefore, we give the text of the node name
8018 % again, so it is as if TeX is seeing it for the first time.
8020 \ifdim \wd\printedmanualbox > 0pt
8021 % Cross-manual reference with a printed manual name.
8023 \crossmanualxref{\cite{\printedmanual\unskip}}%
8025 \else\ifdim \wd\infofilenamebox > 0pt
8026 % Cross-manual reference with only an info filename (arg 4), no
8027 % printed manual name (arg 5). This is essentially the same as
8028 % the case above; we output the filename, since we have nothing else.
8030 \crossmanualxref{\code{\infofilename\unskip}}%
8032 \else
8033 % Reference within this manual.
8035 % _ (for example) has to be the character _ for the purposes of the
8036 % control sequence corresponding to the node, but it has to expand
8037 % into the usual \leavevmode...\vrule stuff for purposes of
8038 % printing. So we \turnoffactive for the \refx-snt, back on for the
8039 % printing, back off for the \refx-pg.
8040 {\turnoffactive
8041 % Only output a following space if the -snt ref is nonempty; for
8042 % @unnumbered and @anchor, it won't be.
8043 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
8044 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
8046 % output the `[mynode]' via the macro below so it can be overridden.
8047 \xrefprintnodename\printedrefname
8049 % But we always want a comma and a space:
8050 ,\space
8052 % output the `page 3'.
8053 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
8054 \fi\fi
8056 \endlink
8057 \endgroup}
8059 % Output a cross-manual xref to #1. Used just above (twice).
8061 % Only include the text "Section ``foo'' in" if the foo is neither
8062 % missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply
8063 % "see The Foo Manual", the idea being to refer to the whole manual.
8065 % But, this being TeX, we can't easily compare our node name against the
8066 % string "Top" while ignoring the possible spaces before and after in
8067 % the input. By adding the arbitrary 7sp below, we make it much less
8068 % likely that a real node name would have the same width as "Top" (e.g.,
8069 % in a monospaced font). Hopefully it will never happen in practice.
8071 % For the same basic reason, we retypeset the "Top" at every
8072 % reference, since the current font is indeterminate.
8074 \def\crossmanualxref#1{%
8075 \setbox\toprefbox = \hbox{Top\kern7sp}%
8076 \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8077 \ifdim \wd2 > 7sp % nonempty?
8078 \ifdim \wd2 = \wd\toprefbox \else % same as Top?
8079 \putwordSection{} ``\printedrefname'' \putwordin{}\space
8085 % This macro is called from \xrefX for the `[nodename]' part of xref
8086 % output. It's a separate macro only so it can be changed more easily,
8087 % since square brackets don't work well in some documents. Particularly
8088 % one that Bob is working on :).
8090 \def\xrefprintnodename#1{[#1]}
8092 % Things referred to by \setref.
8094 \def\Ynothing{}
8095 \def\Yomitfromtoc{}
8096 \def\Ynumbered{%
8097 \ifnum\secno=0
8098 \putwordChapter@tie \the\chapno
8099 \else \ifnum\subsecno=0
8100 \putwordSection@tie \the\chapno.\the\secno
8101 \else \ifnum\subsubsecno=0
8102 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
8103 \else
8104 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
8105 \fi\fi\fi
8107 \def\Yappendix{%
8108 \ifnum\secno=0
8109 \putwordAppendix@tie @char\the\appendixno{}%
8110 \else \ifnum\subsecno=0
8111 \putwordSection@tie @char\the\appendixno.\the\secno
8112 \else \ifnum\subsubsecno=0
8113 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
8114 \else
8115 \putwordSection@tie
8116 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
8117 \fi\fi\fi
8120 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
8121 % If its value is nonempty, SUFFIX is output afterward.
8123 \def\refx#1#2{%
8125 \indexnofonts
8126 \otherbackslash
8127 \expandafter\global\expandafter\let\expandafter\thisrefX
8128 \csname XR#1\endcsname
8130 \ifx\thisrefX\relax
8131 % If not defined, say something at least.
8132 \angleleft un\-de\-fined\angleright
8133 \iflinks
8134 \ifhavexrefs
8135 {\toks0 = {#1}% avoid expansion of possibly-complex value
8136 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
8137 \else
8138 \ifwarnedxrefs\else
8139 \global\warnedxrefstrue
8140 \message{Cross reference values unknown; you must run TeX again.}%
8144 \else
8145 % It's defined, so just use it.
8146 \thisrefX
8148 #2% Output the suffix in any case.
8151 % This is the macro invoked by entries in the aux file. Usually it's
8152 % just a \def (we prepend XR to the control sequence name to avoid
8153 % collisions). But if this is a float type, we have more work to do.
8155 \def\xrdef#1#2{%
8156 {% The node name might contain 8-bit characters, which in our current
8157 % implementation are changed to commands like @'e. Don't let these
8158 % mess up the control sequence name.
8159 \indexnofonts
8160 \turnoffactive
8161 \xdef\safexrefname{#1}%
8164 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
8166 % Was that xref control sequence that we just defined for a float?
8167 \expandafter\iffloat\csname XR\safexrefname\endcsname
8168 % it was a float, and we have the (safe) float type in \iffloattype.
8169 \expandafter\let\expandafter\floatlist
8170 \csname floatlist\iffloattype\endcsname
8172 % Is this the first time we've seen this float type?
8173 \expandafter\ifx\floatlist\relax
8174 \toks0 = {\do}% yes, so just \do
8175 \else
8176 % had it before, so preserve previous elements in list.
8177 \toks0 = \expandafter{\floatlist\do}%
8180 % Remember this xref in the control sequence \floatlistFLOATTYPE,
8181 % for later use in \listoffloats.
8182 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
8183 {\safexrefname}}%
8187 % Read the last existing aux file, if any. No error if none exists.
8189 \def\tryauxfile{%
8190 \openin 1 \jobname.aux
8191 \ifeof 1 \else
8192 \readdatafile{aux}%
8193 \global\havexrefstrue
8195 \closein 1
8198 \def\setupdatafile{%
8199 \catcode`\^^@=\other
8200 \catcode`\^^A=\other
8201 \catcode`\^^B=\other
8202 \catcode`\^^C=\other
8203 \catcode`\^^D=\other
8204 \catcode`\^^E=\other
8205 \catcode`\^^F=\other
8206 \catcode`\^^G=\other
8207 \catcode`\^^H=\other
8208 \catcode`\^^K=\other
8209 \catcode`\^^L=\other
8210 \catcode`\^^N=\other
8211 \catcode`\^^P=\other
8212 \catcode`\^^Q=\other
8213 \catcode`\^^R=\other
8214 \catcode`\^^S=\other
8215 \catcode`\^^T=\other
8216 \catcode`\^^U=\other
8217 \catcode`\^^V=\other
8218 \catcode`\^^W=\other
8219 \catcode`\^^X=\other
8220 \catcode`\^^Z=\other
8221 \catcode`\^^[=\other
8222 \catcode`\^^\=\other
8223 \catcode`\^^]=\other
8224 \catcode`\^^^=\other
8225 \catcode`\^^_=\other
8226 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8227 % in xref tags, i.e., node names. But since ^^e4 notation isn't
8228 % supported in the main text, it doesn't seem desirable. Furthermore,
8229 % that is not enough: for node names that actually contain a ^
8230 % character, we would end up writing a line like this: 'xrdef {'hat
8231 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8232 % argument, and \hat is not an expandable control sequence. It could
8233 % all be worked out, but why? Either we support ^^ or we don't.
8235 % The other change necessary for this was to define \auxhat:
8236 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8237 % and then to call \auxhat in \setq.
8239 \catcode`\^=\other
8241 % Special characters. Should be turned off anyway, but...
8242 \catcode`\~=\other
8243 \catcode`\[=\other
8244 \catcode`\]=\other
8245 \catcode`\"=\other
8246 \catcode`\_=\other
8247 \catcode`\|=\other
8248 \catcode`\<=\other
8249 \catcode`\>=\other
8250 \catcode`\$=\other
8251 \catcode`\#=\other
8252 \catcode`\&=\other
8253 \catcode`\%=\other
8254 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
8256 % This is to support \ in node names and titles, since the \
8257 % characters end up in a \csname. It's easier than
8258 % leaving it active and making its active definition an actual \
8259 % character. What I don't understand is why it works in the *value*
8260 % of the xrdef. Seems like it should be a catcode12 \, and that
8261 % should not typeset properly. But it works, so I'm moving on for
8262 % now. --karl, 15jan04.
8263 \catcode`\\=\other
8265 % Make the characters 128-255 be printing characters.
8267 \count1=128
8268 \def\loop{%
8269 \catcode\count1=\other
8270 \advance\count1 by 1
8271 \ifnum \count1<256 \loop \fi
8275 % @ is our escape character in .aux files, and we need braces.
8276 \catcode`\{=1
8277 \catcode`\}=2
8278 \catcode`\@=0
8281 \def\readdatafile#1{%
8282 \begingroup
8283 \setupdatafile
8284 \input\jobname.#1
8285 \endgroup}
8288 \message{insertions,}
8289 % including footnotes.
8291 \newcount \footnoteno
8293 % The trailing space in the following definition for supereject is
8294 % vital for proper filling; pages come out unaligned when you do a
8295 % pagealignmacro call if that space before the closing brace is
8296 % removed. (Generally, numeric constants should always be followed by a
8297 % space to prevent strange expansion errors.)
8298 \def\supereject{\par\penalty -20000\footnoteno =0 }
8300 % @footnotestyle is meaningful for Info output only.
8301 \let\footnotestyle=\comment
8303 {\catcode `\@=11
8305 % Auto-number footnotes. Otherwise like plain.
8306 \gdef\footnote{%
8307 \let\indent=\ptexindent
8308 \let\noindent=\ptexnoindent
8309 \global\advance\footnoteno by \@ne
8310 \edef\thisfootno{$^{\the\footnoteno}$}%
8312 % In case the footnote comes at the end of a sentence, preserve the
8313 % extra spacing after we do the footnote number.
8314 \let\@sf\empty
8315 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
8317 % Remove inadvertent blank space before typesetting the footnote number.
8318 \unskip
8319 \thisfootno\@sf
8320 \dofootnote
8323 % Don't bother with the trickery in plain.tex to not require the
8324 % footnote text as a parameter. Our footnotes don't need to be so general.
8326 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8327 % \parseargline) fails inside footnotes because the tokens are fixed when
8328 % the footnote is read. --karl, 16nov96.
8330 \gdef\dofootnote{%
8331 \insert\footins\bgroup
8332 % We want to typeset this text as a normal paragraph, even if the
8333 % footnote reference occurs in (for example) a display environment.
8334 % So reset some parameters.
8335 \hsize=\pagewidth
8336 \interlinepenalty\interfootnotelinepenalty
8337 \splittopskip\ht\strutbox % top baseline for broken footnotes
8338 \splitmaxdepth\dp\strutbox
8339 \floatingpenalty\@MM
8340 \leftskip\z@skip
8341 \rightskip\z@skip
8342 \spaceskip\z@skip
8343 \xspaceskip\z@skip
8344 \parindent\defaultparindent
8346 \smallfonts \rm
8348 % Because we use hanging indentation in footnotes, a @noindent appears
8349 % to exdent this text, so make it be a no-op. makeinfo does not use
8350 % hanging indentation so @noindent can still be needed within footnote
8351 % text after an @example or the like (not that this is good style).
8352 \let\noindent = \relax
8354 % Hang the footnote text off the number. Use \everypar in case the
8355 % footnote extends for more than one paragraph.
8356 \everypar = {\hang}%
8357 \textindent{\thisfootno}%
8359 % Don't crash into the line above the footnote text. Since this
8360 % expands into a box, it must come within the paragraph, lest it
8361 % provide a place where TeX can split the footnote.
8362 \footstrut
8364 % Invoke rest of plain TeX footnote routine.
8365 \futurelet\next\fo@t
8367 }%end \catcode `\@=11
8369 % In case a @footnote appears in a vbox, save the footnote text and create
8370 % the real \insert just after the vbox finished. Otherwise, the insertion
8371 % would be lost.
8372 % Similarly, if a @footnote appears inside an alignment, save the footnote
8373 % text to a box and make the \insert when a row of the table is finished.
8374 % And the same can be done for other insert classes. --kasal, 16nov03.
8376 % Replace the \insert primitive by a cheating macro.
8377 % Deeper inside, just make sure that the saved insertions are not spilled
8378 % out prematurely.
8380 \def\startsavinginserts{%
8381 \ifx \insert\ptexinsert
8382 \let\insert\saveinsert
8383 \else
8384 \let\checkinserts\relax
8388 % This \insert replacement works for both \insert\footins{foo} and
8389 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8391 \def\saveinsert#1{%
8392 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8393 \afterassignment\next
8394 % swallow the left brace
8395 \let\temp =
8397 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
8398 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
8400 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8402 \def\placesaveins#1{%
8403 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8404 {\box#1}%
8407 % eat @SAVE -- beware, all of them have catcode \other:
8409 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
8410 \gdef\gobblesave @SAVE{}
8413 % initialization:
8414 \def\newsaveins #1{%
8415 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8416 \next
8418 \def\newsaveinsX #1{%
8419 \csname newbox\endcsname #1%
8420 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8421 \checksaveins #1}%
8424 % initialize:
8425 \let\checkinserts\empty
8426 \newsaveins\footins
8427 \newsaveins\margin
8430 % @image. We use the macros from epsf.tex to support this.
8431 % If epsf.tex is not installed and @image is used, we complain.
8433 % Check for and read epsf.tex up front. If we read it only at @image
8434 % time, we might be inside a group, and then its definitions would get
8435 % undone and the next image would fail.
8436 \openin 1 = epsf.tex
8437 \ifeof 1 \else
8438 % Do not bother showing banner with epsf.tex v2.7k (available in
8439 % doc/epsf.tex and on ctan).
8440 \def\epsfannounce{\toks0 = }%
8441 \input epsf.tex
8443 \closein 1
8445 % We will only complain once about lack of epsf.tex.
8446 \newif\ifwarnednoepsf
8447 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8448 work. It is also included in the Texinfo distribution, or you can get
8449 it from ftp://tug.org/tex/epsf.tex.}
8451 \def\image#1{%
8452 \ifx\epsfbox\thisisundefined
8453 \ifwarnednoepsf \else
8454 \errhelp = \noepsfhelp
8455 \errmessage{epsf.tex not found, images will be ignored}%
8456 \global\warnednoepsftrue
8458 \else
8459 \imagexxx #1,,,,,\finish
8463 % Arguments to @image:
8464 % #1 is (mandatory) image filename; we tack on .eps extension.
8465 % #2 is (optional) width, #3 is (optional) height.
8466 % #4 is (ignored optional) html alt text.
8467 % #5 is (ignored optional) extension.
8468 % #6 is just the usual extra ignored arg for parsing stuff.
8469 \newif\ifimagevmode
8470 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
8471 \catcode`\^^M = 5 % in case we're inside an example
8472 \normalturnoffactive % allow _ et al. in names
8473 % If the image is by itself, center it.
8474 \ifvmode
8475 \imagevmodetrue
8476 \else \ifx\centersub\centerV
8477 % for @center @image, we need a vbox so we can have our vertical space
8478 \imagevmodetrue
8479 \vbox\bgroup % vbox has better behavior than vtop herev
8480 \fi\fi
8482 \ifimagevmode
8483 \nobreak\medskip
8484 % Usually we'll have text after the image which will insert
8485 % \parskip glue, so insert it here too to equalize the space
8486 % above and below.
8487 \nobreak\vskip\parskip
8488 \nobreak
8491 % Leave vertical mode so that indentation from an enclosing
8492 % environment such as @quotation is respected.
8493 % However, if we're at the top level, we don't want the
8494 % normal paragraph indentation.
8495 % On the other hand, if we are in the case of @center @image, we don't
8496 % want to start a paragraph, which will create a hsize-width box and
8497 % eradicate the centering.
8498 \ifx\centersub\centerV\else \noindent \fi
8500 % Output the image.
8501 \ifpdf
8502 \dopdfimage{#1}{#2}{#3}%
8503 \else
8504 % \epsfbox itself resets \epsf?size at each figure.
8505 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
8506 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
8507 \epsfbox{#1.eps}%
8510 \ifimagevmode
8511 \medskip % space after a standalone image
8512 \fi
8513 \ifx\centersub\centerV \egroup \fi
8514 \endgroup}
8517 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8518 % etc. We don't actually implement floating yet, we always include the
8519 % float "here". But it seemed the best name for the future.
8521 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
8523 % There may be a space before second and/or third parameter; delete it.
8524 \def\eatcommaspace#1, {#1,}
8526 % #1 is the optional FLOATTYPE, the text label for this float, typically
8527 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
8528 % this float will not be numbered and cannot be referred to.
8530 % #2 is the optional xref label. Also must be present for the float to
8531 % be referable.
8533 % #3 is the optional positioning argument; for now, it is ignored. It
8534 % will somehow specify the positions allowed to float to (here, top, bottom).
8536 % We keep a separate counter for each FLOATTYPE, which we reset at each
8537 % chapter-level command.
8538 \let\resetallfloatnos=\empty
8540 \def\dofloat#1,#2,#3,#4\finish{%
8541 \let\thiscaption=\empty
8542 \let\thisshortcaption=\empty
8544 % don't lose footnotes inside @float.
8546 % BEWARE: when the floats start float, we have to issue warning whenever an
8547 % insert appears inside a float which could possibly float. --kasal, 26may04
8549 \startsavinginserts
8551 % We can't be used inside a paragraph.
8552 \par
8554 \vtop\bgroup
8555 \def\floattype{#1}%
8556 \def\floatlabel{#2}%
8557 \def\floatloc{#3}% we do nothing with this yet.
8559 \ifx\floattype\empty
8560 \let\safefloattype=\empty
8561 \else
8563 % the floattype might have accents or other special characters,
8564 % but we need to use it in a control sequence name.
8565 \indexnofonts
8566 \turnoffactive
8567 \xdef\safefloattype{\floattype}%
8571 % If label is given but no type, we handle that as the empty type.
8572 \ifx\floatlabel\empty \else
8573 % We want each FLOATTYPE to be numbered separately (Figure 1,
8574 % Table 1, Figure 2, ...). (And if no label, no number.)
8576 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
8577 \global\advance\floatno by 1
8580 % This magic value for \lastsection is output by \setref as the
8581 % XREFLABEL-title value. \xrefX uses it to distinguish float
8582 % labels (which have a completely different output format) from
8583 % node and anchor labels. And \xrdef uses it to construct the
8584 % lists of floats.
8586 \edef\lastsection{\floatmagic=\safefloattype}%
8587 \setref{\floatlabel}{Yfloat}%
8591 % start with \parskip glue, I guess.
8592 \vskip\parskip
8594 % Don't suppress indentation if a float happens to start a section.
8595 \restorefirstparagraphindent
8598 % we have these possibilities:
8599 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8600 % @float Foo,lbl & no caption: Foo 1.1
8601 % @float Foo & @caption{Cap}: Foo: Cap
8602 % @float Foo & no caption: Foo
8603 % @float ,lbl & Caption{Cap}: 1.1: Cap
8604 % @float ,lbl & no caption: 1.1
8605 % @float & @caption{Cap}: Cap
8606 % @float & no caption:
8608 \def\Efloat{%
8609 \let\floatident = \empty
8611 % In all cases, if we have a float type, it comes first.
8612 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8614 % If we have an xref label, the number comes next.
8615 \ifx\floatlabel\empty \else
8616 \ifx\floattype\empty \else % if also had float type, need tie first.
8617 \appendtomacro\floatident{\tie}%
8619 % the number.
8620 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8623 % Start the printed caption with what we've constructed in
8624 % \floatident, but keep it separate; we need \floatident again.
8625 \let\captionline = \floatident
8627 \ifx\thiscaption\empty \else
8628 \ifx\floatident\empty \else
8629 \appendtomacro\captionline{: }% had ident, so need a colon between
8632 % caption text.
8633 \appendtomacro\captionline{\scanexp\thiscaption}%
8636 % If we have anything to print, print it, with space before.
8637 % Eventually this needs to become an \insert.
8638 \ifx\captionline\empty \else
8639 \vskip.5\parskip
8640 \captionline
8642 % Space below caption.
8643 \vskip\parskip
8646 % If have an xref label, write the list of floats info. Do this
8647 % after the caption, to avoid chance of it being a breakpoint.
8648 \ifx\floatlabel\empty \else
8649 % Write the text that goes in the lof to the aux file as
8650 % \floatlabel-lof. Besides \floatident, we include the short
8651 % caption if specified, else the full caption if specified, else nothing.
8653 \atdummies
8655 % since we read the caption text in the macro world, where ^^M
8656 % is turned into a normal character, we have to scan it back, so
8657 % we don't write the literal three characters "^^M" into the aux file.
8658 \scanexp{%
8659 \xdef\noexpand\gtemp{%
8660 \ifx\thisshortcaption\empty
8661 \thiscaption
8662 \else
8663 \thisshortcaption
8667 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
8668 \ifx\gtemp\empty \else : \gtemp \fi}}%
8671 \egroup % end of \vtop
8673 % place the captured inserts
8675 % BEWARE: when the floats start floating, we have to issue warning
8676 % whenever an insert appears inside a float which could possibly
8677 % float. --kasal, 26may04
8679 \checkinserts
8682 % Append the tokens #2 to the definition of macro #1, not expanding either.
8684 \def\appendtomacro#1#2{%
8685 \expandafter\def\expandafter#1\expandafter{#1#2}%
8688 % @caption, @shortcaption
8690 \def\caption{\docaption\thiscaption}
8691 \def\shortcaption{\docaption\thisshortcaption}
8692 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8693 \def\defcaption#1#2{\egroup \def#1{#2}}
8695 % The parameter is the control sequence identifying the counter we are
8696 % going to use. Create it if it doesn't exist and assign it to \floatno.
8697 \def\getfloatno#1{%
8698 \ifx#1\relax
8699 % Haven't seen this figure type before.
8700 \csname newcount\endcsname #1%
8702 % Remember to reset this floatno at the next chap.
8703 \expandafter\gdef\expandafter\resetallfloatnos
8704 \expandafter{\resetallfloatnos #1=0 }%
8706 \let\floatno#1%
8709 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8710 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8711 % first read the @float command.
8713 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
8715 % Magic string used for the XREFLABEL-title value, so \xrefX can
8716 % distinguish floats from other xref types.
8717 \def\floatmagic{!!float!!}
8719 % #1 is the control sequence we are passed; we expand into a conditional
8720 % which is true if #1 represents a float ref. That is, the magic
8721 % \lastsection value which we \setref above.
8723 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
8725 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8726 % (safe) float type for this float. We set \iffloattype to #2.
8728 \def\doiffloat#1=#2=#3\finish{%
8729 \def\temp{#1}%
8730 \def\iffloattype{#2}%
8731 \ifx\temp\floatmagic
8734 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8736 \parseargdef\listoffloats{%
8737 \def\floattype{#1}% floattype
8739 % the floattype might have accents or other special characters,
8740 % but we need to use it in a control sequence name.
8741 \indexnofonts
8742 \turnoffactive
8743 \xdef\safefloattype{\floattype}%
8746 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8747 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8748 \ifhavexrefs
8749 % if the user said @listoffloats foo but never @float foo.
8750 \message{\linenumber No `\safefloattype' floats to list.}%
8752 \else
8753 \begingroup
8754 \leftskip=\tocindent % indent these entries like a toc
8755 \let\do=\listoffloatsdo
8756 \csname floatlist\safefloattype\endcsname
8757 \endgroup
8761 % This is called on each entry in a list of floats. We're passed the
8762 % xref label, in the form LABEL-title, which is how we save it in the
8763 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8764 % has the text we're supposed to typeset here.
8766 % Figures without xref labels will not be included in the list (since
8767 % they won't appear in the aux file).
8769 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8770 \def\listoffloatsdoentry#1-title\finish{{%
8771 % Can't fully expand XR#1-lof because it can contain anything. Just
8772 % pass the control sequence. On the other hand, XR#1-pg is just the
8773 % page number, and we want to fully expand that so we can get a link
8774 % in pdf output.
8775 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8777 % use the same \entry macro we use to generate the TOC and index.
8778 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8779 \writeentry
8783 \message{localization,}
8785 % For single-language documents, @documentlanguage is usually given very
8786 % early, just after @documentencoding. Single argument is the language
8787 % (de) or locale (de_DE) abbreviation.
8790 \catcode`\_ = \active
8791 \globaldefs=1
8792 \parseargdef\documentlanguage{\begingroup
8793 \let_=\normalunderscore % normal _ character for filenames
8794 \tex % read txi-??.tex file in plain TeX.
8795 % Read the file by the name they passed if it exists.
8796 \openin 1 txi-#1.tex
8797 \ifeof 1
8798 \documentlanguagetrywithoutunderscore{#1_\finish}%
8799 \else
8800 \globaldefs = 1 % everything in the txi-LL files needs to persist
8801 \input txi-#1.tex
8803 \closein 1
8804 \endgroup % end raw TeX
8805 \endgroup}
8807 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8808 % try txi-de.tex.
8810 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8811 \openin 1 txi-#1.tex
8812 \ifeof 1
8813 \errhelp = \nolanghelp
8814 \errmessage{Cannot read language file txi-#1.tex}%
8815 \else
8816 \globaldefs = 1 % everything in the txi-LL files needs to persist
8817 \input txi-#1.tex
8819 \closein 1
8821 }% end of special _ catcode
8823 \newhelp\nolanghelp{The given language definition file cannot be found or
8824 is empty. Maybe you need to install it? Putting it in the current
8825 directory should work if nowhere else does.}
8827 % This macro is called from txi-??.tex files; the first argument is the
8828 % \language name to set (without the "\lang@" prefix), the second and
8829 % third args are \{left,right}hyphenmin.
8831 % The language names to pass are determined when the format is built.
8832 % See the etex.log file created at that time, e.g.,
8833 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8835 % With TeX Live 2008, etex now includes hyphenation patterns for all
8836 % available languages. This means we can support hyphenation in
8837 % Texinfo, at least to some extent. (This still doesn't solve the
8838 % accented characters problem.)
8840 \catcode`@=11
8841 \def\txisetlanguage#1#2#3{%
8842 % do not set the language if the name is undefined in the current TeX.
8843 \expandafter\ifx\csname lang@#1\endcsname \relax
8844 \message{no patterns for #1}%
8845 \else
8846 \global\language = \csname lang@#1\endcsname
8848 % but there is no harm in adjusting the hyphenmin values regardless.
8849 \global\lefthyphenmin = #2\relax
8850 \global\righthyphenmin = #3\relax
8853 % Helpers for encodings.
8854 % Set the catcode of characters 128 through 255 to the specified number.
8856 \def\setnonasciicharscatcode#1{%
8857 \count255=128
8858 \loop\ifnum\count255<256
8859 \global\catcode\count255=#1\relax
8860 \advance\count255 by 1
8861 \repeat
8864 \def\setnonasciicharscatcodenonglobal#1{%
8865 \count255=128
8866 \loop\ifnum\count255<256
8867 \catcode\count255=#1\relax
8868 \advance\count255 by 1
8869 \repeat
8872 % @documentencoding sets the definition of non-ASCII characters
8873 % according to the specified encoding.
8875 \parseargdef\documentencoding{%
8876 % Encoding being declared for the document.
8877 \def\declaredencoding{\csname #1.enc\endcsname}%
8879 % Supported encodings: names converted to tokens in order to be able
8880 % to compare them with \ifx.
8881 \def\ascii{\csname US-ASCII.enc\endcsname}%
8882 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8883 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8884 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8885 \def\utfeight{\csname UTF-8.enc\endcsname}%
8887 \ifx \declaredencoding \ascii
8888 \asciichardefs
8890 \else \ifx \declaredencoding \lattwo
8891 \setnonasciicharscatcode\active
8892 \lattwochardefs
8894 \else \ifx \declaredencoding \latone
8895 \setnonasciicharscatcode\active
8896 \latonechardefs
8898 \else \ifx \declaredencoding \latnine
8899 \setnonasciicharscatcode\active
8900 \latninechardefs
8902 \else \ifx \declaredencoding \utfeight
8903 \setnonasciicharscatcode\active
8904 \utfeightchardefs
8906 \else
8907 \message{Unknown document encoding #1, ignoring.}%
8909 \fi % utfeight
8910 \fi % latnine
8911 \fi % latone
8912 \fi % lattwo
8913 \fi % ascii
8916 % A message to be logged when using a character that isn't available
8917 % the default font encoding (OT1).
8919 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8921 % Take account of \c (plain) vs. \, (Texinfo) difference.
8922 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8924 % First, make active non-ASCII characters in order for them to be
8925 % correctly categorized when TeX reads the replacement text of
8926 % macros containing the character definitions.
8927 \setnonasciicharscatcode\active
8929 % Latin1 (ISO-8859-1) character definitions.
8930 \def\latonechardefs{%
8931 \gdef^^a0{\tie}
8932 \gdef^^a1{\exclamdown}
8933 \gdef^^a2{\missingcharmsg{CENT SIGN}}
8934 \gdef^^a3{{\pounds}}
8935 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8936 \gdef^^a5{\missingcharmsg{YEN SIGN}}
8937 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8938 \gdef^^a7{\S}
8939 \gdef^^a8{\"{}}
8940 \gdef^^a9{\copyright}
8941 \gdef^^aa{\ordf}
8942 \gdef^^ab{\guillemetleft}
8943 \gdef^^ac{$\lnot$}
8944 \gdef^^ad{\-}
8945 \gdef^^ae{\registeredsymbol}
8946 \gdef^^af{\={}}
8948 \gdef^^b0{\textdegree}
8949 \gdef^^b1{$\pm$}
8950 \gdef^^b2{$^2$}
8951 \gdef^^b3{$^3$}
8952 \gdef^^b4{\'{}}
8953 \gdef^^b5{$\mu$}
8954 \gdef^^b6{\P}
8956 \gdef^^b7{$^.$}
8957 \gdef^^b8{\cedilla\ }
8958 \gdef^^b9{$^1$}
8959 \gdef^^ba{\ordm}
8961 \gdef^^bb{\guillemetright}
8962 \gdef^^bc{$1\over4$}
8963 \gdef^^bd{$1\over2$}
8964 \gdef^^be{$3\over4$}
8965 \gdef^^bf{\questiondown}
8967 \gdef^^c0{\`A}
8968 \gdef^^c1{\'A}
8969 \gdef^^c2{\^A}
8970 \gdef^^c3{\~A}
8971 \gdef^^c4{\"A}
8972 \gdef^^c5{\ringaccent A}
8973 \gdef^^c6{\AE}
8974 \gdef^^c7{\cedilla C}
8975 \gdef^^c8{\`E}
8976 \gdef^^c9{\'E}
8977 \gdef^^ca{\^E}
8978 \gdef^^cb{\"E}
8979 \gdef^^cc{\`I}
8980 \gdef^^cd{\'I}
8981 \gdef^^ce{\^I}
8982 \gdef^^cf{\"I}
8984 \gdef^^d0{\DH}
8985 \gdef^^d1{\~N}
8986 \gdef^^d2{\`O}
8987 \gdef^^d3{\'O}
8988 \gdef^^d4{\^O}
8989 \gdef^^d5{\~O}
8990 \gdef^^d6{\"O}
8991 \gdef^^d7{$\times$}
8992 \gdef^^d8{\O}
8993 \gdef^^d9{\`U}
8994 \gdef^^da{\'U}
8995 \gdef^^db{\^U}
8996 \gdef^^dc{\"U}
8997 \gdef^^dd{\'Y}
8998 \gdef^^de{\TH}
8999 \gdef^^df{\ss}
9001 \gdef^^e0{\`a}
9002 \gdef^^e1{\'a}
9003 \gdef^^e2{\^a}
9004 \gdef^^e3{\~a}
9005 \gdef^^e4{\"a}
9006 \gdef^^e5{\ringaccent a}
9007 \gdef^^e6{\ae}
9008 \gdef^^e7{\cedilla c}
9009 \gdef^^e8{\`e}
9010 \gdef^^e9{\'e}
9011 \gdef^^ea{\^e}
9012 \gdef^^eb{\"e}
9013 \gdef^^ec{\`{\dotless i}}
9014 \gdef^^ed{\'{\dotless i}}
9015 \gdef^^ee{\^{\dotless i}}
9016 \gdef^^ef{\"{\dotless i}}
9018 \gdef^^f0{\dh}
9019 \gdef^^f1{\~n}
9020 \gdef^^f2{\`o}
9021 \gdef^^f3{\'o}
9022 \gdef^^f4{\^o}
9023 \gdef^^f5{\~o}
9024 \gdef^^f6{\"o}
9025 \gdef^^f7{$\div$}
9026 \gdef^^f8{\o}
9027 \gdef^^f9{\`u}
9028 \gdef^^fa{\'u}
9029 \gdef^^fb{\^u}
9030 \gdef^^fc{\"u}
9031 \gdef^^fd{\'y}
9032 \gdef^^fe{\th}
9033 \gdef^^ff{\"y}
9036 % Latin9 (ISO-8859-15) encoding character definitions.
9037 \def\latninechardefs{%
9038 % Encoding is almost identical to Latin1.
9039 \latonechardefs
9041 \gdef^^a4{\euro}
9042 \gdef^^a6{\v S}
9043 \gdef^^a8{\v s}
9044 \gdef^^b4{\v Z}
9045 \gdef^^b8{\v z}
9046 \gdef^^bc{\OE}
9047 \gdef^^bd{\oe}
9048 \gdef^^be{\"Y}
9051 % Latin2 (ISO-8859-2) character definitions.
9052 \def\lattwochardefs{%
9053 \gdef^^a0{\tie}
9054 \gdef^^a1{\ogonek{A}}
9055 \gdef^^a2{\u{}}
9056 \gdef^^a3{\L}
9057 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
9058 \gdef^^a5{\v L}
9059 \gdef^^a6{\'S}
9060 \gdef^^a7{\S}
9061 \gdef^^a8{\"{}}
9062 \gdef^^a9{\v S}
9063 \gdef^^aa{\cedilla S}
9064 \gdef^^ab{\v T}
9065 \gdef^^ac{\'Z}
9066 \gdef^^ad{\-}
9067 \gdef^^ae{\v Z}
9068 \gdef^^af{\dotaccent Z}
9070 \gdef^^b0{\textdegree}
9071 \gdef^^b1{\ogonek{a}}
9072 \gdef^^b2{\ogonek{ }}
9073 \gdef^^b3{\l}
9074 \gdef^^b4{\'{}}
9075 \gdef^^b5{\v l}
9076 \gdef^^b6{\'s}
9077 \gdef^^b7{\v{}}
9078 \gdef^^b8{\cedilla\ }
9079 \gdef^^b9{\v s}
9080 \gdef^^ba{\cedilla s}
9081 \gdef^^bb{\v t}
9082 \gdef^^bc{\'z}
9083 \gdef^^bd{\H{}}
9084 \gdef^^be{\v z}
9085 \gdef^^bf{\dotaccent z}
9087 \gdef^^c0{\'R}
9088 \gdef^^c1{\'A}
9089 \gdef^^c2{\^A}
9090 \gdef^^c3{\u A}
9091 \gdef^^c4{\"A}
9092 \gdef^^c5{\'L}
9093 \gdef^^c6{\'C}
9094 \gdef^^c7{\cedilla C}
9095 \gdef^^c8{\v C}
9096 \gdef^^c9{\'E}
9097 \gdef^^ca{\ogonek{E}}
9098 \gdef^^cb{\"E}
9099 \gdef^^cc{\v E}
9100 \gdef^^cd{\'I}
9101 \gdef^^ce{\^I}
9102 \gdef^^cf{\v D}
9104 \gdef^^d0{\DH}
9105 \gdef^^d1{\'N}
9106 \gdef^^d2{\v N}
9107 \gdef^^d3{\'O}
9108 \gdef^^d4{\^O}
9109 \gdef^^d5{\H O}
9110 \gdef^^d6{\"O}
9111 \gdef^^d7{$\times$}
9112 \gdef^^d8{\v R}
9113 \gdef^^d9{\ringaccent U}
9114 \gdef^^da{\'U}
9115 \gdef^^db{\H U}
9116 \gdef^^dc{\"U}
9117 \gdef^^dd{\'Y}
9118 \gdef^^de{\cedilla T}
9119 \gdef^^df{\ss}
9121 \gdef^^e0{\'r}
9122 \gdef^^e1{\'a}
9123 \gdef^^e2{\^a}
9124 \gdef^^e3{\u a}
9125 \gdef^^e4{\"a}
9126 \gdef^^e5{\'l}
9127 \gdef^^e6{\'c}
9128 \gdef^^e7{\cedilla c}
9129 \gdef^^e8{\v c}
9130 \gdef^^e9{\'e}
9131 \gdef^^ea{\ogonek{e}}
9132 \gdef^^eb{\"e}
9133 \gdef^^ec{\v e}
9134 \gdef^^ed{\'{\dotless{i}}}
9135 \gdef^^ee{\^{\dotless{i}}}
9136 \gdef^^ef{\v d}
9138 \gdef^^f0{\dh}
9139 \gdef^^f1{\'n}
9140 \gdef^^f2{\v n}
9141 \gdef^^f3{\'o}
9142 \gdef^^f4{\^o}
9143 \gdef^^f5{\H o}
9144 \gdef^^f6{\"o}
9145 \gdef^^f7{$\div$}
9146 \gdef^^f8{\v r}
9147 \gdef^^f9{\ringaccent u}
9148 \gdef^^fa{\'u}
9149 \gdef^^fb{\H u}
9150 \gdef^^fc{\"u}
9151 \gdef^^fd{\'y}
9152 \gdef^^fe{\cedilla t}
9153 \gdef^^ff{\dotaccent{}}
9156 % UTF-8 character definitions.
9158 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
9159 % changes for Texinfo conventions. It is included here under the GPL by
9160 % permission from Frank Mittelbach and the LaTeX team.
9162 \newcount\countUTFx
9163 \newcount\countUTFy
9164 \newcount\countUTFz
9166 \gdef\UTFviiiTwoOctets#1#2{\expandafter
9167 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
9169 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
9170 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
9172 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
9173 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
9175 \gdef\UTFviiiDefined#1{%
9176 \ifx #1\relax
9177 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
9178 \else
9179 \expandafter #1%
9183 \begingroup
9184 \catcode`\~13
9185 \catcode`\"12
9187 \def\UTFviiiLoop{%
9188 \global\catcode\countUTFx\active
9189 \uccode`\~\countUTFx
9190 \uppercase\expandafter{\UTFviiiTmp}%
9191 \advance\countUTFx by 1
9192 \ifnum\countUTFx < \countUTFy
9193 \expandafter\UTFviiiLoop
9194 \fi}
9196 \countUTFx = "C2
9197 \countUTFy = "E0
9198 \def\UTFviiiTmp{%
9199 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
9200 \UTFviiiLoop
9202 \countUTFx = "E0
9203 \countUTFy = "F0
9204 \def\UTFviiiTmp{%
9205 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
9206 \UTFviiiLoop
9208 \countUTFx = "F0
9209 \countUTFy = "F4
9210 \def\UTFviiiTmp{%
9211 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
9212 \UTFviiiLoop
9213 \endgroup
9215 \begingroup
9216 \catcode`\"=12
9217 \catcode`\<=12
9218 \catcode`\.=12
9219 \catcode`\,=12
9220 \catcode`\;=12
9221 \catcode`\!=12
9222 \catcode`\~=13
9224 \gdef\DeclareUnicodeCharacter#1#2{%
9225 \countUTFz = "#1\relax
9226 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9227 \begingroup
9228 \parseXMLCharref
9229 \def\UTFviiiTwoOctets##1##2{%
9230 \csname u8:##1\string ##2\endcsname}%
9231 \def\UTFviiiThreeOctets##1##2##3{%
9232 \csname u8:##1\string ##2\string ##3\endcsname}%
9233 \def\UTFviiiFourOctets##1##2##3##4{%
9234 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
9235 \expandafter\expandafter\expandafter\expandafter
9236 \expandafter\expandafter\expandafter
9237 \gdef\UTFviiiTmp{#2}%
9238 \endgroup}
9240 \gdef\parseXMLCharref{%
9241 \ifnum\countUTFz < "A0\relax
9242 \errhelp = \EMsimple
9243 \errmessage{Cannot define Unicode char value < 00A0}%
9244 \else\ifnum\countUTFz < "800\relax
9245 \parseUTFviiiA,%
9246 \parseUTFviiiB C\UTFviiiTwoOctets.,%
9247 \else\ifnum\countUTFz < "10000\relax
9248 \parseUTFviiiA;%
9249 \parseUTFviiiA,%
9250 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
9251 \else
9252 \parseUTFviiiA;%
9253 \parseUTFviiiA,%
9254 \parseUTFviiiA!%
9255 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
9256 \fi\fi\fi
9259 \gdef\parseUTFviiiA#1{%
9260 \countUTFx = \countUTFz
9261 \divide\countUTFz by 64
9262 \countUTFy = \countUTFz
9263 \multiply\countUTFz by 64
9264 \advance\countUTFx by -\countUTFz
9265 \advance\countUTFx by 128
9266 \uccode `#1\countUTFx
9267 \countUTFz = \countUTFy}
9269 \gdef\parseUTFviiiB#1#2#3#4{%
9270 \advance\countUTFz by "#10\relax
9271 \uccode `#3\countUTFz
9272 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9273 \endgroup
9275 \def\utfeightchardefs{%
9276 \DeclareUnicodeCharacter{00A0}{\tie}
9277 \DeclareUnicodeCharacter{00A1}{\exclamdown}
9278 \DeclareUnicodeCharacter{00A3}{\pounds}
9279 \DeclareUnicodeCharacter{00A8}{\"{ }}
9280 \DeclareUnicodeCharacter{00A9}{\copyright}
9281 \DeclareUnicodeCharacter{00AA}{\ordf}
9282 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
9283 \DeclareUnicodeCharacter{00AD}{\-}
9284 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
9285 \DeclareUnicodeCharacter{00AF}{\={ }}
9287 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
9288 \DeclareUnicodeCharacter{00B4}{\'{ }}
9289 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
9290 \DeclareUnicodeCharacter{00BA}{\ordm}
9291 \DeclareUnicodeCharacter{00BB}{\guillemetright}
9292 \DeclareUnicodeCharacter{00BF}{\questiondown}
9294 \DeclareUnicodeCharacter{00C0}{\`A}
9295 \DeclareUnicodeCharacter{00C1}{\'A}
9296 \DeclareUnicodeCharacter{00C2}{\^A}
9297 \DeclareUnicodeCharacter{00C3}{\~A}
9298 \DeclareUnicodeCharacter{00C4}{\"A}
9299 \DeclareUnicodeCharacter{00C5}{\AA}
9300 \DeclareUnicodeCharacter{00C6}{\AE}
9301 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
9302 \DeclareUnicodeCharacter{00C8}{\`E}
9303 \DeclareUnicodeCharacter{00C9}{\'E}
9304 \DeclareUnicodeCharacter{00CA}{\^E}
9305 \DeclareUnicodeCharacter{00CB}{\"E}
9306 \DeclareUnicodeCharacter{00CC}{\`I}
9307 \DeclareUnicodeCharacter{00CD}{\'I}
9308 \DeclareUnicodeCharacter{00CE}{\^I}
9309 \DeclareUnicodeCharacter{00CF}{\"I}
9311 \DeclareUnicodeCharacter{00D0}{\DH}
9312 \DeclareUnicodeCharacter{00D1}{\~N}
9313 \DeclareUnicodeCharacter{00D2}{\`O}
9314 \DeclareUnicodeCharacter{00D3}{\'O}
9315 \DeclareUnicodeCharacter{00D4}{\^O}
9316 \DeclareUnicodeCharacter{00D5}{\~O}
9317 \DeclareUnicodeCharacter{00D6}{\"O}
9318 \DeclareUnicodeCharacter{00D8}{\O}
9319 \DeclareUnicodeCharacter{00D9}{\`U}
9320 \DeclareUnicodeCharacter{00DA}{\'U}
9321 \DeclareUnicodeCharacter{00DB}{\^U}
9322 \DeclareUnicodeCharacter{00DC}{\"U}
9323 \DeclareUnicodeCharacter{00DD}{\'Y}
9324 \DeclareUnicodeCharacter{00DE}{\TH}
9325 \DeclareUnicodeCharacter{00DF}{\ss}
9327 \DeclareUnicodeCharacter{00E0}{\`a}
9328 \DeclareUnicodeCharacter{00E1}{\'a}
9329 \DeclareUnicodeCharacter{00E2}{\^a}
9330 \DeclareUnicodeCharacter{00E3}{\~a}
9331 \DeclareUnicodeCharacter{00E4}{\"a}
9332 \DeclareUnicodeCharacter{00E5}{\aa}
9333 \DeclareUnicodeCharacter{00E6}{\ae}
9334 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
9335 \DeclareUnicodeCharacter{00E8}{\`e}
9336 \DeclareUnicodeCharacter{00E9}{\'e}
9337 \DeclareUnicodeCharacter{00EA}{\^e}
9338 \DeclareUnicodeCharacter{00EB}{\"e}
9339 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
9340 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
9341 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
9342 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
9344 \DeclareUnicodeCharacter{00F0}{\dh}
9345 \DeclareUnicodeCharacter{00F1}{\~n}
9346 \DeclareUnicodeCharacter{00F2}{\`o}
9347 \DeclareUnicodeCharacter{00F3}{\'o}
9348 \DeclareUnicodeCharacter{00F4}{\^o}
9349 \DeclareUnicodeCharacter{00F5}{\~o}
9350 \DeclareUnicodeCharacter{00F6}{\"o}
9351 \DeclareUnicodeCharacter{00F8}{\o}
9352 \DeclareUnicodeCharacter{00F9}{\`u}
9353 \DeclareUnicodeCharacter{00FA}{\'u}
9354 \DeclareUnicodeCharacter{00FB}{\^u}
9355 \DeclareUnicodeCharacter{00FC}{\"u}
9356 \DeclareUnicodeCharacter{00FD}{\'y}
9357 \DeclareUnicodeCharacter{00FE}{\th}
9358 \DeclareUnicodeCharacter{00FF}{\"y}
9360 \DeclareUnicodeCharacter{0100}{\=A}
9361 \DeclareUnicodeCharacter{0101}{\=a}
9362 \DeclareUnicodeCharacter{0102}{\u{A}}
9363 \DeclareUnicodeCharacter{0103}{\u{a}}
9364 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
9365 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
9366 \DeclareUnicodeCharacter{0106}{\'C}
9367 \DeclareUnicodeCharacter{0107}{\'c}
9368 \DeclareUnicodeCharacter{0108}{\^C}
9369 \DeclareUnicodeCharacter{0109}{\^c}
9370 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
9371 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
9372 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
9373 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
9374 \DeclareUnicodeCharacter{010C}{\v{C}}
9375 \DeclareUnicodeCharacter{010D}{\v{c}}
9376 \DeclareUnicodeCharacter{010E}{\v{D}}
9378 \DeclareUnicodeCharacter{0112}{\=E}
9379 \DeclareUnicodeCharacter{0113}{\=e}
9380 \DeclareUnicodeCharacter{0114}{\u{E}}
9381 \DeclareUnicodeCharacter{0115}{\u{e}}
9382 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
9383 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
9384 \DeclareUnicodeCharacter{011A}{\v{E}}
9385 \DeclareUnicodeCharacter{011B}{\v{e}}
9386 \DeclareUnicodeCharacter{011C}{\^G}
9387 \DeclareUnicodeCharacter{011D}{\^g}
9388 \DeclareUnicodeCharacter{011E}{\u{G}}
9389 \DeclareUnicodeCharacter{011F}{\u{g}}
9391 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
9392 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
9393 \DeclareUnicodeCharacter{0124}{\^H}
9394 \DeclareUnicodeCharacter{0125}{\^h}
9395 \DeclareUnicodeCharacter{0128}{\~I}
9396 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
9397 \DeclareUnicodeCharacter{012A}{\=I}
9398 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
9399 \DeclareUnicodeCharacter{012C}{\u{I}}
9400 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
9402 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
9403 \DeclareUnicodeCharacter{0131}{\dotless{i}}
9404 \DeclareUnicodeCharacter{0132}{IJ}
9405 \DeclareUnicodeCharacter{0133}{ij}
9406 \DeclareUnicodeCharacter{0134}{\^J}
9407 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
9408 \DeclareUnicodeCharacter{0139}{\'L}
9409 \DeclareUnicodeCharacter{013A}{\'l}
9411 \DeclareUnicodeCharacter{0141}{\L}
9412 \DeclareUnicodeCharacter{0142}{\l}
9413 \DeclareUnicodeCharacter{0143}{\'N}
9414 \DeclareUnicodeCharacter{0144}{\'n}
9415 \DeclareUnicodeCharacter{0147}{\v{N}}
9416 \DeclareUnicodeCharacter{0148}{\v{n}}
9417 \DeclareUnicodeCharacter{014C}{\=O}
9418 \DeclareUnicodeCharacter{014D}{\=o}
9419 \DeclareUnicodeCharacter{014E}{\u{O}}
9420 \DeclareUnicodeCharacter{014F}{\u{o}}
9422 \DeclareUnicodeCharacter{0150}{\H{O}}
9423 \DeclareUnicodeCharacter{0151}{\H{o}}
9424 \DeclareUnicodeCharacter{0152}{\OE}
9425 \DeclareUnicodeCharacter{0153}{\oe}
9426 \DeclareUnicodeCharacter{0154}{\'R}
9427 \DeclareUnicodeCharacter{0155}{\'r}
9428 \DeclareUnicodeCharacter{0158}{\v{R}}
9429 \DeclareUnicodeCharacter{0159}{\v{r}}
9430 \DeclareUnicodeCharacter{015A}{\'S}
9431 \DeclareUnicodeCharacter{015B}{\'s}
9432 \DeclareUnicodeCharacter{015C}{\^S}
9433 \DeclareUnicodeCharacter{015D}{\^s}
9434 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
9435 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
9437 \DeclareUnicodeCharacter{0160}{\v{S}}
9438 \DeclareUnicodeCharacter{0161}{\v{s}}
9439 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
9440 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
9441 \DeclareUnicodeCharacter{0164}{\v{T}}
9443 \DeclareUnicodeCharacter{0168}{\~U}
9444 \DeclareUnicodeCharacter{0169}{\~u}
9445 \DeclareUnicodeCharacter{016A}{\=U}
9446 \DeclareUnicodeCharacter{016B}{\=u}
9447 \DeclareUnicodeCharacter{016C}{\u{U}}
9448 \DeclareUnicodeCharacter{016D}{\u{u}}
9449 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
9450 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
9452 \DeclareUnicodeCharacter{0170}{\H{U}}
9453 \DeclareUnicodeCharacter{0171}{\H{u}}
9454 \DeclareUnicodeCharacter{0174}{\^W}
9455 \DeclareUnicodeCharacter{0175}{\^w}
9456 \DeclareUnicodeCharacter{0176}{\^Y}
9457 \DeclareUnicodeCharacter{0177}{\^y}
9458 \DeclareUnicodeCharacter{0178}{\"Y}
9459 \DeclareUnicodeCharacter{0179}{\'Z}
9460 \DeclareUnicodeCharacter{017A}{\'z}
9461 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
9462 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
9463 \DeclareUnicodeCharacter{017D}{\v{Z}}
9464 \DeclareUnicodeCharacter{017E}{\v{z}}
9466 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
9467 \DeclareUnicodeCharacter{01C5}{D\v{z}}
9468 \DeclareUnicodeCharacter{01C6}{d\v{z}}
9469 \DeclareUnicodeCharacter{01C7}{LJ}
9470 \DeclareUnicodeCharacter{01C8}{Lj}
9471 \DeclareUnicodeCharacter{01C9}{lj}
9472 \DeclareUnicodeCharacter{01CA}{NJ}
9473 \DeclareUnicodeCharacter{01CB}{Nj}
9474 \DeclareUnicodeCharacter{01CC}{nj}
9475 \DeclareUnicodeCharacter{01CD}{\v{A}}
9476 \DeclareUnicodeCharacter{01CE}{\v{a}}
9477 \DeclareUnicodeCharacter{01CF}{\v{I}}
9479 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
9480 \DeclareUnicodeCharacter{01D1}{\v{O}}
9481 \DeclareUnicodeCharacter{01D2}{\v{o}}
9482 \DeclareUnicodeCharacter{01D3}{\v{U}}
9483 \DeclareUnicodeCharacter{01D4}{\v{u}}
9485 \DeclareUnicodeCharacter{01E2}{\={\AE}}
9486 \DeclareUnicodeCharacter{01E3}{\={\ae}}
9487 \DeclareUnicodeCharacter{01E6}{\v{G}}
9488 \DeclareUnicodeCharacter{01E7}{\v{g}}
9489 \DeclareUnicodeCharacter{01E8}{\v{K}}
9490 \DeclareUnicodeCharacter{01E9}{\v{k}}
9492 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
9493 \DeclareUnicodeCharacter{01F1}{DZ}
9494 \DeclareUnicodeCharacter{01F2}{Dz}
9495 \DeclareUnicodeCharacter{01F3}{dz}
9496 \DeclareUnicodeCharacter{01F4}{\'G}
9497 \DeclareUnicodeCharacter{01F5}{\'g}
9498 \DeclareUnicodeCharacter{01F8}{\`N}
9499 \DeclareUnicodeCharacter{01F9}{\`n}
9500 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
9501 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
9502 \DeclareUnicodeCharacter{01FE}{\'{\O}}
9503 \DeclareUnicodeCharacter{01FF}{\'{\o}}
9505 \DeclareUnicodeCharacter{021E}{\v{H}}
9506 \DeclareUnicodeCharacter{021F}{\v{h}}
9508 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
9509 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
9510 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
9511 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
9512 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
9513 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
9515 \DeclareUnicodeCharacter{0232}{\=Y}
9516 \DeclareUnicodeCharacter{0233}{\=y}
9517 \DeclareUnicodeCharacter{0237}{\dotless{j}}
9519 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
9521 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
9522 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
9523 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
9524 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
9525 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
9526 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
9527 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
9528 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
9529 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
9530 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
9531 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
9532 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
9534 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
9535 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
9537 \DeclareUnicodeCharacter{1E20}{\=G}
9538 \DeclareUnicodeCharacter{1E21}{\=g}
9539 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
9540 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
9541 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
9542 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
9543 \DeclareUnicodeCharacter{1E26}{\"H}
9544 \DeclareUnicodeCharacter{1E27}{\"h}
9546 \DeclareUnicodeCharacter{1E30}{\'K}
9547 \DeclareUnicodeCharacter{1E31}{\'k}
9548 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
9549 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
9550 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
9551 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
9552 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
9553 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
9554 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
9555 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
9556 \DeclareUnicodeCharacter{1E3E}{\'M}
9557 \DeclareUnicodeCharacter{1E3F}{\'m}
9559 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
9560 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
9561 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
9562 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
9563 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
9564 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
9565 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
9566 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
9567 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
9568 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
9570 \DeclareUnicodeCharacter{1E54}{\'P}
9571 \DeclareUnicodeCharacter{1E55}{\'p}
9572 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
9573 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
9574 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
9575 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
9576 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
9577 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
9578 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
9579 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
9581 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
9582 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
9583 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
9584 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
9585 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
9586 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
9587 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
9588 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
9589 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
9590 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
9592 \DeclareUnicodeCharacter{1E7C}{\~V}
9593 \DeclareUnicodeCharacter{1E7D}{\~v}
9594 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
9595 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
9597 \DeclareUnicodeCharacter{1E80}{\`W}
9598 \DeclareUnicodeCharacter{1E81}{\`w}
9599 \DeclareUnicodeCharacter{1E82}{\'W}
9600 \DeclareUnicodeCharacter{1E83}{\'w}
9601 \DeclareUnicodeCharacter{1E84}{\"W}
9602 \DeclareUnicodeCharacter{1E85}{\"w}
9603 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
9604 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
9605 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
9606 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
9607 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
9608 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
9609 \DeclareUnicodeCharacter{1E8C}{\"X}
9610 \DeclareUnicodeCharacter{1E8D}{\"x}
9611 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
9612 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
9614 \DeclareUnicodeCharacter{1E90}{\^Z}
9615 \DeclareUnicodeCharacter{1E91}{\^z}
9616 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
9617 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
9618 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
9619 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
9620 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
9621 \DeclareUnicodeCharacter{1E97}{\"t}
9622 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
9623 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
9625 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
9626 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
9628 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
9629 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
9630 \DeclareUnicodeCharacter{1EBC}{\~E}
9631 \DeclareUnicodeCharacter{1EBD}{\~e}
9633 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
9634 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
9635 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
9636 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
9638 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
9639 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
9641 \DeclareUnicodeCharacter{1EF2}{\`Y}
9642 \DeclareUnicodeCharacter{1EF3}{\`y}
9643 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
9645 \DeclareUnicodeCharacter{1EF8}{\~Y}
9646 \DeclareUnicodeCharacter{1EF9}{\~y}
9648 \DeclareUnicodeCharacter{2013}{--}
9649 \DeclareUnicodeCharacter{2014}{---}
9650 \DeclareUnicodeCharacter{2018}{\quoteleft}
9651 \DeclareUnicodeCharacter{2019}{\quoteright}
9652 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
9653 \DeclareUnicodeCharacter{201C}{\quotedblleft}
9654 \DeclareUnicodeCharacter{201D}{\quotedblright}
9655 \DeclareUnicodeCharacter{201E}{\quotedblbase}
9656 \DeclareUnicodeCharacter{2022}{\bullet}
9657 \DeclareUnicodeCharacter{2026}{\dots}
9658 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9659 \DeclareUnicodeCharacter{203A}{\guilsinglright}
9660 \DeclareUnicodeCharacter{20AC}{\euro}
9662 \DeclareUnicodeCharacter{2192}{\expansion}
9663 \DeclareUnicodeCharacter{21D2}{\result}
9665 \DeclareUnicodeCharacter{2212}{\minus}
9666 \DeclareUnicodeCharacter{2217}{\point}
9667 \DeclareUnicodeCharacter{2261}{\equiv}
9668 }% end of \utfeightchardefs
9671 % US-ASCII character definitions.
9672 \def\asciichardefs{% nothing need be done
9673 \relax
9676 % Make non-ASCII characters printable again for compatibility with
9677 % existing Texinfo documents that may use them, even without declaring a
9678 % document encoding.
9680 \setnonasciicharscatcode \other
9683 \message{formatting,}
9685 \newdimen\defaultparindent \defaultparindent = 15pt
9687 \chapheadingskip = 15pt plus 4pt minus 2pt
9688 \secheadingskip = 12pt plus 3pt minus 2pt
9689 \subsecheadingskip = 9pt plus 2pt minus 2pt
9691 % Prevent underfull vbox error messages.
9692 \vbadness = 10000
9694 % Don't be very finicky about underfull hboxes, either.
9695 \hbadness = 6666
9697 % Following George Bush, get rid of widows and orphans.
9698 \widowpenalty=10000
9699 \clubpenalty=10000
9701 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9702 % using an old version of TeX, don't do anything. We want the amount of
9703 % stretch added to depend on the line length, hence the dependence on
9704 % \hsize. We call this whenever the paper size is set.
9706 \def\setemergencystretch{%
9707 \ifx\emergencystretch\thisisundefined
9708 % Allow us to assign to \emergencystretch anyway.
9709 \def\emergencystretch{\dimen0}%
9710 \else
9711 \emergencystretch = .15\hsize
9715 % Parameters in order: 1) textheight; 2) textwidth;
9716 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9717 % 7) physical page height; 8) physical page width.
9719 % We also call \setleading{\textleading}, so the caller should define
9720 % \textleading. The caller should also set \parskip.
9722 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9723 \voffset = #3\relax
9724 \topskip = #6\relax
9725 \splittopskip = \topskip
9727 \vsize = #1\relax
9728 \advance\vsize by \topskip
9729 \outervsize = \vsize
9730 \advance\outervsize by 2\topandbottommargin
9731 \pageheight = \vsize
9733 \hsize = #2\relax
9734 \outerhsize = \hsize
9735 \advance\outerhsize by 0.5in
9736 \pagewidth = \hsize
9738 \normaloffset = #4\relax
9739 \bindingoffset = #5\relax
9741 \ifpdf
9742 \pdfpageheight #7\relax
9743 \pdfpagewidth #8\relax
9744 % if we don't reset these, they will remain at "1 true in" of
9745 % whatever layout pdftex was dumped with.
9746 \pdfhorigin = 1 true in
9747 \pdfvorigin = 1 true in
9750 \setleading{\textleading}
9752 \parindent = \defaultparindent
9753 \setemergencystretch
9756 % @letterpaper (the default).
9757 \def\letterpaper{{\globaldefs = 1
9758 \parskip = 3pt plus 2pt minus 1pt
9759 \textleading = 13.2pt
9761 % If page is nothing but text, make it come out even.
9762 \internalpagesizes{607.2pt}{6in}% that's 46 lines
9763 {\voffset}{.25in}%
9764 {\bindingoffset}{36pt}%
9765 {11in}{8.5in}%
9768 % Use @smallbook to reset parameters for 7x9.25 trim size.
9769 \def\smallbook{{\globaldefs = 1
9770 \parskip = 2pt plus 1pt
9771 \textleading = 12pt
9773 \internalpagesizes{7.5in}{5in}%
9774 {-.2in}{0in}%
9775 {\bindingoffset}{16pt}%
9776 {9.25in}{7in}%
9778 \lispnarrowing = 0.3in
9779 \tolerance = 700
9780 \hfuzz = 1pt
9781 \contentsrightmargin = 0pt
9782 \defbodyindent = .5cm
9785 % Use @smallerbook to reset parameters for 6x9 trim size.
9786 % (Just testing, parameters still in flux.)
9787 \def\smallerbook{{\globaldefs = 1
9788 \parskip = 1.5pt plus 1pt
9789 \textleading = 12pt
9791 \internalpagesizes{7.4in}{4.8in}%
9792 {-.2in}{-.4in}%
9793 {0pt}{14pt}%
9794 {9in}{6in}%
9796 \lispnarrowing = 0.25in
9797 \tolerance = 700
9798 \hfuzz = 1pt
9799 \contentsrightmargin = 0pt
9800 \defbodyindent = .4cm
9803 % Use @afourpaper to print on European A4 paper.
9804 \def\afourpaper{{\globaldefs = 1
9805 \parskip = 3pt plus 2pt minus 1pt
9806 \textleading = 13.2pt
9808 % Double-side printing via postscript on Laserjet 4050
9809 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9810 % To change the settings for a different printer or situation, adjust
9811 % \normaloffset until the front-side and back-side texts align. Then
9812 % do the same for \bindingoffset. You can set these for testing in
9813 % your texinfo source file like this:
9814 % @tex
9815 % \global\normaloffset = -6mm
9816 % \global\bindingoffset = 10mm
9817 % @end tex
9818 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9819 {\voffset}{\hoffset}%
9820 {\bindingoffset}{44pt}%
9821 {297mm}{210mm}%
9823 \tolerance = 700
9824 \hfuzz = 1pt
9825 \contentsrightmargin = 0pt
9826 \defbodyindent = 5mm
9829 % Use @afivepaper to print on European A5 paper.
9830 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9831 % He also recommends making @example and @lisp be small.
9832 \def\afivepaper{{\globaldefs = 1
9833 \parskip = 2pt plus 1pt minus 0.1pt
9834 \textleading = 12.5pt
9836 \internalpagesizes{160mm}{120mm}%
9837 {\voffset}{\hoffset}%
9838 {\bindingoffset}{8pt}%
9839 {210mm}{148mm}%
9841 \lispnarrowing = 0.2in
9842 \tolerance = 800
9843 \hfuzz = 1.2pt
9844 \contentsrightmargin = 0pt
9845 \defbodyindent = 2mm
9846 \tableindent = 12mm
9849 % A specific text layout, 24x15cm overall, intended for A4 paper.
9850 \def\afourlatex{{\globaldefs = 1
9851 \afourpaper
9852 \internalpagesizes{237mm}{150mm}%
9853 {\voffset}{4.6mm}%
9854 {\bindingoffset}{7mm}%
9855 {297mm}{210mm}%
9857 % Must explicitly reset to 0 because we call \afourpaper.
9858 \globaldefs = 0
9861 % Use @afourwide to print on A4 paper in landscape format.
9862 \def\afourwide{{\globaldefs = 1
9863 \afourpaper
9864 \internalpagesizes{241mm}{165mm}%
9865 {\voffset}{-2.95mm}%
9866 {\bindingoffset}{7mm}%
9867 {297mm}{210mm}%
9868 \globaldefs = 0
9871 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9872 % Perhaps we should allow setting the margins, \topskip, \parskip,
9873 % and/or leading, also. Or perhaps we should compute them somehow.
9875 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9876 \def\pagesizesyyy#1,#2,#3\finish{{%
9877 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9878 \globaldefs = 1
9880 \parskip = 3pt plus 2pt minus 1pt
9881 \setleading{\textleading}%
9883 \dimen0 = #1\relax
9884 \advance\dimen0 by \voffset
9886 \dimen2 = \hsize
9887 \advance\dimen2 by \normaloffset
9889 \internalpagesizes{#1}{\hsize}%
9890 {\voffset}{\normaloffset}%
9891 {\bindingoffset}{44pt}%
9892 {\dimen0}{\dimen2}%
9895 % Set default to letter.
9897 \letterpaper
9900 \message{and turning on texinfo input format.}
9902 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
9904 % DEL is a comment character, in case @c does not suffice.
9905 \catcode`\^^? = 14
9907 % Define macros to output various characters with catcode for normal text.
9908 \catcode`\"=\other \def\normaldoublequote{"}
9909 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
9910 \catcode`\+=\other \def\normalplus{+}
9911 \catcode`\<=\other \def\normalless{<}
9912 \catcode`\>=\other \def\normalgreater{>}
9913 \catcode`\^=\other \def\normalcaret{^}
9914 \catcode`\_=\other \def\normalunderscore{_}
9915 \catcode`\|=\other \def\normalverticalbar{|}
9916 \catcode`\~=\other \def\normaltilde{~}
9918 % This macro is used to make a character print one way in \tt
9919 % (where it can probably be output as-is), and another way in other fonts,
9920 % where something hairier probably needs to be done.
9922 % #1 is what to print if we are indeed using \tt; #2 is what to print
9923 % otherwise. Since all the Computer Modern typewriter fonts have zero
9924 % interword stretch (and shrink), and it is reasonable to expect all
9925 % typewriter fonts to have this, we can check that font parameter.
9927 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9929 % Same as above, but check for italic font. Actually this also catches
9930 % non-italic slanted fonts since it is impossible to distinguish them from
9931 % italic fonts. But since this is only used by $ and it uses \sl anyway
9932 % this is not a problem.
9933 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9935 % Turn off all special characters except @
9936 % (and those which the user can use as if they were ordinary).
9937 % Most of these we simply print from the \tt font, but for some, we can
9938 % use math or other variants that look better in normal text.
9940 \catcode`\"=\active
9941 \def\activedoublequote{{\tt\char34}}
9942 \let"=\activedoublequote
9943 \catcode`\~=\active
9944 \def~{{\tt\char126}}
9945 \chardef\hat=`\^
9946 \catcode`\^=\active
9947 \def^{{\tt \hat}}
9949 \catcode`\_=\active
9950 \def_{\ifusingtt\normalunderscore\_}
9951 \let\realunder=_
9952 % Subroutine for the previous macro.
9953 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9955 \catcode`\|=\active
9956 \def|{{\tt\char124}}
9957 \chardef \less=`\<
9958 \catcode`\<=\active
9959 \def<{{\tt \less}}
9960 \chardef \gtr=`\>
9961 \catcode`\>=\active
9962 \def>{{\tt \gtr}}
9963 \catcode`\+=\active
9964 \def+{{\tt \char 43}}
9965 \catcode`\$=\active
9966 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9968 % If a .fmt file is being used, characters that might appear in a file
9969 % name cannot be active until we have parsed the command line.
9970 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9971 % \otherifyactive is called near the end of this file.
9972 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9974 % Used sometimes to turn off (effectively) the active characters even after
9975 % parsing them.
9976 \def\turnoffactive{%
9977 \normalturnoffactive
9978 \otherbackslash
9981 \catcode`\@=0
9983 % \backslashcurfont outputs one backslash character in current font,
9984 % as in \char`\\.
9985 \global\chardef\backslashcurfont=`\\
9986 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
9988 % \realbackslash is an actual character `\' with catcode other, and
9989 % \doublebackslash is two of them (for the pdf outlines).
9990 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9992 % In texinfo, backslash is an active character; it prints the backslash
9993 % in fixed width font.
9994 \catcode`\\=\active % @ for escape char from now on.
9996 % The story here is that in math mode, the \char of \backslashcurfont
9997 % ends up printing the roman \ from the math symbol font (because \char
9998 % in math mode uses the \mathcode, and plain.tex sets
9999 % \mathcode`\\="026E). It seems better for @backslashchar{} to always
10000 % print a typewriter backslash, hence we use an explicit \mathchar,
10001 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
10002 % ignored family value; char position "5C). We can't use " for the
10003 % usual hex value because it has already been made active.
10004 @def@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
10005 @let@backslashchar = @normalbackslash % @backslashchar{} is for user documents.
10007 % On startup, @fixbackslash assigns:
10008 % @let \ = @normalbackslash
10009 % \rawbackslash defines an active \ to do \backslashcurfont.
10010 % \otherbackslash defines an active \ to be a literal `\' character with
10011 % catcode other. We switch back and forth between these.
10012 @gdef@rawbackslash{@let\=@backslashcurfont}
10013 @gdef@otherbackslash{@let\=@realbackslash}
10015 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
10016 % the literal character `\'. Also revert - to its normal character, in
10017 % case the active - from code has slipped in.
10019 {@catcode`- = @active
10020 @gdef@normalturnoffactive{%
10021 @let-=@normaldash
10022 @let"=@normaldoublequote
10023 @let$=@normaldollar %$ font-lock fix
10024 @let+=@normalplus
10025 @let<=@normalless
10026 @let>=@normalgreater
10027 @let\=@normalbackslash
10028 @let^=@normalcaret
10029 @let_=@normalunderscore
10030 @let|=@normalverticalbar
10031 @let~=@normaltilde
10032 @markupsetuplqdefault
10033 @markupsetuprqdefault
10034 @unsepspaces
10038 % Make _ and + \other characters, temporarily.
10039 % This is canceled by @fixbackslash.
10040 @otherifyactive
10042 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
10043 % That is what \eatinput is for; after that, the `\' should revert to printing
10044 % a backslash.
10046 @gdef@eatinput input texinfo{@fixbackslash}
10047 @global@let\ = @eatinput
10049 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
10050 % the first `\' in the file would cause an error. This macro tries to fix
10051 % that, assuming it is called before the first `\' could plausibly occur.
10052 % Also turn back on active characters that might appear in the input
10053 % file name, in case not using a pre-dumped format.
10055 @gdef@fixbackslash{%
10056 @ifx\@eatinput @let\ = @normalbackslash @fi
10057 @catcode`+=@active
10058 @catcode`@_=@active
10061 % Say @foo, not \foo, in error messages.
10062 @escapechar = `@@
10064 % These (along with & and #) are made active for url-breaking, so need
10065 % active definitions as the normal characters.
10066 @def@normaldot{.}
10067 @def@normalquest{?}
10068 @def@normalslash{/}
10070 % These look ok in all fonts, so just make them not special.
10071 % @hashchar{} gets its own user-level command, because of #line.
10072 @catcode`@& = @other @def@normalamp{&}
10073 @catcode`@# = @other @def@normalhash{#}
10074 @catcode`@% = @other @def@normalpercent{%}
10076 @let @hashchar = @normalhash
10078 @c Finally, make ` and ' active, so that txicodequoteundirected and
10079 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
10080 @c don't make ` and ' active, @code will not get them as active chars.
10081 @c Do this last of all since we use ` in the previous @catcode assignments.
10082 @catcode`@'=@active
10083 @catcode`@`=@active
10084 @markupsetuplqdefault
10085 @markupsetuprqdefault
10087 @c Local variables:
10088 @c eval: (add-hook 'write-file-hooks 'time-stamp)
10089 @c page-delimiter: "^\\\\message"
10090 @c time-stamp-start: "def\\\\texinfoversion{"
10091 @c time-stamp-format: "%:y-%02m-%02d.%02H"
10092 @c time-stamp-end: "}"
10093 @c End:
10095 @c vim:sw=2:
10097 @ignore
10098 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
10099 @end ignore