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