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