Don't use dangling elses.
[s-roff.git] / doc / texinfo.tex
blobfb2496bbd504e1d0e7d3af651321824775edc15e
1 % texinfo.tex -- TeX macros to handle Texinfo files.
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
6 \def\texinfoversion{2009-01-01.14}
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 Free Software Foundation, Inc.
12 % This texinfo.tex file is free software: you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation, either version 3 of the
15 % License, or (at your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this program. If not, see <http://www.gnu.org/licenses/>.
25 % As a special exception, when this file is read by TeX when processing
26 % a Texinfo source document, you may use the result without
27 % restriction. (This has been our intent since Texinfo was invented.)
29 % Please try the latest version of texinfo.tex before submitting bug
30 % reports; you can get the latest version from:
31 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
32 % ftp://tug.org/tex/texinfo.tex
33 % (and all CTAN mirrors, see http://www.ctan.org).
34 % The texinfo.tex in any given distribution could well be out
35 % of date, so if that's what you're using, please check.
37 % Send bug reports to bug-texinfo@gnu.org. Please include including a
38 % complete document in each bug report with which we can reproduce the
39 % problem. Patches are, of course, greatly appreciated.
41 % To process a Texinfo manual with TeX, it's most reliable to use the
42 % texi2dvi shell script that comes with the distribution. For a simple
43 % manual foo.texi, however, you can get away with this:
44 % tex foo.texi
45 % texindex foo.??
46 % tex foo.texi
47 % tex foo.texi
48 % dvips foo.dvi -o # or whatever; this makes foo.ps.
49 % The extra TeX runs get the cross-reference information correct.
50 % Sometimes one run after texindex suffices, and sometimes you need more
51 % than two; texi2dvi does it as many times as necessary.
53 % It is possible to adapt texinfo.tex for other languages, to some
54 % extent. You can get the existing language-specific files from the
55 % full Texinfo distribution.
57 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60 \message{Loading texinfo [version \texinfoversion]:}
62 % If in a .fmt file, print the version number
63 % and turn on active characters that we couldn't do earlier because
64 % they might have appeared in the input file name.
65 \everyjob{\message{[Texinfo version \texinfoversion]}%
66 \catcode`+=\active \catcode`\_=\active}
69 \chardef\other=12
71 % We never want plain's \outer definition of \+ in Texinfo.
72 % For @tex, we can use \tabalign.
73 \let\+ = \relax
75 % Save some plain tex macros whose names we will redefine.
76 \let\ptexb=\b
77 \let\ptexbullet=\bullet
78 \let\ptexc=\c
79 \let\ptexcomma=\,
80 \let\ptexdot=\.
81 \let\ptexdots=\dots
82 \let\ptexend=\end
83 \let\ptexequiv=\equiv
84 \let\ptexexclam=\!
85 \let\ptexfootnote=\footnote
86 \let\ptexgtr=>
87 \let\ptexhat=^
88 \let\ptexi=\i
89 \let\ptexindent=\indent
90 \let\ptexinsert=\insert
91 \let\ptexlbrace=\{
92 \let\ptexless=<
93 \let\ptexnewwrite\newwrite
94 \let\ptexnoindent=\noindent
95 \let\ptexplus=+
96 \let\ptexrbrace=\}
97 \let\ptexslash=\/
98 \let\ptexstar=\*
99 \let\ptext=\t
100 \let\ptextop=\top
101 {\catcode`\'=\active
102 \global\let\ptexquoteright'}% Math-mode def from plain.tex.
103 \let\ptexraggedright=\raggedright
105 % If this character appears in an error message or help string, it
106 % starts a new line in the output.
107 \newlinechar = `^^J
109 % Use TeX 3.0's \inputlineno to get the line number, for better error
110 % messages, but if we're using an old version of TeX, don't do anything.
112 \ifx\inputlineno\thisisundefined
113 \let\linenumber = \empty % Pre-3.0.
114 \else
115 \def\linenumber{l.\the\inputlineno:\space}
118 % Set up fixed words for English if not already set.
119 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
120 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
121 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
122 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
123 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
124 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
125 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
126 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
127 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
128 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
129 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
130 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
131 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
132 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
133 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
134 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
135 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
136 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
137 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
139 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
140 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
141 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
142 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
143 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
144 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
145 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
146 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
147 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
148 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
149 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
150 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
152 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
153 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
154 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
155 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
156 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
158 % Since the category of space is not known, we have to be careful.
159 \chardef\spacecat = 10
160 \def\spaceisspace{\catcode`\ =\spacecat}
162 % sometimes characters are active, so we need control sequences.
163 \chardef\colonChar = `\:
164 \chardef\commaChar = `\,
165 \chardef\dashChar = `\-
166 \chardef\dotChar = `\.
167 \chardef\exclamChar= `\!
168 \chardef\lquoteChar= `\`
169 \chardef\questChar = `\?
170 \chardef\rquoteChar= `\'
171 \chardef\semiChar = `\;
172 \chardef\underChar = `\_
174 % Ignore a token.
176 \def\gobble#1{}
178 % The following is used inside several \edef's.
179 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
181 % Hyphenation fixes.
182 \hyphenation{
183 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
184 ap-pen-dix bit-map bit-maps
185 data-base data-bases eshell fall-ing half-way long-est man-u-script
186 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
187 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
188 spell-ing spell-ings
189 stand-alone strong-est time-stamp time-stamps which-ever white-space
190 wide-spread wrap-around
193 % Margin to add to right of even pages, to left of odd pages.
194 \newdimen\bindingoffset
195 \newdimen\normaloffset
196 \newdimen\pagewidth \newdimen\pageheight
198 % For a final copy, take out the rectangles
199 % that mark overfull boxes (in case you have decided
200 % that the text looks ok even though it passes the margin).
202 \def\finalout{\overfullrule=0pt}
204 % @| inserts a changebar to the left of the current line. It should
205 % surround any changed text. This approach does *not* work if the
206 % change spans more than two lines of output. To handle that, we would
207 % have adopt a much more difficult approach (putting marks into the main
208 % vertical list for the beginning and end of each change).
210 \def\|{%
211 % \vadjust can only be used in horizontal mode.
212 \leavevmode
214 % Append this vertical mode material after the current line in the output.
215 \vadjust{%
216 % We want to insert a rule with the height and depth of the current
217 % leading; that is exactly what \strutbox is supposed to record.
218 \vskip-\baselineskip
220 % \vadjust-items are inserted at the left edge of the type. So
221 % the \llap here moves out into the left-hand margin.
222 \llap{%
224 % For a thicker or thinner bar, change the `1pt'.
225 \vrule height\baselineskip width1pt
227 % This is the space between the bar and the text.
228 \hskip 12pt
233 % Sometimes it is convenient to have everything in the transcript file
234 % and nothing on the terminal. We don't just call \tracingall here,
235 % since that produces some useless output on the terminal. We also make
236 % some effort to order the tracing commands to reduce output in the log
237 % file; cf. trace.sty in LaTeX.
239 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
240 \def\loggingall{%
241 \tracingstats2
242 \tracingpages1
243 \tracinglostchars2 % 2 gives us more in etex
244 \tracingparagraphs1
245 \tracingoutput1
246 \tracingmacros2
247 \tracingrestores1
248 \showboxbreadth\maxdimen \showboxdepth\maxdimen
249 \ifx\eTeXversion\undefined\else % etex gives us more logging
250 \tracingscantokens1
251 \tracingifs1
252 \tracinggroups1
253 \tracingnesting2
254 \tracingassigns1
256 \tracingcommands3 % 3 gives us more in etex
257 \errorcontextlines16
260 % add check for \lastpenalty to plain's definitions. If the last thing
261 % we did was a \nobreak, we don't want to insert more space.
263 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
264 \removelastskip\penalty-50\smallskip\fi\fi}
265 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
266 \removelastskip\penalty-100\medskip\fi\fi}
267 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
268 \removelastskip\penalty-200\bigskip\fi\fi}
270 % For @cropmarks command.
271 % Do @cropmarks to get crop marks.
273 \newif\ifcropmarks
274 \let\cropmarks = \cropmarkstrue
276 % Dimensions to add cropmarks at corners.
277 % Added by P. A. MacKay, 12 Nov. 1986
279 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
280 \newdimen\cornerlong \cornerlong=1pc
281 \newdimen\cornerthick \cornerthick=.3pt
282 \newdimen\topandbottommargin \topandbottommargin=.75in
284 % Output a mark which sets \thischapter, \thissection and \thiscolor.
285 % We dump everything together because we only have one kind of mark.
286 % This works because we only use \botmark / \topmark, not \firstmark.
288 % A mark contains a subexpression of the \ifcase ... \fi construct.
289 % \get*marks macros below extract the needed part using \ifcase.
291 % Another complication is to let the user choose whether \thischapter
292 % (\thissection) refers to the chapter (section) in effect at the top
293 % of a page, or that at the bottom of a page. The solution is
294 % described on page 260 of The TeXbook. It involves outputting two
295 % marks for the sectioning macros, one before the section break, and
296 % one after. I won't pretend I can describe this better than DEK...
297 \def\domark{%
298 \toks0=\expandafter{\lastchapterdefs}%
299 \toks2=\expandafter{\lastsectiondefs}%
300 \toks4=\expandafter{\prevchapterdefs}%
301 \toks6=\expandafter{\prevsectiondefs}%
302 \toks8=\expandafter{\lastcolordefs}%
303 \mark{%
304 \the\toks0 \the\toks2
305 \noexpand\or \the\toks4 \the\toks6
306 \noexpand\else \the\toks8
309 % \topmark doesn't work for the very first chapter (after the title
310 % page or the contents), so we use \firstmark there -- this gets us
311 % the mark with the chapter defs, unless the user sneaks in, e.g.,
312 % @setcolor (or @url, or @link, etc.) between @contents and the very
313 % first @chapter.
314 \def\gettopheadingmarks{%
315 \ifcase0\topmark\fi
316 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
318 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
319 \def\getcolormarks{\ifcase2\topmark\fi}
321 % Avoid "undefined control sequence" errors.
322 \def\lastchapterdefs{}
323 \def\lastsectiondefs{}
324 \def\prevchapterdefs{}
325 \def\prevsectiondefs{}
326 \def\lastcolordefs{}
328 % Main output routine.
329 \chardef\PAGE = 255
330 \output = {\onepageout{\pagecontents\PAGE}}
332 \newbox\headlinebox
333 \newbox\footlinebox
335 % \onepageout takes a vbox as an argument. Note that \pagecontents
336 % does insertions, but you have to call it yourself.
337 \def\onepageout#1{%
338 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
340 \ifodd\pageno \advance\hoffset by \bindingoffset
341 \else \advance\hoffset by -\bindingoffset\fi
343 % Do this outside of the \shipout so @code etc. will be expanded in
344 % the headline as they should be, not taken literally (outputting ''code).
345 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
346 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
347 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
348 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
351 % Have to do this stuff outside the \shipout because we want it to
352 % take effect in \write's, yet the group defined by the \vbox ends
353 % before the \shipout runs.
355 \indexdummies % don't expand commands in the output.
356 \normalturnoffactive % \ in index entries must not stay \, e.g., if
357 % the page break happens to be in the middle of an example.
358 % We don't want .vr (or whatever) entries like this:
359 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
360 % "\acronym" won't work when it's read back in;
361 % it needs to be
362 % {\code {{\tt \backslashcurfont }acronym}
363 \shipout\vbox{%
364 % Do this early so pdf references go to the beginning of the page.
365 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
367 \ifcropmarks \vbox to \outervsize\bgroup
368 \hsize = \outerhsize
369 \vskip-\topandbottommargin
370 \vtop to0pt{%
371 \line{\ewtop\hfil\ewtop}%
372 \nointerlineskip
373 \line{%
374 \vbox{\moveleft\cornerthick\nstop}%
375 \hfill
376 \vbox{\moveright\cornerthick\nstop}%
378 \vss}%
379 \vskip\topandbottommargin
380 \line\bgroup
381 \hfil % center the page within the outer (page) hsize.
382 \ifodd\pageno\hskip\bindingoffset\fi
383 \vbox\bgroup
386 \unvbox\headlinebox
387 \pagebody{#1}%
388 \ifdim\ht\footlinebox > 0pt
389 % Only leave this space if the footline is nonempty.
390 % (We lessened \vsize for it in \oddfootingyyy.)
391 % The \baselineskip=24pt in plain's \makefootline has no effect.
392 \vskip 24pt
393 \unvbox\footlinebox
396 \ifcropmarks
397 \egroup % end of \vbox\bgroup
398 \hfil\egroup % end of (centering) \line\bgroup
399 \vskip\topandbottommargin plus1fill minus1fill
400 \boxmaxdepth = \cornerthick
401 \vbox to0pt{\vss
402 \line{%
403 \vbox{\moveleft\cornerthick\nsbot}%
404 \hfill
405 \vbox{\moveright\cornerthick\nsbot}%
407 \nointerlineskip
408 \line{\ewbot\hfil\ewbot}%
410 \egroup % \vbox from first cropmarks clause
412 }% end of \shipout\vbox
413 }% end of group with \indexdummies
414 \advancepageno
415 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
418 \newinsert\margin \dimen\margin=\maxdimen
420 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
421 {\catcode`\@ =11
422 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
423 % marginal hacks, juha@viisa.uucp (Juha Takala)
424 \ifvoid\margin\else % marginal info is present
425 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
426 \dimen@=\dp#1\relax \unvbox#1\relax
427 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
428 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
431 % Here are the rules for the cropmarks. Note that they are
432 % offset so that the space between them is truly \outerhsize or \outervsize
433 % (P. A. MacKay, 12 November, 1986)
435 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
436 \def\nstop{\vbox
437 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
438 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
439 \def\nsbot{\vbox
440 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
442 % Parse an argument, then pass it to #1. The argument is the rest of
443 % the input line (except we remove a trailing comment). #1 should be a
444 % macro which expects an ordinary undelimited TeX argument.
446 \def\parsearg{\parseargusing{}}
447 \def\parseargusing#1#2{%
448 \def\argtorun{#2}%
449 \begingroup
450 \obeylines
451 \spaceisspace
453 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
456 {\obeylines %
457 \gdef\parseargline#1^^M{%
458 \endgroup % End of the group started in \parsearg.
459 \argremovecomment #1\comment\ArgTerm%
463 % First remove any @comment, then any @c comment.
464 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
465 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
467 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
469 % \argremovec might leave us with trailing space, e.g.,
470 % @end itemize @c foo
471 % This space token undergoes the same procedure and is eventually removed
472 % by \finishparsearg.
474 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
475 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
476 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
477 \def\temp{#3}%
478 \ifx\temp\empty
479 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
480 \let\temp\finishparsearg
481 \else
482 \let\temp\argcheckspaces
484 % Put the space token in:
485 \temp#1 #3\ArgTerm
488 % If a _delimited_ argument is enclosed in braces, they get stripped; so
489 % to get _exactly_ the rest of the line, we had to prevent such situation.
490 % We prepended an \empty token at the very beginning and we expand it now,
491 % just before passing the control to \argtorun.
492 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
493 % either the null string, or it ends with \^^M---thus there is no danger
494 % that a pair of braces would be stripped.
496 % But first, we have to remove the trailing space token.
498 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
500 % \parseargdef\foo{...}
501 % is roughly equivalent to
502 % \def\foo{\parsearg\Xfoo}
503 % \def\Xfoo#1{...}
505 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
506 % favourite TeX trick. --kasal, 16nov03
508 \def\parseargdef#1{%
509 \expandafter \doparseargdef \csname\string#1\endcsname #1%
511 \def\doparseargdef#1#2{%
512 \def#2{\parsearg#1}%
513 \def#1##1%
516 % Several utility definitions with active space:
518 \obeyspaces
519 \gdef\obeyedspace{ }
521 % Make each space character in the input produce a normal interword
522 % space in the output. Don't allow a line break at this space, as this
523 % is used only in environments like @example, where each line of input
524 % should produce a line of output anyway.
526 \gdef\sepspaces{\obeyspaces\let =\tie}
528 % If an index command is used in an @example environment, any spaces
529 % therein should become regular spaces in the raw index file, not the
530 % expansion of \tie (\leavevmode \penalty \@M \ ).
531 \gdef\unsepspaces{\let =\space}
535 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
537 % Define the framework for environments in texinfo.tex. It's used like this:
539 % \envdef\foo{...}
540 % \def\Efoo{...}
542 % It's the responsibility of \envdef to insert \begingroup before the
543 % actual body; @end closes the group after calling \Efoo. \envdef also
544 % defines \thisenv, so the current environment is known; @end checks
545 % whether the environment name matches. The \checkenv macro can also be
546 % used to check whether the current environment is the one expected.
548 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
549 % are not treated as environments; they don't open a group. (The
550 % implementation of @end takes care not to call \endgroup in this
551 % special case.)
554 % At run-time, environments start with this:
555 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
556 % initialize
557 \let\thisenv\empty
559 % ... but they get defined via ``\envdef\foo{...}'':
560 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
561 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
563 % Check whether we're in the right environment:
564 \def\checkenv#1{%
565 \def\temp{#1}%
566 \ifx\thisenv\temp
567 \else
568 \badenverr
572 % Environment mismatch, #1 expected:
573 \def\badenverr{%
574 \errhelp = \EMsimple
575 \errmessage{This command can appear only \inenvironment\temp,
576 not \inenvironment\thisenv}%
578 \def\inenvironment#1{%
579 \ifx#1\empty
580 out of any environment%
581 \else
582 in environment \expandafter\string#1%
586 % @end foo executes the definition of \Efoo.
587 % But first, it executes a specialized version of \checkenv
589 \parseargdef\end{%
590 \if 1\csname iscond.#1\endcsname
591 \else
592 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
593 \expandafter\checkenv\csname#1\endcsname
594 \csname E#1\endcsname
595 \endgroup
599 \newhelp\EMsimple{Press RETURN to continue.}
602 %% Simple single-character @ commands
604 % @@ prints an @
605 % Kludge this until the fonts are right (grr).
606 \def\@{{\tt\char64}}
608 % This is turned off because it was never documented
609 % and you can use @w{...} around a quote to suppress ligatures.
610 %% Define @` and @' to be the same as ` and '
611 %% but suppressing ligatures.
612 %\def\`{{`}}
613 %\def\'{{'}}
615 % Used to generate quoted braces.
616 \def\mylbrace {{\tt\char123}}
617 \def\myrbrace {{\tt\char125}}
618 \let\{=\mylbrace
619 \let\}=\myrbrace
620 \begingroup
621 % Definitions to produce \{ and \} commands for indices,
622 % and @{ and @} for the aux/toc files.
623 \catcode`\{ = \other \catcode`\} = \other
624 \catcode`\[ = 1 \catcode`\] = 2
625 \catcode`\! = 0 \catcode`\\ = \other
626 !gdef!lbracecmd[\{]%
627 !gdef!rbracecmd[\}]%
628 !gdef!lbraceatcmd[@{]%
629 !gdef!rbraceatcmd[@}]%
630 !endgroup
632 % @comma{} to avoid , parsing problems.
633 \let\comma = ,
635 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
636 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
637 \let\, = \c
638 \let\dotaccent = \.
639 \def\ringaccent#1{{\accent23 #1}}
640 \let\tieaccent = \t
641 \let\ubaraccent = \b
642 \let\udotaccent = \d
644 % Other special characters: @questiondown @exclamdown @ordf @ordm
645 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
646 \def\questiondown{?`}
647 \def\exclamdown{!`}
648 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
649 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
651 % Dotless i and dotless j, used for accents.
652 \def\imacro{i}
653 \def\jmacro{j}
654 \def\dotless#1{%
655 \def\temp{#1}%
656 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
657 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
658 \else \errmessage{@dotless can be used only with i or j}%
659 \fi\fi
662 % The \TeX{} logo, as in plain, but resetting the spacing so that a
663 % period following counts as ending a sentence. (Idea found in latex.)
665 \edef\TeX{\TeX \spacefactor=1000 }
667 % @LaTeX{} logo. Not quite the same results as the definition in
668 % latex.ltx, since we use a different font for the raised A; it's most
669 % convenient for us to use an explicitly smaller font, rather than using
670 % the \scriptstyle font (since we don't reset \scriptstyle and
671 % \scriptscriptstyle).
673 \def\LaTeX{%
674 L\kern-.36em
675 {\setbox0=\hbox{T}%
676 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
677 \kern-.15em
678 \TeX
681 % Be sure we're in horizontal mode when doing a tie, since we make space
682 % equivalent to this in @example-like environments. Otherwise, a space
683 % at the beginning of a line will start with \penalty -- and
684 % since \penalty is valid in vertical mode, we'd end up putting the
685 % penalty on the vertical list instead of in the new paragraph.
686 {\catcode`@ = 11
687 % Avoid using \@M directly, because that causes trouble
688 % if the definition is written into an index file.
689 \global\let\tiepenalty = \@M
690 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
693 % @: forces normal size whitespace following.
694 \def\:{\spacefactor=1000 }
696 % @* forces a line break.
697 \def\*{\hfil\break\hbox{}\ignorespaces}
699 % @/ allows a line break.
700 \let\/=\allowbreak
702 % @. is an end-of-sentence period.
703 \def\.{.\spacefactor=\endofsentencespacefactor\space}
705 % @! is an end-of-sentence bang.
706 \def\!{!\spacefactor=\endofsentencespacefactor\space}
708 % @? is an end-of-sentence query.
709 \def\?{?\spacefactor=\endofsentencespacefactor\space}
711 % @frenchspacing on|off says whether to put extra space after punctuation.
713 \def\onword{on}
714 \def\offword{off}
716 \parseargdef\frenchspacing{%
717 \def\temp{#1}%
718 \ifx\temp\onword \plainfrenchspacing
719 \else\ifx\temp\offword \plainnonfrenchspacing
720 \else
721 \errhelp = \EMsimple
722 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
723 \fi\fi
726 % @w prevents a word break. Without the \leavevmode, @w at the
727 % beginning of a paragraph, when TeX is still in vertical mode, would
728 % produce a whole line of output instead of starting the paragraph.
729 \def\w#1{\leavevmode\hbox{#1}}
731 % @group ... @end group forces ... to be all on one page, by enclosing
732 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
733 % to keep its height that of a normal line. According to the rules for
734 % \topskip (p.114 of the TeXbook), the glue inserted is
735 % max (\topskip - \ht (first item), 0). If that height is large,
736 % therefore, no glue is inserted, and the space between the headline and
737 % the text is small, which looks bad.
739 % Another complication is that the group might be very large. This can
740 % cause the glue on the previous page to be unduly stretched, because it
741 % does not have much material. In this case, it's better to add an
742 % explicit \vfill so that the extra space is at the bottom. The
743 % threshold for doing this is if the group is more than \vfilllimit
744 % percent of a page (\vfilllimit can be changed inside of @tex).
746 \newbox\groupbox
747 \def\vfilllimit{0.7}
749 \envdef\group{%
750 \ifnum\catcode`\^^M=\active \else
751 \errhelp = \groupinvalidhelp
752 \errmessage{@group invalid in context where filling is enabled}%
754 \startsavinginserts
756 \setbox\groupbox = \vtop\bgroup
757 % Do @comment since we are called inside an environment such as
758 % @example, where each end-of-line in the input causes an
759 % end-of-line in the output. We don't want the end-of-line after
760 % the `@group' to put extra space in the output. Since @group
761 % should appear on a line by itself (according to the Texinfo
762 % manual), we don't worry about eating any user text.
763 \comment
766 % The \vtop produces a box with normal height and large depth; thus, TeX puts
767 % \baselineskip glue before it, and (when the next line of text is done)
768 % \lineskip glue after it. Thus, space below is not quite equal to space
769 % above. But it's pretty close.
770 \def\Egroup{%
771 % To get correct interline space between the last line of the group
772 % and the first line afterwards, we have to propagate \prevdepth.
773 \endgraf % Not \par, as it may have been set to \lisppar.
774 \global\dimen1 = \prevdepth
775 \egroup % End the \vtop.
776 % \dimen0 is the vertical size of the group's box.
777 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
778 % \dimen2 is how much space is left on the page (more or less).
779 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
780 % if the group doesn't fit on the current page, and it's a big big
781 % group, force a page break.
782 \ifdim \dimen0 > \dimen2
783 \ifdim \pagetotal < \vfilllimit\pageheight
784 \page
787 \box\groupbox
788 \prevdepth = \dimen1
789 \checkinserts
792 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
793 % message, so this ends up printing `@group can only ...'.
795 \newhelp\groupinvalidhelp{%
796 group can only be used in environments such as @example,^^J%
797 where each line of input produces a line of output.}
799 % @need space-in-mils
800 % forces a page break if there is not space-in-mils remaining.
802 \newdimen\mil \mil=0.001in
804 % Old definition--didn't work.
805 %\parseargdef\need{\par %
806 %% This method tries to make TeX break the page naturally
807 %% if the depth of the box does not fit.
808 %{\baselineskip=0pt%
809 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
810 %\prevdepth=-1000pt
813 \parseargdef\need{%
814 % Ensure vertical mode, so we don't make a big box in the middle of a
815 % paragraph.
816 \par
818 % If the @need value is less than one line space, it's useless.
819 \dimen0 = #1\mil
820 \dimen2 = \ht\strutbox
821 \advance\dimen2 by \dp\strutbox
822 \ifdim\dimen0 > \dimen2
824 % Do a \strut just to make the height of this box be normal, so the
825 % normal leading is inserted relative to the preceding line.
826 % And a page break here is fine.
827 \vtop to #1\mil{\strut\vfil}%
829 % TeX does not even consider page breaks if a penalty added to the
830 % main vertical list is 10000 or more. But in order to see if the
831 % empty box we just added fits on the page, we must make it consider
832 % page breaks. On the other hand, we don't want to actually break the
833 % page after the empty box. So we use a penalty of 9999.
835 % There is an extremely small chance that TeX will actually break the
836 % page at this \penalty, if there are no other feasible breakpoints in
837 % sight. (If the user is using lots of big @group commands, which
838 % almost-but-not-quite fill up a page, TeX will have a hard time doing
839 % good page breaking, for example.) However, I could not construct an
840 % example where a page broke at this \penalty; if it happens in a real
841 % document, then we can reconsider our strategy.
842 \penalty9999
844 % Back up by the size of the box, whether we did a page break or not.
845 \kern -#1\mil
847 % Do not allow a page break right after this kern.
848 \nobreak
852 % @br forces paragraph break (and is undocumented).
854 \let\br = \par
856 % @page forces the start of a new page.
858 \def\page{\par\vfill\supereject}
860 % @exdent text....
861 % outputs text on separate line in roman font, starting at standard page margin
863 % This records the amount of indent in the innermost environment.
864 % That's how much \exdent should take out.
865 \newskip\exdentamount
867 % This defn is used inside fill environments such as @defun.
868 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
870 % This defn is used inside nofill environments such as @example.
871 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
872 \leftline{\hskip\leftskip{\rm#1}}}}
874 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
875 % paragraph. For more general purposes, use the \margin insertion
876 % class. WHICH is `l' or `r'.
878 \newskip\inmarginspacing \inmarginspacing=1cm
879 \def\strutdepth{\dp\strutbox}
881 \def\doinmargin#1#2{\strut\vadjust{%
882 \nobreak
883 \kern-\strutdepth
884 \vtop to \strutdepth{%
885 \baselineskip=\strutdepth
886 \vss
887 % if you have multiple lines of stuff to put here, you'll need to
888 % make the vbox yourself of the appropriate size.
889 \ifx#1l%
890 \llap{\ignorespaces #2\hskip\inmarginspacing}%
891 \else
892 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
894 \null
897 \def\inleftmargin{\doinmargin l}
898 \def\inrightmargin{\doinmargin r}
900 % @inmargin{TEXT [, RIGHT-TEXT]}
901 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
902 % else use TEXT for both).
904 \def\inmargin#1{\parseinmargin #1,,\finish}
905 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
906 \setbox0 = \hbox{\ignorespaces #2}%
907 \ifdim\wd0 > 0pt
908 \def\lefttext{#1}% have both texts
909 \def\righttext{#2}%
910 \else
911 \def\lefttext{#1}% have only one text
912 \def\righttext{#1}%
915 \ifodd\pageno
916 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
917 \else
918 \def\temp{\inleftmargin\lefttext}%
920 \temp
923 % @include FILE -- \input text of FILE.
925 \def\include{\parseargusing\filenamecatcodes\includezzz}
926 \def\includezzz#1{%
927 \pushthisfilestack
928 \def\thisfile{#1}%
930 \makevalueexpandable % we want to expand any @value in FILE.
931 \turnoffactive % and allow special characters in the expansion
932 \indexnofonts % Allow `@@' and other weird things in file names.
933 \edef\temp{\noexpand\input #1 }%
935 % This trickery is to read FILE outside of a group, in case it makes
936 % definitions, etc.
937 \expandafter
938 }\temp
939 \popthisfilestack
941 \def\filenamecatcodes{%
942 \catcode`\\=\other
943 \catcode`~=\other
944 \catcode`^=\other
945 \catcode`_=\other
946 \catcode`|=\other
947 \catcode`<=\other
948 \catcode`>=\other
949 \catcode`+=\other
950 \catcode`-=\other
951 \catcode`\`=\other
952 \catcode`\'=\other
955 \def\pushthisfilestack{%
956 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
958 \def\pushthisfilestackX{%
959 \expandafter\pushthisfilestackY\thisfile\StackTerm
961 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
962 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
965 \def\popthisfilestack{\errthisfilestackempty}
966 \def\errthisfilestackempty{\errmessage{Internal error:
967 the stack of filenames is empty.}}
969 \def\thisfile{}
971 % @center line
972 % outputs that line, centered.
974 \parseargdef\center{%
975 \ifhmode
976 \let\next\centerH
977 \else
978 \let\next\centerV
980 \next{\hfil \ignorespaces#1\unskip \hfil}%
982 \def\centerH#1{%
984 \hfil\break
985 \advance\hsize by -\leftskip
986 \advance\hsize by -\rightskip
987 \line{#1}%
988 \break
991 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
993 % @sp n outputs n lines of vertical space
995 \parseargdef\sp{\vskip #1\baselineskip}
997 % @comment ...line which is ignored...
998 % @c is the same as @comment
999 % @ignore ... @end ignore is another way to write a comment
1001 \def\comment{\begingroup \catcode`\^^M=\other%
1002 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
1003 \commentxxx}
1004 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
1006 \let\c=\comment
1008 % @paragraphindent NCHARS
1009 % We'll use ems for NCHARS, close enough.
1010 % NCHARS can also be the word `asis' or `none'.
1011 % We cannot feasibly implement @paragraphindent asis, though.
1013 \def\asisword{asis} % no translation, these are keywords
1014 \def\noneword{none}
1016 \parseargdef\paragraphindent{%
1017 \def\temp{#1}%
1018 \ifx\temp\asisword
1019 \else
1020 \ifx\temp\noneword
1021 \defaultparindent = 0pt
1022 \else
1023 \defaultparindent = #1em
1026 \parindent = \defaultparindent
1029 % @exampleindent NCHARS
1030 % We'll use ems for NCHARS like @paragraphindent.
1031 % It seems @exampleindent asis isn't necessary, but
1032 % I preserve it to make it similar to @paragraphindent.
1033 \parseargdef\exampleindent{%
1034 \def\temp{#1}%
1035 \ifx\temp\asisword
1036 \else
1037 \ifx\temp\noneword
1038 \lispnarrowing = 0pt
1039 \else
1040 \lispnarrowing = #1em
1045 % @firstparagraphindent WORD
1046 % If WORD is `none', then suppress indentation of the first paragraph
1047 % after a section heading. If WORD is `insert', then do indent at such
1048 % paragraphs.
1050 % The paragraph indentation is suppressed or not by calling
1051 % \suppressfirstparagraphindent, which the sectioning commands do.
1052 % We switch the definition of this back and forth according to WORD.
1053 % By default, we suppress indentation.
1055 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1056 \def\insertword{insert}
1058 \parseargdef\firstparagraphindent{%
1059 \def\temp{#1}%
1060 \ifx\temp\noneword
1061 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1062 \else\ifx\temp\insertword
1063 \let\suppressfirstparagraphindent = \relax
1064 \else
1065 \errhelp = \EMsimple
1066 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1067 \fi\fi
1070 % Here is how we actually suppress indentation. Redefine \everypar to
1071 % \kern backwards by \parindent, and then reset itself to empty.
1073 % We also make \indent itself not actually do anything until the next
1074 % paragraph.
1076 \gdef\dosuppressfirstparagraphindent{%
1077 \gdef\indent{%
1078 \restorefirstparagraphindent
1079 \indent
1081 \gdef\noindent{%
1082 \restorefirstparagraphindent
1083 \noindent
1085 \global\everypar = {%
1086 \kern -\parindent
1087 \restorefirstparagraphindent
1091 \gdef\restorefirstparagraphindent{%
1092 \global \let \indent = \ptexindent
1093 \global \let \noindent = \ptexnoindent
1094 \global \everypar = {}%
1098 % @asis just yields its argument. Used with @table, for example.
1100 \def\asis#1{#1}
1102 % @math outputs its argument in math mode.
1104 % One complication: _ usually means subscripts, but it could also mean
1105 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1106 % _ active, and distinguish by seeing if the current family is \slfam,
1107 % which is what @var uses.
1109 \catcode`\_ = \active
1110 \gdef\mathunderscore{%
1111 \catcode`\_=\active
1112 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1115 % Another complication: we want \\ (and @\) to output a \ character.
1116 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1117 % this is not advertised and we don't care. Texinfo does not
1118 % otherwise define @\.
1120 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1121 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1123 \def\math{%
1124 \tex
1125 \mathunderscore
1126 \let\\ = \mathbackslash
1127 \mathactive
1128 % make the texinfo accent commands work in math mode
1129 \let\"=\ddot
1130 \let\'=\acute
1131 \let\==\bar
1132 \let\^=\hat
1133 \let\`=\grave
1134 \let\u=\breve
1135 \let\v=\check
1136 \let\~=\tilde
1137 \let\dotaccent=\dot
1138 $\finishmath
1140 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1142 % Some active characters (such as <) are spaced differently in math.
1143 % We have to reset their definitions in case the @math was an argument
1144 % to a command which sets the catcodes (such as @item or @section).
1147 \catcode`^ = \active
1148 \catcode`< = \active
1149 \catcode`> = \active
1150 \catcode`+ = \active
1151 \catcode`' = \active
1152 \gdef\mathactive{%
1153 \let^ = \ptexhat
1154 \let< = \ptexless
1155 \let> = \ptexgtr
1156 \let+ = \ptexplus
1157 \let' = \ptexquoteright
1161 % Some math mode symbols.
1162 \def\bullet{$\ptexbullet$}
1163 \def\geq{\ifmmode \ge\else $\ge$\fi}
1164 \def\leq{\ifmmode \le\else $\le$\fi}
1165 \def\minus{\ifmmode -\else $-$\fi}
1167 % @dots{} outputs an ellipsis using the current font.
1168 % We do .5em per period so that it has the same spacing in the cm
1169 % typewriter fonts as three actual period characters; on the other hand,
1170 % in other typewriter fonts three periods are wider than 1.5em. So do
1171 % whichever is larger.
1173 \def\dots{%
1174 \leavevmode
1175 \setbox0=\hbox{...}% get width of three periods
1176 \ifdim\wd0 > 1.5em
1177 \dimen0 = \wd0
1178 \else
1179 \dimen0 = 1.5em
1181 \hbox to \dimen0{%
1182 \hskip 0pt plus.25fil
1183 .\hskip 0pt plus1fil
1184 .\hskip 0pt plus1fil
1185 .\hskip 0pt plus.5fil
1189 % @enddots{} is an end-of-sentence ellipsis.
1191 \def\enddots{%
1192 \dots
1193 \spacefactor=\endofsentencespacefactor
1196 % @comma{} is so commas can be inserted into text without messing up
1197 % Texinfo's parsing.
1199 \let\comma = ,
1201 % @refill is a no-op.
1202 \let\refill=\relax
1204 % If working on a large document in chapters, it is convenient to
1205 % be able to disable indexing, cross-referencing, and contents, for test runs.
1206 % This is done with @novalidate (before @setfilename).
1208 \newif\iflinks \linkstrue % by default we want the aux files.
1209 \let\novalidate = \linksfalse
1211 % @setfilename is done at the beginning of every texinfo file.
1212 % So open here the files we need to have open while reading the input.
1213 % This makes it possible to make a .fmt file for texinfo.
1214 \def\setfilename{%
1215 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1216 \iflinks
1217 \tryauxfile
1218 % Open the new aux file. TeX will close it automatically at exit.
1219 \immediate\openout\auxfile=\jobname.aux
1220 \fi % \openindices needs to do some work in any case.
1221 \openindices
1222 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1224 % If texinfo.cnf is present on the system, read it.
1225 % Useful for site-wide @afourpaper, etc.
1226 \openin 1 texinfo.cnf
1227 \ifeof 1 \else \input texinfo.cnf \fi
1228 \closein 1
1230 \comment % Ignore the actual filename.
1233 % Called from \setfilename.
1235 \def\openindices{%
1236 \newindex{cp}%
1237 \newcodeindex{fn}%
1238 \newcodeindex{vr}%
1239 \newcodeindex{tp}%
1240 \newcodeindex{ky}%
1241 \newcodeindex{pg}%
1244 % @bye.
1245 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1248 \message{pdf,}
1249 % adobe `portable' document format
1250 \newcount\tempnum
1251 \newcount\lnkcount
1252 \newtoks\filename
1253 \newcount\filenamelength
1254 \newcount\pgn
1255 \newtoks\toksA
1256 \newtoks\toksB
1257 \newtoks\toksC
1258 \newtoks\toksD
1259 \newbox\boxA
1260 \newcount\countA
1261 \newif\ifpdf
1262 \newif\ifpdfmakepagedest
1264 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1265 % can be set). So we test for \relax and 0 as well as \undefined,
1266 % borrowed from ifpdf.sty.
1267 \ifx\pdfoutput\undefined
1268 \else
1269 \ifx\pdfoutput\relax
1270 \else
1271 \ifcase\pdfoutput
1272 \else
1273 \pdftrue
1278 % PDF uses PostScript string constants for the names of xref targets,
1279 % for display in the outlines, and in other places. Thus, we have to
1280 % double any backslashes. Otherwise, a name like "\node" will be
1281 % interpreted as a newline (\n), followed by o, d, e. Not good.
1282 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1283 % (and related messages, the final outcome is that it is up to the TeX
1284 % user to double the backslashes and otherwise make the string valid, so
1285 % that's what we do).
1287 % double active backslashes.
1289 {\catcode`\@=0 \catcode`\\=\active
1290 @gdef@activebackslashdouble{%
1291 @catcode`@\=@active
1292 @let\=@doublebackslash}
1295 % To handle parens, we must adopt a different approach, since parens are
1296 % not active characters. hyperref.dtx (which has the same problem as
1297 % us) handles it with this amazing macro to replace tokens, with minor
1298 % changes for Texinfo. It is included here under the GPL by permission
1299 % from the author, Heiko Oberdiek.
1301 % #1 is the tokens to replace.
1302 % #2 is the replacement.
1303 % #3 is the control sequence with the string.
1305 \def\HyPsdSubst#1#2#3{%
1306 \def\HyPsdReplace##1#1##2\END{%
1307 ##1%
1308 \ifx\\##2\\%
1309 \else
1311 \HyReturnAfterFi{%
1312 \HyPsdReplace##2\END
1316 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1318 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1320 % #1 is a control sequence in which to do the replacements.
1321 \def\backslashparens#1{%
1322 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1323 % \lastnode when called from \setref -> \pdfmkdest.
1324 \HyPsdSubst{(}{\realbackslash(}{#1}%
1325 \HyPsdSubst{)}{\realbackslash)}{#1}%
1328 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1329 with PDF output, and none of those formats could be found. (.eps cannot
1330 be supported due to the design of the PDF format; use regular TeX (DVI
1331 output) for that.)}
1333 \ifpdf
1335 % Color manipulation macros based on pdfcolor.tex.
1336 \def\cmykDarkRed{0.28 1 1 0.35}
1337 \def\cmykBlack{0 0 0 1}
1339 % k sets the color for filling (usual text, etc.);
1340 % K sets the color for stroking (thin rules, e.g., normal _'s).
1341 \def\pdfsetcolor#1{\pdfliteral{#1 k #1 K}}
1343 % Set color, and create a mark which defines \thiscolor accordingly,
1344 % so that \makeheadline knows which color to restore.
1345 \def\setcolor#1{%
1346 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1347 \domark
1348 \pdfsetcolor{#1}%
1351 \def\maincolor{\cmykBlack}
1352 \pdfsetcolor{\maincolor}
1353 \edef\thiscolor{\maincolor}
1354 \def\lastcolordefs{}
1356 \def\makefootline{%
1357 \baselineskip24pt
1358 \line{\pdfsetcolor{\maincolor}\the\footline}%
1361 \def\makeheadline{%
1362 \vbox to 0pt{%
1363 \vskip-22.5pt
1364 \line{%
1365 \vbox to8.5pt{}%
1366 % Extract \thiscolor definition from the marks.
1367 \getcolormarks
1368 % Typeset the headline with \maincolor, then restore the color.
1369 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1371 \vss
1373 \nointerlineskip
1377 \pdfcatalog{/PageMode /UseOutlines}
1379 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1380 \def\dopdfimage#1#2#3{%
1381 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1382 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1384 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1385 % others). Let's try in that order.
1386 \let\pdfimgext=\empty
1387 \begingroup
1388 \openin 1 #1.png \ifeof 1
1389 \openin 1 #1.jpg \ifeof 1
1390 \openin 1 #1.jpeg \ifeof 1
1391 \openin 1 #1.JPG \ifeof 1
1392 \openin 1 #1.pdf \ifeof 1
1393 \openin 1 #1.PDF \ifeof 1
1394 \errhelp = \nopdfimagehelp
1395 \errmessage{Could not find image file #1 for pdf}%
1396 \else \gdef\pdfimgext{PDF}%
1398 \else \gdef\pdfimgext{pdf}%
1400 \else \gdef\pdfimgext{JPG}%
1402 \else \gdef\pdfimgext{jpeg}%
1404 \else \gdef\pdfimgext{jpg}%
1406 \else \gdef\pdfimgext{png}%
1408 \closein 1
1409 \endgroup
1411 % without \immediate, ancient pdftex seg faults when the same image is
1412 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1413 \ifnum\pdftexversion < 14
1414 \immediate\pdfimage
1415 \else
1416 \immediate\pdfximage
1418 \ifdim \wd0 >0pt width \imagewidth \fi
1419 \ifdim \wd2 >0pt height \imageheight \fi
1420 \ifnum\pdftexversion<13
1421 #1.\pdfimgext
1422 \else
1423 {#1.\pdfimgext}%
1425 \ifnum\pdftexversion < 14 \else
1426 \pdfrefximage \pdflastximage
1427 \fi}
1429 \def\pdfmkdest#1{{%
1430 % We have to set dummies so commands such as @code, and characters
1431 % such as \, aren't expanded when present in a section title.
1432 \indexnofonts
1433 \turnoffactive
1434 \activebackslashdouble
1435 \makevalueexpandable
1436 \def\pdfdestname{#1}%
1437 \backslashparens\pdfdestname
1438 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1441 % used to mark target names; must be expandable.
1442 \def\pdfmkpgn#1{#1}
1444 % by default, use a color that is dark enough to print on paper as
1445 % nearly black, but still distinguishable for online viewing.
1446 \def\urlcolor{\cmykDarkRed}
1447 \def\linkcolor{\cmykDarkRed}
1448 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1450 % Adding outlines to PDF; macros for calculating structure of outlines
1451 % come from Petr Olsak
1452 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1453 \else \csname#1\endcsname \fi}
1454 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1455 \advance\tempnum by 1
1456 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1458 % #1 is the section text, which is what will be displayed in the
1459 % outline by the pdf viewer. #2 is the pdf expression for the number
1460 % of subentries (or empty, for subsubsections). #3 is the node text,
1461 % which might be empty if this toc entry had no corresponding node.
1462 % #4 is the page number
1464 \def\dopdfoutline#1#2#3#4{%
1465 % Generate a link to the node text if that exists; else, use the
1466 % page number. We could generate a destination for the section
1467 % text in the case where a section has no node, but it doesn't
1468 % seem worth the trouble, since most documents are normally structured.
1469 \def\pdfoutlinedest{#3}%
1470 \ifx\pdfoutlinedest\empty
1471 \def\pdfoutlinedest{#4}%
1472 \else
1473 % Doubled backslashes in the name.
1474 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1475 \backslashparens\pdfoutlinedest}%
1478 % Also double the backslashes in the display string.
1479 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1480 \backslashparens\pdfoutlinetext}%
1482 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1485 \def\pdfmakeoutlines{%
1486 \begingroup
1487 % Thanh's hack / proper braces in bookmarks
1488 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1489 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1491 % Read toc silently, to get counts of subentries for \pdfoutline.
1492 \def\numchapentry##1##2##3##4{%
1493 \def\thischapnum{##2}%
1494 \def\thissecnum{0}%
1495 \def\thissubsecnum{0}%
1497 \def\numsecentry##1##2##3##4{%
1498 \advancenumber{chap\thischapnum}%
1499 \def\thissecnum{##2}%
1500 \def\thissubsecnum{0}%
1502 \def\numsubsecentry##1##2##3##4{%
1503 \advancenumber{sec\thissecnum}%
1504 \def\thissubsecnum{##2}%
1506 \def\numsubsubsecentry##1##2##3##4{%
1507 \advancenumber{subsec\thissubsecnum}%
1509 \def\thischapnum{0}%
1510 \def\thissecnum{0}%
1511 \def\thissubsecnum{0}%
1513 % use \def rather than \let here because we redefine \chapentry et
1514 % al. a second time, below.
1515 \def\appentry{\numchapentry}%
1516 \def\appsecentry{\numsecentry}%
1517 \def\appsubsecentry{\numsubsecentry}%
1518 \def\appsubsubsecentry{\numsubsubsecentry}%
1519 \def\unnchapentry{\numchapentry}%
1520 \def\unnsecentry{\numsecentry}%
1521 \def\unnsubsecentry{\numsubsecentry}%
1522 \def\unnsubsubsecentry{\numsubsubsecentry}%
1523 \readdatafile{toc}%
1525 % Read toc second time, this time actually producing the outlines.
1526 % The `-' means take the \expnumber as the absolute number of
1527 % subentries, which we calculated on our first read of the .toc above.
1529 % We use the node names as the destinations.
1530 \def\numchapentry##1##2##3##4{%
1531 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1532 \def\numsecentry##1##2##3##4{%
1533 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1534 \def\numsubsecentry##1##2##3##4{%
1535 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1536 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1537 \dopdfoutline{##1}{}{##3}{##4}}%
1539 % PDF outlines are displayed using system fonts, instead of
1540 % document fonts. Therefore we cannot use special characters,
1541 % since the encoding is unknown. For example, the eogonek from
1542 % Latin 2 (0xea) gets translated to a | character. Info from
1543 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1545 % xx to do this right, we have to translate 8-bit characters to
1546 % their "best" equivalent, based on the @documentencoding. Right
1547 % now, I guess we'll just let the pdf reader have its way.
1548 \indexnofonts
1549 \setupdatafile
1550 \catcode`\\=\active \otherbackslash
1551 \input \tocreadfilename
1552 \endgroup
1555 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1556 \ifx\PP\D\let\nextsp\relax
1557 \else\let\nextsp\skipspaces
1558 \ifx\p\space\else\addtokens{\filename}{\PP}%
1559 \advance\filenamelength by 1
1562 \nextsp}
1563 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1564 \ifnum\pdftexversion < 14
1565 \let \startlink \pdfannotlink
1566 \else
1567 \let \startlink \pdfstartlink
1569 % make a live url in pdf output.
1570 \def\pdfurl#1{%
1571 \begingroup
1572 % it seems we really need yet another set of dummies; have not
1573 % tried to figure out what each command should do in the context
1574 % of @url. for now, just make @/ a no-op, that's the only one
1575 % people have actually reported a problem with.
1577 \normalturnoffactive
1578 \def\@{@}%
1579 \let\/=\empty
1580 \makevalueexpandable
1581 % \indexnofonts -- is that what we want?
1582 \def\var##1{##1}%
1584 \leavevmode\setcolor{\urlcolor}%
1585 \startlink attr{/Border [0 0 0]}%
1586 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1587 \endgroup}
1588 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1589 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1590 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1591 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1592 \def\maketoks{%
1593 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1594 \ifx\first0\adn0
1595 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1596 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1597 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1598 \else
1599 \ifnum0=\countA\else\makelink\fi
1600 \ifx\first.\let\next=\done\else
1601 \let\next=\maketoks
1602 \addtokens{\toksB}{\the\toksD}
1603 \ifx\first,\addtokens{\toksB}{\space}\fi
1605 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1606 \next}
1607 \def\makelink{\addtokens{\toksB}%
1608 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1609 \def\pdflink#1{%
1610 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1611 \setcolor{\linkcolor}#1\endlink}
1612 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1613 \else
1614 % non-pdf mode
1615 \let\pdfmkdest = \gobble
1616 \let\pdfurl = \gobble
1617 \let\endlink = \relax
1618 \let\setcolor = \gobble
1619 \let\pdfsetcolor = \gobble
1620 \let\pdfmakeoutlines = \relax
1621 \fi % \ifx\pdfoutput
1624 \message{fonts,}
1626 % Change the current font style to #1, remembering it in \curfontstyle.
1627 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1628 % italics, not bold italics.
1630 \def\setfontstyle#1{%
1631 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1632 \csname ten#1\endcsname % change the current font
1635 % Select #1 fonts with the current style.
1637 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1639 \def\rm{\fam=0 \setfontstyle{rm}}
1640 \def\it{\fam=\itfam \setfontstyle{it}}
1641 \def\sl{\fam=\slfam \setfontstyle{sl}}
1642 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1643 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1645 % Unfortunately, we have to override this for titles and the like, since
1646 % in those cases "rm" is bold. Sigh.
1647 \def\rmisbold{\rm\def\curfontstyle{bf}}
1649 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1650 % So we set up a \sf.
1651 \newfam\sffam
1652 \def\sf{\fam=\sffam \setfontstyle{sf}}
1653 \let\li = \sf % Sometimes we call it \li, not \sf.
1655 % We don't need math for this font style.
1656 \def\ttsl{\setfontstyle{ttsl}}
1659 % Default leading.
1660 \newdimen\textleading \textleading = 13.2pt
1662 % Set the baselineskip to #1, and the lineskip and strut size
1663 % correspondingly. There is no deep meaning behind these magic numbers
1664 % used as factors; they just match (closely enough) what Knuth defined.
1666 \def\lineskipfactor{.08333}
1667 \def\strutheightpercent{.70833}
1668 \def\strutdepthpercent {.29167}
1670 % can get a sort of poor man's double spacing by redefining this.
1671 \def\baselinefactor{1}
1673 \def\setleading#1{%
1674 \dimen0 = #1\relax
1675 \normalbaselineskip = \baselinefactor\dimen0
1676 \normallineskip = \lineskipfactor\normalbaselineskip
1677 \normalbaselines
1678 \setbox\strutbox =\hbox{%
1679 \vrule width0pt height\strutheightpercent\baselineskip
1680 depth \strutdepthpercent \baselineskip
1684 % PDF CMaps. See also LaTeX's t1.cmap.
1686 % do nothing with this by default.
1687 \expandafter\let\csname cmapOT1\endcsname\gobble
1688 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1689 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1691 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1692 % (\pdffontattr was introduced many years ago, but people still run
1693 % older pdftex's; it's easy to conditionalize, so we do.)
1694 \ifpdf \ifx\pdffontattr\undefined \else
1695 \begingroup
1696 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1697 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1698 %%DocumentNeededResources: ProcSet (CIDInit)
1699 %%IncludeResource: ProcSet (CIDInit)
1700 %%BeginResource: CMap (TeX-OT1-0)
1701 %%Title: (TeX-OT1-0 TeX OT1 0)
1702 %%Version: 1.000
1703 %%EndComments
1704 /CIDInit /ProcSet findresource begin
1705 12 dict begin
1706 begincmap
1707 /CIDSystemInfo
1708 << /Registry (TeX)
1709 /Ordering (OT1)
1710 /Supplement 0
1711 >> def
1712 /CMapName /TeX-OT1-0 def
1713 /CMapType 2 def
1714 1 begincodespacerange
1715 <00> <7F>
1716 endcodespacerange
1717 8 beginbfrange
1718 <00> <01> <0393>
1719 <09> <0A> <03A8>
1720 <23> <26> <0023>
1721 <28> <3B> <0028>
1722 <3F> <5B> <003F>
1723 <5D> <5E> <005D>
1724 <61> <7A> <0061>
1725 <7B> <7C> <2013>
1726 endbfrange
1727 40 beginbfchar
1728 <02> <0398>
1729 <03> <039B>
1730 <04> <039E>
1731 <05> <03A0>
1732 <06> <03A3>
1733 <07> <03D2>
1734 <08> <03A6>
1735 <0B> <00660066>
1736 <0C> <00660069>
1737 <0D> <0066006C>
1738 <0E> <006600660069>
1739 <0F> <00660066006C>
1740 <10> <0131>
1741 <11> <0237>
1742 <12> <0060>
1743 <13> <00B4>
1744 <14> <02C7>
1745 <15> <02D8>
1746 <16> <00AF>
1747 <17> <02DA>
1748 <18> <00B8>
1749 <19> <00DF>
1750 <1A> <00E6>
1751 <1B> <0153>
1752 <1C> <00F8>
1753 <1D> <00C6>
1754 <1E> <0152>
1755 <1F> <00D8>
1756 <21> <0021>
1757 <22> <201D>
1758 <27> <2019>
1759 <3C> <00A1>
1760 <3D> <003D>
1761 <3E> <00BF>
1762 <5C> <201C>
1763 <5F> <02D9>
1764 <60> <2018>
1765 <7D> <02DD>
1766 <7E> <007E>
1767 <7F> <00A8>
1768 endbfchar
1769 endcmap
1770 CMapName currentdict /CMap defineresource pop
1773 %%EndResource
1774 %%EOF
1775 }\endgroup
1776 \expandafter\edef\csname cmapOT1\endcsname#1{%
1777 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1780 % \cmapOT1IT
1781 \begingroup
1782 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1783 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1784 %%DocumentNeededResources: ProcSet (CIDInit)
1785 %%IncludeResource: ProcSet (CIDInit)
1786 %%BeginResource: CMap (TeX-OT1IT-0)
1787 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1788 %%Version: 1.000
1789 %%EndComments
1790 /CIDInit /ProcSet findresource begin
1791 12 dict begin
1792 begincmap
1793 /CIDSystemInfo
1794 << /Registry (TeX)
1795 /Ordering (OT1IT)
1796 /Supplement 0
1797 >> def
1798 /CMapName /TeX-OT1IT-0 def
1799 /CMapType 2 def
1800 1 begincodespacerange
1801 <00> <7F>
1802 endcodespacerange
1803 8 beginbfrange
1804 <00> <01> <0393>
1805 <09> <0A> <03A8>
1806 <25> <26> <0025>
1807 <28> <3B> <0028>
1808 <3F> <5B> <003F>
1809 <5D> <5E> <005D>
1810 <61> <7A> <0061>
1811 <7B> <7C> <2013>
1812 endbfrange
1813 42 beginbfchar
1814 <02> <0398>
1815 <03> <039B>
1816 <04> <039E>
1817 <05> <03A0>
1818 <06> <03A3>
1819 <07> <03D2>
1820 <08> <03A6>
1821 <0B> <00660066>
1822 <0C> <00660069>
1823 <0D> <0066006C>
1824 <0E> <006600660069>
1825 <0F> <00660066006C>
1826 <10> <0131>
1827 <11> <0237>
1828 <12> <0060>
1829 <13> <00B4>
1830 <14> <02C7>
1831 <15> <02D8>
1832 <16> <00AF>
1833 <17> <02DA>
1834 <18> <00B8>
1835 <19> <00DF>
1836 <1A> <00E6>
1837 <1B> <0153>
1838 <1C> <00F8>
1839 <1D> <00C6>
1840 <1E> <0152>
1841 <1F> <00D8>
1842 <21> <0021>
1843 <22> <201D>
1844 <23> <0023>
1845 <24> <00A3>
1846 <27> <2019>
1847 <3C> <00A1>
1848 <3D> <003D>
1849 <3E> <00BF>
1850 <5C> <201C>
1851 <5F> <02D9>
1852 <60> <2018>
1853 <7D> <02DD>
1854 <7E> <007E>
1855 <7F> <00A8>
1856 endbfchar
1857 endcmap
1858 CMapName currentdict /CMap defineresource pop
1861 %%EndResource
1862 %%EOF
1863 }\endgroup
1864 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1865 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1868 % \cmapOT1TT
1869 \begingroup
1870 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1871 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1872 %%DocumentNeededResources: ProcSet (CIDInit)
1873 %%IncludeResource: ProcSet (CIDInit)
1874 %%BeginResource: CMap (TeX-OT1TT-0)
1875 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1876 %%Version: 1.000
1877 %%EndComments
1878 /CIDInit /ProcSet findresource begin
1879 12 dict begin
1880 begincmap
1881 /CIDSystemInfo
1882 << /Registry (TeX)
1883 /Ordering (OT1TT)
1884 /Supplement 0
1885 >> def
1886 /CMapName /TeX-OT1TT-0 def
1887 /CMapType 2 def
1888 1 begincodespacerange
1889 <00> <7F>
1890 endcodespacerange
1891 5 beginbfrange
1892 <00> <01> <0393>
1893 <09> <0A> <03A8>
1894 <21> <26> <0021>
1895 <28> <5F> <0028>
1896 <61> <7E> <0061>
1897 endbfrange
1898 32 beginbfchar
1899 <02> <0398>
1900 <03> <039B>
1901 <04> <039E>
1902 <05> <03A0>
1903 <06> <03A3>
1904 <07> <03D2>
1905 <08> <03A6>
1906 <0B> <2191>
1907 <0C> <2193>
1908 <0D> <0027>
1909 <0E> <00A1>
1910 <0F> <00BF>
1911 <10> <0131>
1912 <11> <0237>
1913 <12> <0060>
1914 <13> <00B4>
1915 <14> <02C7>
1916 <15> <02D8>
1917 <16> <00AF>
1918 <17> <02DA>
1919 <18> <00B8>
1920 <19> <00DF>
1921 <1A> <00E6>
1922 <1B> <0153>
1923 <1C> <00F8>
1924 <1D> <00C6>
1925 <1E> <0152>
1926 <1F> <00D8>
1927 <20> <2423>
1928 <27> <2019>
1929 <60> <2018>
1930 <7F> <00A8>
1931 endbfchar
1932 endcmap
1933 CMapName currentdict /CMap defineresource pop
1936 %%EndResource
1937 %%EOF
1938 }\endgroup
1939 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1940 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1942 \fi\fi
1945 % Set the font macro #1 to the font named #2, adding on the
1946 % specified font prefix (normally `cm').
1947 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1948 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1949 % empty to omit).
1950 \def\setfont#1#2#3#4#5{%
1951 \font#1=\fontprefix#2#3 scaled #4
1952 \csname cmap#5\endcsname#1%
1954 % This is what gets called when #5 of \setfont is empty.
1955 \let\cmap\gobble
1956 % emacs-page end of cmaps
1958 % Use cm as the default font prefix.
1959 % To specify the font prefix, you must define \fontprefix
1960 % before you read in texinfo.tex.
1961 \ifx\fontprefix\undefined
1962 \def\fontprefix{cm}
1964 % Support font families that don't use the same naming scheme as CM.
1965 \def\rmshape{r}
1966 \def\rmbshape{bx} %where the normal face is bold
1967 \def\bfshape{b}
1968 \def\bxshape{bx}
1969 \def\ttshape{tt}
1970 \def\ttbshape{tt}
1971 \def\ttslshape{sltt}
1972 \def\itshape{ti}
1973 \def\itbshape{bxti}
1974 \def\slshape{sl}
1975 \def\slbshape{bxsl}
1976 \def\sfshape{ss}
1977 \def\sfbshape{ss}
1978 \def\scshape{csc}
1979 \def\scbshape{csc}
1981 % Definitions for a main text size of 11pt. This is the default in
1982 % Texinfo.
1984 \def\definetextfontsizexi{%
1985 % Text fonts (11.2pt, magstep1).
1986 \def\textnominalsize{11pt}
1987 \edef\mainmagstep{\magstephalf}
1988 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1989 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1990 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1991 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1992 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1993 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1994 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1995 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1996 \font\texti=cmmi10 scaled \mainmagstep
1997 \font\textsy=cmsy10 scaled \mainmagstep
1998 \def\textecsize{1095}
2000 % A few fonts for @defun names and args.
2001 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
2002 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
2003 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
2004 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2006 % Fonts for indices, footnotes, small examples (9pt).
2007 \def\smallnominalsize{9pt}
2008 \setfont\smallrm\rmshape{9}{1000}{OT1}
2009 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2010 \setfont\smallbf\bfshape{10}{900}{OT1}
2011 \setfont\smallit\itshape{9}{1000}{OT1IT}
2012 \setfont\smallsl\slshape{9}{1000}{OT1}
2013 \setfont\smallsf\sfshape{9}{1000}{OT1}
2014 \setfont\smallsc\scshape{10}{900}{OT1}
2015 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2016 \font\smalli=cmmi9
2017 \font\smallsy=cmsy9
2018 \def\smallecsize{0900}
2020 % Fonts for small examples (8pt).
2021 \def\smallernominalsize{8pt}
2022 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2023 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2024 \setfont\smallerbf\bfshape{10}{800}{OT1}
2025 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2026 \setfont\smallersl\slshape{8}{1000}{OT1}
2027 \setfont\smallersf\sfshape{8}{1000}{OT1}
2028 \setfont\smallersc\scshape{10}{800}{OT1}
2029 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2030 \font\smalleri=cmmi8
2031 \font\smallersy=cmsy8
2032 \def\smallerecsize{0800}
2034 % Fonts for title page (20.4pt):
2035 \def\titlenominalsize{20pt}
2036 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2037 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2038 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2039 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2040 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2041 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2042 \let\titlebf=\titlerm
2043 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2044 \font\titlei=cmmi12 scaled \magstep3
2045 \font\titlesy=cmsy10 scaled \magstep4
2046 \def\titleecsize{2074}
2048 % Chapter (and unnumbered) fonts (17.28pt).
2049 \def\chapnominalsize{17pt}
2050 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
2051 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
2052 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
2053 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
2054 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2055 \setfont\chapsf\sfbshape{17}{1000}{OT1}
2056 \let\chapbf=\chaprm
2057 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
2058 \font\chapi=cmmi12 scaled \magstep2
2059 \font\chapsy=cmsy10 scaled \magstep3
2060 \def\chapecsize{1728}
2062 % Section fonts (14.4pt).
2063 \def\secnominalsize{14pt}
2064 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
2065 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
2066 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
2067 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
2068 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2069 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
2070 \let\secbf\secrm
2071 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
2072 \font\seci=cmmi12 scaled \magstep1
2073 \font\secsy=cmsy10 scaled \magstep2
2074 \def\sececsize{1440}
2076 % Subsection fonts (13.15pt).
2077 \def\ssecnominalsize{13pt}
2078 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
2079 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
2080 \setfont\ssecsl\slbshape{10}{1315}{OT1}
2081 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
2082 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2083 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
2084 \let\ssecbf\ssecrm
2085 \setfont\ssecsc\scbshape{10}{1315}{OT1}
2086 \font\sseci=cmmi12 scaled \magstephalf
2087 \font\ssecsy=cmsy10 scaled 1315
2088 \def\ssececsize{1200}
2090 % Reduced fonts for @acro in text (10pt).
2091 \def\reducednominalsize{10pt}
2092 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2093 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2094 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2095 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2096 \setfont\reducedsl\slshape{10}{1000}{OT1}
2097 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2098 \setfont\reducedsc\scshape{10}{1000}{OT1}
2099 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2100 \font\reducedi=cmmi10
2101 \font\reducedsy=cmsy10
2102 \def\reducedecsize{1000}
2104 % reset the current fonts
2105 \textfonts
2107 } % end of 11pt text font size definitions
2110 % Definitions to make the main text be 10pt Computer Modern, with
2111 % section, chapter, etc., sizes following suit. This is for the GNU
2112 % Press printing of the Emacs 22 manual. Maybe other manuals in the
2113 % future. Used with @smallbook, which sets the leading to 12pt.
2115 \def\definetextfontsizex{%
2116 % Text fonts (10pt).
2117 \def\textnominalsize{10pt}
2118 \edef\mainmagstep{1000}
2119 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2120 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2121 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2122 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2123 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2124 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2125 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2126 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2127 \font\texti=cmmi10 scaled \mainmagstep
2128 \font\textsy=cmsy10 scaled \mainmagstep
2129 \def\textecsize{1000}
2131 % A few fonts for @defun names and args.
2132 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2133 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2134 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2135 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2137 % Fonts for indices, footnotes, small examples (9pt).
2138 \def\smallnominalsize{9pt}
2139 \setfont\smallrm\rmshape{9}{1000}{OT1}
2140 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2141 \setfont\smallbf\bfshape{10}{900}{OT1}
2142 \setfont\smallit\itshape{9}{1000}{OT1IT}
2143 \setfont\smallsl\slshape{9}{1000}{OT1}
2144 \setfont\smallsf\sfshape{9}{1000}{OT1}
2145 \setfont\smallsc\scshape{10}{900}{OT1}
2146 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2147 \font\smalli=cmmi9
2148 \font\smallsy=cmsy9
2149 \def\smallecsize{0900}
2151 % Fonts for small examples (8pt).
2152 \def\smallernominalsize{8pt}
2153 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2154 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2155 \setfont\smallerbf\bfshape{10}{800}{OT1}
2156 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2157 \setfont\smallersl\slshape{8}{1000}{OT1}
2158 \setfont\smallersf\sfshape{8}{1000}{OT1}
2159 \setfont\smallersc\scshape{10}{800}{OT1}
2160 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2161 \font\smalleri=cmmi8
2162 \font\smallersy=cmsy8
2163 \def\smallerecsize{0800}
2165 % Fonts for title page (20.4pt):
2166 \def\titlenominalsize{20pt}
2167 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2168 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2169 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2170 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2171 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2172 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2173 \let\titlebf=\titlerm
2174 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2175 \font\titlei=cmmi12 scaled \magstep3
2176 \font\titlesy=cmsy10 scaled \magstep4
2177 \def\titleecsize{2074}
2179 % Chapter fonts (14.4pt).
2180 \def\chapnominalsize{14pt}
2181 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2182 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2183 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2184 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2185 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2186 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2187 \let\chapbf\chaprm
2188 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2189 \font\chapi=cmmi12 scaled \magstep1
2190 \font\chapsy=cmsy10 scaled \magstep2
2191 \def\chapecsize{1440}
2193 % Section fonts (12pt).
2194 \def\secnominalsize{12pt}
2195 \setfont\secrm\rmbshape{12}{1000}{OT1}
2196 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2197 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2198 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2199 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2200 \setfont\secsf\sfbshape{12}{1000}{OT1}
2201 \let\secbf\secrm
2202 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2203 \font\seci=cmmi12
2204 \font\secsy=cmsy10 scaled \magstep1
2205 \def\sececsize{1200}
2207 % Subsection fonts (10pt).
2208 \def\ssecnominalsize{10pt}
2209 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2210 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2211 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2212 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2213 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2214 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2215 \let\ssecbf\ssecrm
2216 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2217 \font\sseci=cmmi10
2218 \font\ssecsy=cmsy10
2219 \def\ssececsize{1000}
2221 % Reduced fonts for @acro in text (9pt).
2222 \def\reducednominalsize{9pt}
2223 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2224 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2225 \setfont\reducedbf\bfshape{10}{900}{OT1}
2226 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2227 \setfont\reducedsl\slshape{9}{1000}{OT1}
2228 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2229 \setfont\reducedsc\scshape{10}{900}{OT1}
2230 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2231 \font\reducedi=cmmi9
2232 \font\reducedsy=cmsy9
2233 \def\reducedecsize{0900}
2235 % reduce space between paragraphs
2236 \divide\parskip by 2
2238 % reset the current fonts
2239 \textfonts
2241 } % end of 10pt text font size definitions
2244 % We provide the user-level command
2245 % @fonttextsize 10
2246 % (or 11) to redefine the text font size. pt is assumed.
2248 \def\xword{10}
2249 \def\xiword{11}
2251 \parseargdef\fonttextsize{%
2252 \def\textsizearg{#1}%
2253 \wlog{doing @fonttextsize \textsizearg}%
2255 % Set \globaldefs so that documents can use this inside @tex, since
2256 % makeinfo 4.8 does not support it, but we need it nonetheless.
2258 \begingroup \globaldefs=1
2259 \ifx\textsizearg\xword \definetextfontsizex
2260 \else \ifx\textsizearg\xiword \definetextfontsizexi
2261 \else
2262 \errhelp=\EMsimple
2263 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2264 \fi\fi
2265 \endgroup
2269 % In order for the font changes to affect most math symbols and letters,
2270 % we have to define the \textfont of the standard families. Since
2271 % texinfo doesn't allow for producing subscripts and superscripts except
2272 % in the main text, we don't bother to reset \scriptfont and
2273 % \scriptscriptfont (which would also require loading a lot more fonts).
2275 \def\resetmathfonts{%
2276 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2277 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2278 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2281 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2282 % of just \STYLE. We do this because \STYLE needs to also set the
2283 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2284 % \tenSTYLE to set the current font.
2286 % Each font-changing command also sets the names \lsize (one size lower)
2287 % and \lllsize (three sizes lower). These relative commands are used in
2288 % the LaTeX logo and acronyms.
2290 % This all needs generalizing, badly.
2292 \def\textfonts{%
2293 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2294 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2295 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2296 \let\tenttsl=\textttsl
2297 \def\curfontsize{text}%
2298 \def\lsize{reduced}\def\lllsize{smaller}%
2299 \resetmathfonts \setleading{\textleading}}
2300 \def\titlefonts{%
2301 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2302 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2303 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2304 \let\tenttsl=\titlettsl
2305 \def\curfontsize{title}%
2306 \def\lsize{chap}\def\lllsize{subsec}%
2307 \resetmathfonts \setleading{25pt}}
2308 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2309 \def\chapfonts{%
2310 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2311 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2312 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2313 \let\tenttsl=\chapttsl
2314 \def\curfontsize{chap}%
2315 \def\lsize{sec}\def\lllsize{text}%
2316 \resetmathfonts \setleading{19pt}}
2317 \def\secfonts{%
2318 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2319 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2320 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2321 \let\tenttsl=\secttsl
2322 \def\curfontsize{sec}%
2323 \def\lsize{subsec}\def\lllsize{reduced}%
2324 \resetmathfonts \setleading{16pt}}
2325 \def\subsecfonts{%
2326 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2327 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2328 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2329 \let\tenttsl=\ssecttsl
2330 \def\curfontsize{ssec}%
2331 \def\lsize{text}\def\lllsize{small}%
2332 \resetmathfonts \setleading{15pt}}
2333 \let\subsubsecfonts = \subsecfonts
2334 \def\reducedfonts{%
2335 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2336 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2337 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2338 \let\tenttsl=\reducedttsl
2339 \def\curfontsize{reduced}%
2340 \def\lsize{small}\def\lllsize{smaller}%
2341 \resetmathfonts \setleading{10.5pt}}
2342 \def\smallfonts{%
2343 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2344 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2345 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2346 \let\tenttsl=\smallttsl
2347 \def\curfontsize{small}%
2348 \def\lsize{smaller}\def\lllsize{smaller}%
2349 \resetmathfonts \setleading{10.5pt}}
2350 \def\smallerfonts{%
2351 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2352 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2353 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2354 \let\tenttsl=\smallerttsl
2355 \def\curfontsize{smaller}%
2356 \def\lsize{smaller}\def\lllsize{smaller}%
2357 \resetmathfonts \setleading{9.5pt}}
2359 % Fonts for short table of contents.
2360 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2361 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2362 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2363 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2365 % Define these just so they can be easily changed for other fonts.
2366 \def\angleleft{$\langle$}
2367 \def\angleright{$\rangle$}
2369 % Set the fonts to use with the @small... environments.
2370 \let\smallexamplefonts = \smallfonts
2372 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2373 % can fit this many characters:
2374 % 8.5x11=86 smallbook=72 a4=90 a5=69
2375 % If we use \scriptfonts (8pt), then we can fit this many characters:
2376 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2377 % For me, subjectively, the few extra characters that fit aren't worth
2378 % the additional smallness of 8pt. So I'm making the default 9pt.
2380 % By the way, for comparison, here's what fits with @example (10pt):
2381 % 8.5x11=71 smallbook=60 a4=75 a5=58
2382 % --karl, 24jan03.
2384 % Set up the default fonts, so we can use them for creating boxes.
2386 \definetextfontsizexi
2389 \message{markup,}
2391 % Check if we are currently using a typewriter font. Since all the
2392 % Computer Modern typewriter fonts have zero interword stretch (and
2393 % shrink), and it is reasonable to expect all typewriter fonts to have
2394 % this property, we can check that font parameter.
2396 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2398 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2399 % define and register \INITMACRO to be called on markup style changes.
2400 % \INITMACRO can check \currentmarkupstyle for the innermost
2401 % style and the set of \ifmarkupSTYLE switches for all styles
2402 % currently in effect.
2403 \newif\ifmarkupvar
2404 \newif\ifmarkupsamp
2405 \newif\ifmarkupkey
2406 %\newif\ifmarkupfile % @file == @samp.
2407 %\newif\ifmarkupoption % @option == @samp.
2408 \newif\ifmarkupcode
2409 \newif\ifmarkupkbd
2410 %\newif\ifmarkupenv % @env == @code.
2411 %\newif\ifmarkupcommand % @command == @code.
2412 \newif\ifmarkuptex % @tex (and part of @math, for now).
2413 \newif\ifmarkupexample
2414 \newif\ifmarkupverb
2415 \newif\ifmarkupverbatim
2417 \let\currentmarkupstyle\empty
2419 \def\setupmarkupstyle#1{%
2420 \csname markup#1true\endcsname
2421 \def\currentmarkupstyle{#1}%
2422 \markupstylesetup
2425 \let\markupstylesetup\empty
2427 \def\defmarkupstylesetup#1{%
2428 \expandafter\def\expandafter\markupstylesetup
2429 \expandafter{\markupstylesetup #1}%
2430 \def#1%
2433 % Markup style setup for left and right quotes.
2434 \defmarkupstylesetup\markupsetuplq{%
2435 \expandafter\let\expandafter \temp \csname markupsetuplq\currentmarkupstyle\endcsname
2436 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2439 \defmarkupstylesetup\markupsetuprq{%
2440 \expandafter\let\expandafter \temp \csname markupsetuprq\currentmarkupstyle\endcsname
2441 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2445 \catcode`\'=\active
2446 \catcode`\`=\active
2448 \gdef\markupsetuplqdefault{\let`\lq}
2449 \gdef\markupsetuprqdefault{\let'\rq}
2451 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2452 \gdef\markupsetcodequoteright{\let'\codequoteright}
2454 \gdef\markupsetnoligaturesquoteleft{\let`\noligaturesquoteleft}
2457 \let\markupsetuplqcode \markupsetcodequoteleft
2458 \let\markupsetuprqcode \markupsetcodequoteright
2459 \let\markupsetuplqexample \markupsetcodequoteleft
2460 \let\markupsetuprqexample \markupsetcodequoteright
2461 \let\markupsetuplqverb \markupsetcodequoteleft
2462 \let\markupsetuprqverb \markupsetcodequoteright
2463 \let\markupsetuplqverbatim \markupsetcodequoteleft
2464 \let\markupsetuprqverbatim \markupsetcodequoteright
2466 \let\markupsetuplqsamp \markupsetnoligaturesquoteleft
2467 \let\markupsetuplqkbd \markupsetnoligaturesquoteleft
2469 % Allow an option to not replace quotes with a regular directed right
2470 % quote/apostrophe (char 0x27), but instead use the undirected quote
2471 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
2472 % the default, but it works for pasting with more pdf viewers (at least
2473 % evince), the lilypond developers report. xpdf does work with the
2474 % regular 0x27.
2476 \def\codequoteright{%
2477 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2478 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2480 \else \char'15 \fi
2481 \else \char'15 \fi
2484 % and a similar option for the left quote char vs. a grave accent.
2485 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2486 % the code environments to do likewise.
2488 \def\codequoteleft{%
2489 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2490 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2491 % [Knuth] pp. 380,381,391
2492 % \relax disables Spanish ligatures ?` and !` of \tt font.
2493 \relax`%
2494 \else \char'22 \fi
2495 \else \char'22 \fi
2498 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2499 \def\noligaturesquoteleft{\relax\lq}
2501 % Count depth in font-changes, for error checks
2502 \newcount\fontdepth \fontdepth=0
2504 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
2505 %% serif) and @ii for TeX italic
2507 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
2508 % unless the following character is such as not to need one.
2509 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
2510 \ptexslash\fi\fi\fi}
2511 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
2512 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
2514 % like \smartslanted except unconditionally uses \ttsl.
2515 % @var is set to this for defun arguments.
2516 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
2518 % @cite is like \smartslanted except unconditionally use \sl. We never want
2519 % ttsl for book titles, do we?
2520 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
2522 \let\i=\smartitalic
2523 \let\slanted=\smartslanted
2524 \def\var#1{{\setupmarkupstyle{var}\smartslanted{#1}}}
2525 \let\dfn=\smartslanted
2526 \let\emph=\smartitalic
2528 % Explicit font changes: @r, @sc, undocumented @ii.
2529 \def\r#1{{\rm #1}} % roman font
2530 \def\sc#1{{\smallcaps#1}} % smallcaps font
2531 \def\ii#1{{\it #1}} % italic font
2533 % @b, explicit bold. Also @strong.
2534 \def\b#1{{\bf #1}}
2535 \let\strong=\b
2537 % @sansserif, explicit sans.
2538 \def\sansserif#1{{\sf #1}}
2540 % We can't just use \exhyphenpenalty, because that only has effect at
2541 % the end of a paragraph. Restore normal hyphenation at the end of the
2542 % group within which \nohyphenation is presumably called.
2544 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2545 \def\restorehyphenation{\hyphenchar\font = `- }
2547 % Set sfcode to normal for the chars that usually have another value.
2548 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2549 % sometimes \x has an active definition that messes things up.
2551 \catcode`@=11
2552 \def\plainfrenchspacing{%
2553 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2554 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2555 \def\endofsentencespacefactor{1000}% for @. and friends
2557 \def\plainnonfrenchspacing{%
2558 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2559 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2560 \def\endofsentencespacefactor{3000}% for @. and friends
2562 \catcode`@=\other
2563 \def\endofsentencespacefactor{3000}% default
2565 % @t, explicit typewriter.
2566 \def\t#1{%
2567 {\tt \rawbackslash \plainfrenchspacing #1}%
2568 \null
2571 % @samp.
2572 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2574 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2575 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2576 %\font\keysy=cmsy9
2577 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2578 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2579 % \vbox{\hrule\kern-0.4pt
2580 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2581 % \kern-0.4pt\hrule}%
2582 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2584 % definition of @key with no lozenge. If the current font is already
2585 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2586 % if it isn't monospace, then use \tt.
2588 \def\key#1{{\setupmarkupstyle{key}
2589 \nohyphenation
2590 \ifmonospace\else\tt\fi
2591 #1}\null}
2593 % ctrl is no longer a Texinfo command.
2594 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2596 % @file, @option are the same as @samp.
2597 \let\file=\samp
2598 \let\option=\samp
2600 % @code is a modification of @t,
2601 % which makes spaces the same size as normal in the surrounding text.
2602 \def\tclose#1{%
2604 % Change normal interword space to be same as for the current font.
2605 \spaceskip = \fontdimen2\font
2607 % Switch to typewriter.
2610 % But `\ ' produces the large typewriter interword space.
2611 \def\ {{\spaceskip = 0pt{} }}%
2613 % Turn off hyphenation.
2614 \nohyphenation
2616 \rawbackslash
2617 \plainfrenchspacing
2620 \null
2623 % We *must* turn on hyphenation at `-' and `_' in @code.
2624 % Otherwise, it is too hard to avoid overfull hboxes
2625 % in the Emacs manual, the Library manual, etc.
2627 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2628 % both hyphenation at - and hyphenation within words.
2629 % We must therefore turn them both off (\tclose does that)
2630 % and arrange explicitly to hyphenate at a dash.
2631 % -- rms.
2633 \catcode`\-=\active \catcode`\_=\active
2634 \catcode`\'=\active \catcode`\`=\active
2635 \global\let'=\rq \global\let`=\lq % default definitions
2637 \global\def\code{\begingroup
2638 \setupmarkupstyle{code}%
2639 % The following should really be moved into \setupmarkupstyle handlers.
2640 \catcode\dashChar=\active \catcode\underChar=\active
2641 \ifallowcodebreaks
2642 \let-\codedash
2643 \let_\codeunder
2644 \else
2645 \let-\realdash
2646 \let_\realunder
2648 \codex
2652 \def\realdash{-}
2653 \def\codedash{-\discretionary{}{}{}}
2654 \def\codeunder{%
2655 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2656 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2657 % will therefore expand the active definition of _, which is us
2658 % (inside @code that is), therefore an endless loop.
2659 \ifusingtt{\ifmmode
2660 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2661 \else\normalunderscore \fi
2662 \discretionary{}{}{}}%
2663 {\_}%
2665 \def\codex #1{\tclose{#1}\endgroup}
2667 % An additional complication: the above will allow breaks after, e.g.,
2668 % each of the four underscores in __typeof__. This is undesirable in
2669 % some manuals, especially if they don't have long identifiers in
2670 % general. @allowcodebreaks provides a way to control this.
2672 \newif\ifallowcodebreaks \allowcodebreakstrue
2674 \def\keywordtrue{true}
2675 \def\keywordfalse{false}
2677 \parseargdef\allowcodebreaks{%
2678 \def\txiarg{#1}%
2679 \ifx\txiarg\keywordtrue
2680 \allowcodebreakstrue
2681 \else\ifx\txiarg\keywordfalse
2682 \allowcodebreaksfalse
2683 \else
2684 \errhelp = \EMsimple
2685 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2686 \fi\fi
2689 % @kbd is like @code, except that if the argument is just one @key command,
2690 % then @kbd has no effect.
2691 \def\kbd#1{{\setupmarkupstyle{kbd}\def\look{#1}\expandafter\kbdfoo\look??\par}}
2693 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2694 % `example' (@kbd uses ttsl only inside of @example and friends),
2695 % or `code' (@kbd uses normal tty font always).
2696 \parseargdef\kbdinputstyle{%
2697 \def\txiarg{#1}%
2698 \ifx\txiarg\worddistinct
2699 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2700 \else\ifx\txiarg\wordexample
2701 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2702 \else\ifx\txiarg\wordcode
2703 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2704 \else
2705 \errhelp = \EMsimple
2706 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2707 \fi\fi\fi
2709 \def\worddistinct{distinct}
2710 \def\wordexample{example}
2711 \def\wordcode{code}
2713 % Default is `distinct'.
2714 \kbdinputstyle distinct
2716 \def\xkey{\key}
2717 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2718 \ifx\one\xkey\ifx\threex\three \key{#2}%
2719 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2720 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi}
2722 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2723 \let\indicateurl=\code
2724 \let\env=\code
2725 \let\command=\code
2727 % @clicksequence{File @click{} Open ...}
2728 \def\clicksequence#1{\begingroup #1\endgroup}
2730 % @clickstyle @arrow (by default)
2731 \parseargdef\clickstyle{\def\click{#1}}
2732 \def\click{\arrow}
2734 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2735 % second argument specifying the text to display and an optional third
2736 % arg as text to display instead of (rather than in addition to) the url
2737 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2738 % a hypertex \special here.
2740 \def\uref#1{\douref #1,,,\finish}
2741 \def\douref#1,#2,#3,#4\finish{\begingroup
2742 \unsepspaces
2743 \pdfurl{#1}%
2744 \setbox0 = \hbox{\ignorespaces #3}%
2745 \ifdim\wd0 > 0pt
2746 \unhbox0 % third arg given, show only that
2747 \else
2748 \setbox0 = \hbox{\ignorespaces #2}%
2749 \ifdim\wd0 > 0pt
2750 \ifpdf
2751 \unhbox0 % PDF: 2nd arg given, show only it
2752 \else
2753 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2755 \else
2756 \code{#1}% only url given, so show it
2759 \endlink
2760 \endgroup}
2762 % @url synonym for @uref, since that's how everyone uses it.
2764 \let\url=\uref
2766 % rms does not like angle brackets --karl, 17may97.
2767 % So now @email is just like @uref, unless we are pdf.
2769 %\def\email#1{\angleleft{\tt #1}\angleright}
2770 \ifpdf
2771 \def\email#1{\doemail#1,,\finish}
2772 \def\doemail#1,#2,#3\finish{\begingroup
2773 \unsepspaces
2774 \pdfurl{mailto:#1}%
2775 \setbox0 = \hbox{\ignorespaces #2}%
2776 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2777 \endlink
2778 \endgroup}
2779 \else
2780 \let\email=\uref
2783 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2784 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2786 \def\dmn#1{\thinspace #1}
2788 % @l was never documented to mean ``switch to the Lisp font'',
2789 % and it is not used as such in any manual I can find. We need it for
2790 % Polish suppressed-l. --karl, 22sep96.
2791 %\def\l#1{{\li #1}\null}
2793 % @acronym for "FBI", "NATO", and the like.
2794 % We print this one point size smaller, since it's intended for
2795 % all-uppercase.
2797 \def\acronym#1{\doacronym #1,,\finish}
2798 \def\doacronym#1,#2,#3\finish{%
2799 {\selectfonts\lsize #1}%
2800 \def\temp{#2}%
2801 \ifx\temp\empty \else
2802 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2806 % @abbr for "Comput. J." and the like.
2807 % No font change, but don't do end-of-sentence spacing.
2809 \def\abbr#1{\doabbr #1,,\finish}
2810 \def\doabbr#1,#2,#3\finish{%
2811 {\plainfrenchspacing #1}%
2812 \def\temp{#2}%
2813 \ifx\temp\empty \else
2814 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2819 \message{glyphs,}
2821 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
2823 % Since these characters are used in examples, they should be an even number of
2824 % \tt widths. Each \tt character is 1en, so two makes it 1em.
2826 \def\point{$\star$}
2827 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
2828 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
2829 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
2830 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
2831 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
2833 % The @error{} command.
2834 % Adapted from the TeXbook's \boxit.
2836 \newbox\errorbox
2838 {\tentt \global\dimen0 = 3em}% Width of the box.
2839 \dimen2 = .55pt % Thickness of rules
2840 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
2841 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
2843 \setbox\errorbox=\hbox to \dimen0{\hfil
2844 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
2845 \advance\hsize by -2\dimen2 % Rules.
2846 \vbox{%
2847 \hrule height\dimen2
2848 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
2849 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
2850 \kern3pt\vrule width\dimen2}% Space to right.
2851 \hrule height\dimen2}
2852 \hfil}
2854 \def\error{\leavevmode\lower.7ex\copy\errorbox}
2856 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2858 \def\pounds{{\it\$}}
2860 % @euro{} comes from a separate font, depending on the current style.
2861 % We use the free feym* fonts from the eurosym package by Henrik
2862 % Theiling, which support regular, slanted, bold and bold slanted (and
2863 % "outlined" (blackboard board, sort of) versions, which we don't need).
2864 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2866 % Although only regular is the truly official Euro symbol, we ignore
2867 % that. The Euro is designed to be slightly taller than the regular
2868 % font height.
2870 % feymr - regular
2871 % feymo - slanted
2872 % feybr - bold
2873 % feybo - bold slanted
2875 % There is no good (free) typewriter version, to my knowledge.
2876 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2877 % Hmm.
2879 % Also doesn't work in math. Do we need to do math with euro symbols?
2880 % Hope not.
2883 \def\euro{{\eurofont e}}
2884 \def\eurofont{%
2885 % We set the font at each command, rather than predefining it in
2886 % \textfonts and the other font-switching commands, so that
2887 % installations which never need the symbol don't have to have the
2888 % font installed.
2890 % There is only one designed size (nominal 10pt), so we always scale
2891 % that to the current nominal size.
2893 % By the way, simply using "at 1em" works for cmr10 and the like, but
2894 % does not work for cmbx10 and other extended/shrunken fonts.
2896 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2898 \ifx\curfontstyle\bfstylename
2899 % bold:
2900 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2901 \else
2902 % regular:
2903 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2905 \thiseurofont
2908 % Hacks for glyphs from the EC fonts similar to \euro. We don't
2909 % use \let for the aliases, because sometimes we redefine the original
2910 % macro, and the alias should reflect the redefinition.
2911 \def\guillemetleft{{\ecfont \char"13}}
2912 \def\guillemotleft{\guillemetleft}
2913 \def\guillemetright{{\ecfont \char"14}}
2914 \def\guillemotright{\guillemetright}
2915 \def\guilsinglleft{{\ecfont \char"0E}}
2916 \def\guilsinglright{{\ecfont \char"0F}}
2917 \def\quotedblbase{{\ecfont \char"12}}
2918 \def\quotesinglbase{{\ecfont \char"0D}}
2920 % This positioning is not perfect (see the ogonek LaTeX package), but
2921 % we have the precomposed glyphs for the most common cases. We put the
2922 % tests to use those glyphs in the single \ogonek macro so we have fewer
2923 % dummy definitions to worry about for index entries, etc.
2925 % ogonek is also used with other letters in Lithuanian (IOU), but using
2926 % the precomposed glyphs for those is not so easy since they aren't in
2927 % the same EC font.
2928 \def\ogonek#1{{%
2929 \def\temp{#1}%
2930 \ifx\temp\macrocharA\Aogonek
2931 \else\ifx\temp\macrochara\aogonek
2932 \else\ifx\temp\macrocharE\Eogonek
2933 \else\ifx\temp\macrochare\eogonek
2934 \else
2935 \ecfont \setbox0=\hbox{#1}%
2936 \ifdim\ht0=1ex\accent"0C #1%
2937 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
2939 \fi\fi\fi\fi
2942 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
2943 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
2944 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
2945 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
2947 \def\ecfont{%
2948 % We can't distinguish serif/sans and italic/slanted, but this
2949 % is used for crude hacks anyway (like adding French and German
2950 % quotes to documents typeset with CM, where we lose kerning), so
2951 % hopefully nobody will notice/care.
2952 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
2953 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
2954 \ifx\curfontstyle\bfstylename
2955 % bold:
2956 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
2957 \else
2958 % regular:
2959 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
2961 \thisecfont
2964 % @registeredsymbol - R in a circle. The font for the R should really
2965 % be smaller yet, but lllsize is the best we can do for now.
2966 % Adapted from the plain.tex definition of \copyright.
2968 \def\registeredsymbol{%
2969 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2970 \hfil\crcr\Orb}}%
2974 % @textdegree - the normal degrees sign.
2976 \def\textdegree{$^\circ$}
2978 % Laurent Siebenmann reports \Orb undefined with:
2979 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2980 % so we'll define it if necessary.
2982 \ifx\Orb\undefined
2983 \def\Orb{\mathhexbox20D}
2986 % Quotes.
2987 \chardef\quotedblleft="5C
2988 \chardef\quotedblright=`\"
2989 \chardef\quoteleft=`\`
2990 \chardef\quoteright=`\'
2993 \message{page headings,}
2995 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2996 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2998 % First the title page. Must do @settitle before @titlepage.
2999 \newif\ifseenauthor
3000 \newif\iffinishedtitlepage
3002 % Do an implicit @contents or @shortcontents after @end titlepage if the
3003 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3005 \newif\ifsetcontentsaftertitlepage
3006 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3007 \newif\ifsetshortcontentsaftertitlepage
3008 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3010 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3011 \endgroup\page\hbox{}\page}
3013 \envdef\titlepage{%
3014 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3015 \begingroup
3016 \parindent=0pt \textfonts
3017 % Leave some space at the very top of the page.
3018 \vglue\titlepagetopglue
3019 % No rule at page bottom unless we print one at the top with @title.
3020 \finishedtitlepagetrue
3022 % Most title ``pages'' are actually two pages long, with space
3023 % at the top of the second. We don't want the ragged left on the second.
3024 \let\oldpage = \page
3025 \def\page{%
3026 \iffinishedtitlepage\else
3027 \finishtitlepage
3029 \let\page = \oldpage
3030 \page
3031 \null
3035 \def\Etitlepage{%
3036 \iffinishedtitlepage\else
3037 \finishtitlepage
3039 % It is important to do the page break before ending the group,
3040 % because the headline and footline are only empty inside the group.
3041 % If we use the new definition of \page, we always get a blank page
3042 % after the title page, which we certainly don't want.
3043 \oldpage
3044 \endgroup
3046 % Need this before the \...aftertitlepage checks so that if they are
3047 % in effect the toc pages will come out with page numbers.
3048 \HEADINGSon
3050 % If they want short, they certainly want long too.
3051 \ifsetshortcontentsaftertitlepage
3052 \shortcontents
3053 \contents
3054 \global\let\shortcontents = \relax
3055 \global\let\contents = \relax
3058 \ifsetcontentsaftertitlepage
3059 \contents
3060 \global\let\contents = \relax
3061 \global\let\shortcontents = \relax
3065 \def\finishtitlepage{%
3066 \vskip4pt \hrule height 2pt width \hsize
3067 \vskip\titlepagebottomglue
3068 \finishedtitlepagetrue
3071 %%% Macros to be used within @titlepage:
3073 \let\subtitlerm=\tenrm
3074 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3076 \parseargdef\title{%
3077 \checkenv\titlepage
3078 \leftline{\titlefonts\rmisbold #1}
3079 % print a rule at the page bottom also.
3080 \finishedtitlepagefalse
3081 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3084 \parseargdef\subtitle{%
3085 \checkenv\titlepage
3086 {\subtitlefont \rightline{#1}}%
3089 % @author should come last, but may come many times.
3090 % It can also be used inside @quotation.
3092 \parseargdef\author{%
3093 \def\temp{\quotation}%
3094 \ifx\thisenv\temp
3095 \def\quotationauthor{#1}% printed in \Equotation.
3096 \else
3097 \checkenv\titlepage
3098 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3099 {\secfonts\rmisbold \leftline{#1}}%
3104 %%% Set up page headings and footings.
3106 \let\thispage=\folio
3108 \newtoks\evenheadline % headline on even pages
3109 \newtoks\oddheadline % headline on odd pages
3110 \newtoks\evenfootline % footline on even pages
3111 \newtoks\oddfootline % footline on odd pages
3113 % Now make TeX use those variables
3114 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3115 \else \the\evenheadline \fi}}
3116 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3117 \else \the\evenfootline \fi}\HEADINGShook}
3118 \let\HEADINGShook=\relax
3120 % Commands to set those variables.
3121 % For example, this is what @headings on does
3122 % @evenheading @thistitle|@thispage|@thischapter
3123 % @oddheading @thischapter|@thispage|@thistitle
3124 % @evenfooting @thisfile||
3125 % @oddfooting ||@thisfile
3128 \def\evenheading{\parsearg\evenheadingxxx}
3129 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3130 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3131 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3133 \def\oddheading{\parsearg\oddheadingxxx}
3134 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3135 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3136 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3138 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3140 \def\evenfooting{\parsearg\evenfootingxxx}
3141 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3142 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3143 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3145 \def\oddfooting{\parsearg\oddfootingxxx}
3146 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3147 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3148 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3150 % Leave some space for the footline. Hopefully ok to assume
3151 % @evenfooting will not be used by itself.
3152 \global\advance\pageheight by -12pt
3153 \global\advance\vsize by -12pt
3156 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3158 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3159 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3161 % The same set of arguments for:
3163 % @oddheadingmarks
3164 % @evenfootingmarks
3165 % @oddfootingmarks
3166 % @everyheadingmarks
3167 % @everyfootingmarks
3169 \def\evenheadingmarks{\headingmarks{even}{heading}}
3170 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3171 \def\evenfootingmarks{\headingmarks{even}{footing}}
3172 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3173 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3174 \headingmarks{odd}{heading}{#1} }
3175 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3176 \headingmarks{odd}{footing}{#1} }
3177 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3178 \def\headingmarks#1#2#3 {%
3179 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3180 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3183 \everyheadingmarks bottom
3184 \everyfootingmarks bottom
3186 % @headings double turns headings on for double-sided printing.
3187 % @headings single turns headings on for single-sided printing.
3188 % @headings off turns them off.
3189 % @headings on same as @headings double, retained for compatibility.
3190 % @headings after turns on double-sided headings after this page.
3191 % @headings doubleafter turns on double-sided headings after this page.
3192 % @headings singleafter turns on single-sided headings after this page.
3193 % By default, they are off at the start of a document,
3194 % and turned `on' after @end titlepage.
3196 \def\headings #1 {\csname HEADINGS#1\endcsname}
3198 \def\HEADINGSoff{%
3199 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
3200 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
3201 \HEADINGSoff
3202 % When we turn headings on, set the page number to 1.
3203 % For double-sided printing, put current file name in lower left corner,
3204 % chapter name on inside top of right hand pages, document
3205 % title on inside top of left hand pages, and page numbers on outside top
3206 % edge of all pages.
3207 \def\HEADINGSdouble{%
3208 \global\pageno=1
3209 \global\evenfootline={\hfil}
3210 \global\oddfootline={\hfil}
3211 \global\evenheadline={\line{\folio\hfil\thistitle}}
3212 \global\oddheadline={\line{\thischapter\hfil\folio}}
3213 \global\let\contentsalignmacro = \chapoddpage
3215 \let\contentsalignmacro = \chappager
3217 % For single-sided printing, chapter title goes across top left of page,
3218 % page number on top right.
3219 \def\HEADINGSsingle{%
3220 \global\pageno=1
3221 \global\evenfootline={\hfil}
3222 \global\oddfootline={\hfil}
3223 \global\evenheadline={\line{\thischapter\hfil\folio}}
3224 \global\oddheadline={\line{\thischapter\hfil\folio}}
3225 \global\let\contentsalignmacro = \chappager
3227 \def\HEADINGSon{\HEADINGSdouble}
3229 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3230 \let\HEADINGSdoubleafter=\HEADINGSafter
3231 \def\HEADINGSdoublex{%
3232 \global\evenfootline={\hfil}
3233 \global\oddfootline={\hfil}
3234 \global\evenheadline={\line{\folio\hfil\thistitle}}
3235 \global\oddheadline={\line{\thischapter\hfil\folio}}
3236 \global\let\contentsalignmacro = \chapoddpage
3239 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3240 \def\HEADINGSsinglex{%
3241 \global\evenfootline={\hfil}
3242 \global\oddfootline={\hfil}
3243 \global\evenheadline={\line{\thischapter\hfil\folio}}
3244 \global\oddheadline={\line{\thischapter\hfil\folio}}
3245 \global\let\contentsalignmacro = \chappager
3248 % Subroutines used in generating headings
3249 % This produces Day Month Year style of output.
3250 % Only define if not already defined, in case a txi-??.tex file has set
3251 % up a different format (e.g., txi-cs.tex does this).
3252 \ifx\today\undefined
3253 \def\today{%
3254 \number\day\space
3255 \ifcase\month
3256 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3257 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3258 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3260 \space\number\year}
3263 % @settitle line... specifies the title of the document, for headings.
3264 % It generates no output of its own.
3265 \def\thistitle{\putwordNoTitle}
3266 \def\settitle{\parsearg{\gdef\thistitle}}
3269 \message{tables,}
3270 % Tables -- @table, @ftable, @vtable, @item(x).
3272 % default indentation of table text
3273 \newdimen\tableindent \tableindent=.8in
3274 % default indentation of @itemize and @enumerate text
3275 \newdimen\itemindent \itemindent=.3in
3276 % margin between end of table item and start of table text.
3277 \newdimen\itemmargin \itemmargin=.1in
3279 % used internally for \itemindent minus \itemmargin
3280 \newdimen\itemmax
3282 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3283 % these defs.
3284 % They also define \itemindex
3285 % to index the item name in whatever manner is desired (perhaps none).
3287 \newif\ifitemxneedsnegativevskip
3289 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3291 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3292 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3294 \def\itemzzz #1{\begingroup %
3295 \advance\hsize by -\rightskip
3296 \advance\hsize by -\tableindent
3297 \setbox0=\hbox{\itemindicate{#1}}%
3298 \itemindex{#1}%
3299 \nobreak % This prevents a break before @itemx.
3301 % If the item text does not fit in the space we have, put it on a line
3302 % by itself, and do not allow a page break either before or after that
3303 % line. We do not start a paragraph here because then if the next
3304 % command is, e.g., @kindex, the whatsit would get put into the
3305 % horizontal list on a line by itself, resulting in extra blank space.
3306 \ifdim \wd0>\itemmax
3308 % Make this a paragraph so we get the \parskip glue and wrapping,
3309 % but leave it ragged-right.
3310 \begingroup
3311 \advance\leftskip by-\tableindent
3312 \advance\hsize by\tableindent
3313 \advance\rightskip by0pt plus1fil
3314 \leavevmode\unhbox0\par
3315 \endgroup
3317 % We're going to be starting a paragraph, but we don't want the
3318 % \parskip glue -- logically it's part of the @item we just started.
3319 \nobreak \vskip-\parskip
3321 % Stop a page break at the \parskip glue coming up. However, if
3322 % what follows is an environment such as @example, there will be no
3323 % \parskip glue; then the negative vskip we just inserted would
3324 % cause the example and the item to crash together. So we use this
3325 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3326 % \parskip glue after all. Section titles are handled this way also.
3328 \penalty 10001
3329 \endgroup
3330 \itemxneedsnegativevskipfalse
3331 \else
3332 % The item text fits into the space. Start a paragraph, so that the
3333 % following text (if any) will end up on the same line.
3334 \noindent
3335 % Do this with kerns and \unhbox so that if there is a footnote in
3336 % the item text, it can migrate to the main vertical list and
3337 % eventually be printed.
3338 \nobreak\kern-\tableindent
3339 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3340 \unhbox0
3341 \nobreak\kern\dimen0
3342 \endgroup
3343 \itemxneedsnegativevskiptrue
3347 \def\item{\errmessage{@item while not in a list environment}}
3348 \def\itemx{\errmessage{@itemx while not in a list environment}}
3350 % @table, @ftable, @vtable.
3351 \envdef\table{%
3352 \let\itemindex\gobble
3353 \tablecheck{table}%
3355 \envdef\ftable{%
3356 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3357 \tablecheck{ftable}%
3359 \envdef\vtable{%
3360 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3361 \tablecheck{vtable}%
3363 \def\tablecheck#1{%
3364 \ifnum \the\catcode`\^^M=\active
3365 \endgroup
3366 \errmessage{This command won't work in this context; perhaps the problem is
3367 that we are \inenvironment\thisenv}%
3368 \def\next{\doignore{#1}}%
3369 \else
3370 \let\next\tablex
3372 \next
3374 \def\tablex#1{%
3375 \def\itemindicate{#1}%
3376 \parsearg\tabley
3378 \def\tabley#1{%
3380 \makevalueexpandable
3381 \edef\temp{\noexpand\tablez #1\space\space\space}%
3382 \expandafter
3383 }\temp \endtablez
3385 \def\tablez #1 #2 #3 #4\endtablez{%
3386 \aboveenvbreak
3387 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3388 \ifnum 0#2>0 \tableindent=#2\mil \fi
3389 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3390 \itemmax=\tableindent
3391 \advance \itemmax by -\itemmargin
3392 \advance \leftskip by \tableindent
3393 \exdentamount=\tableindent
3394 \parindent = 0pt
3395 \parskip = \smallskipamount
3396 \ifdim \parskip=0pt \parskip=2pt \fi
3397 \let\item = \internalBitem
3398 \let\itemx = \internalBitemx
3400 \def\Etable{\endgraf\afterenvbreak}
3401 \let\Eftable\Etable
3402 \let\Evtable\Etable
3403 \let\Eitemize\Etable
3404 \let\Eenumerate\Etable
3406 % This is the counter used by @enumerate, which is really @itemize
3408 \newcount \itemno
3410 \envdef\itemize{\parsearg\doitemize}
3412 \def\doitemize#1{%
3413 \aboveenvbreak
3414 \itemmax=\itemindent
3415 \advance\itemmax by -\itemmargin
3416 \advance\leftskip by \itemindent
3417 \exdentamount=\itemindent
3418 \parindent=0pt
3419 \parskip=\smallskipamount
3420 \ifdim\parskip=0pt \parskip=2pt \fi
3421 \def\itemcontents{#1}%
3422 % @itemize with no arg is equivalent to @itemize @bullet.
3423 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3424 \let\item=\itemizeitem
3427 % Definition of @item while inside @itemize and @enumerate.
3429 \def\itemizeitem{%
3430 \advance\itemno by 1 % for enumerations
3431 {\let\par=\endgraf \smallbreak}% reasonable place to break
3433 % If the document has an @itemize directly after a section title, a
3434 % \nobreak will be last on the list, and \sectionheading will have
3435 % done a \vskip-\parskip. In that case, we don't want to zero
3436 % parskip, or the item text will crash with the heading. On the
3437 % other hand, when there is normal text preceding the item (as there
3438 % usually is), we do want to zero parskip, or there would be too much
3439 % space. In that case, we won't have a \nobreak before. At least
3440 % that's the theory.
3441 \ifnum\lastpenalty<10000 \parskip=0in \fi
3442 \noindent
3443 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3444 \vadjust{\penalty 1200}}% not good to break after first line of item.
3445 \flushcr
3448 % \splitoff TOKENS\endmark defines \first to be the first token in
3449 % TOKENS, and \rest to be the remainder.
3451 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3453 % Allow an optional argument of an uppercase letter, lowercase letter,
3454 % or number, to specify the first label in the enumerated list. No
3455 % argument is the same as `1'.
3457 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3458 \def\enumeratey #1 #2\endenumeratey{%
3459 % If we were given no argument, pretend we were given `1'.
3460 \def\thearg{#1}%
3461 \ifx\thearg\empty \def\thearg{1}\fi
3463 % Detect if the argument is a single token. If so, it might be a
3464 % letter. Otherwise, the only valid thing it can be is a number.
3465 % (We will always have one token, because of the test we just made.
3466 % This is a good thing, since \splitoff doesn't work given nothing at
3467 % all -- the first parameter is undelimited.)
3468 \expandafter\splitoff\thearg\endmark
3469 \ifx\rest\empty
3470 % Only one token in the argument. It could still be anything.
3471 % A ``lowercase letter'' is one whose \lccode is nonzero.
3472 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3473 % not equal to itself.
3474 % Otherwise, we assume it's a number.
3476 % We need the \relax at the end of the \ifnum lines to stop TeX from
3477 % continuing to look for a <number>.
3479 \ifnum\lccode\expandafter`\thearg=0\relax
3480 \numericenumerate % a number (we hope)
3481 \else
3482 % It's a letter.
3483 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3484 \lowercaseenumerate % lowercase letter
3485 \else
3486 \uppercaseenumerate % uppercase letter
3489 \else
3490 % Multiple tokens in the argument. We hope it's a number.
3491 \numericenumerate
3495 % An @enumerate whose labels are integers. The starting integer is
3496 % given in \thearg.
3498 \def\numericenumerate{%
3499 \itemno = \thearg
3500 \startenumeration{\the\itemno}%
3503 % The starting (lowercase) letter is in \thearg.
3504 \def\lowercaseenumerate{%
3505 \itemno = \expandafter`\thearg
3506 \startenumeration{%
3507 % Be sure we're not beyond the end of the alphabet.
3508 \ifnum\itemno=0
3509 \errmessage{No more lowercase letters in @enumerate; get a bigger
3510 alphabet}%
3512 \char\lccode\itemno
3516 % The starting (uppercase) letter is in \thearg.
3517 \def\uppercaseenumerate{%
3518 \itemno = \expandafter`\thearg
3519 \startenumeration{%
3520 % Be sure we're not beyond the end of the alphabet.
3521 \ifnum\itemno=0
3522 \errmessage{No more uppercase letters in @enumerate; get a bigger
3523 alphabet}
3525 \char\uccode\itemno
3529 % Call \doitemize, adding a period to the first argument and supplying the
3530 % common last two arguments. Also subtract one from the initial value in
3531 % \itemno, since @item increments \itemno.
3533 \def\startenumeration#1{%
3534 \advance\itemno by -1
3535 \doitemize{#1.}\flushcr
3538 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3539 % to @enumerate.
3541 \def\alphaenumerate{\enumerate{a}}
3542 \def\capsenumerate{\enumerate{A}}
3543 \def\Ealphaenumerate{\Eenumerate}
3544 \def\Ecapsenumerate{\Eenumerate}
3547 % @multitable macros
3548 % Amy Hendrickson, 8/18/94, 3/6/96
3550 % @multitable ... @end multitable will make as many columns as desired.
3551 % Contents of each column will wrap at width given in preamble. Width
3552 % can be specified either with sample text given in a template line,
3553 % or in percent of \hsize, the current width of text on page.
3555 % Table can continue over pages but will only break between lines.
3557 % To make preamble:
3559 % Either define widths of columns in terms of percent of \hsize:
3560 % @multitable @columnfractions .25 .3 .45
3561 % @item ...
3563 % Numbers following @columnfractions are the percent of the total
3564 % current hsize to be used for each column. You may use as many
3565 % columns as desired.
3568 % Or use a template:
3569 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3570 % @item ...
3571 % using the widest term desired in each column.
3573 % Each new table line starts with @item, each subsequent new column
3574 % starts with @tab. Empty columns may be produced by supplying @tab's
3575 % with nothing between them for as many times as empty columns are needed,
3576 % ie, @tab@tab@tab will produce two empty columns.
3578 % @item, @tab do not need to be on their own lines, but it will not hurt
3579 % if they are.
3581 % Sample multitable:
3583 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3584 % @item first col stuff @tab second col stuff @tab third col
3585 % @item
3586 % first col stuff
3587 % @tab
3588 % second col stuff
3589 % @tab
3590 % third col
3591 % @item first col stuff @tab second col stuff
3592 % @tab Many paragraphs of text may be used in any column.
3594 % They will wrap at the width determined by the template.
3595 % @item@tab@tab This will be in third column.
3596 % @end multitable
3598 % Default dimensions may be reset by user.
3599 % @multitableparskip is vertical space between paragraphs in table.
3600 % @multitableparindent is paragraph indent in table.
3601 % @multitablecolmargin is horizontal space to be left between columns.
3602 % @multitablelinespace is space to leave between table items, baseline
3603 % to baseline.
3604 % 0pt means it depends on current normal line spacing.
3606 \newskip\multitableparskip
3607 \newskip\multitableparindent
3608 \newdimen\multitablecolspace
3609 \newskip\multitablelinespace
3610 \multitableparskip=0pt
3611 \multitableparindent=6pt
3612 \multitablecolspace=12pt
3613 \multitablelinespace=0pt
3615 % Macros used to set up halign preamble:
3617 \let\endsetuptable\relax
3618 \def\xendsetuptable{\endsetuptable}
3619 \let\columnfractions\relax
3620 \def\xcolumnfractions{\columnfractions}
3621 \newif\ifsetpercent
3623 % #1 is the @columnfraction, usually a decimal number like .5, but might
3624 % be just 1. We just use it, whatever it is.
3626 \def\pickupwholefraction#1 {%
3627 \global\advance\colcount by 1
3628 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3629 \setuptable
3632 \newcount\colcount
3633 \def\setuptable#1{%
3634 \def\firstarg{#1}%
3635 \ifx\firstarg\xendsetuptable
3636 \let\go = \relax
3637 \else
3638 \ifx\firstarg\xcolumnfractions
3639 \global\setpercenttrue
3640 \else
3641 \ifsetpercent
3642 \let\go\pickupwholefraction
3643 \else
3644 \global\advance\colcount by 1
3645 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3646 % separator; typically that is always in the input, anyway.
3647 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3650 \ifx\go\pickupwholefraction
3651 % Put the argument back for the \pickupwholefraction call, so
3652 % we'll always have a period there to be parsed.
3653 \def\go{\pickupwholefraction#1}%
3654 \else
3655 \let\go = \setuptable
3656 \fi%
3661 % multitable-only commands.
3663 % @headitem starts a heading row, which we typeset in bold.
3664 % Assignments have to be global since we are inside the implicit group
3665 % of an alignment entry. Note that \everycr resets \everytab.
3666 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
3668 % A \tab used to include \hskip1sp. But then the space in a template
3669 % line is not enough. That is bad. So let's go back to just `&' until
3670 % we encounter the problem it was intended to solve again.
3671 % --karl, nathan@acm.org, 20apr99.
3672 \def\tab{\checkenv\multitable &\the\everytab}%
3674 % @multitable ... @end multitable definitions:
3676 \newtoks\everytab % insert after every tab.
3678 \envdef\multitable{%
3679 \vskip\parskip
3680 \startsavinginserts
3682 % @item within a multitable starts a normal row.
3683 % We use \def instead of \let so that if one of the multitable entries
3684 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3685 % \endtemplate) expanding \doitemize.
3686 \def\item{\crcr}%
3688 \tolerance=9500
3689 \hbadness=9500
3690 \setmultitablespacing
3691 \parskip=\multitableparskip
3692 \parindent=\multitableparindent
3693 \overfullrule=0pt
3694 \global\colcount=0
3696 \everycr = {%
3697 \noalign{%
3698 \global\everytab={}%
3699 \global\colcount=0 % Reset the column counter.
3700 % Check for saved footnotes, etc.
3701 \checkinserts
3702 % Keeps underfull box messages off when table breaks over pages.
3703 %\filbreak
3704 % Maybe so, but it also creates really weird page breaks when the
3705 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3706 % problem manifests itself, so it can be fixed for real --karl.
3710 \parsearg\domultitable
3712 \def\domultitable#1{%
3713 % To parse everything between @multitable and @item:
3714 \setuptable#1 \endsetuptable
3716 % This preamble sets up a generic column definition, which will
3717 % be used as many times as user calls for columns.
3718 % \vtop will set a single line and will also let text wrap and
3719 % continue for many paragraphs if desired.
3720 \halign\bgroup &%
3721 \global\advance\colcount by 1
3722 \multistrut
3723 \vtop{%
3724 % Use the current \colcount to find the correct column width:
3725 \hsize=\expandafter\csname col\the\colcount\endcsname
3727 % In order to keep entries from bumping into each other
3728 % we will add a \leftskip of \multitablecolspace to all columns after
3729 % the first one.
3731 % If a template has been used, we will add \multitablecolspace
3732 % to the width of each template entry.
3734 % If the user has set preamble in terms of percent of \hsize we will
3735 % use that dimension as the width of the column, and the \leftskip
3736 % will keep entries from bumping into each other. Table will start at
3737 % left margin and final column will justify at right margin.
3739 % Make sure we don't inherit \rightskip from the outer environment.
3740 \rightskip=0pt
3741 \ifnum\colcount=1
3742 % The first column will be indented with the surrounding text.
3743 \advance\hsize by\leftskip
3744 \else
3745 \ifsetpercent \else
3746 % If user has not set preamble in terms of percent of \hsize
3747 % we will advance \hsize by \multitablecolspace.
3748 \advance\hsize by \multitablecolspace
3750 % In either case we will make \leftskip=\multitablecolspace:
3751 \leftskip=\multitablecolspace
3753 % Ignoring space at the beginning and end avoids an occasional spurious
3754 % blank line, when TeX decides to break the line at the space before the
3755 % box from the multistrut, so the strut ends up on a line by itself.
3756 % For example:
3757 % @multitable @columnfractions .11 .89
3758 % @item @code{#}
3759 % @tab Legal holiday which is valid in major parts of the whole country.
3760 % Is automatically provided with highlighting sequences respectively
3761 % marking characters.
3762 \noindent\ignorespaces##\unskip\multistrut
3763 }\cr
3765 \def\Emultitable{%
3766 \crcr
3767 \egroup % end the \halign
3768 \global\setpercentfalse
3771 \def\setmultitablespacing{%
3772 \def\multistrut{\strut}% just use the standard line spacing
3774 % Compute \multitablelinespace (if not defined by user) for use in
3775 % \multitableparskip calculation. We used define \multistrut based on
3776 % this, but (ironically) that caused the spacing to be off.
3777 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3778 \ifdim\multitablelinespace=0pt
3779 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3780 \global\advance\multitablelinespace by-\ht0
3782 %% Test to see if parskip is larger than space between lines of
3783 %% table. If not, do nothing.
3784 %% If so, set to same dimension as multitablelinespace.
3785 \ifdim\multitableparskip>\multitablelinespace
3786 \global\multitableparskip=\multitablelinespace
3787 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3788 %% than skip between lines in the table.
3789 \fi%
3790 \ifdim\multitableparskip=0pt
3791 \global\multitableparskip=\multitablelinespace
3792 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3793 %% than skip between lines in the table.
3794 \fi}
3797 \message{conditionals,}
3799 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3800 % @ifnotxml always succeed. They currently do nothing; we don't
3801 % attempt to check whether the conditionals are properly nested. But we
3802 % have to remember that they are conditionals, so that @end doesn't
3803 % attempt to close an environment group.
3805 \def\makecond#1{%
3806 \expandafter\let\csname #1\endcsname = \relax
3807 \expandafter\let\csname iscond.#1\endcsname = 1
3809 \makecond{iftex}
3810 \makecond{ifnotdocbook}
3811 \makecond{ifnothtml}
3812 \makecond{ifnotinfo}
3813 \makecond{ifnotplaintext}
3814 \makecond{ifnotxml}
3816 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3818 \def\direntry{\doignore{direntry}}
3819 \def\documentdescription{\doignore{documentdescription}}
3820 \def\docbook{\doignore{docbook}}
3821 \def\html{\doignore{html}}
3822 \def\ifdocbook{\doignore{ifdocbook}}
3823 \def\ifhtml{\doignore{ifhtml}}
3824 \def\ifinfo{\doignore{ifinfo}}
3825 \def\ifnottex{\doignore{ifnottex}}
3826 \def\ifplaintext{\doignore{ifplaintext}}
3827 \def\ifxml{\doignore{ifxml}}
3828 \def\ignore{\doignore{ignore}}
3829 \def\menu{\doignore{menu}}
3830 \def\xml{\doignore{xml}}
3832 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3834 % A count to remember the depth of nesting.
3835 \newcount\doignorecount
3837 \def\doignore#1{\begingroup
3838 % Scan in ``verbatim'' mode:
3839 \obeylines
3840 \catcode`\@ = \other
3841 \catcode`\{ = \other
3842 \catcode`\} = \other
3844 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3845 \spaceisspace
3847 % Count number of #1's that we've seen.
3848 \doignorecount = 0
3850 % Swallow text until we reach the matching `@end #1'.
3851 \dodoignore{#1}%
3854 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3855 \obeylines %
3857 \gdef\dodoignore#1{%
3858 % #1 contains the command name as a string, e.g., `ifinfo'.
3860 % Define a command to find the next `@end #1'.
3861 \long\def\doignoretext##1^^M@end #1{%
3862 \doignoretextyyy##1^^M@#1\_STOP_}%
3864 % And this command to find another #1 command, at the beginning of a
3865 % line. (Otherwise, we would consider a line `@c @ifset', for
3866 % example, to count as an @ifset for nesting.)
3867 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3869 % And now expand that command.
3870 \doignoretext ^^M%
3874 \def\doignoreyyy#1{%
3875 \def\temp{#1}%
3876 \ifx\temp\empty % Nothing found.
3877 \let\next\doignoretextzzz
3878 \else % Found a nested condition, ...
3879 \advance\doignorecount by 1
3880 \let\next\doignoretextyyy % ..., look for another.
3881 % If we're here, #1 ends with ^^M\ifinfo (for example).
3883 \next #1% the token \_STOP_ is present just after this macro.
3886 % We have to swallow the remaining "\_STOP_".
3888 \def\doignoretextzzz#1{%
3889 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3890 \let\next\enddoignore
3891 \else % Still inside a nested condition.
3892 \advance\doignorecount by -1
3893 \let\next\doignoretext % Look for the next @end.
3895 \next
3898 % Finish off ignored text.
3899 { \obeylines%
3900 % Ignore anything after the last `@end #1'; this matters in verbatim
3901 % environments, where otherwise the newline after an ignored conditional
3902 % would result in a blank line in the output.
3903 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3907 % @set VAR sets the variable VAR to an empty value.
3908 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3910 % Since we want to separate VAR from REST-OF-LINE (which might be
3911 % empty), we can't just use \parsearg; we have to insert a space of our
3912 % own to delimit the rest of the line, and then take it out again if we
3913 % didn't need it.
3914 % We rely on the fact that \parsearg sets \catcode`\ =10.
3916 \parseargdef\set{\setyyy#1 \endsetyyy}
3917 \def\setyyy#1 #2\endsetyyy{%
3919 \makevalueexpandable
3920 \def\temp{#2}%
3921 \edef\next{\gdef\makecsname{SET#1}}%
3922 \ifx\temp\empty
3923 \next{}%
3924 \else
3925 \setzzz#2\endsetzzz
3929 % Remove the trailing space \setxxx inserted.
3930 \def\setzzz#1 \endsetzzz{\next{#1}}
3932 % @clear VAR clears (i.e., unsets) the variable VAR.
3934 \parseargdef\clear{%
3936 \makevalueexpandable
3937 \global\expandafter\let\csname SET#1\endcsname=\relax
3941 % @value{foo} gets the text saved in variable foo.
3942 \def\value{\begingroup\makevalueexpandable\valuexxx}
3943 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3945 \catcode`\- = \active \catcode`\_ = \active
3947 \gdef\makevalueexpandable{%
3948 \let\value = \expandablevalue
3949 % We don't want these characters active, ...
3950 \catcode`\-=\other \catcode`\_=\other
3951 % ..., but we might end up with active ones in the argument if
3952 % we're called from @code, as @code{@value{foo-bar_}}, though.
3953 % So \let them to their normal equivalents.
3954 \let-\realdash \let_\normalunderscore
3958 % We have this subroutine so that we can handle at least some @value's
3959 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3960 % The command has to be fully expandable (if the variable is set), since
3961 % the result winds up in the index file. This means that if the
3962 % variable's value contains other Texinfo commands, it's almost certain
3963 % it will fail (although perhaps we could fix that with sufficient work
3964 % to do a one-level expansion on the result, instead of complete).
3966 \def\expandablevalue#1{%
3967 \expandafter\ifx\csname SET#1\endcsname\relax
3968 {[No value for ``#1'']}%
3969 \message{Variable `#1', used in @value, is not set.}%
3970 \else
3971 \csname SET#1\endcsname
3975 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3976 % with @set.
3978 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3980 \makecond{ifset}
3981 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3982 \def\doifset#1#2{%
3984 \makevalueexpandable
3985 \let\next=\empty
3986 \expandafter\ifx\csname SET#2\endcsname\relax
3987 #1% If not set, redefine \next.
3989 \expandafter
3990 }\next
3992 \def\ifsetfail{\doignore{ifset}}
3994 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3995 % defined with @set, or has been undefined with @clear.
3997 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3998 % above code: if the variable is not set, do nothing, if it is set,
3999 % then redefine \next to \ifclearfail.
4001 \makecond{ifclear}
4002 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4003 \def\ifclearfail{\doignore{ifclear}}
4005 % @dircategory CATEGORY -- specify a category of the dir file
4006 % which this file should belong to. Ignore this in TeX.
4007 \let\dircategory=\comment
4009 % @defininfoenclose.
4010 \let\definfoenclose=\comment
4013 \message{indexing,}
4014 % Index generation facilities
4016 % Define \newwrite to be identical to plain tex's \newwrite
4017 % except not \outer, so it can be used within macros and \if's.
4018 \edef\newwrite{\makecsname{ptexnewwrite}}
4020 % \newindex {foo} defines an index named foo.
4021 % It automatically defines \fooindex such that
4022 % \fooindex ...rest of line... puts an entry in the index foo.
4023 % It also defines \fooindfile to be the number of the output channel for
4024 % the file that accumulates this index. The file's extension is foo.
4025 % The name of an index should be no more than 2 characters long
4026 % for the sake of vms.
4028 \def\newindex#1{%
4029 \iflinks
4030 \expandafter\newwrite \csname#1indfile\endcsname
4031 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4033 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4034 \noexpand\doindex{#1}}
4037 % @defindex foo == \newindex{foo}
4039 \def\defindex{\parsearg\newindex}
4041 % Define @defcodeindex, like @defindex except put all entries in @code.
4043 \def\defcodeindex{\parsearg\newcodeindex}
4045 \def\newcodeindex#1{%
4046 \iflinks
4047 \expandafter\newwrite \csname#1indfile\endcsname
4048 \openout \csname#1indfile\endcsname \jobname.#1
4050 \expandafter\xdef\csname#1index\endcsname{%
4051 \noexpand\docodeindex{#1}}%
4055 % @synindex foo bar makes index foo feed into index bar.
4056 % Do this instead of @defindex foo if you don't want it as a separate index.
4058 % @syncodeindex foo bar similar, but put all entries made for index foo
4059 % inside @code.
4061 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4062 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4064 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4065 % #3 the target index (bar).
4066 \def\dosynindex#1#2#3{%
4067 % Only do \closeout if we haven't already done it, else we'll end up
4068 % closing the target index.
4069 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4070 % The \closeout helps reduce unnecessary open files; the limit on the
4071 % Acorn RISC OS is a mere 16 files.
4072 \expandafter\closeout\csname#2indfile\endcsname
4073 \expandafter\let\csname donesynindex#2\endcsname = 1
4075 % redefine \fooindfile:
4076 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4077 \expandafter\let\csname#2indfile\endcsname=\temp
4078 % redefine \fooindex:
4079 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4082 % Define \doindex, the driver for all \fooindex macros.
4083 % Argument #1 is generated by the calling \fooindex macro,
4084 % and it is "foo", the name of the index.
4086 % \doindex just uses \parsearg; it calls \doind for the actual work.
4087 % This is because \doind is more useful to call from other macros.
4089 % There is also \dosubind {index}{topic}{subtopic}
4090 % which makes an entry in a two-level index such as the operation index.
4092 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4093 \def\singleindexer #1{\doind{\indexname}{#1}}
4095 % like the previous two, but they put @code around the argument.
4096 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4097 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4099 % Take care of Texinfo commands that can appear in an index entry.
4100 % Since there are some commands we want to expand, and others we don't,
4101 % we have to laboriously prevent expansion for those that we don't.
4103 \def\indexdummies{%
4104 \escapechar = `\\ % use backslash in output files.
4105 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4106 \def\ {\realbackslash\space }%
4108 % Need these in case \tex is in effect and \{ is a \delimiter again.
4109 % But can't use \lbracecmd and \rbracecmd because texindex assumes
4110 % braces and backslashes are used only as delimiters.
4111 \let\{ = \mylbrace
4112 \let\} = \myrbrace
4114 % I don't entirely understand this, but when an index entry is
4115 % generated from a macro call, the \endinput which \scanmacro inserts
4116 % causes processing to be prematurely terminated. This is,
4117 % apparently, because \indexsorttmp is fully expanded, and \endinput
4118 % is an expandable command. The redefinition below makes \endinput
4119 % disappear altogether for that purpose -- although logging shows that
4120 % processing continues to some further point. On the other hand, it
4121 % seems \endinput does not hurt in the printed index arg, since that
4122 % is still getting written without apparent harm.
4124 % Sample source (mac-idx3.tex, reported by Graham Percival to
4125 % help-texinfo, 22may06):
4126 % @macro funindex {WORD}
4127 % @findex xyz
4128 % @end macro
4129 % ...
4130 % @funindex commtest
4132 % The above is not enough to reproduce the bug, but it gives the flavor.
4134 % Sample whatsit resulting:
4135 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4137 % So:
4138 \let\endinput = \empty
4140 % Do the redefinitions.
4141 \commondummies
4144 % For the aux and toc files, @ is the escape character. So we want to
4145 % redefine everything using @ as the escape character (instead of
4146 % \realbackslash, still used for index files). When everything uses @,
4147 % this will be simpler.
4149 \def\atdummies{%
4150 \def\@{@@}%
4151 \def\ {@ }%
4152 \let\{ = \lbraceatcmd
4153 \let\} = \rbraceatcmd
4155 % Do the redefinitions.
4156 \commondummies
4157 \otherbackslash
4160 % Called from \indexdummies and \atdummies.
4162 \def\commondummies{%
4164 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4165 % preventing its expansion. This is used only for control% words,
4166 % not control letters, because the \space would be incorrect for
4167 % control characters, but is needed to separate the control word
4168 % from whatever follows.
4170 % For control letters, we have \definedummyletter, which omits the
4171 % space.
4173 % These can be used both for control words that take an argument and
4174 % those that do not. If it is followed by {arg} in the input, then
4175 % that will dutifully get written to the index (or wherever).
4177 \def\definedummyword ##1{\def##1{\string##1\space}}%
4178 \def\definedummyletter##1{\def##1{\string##1}}%
4179 \let\definedummyaccent\definedummyletter
4181 \commondummiesnofonts
4183 \definedummyletter\_%
4185 % Non-English letters.
4186 \definedummyword\AA
4187 \definedummyword\AE
4188 \definedummyword\L
4189 \definedummyword\OE
4190 \definedummyword\O
4191 \definedummyword\aa
4192 \definedummyword\ae
4193 \definedummyword\l
4194 \definedummyword\oe
4195 \definedummyword\o
4196 \definedummyword\ss
4197 \definedummyword\exclamdown
4198 \definedummyword\questiondown
4199 \definedummyword\ordf
4200 \definedummyword\ordm
4202 % Although these internal commands shouldn't show up, sometimes they do.
4203 \definedummyword\bf
4204 \definedummyword\gtr
4205 \definedummyword\hat
4206 \definedummyword\less
4207 \definedummyword\sf
4208 \definedummyword\sl
4209 \definedummyword\tclose
4210 \definedummyword\tt
4212 \definedummyword\LaTeX
4213 \definedummyword\TeX
4215 % Assorted special characters.
4216 \definedummyword\bullet
4217 \definedummyword\comma
4218 \definedummyword\copyright
4219 \definedummyword\registeredsymbol
4220 \definedummyword\dots
4221 \definedummyword\enddots
4222 \definedummyword\equiv
4223 \definedummyword\error
4224 \definedummyword\euro
4225 \definedummyword\guillemetleft
4226 \definedummyword\guillemetright
4227 \definedummyword\guilsinglleft
4228 \definedummyword\guilsinglright
4229 \definedummyword\expansion
4230 \definedummyword\minus
4231 \definedummyword\ogonek
4232 \definedummyword\pounds
4233 \definedummyword\point
4234 \definedummyword\print
4235 \definedummyword\quotedblbase
4236 \definedummyword\quotedblleft
4237 \definedummyword\quotedblright
4238 \definedummyword\quoteleft
4239 \definedummyword\quoteright
4240 \definedummyword\quotesinglbase
4241 \definedummyword\result
4242 \definedummyword\textdegree
4244 % We want to disable all macros so that they are not expanded by \write.
4245 \macrolist
4247 \normalturnoffactive
4249 % Handle some cases of @value -- where it does not contain any
4250 % (non-fully-expandable) commands.
4251 \makevalueexpandable
4254 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4256 \def\commondummiesnofonts{%
4257 % Control letters and accents.
4258 \definedummyletter\!%
4259 \definedummyaccent\"%
4260 \definedummyaccent\'%
4261 \definedummyletter\*%
4262 \definedummyaccent\,%
4263 \definedummyletter\.%
4264 \definedummyletter\/%
4265 \definedummyletter\:%
4266 \definedummyaccent\=%
4267 \definedummyletter\?%
4268 \definedummyaccent\^%
4269 \definedummyaccent\`%
4270 \definedummyaccent\~%
4271 \definedummyword\u
4272 \definedummyword\v
4273 \definedummyword\H
4274 \definedummyword\dotaccent
4275 \definedummyword\ogonek
4276 \definedummyword\ringaccent
4277 \definedummyword\tieaccent
4278 \definedummyword\ubaraccent
4279 \definedummyword\udotaccent
4280 \definedummyword\dotless
4282 % Texinfo font commands.
4283 \definedummyword\b
4284 \definedummyword\i
4285 \definedummyword\r
4286 \definedummyword\sc
4287 \definedummyword\t
4289 % Commands that take arguments.
4290 \definedummyword\acronym
4291 \definedummyword\cite
4292 \definedummyword\code
4293 \definedummyword\command
4294 \definedummyword\dfn
4295 \definedummyword\emph
4296 \definedummyword\env
4297 \definedummyword\file
4298 \definedummyword\kbd
4299 \definedummyword\key
4300 \definedummyword\math
4301 \definedummyword\option
4302 \definedummyword\pxref
4303 \definedummyword\ref
4304 \definedummyword\samp
4305 \definedummyword\strong
4306 \definedummyword\tie
4307 \definedummyword\uref
4308 \definedummyword\url
4309 \definedummyword\var
4310 \definedummyword\verb
4311 \definedummyword\w
4312 \definedummyword\xref
4315 % \indexnofonts is used when outputting the strings to sort the index
4316 % by, and when constructing control sequence names. It eliminates all
4317 % control sequences and just writes whatever the best ASCII sort string
4318 % would be for a given command (usually its argument).
4320 \def\indexnofonts{%
4321 % Accent commands should become @asis.
4322 \def\definedummyaccent##1{\let##1\asis}%
4323 % We can just ignore other control letters.
4324 \def\definedummyletter##1{\let##1\empty}%
4325 % Hopefully, all control words can become @asis.
4326 \let\definedummyword\definedummyaccent
4328 \commondummiesnofonts
4330 % Don't no-op \tt, since it isn't a user-level command
4331 % and is used in the definitions of the active chars like <, >, |, etc.
4332 % Likewise with the other plain tex font commands.
4333 %\let\tt=\asis
4335 \def\ { }%
4336 \def\@{@}%
4337 % how to handle braces?
4338 \def\_{\normalunderscore}%
4340 % Non-English letters.
4341 \def\AA{AA}%
4342 \def\AE{AE}%
4343 \def\L{L}%
4344 \def\OE{OE}%
4345 \def\O{O}%
4346 \def\aa{aa}%
4347 \def\ae{ae}%
4348 \def\l{l}%
4349 \def\oe{oe}%
4350 \def\o{o}%
4351 \def\ss{ss}%
4352 \def\exclamdown{!}%
4353 \def\questiondown{?}%
4354 \def\ordf{a}%
4355 \def\ordm{o}%
4357 \def\LaTeX{LaTeX}%
4358 \def\TeX{TeX}%
4360 % Assorted special characters.
4361 % (The following {} will end up in the sort string, but that's ok.)
4362 \def\bullet{bullet}%
4363 \def\comma{,}%
4364 \def\copyright{copyright}%
4365 \def\registeredsymbol{R}%
4366 \def\dots{...}%
4367 \def\enddots{...}%
4368 \def\equiv{==}%
4369 \def\error{error}%
4370 \def\euro{euro}%
4371 \def\guillemetleft{<<}%
4372 \def\guillemetright{>>}%
4373 \def\guilsinglleft{<}%
4374 \def\guilsinglright{>}%
4375 \def\expansion{==>}%
4376 \def\minus{-}%
4377 \def\pounds{pounds}%
4378 \def\point{.}%
4379 \def\print{-|}%
4380 \def\quotedblbase{"}%
4381 \def\quotedblleft{"}%
4382 \def\quotedblright{"}%
4383 \def\quoteleft{`}%
4384 \def\quoteright{'}%
4385 \def\quotesinglbase{,}%
4386 \def\result{=>}%
4387 \def\textdegree{degrees}%
4389 % We need to get rid of all macros, leaving only the arguments (if present).
4390 % Of course this is not nearly correct, but it is the best we can do for now.
4391 % makeinfo does not expand macros in the argument to @deffn, which ends up
4392 % writing an index entry, and texindex isn't prepared for an index sort entry
4393 % that starts with \.
4395 % Since macro invocations are followed by braces, we can just redefine them
4396 % to take a single TeX argument. The case of a macro invocation that
4397 % goes to end-of-line is not handled.
4399 \macrolist
4402 \let\indexbackslash=0 %overridden during \printindex.
4403 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4405 % Most index entries go through here, but \dosubind is the general case.
4406 % #1 is the index name, #2 is the entry text.
4407 \def\doind#1#2{\dosubind{#1}{#2}{}}
4409 % Workhorse for all \fooindexes.
4410 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4411 % empty if called from \doind, as we usually are (the main exception
4412 % is with most defuns, which call us directly).
4414 \def\dosubind#1#2#3{%
4415 \iflinks
4417 % Store the main index entry text (including the third arg).
4418 \toks0 = {#2}%
4419 % If third arg is present, precede it with a space.
4420 \def\thirdarg{#3}%
4421 \ifx\thirdarg\empty \else
4422 \toks0 = \expandafter{\the\toks0 \space #3}%
4425 \edef\writeto{\csname#1indfile\endcsname}%
4427 \safewhatsit\dosubindwrite
4432 % Write the entry in \toks0 to the index file:
4434 \def\dosubindwrite{%
4435 % Put the index entry in the margin if desired.
4436 \ifx\SETmarginindex\relax\else
4437 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4440 % Remember, we are within a group.
4441 \indexdummies % Must do this here, since \bf, etc expand at this stage
4442 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4443 % so it will be output as is; and it will print as backslash.
4445 % Process the index entry with all font commands turned off, to
4446 % get the string to sort by.
4447 {\indexnofonts
4448 \edef\temp{\the\toks0}% need full expansion
4449 \xdef\indexsorttmp{\temp}%
4452 % Set up the complete index entry, with both the sort key and
4453 % the original text, including any font commands. We write
4454 % three arguments to \entry to the .?? file (four in the
4455 % subentry case), texindex reduces to two when writing the .??s
4456 % sorted result.
4457 \edef\temp{%
4458 \write\writeto{%
4459 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4461 \temp
4464 % Take care of unwanted page breaks/skips around a whatsit:
4466 % If a skip is the last thing on the list now, preserve it
4467 % by backing up by \lastskip, doing the \write, then inserting
4468 % the skip again. Otherwise, the whatsit generated by the
4469 % \write or \pdfdest will make \lastskip zero. The result is that
4470 % sequences like this:
4471 % @end defun
4472 % @tindex whatever
4473 % @defun ...
4474 % will have extra space inserted, because the \medbreak in the
4475 % start of the @defun won't see the skip inserted by the @end of
4476 % the previous defun.
4478 % But don't do any of this if we're not in vertical mode. We
4479 % don't want to do a \vskip and prematurely end a paragraph.
4481 % Avoid page breaks due to these extra skips, too.
4483 % But wait, there is a catch there:
4484 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4485 % sufficient for this purpose, as it ignores stretch and shrink parts
4486 % of the skip. The only way seems to be to check the textual
4487 % representation of the skip.
4489 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4490 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4492 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4494 \newskip\whatsitskip
4495 \newcount\whatsitpenalty
4497 % ..., ready, GO:
4499 \def\safewhatsit#1{%
4500 \ifhmode
4502 \else
4503 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4504 \whatsitskip = \lastskip
4505 \edef\lastskipmacro{\the\lastskip}%
4506 \whatsitpenalty = \lastpenalty
4508 % If \lastskip is nonzero, that means the last item was a
4509 % skip. And since a skip is discardable, that means this
4510 % -\whatsitskip glue we're inserting is preceded by a
4511 % non-discardable item, therefore it is not a potential
4512 % breakpoint, therefore no \nobreak needed.
4513 \ifx\lastskipmacro\zeroskipmacro
4514 \else
4515 \vskip-\whatsitskip
4520 \ifx\lastskipmacro\zeroskipmacro
4521 % If \lastskip was zero, perhaps the last item was a penalty, and
4522 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4523 % to re-insert the same penalty (values >10000 are used for various
4524 % signals); since we just inserted a non-discardable item, any
4525 % following glue (such as a \parskip) would be a breakpoint. For example:
4527 % @deffn deffn-whatever
4528 % @vindex index-whatever
4529 % Description.
4530 % would allow a break between the index-whatever whatsit
4531 % and the "Description." paragraph.
4532 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4533 \else
4534 % On the other hand, if we had a nonzero \lastskip,
4535 % this make-up glue would be preceded by a non-discardable item
4536 % (the whatsit from the \write), so we must insert a \nobreak.
4537 \nobreak\vskip\whatsitskip
4542 % The index entry written in the file actually looks like
4543 % \entry {sortstring}{page}{topic}
4544 % or
4545 % \entry {sortstring}{page}{topic}{subtopic}
4546 % The texindex program reads in these files and writes files
4547 % containing these kinds of lines:
4548 % \initial {c}
4549 % before the first topic whose initial is c
4550 % \entry {topic}{pagelist}
4551 % for a topic that is used without subtopics
4552 % \primary {topic}
4553 % for the beginning of a topic that is used with subtopics
4554 % \secondary {subtopic}{pagelist}
4555 % for each subtopic.
4557 % Define the user-accessible indexing commands
4558 % @findex, @vindex, @kindex, @cindex.
4560 \def\findex {\fnindex}
4561 \def\kindex {\kyindex}
4562 \def\cindex {\cpindex}
4563 \def\vindex {\vrindex}
4564 \def\tindex {\tpindex}
4565 \def\pindex {\pgindex}
4567 \def\cindexsub {\begingroup\obeylines\cindexsub}
4568 {\obeylines %
4569 \gdef\cindexsub "#1" #2^^M{\endgroup %
4570 \dosubind{cp}{#2}{#1}}}
4572 % Define the macros used in formatting output of the sorted index material.
4574 % @printindex causes a particular index (the ??s file) to get printed.
4575 % It does not print any chapter heading (usually an @unnumbered).
4577 \parseargdef\printindex{\begingroup
4578 \dobreak \chapheadingskip{10000}%
4580 \smallfonts \rm
4581 \tolerance = 9500
4582 \plainfrenchspacing
4583 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4585 % See if the index file exists and is nonempty.
4586 % Change catcode of @ here so that if the index file contains
4587 % \initial {@}
4588 % as its first line, TeX doesn't complain about mismatched braces
4589 % (because it thinks @} is a control sequence).
4590 \catcode`\@ = 11
4591 \openin 1 \jobname.#1s
4592 \ifeof 1
4593 % \enddoublecolumns gets confused if there is no text in the index,
4594 % and it loses the chapter title and the aux file entries for the
4595 % index. The easiest way to prevent this problem is to make sure
4596 % there is some text.
4597 \putwordIndexNonexistent
4598 \else
4600 % If the index file exists but is empty, then \openin leaves \ifeof
4601 % false. We have to make TeX try to read something from the file, so
4602 % it can discover if there is anything in it.
4603 \read 1 to \temp
4604 \ifeof 1
4605 \putwordIndexIsEmpty
4606 \else
4607 % Index files are almost Texinfo source, but we use \ as the escape
4608 % character. It would be better to use @, but that's too big a change
4609 % to make right now.
4610 \def\indexbackslash{\backslashcurfont}%
4611 \catcode`\\ = 0
4612 \escapechar = `\\
4613 \begindoublecolumns
4614 \input \jobname.#1s
4615 \enddoublecolumns
4618 \closein 1
4619 \endgroup}
4621 % These macros are used by the sorted index file itself.
4622 % Change them to control the appearance of the index.
4624 \def\initial#1{{%
4625 % Some minor font changes for the special characters.
4626 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4628 % Remove any glue we may have, we'll be inserting our own.
4629 \removelastskip
4631 % We like breaks before the index initials, so insert a bonus.
4632 \nobreak
4633 \vskip 0pt plus 3\baselineskip
4634 \penalty 0
4635 \vskip 0pt plus -3\baselineskip
4637 % Typeset the initial. Making this add up to a whole number of
4638 % baselineskips increases the chance of the dots lining up from column
4639 % to column. It still won't often be perfect, because of the stretch
4640 % we need before each entry, but it's better.
4642 % No shrink because it confuses \balancecolumns.
4643 \vskip 1.67\baselineskip plus .5\baselineskip
4644 \leftline{\secbf #1}%
4645 % Do our best not to break after the initial.
4646 \nobreak
4647 \vskip .33\baselineskip plus .1\baselineskip
4650 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4651 % then page number (#2) flushed to the right margin. It is used for index
4652 % and table of contents entries. The paragraph is indented by \leftskip.
4654 % A straightforward implementation would start like this:
4655 % \def\entry#1#2{...
4656 % But this freezes the catcodes in the argument, and can cause problems to
4657 % @code, which sets - active. This problem was fixed by a kludge---
4658 % ``-'' was active throughout whole index, but this isn't really right.
4660 % The right solution is to prevent \entry from swallowing the whole text.
4661 % --kasal, 21nov03
4662 \def\entry{%
4663 \begingroup
4665 % Start a new paragraph if necessary, so our assignments below can't
4666 % affect previous text.
4667 \par
4669 % Do not fill out the last line with white space.
4670 \parfillskip = 0in
4672 % No extra space above this paragraph.
4673 \parskip = 0in
4675 % Do not prefer a separate line ending with a hyphen to fewer lines.
4676 \finalhyphendemerits = 0
4678 % \hangindent is only relevant when the entry text and page number
4679 % don't both fit on one line. In that case, bob suggests starting the
4680 % dots pretty far over on the line. Unfortunately, a large
4681 % indentation looks wrong when the entry text itself is broken across
4682 % lines. So we use a small indentation and put up with long leaders.
4684 % \hangafter is reset to 1 (which is the value we want) at the start
4685 % of each paragraph, so we need not do anything with that.
4686 \hangindent = 2em
4688 % When the entry text needs to be broken, just fill out the first line
4689 % with blank space.
4690 \rightskip = 0pt plus1fil
4692 % A bit of stretch before each entry for the benefit of balancing
4693 % columns.
4694 \vskip 0pt plus1pt
4696 % Swallow the left brace of the text (first parameter):
4697 \afterassignment\doentry
4698 \let\temp =
4700 \def\doentry{%
4701 \bgroup % Instead of the swallowed brace.
4702 \noindent
4703 \aftergroup\finishentry
4704 % And now comes the text of the entry.
4706 \def\finishentry#1{%
4707 % #1 is the page number.
4709 % The following is kludged to not output a line of dots in the index if
4710 % there are no page numbers. The next person who breaks this will be
4711 % cursed by a Unix daemon.
4712 \setbox\boxA = \hbox{#1}%
4713 \ifdim\wd\boxA = 0pt
4715 \else
4717 % If we must, put the page number on a line of its own, and fill out
4718 % this line with blank space. (The \hfil is overwhelmed with the
4719 % fill leaders glue in \indexdotfill if the page number does fit.)
4720 \hfil\penalty50
4721 \null\nobreak\indexdotfill % Have leaders before the page number.
4723 % The `\ ' here is removed by the implicit \unskip that TeX does as
4724 % part of (the primitive) \par. Without it, a spurious underfull
4725 % \hbox ensues.
4726 \ifpdf
4727 \pdfgettoks#1.%
4728 \ \the\toksA
4729 \else
4730 \ #1%
4733 \par
4734 \endgroup
4737 % Like plain.tex's \dotfill, except uses up at least 1 em.
4738 \def\indexdotfill{\cleaders
4739 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4741 \def\primary #1{\line{#1\hfil}}
4743 \newskip\secondaryindent \secondaryindent=0.5cm
4744 \def\secondary#1#2{{%
4745 \parfillskip=0in
4746 \parskip=0in
4747 \hangindent=1in
4748 \hangafter=1
4749 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4750 \ifpdf
4751 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4752 \else
4755 \par
4758 % Define two-column mode, which we use to typeset indexes.
4759 % Adapted from the TeXbook, page 416, which is to say,
4760 % the manmac.tex format used to print the TeXbook itself.
4761 \catcode`\@=11
4763 \newbox\partialpage
4764 \newdimen\doublecolumnhsize
4766 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4767 % Grab any single-column material above us.
4768 \output = {%
4770 % Here is a possibility not foreseen in manmac: if we accumulate a
4771 % whole lot of material, we might end up calling this \output
4772 % routine twice in a row (see the doublecol-lose test, which is
4773 % essentially a couple of indexes with @setchapternewpage off). In
4774 % that case we just ship out what is in \partialpage with the normal
4775 % output routine. Generally, \partialpage will be empty when this
4776 % runs and this will be a no-op. See the indexspread.tex test case.
4777 \ifvoid\partialpage \else
4778 \onepageout{\pagecontents\partialpage}%
4781 \global\setbox\partialpage = \vbox{%
4782 % Unvbox the main output page.
4783 \unvbox\PAGE
4784 \kern-\topskip \kern\baselineskip
4787 \eject % run that output routine to set \partialpage
4789 % Use the double-column output routine for subsequent pages.
4790 \output = {\doublecolumnout}%
4792 % Change the page size parameters. We could do this once outside this
4793 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4794 % format, but then we repeat the same computation. Repeating a couple
4795 % of assignments once per index is clearly meaningless for the
4796 % execution time, so we may as well do it in one place.
4798 % First we halve the line length, less a little for the gutter between
4799 % the columns. We compute the gutter based on the line length, so it
4800 % changes automatically with the paper format. The magic constant
4801 % below is chosen so that the gutter has the same value (well, +-<1pt)
4802 % as it did when we hard-coded it.
4804 % We put the result in a separate register, \doublecolumhsize, so we
4805 % can restore it in \pagesofar, after \hsize itself has (potentially)
4806 % been clobbered.
4808 \doublecolumnhsize = \hsize
4809 \advance\doublecolumnhsize by -.04154\hsize
4810 \divide\doublecolumnhsize by 2
4811 \hsize = \doublecolumnhsize
4813 % Double the \vsize as well. (We don't need a separate register here,
4814 % since nobody clobbers \vsize.)
4815 \vsize = 2\vsize
4818 % The double-column output routine for all double-column pages except
4819 % the last.
4821 \def\doublecolumnout{%
4822 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4823 % Get the available space for the double columns -- the normal
4824 % (undoubled) page height minus any material left over from the
4825 % previous page.
4826 \dimen@ = \vsize
4827 \divide\dimen@ by 2
4828 \advance\dimen@ by -\ht\partialpage
4830 % box0 will be the left-hand column, box2 the right.
4831 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4832 \onepageout\pagesofar
4833 \unvbox255
4834 \penalty\outputpenalty
4837 % Re-output the contents of the output page -- any previous material,
4838 % followed by the two boxes we just split, in box0 and box2.
4839 \def\pagesofar{%
4840 \unvbox\partialpage
4842 \hsize = \doublecolumnhsize
4843 \wd0=\hsize \wd2=\hsize
4844 \hbox to\pagewidth{\box0\hfil\box2}%
4847 % All done with double columns.
4848 \def\enddoublecolumns{%
4849 % The following penalty ensures that the page builder is exercised
4850 % _before_ we change the output routine. This is necessary in the
4851 % following situation:
4853 % The last section of the index consists only of a single entry.
4854 % Before this section, \pagetotal is less than \pagegoal, so no
4855 % break occurs before the last section starts. However, the last
4856 % section, consisting of \initial and the single \entry, does not
4857 % fit on the page and has to be broken off. Without the following
4858 % penalty the page builder will not be exercised until \eject
4859 % below, and by that time we'll already have changed the output
4860 % routine to the \balancecolumns version, so the next-to-last
4861 % double-column page will be processed with \balancecolumns, which
4862 % is wrong: The two columns will go to the main vertical list, with
4863 % the broken-off section in the recent contributions. As soon as
4864 % the output routine finishes, TeX starts reconsidering the page
4865 % break. The two columns and the broken-off section both fit on the
4866 % page, because the two columns now take up only half of the page
4867 % goal. When TeX sees \eject from below which follows the final
4868 % section, it invokes the new output routine that we've set after
4869 % \balancecolumns below; \onepageout will try to fit the two columns
4870 % and the final section into the vbox of \pageheight (see
4871 % \pagebody), causing an overfull box.
4873 % Note that glue won't work here, because glue does not exercise the
4874 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4875 \penalty0
4877 \output = {%
4878 % Split the last of the double-column material. Leave it on the
4879 % current page, no automatic page break.
4880 \balancecolumns
4882 % If we end up splitting too much material for the current page,
4883 % though, there will be another page break right after this \output
4884 % invocation ends. Having called \balancecolumns once, we do not
4885 % want to call it again. Therefore, reset \output to its normal
4886 % definition right away. (We hope \balancecolumns will never be
4887 % called on to balance too much material, but if it is, this makes
4888 % the output somewhat more palatable.)
4889 \global\output = {\onepageout{\pagecontents\PAGE}}%
4891 \eject
4892 \endgroup % started in \begindoublecolumns
4894 % \pagegoal was set to the doubled \vsize above, since we restarted
4895 % the current page. We're now back to normal single-column
4896 % typesetting, so reset \pagegoal to the normal \vsize (after the
4897 % \endgroup where \vsize got restored).
4898 \pagegoal = \vsize
4901 % Called at the end of the double column material.
4902 \def\balancecolumns{%
4903 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4904 \dimen@ = \ht0
4905 \advance\dimen@ by \topskip
4906 \advance\dimen@ by-\baselineskip
4907 \divide\dimen@ by 2 % target to split to
4908 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4909 \splittopskip = \topskip
4910 % Loop until we get a decent breakpoint.
4912 \vbadness = 10000
4913 \loop
4914 \global\setbox3 = \copy0
4915 \global\setbox1 = \vsplit3 to \dimen@
4916 \ifdim\ht3>\dimen@
4917 \global\advance\dimen@ by 1pt
4918 \repeat
4920 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4921 \setbox0=\vbox to\dimen@{\unvbox1}%
4922 \setbox2=\vbox to\dimen@{\unvbox3}%
4924 \pagesofar
4926 \catcode`\@ = \other
4929 \message{sectioning,}
4930 % Chapters, sections, etc.
4932 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4933 % sections so that we can refer to them unambiguously in the pdf
4934 % outlines by their "section number". We avoid collisions with chapter
4935 % numbers by starting them at 10000. (If a document ever has 10000
4936 % chapters, we're in trouble anyway, I'm sure.)
4937 \newcount\unnumberedno \unnumberedno = 10000
4938 \newcount\chapno
4939 \newcount\secno \secno=0
4940 \newcount\subsecno \subsecno=0
4941 \newcount\subsubsecno \subsubsecno=0
4943 % This counter is funny since it counts through charcodes of letters A, B, ...
4944 \newcount\appendixno \appendixno = `\@
4946 % \def\appendixletter{\char\the\appendixno}
4947 % We do the following ugly conditional instead of the above simple
4948 % construct for the sake of pdftex, which needs the actual
4949 % letter in the expansion, not just typeset.
4951 \def\appendixletter{%
4952 \ifnum\appendixno=`A A%
4953 \else\ifnum\appendixno=`B B%
4954 \else\ifnum\appendixno=`C C%
4955 \else\ifnum\appendixno=`D D%
4956 \else\ifnum\appendixno=`E E%
4957 \else\ifnum\appendixno=`F F%
4958 \else\ifnum\appendixno=`G G%
4959 \else\ifnum\appendixno=`H H%
4960 \else\ifnum\appendixno=`I I%
4961 \else\ifnum\appendixno=`J J%
4962 \else\ifnum\appendixno=`K K%
4963 \else\ifnum\appendixno=`L L%
4964 \else\ifnum\appendixno=`M M%
4965 \else\ifnum\appendixno=`N N%
4966 \else\ifnum\appendixno=`O O%
4967 \else\ifnum\appendixno=`P P%
4968 \else\ifnum\appendixno=`Q Q%
4969 \else\ifnum\appendixno=`R R%
4970 \else\ifnum\appendixno=`S S%
4971 \else\ifnum\appendixno=`T T%
4972 \else\ifnum\appendixno=`U U%
4973 \else\ifnum\appendixno=`V V%
4974 \else\ifnum\appendixno=`W W%
4975 \else\ifnum\appendixno=`X X%
4976 \else\ifnum\appendixno=`Y Y%
4977 \else\ifnum\appendixno=`Z Z%
4978 % The \the is necessary, despite appearances, because \appendixletter is
4979 % expanded while writing the .toc file. \char\appendixno is not
4980 % expandable, thus it is written literally, thus all appendixes come out
4981 % with the same letter (or @) in the toc without it.
4982 \else\char\the\appendixno
4983 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4984 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4986 % Each @chapter defines these (using marks) as the number+name, number
4987 % and name of the chapter. Page headings and footings can use
4988 % these. @section does likewise.
4989 \def\thischapter{}
4990 \def\thischapternum{}
4991 \def\thischaptername{}
4992 \def\thissection{}
4993 \def\thissectionnum{}
4994 \def\thissectionname{}
4996 \newcount\absseclevel % used to calculate proper heading level
4997 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4999 % @raisesections: treat @section as chapter, @subsection as section, etc.
5000 \def\raisesections{\global\advance\secbase by -1}
5001 \let\up=\raisesections % original BFox name
5003 % @lowersections: treat @chapter as section, @section as subsection, etc.
5004 \def\lowersections{\global\advance\secbase by 1}
5005 \let\down=\lowersections % original BFox name
5007 % we only have subsub.
5008 \chardef\maxseclevel = 3
5010 % A numbered section within an unnumbered changes to unnumbered too.
5011 % To achive this, remember the "biggest" unnum. sec. we are currently in:
5012 \chardef\unmlevel = \maxseclevel
5014 % Trace whether the current chapter is an appendix or not:
5015 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5016 \def\chapheadtype{N}
5018 % Choose a heading macro
5019 % #1 is heading type
5020 % #2 is heading level
5021 % #3 is text for heading
5022 \def\genhead#1#2#3{%
5023 % Compute the abs. sec. level:
5024 \absseclevel=#2
5025 \advance\absseclevel by \secbase
5026 % Make sure \absseclevel doesn't fall outside the range:
5027 \ifnum \absseclevel < 0
5028 \absseclevel = 0
5029 \else
5030 \ifnum \absseclevel > 3
5031 \absseclevel = 3
5034 % The heading type:
5035 \def\headtype{#1}%
5036 \if \headtype U%
5037 \ifnum \absseclevel < \unmlevel
5038 \chardef\unmlevel = \absseclevel
5040 \else
5041 % Check for appendix sections:
5042 \ifnum \absseclevel = 0
5043 \edef\chapheadtype{\headtype}%
5044 \else
5045 \if \headtype A\if \chapheadtype N%
5046 \errmessage{@appendix... within a non-appendix chapter}%
5047 \fi\fi
5049 % Check for numbered within unnumbered:
5050 \ifnum \absseclevel > \unmlevel
5051 \def\headtype{U}%
5052 \else
5053 \chardef\unmlevel = 3
5056 % Now print the heading:
5057 \if \headtype U%
5058 \ifcase\absseclevel
5059 \unnumberedzzz{#3}%
5060 \or \unnumberedseczzz{#3}%
5061 \or \unnumberedsubseczzz{#3}%
5062 \or \unnumberedsubsubseczzz{#3}%
5064 \else
5065 \if \headtype A%
5066 \ifcase\absseclevel
5067 \appendixzzz{#3}%
5068 \or \appendixsectionzzz{#3}%
5069 \or \appendixsubseczzz{#3}%
5070 \or \appendixsubsubseczzz{#3}%
5072 \else
5073 \ifcase\absseclevel
5074 \chapterzzz{#3}%
5075 \or \seczzz{#3}%
5076 \or \numberedsubseczzz{#3}%
5077 \or \numberedsubsubseczzz{#3}%
5081 \suppressfirstparagraphindent
5084 % an interface:
5085 \def\numhead{\genhead N}
5086 \def\apphead{\genhead A}
5087 \def\unnmhead{\genhead U}
5089 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5090 % all lower-level sectioning counters to zero.
5092 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5093 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5094 \let\chaplevelprefix = \empty
5096 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5097 \def\chapterzzz#1{%
5098 % section resetting is \global in case the chapter is in a group, such
5099 % as an @include file.
5100 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5101 \global\advance\chapno by 1
5103 % Used for \float.
5104 \gdef\chaplevelprefix{\the\chapno.}%
5105 \resetallfloatnos
5107 \message{\putwordChapter\space \the\chapno}%
5109 % Write the actual heading.
5110 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5112 % So @section and the like are numbered underneath this chapter.
5113 \global\let\section = \numberedsec
5114 \global\let\subsection = \numberedsubsec
5115 \global\let\subsubsection = \numberedsubsubsec
5118 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
5119 \def\appendixzzz#1{%
5120 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5121 \global\advance\appendixno by 1
5122 \gdef\chaplevelprefix{\appendixletter.}%
5123 \resetallfloatnos
5125 \def\appendixnum{\putwordAppendix\space \appendixletter}%
5126 \message{\appendixnum}%
5128 \chapmacro{#1}{Yappendix}{\appendixletter}%
5130 \global\let\section = \appendixsec
5131 \global\let\subsection = \appendixsubsec
5132 \global\let\subsubsection = \appendixsubsubsec
5135 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
5136 \def\unnumberedzzz#1{%
5137 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5138 \global\advance\unnumberedno by 1
5140 % Since an unnumbered has no number, no prefix for figures.
5141 \global\let\chaplevelprefix = \empty
5142 \resetallfloatnos
5144 % This used to be simply \message{#1}, but TeX fully expands the
5145 % argument to \message. Therefore, if #1 contained @-commands, TeX
5146 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5147 % expanded @cite (which turns out to cause errors because \cite is meant
5148 % to be executed, not expanded).
5150 % Anyway, we don't want the fully-expanded definition of @cite to appear
5151 % as a result of the \message, we just want `@cite' itself. We use
5152 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5153 % simply yielding the contents of <toks register>. (We also do this for
5154 % the toc entries.)
5155 \toks0 = {#1}%
5156 \message{(\the\toks0)}%
5158 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5160 \global\let\section = \unnumberedsec
5161 \global\let\subsection = \unnumberedsubsec
5162 \global\let\subsubsection = \unnumberedsubsubsec
5165 % @centerchap is like @unnumbered, but the heading is centered.
5166 \outer\parseargdef\centerchap{%
5167 % Well, we could do the following in a group, but that would break
5168 % an assumption that \chapmacro is called at the outermost level.
5169 % Thus we are safer this way: --kasal, 24feb04
5170 \let\centerparametersmaybe = \centerparameters
5171 \unnmhead0{#1}%
5172 \let\centerparametersmaybe = \relax
5175 % @top is like @unnumbered.
5176 \let\top\unnumbered
5178 % Sections.
5179 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5180 \def\seczzz#1{%
5181 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5182 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5185 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
5186 \def\appendixsectionzzz#1{%
5187 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5188 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5190 \let\appendixsec\appendixsection
5192 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
5193 \def\unnumberedseczzz#1{%
5194 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5195 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5198 % Subsections.
5199 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
5200 \def\numberedsubseczzz#1{%
5201 \global\subsubsecno=0 \global\advance\subsecno by 1
5202 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5205 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
5206 \def\appendixsubseczzz#1{%
5207 \global\subsubsecno=0 \global\advance\subsecno by 1
5208 \sectionheading{#1}{subsec}{Yappendix}%
5209 {\appendixletter.\the\secno.\the\subsecno}%
5212 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
5213 \def\unnumberedsubseczzz#1{%
5214 \global\subsubsecno=0 \global\advance\subsecno by 1
5215 \sectionheading{#1}{subsec}{Ynothing}%
5216 {\the\unnumberedno.\the\secno.\the\subsecno}%
5219 % Subsubsections.
5220 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
5221 \def\numberedsubsubseczzz#1{%
5222 \global\advance\subsubsecno by 1
5223 \sectionheading{#1}{subsubsec}{Ynumbered}%
5224 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5227 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
5228 \def\appendixsubsubseczzz#1{%
5229 \global\advance\subsubsecno by 1
5230 \sectionheading{#1}{subsubsec}{Yappendix}%
5231 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5234 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
5235 \def\unnumberedsubsubseczzz#1{%
5236 \global\advance\subsubsecno by 1
5237 \sectionheading{#1}{subsubsec}{Ynothing}%
5238 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5241 % These macros control what the section commands do, according
5242 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5243 % Define them by default for a numbered chapter.
5244 \let\section = \numberedsec
5245 \let\subsection = \numberedsubsec
5246 \let\subsubsection = \numberedsubsubsec
5248 % Define @majorheading, @heading and @subheading
5250 % NOTE on use of \vbox for chapter headings, section headings, and such:
5251 % 1) We use \vbox rather than the earlier \line to permit
5252 % overlong headings to fold.
5253 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5254 % heading is obnoxious; this forbids it.
5255 % 3) Likewise, headings look best if no \parindent is used, and
5256 % if justification is not attempted. Hence \raggedright.
5258 \def\majorheading{%
5259 {\advance\chapheadingskip by 10pt \chapbreak }%
5260 \parsearg\chapheadingzzz
5263 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5264 \def\chapheadingzzz#1{%
5265 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5266 \parindent=0pt\ptexraggedright
5267 \rmisbold #1\hfill}}%
5268 \bigskip \par\penalty 200\relax
5269 \suppressfirstparagraphindent
5272 % @heading, @subheading, @subsubheading.
5273 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5274 \suppressfirstparagraphindent}
5275 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5276 \suppressfirstparagraphindent}
5277 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5278 \suppressfirstparagraphindent}
5280 % These macros generate a chapter, section, etc. heading only
5281 % (including whitespace, linebreaking, etc. around it),
5282 % given all the information in convenient, parsed form.
5284 %%% Args are the skip and penalty (usually negative)
5285 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5287 %%% Define plain chapter starts, and page on/off switching for it
5288 % Parameter controlling skip before chapter headings (if needed)
5290 \newskip\chapheadingskip
5292 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5293 \def\chappager{\par\vfill\supereject}
5294 % Because \domark is called before \chapoddpage, the filler page will
5295 % get the headings for the next chapter, which is wrong. But we don't
5296 % care -- we just disable all headings on the filler page.
5297 \def\chapoddpage{%
5298 \chappager
5299 \ifodd\pageno \else
5300 \begingroup
5301 \evenheadline={\hfil}\evenfootline={\hfil}%
5302 \oddheadline={\hfil}\oddfootline={\hfil}%
5303 \hbox to 0pt{}%
5304 \chappager
5305 \endgroup
5309 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5311 \def\CHAPPAGoff{%
5312 \global\let\contentsalignmacro = \chappager
5313 \global\let\pchapsepmacro=\chapbreak
5314 \global\let\pagealignmacro=\chappager}
5316 \def\CHAPPAGon{%
5317 \global\let\contentsalignmacro = \chappager
5318 \global\let\pchapsepmacro=\chappager
5319 \global\let\pagealignmacro=\chappager
5320 \global\def\HEADINGSon{\HEADINGSsingle}}
5322 \def\CHAPPAGodd{%
5323 \global\let\contentsalignmacro = \chapoddpage
5324 \global\let\pchapsepmacro=\chapoddpage
5325 \global\let\pagealignmacro=\chapoddpage
5326 \global\def\HEADINGSon{\HEADINGSdouble}}
5328 \CHAPPAGon
5330 % Chapter opening.
5332 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5333 % Yappendix, Yomitfromtoc), #3 the chapter number.
5335 % To test against our argument.
5336 \def\Ynothingkeyword{Ynothing}
5337 \def\Yomitfromtockeyword{Yomitfromtoc}
5338 \def\Yappendixkeyword{Yappendix}
5340 \def\chapmacro#1#2#3{%
5341 % Insert the first mark before the heading break (see notes for \domark).
5342 \let\prevchapterdefs=\lastchapterdefs
5343 \let\prevsectiondefs=\lastsectiondefs
5344 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5345 \gdef\thissection{}}%
5347 \def\temptype{#2}%
5348 \ifx\temptype\Ynothingkeyword
5349 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5350 \gdef\thischapter{\thischaptername}}%
5351 \else\ifx\temptype\Yomitfromtockeyword
5352 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5353 \gdef\thischapter{}}%
5354 \else\ifx\temptype\Yappendixkeyword
5355 \toks0={#1}%
5356 \xdef\lastchapterdefs{%
5357 \gdef\noexpand\thischaptername{\the\toks0}%
5358 \gdef\noexpand\thischapternum{\appendixletter}%
5359 \gdef\noexpand\thischapter{\putwordAppendix{} \noexpand\thischapternum:
5360 \noexpand\thischaptername}%
5362 \else
5363 \toks0={#1}%
5364 \xdef\lastchapterdefs{%
5365 \gdef\noexpand\thischaptername{\the\toks0}%
5366 \gdef\noexpand\thischapternum{\the\chapno}%
5367 \gdef\noexpand\thischapter{\putwordChapter{} \noexpand\thischapternum:
5368 \noexpand\thischaptername}%
5370 \fi\fi\fi
5372 % Output the mark. Pass it through \safewhatsit, to take care of
5373 % the preceding space.
5374 \safewhatsit\domark
5376 % Insert the chapter heading break.
5377 \pchapsepmacro
5379 % Now the second mark, after the heading break. No break points
5380 % between here and the heading.
5381 \let\prevchapterdefs=\lastchapterdefs
5382 \let\prevsectiondefs=\lastsectiondefs
5383 \domark
5386 \chapfonts \rmisbold
5388 % Have to define \lastsection before calling \donoderef, because the
5389 % xref code eventually uses it. On the other hand, it has to be called
5390 % after \pchapsepmacro, or the headline will change too soon.
5391 \gdef\lastsection{#1}%
5393 % Only insert the separating space if we have a chapter/appendix
5394 % number, and don't print the unnumbered ``number''.
5395 \ifx\temptype\Ynothingkeyword
5396 \setbox0 = \hbox{}%
5397 \def\toctype{unnchap}%
5398 \else\ifx\temptype\Yomitfromtockeyword
5399 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5400 \def\toctype{omit}%
5401 \else\ifx\temptype\Yappendixkeyword
5402 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5403 \def\toctype{app}%
5404 \else
5405 \setbox0 = \hbox{#3\enspace}%
5406 \def\toctype{numchap}%
5407 \fi\fi\fi
5409 % Write the toc entry for this chapter. Must come before the
5410 % \donoderef, because we include the current node name in the toc
5411 % entry, and \donoderef resets it to empty.
5412 \writetocentry{\toctype}{#1}{#3}%
5414 % For pdftex, we have to write out the node definition (aka, make
5415 % the pdfdest) after any page break, but before the actual text has
5416 % been typeset. If the destination for the pdf outline is after the
5417 % text, then jumping from the outline may wind up with the text not
5418 % being visible, for instance under high magnification.
5419 \donoderef{#2}%
5421 % Typeset the actual heading.
5422 \nobreak % Avoid page breaks at the interline glue.
5423 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5424 \hangindent=\wd0 \centerparametersmaybe
5425 \unhbox0 #1\par}%
5427 \nobreak\bigskip % no page break after a chapter title
5428 \nobreak
5431 % @centerchap -- centered and unnumbered.
5432 \let\centerparametersmaybe = \relax
5433 \def\centerparameters{%
5434 \advance\rightskip by 3\rightskip
5435 \leftskip = \rightskip
5436 \parfillskip = 0pt
5440 % I don't think this chapter style is supported any more, so I'm not
5441 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5443 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5445 \def\unnchfopen #1{%
5446 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5447 \parindent=0pt\ptexraggedright
5448 \rmisbold #1\hfill}}\bigskip \par\nobreak
5450 \def\chfopen #1#2{\chapoddpage {\chapfonts
5451 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5452 \par\penalty 5000 %
5454 \def\centerchfopen #1{%
5455 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5456 \parindent=0pt
5457 \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
5459 \def\CHAPFopen{%
5460 \global\let\chapmacro=\chfopen
5461 \global\let\centerchapmacro=\centerchfopen}
5464 % Section titles. These macros combine the section number parts and
5465 % call the generic \sectionheading to do the printing.
5467 \newskip\secheadingskip
5468 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5470 % Subsection titles.
5471 \newskip\subsecheadingskip
5472 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5474 % Subsubsection titles.
5475 \def\subsubsecheadingskip{\subsecheadingskip}
5476 \def\subsubsecheadingbreak{\subsecheadingbreak}
5479 % Print any size, any type, section title.
5481 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5482 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5483 % section number.
5485 \def\seckeyword{sec}
5487 \def\sectionheading#1#2#3#4{%
5489 % Switch to the right set of fonts.
5490 \csname #2fonts\endcsname \rmisbold
5492 \def\sectionlevel{#2}%
5493 \def\temptype{#3}%
5495 % Insert first mark before the heading break (see notes for \domark).
5496 \let\prevsectiondefs=\lastsectiondefs
5497 \ifx\temptype\Ynothingkeyword
5498 \ifx\sectionlevel\seckeyword
5499 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5500 \gdef\thissection{\thissectionname}}%
5502 \else\ifx\temptype\Yomitfromtockeyword
5503 % Don't redefine \thissection.
5504 \else\ifx\temptype\Yappendixkeyword
5505 \ifx\sectionlevel\seckeyword
5506 \toks0={#1}%
5507 \xdef\lastsectiondefs{%
5508 \gdef\noexpand\thissectionname{\the\toks0}%
5509 \gdef\noexpand\thissectionnum{#4}%
5510 \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5511 \noexpand\thissectionname}%
5514 \else
5515 \ifx\sectionlevel\seckeyword
5516 \toks0={#1}%
5517 \xdef\lastsectiondefs{%
5518 \gdef\noexpand\thissectionname{\the\toks0}%
5519 \gdef\noexpand\thissectionnum{#4}%
5520 \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5521 \noexpand\thissectionname}%
5524 \fi\fi\fi
5526 % Go into vertical mode. Usually we'll already be there, but we
5527 % don't want the following whatsit to end up in a preceding paragraph
5528 % if the document didn't happen to have a blank line.
5529 \par
5531 % Output the mark. Pass it through \safewhatsit, to take care of
5532 % the preceding space.
5533 \safewhatsit\domark
5535 % Insert space above the heading.
5536 \csname #2headingbreak\endcsname
5538 % Now the second mark, after the heading break. No break points
5539 % between here and the heading.
5540 \let\prevsectiondefs=\lastsectiondefs
5541 \domark
5543 % Only insert the space after the number if we have a section number.
5544 \ifx\temptype\Ynothingkeyword
5545 \setbox0 = \hbox{}%
5546 \def\toctype{unn}%
5547 \gdef\lastsection{#1}%
5548 \else\ifx\temptype\Yomitfromtockeyword
5549 % for @headings -- no section number, don't include in toc,
5550 % and don't redefine \lastsection.
5551 \setbox0 = \hbox{}%
5552 \def\toctype{omit}%
5553 \let\sectionlevel=\empty
5554 \else\ifx\temptype\Yappendixkeyword
5555 \setbox0 = \hbox{#4\enspace}%
5556 \def\toctype{app}%
5557 \gdef\lastsection{#1}%
5558 \else
5559 \setbox0 = \hbox{#4\enspace}%
5560 \def\toctype{num}%
5561 \gdef\lastsection{#1}%
5562 \fi\fi\fi
5564 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5565 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5567 % Write the node reference (= pdf destination for pdftex).
5568 % Again, see comments in \chapmacro.
5569 \donoderef{#3}%
5571 % Interline glue will be inserted when the vbox is completed.
5572 % That glue will be a valid breakpoint for the page, since it'll be
5573 % preceded by a whatsit (usually from the \donoderef, or from the
5574 % \writetocentry if there was no node). We don't want to allow that
5575 % break, since then the whatsits could end up on page n while the
5576 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5577 \nobreak
5579 % Output the actual section heading.
5580 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5581 \hangindent=\wd0 % zero if no section number
5582 \unhbox0 #1}%
5584 % Add extra space after the heading -- half of whatever came above it.
5585 % Don't allow stretch, though.
5586 \kern .5 \csname #2headingskip\endcsname
5588 % Do not let the kern be a potential breakpoint, as it would be if it
5589 % was followed by glue.
5590 \nobreak
5592 % We'll almost certainly start a paragraph next, so don't let that
5593 % glue accumulate. (Not a breakpoint because it's preceded by a
5594 % discardable item.)
5595 \vskip-\parskip
5597 % This is purely so the last item on the list is a known \penalty >
5598 % 10000. This is so \startdefun can avoid allowing breakpoints after
5599 % section headings. Otherwise, it would insert a valid breakpoint between:
5601 % @section sec-whatever
5602 % @deffn def-whatever
5603 \penalty 10001
5607 \message{toc,}
5608 % Table of contents.
5609 \newwrite\tocfile
5611 % Write an entry to the toc file, opening it if necessary.
5612 % Called from @chapter, etc.
5614 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5615 % We append the current node name (if any) and page number as additional
5616 % arguments for the \{chap,sec,...}entry macros which will eventually
5617 % read this. The node name is used in the pdf outlines as the
5618 % destination to jump to.
5620 % We open the .toc file for writing here instead of at @setfilename (or
5621 % any other fixed time) so that @contents can be anywhere in the document.
5622 % But if #1 is `omit', then we don't do anything. This is used for the
5623 % table of contents chapter openings themselves.
5625 \newif\iftocfileopened
5626 \def\omitkeyword{omit}%
5628 \def\writetocentry#1#2#3{%
5629 \edef\writetoctype{#1}%
5630 \ifx\writetoctype\omitkeyword \else
5631 \iftocfileopened\else
5632 \immediate\openout\tocfile = \jobname.toc
5633 \global\tocfileopenedtrue
5636 \iflinks
5637 {\atdummies
5638 \edef\temp{%
5639 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5640 \temp
5645 % Tell \shipout to create a pdf destination on each page, if we're
5646 % writing pdf. These are used in the table of contents. We can't
5647 % just write one on every page because the title pages are numbered
5648 % 1 and 2 (the page numbers aren't printed), and so are the first
5649 % two pages of the document. Thus, we'd have two destinations named
5650 % `1', and two named `2'.
5651 \ifpdf \global\pdfmakepagedesttrue \fi
5655 % These characters do not print properly in the Computer Modern roman
5656 % fonts, so we must take special care. This is more or less redundant
5657 % with the Texinfo input format setup at the end of this file.
5659 \def\activecatcodes{%
5660 \catcode`\"=\active
5661 \catcode`\$=\active
5662 \catcode`\<=\active
5663 \catcode`\>=\active
5664 \catcode`\\=\active
5665 \catcode`\^=\active
5666 \catcode`\_=\active
5667 \catcode`\|=\active
5668 \catcode`\~=\active
5672 % Read the toc file, which is essentially Texinfo input.
5673 \def\readtocfile{%
5674 \setupdatafile
5675 \activecatcodes
5676 \input \tocreadfilename
5679 \newskip\contentsrightmargin \contentsrightmargin=1in
5680 \newcount\savepageno
5681 \newcount\lastnegativepageno \lastnegativepageno = -1
5683 % Prepare to read what we've written to \tocfile.
5685 \def\startcontents#1{%
5686 % If @setchapternewpage on, and @headings double, the contents should
5687 % start on an odd page, unlike chapters. Thus, we maintain
5688 % \contentsalignmacro in parallel with \pagealignmacro.
5689 % From: Torbjorn Granlund <tege@matematik.su.se>
5690 \contentsalignmacro
5691 \immediate\closeout\tocfile
5693 % Don't need to put `Contents' or `Short Contents' in the headline.
5694 % It is abundantly clear what they are.
5695 \chapmacro{#1}{Yomitfromtoc}{}%
5697 \savepageno = \pageno
5698 \begingroup % Set up to handle contents files properly.
5699 \raggedbottom % Worry more about breakpoints than the bottom.
5700 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5702 % Roman numerals for page numbers.
5703 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5706 % redefined for the two-volume lispref. We always output on
5707 % \jobname.toc even if this is redefined.
5709 \def\tocreadfilename{\jobname.toc}
5711 % Normal (long) toc.
5713 \def\contents{%
5714 \startcontents{\putwordTOC}%
5715 \openin 1 \tocreadfilename\space
5716 \ifeof 1 \else
5717 \readtocfile
5719 \vfill \eject
5720 \contentsalignmacro % in case @setchapternewpage odd is in effect
5721 \ifeof 1 \else
5722 \pdfmakeoutlines
5724 \closein 1
5725 \endgroup
5726 \lastnegativepageno = \pageno
5727 \global\pageno = \savepageno
5730 % And just the chapters.
5731 \def\summarycontents{%
5732 \startcontents{\putwordShortTOC}%
5734 \let\numchapentry = \shortchapentry
5735 \let\appentry = \shortchapentry
5736 \let\unnchapentry = \shortunnchapentry
5737 % We want a true roman here for the page numbers.
5738 \secfonts
5739 \let\rm=\shortcontrm \let\bf=\shortcontbf
5740 \let\sl=\shortcontsl \let\tt=\shortconttt
5742 \hyphenpenalty = 10000
5743 \advance\baselineskip by 1pt % Open it up a little.
5744 \def\numsecentry##1##2##3##4{}
5745 \let\appsecentry = \numsecentry
5746 \let\unnsecentry = \numsecentry
5747 \let\numsubsecentry = \numsecentry
5748 \let\appsubsecentry = \numsecentry
5749 \let\unnsubsecentry = \numsecentry
5750 \let\numsubsubsecentry = \numsecentry
5751 \let\appsubsubsecentry = \numsecentry
5752 \let\unnsubsubsecentry = \numsecentry
5753 \openin 1 \tocreadfilename\space
5754 \ifeof 1 \else
5755 \readtocfile
5757 \closein 1
5758 \vfill \eject
5759 \contentsalignmacro % in case @setchapternewpage odd is in effect
5760 \endgroup
5761 \lastnegativepageno = \pageno
5762 \global\pageno = \savepageno
5764 \let\shortcontents = \summarycontents
5766 % Typeset the label for a chapter or appendix for the short contents.
5767 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
5769 \def\shortchaplabel#1{%
5770 % This space should be enough, since a single number is .5em, and the
5771 % widest letter (M) is 1em, at least in the Computer Modern fonts.
5772 % But use \hss just in case.
5773 % (This space doesn't include the extra space that gets added after
5774 % the label; that gets put in by \shortchapentry above.)
5776 % We'd like to right-justify chapter numbers, but that looks strange
5777 % with appendix letters. And right-justifying numbers and
5778 % left-justifying letters looks strange when there is less than 10
5779 % chapters. Have to read the whole toc once to know how many chapters
5780 % there are before deciding ...
5781 \hbox to 1em{#1\hss}%
5784 % These macros generate individual entries in the table of contents.
5785 % The first argument is the chapter or section name.
5786 % The last argument is the page number.
5787 % The arguments in between are the chapter number, section number, ...
5789 % Chapters, in the main contents.
5790 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5792 % Chapters, in the short toc.
5793 % See comments in \dochapentry re vbox and related settings.
5794 \def\shortchapentry#1#2#3#4{%
5795 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5798 % Appendices, in the main contents.
5799 % Need the word Appendix, and a fixed-size box.
5801 \def\appendixbox#1{%
5802 % We use M since it's probably the widest letter.
5803 \setbox0 = \hbox{\putwordAppendix{} M}%
5804 \hbox to \wd0{\putwordAppendix{} #1\hss}}
5806 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5808 % Unnumbered chapters.
5809 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5810 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5812 % Sections.
5813 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5814 \let\appsecentry=\numsecentry
5815 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5817 % Subsections.
5818 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5819 \let\appsubsecentry=\numsubsecentry
5820 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5822 % And subsubsections.
5823 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5824 \let\appsubsubsecentry=\numsubsubsecentry
5825 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5827 % This parameter controls the indentation of the various levels.
5828 % Same as \defaultparindent.
5829 \newdimen\tocindent \tocindent = 15pt
5831 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5832 % page number.
5834 % If the toc has to be broken over pages, we want it to be at chapters
5835 % if at all possible; hence the \penalty.
5836 \def\dochapentry#1#2{%
5837 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5838 \begingroup
5839 \chapentryfonts
5840 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5841 \endgroup
5842 \nobreak\vskip .25\baselineskip plus.1\baselineskip
5845 \def\dosecentry#1#2{\begingroup
5846 \secentryfonts \leftskip=\tocindent
5847 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5848 \endgroup}
5850 \def\dosubsecentry#1#2{\begingroup
5851 \subsecentryfonts \leftskip=2\tocindent
5852 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5853 \endgroup}
5855 \def\dosubsubsecentry#1#2{\begingroup
5856 \subsubsecentryfonts \leftskip=3\tocindent
5857 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5858 \endgroup}
5860 % We use the same \entry macro as for the index entries.
5861 \let\tocentry = \entry
5863 % Space between chapter (or whatever) number and the title.
5864 \def\labelspace{\hskip1em \relax}
5866 \def\dopageno#1{{\rm #1}}
5867 \def\doshortpageno#1{{\rm #1}}
5869 \def\chapentryfonts{\secfonts \rm}
5870 \def\secentryfonts{\textfonts}
5871 \def\subsecentryfonts{\textfonts}
5872 \def\subsubsecentryfonts{\textfonts}
5875 \message{environments,}
5876 % @foo ... @end foo.
5878 % @tex ... @end tex escapes into raw Tex temporarily.
5879 % One exception: @ is still an escape character, so that @end tex works.
5880 % But \@ or @@ will get a plain tex @ character.
5882 \envdef\tex{%
5883 \setupmarkupstyle{tex}%
5884 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5885 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5886 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5887 \catcode `\%=14
5888 \catcode `\+=\other
5889 \catcode `\"=\other
5890 \catcode `\|=\other
5891 \catcode `\<=\other
5892 \catcode `\>=\other
5893 \catcode`\`=\other
5894 \catcode`\'=\other
5895 \escapechar=`\\
5897 \let\b=\ptexb
5898 \let\bullet=\ptexbullet
5899 \let\c=\ptexc
5900 \let\,=\ptexcomma
5901 \let\.=\ptexdot
5902 \let\dots=\ptexdots
5903 \let\equiv=\ptexequiv
5904 \let\!=\ptexexclam
5905 \let\i=\ptexi
5906 \let\indent=\ptexindent
5907 \let\noindent=\ptexnoindent
5908 \let\{=\ptexlbrace
5909 \let\+=\tabalign
5910 \let\}=\ptexrbrace
5911 \let\/=\ptexslash
5912 \let\*=\ptexstar
5913 \let\t=\ptext
5914 \expandafter \let\csname top\endcsname=\ptextop % outer
5915 \let\frenchspacing=\plainfrenchspacing
5917 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5918 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5919 \def\@{@}%
5921 % There is no need to define \Etex.
5923 % Define @lisp ... @end lisp.
5924 % @lisp environment forms a group so it can rebind things,
5925 % including the definition of @end lisp (which normally is erroneous).
5927 % Amount to narrow the margins by for @lisp.
5928 \newskip\lispnarrowing \lispnarrowing=0.4in
5930 % This is the definition that ^^M gets inside @lisp, @example, and other
5931 % such environments. \null is better than a space, since it doesn't
5932 % have any width.
5933 \def\lisppar{\null\endgraf}
5935 % This space is always present above and below environments.
5936 \newskip\envskipamount \envskipamount = 0pt
5938 % Make spacing and below environment symmetrical. We use \parskip here
5939 % to help in doing that, since in @example-like environments \parskip
5940 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
5941 % start of the next paragraph will insert \parskip.
5943 \def\aboveenvbreak{{%
5944 % =10000 instead of <10000 because of a special case in \itemzzz and
5945 % \sectionheading, q.v.
5946 \ifnum \lastpenalty=10000 \else
5947 \advance\envskipamount by \parskip
5948 \endgraf
5949 \ifdim\lastskip<\envskipamount
5950 \removelastskip
5951 % it's not a good place to break if the last penalty was \nobreak
5952 % or better ...
5953 \ifnum\lastpenalty<10000 \penalty-50 \fi
5954 \vskip\envskipamount
5959 \let\afterenvbreak = \aboveenvbreak
5961 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
5962 % also clear it, so that its embedded environments do the narrowing again.
5963 \let\nonarrowing=\relax
5965 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
5966 % environment contents.
5967 \font\circle=lcircle10
5968 \newdimen\circthick
5969 \newdimen\cartouter\newdimen\cartinner
5970 \newskip\normbskip\newskip\normpskip\newskip\normlskip
5971 \circthick=\fontdimen8\circle
5973 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
5974 \def\ctr{{\hskip 6pt\circle\char'010}}
5975 \def\cbl{{\circle\char'012\hskip -6pt}}
5976 \def\cbr{{\hskip 6pt\circle\char'011}}
5977 \def\carttop{\hbox to \cartouter{\hskip\lskip
5978 \ctl\leaders\hrule height\circthick\hfil\ctr
5979 \hskip\rskip}}
5980 \def\cartbot{\hbox to \cartouter{\hskip\lskip
5981 \cbl\leaders\hrule height\circthick\hfil\cbr
5982 \hskip\rskip}}
5984 \newskip\lskip\newskip\rskip
5986 \envdef\cartouche{%
5987 \ifhmode\par\fi % can't be in the midst of a paragraph.
5988 \startsavinginserts
5989 \lskip=\leftskip \rskip=\rightskip
5990 \leftskip=0pt\rightskip=0pt % we want these *outside*.
5991 \cartinner=\hsize \advance\cartinner by-\lskip
5992 \advance\cartinner by-\rskip
5993 \cartouter=\hsize
5994 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
5995 % side, and for 6pt waste from
5996 % each corner char, and rule thickness
5997 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
5998 % Flag to tell @lisp, etc., not to narrow margin.
5999 \let\nonarrowing = t%
6000 \vbox\bgroup
6001 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6002 \carttop
6003 \hbox\bgroup
6004 \hskip\lskip
6005 \vrule\kern3pt
6006 \vbox\bgroup
6007 \kern3pt
6008 \hsize=\cartinner
6009 \baselineskip=\normbskip
6010 \lineskip=\normlskip
6011 \parskip=\normpskip
6012 \vskip -\parskip
6013 \comment % For explanation, see the end of \def\group.
6015 \def\Ecartouche{%
6016 \ifhmode\par\fi
6017 \kern3pt
6018 \egroup
6019 \kern3pt\vrule
6020 \hskip\rskip
6021 \egroup
6022 \cartbot
6023 \egroup
6024 \checkinserts
6028 % This macro is called at the beginning of all the @example variants,
6029 % inside a group.
6030 \newdimen\nonfillparindent
6031 \def\nonfillstart{%
6032 \aboveenvbreak
6033 \hfuzz = 12pt % Don't be fussy
6034 \sepspaces % Make spaces be word-separators rather than space tokens.
6035 \let\par = \lisppar % don't ignore blank lines
6036 \obeylines % each line of input is a line of output
6037 \parskip = 0pt
6038 % Turn off paragraph indentation but redefine \indent to emulate
6039 % the normal \indent.
6040 \nonfillparindent=\parindent
6041 \parindent = 0pt
6042 \let\indent\nonfillindent
6044 \emergencystretch = 0pt % don't try to avoid overfull boxes
6045 \ifx\nonarrowing\relax
6046 \advance \leftskip by \lispnarrowing
6047 \exdentamount=\lispnarrowing
6048 \else
6049 \let\nonarrowing = \relax
6051 \let\exdent=\nofillexdent
6054 \begingroup
6055 \obeyspaces
6056 % We want to swallow spaces (but not other tokens) after the fake
6057 % @indent in our nonfill-environments, where spaces are normally
6058 % active and set to @tie, resulting in them not being ignored after
6059 % @indent.
6060 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6061 \gdef\nonfillindentcheck{%
6062 \ifx\temp %
6063 \expandafter\nonfillindentgobble%
6064 \else%
6065 \leavevmode\nonfillindentbox%
6066 \fi%
6068 \endgroup
6069 \def\nonfillindentgobble#1{\nonfillindent}
6070 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6072 % If you want all examples etc. small: @set dispenvsize small.
6073 % If you want even small examples the full size: @set dispenvsize nosmall.
6074 % This affects the following displayed environments:
6075 % @example, @display, @format, @lisp
6077 \def\smallword{small}
6078 \def\nosmallword{nosmall}
6079 \let\SETdispenvsize\relax
6080 \def\setnormaldispenv{%
6081 \ifx\SETdispenvsize\smallword
6082 % end paragraph for sake of leading, in case document has no blank
6083 % line. This is redundant with what happens in \aboveenvbreak, but
6084 % we need to do it before changing the fonts, and it's inconvenient
6085 % to change the fonts afterward.
6086 \ifnum \lastpenalty=10000 \else \endgraf \fi
6087 \smallexamplefonts \rm
6090 \def\setsmalldispenv{%
6091 \ifx\SETdispenvsize\nosmallword
6092 \else
6093 \ifnum \lastpenalty=10000 \else \endgraf \fi
6094 \smallexamplefonts \rm
6098 % We often define two environments, @foo and @smallfoo.
6099 % Let's do it by one command:
6100 \def\makedispenv #1#2{
6101 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
6102 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
6103 \expandafter\let\csname E#1\endcsname \afterenvbreak
6104 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6107 % Define two synonyms:
6108 \def\maketwodispenvs #1#2#3{
6109 \makedispenv{#1}{#3}
6110 \makedispenv{#2}{#3}
6113 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
6115 % @smallexample and @smalllisp: use smaller fonts.
6116 % Originally contributed by Pavel@xerox.
6118 \maketwodispenvs {lisp}{example}{%
6119 \nonfillstart
6120 \tt\setupmarkupstyle{example}%
6121 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6122 \gobble % eat return
6124 % @display/@smalldisplay: same as @lisp except keep current font.
6126 \makedispenv {display}{%
6127 \nonfillstart
6128 \gobble
6131 % @format/@smallformat: same as @display except don't narrow margins.
6133 \makedispenv{format}{%
6134 \let\nonarrowing = t%
6135 \nonfillstart
6136 \gobble
6139 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6140 \envdef\flushleft{%
6141 \let\nonarrowing = t%
6142 \nonfillstart
6143 \gobble
6145 \let\Eflushleft = \afterenvbreak
6147 % @flushright.
6149 \envdef\flushright{%
6150 \let\nonarrowing = t%
6151 \nonfillstart
6152 \advance\leftskip by 0pt plus 1fill
6153 \gobble
6155 \let\Eflushright = \afterenvbreak
6158 % @raggedright does more-or-less normal line breaking but no right
6159 % justification. From plain.tex.
6160 \envdef\raggedright{%
6161 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6163 \let\Eraggedright\par
6165 \envdef\raggedleft{%
6166 \parindent=0pt \leftskip0pt plus2em
6167 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6168 \hbadness=10000 % Last line will usually be underfull, so turn off
6169 % badness reporting.
6171 \let\Eraggedleft\par
6173 \envdef\raggedcenter{%
6174 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6175 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6176 \hbadness=10000 % Last line will usually be underfull, so turn off
6177 % badness reporting.
6179 \let\Eraggedcenter\par
6182 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6183 % and narrows the margins. We keep \parskip nonzero in general, since
6184 % we're doing normal filling. So, when using \aboveenvbreak and
6185 % \afterenvbreak, temporarily make \parskip 0.
6187 \def\quotationstart{%
6188 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6189 \parindent=0pt
6191 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6192 \ifx\nonarrowing\relax
6193 \advance\leftskip by \lispnarrowing
6194 \advance\rightskip by \lispnarrowing
6195 \exdentamount = \lispnarrowing
6196 \else
6197 \let\nonarrowing = \relax
6199 \parsearg\quotationlabel
6202 \envdef\quotation{%
6203 \setnormaldispenv
6204 \quotationstart
6207 \envdef\smallquotation{%
6208 \setsmalldispenv
6209 \quotationstart
6211 \let\Esmallquotation = \Equotation
6213 % We have retained a nonzero parskip for the environment, since we're
6214 % doing normal filling.
6216 \def\Equotation{%
6217 \par
6218 \ifx\quotationauthor\undefined\else
6219 % indent a bit.
6220 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6222 {\parskip=0pt \afterenvbreak}%
6225 % If we're given an argument, typeset it in bold with a colon after.
6226 \def\quotationlabel#1{%
6227 \def\temp{#1}%
6228 \ifx\temp\empty \else
6229 {\bf #1: }%
6234 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6235 % If we want to allow any <char> as delimiter,
6236 % we need the curly braces so that makeinfo sees the @verb command, eg:
6237 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6239 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6241 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6242 % active too. Otherwise, they get lost as the first character on a
6243 % verbatim line.
6244 \def\dospecials{%
6245 \do\ \do\\\do\{\do\}\do\$\do\&%
6246 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6247 \do\<\do\>\do\|\do\@\do+\do\"%
6248 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6249 % @set txicodequotebacktick will not have effect on @verb and
6250 % @verbatim, and ?` and !` ligatures won't get disabled.
6251 %\do\`\do\'%
6254 % [Knuth] p. 380
6255 \def\uncatcodespecials{%
6256 \def\do##1{\catcode`##1=\other}\dospecials}
6258 % Setup for the @verb command.
6260 % Eight spaces for a tab
6261 \begingroup
6262 \catcode`\^^I=\active
6263 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6264 \endgroup
6266 \def\setupverb{%
6267 \tt % easiest (and conventionally used) font for verbatim
6268 \def\par{\leavevmode\endgraf}%
6269 \setupmarkupstyle{verb}%
6270 \tabeightspaces
6271 % Respect line breaks,
6272 % print special symbols as themselves, and
6273 % make each space count
6274 % must do in this order:
6275 \obeylines \uncatcodespecials \sepspaces
6278 % Setup for the @verbatim environment
6280 % Real tab expansion
6281 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6283 \def\starttabbox{\setbox0=\hbox\bgroup}
6285 \begingroup
6286 \catcode`\^^I=\active
6287 \gdef\tabexpand{%
6288 \catcode`\^^I=\active
6289 \def^^I{\leavevmode\egroup
6290 \dimen0=\wd0 % the width so far, or since the previous tab
6291 \divide\dimen0 by\tabw
6292 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
6293 \advance\dimen0 by\tabw % advance to next multiple of \tabw
6294 \wd0=\dimen0 \box0 \starttabbox
6297 \endgroup
6299 % start the verbatim environment.
6300 \def\setupverbatim{%
6301 \let\nonarrowing = t%
6302 \nonfillstart
6303 % Easiest (and conventionally used) font for verbatim
6305 \def\par{\leavevmode\egroup\box0\endgraf}%
6306 \tabexpand
6307 \setupmarkupstyle{verbatim}%
6308 % Respect line breaks,
6309 % print special symbols as themselves, and
6310 % make each space count
6311 % must do in this order:
6312 \obeylines \uncatcodespecials \sepspaces
6313 \everypar{\starttabbox}%
6316 % Do the @verb magic: verbatim text is quoted by unique
6317 % delimiter characters. Before first delimiter expect a
6318 % right brace, after last delimiter expect closing brace:
6320 % \def\doverb'{'<char>#1<char>'}'{#1}
6322 % [Knuth] p. 382; only eat outer {}
6323 \begingroup
6324 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6325 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6326 \endgroup
6328 \def\verb{\begingroup\setupverb\doverb}
6331 % Do the @verbatim magic: define the macro \doverbatim so that
6332 % the (first) argument ends when '@end verbatim' is reached, ie:
6334 % \def\doverbatim#1@end verbatim{#1}
6336 % For Texinfo it's a lot easier than for LaTeX,
6337 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6338 % we need not redefine '\', '{' and '}'.
6340 % Inspired by LaTeX's verbatim command set [latex.ltx]
6342 \begingroup
6343 \catcode`\ =\active
6344 \obeylines %
6345 % ignore everything up to the first ^^M, that's the newline at the end
6346 % of the @verbatim input line itself. Otherwise we get an extra blank
6347 % line in the output.
6348 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6349 % We really want {...\end verbatim} in the body of the macro, but
6350 % without the active space; thus we have to use \xdef and \gobble.
6351 \endgroup
6353 \envdef\verbatim{%
6354 \setupverbatim\doverbatim
6356 \let\Everbatim = \afterenvbreak
6359 % @verbatiminclude FILE - insert text of file in verbatim environment.
6361 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6363 \def\doverbatiminclude#1{%
6365 \makevalueexpandable
6366 \setupverbatim
6367 \indexnofonts % Allow `@@' and other weird things in file names.
6368 \input #1
6369 \afterenvbreak
6373 % @copying ... @end copying.
6374 % Save the text away for @insertcopying later.
6376 % We save the uninterpreted tokens, rather than creating a box.
6377 % Saving the text in a box would be much easier, but then all the
6378 % typesetting commands (@smallbook, font changes, etc.) have to be done
6379 % beforehand -- and a) we want @copying to be done first in the source
6380 % file; b) letting users define the frontmatter in as flexible order as
6381 % possible is very desirable.
6383 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6384 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6386 \def\insertcopying{%
6387 \begingroup
6388 \parindent = 0pt % paragraph indentation looks wrong on title page
6389 \scanexp\copyingtext
6390 \endgroup
6394 \message{defuns,}
6395 % @defun etc.
6397 \newskip\defbodyindent \defbodyindent=.4in
6398 \newskip\defargsindent \defargsindent=50pt
6399 \newskip\deflastargmargin \deflastargmargin=18pt
6400 \newcount\defunpenalty
6402 % Start the processing of @deffn:
6403 \def\startdefun{%
6404 \ifnum\lastpenalty<10000
6405 \medbreak
6406 \defunpenalty=10003 % Will keep this @deffn together with the
6407 % following @def command, see below.
6408 \else
6409 % If there are two @def commands in a row, we'll have a \nobreak,
6410 % which is there to keep the function description together with its
6411 % header. But if there's nothing but headers, we need to allow a
6412 % break somewhere. Check specifically for penalty 10002, inserted
6413 % by \printdefunline, instead of 10000, since the sectioning
6414 % commands also insert a nobreak penalty, and we don't want to allow
6415 % a break between a section heading and a defun.
6417 % As a minor refinement, we avoid "club" headers by signalling
6418 % with penalty of 10003 after the very first @deffn in the
6419 % sequence (see above), and penalty of 10002 after any following
6420 % @def command.
6421 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6423 % Similarly, after a section heading, do not allow a break.
6424 % But do insert the glue.
6425 \medskip % preceded by discardable penalty, so not a breakpoint
6428 \parindent=0in
6429 \advance\leftskip by \defbodyindent
6430 \exdentamount=\defbodyindent
6433 \def\dodefunx#1{%
6434 % First, check whether we are in the right environment:
6435 \checkenv#1%
6437 % As above, allow line break if we have multiple x headers in a row.
6438 % It's not a great place, though.
6439 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6441 % And now, it's time to reuse the body of the original defun:
6442 \expandafter\gobbledefun#1%
6444 \def\gobbledefun#1\startdefun{}
6446 % \printdefunline \deffnheader{text}
6448 \def\printdefunline#1#2{%
6449 \begingroup
6450 % call \deffnheader:
6451 #1#2 \endheader
6452 % common ending:
6453 \interlinepenalty = 10000
6454 \advance\rightskip by 0pt plus 1fil
6455 \endgraf
6456 \nobreak\vskip -\parskip
6457 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6458 % Some of the @defun-type tags do not enable magic parentheses,
6459 % rendering the following check redundant. But we don't optimize.
6460 \checkparencounts
6461 \endgroup
6464 \def\Edefun{\endgraf\medbreak}
6466 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6467 % the only thing remaining is to define \deffnheader.
6469 \def\makedefun#1{%
6470 \expandafter\let\csname E#1\endcsname = \Edefun
6471 \edef\temp{\noexpand\domakedefun
6472 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6473 \temp
6476 % \domakedefun \deffn \deffnx \deffnheader
6478 % Define \deffn and \deffnx, without parameters.
6479 % \deffnheader has to be defined explicitly.
6481 \def\domakedefun#1#2#3{%
6482 \envdef#1{%
6483 \startdefun
6484 \parseargusing\activeparens{\printdefunline#3}%
6486 \def#2{\dodefunx#1}%
6487 \def#3%
6490 %%% Untyped functions:
6492 % @deffn category name args
6493 \makedefun{deffn}{\deffngeneral{}}
6495 % @deffn category class name args
6496 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6498 % \defopon {category on}class name args
6499 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6501 % \deffngeneral {subind}category name args
6503 \def\deffngeneral#1#2 #3 #4\endheader{%
6504 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6505 \dosubind{fn}{\code{#3}}{#1}%
6506 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6509 %%% Typed functions:
6511 % @deftypefn category type name args
6512 \makedefun{deftypefn}{\deftypefngeneral{}}
6514 % @deftypeop category class type name args
6515 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6517 % \deftypeopon {category on}class type name args
6518 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6520 % \deftypefngeneral {subind}category type name args
6522 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6523 \dosubind{fn}{\code{#4}}{#1}%
6524 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6527 %%% Typed variables:
6529 % @deftypevr category type var args
6530 \makedefun{deftypevr}{\deftypecvgeneral{}}
6532 % @deftypecv category class type var args
6533 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6535 % \deftypecvof {category of}class type var args
6536 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6538 % \deftypecvgeneral {subind}category type var args
6540 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6541 \dosubind{vr}{\code{#4}}{#1}%
6542 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6545 %%% Untyped variables:
6547 % @defvr category var args
6548 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6550 % @defcv category class var args
6551 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6553 % \defcvof {category of}class var args
6554 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6556 %%% Type:
6557 % @deftp category name args
6558 \makedefun{deftp}#1 #2 #3\endheader{%
6559 \doind{tp}{\code{#2}}%
6560 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6563 % Remaining @defun-like shortcuts:
6564 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6565 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6566 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6567 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6568 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6569 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6570 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6571 \makedefun{defmethod}{\defopon\putwordMethodon}
6572 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6573 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6574 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6576 % \defname, which formats the name of the @def (not the args).
6577 % #1 is the category, such as "Function".
6578 % #2 is the return type, if any.
6579 % #3 is the function name.
6581 % We are followed by (but not passed) the arguments, if any.
6583 \def\defname#1#2#3{%
6584 % Get the values of \leftskip and \rightskip as they were outside the @def...
6585 \advance\leftskip by -\defbodyindent
6587 % How we'll format the type name. Putting it in brackets helps
6588 % distinguish it from the body text that may end up on the next line
6589 % just below it.
6590 \def\temp{#1}%
6591 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6593 % Figure out line sizes for the paragraph shape.
6594 % The first line needs space for \box0; but if \rightskip is nonzero,
6595 % we need only space for the part of \box0 which exceeds it:
6596 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6597 % The continuations:
6598 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6599 % (plain.tex says that \dimen1 should be used only as global.)
6600 \parshape 2 0in \dimen0 \defargsindent \dimen2
6602 % Put the type name to the right margin.
6603 \noindent
6604 \hbox to 0pt{%
6605 \hfil\box0 \kern-\hsize
6606 % \hsize has to be shortened this way:
6607 \kern\leftskip
6608 % Intentionally do not respect \rightskip, since we need the space.
6611 % Allow all lines to be underfull without complaint:
6612 \tolerance=10000 \hbadness=10000
6613 \exdentamount=\defbodyindent
6615 % defun fonts. We use typewriter by default (used to be bold) because:
6616 % . we're printing identifiers, they should be in tt in principle.
6617 % . in languages with many accents, such as Czech or French, it's
6618 % common to leave accents off identifiers. The result looks ok in
6619 % tt, but exceedingly strange in rm.
6620 % . we don't want -- and --- to be treated as ligatures.
6621 % . this still does not fix the ?` and !` ligatures, but so far no
6622 % one has made identifiers using them :).
6623 \df \tt
6624 \def\temp{#2}% return value type
6625 \ifx\temp\empty\else \tclose{\temp} \fi
6626 #3% output function name
6628 {\rm\enskip}% hskip 0.5 em of \tenrm
6630 \boldbrax
6631 % arguments will be output next, if any.
6634 % Print arguments in slanted roman (not ttsl), inconsistently with using
6635 % tt for the name. This is because literal text is sometimes needed in
6636 % the argument list (groff manual), and ttsl and tt are not very
6637 % distinguishable. Prevent hyphenation at `-' chars.
6639 \def\defunargs#1{%
6640 % use sl by default (not ttsl),
6641 % tt for the names.
6642 \df \sl \hyphenchar\font=0
6644 % On the other hand, if an argument has two dashes (for instance), we
6645 % want a way to get ttsl. Let's try @var for that.
6646 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
6648 \sl\hyphenchar\font=45
6651 % We want ()&[] to print specially on the defun line.
6653 \def\activeparens{%
6654 \catcode`\(=\active \catcode`\)=\active
6655 \catcode`\[=\active \catcode`\]=\active
6656 \catcode`\&=\active
6659 % Make control sequences which act like normal parenthesis chars.
6660 \let\lparen = ( \let\rparen = )
6662 % Be sure that we always have a definition for `(', etc. For example,
6663 % if the fn name has parens in it, \boldbrax will not be in effect yet,
6664 % so TeX would otherwise complain about undefined control sequence.
6666 \activeparens
6667 \global\let(=\lparen \global\let)=\rparen
6668 \global\let[=\lbrack \global\let]=\rbrack
6669 \global\let& = \&
6671 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
6672 \gdef\magicamp{\let&=\amprm}
6675 \newcount\parencount
6677 % If we encounter &foo, then turn on ()-hacking afterwards
6678 \newif\ifampseen
6679 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
6681 \def\parenfont{%
6682 \ifampseen
6683 % At the first level, print parens in roman,
6684 % otherwise use the default font.
6685 \ifnum \parencount=1 \rm \fi
6686 \else
6687 % The \sf parens (in \boldbrax) actually are a little bolder than
6688 % the contained text. This is especially needed for [ and ] .
6692 \def\infirstlevel#1{%
6693 \ifampseen
6694 \ifnum\parencount=1
6699 \def\bfafterword#1 {#1 \bf}
6701 \def\opnr{%
6702 \global\advance\parencount by 1
6703 {\parenfont(}%
6704 \infirstlevel \bfafterword
6706 \def\clnr{%
6707 {\parenfont)}%
6708 \infirstlevel \sl
6709 \global\advance\parencount by -1
6712 \newcount\brackcount
6713 \def\lbrb{%
6714 \global\advance\brackcount by 1
6715 {\bf[}%
6717 \def\rbrb{%
6718 {\bf]}%
6719 \global\advance\brackcount by -1
6722 \def\checkparencounts{%
6723 \ifnum\parencount=0 \else \badparencount \fi
6724 \ifnum\brackcount=0 \else \badbrackcount \fi
6726 % these should not use \errmessage; the glibc manual, at least, actually
6727 % has such constructs (when documenting function pointers).
6728 \def\badparencount{%
6729 \message{Warning: unbalanced parentheses in @def...}%
6730 \global\parencount=0
6732 \def\badbrackcount{%
6733 \message{Warning: unbalanced square brackets in @def...}%
6734 \global\brackcount=0
6738 \message{macros,}
6739 % @macro.
6741 % To do this right we need a feature of e-TeX, \scantokens,
6742 % which we arrange to emulate with a temporary file in ordinary TeX.
6743 \ifx\eTeXversion\undefined
6744 \newwrite\macscribble
6745 \def\scantokens#1{%
6746 \toks0={#1}%
6747 \immediate\openout\macscribble=\jobname.tmp
6748 \immediate\write\macscribble{\the\toks0}%
6749 \immediate\closeout\macscribble
6750 \input \jobname.tmp
6754 \def\scanmacro#1{%
6755 \begingroup
6756 \newlinechar`\^^M
6757 \let\xeatspaces\eatspaces
6758 % Undo catcode changes of \startcontents and \doprintindex
6759 % When called from @insertcopying or (short)caption, we need active
6760 % backslash to get it printed correctly. Previously, we had
6761 % \catcode`\\=\other instead. We'll see whether a problem appears
6762 % with macro expansion. --kasal, 19aug04
6763 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6764 % ... and \example
6765 \spaceisspace
6767 % Append \endinput to make sure that TeX does not see the ending newline.
6768 % I've verified that it is necessary both for e-TeX and for ordinary TeX
6769 % --kasal, 29nov03
6770 \scantokens{#1\endinput}%
6771 \endgroup
6774 \def\scanexp#1{%
6775 \edef\temp{\noexpand\scanmacro{#1}}%
6776 \temp
6779 \newcount\paramno % Count of parameters
6780 \newtoks\macname % Macro name
6781 \newif\ifrecursive % Is it recursive?
6783 % List of all defined macros in the form
6784 % \definedummyword\macro1\definedummyword\macro2...
6785 % Currently is also contains all @aliases; the list can be split
6786 % if there is a need.
6787 \def\macrolist{}
6789 % Add the macro to \macrolist
6790 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6791 \def\addtomacrolistxxx#1{%
6792 \toks0 = \expandafter{\macrolist\definedummyword#1}%
6793 \xdef\macrolist{\the\toks0}%
6796 % Utility routines.
6797 % This does \let #1 = #2, with \csnames; that is,
6798 % \let \csname#1\endcsname = \csname#2\endcsname
6799 % (except of course we have to play expansion games).
6801 \def\cslet#1#2{%
6802 \expandafter\let
6803 \csname#1\expandafter\endcsname
6804 \csname#2\endcsname
6807 % Trim leading and trailing spaces off a string.
6808 % Concepts from aro-bend problem 15 (see CTAN).
6809 {\catcode`\@=11
6810 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6811 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6812 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6813 \def\unbrace#1{#1}
6814 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6817 % Trim a single trailing ^^M off a string.
6818 {\catcode`\^^M=\other \catcode`\Q=3%
6819 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6820 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6821 \gdef\eatcrb#1Q#2Q{#1}%
6824 % Macro bodies are absorbed as an argument in a context where
6825 % all characters are catcode 10, 11 or 12, except \ which is active
6826 % (as in normal texinfo). It is necessary to change the definition of \.
6828 % Non-ASCII encodings make 8-bit characters active, so un-activate
6829 % them to avoid their expansion. Must do this non-globally, to
6830 % confine the change to the current group.
6832 % It's necessary to have hard CRs when the macro is executed. This is
6833 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
6834 % body, and then making it the \newlinechar in \scanmacro.
6836 \def\scanctxt{%
6837 \catcode`\"=\other
6838 \catcode`\+=\other
6839 \catcode`\<=\other
6840 \catcode`\>=\other
6841 \catcode`\@=\other
6842 \catcode`\^=\other
6843 \catcode`\_=\other
6844 \catcode`\|=\other
6845 \catcode`\~=\other
6846 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
6849 \def\scanargctxt{%
6850 \scanctxt
6851 \catcode`\\=\other
6852 \catcode`\^^M=\other
6855 \def\macrobodyctxt{%
6856 \scanctxt
6857 \catcode`\{=\other
6858 \catcode`\}=\other
6859 \catcode`\^^M=\other
6860 \usembodybackslash
6863 \def\macroargctxt{%
6864 \scanctxt
6865 \catcode`\\=\other
6868 % \mbodybackslash is the definition of \ in @macro bodies.
6869 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6870 % where N is the macro parameter number.
6871 % We define \csname macarg.\endcsname to be \realbackslash, so
6872 % \\ in macro replacement text gets you a backslash.
6874 {\catcode`@=0 @catcode`@\=@active
6875 @gdef@usembodybackslash{@let\=@mbodybackslash}
6876 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6878 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6880 \def\macro{\recursivefalse\parsearg\macroxxx}
6881 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6883 \def\macroxxx#1{%
6884 \getargs{#1}% now \macname is the macname and \argl the arglist
6885 \ifx\argl\empty % no arguments
6886 \paramno=0%
6887 \else
6888 \expandafter\parsemargdef \argl;%
6890 \if1\csname ismacro.\the\macname\endcsname
6891 \message{Warning: redefining \the\macname}%
6892 \else
6893 \expandafter\ifx\csname \the\macname\endcsname \relax
6894 \else \errmessage{Macro name \the\macname\space already defined}\fi
6895 \global\cslet{macsave.\the\macname}{\the\macname}%
6896 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6897 \addtomacrolist{\the\macname}%
6899 \begingroup \macrobodyctxt
6900 \ifrecursive \expandafter\parsermacbody
6901 \else \expandafter\parsemacbody
6902 \fi}
6904 \parseargdef\unmacro{%
6905 \if1\csname ismacro.#1\endcsname
6906 \global\cslet{#1}{macsave.#1}%
6907 \global\expandafter\let \csname ismacro.#1\endcsname=0%
6908 % Remove the macro name from \macrolist:
6909 \begingroup
6910 \expandafter\let\csname#1\endcsname \relax
6911 \let\definedummyword\unmacrodo
6912 \xdef\macrolist{\macrolist}%
6913 \endgroup
6914 \else
6915 \errmessage{Macro #1 not defined}%
6919 % Called by \do from \dounmacro on each macro. The idea is to omit any
6920 % macro definitions that have been changed to \relax.
6922 \def\unmacrodo#1{%
6923 \ifx #1\relax
6924 % remove this
6925 \else
6926 \noexpand\definedummyword \noexpand#1%
6930 % This makes use of the obscure feature that if the last token of a
6931 % <parameter list> is #, then the preceding argument is delimited by
6932 % an opening brace, and that opening brace is not consumed.
6933 \def\getargs#1{\getargsxxx#1{}}
6934 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
6935 \def\getmacname #1 #2\relax{\macname={#1}}
6936 \def\getmacargs#1{\def\argl{#1}}
6938 % Parse the optional {params} list. Set up \paramno and \paramlist
6939 % so \defmacro knows what to do. Define \macarg.blah for each blah
6940 % in the params list, to be ##N where N is the position in that list.
6941 % That gets used by \mbodybackslash (above).
6943 % We need to get `macro parameter char #' into several definitions.
6944 % The technique used is stolen from LaTeX: let \hash be something
6945 % unexpandable, insert that wherever you need a #, and then redefine
6946 % it to # just before using the token list produced.
6948 % The same technique is used to protect \eatspaces till just before
6949 % the macro is used.
6951 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
6952 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
6953 \def\parsemargdefxxx#1,{%
6954 \if#1;\let\next=\relax
6955 \else \let\next=\parsemargdefxxx
6956 \advance\paramno by 1%
6957 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
6958 {\xeatspaces{\hash\the\paramno}}%
6959 \edef\paramlist{\paramlist\hash\the\paramno,}%
6960 \fi\next}
6962 % These two commands read recursive and nonrecursive macro bodies.
6963 % (They're different since rec and nonrec macros end differently.)
6965 \long\def\parsemacbody#1@end macro%
6966 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6967 \long\def\parsermacbody#1@end rmacro%
6968 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6970 % This defines the macro itself. There are six cases: recursive and
6971 % nonrecursive macros of zero, one, and many arguments.
6972 % Much magic with \expandafter here.
6973 % \xdef is used so that macro definitions will survive the file
6974 % they're defined in; @include reads the file inside a group.
6975 \def\defmacro{%
6976 \let\hash=##% convert placeholders to macro parameter chars
6977 \ifrecursive
6978 \ifcase\paramno
6980 \expandafter\xdef\csname\the\macname\endcsname{%
6981 \noexpand\scanmacro{\temp}}%
6982 \or % 1
6983 \expandafter\xdef\csname\the\macname\endcsname{%
6984 \bgroup\noexpand\macroargctxt
6985 \noexpand\braceorline
6986 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6987 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6988 \egroup\noexpand\scanmacro{\temp}}%
6989 \else % many
6990 \expandafter\xdef\csname\the\macname\endcsname{%
6991 \bgroup\noexpand\macroargctxt
6992 \noexpand\csname\the\macname xx\endcsname}%
6993 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6994 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6995 \expandafter\expandafter
6996 \expandafter\xdef
6997 \expandafter\expandafter
6998 \csname\the\macname xxx\endcsname
6999 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7001 \else
7002 \ifcase\paramno
7004 \expandafter\xdef\csname\the\macname\endcsname{%
7005 \noexpand\norecurse{\the\macname}%
7006 \noexpand\scanmacro{\temp}\egroup}%
7007 \or % 1
7008 \expandafter\xdef\csname\the\macname\endcsname{%
7009 \bgroup\noexpand\macroargctxt
7010 \noexpand\braceorline
7011 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7012 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7013 \egroup
7014 \noexpand\norecurse{\the\macname}%
7015 \noexpand\scanmacro{\temp}\egroup}%
7016 \else % many
7017 \expandafter\xdef\csname\the\macname\endcsname{%
7018 \bgroup\noexpand\macroargctxt
7019 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7020 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7021 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7022 \expandafter\expandafter
7023 \expandafter\xdef
7024 \expandafter\expandafter
7025 \csname\the\macname xxx\endcsname
7026 \paramlist{%
7027 \egroup
7028 \noexpand\norecurse{\the\macname}%
7029 \noexpand\scanmacro{\temp}\egroup}%
7031 \fi}
7033 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7035 % \braceorline decides whether the next nonwhitespace character is a
7036 % {. If so it reads up to the closing }, if not, it reads the whole
7037 % line. Whatever was read is then fed to the next control sequence
7038 % as an argument (by \parsebrace or \parsearg)
7039 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7040 \def\braceorlinexxx{%
7041 \ifx\nchar\bgroup\else
7042 \expandafter\parsearg
7043 \fi \macnamexxx}
7046 % @alias.
7047 % We need some trickery to remove the optional spaces around the equal
7048 % sign. Just make them active and then expand them all to nothing.
7049 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7050 \def\aliasxxx #1{\aliasyyy#1\relax}
7051 \def\aliasyyy #1=#2\relax{%
7053 \expandafter\let\obeyedspace=\empty
7054 \addtomacrolist{#1}%
7055 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7057 \next
7061 \message{cross references,}
7063 \newwrite\auxfile
7064 \newif\ifhavexrefs % True if xref values are known.
7065 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7067 % @inforef is relatively simple.
7068 \def\inforef #1{\inforefzzz #1,,,,**}
7069 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7070 node \samp{\ignorespaces#1{}}}
7072 % @node's only job in TeX is to define \lastnode, which is used in
7073 % cross-references. The @node line might or might not have commas, and
7074 % might or might not have spaces before the first comma, like:
7075 % @node foo , bar , ...
7076 % We don't want such trailing spaces in the node name.
7078 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7080 % also remove a trailing comma, in case of something like this:
7081 % @node Help-Cross, , , Cross-refs
7082 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7083 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7085 \let\nwnode=\node
7086 \let\lastnode=\empty
7088 % Write a cross-reference definition for the current node. #1 is the
7089 % type (Ynumbered, Yappendix, Ynothing).
7091 \def\donoderef#1{%
7092 \ifx\lastnode\empty\else
7093 \setref{\lastnode}{#1}%
7094 \global\let\lastnode=\empty
7098 % @anchor{NAME} -- define xref target at arbitrary point.
7100 \newcount\savesfregister
7102 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7103 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7104 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7106 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7107 % anchor), which consists of three parts:
7108 % 1) NAME-title - the current sectioning name taken from \lastsection,
7109 % or the anchor name.
7110 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7111 % empty for anchors.
7112 % 3) NAME-pg - the page number.
7114 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7115 % floats, there is an additional part, which is not written here:
7116 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7118 \def\setref#1#2{%
7119 \pdfmkdest{#1}%
7120 \iflinks
7122 \atdummies % preserve commands, but don't expand them
7123 \edef\writexrdef##1##2{%
7124 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7125 ##1}{##2}}% these are parameters of \writexrdef
7127 \toks0 = \expandafter{\lastsection}%
7128 \immediate \writexrdef{title}{\the\toks0 }%
7129 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7130 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout
7135 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7136 % the node name, #2 the name of the Info cross-reference, #3 the printed
7137 % node name, #4 the name of the Info file, #5 the name of the printed
7138 % manual. All but the node name can be omitted.
7140 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7141 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7142 \def\ref#1{\xrefX[#1,,,,,,,]}
7143 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7144 \unsepspaces
7145 \def\printedmanual{\ignorespaces #5}%
7146 \def\printedrefname{\ignorespaces #3}%
7147 \setbox1=\hbox{\printedmanual\unskip}%
7148 \setbox0=\hbox{\printedrefname\unskip}%
7149 \ifdim \wd0 = 0pt
7150 % No printed node name was explicitly given.
7151 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
7152 % Use the node name inside the square brackets.
7153 \def\printedrefname{\ignorespaces #1}%
7154 \else
7155 % Use the actual chapter/section title appear inside
7156 % the square brackets. Use the real section title if we have it.
7157 \ifdim \wd1 > 0pt
7158 % It is in another manual, so we don't have it.
7159 \def\printedrefname{\ignorespaces #1}%
7160 \else
7161 \ifhavexrefs
7162 % We know the real title if we have the xref values.
7163 \def\printedrefname{\refx{#1-title}{}}%
7164 \else
7165 % Otherwise just copy the Info node name.
7166 \def\printedrefname{\ignorespaces #1}%
7167 \fi%
7172 % Make link in pdf output.
7173 \ifpdf
7174 {\indexnofonts
7175 \turnoffactive
7176 % This expands tokens, so do it after making catcode changes, so _
7177 % etc. don't get their TeX definitions.
7178 \getfilename{#4}%
7180 % See comments at \activebackslashdouble.
7181 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
7182 \backslashparens\pdfxrefdest}%
7184 \leavevmode
7185 \startlink attr{/Border [0 0 0]}%
7186 \ifnum\filenamelength>0
7187 goto file{\the\filename.pdf} name{\pdfxrefdest}%
7188 \else
7189 goto name{\pdfmkpgn{\pdfxrefdest}}%
7192 \setcolor{\linkcolor}%
7195 % Float references are printed completely differently: "Figure 1.2"
7196 % instead of "[somenode], p.3". We distinguish them by the
7197 % LABEL-title being set to a magic string.
7199 % Have to otherify everything special to allow the \csname to
7200 % include an _ in the xref name, etc.
7201 \indexnofonts
7202 \turnoffactive
7203 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7204 \csname XR#1-title\endcsname
7206 \iffloat\Xthisreftitle
7207 % If the user specified the print name (third arg) to the ref,
7208 % print it instead of our usual "Figure 1.2".
7209 \ifdim\wd0 = 0pt
7210 \refx{#1-snt}{}%
7211 \else
7212 \printedrefname
7215 % if the user also gave the printed manual name (fifth arg), append
7216 % "in MANUALNAME".
7217 \ifdim \wd1 > 0pt
7218 \space \putwordin{} \cite{\printedmanual}%
7220 \else
7221 % node/anchor (non-float) references.
7223 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7224 % insert empty discretionaries after hyphens, which means that it will
7225 % not find a line break at a hyphen in a node names. Since some manuals
7226 % are best written with fairly long node names, containing hyphens, this
7227 % is a loss. Therefore, we give the text of the node name again, so it
7228 % is as if TeX is seeing it for the first time.
7229 \ifdim \wd1 > 0pt
7230 \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7231 \else
7232 % _ (for example) has to be the character _ for the purposes of the
7233 % control sequence corresponding to the node, but it has to expand
7234 % into the usual \leavevmode...\vrule stuff for purposes of
7235 % printing. So we \turnoffactive for the \refx-snt, back on for the
7236 % printing, back off for the \refx-pg.
7237 {\turnoffactive
7238 % Only output a following space if the -snt ref is nonempty; for
7239 % @unnumbered and @anchor, it won't be.
7240 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7241 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7243 % output the `[mynode]' via a macro so it can be overridden.
7244 \xrefprintnodename\printedrefname
7246 % But we always want a comma and a space:
7247 ,\space
7249 % output the `page 3'.
7250 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7253 \endlink
7254 \endgroup}
7256 % This macro is called from \xrefX for the `[nodename]' part of xref
7257 % output. It's a separate macro only so it can be changed more easily,
7258 % since square brackets don't work well in some documents. Particularly
7259 % one that Bob is working on :).
7261 \def\xrefprintnodename#1{[#1]}
7263 % Things referred to by \setref.
7265 \def\Ynothing{}
7266 \def\Yomitfromtoc{}
7267 \def\Ynumbered{%
7268 \ifnum\secno=0
7269 \putwordChapter@tie \the\chapno
7270 \else \ifnum\subsecno=0
7271 \putwordSection@tie \the\chapno.\the\secno
7272 \else \ifnum\subsubsecno=0
7273 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7274 \else
7275 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7276 \fi\fi\fi
7278 \def\Yappendix{%
7279 \ifnum\secno=0
7280 \putwordAppendix@tie @char\the\appendixno{}%
7281 \else \ifnum\subsecno=0
7282 \putwordSection@tie @char\the\appendixno.\the\secno
7283 \else \ifnum\subsubsecno=0
7284 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7285 \else
7286 \putwordSection@tie
7287 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7288 \fi\fi\fi
7291 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7292 % If its value is nonempty, SUFFIX is output afterward.
7294 \def\refx#1#2{%
7296 \indexnofonts
7297 \otherbackslash
7298 \expandafter\global\expandafter\let\expandafter\thisrefX
7299 \csname XR#1\endcsname
7301 \ifx\thisrefX\relax
7302 % If not defined, say something at least.
7303 \angleleft un\-de\-fined\angleright
7304 \iflinks
7305 \ifhavexrefs
7306 \message{\linenumber Undefined cross reference `#1'.}%
7307 \else
7308 \ifwarnedxrefs\else
7309 \global\warnedxrefstrue
7310 \message{Cross reference values unknown; you must run TeX again.}%
7314 \else
7315 % It's defined, so just use it.
7316 \thisrefX
7318 #2% Output the suffix in any case.
7321 % This is the macro invoked by entries in the aux file. Usually it's
7322 % just a \def (we prepend XR to the control sequence name to avoid
7323 % collisions). But if this is a float type, we have more work to do.
7325 \def\xrdef#1#2{%
7326 {% The node name might contain 8-bit characters, which in our current
7327 % implementation are changed to commands like @'e. Don't let these
7328 % mess up the control sequence name.
7329 \indexnofonts
7330 \turnoffactive
7331 \xdef\safexrefname{#1}%
7334 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7336 % Was that xref control sequence that we just defined for a float?
7337 \expandafter\iffloat\csname XR\safexrefname\endcsname
7338 % it was a float, and we have the (safe) float type in \iffloattype.
7339 \expandafter\let\expandafter\floatlist
7340 \csname floatlist\iffloattype\endcsname
7342 % Is this the first time we've seen this float type?
7343 \expandafter\ifx\floatlist\relax
7344 \toks0 = {\do}% yes, so just \do
7345 \else
7346 % had it before, so preserve previous elements in list.
7347 \toks0 = \expandafter{\floatlist\do}%
7350 % Remember this xref in the control sequence \floatlistFLOATTYPE,
7351 % for later use in \listoffloats.
7352 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
7353 {\safexrefname}}%
7357 % Read the last existing aux file, if any. No error if none exists.
7359 \def\tryauxfile{%
7360 \openin 1 \jobname.aux
7361 \ifeof 1 \else
7362 \readdatafile{aux}%
7363 \global\havexrefstrue
7365 \closein 1
7368 \def\setupdatafile{%
7369 \catcode`\^^@=\other
7370 \catcode`\^^A=\other
7371 \catcode`\^^B=\other
7372 \catcode`\^^C=\other
7373 \catcode`\^^D=\other
7374 \catcode`\^^E=\other
7375 \catcode`\^^F=\other
7376 \catcode`\^^G=\other
7377 \catcode`\^^H=\other
7378 \catcode`\^^K=\other
7379 \catcode`\^^L=\other
7380 \catcode`\^^N=\other
7381 \catcode`\^^P=\other
7382 \catcode`\^^Q=\other
7383 \catcode`\^^R=\other
7384 \catcode`\^^S=\other
7385 \catcode`\^^T=\other
7386 \catcode`\^^U=\other
7387 \catcode`\^^V=\other
7388 \catcode`\^^W=\other
7389 \catcode`\^^X=\other
7390 \catcode`\^^Z=\other
7391 \catcode`\^^[=\other
7392 \catcode`\^^\=\other
7393 \catcode`\^^]=\other
7394 \catcode`\^^^=\other
7395 \catcode`\^^_=\other
7396 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
7397 % in xref tags, i.e., node names. But since ^^e4 notation isn't
7398 % supported in the main text, it doesn't seem desirable. Furthermore,
7399 % that is not enough: for node names that actually contain a ^
7400 % character, we would end up writing a line like this: 'xrdef {'hat
7401 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
7402 % argument, and \hat is not an expandable control sequence. It could
7403 % all be worked out, but why? Either we support ^^ or we don't.
7405 % The other change necessary for this was to define \auxhat:
7406 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
7407 % and then to call \auxhat in \setq.
7409 \catcode`\^=\other
7411 % Special characters. Should be turned off anyway, but...
7412 \catcode`\~=\other
7413 \catcode`\[=\other
7414 \catcode`\]=\other
7415 \catcode`\"=\other
7416 \catcode`\_=\other
7417 \catcode`\|=\other
7418 \catcode`\<=\other
7419 \catcode`\>=\other
7420 \catcode`\$=\other
7421 \catcode`\#=\other
7422 \catcode`\&=\other
7423 \catcode`\%=\other
7424 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
7426 % This is to support \ in node names and titles, since the \
7427 % characters end up in a \csname. It's easier than
7428 % leaving it active and making its active definition an actual \
7429 % character. What I don't understand is why it works in the *value*
7430 % of the xrdef. Seems like it should be a catcode12 \, and that
7431 % should not typeset properly. But it works, so I'm moving on for
7432 % now. --karl, 15jan04.
7433 \catcode`\\=\other
7435 % Make the characters 128-255 be printing characters.
7437 \count1=128
7438 \def\loop{%
7439 \catcode\count1=\other
7440 \advance\count1 by 1
7441 \ifnum \count1<256 \loop \fi
7445 % @ is our escape character in .aux files, and we need braces.
7446 \catcode`\{=1
7447 \catcode`\}=2
7448 \catcode`\@=0
7451 \def\readdatafile#1{%
7452 \begingroup
7453 \setupdatafile
7454 \input\jobname.#1
7455 \endgroup}
7458 \message{insertions,}
7459 % including footnotes.
7461 \newcount \footnoteno
7463 % The trailing space in the following definition for supereject is
7464 % vital for proper filling; pages come out unaligned when you do a
7465 % pagealignmacro call if that space before the closing brace is
7466 % removed. (Generally, numeric constants should always be followed by a
7467 % space to prevent strange expansion errors.)
7468 \def\supereject{\par\penalty -20000\footnoteno =0 }
7470 % @footnotestyle is meaningful for info output only.
7471 \let\footnotestyle=\comment
7473 {\catcode `\@=11
7475 % Auto-number footnotes. Otherwise like plain.
7476 \gdef\footnote{%
7477 \let\indent=\ptexindent
7478 \let\noindent=\ptexnoindent
7479 \global\advance\footnoteno by \@ne
7480 \edef\thisfootno{$^{\the\footnoteno}$}%
7482 % In case the footnote comes at the end of a sentence, preserve the
7483 % extra spacing after we do the footnote number.
7484 \let\@sf\empty
7485 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
7487 % Remove inadvertent blank space before typesetting the footnote number.
7488 \unskip
7489 \thisfootno\@sf
7490 \dofootnote
7493 % Don't bother with the trickery in plain.tex to not require the
7494 % footnote text as a parameter. Our footnotes don't need to be so general.
7496 % Oh yes, they do; otherwise, @ifset (and anything else that uses
7497 % \parseargline) fails inside footnotes because the tokens are fixed when
7498 % the footnote is read. --karl, 16nov96.
7500 \gdef\dofootnote{%
7501 \insert\footins\bgroup
7502 % We want to typeset this text as a normal paragraph, even if the
7503 % footnote reference occurs in (for example) a display environment.
7504 % So reset some parameters.
7505 \hsize=\pagewidth
7506 \interlinepenalty\interfootnotelinepenalty
7507 \splittopskip\ht\strutbox % top baseline for broken footnotes
7508 \splitmaxdepth\dp\strutbox
7509 \floatingpenalty\@MM
7510 \leftskip\z@skip
7511 \rightskip\z@skip
7512 \spaceskip\z@skip
7513 \xspaceskip\z@skip
7514 \parindent\defaultparindent
7516 \smallfonts \rm
7518 % Because we use hanging indentation in footnotes, a @noindent appears
7519 % to exdent this text, so make it be a no-op. makeinfo does not use
7520 % hanging indentation so @noindent can still be needed within footnote
7521 % text after an @example or the like (not that this is good style).
7522 \let\noindent = \relax
7524 % Hang the footnote text off the number. Use \everypar in case the
7525 % footnote extends for more than one paragraph.
7526 \everypar = {\hang}%
7527 \textindent{\thisfootno}%
7529 % Don't crash into the line above the footnote text. Since this
7530 % expands into a box, it must come within the paragraph, lest it
7531 % provide a place where TeX can split the footnote.
7532 \footstrut
7533 \futurelet\next\fo@t
7535 }%end \catcode `\@=11
7537 % In case a @footnote appears in a vbox, save the footnote text and create
7538 % the real \insert just after the vbox finished. Otherwise, the insertion
7539 % would be lost.
7540 % Similarly, if a @footnote appears inside an alignment, save the footnote
7541 % text to a box and make the \insert when a row of the table is finished.
7542 % And the same can be done for other insert classes. --kasal, 16nov03.
7544 % Replace the \insert primitive by a cheating macro.
7545 % Deeper inside, just make sure that the saved insertions are not spilled
7546 % out prematurely.
7548 \def\startsavinginserts{%
7549 \ifx \insert\ptexinsert
7550 \let\insert\saveinsert
7551 \else
7552 \let\checkinserts\relax
7556 % This \insert replacement works for both \insert\footins{foo} and
7557 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
7559 \def\saveinsert#1{%
7560 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
7561 \afterassignment\next
7562 % swallow the left brace
7563 \let\temp =
7565 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
7566 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
7568 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
7570 \def\placesaveins#1{%
7571 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
7572 {\box#1}%
7575 % eat @SAVE -- beware, all of them have catcode \other:
7577 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
7578 \gdef\gobblesave @SAVE{}
7581 % initialization:
7582 \def\newsaveins #1{%
7583 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
7584 \next
7586 \def\newsaveinsX #1{%
7587 \csname newbox\endcsname #1%
7588 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7589 \checksaveins #1}%
7592 % initialize:
7593 \let\checkinserts\empty
7594 \newsaveins\footins
7595 \newsaveins\margin
7598 % @image. We use the macros from epsf.tex to support this.
7599 % If epsf.tex is not installed and @image is used, we complain.
7601 % Check for and read epsf.tex up front. If we read it only at @image
7602 % time, we might be inside a group, and then its definitions would get
7603 % undone and the next image would fail.
7604 \openin 1 = epsf.tex
7605 \ifeof 1 \else
7606 % Do not bother showing banner with epsf.tex v2.7k (available in
7607 % doc/epsf.tex and on ctan).
7608 \def\epsfannounce{\toks0 = }%
7609 \input epsf.tex
7611 \closein 1
7613 % We will only complain once about lack of epsf.tex.
7614 \newif\ifwarnednoepsf
7615 \newhelp\noepsfhelp{epsf.tex must be installed for images to
7616 work. It is also included in the Texinfo distribution, or you can get
7617 it from ftp://tug.org/tex/epsf.tex.}
7619 \def\image#1{%
7620 \ifx\epsfbox\undefined
7621 \ifwarnednoepsf \else
7622 \errhelp = \noepsfhelp
7623 \errmessage{epsf.tex not found, images will be ignored}%
7624 \global\warnednoepsftrue
7626 \else
7627 \imagexxx #1,,,,,\finish
7631 % Arguments to @image:
7632 % #1 is (mandatory) image filename; we tack on .eps extension.
7633 % #2 is (optional) width, #3 is (optional) height.
7634 % #4 is (ignored optional) html alt text.
7635 % #5 is (ignored optional) extension.
7636 % #6 is just the usual extra ignored arg for parsing this stuff.
7637 \newif\ifimagevmode
7638 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7639 \catcode`\^^M = 5 % in case we're inside an example
7640 \normalturnoffactive % allow _ et al. in names
7641 % If the image is by itself, center it.
7642 \ifvmode
7643 \imagevmodetrue
7644 \nobreak\medskip
7645 % Usually we'll have text after the image which will insert
7646 % \parskip glue, so insert it here too to equalize the space
7647 % above and below.
7648 \nobreak\vskip\parskip
7649 \nobreak
7652 % Leave vertical mode so that indentation from an enclosing
7653 % environment such as @quotation is respected. On the other hand, if
7654 % it's at the top level, we don't want the normal paragraph indentation.
7655 \noindent
7657 % Output the image.
7658 \ifpdf
7659 \dopdfimage{#1}{#2}{#3}%
7660 \else
7661 % \epsfbox itself resets \epsf?size at each figure.
7662 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
7663 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7664 \epsfbox{#1.eps}%
7667 \ifimagevmode \medskip \fi % space after the standalone image
7668 \endgroup}
7671 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7672 % etc. We don't actually implement floating yet, we always include the
7673 % float "here". But it seemed the best name for the future.
7675 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7677 % There may be a space before second and/or third parameter; delete it.
7678 \def\eatcommaspace#1, {#1,}
7680 % #1 is the optional FLOATTYPE, the text label for this float, typically
7681 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
7682 % this float will not be numbered and cannot be referred to.
7684 % #2 is the optional xref label. Also must be present for the float to
7685 % be referable.
7687 % #3 is the optional positioning argument; for now, it is ignored. It
7688 % will somehow specify the positions allowed to float to (here, top, bottom).
7690 % We keep a separate counter for each FLOATTYPE, which we reset at each
7691 % chapter-level command.
7692 \let\resetallfloatnos=\empty
7694 \def\dofloat#1,#2,#3,#4\finish{%
7695 \let\thiscaption=\empty
7696 \let\thisshortcaption=\empty
7698 % don't lose footnotes inside @float.
7700 % BEWARE: when the floats start float, we have to issue warning whenever an
7701 % insert appears inside a float which could possibly float. --kasal, 26may04
7703 \startsavinginserts
7705 % We can't be used inside a paragraph.
7706 \par
7708 \vtop\bgroup
7709 \def\floattype{#1}%
7710 \def\floatlabel{#2}%
7711 \def\floatloc{#3}% we do nothing with this yet.
7713 \ifx\floattype\empty
7714 \let\safefloattype=\empty
7715 \else
7717 % the floattype might have accents or other special characters,
7718 % but we need to use it in a control sequence name.
7719 \indexnofonts
7720 \turnoffactive
7721 \xdef\safefloattype{\floattype}%
7725 % If label is given but no type, we handle that as the empty type.
7726 \ifx\floatlabel\empty \else
7727 % We want each FLOATTYPE to be numbered separately (Figure 1,
7728 % Table 1, Figure 2, ...). (And if no label, no number.)
7730 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7731 \global\advance\floatno by 1
7734 % This magic value for \lastsection is output by \setref as the
7735 % XREFLABEL-title value. \xrefX uses it to distinguish float
7736 % labels (which have a completely different output format) from
7737 % node and anchor labels. And \xrdef uses it to construct the
7738 % lists of floats.
7740 \edef\lastsection{\floatmagic=\safefloattype}%
7741 \setref{\floatlabel}{Yfloat}%
7745 % start with \parskip glue, I guess.
7746 \vskip\parskip
7748 % Don't suppress indentation if a float happens to start a section.
7749 \restorefirstparagraphindent
7752 % we have these possibilities:
7753 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7754 % @float Foo,lbl & no caption: Foo 1.1
7755 % @float Foo & @caption{Cap}: Foo: Cap
7756 % @float Foo & no caption: Foo
7757 % @float ,lbl & Caption{Cap}: 1.1: Cap
7758 % @float ,lbl & no caption: 1.1
7759 % @float & @caption{Cap}: Cap
7760 % @float & no caption:
7762 \def\Efloat{%
7763 \let\floatident = \empty
7765 % In all cases, if we have a float type, it comes first.
7766 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7768 % If we have an xref label, the number comes next.
7769 \ifx\floatlabel\empty \else
7770 \ifx\floattype\empty \else % if also had float type, need tie first.
7771 \appendtomacro\floatident{\tie}%
7773 % the number.
7774 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
7777 % Start the printed caption with what we've constructed in
7778 % \floatident, but keep it separate; we need \floatident again.
7779 \let\captionline = \floatident
7781 \ifx\thiscaption\empty \else
7782 \ifx\floatident\empty \else
7783 \appendtomacro\captionline{: }% had ident, so need a colon between
7786 % caption text.
7787 \appendtomacro\captionline{\scanexp\thiscaption}%
7790 % If we have anything to print, print it, with space before.
7791 % Eventually this needs to become an \insert.
7792 \ifx\captionline\empty \else
7793 \vskip.5\parskip
7794 \captionline
7796 % Space below caption.
7797 \vskip\parskip
7800 % If have an xref label, write the list of floats info. Do this
7801 % after the caption, to avoid chance of it being a breakpoint.
7802 \ifx\floatlabel\empty \else
7803 % Write the text that goes in the lof to the aux file as
7804 % \floatlabel-lof. Besides \floatident, we include the short
7805 % caption if specified, else the full caption if specified, else nothing.
7807 \atdummies
7809 % since we read the caption text in the macro world, where ^^M
7810 % is turned into a normal character, we have to scan it back, so
7811 % we don't write the literal three characters "^^M" into the aux file.
7812 \scanexp{%
7813 \xdef\noexpand\gtemp{%
7814 \ifx\thisshortcaption\empty
7815 \thiscaption
7816 \else
7817 \thisshortcaption
7821 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7822 \ifx\gtemp\empty \else : \gtemp \fi}}%
7825 \egroup % end of \vtop
7827 % place the captured inserts
7829 % BEWARE: when the floats start floating, we have to issue warning
7830 % whenever an insert appears inside a float which could possibly
7831 % float. --kasal, 26may04
7833 \checkinserts
7836 % Append the tokens #2 to the definition of macro #1, not expanding either.
7838 \def\appendtomacro#1#2{%
7839 \expandafter\def\expandafter#1\expandafter{#1#2}%
7842 % @caption, @shortcaption
7844 \def\caption{\docaption\thiscaption}
7845 \def\shortcaption{\docaption\thisshortcaption}
7846 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7847 \def\defcaption#1#2{\egroup \def#1{#2}}
7849 % The parameter is the control sequence identifying the counter we are
7850 % going to use. Create it if it doesn't exist and assign it to \floatno.
7851 \def\getfloatno#1{%
7852 \ifx#1\relax
7853 % Haven't seen this figure type before.
7854 \csname newcount\endcsname #1%
7856 % Remember to reset this floatno at the next chap.
7857 \expandafter\gdef\expandafter\resetallfloatnos
7858 \expandafter{\resetallfloatnos #1=0 }%
7860 \let\floatno#1%
7863 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
7864 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
7865 % first read the @float command.
7867 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7869 % Magic string used for the XREFLABEL-title value, so \xrefX can
7870 % distinguish floats from other xref types.
7871 \def\floatmagic{!!float!!}
7873 % #1 is the control sequence we are passed; we expand into a conditional
7874 % which is true if #1 represents a float ref. That is, the magic
7875 % \lastsection value which we \setref above.
7877 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7879 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
7880 % (safe) float type for this float. We set \iffloattype to #2.
7882 \def\doiffloat#1=#2=#3\finish{%
7883 \def\temp{#1}%
7884 \def\iffloattype{#2}%
7885 \ifx\temp\floatmagic
7888 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7890 \parseargdef\listoffloats{%
7891 \def\floattype{#1}% floattype
7893 % the floattype might have accents or other special characters,
7894 % but we need to use it in a control sequence name.
7895 \indexnofonts
7896 \turnoffactive
7897 \xdef\safefloattype{\floattype}%
7900 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7901 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7902 \ifhavexrefs
7903 % if the user said @listoffloats foo but never @float foo.
7904 \message{\linenumber No `\safefloattype' floats to list.}%
7906 \else
7907 \begingroup
7908 \leftskip=\tocindent % indent these entries like a toc
7909 \let\do=\listoffloatsdo
7910 \csname floatlist\safefloattype\endcsname
7911 \endgroup
7915 % This is called on each entry in a list of floats. We're passed the
7916 % xref label, in the form LABEL-title, which is how we save it in the
7917 % aux file. We strip off the -title and look up \XRLABEL-lof, which
7918 % has the text we're supposed to typeset here.
7920 % Figures without xref labels will not be included in the list (since
7921 % they won't appear in the aux file).
7923 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7924 \def\listoffloatsdoentry#1-title\finish{{%
7925 % Can't fully expand XR#1-lof because it can contain anything. Just
7926 % pass the control sequence. On the other hand, XR#1-pg is just the
7927 % page number, and we want to fully expand that so we can get a link
7928 % in pdf output.
7929 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
7931 % use the same \entry macro we use to generate the TOC and index.
7932 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7933 \writeentry
7937 \message{localization,}
7939 % For single-language documents, @documentlanguage is usually given very
7940 % early, just after @documentencoding. Single argument is the language
7941 % (de) or locale (de_DE) abbreviation.
7944 \catcode`\_ = \active
7945 \globaldefs=1
7946 \parseargdef\documentlanguage{\begingroup
7947 \let_=\normalunderscore % normal _ character for filenames
7948 \tex % read txi-??.tex file in plain TeX.
7949 % Read the file by the name they passed if it exists.
7950 \openin 1 txi-#1.tex
7951 \ifeof 1
7952 \documentlanguagetrywithoutunderscore{#1_\finish}%
7953 \else
7954 \globaldefs = 1 % everything in the txi-LL files needs to persist
7955 \input txi-#1.tex
7957 \closein 1
7958 \endgroup % end raw TeX
7959 \endgroup}
7962 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
7963 % try txi-de.tex.
7965 \def\documentlanguagetrywithoutunderscore#1_#2\finish{%
7966 \openin 1 txi-#1.tex
7967 \ifeof 1
7968 \errhelp = \nolanghelp
7969 \errmessage{Cannot read language file txi-#1.tex}%
7970 \else
7971 \input txi-#1.tex
7973 \closein 1
7976 \newhelp\nolanghelp{The given language definition file cannot be found or
7977 is empty. Maybe you need to install it? Putting it in the current
7978 directory should work if nowhere else does.}
7980 % This macro is called from txi-??.tex files; the first argument is the
7981 % \language name to set (without the "\lang@" prefix), the second and
7982 % third args are \{left,right}hyphenmin.
7984 % The language names to pass are determined when the format is built.
7985 % See the etex.log file created at that time, e.g.,
7986 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
7988 % With TeX Live 2008, etex now includes hyphenation patterns for all
7989 % available languages. This means we can support hyphenation in
7990 % Texinfo, at least to some extent. (This still doesn't solve the
7991 % accented characters problem.)
7993 \catcode`@=11
7994 \def\txisetlanguage#1#2#3{%
7995 % do not set the language if the name is undefined in the current TeX.
7996 \expandafter\ifx\csname lang@#1\endcsname \relax
7997 \message{no patterns for #1}%
7998 \else
7999 \global\language = \csname lang@#1\endcsname
8001 % but there is no harm in adjusting the hyphenmin values regardless.
8002 \global\lefthyphenmin = #2\relax
8003 \global\righthyphenmin = #3\relax
8006 % Helpers for encodings.
8007 % Set the catcode of characters 128 through 255 to the specified number.
8009 \def\setnonasciicharscatcode#1{%
8010 \count255=128
8011 \loop\ifnum\count255<256
8012 \global\catcode\count255=#1\relax
8013 \advance\count255 by 1
8014 \repeat
8017 \def\setnonasciicharscatcodenonglobal#1{%
8018 \count255=128
8019 \loop\ifnum\count255<256
8020 \catcode\count255=#1\relax
8021 \advance\count255 by 1
8022 \repeat
8025 % @documentencoding sets the definition of non-ASCII characters
8026 % according to the specified encoding.
8028 \parseargdef\documentencoding{%
8029 % Encoding being declared for the document.
8030 \def\declaredencoding{\csname #1.enc\endcsname}%
8032 % Supported encodings: names converted to tokens in order to be able
8033 % to compare them with \ifx.
8034 \def\ascii{\csname US-ASCII.enc\endcsname}%
8035 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8036 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8037 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8038 \def\utfeight{\csname UTF-8.enc\endcsname}%
8040 \ifx \declaredencoding \ascii
8041 \asciichardefs
8043 \else \ifx \declaredencoding \lattwo
8044 \setnonasciicharscatcode\active
8045 \lattwochardefs
8047 \else \ifx \declaredencoding \latone
8048 \setnonasciicharscatcode\active
8049 \latonechardefs
8051 \else \ifx \declaredencoding \latnine
8052 \setnonasciicharscatcode\active
8053 \latninechardefs
8055 \else \ifx \declaredencoding \utfeight
8056 \setnonasciicharscatcode\active
8057 \utfeightchardefs
8059 \else
8060 \message{Unknown document encoding #1, ignoring.}%
8062 \fi % utfeight
8063 \fi % latnine
8064 \fi % latone
8065 \fi % lattwo
8066 \fi % ascii
8069 % A message to be logged when using a character that isn't available
8070 % the default font encoding (OT1).
8072 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8074 % Take account of \c (plain) vs. \, (Texinfo) difference.
8075 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8077 % First, make active non-ASCII characters in order for them to be
8078 % correctly categorized when TeX reads the replacement text of
8079 % macros containing the character definitions.
8080 \setnonasciicharscatcode\active
8082 % Latin1 (ISO-8859-1) character definitions.
8083 \def\latonechardefs{%
8084 \gdef^^a0{~}
8085 \gdef^^a1{\exclamdown}
8086 \gdef^^a2{\missingcharmsg{CENT SIGN}}
8087 \gdef^^a3{{\pounds}}
8088 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8089 \gdef^^a5{\missingcharmsg{YEN SIGN}}
8090 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8091 \gdef^^a7{\S}
8092 \gdef^^a8{\"{}}
8093 \gdef^^a9{\copyright}
8094 \gdef^^aa{\ordf}
8095 \gdef^^ab{\guillemetleft}
8096 \gdef^^ac{$\lnot$}
8097 \gdef^^ad{\-}
8098 \gdef^^ae{\registeredsymbol}
8099 \gdef^^af{\={}}
8101 \gdef^^b0{\textdegree}
8102 \gdef^^b1{$\pm$}
8103 \gdef^^b2{$^2$}
8104 \gdef^^b3{$^3$}
8105 \gdef^^b4{\'{}}
8106 \gdef^^b5{$\mu$}
8107 \gdef^^b6{\P}
8109 \gdef^^b7{$^.$}
8110 \gdef^^b8{\cedilla\ }
8111 \gdef^^b9{$^1$}
8112 \gdef^^ba{\ordm}
8114 \gdef^^bb{\guilletright}
8115 \gdef^^bc{$1\over4$}
8116 \gdef^^bd{$1\over2$}
8117 \gdef^^be{$3\over4$}
8118 \gdef^^bf{\questiondown}
8120 \gdef^^c0{\`A}
8121 \gdef^^c1{\'A}
8122 \gdef^^c2{\^A}
8123 \gdef^^c3{\~A}
8124 \gdef^^c4{\"A}
8125 \gdef^^c5{\ringaccent A}
8126 \gdef^^c6{\AE}
8127 \gdef^^c7{\cedilla C}
8128 \gdef^^c8{\`E}
8129 \gdef^^c9{\'E}
8130 \gdef^^ca{\^E}
8131 \gdef^^cb{\"E}
8132 \gdef^^cc{\`I}
8133 \gdef^^cd{\'I}
8134 \gdef^^ce{\^I}
8135 \gdef^^cf{\"I}
8137 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER ETH}}
8138 \gdef^^d1{\~N}
8139 \gdef^^d2{\`O}
8140 \gdef^^d3{\'O}
8141 \gdef^^d4{\^O}
8142 \gdef^^d5{\~O}
8143 \gdef^^d6{\"O}
8144 \gdef^^d7{$\times$}
8145 \gdef^^d8{\O}
8146 \gdef^^d9{\`U}
8147 \gdef^^da{\'U}
8148 \gdef^^db{\^U}
8149 \gdef^^dc{\"U}
8150 \gdef^^dd{\'Y}
8151 \gdef^^de{\missingcharmsg{LATIN CAPITAL LETTER THORN}}
8152 \gdef^^df{\ss}
8154 \gdef^^e0{\`a}
8155 \gdef^^e1{\'a}
8156 \gdef^^e2{\^a}
8157 \gdef^^e3{\~a}
8158 \gdef^^e4{\"a}
8159 \gdef^^e5{\ringaccent a}
8160 \gdef^^e6{\ae}
8161 \gdef^^e7{\cedilla c}
8162 \gdef^^e8{\`e}
8163 \gdef^^e9{\'e}
8164 \gdef^^ea{\^e}
8165 \gdef^^eb{\"e}
8166 \gdef^^ec{\`{\dotless i}}
8167 \gdef^^ed{\'{\dotless i}}
8168 \gdef^^ee{\^{\dotless i}}
8169 \gdef^^ef{\"{\dotless i}}
8171 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER ETH}}
8172 \gdef^^f1{\~n}
8173 \gdef^^f2{\`o}
8174 \gdef^^f3{\'o}
8175 \gdef^^f4{\^o}
8176 \gdef^^f5{\~o}
8177 \gdef^^f6{\"o}
8178 \gdef^^f7{$\div$}
8179 \gdef^^f8{\o}
8180 \gdef^^f9{\`u}
8181 \gdef^^fa{\'u}
8182 \gdef^^fb{\^u}
8183 \gdef^^fc{\"u}
8184 \gdef^^fd{\'y}
8185 \gdef^^fe{\missingcharmsg{LATIN SMALL LETTER THORN}}
8186 \gdef^^ff{\"y}
8189 % Latin9 (ISO-8859-15) encoding character definitions.
8190 \def\latninechardefs{%
8191 % Encoding is almost identical to Latin1.
8192 \latonechardefs
8194 \gdef^^a4{\euro}
8195 \gdef^^a6{\v S}
8196 \gdef^^a8{\v s}
8197 \gdef^^b4{\v Z}
8198 \gdef^^b8{\v z}
8199 \gdef^^bc{\OE}
8200 \gdef^^bd{\oe}
8201 \gdef^^be{\"Y}
8204 % Latin2 (ISO-8859-2) character definitions.
8205 \def\lattwochardefs{%
8206 \gdef^^a0{~}
8207 \gdef^^a1{\ogonek{A}}
8208 \gdef^^a2{\u{}}
8209 \gdef^^a3{\L}
8210 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8211 \gdef^^a5{\v L}
8212 \gdef^^a6{\'S}
8213 \gdef^^a7{\S}
8214 \gdef^^a8{\"{}}
8215 \gdef^^a9{\v S}
8216 \gdef^^aa{\cedilla S}
8217 \gdef^^ab{\v T}
8218 \gdef^^ac{\'Z}
8219 \gdef^^ad{\-}
8220 \gdef^^ae{\v Z}
8221 \gdef^^af{\dotaccent Z}
8223 \gdef^^b0{\textdegree}
8224 \gdef^^b1{\ogonek{a}}
8225 \gdef^^b2{\ogonek{ }}
8226 \gdef^^b3{\l}
8227 \gdef^^b4{\'{}}
8228 \gdef^^b5{\v l}
8229 \gdef^^b6{\'s}
8230 \gdef^^b7{\v{}}
8231 \gdef^^b8{\cedilla\ }
8232 \gdef^^b9{\v s}
8233 \gdef^^ba{\cedilla s}
8234 \gdef^^bb{\v t}
8235 \gdef^^bc{\'z}
8236 \gdef^^bd{\H{}}
8237 \gdef^^be{\v z}
8238 \gdef^^bf{\dotaccent z}
8240 \gdef^^c0{\'R}
8241 \gdef^^c1{\'A}
8242 \gdef^^c2{\^A}
8243 \gdef^^c3{\u A}
8244 \gdef^^c4{\"A}
8245 \gdef^^c5{\'L}
8246 \gdef^^c6{\'C}
8247 \gdef^^c7{\cedilla C}
8248 \gdef^^c8{\v C}
8249 \gdef^^c9{\'E}
8250 \gdef^^ca{\ogonek{E}}
8251 \gdef^^cb{\"E}
8252 \gdef^^cc{\v E}
8253 \gdef^^cd{\'I}
8254 \gdef^^ce{\^I}
8255 \gdef^^cf{\v D}
8257 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER D WITH STROKE}}
8258 \gdef^^d1{\'N}
8259 \gdef^^d2{\v N}
8260 \gdef^^d3{\'O}
8261 \gdef^^d4{\^O}
8262 \gdef^^d5{\H O}
8263 \gdef^^d6{\"O}
8264 \gdef^^d7{$\times$}
8265 \gdef^^d8{\v R}
8266 \gdef^^d9{\ringaccent U}
8267 \gdef^^da{\'U}
8268 \gdef^^db{\H U}
8269 \gdef^^dc{\"U}
8270 \gdef^^dd{\'Y}
8271 \gdef^^de{\cedilla T}
8272 \gdef^^df{\ss}
8274 \gdef^^e0{\'r}
8275 \gdef^^e1{\'a}
8276 \gdef^^e2{\^a}
8277 \gdef^^e3{\u a}
8278 \gdef^^e4{\"a}
8279 \gdef^^e5{\'l}
8280 \gdef^^e6{\'c}
8281 \gdef^^e7{\cedilla c}
8282 \gdef^^e8{\v c}
8283 \gdef^^e9{\'e}
8284 \gdef^^ea{\ogonek{e}}
8285 \gdef^^eb{\"e}
8286 \gdef^^ec{\v e}
8287 \gdef^^ed{\'\i}
8288 \gdef^^ee{\^\i}
8289 \gdef^^ef{\v d}
8291 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER D WITH STROKE}}
8292 \gdef^^f1{\'n}
8293 \gdef^^f2{\v n}
8294 \gdef^^f3{\'o}
8295 \gdef^^f4{\^o}
8296 \gdef^^f5{\H o}
8297 \gdef^^f6{\"o}
8298 \gdef^^f7{$\div$}
8299 \gdef^^f8{\v r}
8300 \gdef^^f9{\ringaccent u}
8301 \gdef^^fa{\'u}
8302 \gdef^^fb{\H u}
8303 \gdef^^fc{\"u}
8304 \gdef^^fd{\'y}
8305 \gdef^^fe{\cedilla t}
8306 \gdef^^ff{\dotaccent{}}
8309 % UTF-8 character definitions.
8311 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8312 % changes for Texinfo conventions. It is included here under the GPL by
8313 % permission from Frank Mittelbach and the LaTeX team.
8315 \newcount\countUTFx
8316 \newcount\countUTFy
8317 \newcount\countUTFz
8319 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8320 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8322 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8323 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8325 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8326 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8328 \gdef\UTFviiiDefined#1{%
8329 \ifx #1\relax
8330 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8331 \else
8332 \expandafter #1%
8336 \begingroup
8337 \catcode`\~13
8338 \catcode`\"12
8340 \def\UTFviiiLoop{%
8341 \global\catcode\countUTFx\active
8342 \uccode`\~\countUTFx
8343 \uppercase\expandafter{\UTFviiiTmp}%
8344 \advance\countUTFx by 1
8345 \ifnum\countUTFx < \countUTFy
8346 \expandafter\UTFviiiLoop
8347 \fi}
8349 \countUTFx = "C2
8350 \countUTFy = "E0
8351 \def\UTFviiiTmp{%
8352 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
8353 \UTFviiiLoop
8355 \countUTFx = "E0
8356 \countUTFy = "F0
8357 \def\UTFviiiTmp{%
8358 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
8359 \UTFviiiLoop
8361 \countUTFx = "F0
8362 \countUTFy = "F4
8363 \def\UTFviiiTmp{%
8364 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
8365 \UTFviiiLoop
8366 \endgroup
8368 \begingroup
8369 \catcode`\"=12
8370 \catcode`\<=12
8371 \catcode`\.=12
8372 \catcode`\,=12
8373 \catcode`\;=12
8374 \catcode`\!=12
8375 \catcode`\~=13
8377 \gdef\DeclareUnicodeCharacter#1#2{%
8378 \countUTFz = "#1\relax
8379 \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
8380 \begingroup
8381 \parseXMLCharref
8382 \def\UTFviiiTwoOctets##1##2{%
8383 \csname u8:##1\string ##2\endcsname}%
8384 \def\UTFviiiThreeOctets##1##2##3{%
8385 \csname u8:##1\string ##2\string ##3\endcsname}%
8386 \def\UTFviiiFourOctets##1##2##3##4{%
8387 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
8388 \expandafter\expandafter\expandafter\expandafter
8389 \expandafter\expandafter\expandafter
8390 \gdef\UTFviiiTmp{#2}%
8391 \endgroup}
8393 \gdef\parseXMLCharref{%
8394 \ifnum\countUTFz < "A0\relax
8395 \errhelp = \EMsimple
8396 \errmessage{Cannot define Unicode char value < 00A0}%
8397 \else\ifnum\countUTFz < "800\relax
8398 \parseUTFviiiA,%
8399 \parseUTFviiiB C\UTFviiiTwoOctets.,%
8400 \else\ifnum\countUTFz < "10000\relax
8401 \parseUTFviiiA;%
8402 \parseUTFviiiA,%
8403 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
8404 \else
8405 \parseUTFviiiA;%
8406 \parseUTFviiiA,%
8407 \parseUTFviiiA!%
8408 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
8409 \fi\fi\fi
8412 \gdef\parseUTFviiiA#1{%
8413 \countUTFx = \countUTFz
8414 \divide\countUTFz by 64
8415 \countUTFy = \countUTFz
8416 \multiply\countUTFz by 64
8417 \advance\countUTFx by -\countUTFz
8418 \advance\countUTFx by 128
8419 \uccode `#1\countUTFx
8420 \countUTFz = \countUTFy}
8422 \gdef\parseUTFviiiB#1#2#3#4{%
8423 \advance\countUTFz by "#10\relax
8424 \uccode `#3\countUTFz
8425 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
8426 \endgroup
8428 \def\utfeightchardefs{%
8429 \DeclareUnicodeCharacter{00A0}{\tie}
8430 \DeclareUnicodeCharacter{00A1}{\exclamdown}
8431 \DeclareUnicodeCharacter{00A3}{\pounds}
8432 \DeclareUnicodeCharacter{00A8}{\"{ }}
8433 \DeclareUnicodeCharacter{00A9}{\copyright}
8434 \DeclareUnicodeCharacter{00AA}{\ordf}
8435 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
8436 \DeclareUnicodeCharacter{00AD}{\-}
8437 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
8438 \DeclareUnicodeCharacter{00AF}{\={ }}
8440 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
8441 \DeclareUnicodeCharacter{00B4}{\'{ }}
8442 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
8443 \DeclareUnicodeCharacter{00BA}{\ordm}
8444 \DeclareUnicodeCharacter{00BB}{\guillemetright}
8445 \DeclareUnicodeCharacter{00BF}{\questiondown}
8447 \DeclareUnicodeCharacter{00C0}{\`A}
8448 \DeclareUnicodeCharacter{00C1}{\'A}
8449 \DeclareUnicodeCharacter{00C2}{\^A}
8450 \DeclareUnicodeCharacter{00C3}{\~A}
8451 \DeclareUnicodeCharacter{00C4}{\"A}
8452 \DeclareUnicodeCharacter{00C5}{\AA}
8453 \DeclareUnicodeCharacter{00C6}{\AE}
8454 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
8455 \DeclareUnicodeCharacter{00C8}{\`E}
8456 \DeclareUnicodeCharacter{00C9}{\'E}
8457 \DeclareUnicodeCharacter{00CA}{\^E}
8458 \DeclareUnicodeCharacter{00CB}{\"E}
8459 \DeclareUnicodeCharacter{00CC}{\`I}
8460 \DeclareUnicodeCharacter{00CD}{\'I}
8461 \DeclareUnicodeCharacter{00CE}{\^I}
8462 \DeclareUnicodeCharacter{00CF}{\"I}
8464 \DeclareUnicodeCharacter{00D1}{\~N}
8465 \DeclareUnicodeCharacter{00D2}{\`O}
8466 \DeclareUnicodeCharacter{00D3}{\'O}
8467 \DeclareUnicodeCharacter{00D4}{\^O}
8468 \DeclareUnicodeCharacter{00D5}{\~O}
8469 \DeclareUnicodeCharacter{00D6}{\"O}
8470 \DeclareUnicodeCharacter{00D8}{\O}
8471 \DeclareUnicodeCharacter{00D9}{\`U}
8472 \DeclareUnicodeCharacter{00DA}{\'U}
8473 \DeclareUnicodeCharacter{00DB}{\^U}
8474 \DeclareUnicodeCharacter{00DC}{\"U}
8475 \DeclareUnicodeCharacter{00DD}{\'Y}
8476 \DeclareUnicodeCharacter{00DF}{\ss}
8478 \DeclareUnicodeCharacter{00E0}{\`a}
8479 \DeclareUnicodeCharacter{00E1}{\'a}
8480 \DeclareUnicodeCharacter{00E2}{\^a}
8481 \DeclareUnicodeCharacter{00E3}{\~a}
8482 \DeclareUnicodeCharacter{00E4}{\"a}
8483 \DeclareUnicodeCharacter{00E5}{\aa}
8484 \DeclareUnicodeCharacter{00E6}{\ae}
8485 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
8486 \DeclareUnicodeCharacter{00E8}{\`e}
8487 \DeclareUnicodeCharacter{00E9}{\'e}
8488 \DeclareUnicodeCharacter{00EA}{\^e}
8489 \DeclareUnicodeCharacter{00EB}{\"e}
8490 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
8491 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
8492 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
8493 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
8495 \DeclareUnicodeCharacter{00F1}{\~n}
8496 \DeclareUnicodeCharacter{00F2}{\`o}
8497 \DeclareUnicodeCharacter{00F3}{\'o}
8498 \DeclareUnicodeCharacter{00F4}{\^o}
8499 \DeclareUnicodeCharacter{00F5}{\~o}
8500 \DeclareUnicodeCharacter{00F6}{\"o}
8501 \DeclareUnicodeCharacter{00F8}{\o}
8502 \DeclareUnicodeCharacter{00F9}{\`u}
8503 \DeclareUnicodeCharacter{00FA}{\'u}
8504 \DeclareUnicodeCharacter{00FB}{\^u}
8505 \DeclareUnicodeCharacter{00FC}{\"u}
8506 \DeclareUnicodeCharacter{00FD}{\'y}
8507 \DeclareUnicodeCharacter{00FF}{\"y}
8509 \DeclareUnicodeCharacter{0100}{\=A}
8510 \DeclareUnicodeCharacter{0101}{\=a}
8511 \DeclareUnicodeCharacter{0102}{\u{A}}
8512 \DeclareUnicodeCharacter{0103}{\u{a}}
8513 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
8514 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
8515 \DeclareUnicodeCharacter{0106}{\'C}
8516 \DeclareUnicodeCharacter{0107}{\'c}
8517 \DeclareUnicodeCharacter{0108}{\^C}
8518 \DeclareUnicodeCharacter{0109}{\^c}
8519 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
8520 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
8521 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
8522 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
8523 \DeclareUnicodeCharacter{010C}{\v{C}}
8524 \DeclareUnicodeCharacter{010D}{\v{c}}
8525 \DeclareUnicodeCharacter{010E}{\v{D}}
8527 \DeclareUnicodeCharacter{0112}{\=E}
8528 \DeclareUnicodeCharacter{0113}{\=e}
8529 \DeclareUnicodeCharacter{0114}{\u{E}}
8530 \DeclareUnicodeCharacter{0115}{\u{e}}
8531 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
8532 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
8533 \DeclareUnicodeCharacter{011A}{\v{E}}
8534 \DeclareUnicodeCharacter{011B}{\v{e}}
8535 \DeclareUnicodeCharacter{011C}{\^G}
8536 \DeclareUnicodeCharacter{011D}{\^g}
8537 \DeclareUnicodeCharacter{011E}{\u{G}}
8538 \DeclareUnicodeCharacter{011F}{\u{g}}
8540 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8541 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8542 \DeclareUnicodeCharacter{0124}{\^H}
8543 \DeclareUnicodeCharacter{0125}{\^h}
8544 \DeclareUnicodeCharacter{0128}{\~I}
8545 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8546 \DeclareUnicodeCharacter{012A}{\=I}
8547 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8548 \DeclareUnicodeCharacter{012C}{\u{I}}
8549 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8551 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8552 \DeclareUnicodeCharacter{0131}{\dotless{i}}
8553 \DeclareUnicodeCharacter{0132}{IJ}
8554 \DeclareUnicodeCharacter{0133}{ij}
8555 \DeclareUnicodeCharacter{0134}{\^J}
8556 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8557 \DeclareUnicodeCharacter{0139}{\'L}
8558 \DeclareUnicodeCharacter{013A}{\'l}
8560 \DeclareUnicodeCharacter{0141}{\L}
8561 \DeclareUnicodeCharacter{0142}{\l}
8562 \DeclareUnicodeCharacter{0143}{\'N}
8563 \DeclareUnicodeCharacter{0144}{\'n}
8564 \DeclareUnicodeCharacter{0147}{\v{N}}
8565 \DeclareUnicodeCharacter{0148}{\v{n}}
8566 \DeclareUnicodeCharacter{014C}{\=O}
8567 \DeclareUnicodeCharacter{014D}{\=o}
8568 \DeclareUnicodeCharacter{014E}{\u{O}}
8569 \DeclareUnicodeCharacter{014F}{\u{o}}
8571 \DeclareUnicodeCharacter{0150}{\H{O}}
8572 \DeclareUnicodeCharacter{0151}{\H{o}}
8573 \DeclareUnicodeCharacter{0152}{\OE}
8574 \DeclareUnicodeCharacter{0153}{\oe}
8575 \DeclareUnicodeCharacter{0154}{\'R}
8576 \DeclareUnicodeCharacter{0155}{\'r}
8577 \DeclareUnicodeCharacter{0158}{\v{R}}
8578 \DeclareUnicodeCharacter{0159}{\v{r}}
8579 \DeclareUnicodeCharacter{015A}{\'S}
8580 \DeclareUnicodeCharacter{015B}{\'s}
8581 \DeclareUnicodeCharacter{015C}{\^S}
8582 \DeclareUnicodeCharacter{015D}{\^s}
8583 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8584 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8586 \DeclareUnicodeCharacter{0160}{\v{S}}
8587 \DeclareUnicodeCharacter{0161}{\v{s}}
8588 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8589 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8590 \DeclareUnicodeCharacter{0164}{\v{T}}
8592 \DeclareUnicodeCharacter{0168}{\~U}
8593 \DeclareUnicodeCharacter{0169}{\~u}
8594 \DeclareUnicodeCharacter{016A}{\=U}
8595 \DeclareUnicodeCharacter{016B}{\=u}
8596 \DeclareUnicodeCharacter{016C}{\u{U}}
8597 \DeclareUnicodeCharacter{016D}{\u{u}}
8598 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8599 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8601 \DeclareUnicodeCharacter{0170}{\H{U}}
8602 \DeclareUnicodeCharacter{0171}{\H{u}}
8603 \DeclareUnicodeCharacter{0174}{\^W}
8604 \DeclareUnicodeCharacter{0175}{\^w}
8605 \DeclareUnicodeCharacter{0176}{\^Y}
8606 \DeclareUnicodeCharacter{0177}{\^y}
8607 \DeclareUnicodeCharacter{0178}{\"Y}
8608 \DeclareUnicodeCharacter{0179}{\'Z}
8609 \DeclareUnicodeCharacter{017A}{\'z}
8610 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8611 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8612 \DeclareUnicodeCharacter{017D}{\v{Z}}
8613 \DeclareUnicodeCharacter{017E}{\v{z}}
8615 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8616 \DeclareUnicodeCharacter{01C5}{D\v{z}}
8617 \DeclareUnicodeCharacter{01C6}{d\v{z}}
8618 \DeclareUnicodeCharacter{01C7}{LJ}
8619 \DeclareUnicodeCharacter{01C8}{Lj}
8620 \DeclareUnicodeCharacter{01C9}{lj}
8621 \DeclareUnicodeCharacter{01CA}{NJ}
8622 \DeclareUnicodeCharacter{01CB}{Nj}
8623 \DeclareUnicodeCharacter{01CC}{nj}
8624 \DeclareUnicodeCharacter{01CD}{\v{A}}
8625 \DeclareUnicodeCharacter{01CE}{\v{a}}
8626 \DeclareUnicodeCharacter{01CF}{\v{I}}
8628 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8629 \DeclareUnicodeCharacter{01D1}{\v{O}}
8630 \DeclareUnicodeCharacter{01D2}{\v{o}}
8631 \DeclareUnicodeCharacter{01D3}{\v{U}}
8632 \DeclareUnicodeCharacter{01D4}{\v{u}}
8634 \DeclareUnicodeCharacter{01E2}{\={\AE}}
8635 \DeclareUnicodeCharacter{01E3}{\={\ae}}
8636 \DeclareUnicodeCharacter{01E6}{\v{G}}
8637 \DeclareUnicodeCharacter{01E7}{\v{g}}
8638 \DeclareUnicodeCharacter{01E8}{\v{K}}
8639 \DeclareUnicodeCharacter{01E9}{\v{k}}
8641 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8642 \DeclareUnicodeCharacter{01F1}{DZ}
8643 \DeclareUnicodeCharacter{01F2}{Dz}
8644 \DeclareUnicodeCharacter{01F3}{dz}
8645 \DeclareUnicodeCharacter{01F4}{\'G}
8646 \DeclareUnicodeCharacter{01F5}{\'g}
8647 \DeclareUnicodeCharacter{01F8}{\`N}
8648 \DeclareUnicodeCharacter{01F9}{\`n}
8649 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8650 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8651 \DeclareUnicodeCharacter{01FE}{\'{\O}}
8652 \DeclareUnicodeCharacter{01FF}{\'{\o}}
8654 \DeclareUnicodeCharacter{021E}{\v{H}}
8655 \DeclareUnicodeCharacter{021F}{\v{h}}
8657 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8658 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8659 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8660 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8661 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8662 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8664 \DeclareUnicodeCharacter{0232}{\=Y}
8665 \DeclareUnicodeCharacter{0233}{\=y}
8666 \DeclareUnicodeCharacter{0237}{\dotless{j}}
8668 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
8670 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8671 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8672 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8673 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8674 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8675 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8676 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8677 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8678 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8679 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8680 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8681 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8683 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8684 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8686 \DeclareUnicodeCharacter{1E20}{\=G}
8687 \DeclareUnicodeCharacter{1E21}{\=g}
8688 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8689 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8690 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8691 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8692 \DeclareUnicodeCharacter{1E26}{\"H}
8693 \DeclareUnicodeCharacter{1E27}{\"h}
8695 \DeclareUnicodeCharacter{1E30}{\'K}
8696 \DeclareUnicodeCharacter{1E31}{\'k}
8697 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8698 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8699 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8700 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8701 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8702 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8703 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8704 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8705 \DeclareUnicodeCharacter{1E3E}{\'M}
8706 \DeclareUnicodeCharacter{1E3F}{\'m}
8708 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8709 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8710 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8711 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8712 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8713 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8714 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8715 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8716 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8717 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8719 \DeclareUnicodeCharacter{1E54}{\'P}
8720 \DeclareUnicodeCharacter{1E55}{\'p}
8721 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8722 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8723 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8724 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8725 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8726 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8727 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8728 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8730 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8731 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8732 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8733 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8734 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8735 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8736 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8737 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8738 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8739 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8741 \DeclareUnicodeCharacter{1E7C}{\~V}
8742 \DeclareUnicodeCharacter{1E7D}{\~v}
8743 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8744 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8746 \DeclareUnicodeCharacter{1E80}{\`W}
8747 \DeclareUnicodeCharacter{1E81}{\`w}
8748 \DeclareUnicodeCharacter{1E82}{\'W}
8749 \DeclareUnicodeCharacter{1E83}{\'w}
8750 \DeclareUnicodeCharacter{1E84}{\"W}
8751 \DeclareUnicodeCharacter{1E85}{\"w}
8752 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8753 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8754 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8755 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8756 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8757 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8758 \DeclareUnicodeCharacter{1E8C}{\"X}
8759 \DeclareUnicodeCharacter{1E8D}{\"x}
8760 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8761 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8763 \DeclareUnicodeCharacter{1E90}{\^Z}
8764 \DeclareUnicodeCharacter{1E91}{\^z}
8765 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8766 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8767 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
8768 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
8769 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
8770 \DeclareUnicodeCharacter{1E97}{\"t}
8771 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
8772 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
8774 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
8775 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
8777 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
8778 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
8779 \DeclareUnicodeCharacter{1EBC}{\~E}
8780 \DeclareUnicodeCharacter{1EBD}{\~e}
8782 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
8783 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
8784 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
8785 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
8787 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
8788 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
8790 \DeclareUnicodeCharacter{1EF2}{\`Y}
8791 \DeclareUnicodeCharacter{1EF3}{\`y}
8792 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
8794 \DeclareUnicodeCharacter{1EF8}{\~Y}
8795 \DeclareUnicodeCharacter{1EF9}{\~y}
8797 \DeclareUnicodeCharacter{2013}{--}
8798 \DeclareUnicodeCharacter{2014}{---}
8799 \DeclareUnicodeCharacter{2018}{\quoteleft}
8800 \DeclareUnicodeCharacter{2019}{\quoteright}
8801 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
8802 \DeclareUnicodeCharacter{201C}{\quotedblleft}
8803 \DeclareUnicodeCharacter{201D}{\quotedblright}
8804 \DeclareUnicodeCharacter{201E}{\quotedblbase}
8805 \DeclareUnicodeCharacter{2022}{\bullet}
8806 \DeclareUnicodeCharacter{2026}{\dots}
8807 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
8808 \DeclareUnicodeCharacter{203A}{\guilsinglright}
8809 \DeclareUnicodeCharacter{20AC}{\euro}
8811 \DeclareUnicodeCharacter{2192}{\expansion}
8812 \DeclareUnicodeCharacter{21D2}{\result}
8814 \DeclareUnicodeCharacter{2212}{\minus}
8815 \DeclareUnicodeCharacter{2217}{\point}
8816 \DeclareUnicodeCharacter{2261}{\equiv}
8817 }% end of \utfeightchardefs
8820 % US-ASCII character definitions.
8821 \def\asciichardefs{% nothing need be done
8822 \relax
8825 % Make non-ASCII characters printable again for compatibility with
8826 % existing Texinfo documents that may use them, even without declaring a
8827 % document encoding.
8829 \setnonasciicharscatcode \other
8832 \message{formatting,}
8834 \newdimen\defaultparindent \defaultparindent = 15pt
8836 \chapheadingskip = 15pt plus 4pt minus 2pt
8837 \secheadingskip = 12pt plus 3pt minus 2pt
8838 \subsecheadingskip = 9pt plus 2pt minus 2pt
8840 % Prevent underfull vbox error messages.
8841 \vbadness = 10000
8843 % Don't be so finicky about underfull hboxes, either.
8844 \hbadness = 2000
8846 % Following George Bush, get rid of widows and orphans.
8847 \widowpenalty=10000
8848 \clubpenalty=10000
8850 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
8851 % using an old version of TeX, don't do anything. We want the amount of
8852 % stretch added to depend on the line length, hence the dependence on
8853 % \hsize. We call this whenever the paper size is set.
8855 \def\setemergencystretch{%
8856 \ifx\emergencystretch\thisisundefined
8857 % Allow us to assign to \emergencystretch anyway.
8858 \def\emergencystretch{\dimen0}%
8859 \else
8860 \emergencystretch = .15\hsize
8864 % Parameters in order: 1) textheight; 2) textwidth;
8865 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
8866 % 7) physical page height; 8) physical page width.
8868 % We also call \setleading{\textleading}, so the caller should define
8869 % \textleading. The caller should also set \parskip.
8871 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
8872 \voffset = #3\relax
8873 \topskip = #6\relax
8874 \splittopskip = \topskip
8876 \vsize = #1\relax
8877 \advance\vsize by \topskip
8878 \outervsize = \vsize
8879 \advance\outervsize by 2\topandbottommargin
8880 \pageheight = \vsize
8882 \hsize = #2\relax
8883 \outerhsize = \hsize
8884 \advance\outerhsize by 0.5in
8885 \pagewidth = \hsize
8887 \normaloffset = #4\relax
8888 \bindingoffset = #5\relax
8890 \ifpdf
8891 \pdfpageheight #7\relax
8892 \pdfpagewidth #8\relax
8893 % if we don't reset these, they will remain at "1 true in" of
8894 % whatever layout pdftex was dumped with.
8895 \pdfhorigin = 1 true in
8896 \pdfvorigin = 1 true in
8899 \setleading{\textleading}
8901 \parindent = \defaultparindent
8902 \setemergencystretch
8905 % @letterpaper (the default).
8906 \def\letterpaper{{\globaldefs = 1
8907 \parskip = 3pt plus 2pt minus 1pt
8908 \textleading = 13.2pt
8910 % If page is nothing but text, make it come out even.
8911 \internalpagesizes{607.2pt}{6in}% that's 46 lines
8912 {\voffset}{.25in}%
8913 {\bindingoffset}{36pt}%
8914 {11in}{8.5in}%
8917 % Use @smallbook to reset parameters for 7x9.25 trim size.
8918 \def\smallbook{{\globaldefs = 1
8919 \parskip = 2pt plus 1pt
8920 \textleading = 12pt
8922 \internalpagesizes{7.5in}{5in}%
8923 {-.2in}{0in}%
8924 {\bindingoffset}{16pt}%
8925 {9.25in}{7in}%
8927 \lispnarrowing = 0.3in
8928 \tolerance = 700
8929 \hfuzz = 1pt
8930 \contentsrightmargin = 0pt
8931 \defbodyindent = .5cm
8934 % Use @smallerbook to reset parameters for 6x9 trim size.
8935 % (Just testing, parameters still in flux.)
8936 \def\smallerbook{{\globaldefs = 1
8937 \parskip = 1.5pt plus 1pt
8938 \textleading = 12pt
8940 \internalpagesizes{7.4in}{4.8in}%
8941 {-.2in}{-.4in}%
8942 {0pt}{14pt}%
8943 {9in}{6in}%
8945 \lispnarrowing = 0.25in
8946 \tolerance = 700
8947 \hfuzz = 1pt
8948 \contentsrightmargin = 0pt
8949 \defbodyindent = .4cm
8952 % Use @afourpaper to print on European A4 paper.
8953 \def\afourpaper{{\globaldefs = 1
8954 \parskip = 3pt plus 2pt minus 1pt
8955 \textleading = 13.2pt
8957 % Double-side printing via postscript on Laserjet 4050
8958 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
8959 % To change the settings for a different printer or situation, adjust
8960 % \normaloffset until the front-side and back-side texts align. Then
8961 % do the same for \bindingoffset. You can set these for testing in
8962 % your texinfo source file like this:
8963 % @tex
8964 % \global\normaloffset = -6mm
8965 % \global\bindingoffset = 10mm
8966 % @end tex
8967 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
8968 {\voffset}{\hoffset}%
8969 {\bindingoffset}{44pt}%
8970 {297mm}{210mm}%
8972 \tolerance = 700
8973 \hfuzz = 1pt
8974 \contentsrightmargin = 0pt
8975 \defbodyindent = 5mm
8978 % Use @afivepaper to print on European A5 paper.
8979 % From romildo@urano.iceb.ufop.br, 2 July 2000.
8980 % He also recommends making @example and @lisp be small.
8981 \def\afivepaper{{\globaldefs = 1
8982 \parskip = 2pt plus 1pt minus 0.1pt
8983 \textleading = 12.5pt
8985 \internalpagesizes{160mm}{120mm}%
8986 {\voffset}{\hoffset}%
8987 {\bindingoffset}{8pt}%
8988 {210mm}{148mm}%
8990 \lispnarrowing = 0.2in
8991 \tolerance = 800
8992 \hfuzz = 1.2pt
8993 \contentsrightmargin = 0pt
8994 \defbodyindent = 2mm
8995 \tableindent = 12mm
8998 % A specific text layout, 24x15cm overall, intended for A4 paper.
8999 \def\afourlatex{{\globaldefs = 1
9000 \afourpaper
9001 \internalpagesizes{237mm}{150mm}%
9002 {\voffset}{4.6mm}%
9003 {\bindingoffset}{7mm}%
9004 {297mm}{210mm}%
9006 % Must explicitly reset to 0 because we call \afourpaper.
9007 \globaldefs = 0
9010 % Use @afourwide to print on A4 paper in landscape format.
9011 \def\afourwide{{\globaldefs = 1
9012 \afourpaper
9013 \internalpagesizes{241mm}{165mm}%
9014 {\voffset}{-2.95mm}%
9015 {\bindingoffset}{7mm}%
9016 {297mm}{210mm}%
9017 \globaldefs = 0
9020 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9021 % Perhaps we should allow setting the margins, \topskip, \parskip,
9022 % and/or leading, also. Or perhaps we should compute them somehow.
9024 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9025 \def\pagesizesyyy#1,#2,#3\finish{{%
9026 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9027 \globaldefs = 1
9029 \parskip = 3pt plus 2pt minus 1pt
9030 \setleading{\textleading}%
9032 \dimen0 = #1\relax
9033 \advance\dimen0 by \voffset
9035 \dimen2 = \hsize
9036 \advance\dimen2 by \normaloffset
9038 \internalpagesizes{#1}{\hsize}%
9039 {\voffset}{\normaloffset}%
9040 {\bindingoffset}{44pt}%
9041 {\dimen0}{\dimen2}%
9044 % Set default to letter.
9046 \letterpaper
9049 \message{and turning on texinfo input format.}
9051 % DEL is a comment character, in case @c does not suffice.
9052 \catcode`\^^? = 14
9054 % Define macros to output various characters with catcode for normal text.
9055 \catcode`\"=\other
9056 \catcode`\~=\other
9057 \catcode`\^=\other
9058 \catcode`\_=\other
9059 \catcode`\|=\other
9060 \catcode`\<=\other
9061 \catcode`\>=\other
9062 \catcode`\+=\other
9063 \catcode`\$=\other
9064 \def\normaldoublequote{"}
9065 \def\normaltilde{~}
9066 \def\normalcaret{^}
9067 \def\normalunderscore{_}
9068 \def\normalverticalbar{|}
9069 \def\normalless{<}
9070 \def\normalgreater{>}
9071 \def\normalplus{+}
9072 \def\normaldollar{$}%$ font-lock fix
9074 % This macro is used to make a character print one way in \tt
9075 % (where it can probably be output as-is), and another way in other fonts,
9076 % where something hairier probably needs to be done.
9078 % #1 is what to print if we are indeed using \tt; #2 is what to print
9079 % otherwise. Since all the Computer Modern typewriter fonts have zero
9080 % interword stretch (and shrink), and it is reasonable to expect all
9081 % typewriter fonts to have this, we can check that font parameter.
9083 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9085 % Same as above, but check for italic font. Actually this also catches
9086 % non-italic slanted fonts since it is impossible to distinguish them from
9087 % italic fonts. But since this is only used by $ and it uses \sl anyway
9088 % this is not a problem.
9089 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9091 % Turn off all special characters except @
9092 % (and those which the user can use as if they were ordinary).
9093 % Most of these we simply print from the \tt font, but for some, we can
9094 % use math or other variants that look better in normal text.
9096 \catcode`\"=\active
9097 \def\activedoublequote{{\tt\char34}}
9098 \let"=\activedoublequote
9099 \catcode`\~=\active
9100 \def~{{\tt\char126}}
9101 \chardef\hat=`\^
9102 \catcode`\^=\active
9103 \def^{{\tt \hat}}
9105 \catcode`\_=\active
9106 \def_{\ifusingtt\normalunderscore\_}
9107 \let\realunder=_
9108 % Subroutine for the previous macro.
9109 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9111 \catcode`\|=\active
9112 \def|{{\tt\char124}}
9113 \chardef \less=`\<
9114 \catcode`\<=\active
9115 \def<{{\tt \less}}
9116 \chardef \gtr=`\>
9117 \catcode`\>=\active
9118 \def>{{\tt \gtr}}
9119 \catcode`\+=\active
9120 \def+{{\tt \char 43}}
9121 \catcode`\$=\active
9122 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9124 % If a .fmt file is being used, characters that might appear in a file
9125 % name cannot be active until we have parsed the command line.
9126 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9127 % \otherifyactive is called near the end of this file.
9128 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9130 % Used sometimes to turn off (effectively) the active characters even after
9131 % parsing them.
9132 \def\turnoffactive{%
9133 \normalturnoffactive
9134 \otherbackslash
9137 \catcode`\@=0
9139 % \backslashcurfont outputs one backslash character in current font,
9140 % as in \char`\\.
9141 \global\chardef\backslashcurfont=`\\
9142 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
9144 % \realbackslash is an actual character `\' with catcode other, and
9145 % \doublebackslash is two of them (for the pdf outlines).
9146 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9148 % In texinfo, backslash is an active character; it prints the backslash
9149 % in fixed width font.
9150 \catcode`\\=\active
9151 @def@normalbackslash{{@tt@backslashcurfont}}
9152 % On startup, @fixbackslash assigns:
9153 % @let \ = @normalbackslash
9155 % \rawbackslash defines an active \ to do \backslashcurfont.
9156 % \otherbackslash defines an active \ to be a literal `\' character with
9157 % catcode other.
9158 @gdef@rawbackslash{@let\=@backslashcurfont}
9159 @gdef@otherbackslash{@let\=@realbackslash}
9161 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9162 % the literal character `\'.
9164 @def@normalturnoffactive{%
9165 @let\=@normalbackslash
9166 @let"=@normaldoublequote
9167 @let~=@normaltilde
9168 @let^=@normalcaret
9169 @let_=@normalunderscore
9170 @let|=@normalverticalbar
9171 @let<=@normalless
9172 @let>=@normalgreater
9173 @let+=@normalplus
9174 @let$=@normaldollar %$ font-lock fix
9175 @markupsetuplqdefault
9176 @markupsetuprqdefault
9177 @unsepspaces
9180 % Make _ and + \other characters, temporarily.
9181 % This is canceled by @fixbackslash.
9182 @otherifyactive
9184 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9185 % That is what \eatinput is for; after that, the `\' should revert to printing
9186 % a backslash.
9188 @gdef@eatinput input texinfo{@fixbackslash}
9189 @global@let\ = @eatinput
9191 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
9192 % the first `\' in the file would cause an error. This macro tries to fix
9193 % that, assuming it is called before the first `\' could plausibly occur.
9194 % Also turn back on active characters that might appear in the input
9195 % file name, in case not using a pre-dumped format.
9197 @gdef@fixbackslash{%
9198 @ifx\@eatinput @let\ = @normalbackslash @fi
9199 @catcode`+=@active
9200 @catcode`@_=@active
9203 % Say @foo, not \foo, in error messages.
9204 @escapechar = `@@
9206 % These look ok in all fonts, so just make them not special.
9207 @catcode`@& = @other
9208 @catcode`@# = @other
9209 @catcode`@% = @other
9211 @c Finally, make ` and ' active, so that txicodequoteundirected and
9212 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
9213 @c don't make ` and ' active, @code will not get them as active chars.
9214 @c Do this last of all since we use ` in the previous @catcode assignments.
9215 @catcode`@'=@active
9216 @catcode`@`=@active
9217 @markupsetuplqdefault
9218 @markupsetuprqdefault
9220 @c Local variables:
9221 @c eval: (add-hook 'write-file-hooks 'time-stamp)
9222 @c page-delimiter: "^\\\\message"
9223 @c time-stamp-start: "def\\\\texinfoversion{"
9224 @c time-stamp-format: "%:y-%02m-%02d.%02H"
9225 @c time-stamp-end: "}"
9226 @c End:
9228 @c vim:sw=2:
9230 @ignore
9231 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115
9232 @end ignore