ox: Store export options in :export-options porperty
[org-mode.git] / doc / texinfo.tex
blob0b958d3c212525947377f4a1c1ddc456578e51e9
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{2012-01-03.18}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007, 2008-2013 Free Software Foundation, Inc.
12 % This texinfo.tex file is free software: you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation, either version 3 of the
15 % License, or (at your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this program. If not, see <http://www.gnu.org/licenses/>.
25 % As a special exception, when this file is read by TeX when processing
26 % a Texinfo source document, you may use the result without
27 % restriction. (This 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
102 % If this character appears in an error message or help string, it
103 % starts a new line in the output.
104 \newlinechar = `^^J
106 % Use TeX 3.0's \inputlineno to get the line number, for better error
107 % messages, but if we're using an old version of TeX, don't do anything.
109 \ifx\inputlineno\thisisundefined
110 \let\linenumber = \empty % Pre-3.0.
111 \else
112 \def\linenumber{l.\the\inputlineno:\space}
115 % Set up fixed words for English if not already set.
116 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
117 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
118 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
119 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
120 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
121 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
122 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
123 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
124 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
125 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
126 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
127 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
128 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
129 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
130 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
131 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
132 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
133 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
134 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
136 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
137 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
138 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
139 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
140 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
141 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
142 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
143 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
144 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
145 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
146 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
147 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
149 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
150 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
151 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
152 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
153 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
155 % Since the category of space is not known, we have to be careful.
156 \chardef\spacecat = 10
157 \def\spaceisspace{\catcode`\ =\spacecat}
159 % sometimes characters are active, so we need control sequences.
160 \chardef\colonChar = `\:
161 \chardef\commaChar = `\,
162 \chardef\dashChar = `\-
163 \chardef\dotChar = `\.
164 \chardef\exclamChar= `\!
165 \chardef\lquoteChar= `\`
166 \chardef\questChar = `\?
167 \chardef\rquoteChar= `\'
168 \chardef\semiChar = `\;
169 \chardef\underChar = `\_
171 % Ignore a token.
173 \def\gobble#1{}
175 % The following is used inside several \edef's.
176 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
178 % Hyphenation fixes.
179 \hyphenation{
180 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
181 ap-pen-dix bit-map bit-maps
182 data-base data-bases eshell fall-ing half-way long-est man-u-script
183 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
184 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
185 spell-ing spell-ings
186 stand-alone strong-est time-stamp time-stamps which-ever white-space
187 wide-spread wrap-around
190 % Margin to add to right of even pages, to left of odd pages.
191 \newdimen\bindingoffset
192 \newdimen\normaloffset
193 \newdimen\pagewidth \newdimen\pageheight
195 % For a final copy, take out the rectangles
196 % that mark overfull boxes (in case you have decided
197 % that the text looks ok even though it passes the margin).
199 \def\finalout{\overfullrule=0pt}
201 % @| inserts a changebar to the left of the current line. It should
202 % surround any changed text. This approach does *not* work if the
203 % change spans more than two lines of output. To handle that, we would
204 % have adopt a much more difficult approach (putting marks into the main
205 % vertical list for the beginning and end of each change).
207 \def\|{%
208 % \vadjust can only be used in horizontal mode.
209 \leavevmode
211 % Append this vertical mode material after the current line in the output.
212 \vadjust{%
213 % We want to insert a rule with the height and depth of the current
214 % leading; that is exactly what \strutbox is supposed to record.
215 \vskip-\baselineskip
217 % \vadjust-items are inserted at the left edge of the type. So
218 % the \llap here moves out into the left-hand margin.
219 \llap{%
221 % For a thicker or thinner bar, change the `1pt'.
222 \vrule height\baselineskip width1pt
224 % This is the space between the bar and the text.
225 \hskip 12pt
230 % Sometimes it is convenient to have everything in the transcript file
231 % and nothing on the terminal. We don't just call \tracingall here,
232 % since that produces some useless output on the terminal. We also make
233 % some effort to order the tracing commands to reduce output in the log
234 % file; cf. trace.sty in LaTeX.
236 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
237 \def\loggingall{%
238 \tracingstats2
239 \tracingpages1
240 \tracinglostchars2 % 2 gives us more in etex
241 \tracingparagraphs1
242 \tracingoutput1
243 \tracingmacros2
244 \tracingrestores1
245 \showboxbreadth\maxdimen \showboxdepth\maxdimen
246 \ifx\eTeXversion\undefined\else % etex gives us more logging
247 \tracingscantokens1
248 \tracingifs1
249 \tracinggroups1
250 \tracingnesting2
251 \tracingassigns1
253 \tracingcommands3 % 3 gives us more in etex
254 \errorcontextlines16
257 % add check for \lastpenalty to plain's definitions. If the last thing
258 % we did was a \nobreak, we don't want to insert more space.
260 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
261 \removelastskip\penalty-50\smallskip\fi\fi}
262 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
263 \removelastskip\penalty-100\medskip\fi\fi}
264 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
265 \removelastskip\penalty-200\bigskip\fi\fi}
267 % For @cropmarks command.
268 % Do @cropmarks to get crop marks.
270 \newif\ifcropmarks
271 \let\cropmarks = \cropmarkstrue
273 % Dimensions to add cropmarks at corners.
274 % Added by P. A. MacKay, 12 Nov. 1986
276 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
277 \newdimen\cornerlong \cornerlong=1pc
278 \newdimen\cornerthick \cornerthick=.3pt
279 \newdimen\topandbottommargin \topandbottommargin=.75in
281 % Output a mark which sets \thischapter, \thissection and \thiscolor.
282 % We dump everything together because we only have one kind of mark.
283 % This works because we only use \botmark / \topmark, not \firstmark.
285 % A mark contains a subexpression of the \ifcase ... \fi construct.
286 % \get*marks macros below extract the needed part using \ifcase.
288 % Another complication is to let the user choose whether \thischapter
289 % (\thissection) refers to the chapter (section) in effect at the top
290 % of a page, or that at the bottom of a page. The solution is
291 % described on page 260 of The TeXbook. It involves outputting two
292 % marks for the sectioning macros, one before the section break, and
293 % one after. I won't pretend I can describe this better than DEK...
294 \def\domark{%
295 \toks0=\expandafter{\lastchapterdefs}%
296 \toks2=\expandafter{\lastsectiondefs}%
297 \toks4=\expandafter{\prevchapterdefs}%
298 \toks6=\expandafter{\prevsectiondefs}%
299 \toks8=\expandafter{\lastcolordefs}%
300 \mark{%
301 \the\toks0 \the\toks2
302 \noexpand\or \the\toks4 \the\toks6
303 \noexpand\else \the\toks8
306 % \topmark doesn't work for the very first chapter (after the title
307 % page or the contents), so we use \firstmark there -- this gets us
308 % the mark with the chapter defs, unless the user sneaks in, e.g.,
309 % @setcolor (or @url, or @link, etc.) between @contents and the very
310 % first @chapter.
311 \def\gettopheadingmarks{%
312 \ifcase0\topmark\fi
313 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
315 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
316 \def\getcolormarks{\ifcase2\topmark\fi}
318 % Avoid "undefined control sequence" errors.
319 \def\lastchapterdefs{}
320 \def\lastsectiondefs{}
321 \def\prevchapterdefs{}
322 \def\prevsectiondefs{}
323 \def\lastcolordefs{}
325 % Main output routine.
326 \chardef\PAGE = 255
327 \output = {\onepageout{\pagecontents\PAGE}}
329 \newbox\headlinebox
330 \newbox\footlinebox
332 % \onepageout takes a vbox as an argument. Note that \pagecontents
333 % does insertions, but you have to call it yourself.
334 \def\onepageout#1{%
335 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
337 \ifodd\pageno \advance\hoffset by \bindingoffset
338 \else \advance\hoffset by -\bindingoffset\fi
340 % Do this outside of the \shipout so @code etc. will be expanded in
341 % the headline as they should be, not taken literally (outputting ''code).
342 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
343 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
344 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
345 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
348 % Have to do this stuff outside the \shipout because we want it to
349 % take effect in \write's, yet the group defined by the \vbox ends
350 % before the \shipout runs.
352 \indexdummies % don't expand commands in the output.
353 \normalturnoffactive % \ in index entries must not stay \, e.g., if
354 % the page break happens to be in the middle of an example.
355 % We don't want .vr (or whatever) entries like this:
356 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
357 % "\acronym" won't work when it's read back in;
358 % it needs to be
359 % {\code {{\tt \backslashcurfont }acronym}
360 \shipout\vbox{%
361 % Do this early so pdf references go to the beginning of the page.
362 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
364 \ifcropmarks \vbox to \outervsize\bgroup
365 \hsize = \outerhsize
366 \vskip-\topandbottommargin
367 \vtop to0pt{%
368 \line{\ewtop\hfil\ewtop}%
369 \nointerlineskip
370 \line{%
371 \vbox{\moveleft\cornerthick\nstop}%
372 \hfill
373 \vbox{\moveright\cornerthick\nstop}%
375 \vss}%
376 \vskip\topandbottommargin
377 \line\bgroup
378 \hfil % center the page within the outer (page) hsize.
379 \ifodd\pageno\hskip\bindingoffset\fi
380 \vbox\bgroup
383 \unvbox\headlinebox
384 \pagebody{#1}%
385 \ifdim\ht\footlinebox > 0pt
386 % Only leave this space if the footline is nonempty.
387 % (We lessened \vsize for it in \oddfootingyyy.)
388 % The \baselineskip=24pt in plain's \makefootline has no effect.
389 \vskip 24pt
390 \unvbox\footlinebox
393 \ifcropmarks
394 \egroup % end of \vbox\bgroup
395 \hfil\egroup % end of (centering) \line\bgroup
396 \vskip\topandbottommargin plus1fill minus1fill
397 \boxmaxdepth = \cornerthick
398 \vbox to0pt{\vss
399 \line{%
400 \vbox{\moveleft\cornerthick\nsbot}%
401 \hfill
402 \vbox{\moveright\cornerthick\nsbot}%
404 \nointerlineskip
405 \line{\ewbot\hfil\ewbot}%
407 \egroup % \vbox from first cropmarks clause
409 }% end of \shipout\vbox
410 }% end of group with \indexdummies
411 \advancepageno
412 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
415 \newinsert\margin \dimen\margin=\maxdimen
417 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
418 {\catcode`\@ =11
419 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
420 % marginal hacks, juha@viisa.uucp (Juha Takala)
421 \ifvoid\margin\else % marginal info is present
422 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
423 \dimen@=\dp#1\relax \unvbox#1\relax
424 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
425 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
428 % Here are the rules for the cropmarks. Note that they are
429 % offset so that the space between them is truly \outerhsize or \outervsize
430 % (P. A. MacKay, 12 November, 1986)
432 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
433 \def\nstop{\vbox
434 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
435 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
436 \def\nsbot{\vbox
437 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
439 % Parse an argument, then pass it to #1. The argument is the rest of
440 % the input line (except we remove a trailing comment). #1 should be a
441 % macro which expects an ordinary undelimited TeX argument.
443 \def\parsearg{\parseargusing{}}
444 \def\parseargusing#1#2{%
445 \def\argtorun{#2}%
446 \begingroup
447 \obeylines
448 \spaceisspace
450 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
453 {\obeylines %
454 \gdef\parseargline#1^^M{%
455 \endgroup % End of the group started in \parsearg.
456 \argremovecomment #1\comment\ArgTerm%
460 % First remove any @comment, then any @c comment.
461 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
462 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
464 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
466 % \argremovec might leave us with trailing space, e.g.,
467 % @end itemize @c foo
468 % This space token undergoes the same procedure and is eventually removed
469 % by \finishparsearg.
471 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
472 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
473 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
474 \def\temp{#3}%
475 \ifx\temp\empty
476 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
477 \let\temp\finishparsearg
478 \else
479 \let\temp\argcheckspaces
481 % Put the space token in:
482 \temp#1 #3\ArgTerm
485 % If a _delimited_ argument is enclosed in braces, they get stripped; so
486 % to get _exactly_ the rest of the line, we had to prevent such situation.
487 % We prepended an \empty token at the very beginning and we expand it now,
488 % just before passing the control to \argtorun.
489 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
490 % either the null string, or it ends with \^^M---thus there is no danger
491 % that a pair of braces would be stripped.
493 % But first, we have to remove the trailing space token.
495 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
497 % \parseargdef\foo{...}
498 % is roughly equivalent to
499 % \def\foo{\parsearg\Xfoo}
500 % \def\Xfoo#1{...}
502 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
503 % favourite TeX trick. --kasal, 16nov03
505 \def\parseargdef#1{%
506 \expandafter \doparseargdef \csname\string#1\endcsname #1%
508 \def\doparseargdef#1#2{%
509 \def#2{\parsearg#1}%
510 \def#1##1%
513 % Several utility definitions with active space:
515 \obeyspaces
516 \gdef\obeyedspace{ }
518 % Make each space character in the input produce a normal interword
519 % space in the output. Don't allow a line break at this space, as this
520 % is used only in environments like @example, where each line of input
521 % should produce a line of output anyway.
523 \gdef\sepspaces{\obeyspaces\let =\tie}
525 % If an index command is used in an @example environment, any spaces
526 % therein should become regular spaces in the raw index file, not the
527 % expansion of \tie (\leavevmode \penalty \@M \ ).
528 \gdef\unsepspaces{\let =\space}
532 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
534 % Define the framework for environments in texinfo.tex. It's used like this:
536 % \envdef\foo{...}
537 % \def\Efoo{...}
539 % It's the responsibility of \envdef to insert \begingroup before the
540 % actual body; @end closes the group after calling \Efoo. \envdef also
541 % defines \thisenv, so the current environment is known; @end checks
542 % whether the environment name matches. The \checkenv macro can also be
543 % used to check whether the current environment is the one expected.
545 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
546 % are not treated as environments; they don't open a group. (The
547 % implementation of @end takes care not to call \endgroup in this
548 % special case.)
551 % At run-time, environments start with this:
552 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
553 % initialize
554 \let\thisenv\empty
556 % ... but they get defined via ``\envdef\foo{...}'':
557 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
558 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
560 % Check whether we're in the right environment:
561 \def\checkenv#1{%
562 \def\temp{#1}%
563 \ifx\thisenv\temp
564 \else
565 \badenverr
569 % Environment mismatch, #1 expected:
570 \def\badenverr{%
571 \errhelp = \EMsimple
572 \errmessage{This command can appear only \inenvironment\temp,
573 not \inenvironment\thisenv}%
575 \def\inenvironment#1{%
576 \ifx#1\empty
577 out of any environment%
578 \else
579 in environment \expandafter\string#1%
583 % @end foo executes the definition of \Efoo.
584 % But first, it executes a specialized version of \checkenv
586 \parseargdef\end{%
587 \if 1\csname iscond.#1\endcsname
588 \else
589 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
590 \expandafter\checkenv\csname#1\endcsname
591 \csname E#1\endcsname
592 \endgroup
596 \newhelp\EMsimple{Press RETURN to continue.}
599 %% Simple single-character @ commands
601 % @@ prints an @
602 % Kludge this until the fonts are right (grr).
603 \def\@{{\tt\char64}}
605 % This is turned off because it was never documented
606 % and you can use @w{...} around a quote to suppress ligatures.
607 %% Define @` and @' to be the same as ` and '
608 %% but suppressing ligatures.
609 %\def\`{{`}}
610 %\def\'{{'}}
612 % Used to generate quoted braces.
613 \def\mylbrace {{\tt\char123}}
614 \def\myrbrace {{\tt\char125}}
615 \let\{=\mylbrace
616 \let\}=\myrbrace
617 \begingroup
618 % Definitions to produce \{ and \} commands for indices,
619 % and @{ and @} for the aux/toc files.
620 \catcode`\{ = \other \catcode`\} = \other
621 \catcode`\[ = 1 \catcode`\] = 2
622 \catcode`\! = 0 \catcode`\\ = \other
623 !gdef!lbracecmd[\{]%
624 !gdef!rbracecmd[\}]%
625 !gdef!lbraceatcmd[@{]%
626 !gdef!rbraceatcmd[@}]%
627 !endgroup
629 % @comma{} to avoid , parsing problems.
630 \let\comma = ,
632 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
633 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
634 \let\, = \c
635 \let\dotaccent = \.
636 \def\ringaccent#1{{\accent23 #1}}
637 \let\tieaccent = \t
638 \let\ubaraccent = \b
639 \let\udotaccent = \d
641 % Other special characters: @questiondown @exclamdown @ordf @ordm
642 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
643 \def\questiondown{?`}
644 \def\exclamdown{!`}
645 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
646 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
648 % Dotless i and dotless j, used for accents.
649 \def\imacro{i}
650 \def\jmacro{j}
651 \def\dotless#1{%
652 \def\temp{#1}%
653 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
654 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
655 \else \errmessage{@dotless can be used only with i or j}%
656 \fi\fi
659 % The \TeX{} logo, as in plain, but resetting the spacing so that a
660 % period following counts as ending a sentence. (Idea found in latex.)
662 \edef\TeX{\TeX \spacefactor=1000 }
664 % @LaTeX{} logo. Not quite the same results as the definition in
665 % latex.ltx, since we use a different font for the raised A; it's most
666 % convenient for us to use an explicitly smaller font, rather than using
667 % the \scriptstyle font (since we don't reset \scriptstyle and
668 % \scriptscriptstyle).
670 \def\LaTeX{%
671 L\kern-.36em
672 {\setbox0=\hbox{T}%
673 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
674 \kern-.15em
675 \TeX
678 % Be sure we're in horizontal mode when doing a tie, since we make space
679 % equivalent to this in @example-like environments. Otherwise, a space
680 % at the beginning of a line will start with \penalty -- and
681 % since \penalty is valid in vertical mode, we'd end up putting the
682 % penalty on the vertical list instead of in the new paragraph.
683 {\catcode`@ = 11
684 % Avoid using \@M directly, because that causes trouble
685 % if the definition is written into an index file.
686 \global\let\tiepenalty = \@M
687 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
690 % @: forces normal size whitespace following.
691 \def\:{\spacefactor=1000 }
693 % @* forces a line break.
694 \def\*{\hfil\break\hbox{}\ignorespaces}
696 % @/ allows a line break.
697 \let\/=\allowbreak
699 % @. is an end-of-sentence period.
700 \def\.{.\spacefactor=\endofsentencespacefactor\space}
702 % @! is an end-of-sentence bang.
703 \def\!{!\spacefactor=\endofsentencespacefactor\space}
705 % @? is an end-of-sentence query.
706 \def\?{?\spacefactor=\endofsentencespacefactor\space}
708 % @frenchspacing on|off says whether to put extra space after punctuation.
710 \def\onword{on}
711 \def\offword{off}
713 \parseargdef\frenchspacing{%
714 \def\temp{#1}%
715 \ifx\temp\onword \plainfrenchspacing
716 \else\ifx\temp\offword \plainnonfrenchspacing
717 \else
718 \errhelp = \EMsimple
719 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
720 \fi\fi
723 % @w prevents a word break. Without the \leavevmode, @w at the
724 % beginning of a paragraph, when TeX is still in vertical mode, would
725 % produce a whole line of output instead of starting the paragraph.
726 \def\w#1{\leavevmode\hbox{#1}}
728 % @group ... @end group forces ... to be all on one page, by enclosing
729 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
730 % to keep its height that of a normal line. According to the rules for
731 % \topskip (p.114 of the TeXbook), the glue inserted is
732 % max (\topskip - \ht (first item), 0). If that height is large,
733 % therefore, no glue is inserted, and the space between the headline and
734 % the text is small, which looks bad.
736 % Another complication is that the group might be very large. This can
737 % cause the glue on the previous page to be unduly stretched, because it
738 % does not have much material. In this case, it's better to add an
739 % explicit \vfill so that the extra space is at the bottom. The
740 % threshold for doing this is if the group is more than \vfilllimit
741 % percent of a page (\vfilllimit can be changed inside of @tex).
743 \newbox\groupbox
744 \def\vfilllimit{0.7}
746 \envdef\group{%
747 \ifnum\catcode`\^^M=\active \else
748 \errhelp = \groupinvalidhelp
749 \errmessage{@group invalid in context where filling is enabled}%
751 \startsavinginserts
753 \setbox\groupbox = \vtop\bgroup
754 % Do @comment since we are called inside an environment such as
755 % @example, where each end-of-line in the input causes an
756 % end-of-line in the output. We don't want the end-of-line after
757 % the `@group' to put extra space in the output. Since @group
758 % should appear on a line by itself (according to the Texinfo
759 % manual), we don't worry about eating any user text.
760 \comment
763 % The \vtop produces a box with normal height and large depth; thus, TeX puts
764 % \baselineskip glue before it, and (when the next line of text is done)
765 % \lineskip glue after it. Thus, space below is not quite equal to space
766 % above. But it's pretty close.
767 \def\Egroup{%
768 % To get correct interline space between the last line of the group
769 % and the first line afterwards, we have to propagate \prevdepth.
770 \endgraf % Not \par, as it may have been set to \lisppar.
771 \global\dimen1 = \prevdepth
772 \egroup % End the \vtop.
773 % \dimen0 is the vertical size of the group's box.
774 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
775 % \dimen2 is how much space is left on the page (more or less).
776 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
777 % if the group doesn't fit on the current page, and it's a big big
778 % group, force a page break.
779 \ifdim \dimen0 > \dimen2
780 \ifdim \pagetotal < \vfilllimit\pageheight
781 \page
784 \box\groupbox
785 \prevdepth = \dimen1
786 \checkinserts
789 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
790 % message, so this ends up printing `@group can only ...'.
792 \newhelp\groupinvalidhelp{%
793 group can only be used in environments such as @example,^^J%
794 where each line of input produces a line of output.}
796 % @need space-in-mils
797 % forces a page break if there is not space-in-mils remaining.
799 \newdimen\mil \mil=0.001in
801 % Old definition--didn't work.
802 %\parseargdef\need{\par %
803 %% This method tries to make TeX break the page naturally
804 %% if the depth of the box does not fit.
805 %{\baselineskip=0pt%
806 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
807 %\prevdepth=-1000pt
810 \parseargdef\need{%
811 % Ensure vertical mode, so we don't make a big box in the middle of a
812 % paragraph.
813 \par
815 % If the @need value is less than one line space, it's useless.
816 \dimen0 = #1\mil
817 \dimen2 = \ht\strutbox
818 \advance\dimen2 by \dp\strutbox
819 \ifdim\dimen0 > \dimen2
821 % Do a \strut just to make the height of this box be normal, so the
822 % normal leading is inserted relative to the preceding line.
823 % And a page break here is fine.
824 \vtop to #1\mil{\strut\vfil}%
826 % TeX does not even consider page breaks if a penalty added to the
827 % main vertical list is 10000 or more. But in order to see if the
828 % empty box we just added fits on the page, we must make it consider
829 % page breaks. On the other hand, we don't want to actually break the
830 % page after the empty box. So we use a penalty of 9999.
832 % There is an extremely small chance that TeX will actually break the
833 % page at this \penalty, if there are no other feasible breakpoints in
834 % sight. (If the user is using lots of big @group commands, which
835 % almost-but-not-quite fill up a page, TeX will have a hard time doing
836 % good page breaking, for example.) However, I could not construct an
837 % example where a page broke at this \penalty; if it happens in a real
838 % document, then we can reconsider our strategy.
839 \penalty9999
841 % Back up by the size of the box, whether we did a page break or not.
842 \kern -#1\mil
844 % Do not allow a page break right after this kern.
845 \nobreak
849 % @br forces paragraph break (and is undocumented).
851 \let\br = \par
853 % @page forces the start of a new page.
855 \def\page{\par\vfill\supereject}
857 % @exdent text....
858 % outputs text on separate line in roman font, starting at standard page margin
860 % This records the amount of indent in the innermost environment.
861 % That's how much \exdent should take out.
862 \newskip\exdentamount
864 % This defn is used inside fill environments such as @defun.
865 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
867 % This defn is used inside nofill environments such as @example.
868 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
869 \leftline{\hskip\leftskip{\rm#1}}}}
871 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
872 % paragraph. For more general purposes, use the \margin insertion
873 % class. WHICH is `l' or `r'.
875 \newskip\inmarginspacing \inmarginspacing=1cm
876 \def\strutdepth{\dp\strutbox}
878 \def\doinmargin#1#2{\strut\vadjust{%
879 \nobreak
880 \kern-\strutdepth
881 \vtop to \strutdepth{%
882 \baselineskip=\strutdepth
883 \vss
884 % if you have multiple lines of stuff to put here, you'll need to
885 % make the vbox yourself of the appropriate size.
886 \ifx#1l%
887 \llap{\ignorespaces #2\hskip\inmarginspacing}%
888 \else
889 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
891 \null
894 \def\inleftmargin{\doinmargin l}
895 \def\inrightmargin{\doinmargin r}
897 % @inmargin{TEXT [, RIGHT-TEXT]}
898 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
899 % else use TEXT for both).
901 \def\inmargin#1{\parseinmargin #1,,\finish}
902 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
903 \setbox0 = \hbox{\ignorespaces #2}%
904 \ifdim\wd0 > 0pt
905 \def\lefttext{#1}% have both texts
906 \def\righttext{#2}%
907 \else
908 \def\lefttext{#1}% have only one text
909 \def\righttext{#1}%
912 \ifodd\pageno
913 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
914 \else
915 \def\temp{\inleftmargin\lefttext}%
917 \temp
920 % @include FILE -- \input text of FILE.
922 \def\include{\parseargusing\filenamecatcodes\includezzz}
923 \def\includezzz#1{%
924 \pushthisfilestack
925 \def\thisfile{#1}%
927 \makevalueexpandable % we want to expand any @value in FILE.
928 \turnoffactive % and allow special characters in the expansion
929 \edef\temp{\noexpand\input #1 }%
931 % This trickery is to read FILE outside of a group, in case it makes
932 % definitions, etc.
933 \expandafter
934 }\temp
935 \popthisfilestack
937 \def\filenamecatcodes{%
938 \catcode`\\=\other
939 \catcode`~=\other
940 \catcode`^=\other
941 \catcode`_=\other
942 \catcode`|=\other
943 \catcode`<=\other
944 \catcode`>=\other
945 \catcode`+=\other
946 \catcode`-=\other
949 \def\pushthisfilestack{%
950 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
952 \def\pushthisfilestackX{%
953 \expandafter\pushthisfilestackY\thisfile\StackTerm
955 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
956 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
959 \def\popthisfilestack{\errthisfilestackempty}
960 \def\errthisfilestackempty{\errmessage{Internal error:
961 the stack of filenames is empty.}}
963 \def\thisfile{}
965 % @center line
966 % outputs that line, centered.
968 \parseargdef\center{%
969 \ifhmode
970 \let\next\centerH
971 \else
972 \let\next\centerV
974 \next{\hfil \ignorespaces#1\unskip \hfil}%
976 \def\centerH#1{%
978 \hfil\break
979 \advance\hsize by -\leftskip
980 \advance\hsize by -\rightskip
981 \line{#1}%
982 \break
985 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
987 % @sp n outputs n lines of vertical space
989 \parseargdef\sp{\vskip #1\baselineskip}
991 % @comment ...line which is ignored...
992 % @c is the same as @comment
993 % @ignore ... @end ignore is another way to write a comment
995 \def\comment{\begingroup \catcode`\^^M=\other%
996 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
997 \commentxxx}
998 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
1000 \let\c=\comment
1002 % @paragraphindent NCHARS
1003 % We'll use ems for NCHARS, close enough.
1004 % NCHARS can also be the word `asis' or `none'.
1005 % We cannot feasibly implement @paragraphindent asis, though.
1007 \def\asisword{asis} % no translation, these are keywords
1008 \def\noneword{none}
1010 \parseargdef\paragraphindent{%
1011 \def\temp{#1}%
1012 \ifx\temp\asisword
1013 \else
1014 \ifx\temp\noneword
1015 \defaultparindent = 0pt
1016 \else
1017 \defaultparindent = #1em
1020 \parindent = \defaultparindent
1023 % @exampleindent NCHARS
1024 % We'll use ems for NCHARS like @paragraphindent.
1025 % It seems @exampleindent asis isn't necessary, but
1026 % I preserve it to make it similar to @paragraphindent.
1027 \parseargdef\exampleindent{%
1028 \def\temp{#1}%
1029 \ifx\temp\asisword
1030 \else
1031 \ifx\temp\noneword
1032 \lispnarrowing = 0pt
1033 \else
1034 \lispnarrowing = #1em
1039 % @firstparagraphindent WORD
1040 % If WORD is `none', then suppress indentation of the first paragraph
1041 % after a section heading. If WORD is `insert', then do indent at such
1042 % paragraphs.
1044 % The paragraph indentation is suppressed or not by calling
1045 % \suppressfirstparagraphindent, which the sectioning commands do.
1046 % We switch the definition of this back and forth according to WORD.
1047 % By default, we suppress indentation.
1049 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1050 \def\insertword{insert}
1052 \parseargdef\firstparagraphindent{%
1053 \def\temp{#1}%
1054 \ifx\temp\noneword
1055 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1056 \else\ifx\temp\insertword
1057 \let\suppressfirstparagraphindent = \relax
1058 \else
1059 \errhelp = \EMsimple
1060 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1061 \fi\fi
1064 % Here is how we actually suppress indentation. Redefine \everypar to
1065 % \kern backwards by \parindent, and then reset itself to empty.
1067 % We also make \indent itself not actually do anything until the next
1068 % paragraph.
1070 \gdef\dosuppressfirstparagraphindent{%
1071 \gdef\indent{%
1072 \restorefirstparagraphindent
1073 \indent
1075 \gdef\noindent{%
1076 \restorefirstparagraphindent
1077 \noindent
1079 \global\everypar = {%
1080 \kern -\parindent
1081 \restorefirstparagraphindent
1085 \gdef\restorefirstparagraphindent{%
1086 \global \let \indent = \ptexindent
1087 \global \let \noindent = \ptexnoindent
1088 \global \everypar = {}%
1092 % @asis just yields its argument. Used with @table, for example.
1094 \def\asis#1{#1}
1096 % @math outputs its argument in math mode.
1098 % One complication: _ usually means subscripts, but it could also mean
1099 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1100 % _ active, and distinguish by seeing if the current family is \slfam,
1101 % which is what @var uses.
1103 \catcode`\_ = \active
1104 \gdef\mathunderscore{%
1105 \catcode`\_=\active
1106 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1109 % Another complication: we want \\ (and @\) to output a \ character.
1110 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1111 % this is not advertised and we don't care. Texinfo does not
1112 % otherwise define @\.
1114 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1115 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1117 \def\math{%
1118 \tex
1119 \mathunderscore
1120 \let\\ = \mathbackslash
1121 \mathactive
1122 % make the texinfo accent commands work in math mode
1123 \let\"=\ddot
1124 \let\'=\acute
1125 \let\==\bar
1126 \let\^=\hat
1127 \let\`=\grave
1128 \let\u=\breve
1129 \let\v=\check
1130 \let\~=\tilde
1131 \let\dotaccent=\dot
1132 $\finishmath
1134 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1136 % Some active characters (such as <) are spaced differently in math.
1137 % We have to reset their definitions in case the @math was an argument
1138 % to a command which sets the catcodes (such as @item or @section).
1141 \catcode`^ = \active
1142 \catcode`< = \active
1143 \catcode`> = \active
1144 \catcode`+ = \active
1145 \gdef\mathactive{%
1146 \let^ = \ptexhat
1147 \let< = \ptexless
1148 \let> = \ptexgtr
1149 \let+ = \ptexplus
1153 % Some math mode symbols.
1154 \def\bullet{$\ptexbullet$}
1155 \def\geq{\ifmmode \ge\else $\ge$\fi}
1156 \def\leq{\ifmmode \le\else $\le$\fi}
1157 \def\minus{\ifmmode -\else $-$\fi}
1159 % @dots{} outputs an ellipsis using the current font.
1160 % We do .5em per period so that it has the same spacing in the cm
1161 % typewriter fonts as three actual period characters; on the other hand,
1162 % in other typewriter fonts three periods are wider than 1.5em. So do
1163 % whichever is larger.
1165 \def\dots{%
1166 \leavevmode
1167 \setbox0=\hbox{...}% get width of three periods
1168 \ifdim\wd0 > 1.5em
1169 \dimen0 = \wd0
1170 \else
1171 \dimen0 = 1.5em
1173 \hbox to \dimen0{%
1174 \hskip 0pt plus.25fil
1175 .\hskip 0pt plus1fil
1176 .\hskip 0pt plus1fil
1177 .\hskip 0pt plus.5fil
1181 % @enddots{} is an end-of-sentence ellipsis.
1183 \def\enddots{%
1184 \dots
1185 \spacefactor=\endofsentencespacefactor
1188 % @comma{} is so commas can be inserted into text without messing up
1189 % Texinfo's parsing.
1191 \let\comma = ,
1193 % @refill is a no-op.
1194 \let\refill=\relax
1196 % If working on a large document in chapters, it is convenient to
1197 % be able to disable indexing, cross-referencing, and contents, for test runs.
1198 % This is done with @novalidate (before @setfilename).
1200 \newif\iflinks \linkstrue % by default we want the aux files.
1201 \let\novalidate = \linksfalse
1203 % @setfilename is done at the beginning of every texinfo file.
1204 % So open here the files we need to have open while reading the input.
1205 % This makes it possible to make a .fmt file for texinfo.
1206 \def\setfilename{%
1207 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1208 \iflinks
1209 \tryauxfile
1210 % Open the new aux file. TeX will close it automatically at exit.
1211 \immediate\openout\auxfile=\jobname.aux
1212 \fi % \openindices needs to do some work in any case.
1213 \openindices
1214 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1216 % If texinfo.cnf is present on the system, read it.
1217 % Useful for site-wide @afourpaper, etc.
1218 \openin 1 texinfo.cnf
1219 \ifeof 1 \else \input texinfo.cnf \fi
1220 \closein 1
1222 \comment % Ignore the actual filename.
1225 % Called from \setfilename.
1227 \def\openindices{%
1228 \newindex{cp}%
1229 \newcodeindex{fn}%
1230 \newcodeindex{vr}%
1231 \newcodeindex{tp}%
1232 \newcodeindex{ky}%
1233 \newcodeindex{pg}%
1236 % @bye.
1237 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1240 \message{pdf,}
1241 % adobe `portable' document format
1242 \newcount\tempnum
1243 \newcount\lnkcount
1244 \newtoks\filename
1245 \newcount\filenamelength
1246 \newcount\pgn
1247 \newtoks\toksA
1248 \newtoks\toksB
1249 \newtoks\toksC
1250 \newtoks\toksD
1251 \newbox\boxA
1252 \newcount\countA
1253 \newif\ifpdf
1254 \newif\ifpdfmakepagedest
1256 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1257 % can be set). So we test for \relax and 0 as well as \undefined,
1258 % borrowed from ifpdf.sty.
1259 \ifx\pdfoutput\undefined
1260 \else
1261 \ifx\pdfoutput\relax
1262 \else
1263 \ifcase\pdfoutput
1264 \else
1265 \pdftrue
1270 % PDF uses PostScript string constants for the names of xref targets,
1271 % for display in the outlines, and in other places. Thus, we have to
1272 % double any backslashes. Otherwise, a name like "\node" will be
1273 % interpreted as a newline (\n), followed by o, d, e. Not good.
1274 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1275 % (and related messages, the final outcome is that it is up to the TeX
1276 % user to double the backslashes and otherwise make the string valid, so
1277 % that's what we do).
1279 % double active backslashes.
1281 {\catcode`\@=0 \catcode`\\=\active
1282 @gdef@activebackslashdouble{%
1283 @catcode`@\=@active
1284 @let\=@doublebackslash}
1287 % To handle parens, we must adopt a different approach, since parens are
1288 % not active characters. hyperref.dtx (which has the same problem as
1289 % us) handles it with this amazing macro to replace tokens, with minor
1290 % changes for Texinfo. It is included here under the GPL by permission
1291 % from the author, Heiko Oberdiek.
1293 % #1 is the tokens to replace.
1294 % #2 is the replacement.
1295 % #3 is the control sequence with the string.
1297 \def\HyPsdSubst#1#2#3{%
1298 \def\HyPsdReplace##1#1##2\END{%
1299 ##1%
1300 \ifx\\##2\\%
1301 \else
1303 \HyReturnAfterFi{%
1304 \HyPsdReplace##2\END
1308 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1310 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1312 % #1 is a control sequence in which to do the replacements.
1313 \def\backslashparens#1{%
1314 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1315 % \lastnode when called from \setref -> \pdfmkdest.
1316 \HyPsdSubst{(}{\realbackslash(}{#1}%
1317 \HyPsdSubst{)}{\realbackslash)}{#1}%
1320 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1321 with PDF output, and none of those formats could be found. (.eps cannot
1322 be supported due to the design of the PDF format; use regular TeX (DVI
1323 output) for that.)}
1325 \ifpdf
1327 % Color manipulation macros based on pdfcolor.tex.
1328 \def\cmykDarkRed{0.28 1 1 0.35}
1329 \def\cmykBlack{0 0 0 1}
1331 \def\pdfsetcolor#1{\pdfliteral{#1 k}}
1332 % Set color, and create a mark which defines \thiscolor accordingly,
1333 % so that \makeheadline knows which color to restore.
1334 \def\setcolor#1{%
1335 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1336 \domark
1337 \pdfsetcolor{#1}%
1340 \def\maincolor{\cmykBlack}
1341 \pdfsetcolor{\maincolor}
1342 \edef\thiscolor{\maincolor}
1343 \def\lastcolordefs{}
1345 \def\makefootline{%
1346 \baselineskip24pt
1347 \line{\pdfsetcolor{\maincolor}\the\footline}%
1350 \def\makeheadline{%
1351 \vbox to 0pt{%
1352 \vskip-22.5pt
1353 \line{%
1354 \vbox to8.5pt{}%
1355 % Extract \thiscolor definition from the marks.
1356 \getcolormarks
1357 % Typeset the headline with \maincolor, then restore the color.
1358 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1360 \vss
1362 \nointerlineskip
1366 \pdfcatalog{/PageMode /UseOutlines}
1368 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1369 \def\dopdfimage#1#2#3{%
1370 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1371 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1373 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1374 % others). Let's try in that order.
1375 \let\pdfimgext=\empty
1376 \begingroup
1377 \openin 1 #1.png \ifeof 1
1378 \openin 1 #1.jpg \ifeof 1
1379 \openin 1 #1.jpeg \ifeof 1
1380 \openin 1 #1.JPG \ifeof 1
1381 \openin 1 #1.pdf \ifeof 1
1382 \openin 1 #1.PDF \ifeof 1
1383 \errhelp = \nopdfimagehelp
1384 \errmessage{Could not find image file #1 for pdf}%
1385 \else \gdef\pdfimgext{PDF}%
1387 \else \gdef\pdfimgext{pdf}%
1389 \else \gdef\pdfimgext{JPG}%
1391 \else \gdef\pdfimgext{jpeg}%
1393 \else \gdef\pdfimgext{jpg}%
1395 \else \gdef\pdfimgext{png}%
1397 \closein 1
1398 \endgroup
1400 % without \immediate, ancient pdftex seg faults when the same image is
1401 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1402 \ifnum\pdftexversion < 14
1403 \immediate\pdfimage
1404 \else
1405 \immediate\pdfximage
1407 \ifdim \wd0 >0pt width \imagewidth \fi
1408 \ifdim \wd2 >0pt height \imageheight \fi
1409 \ifnum\pdftexversion<13
1410 #1.\pdfimgext
1411 \else
1412 {#1.\pdfimgext}%
1414 \ifnum\pdftexversion < 14 \else
1415 \pdfrefximage \pdflastximage
1416 \fi}
1418 \def\pdfmkdest#1{{%
1419 % We have to set dummies so commands such as @code, and characters
1420 % such as \, aren't expanded when present in a section title.
1421 \indexnofonts
1422 \turnoffactive
1423 \activebackslashdouble
1424 \makevalueexpandable
1425 \def\pdfdestname{#1}%
1426 \backslashparens\pdfdestname
1427 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1430 % used to mark target names; must be expandable.
1431 \def\pdfmkpgn#1{#1}
1433 % by default, use a color that is dark enough to print on paper as
1434 % nearly black, but still distinguishable for online viewing.
1435 \def\urlcolor{\cmykDarkRed}
1436 \def\linkcolor{\cmykDarkRed}
1437 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1439 % Adding outlines to PDF; macros for calculating structure of outlines
1440 % come from Petr Olsak
1441 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1442 \else \csname#1\endcsname \fi}
1443 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1444 \advance\tempnum by 1
1445 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1447 % #1 is the section text, which is what will be displayed in the
1448 % outline by the pdf viewer. #2 is the pdf expression for the number
1449 % of subentries (or empty, for subsubsections). #3 is the node text,
1450 % which might be empty if this toc entry had no corresponding node.
1451 % #4 is the page number
1453 \def\dopdfoutline#1#2#3#4{%
1454 % Generate a link to the node text if that exists; else, use the
1455 % page number. We could generate a destination for the section
1456 % text in the case where a section has no node, but it doesn't
1457 % seem worth the trouble, since most documents are normally structured.
1458 \def\pdfoutlinedest{#3}%
1459 \ifx\pdfoutlinedest\empty
1460 \def\pdfoutlinedest{#4}%
1461 \else
1462 % Doubled backslashes in the name.
1463 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1464 \backslashparens\pdfoutlinedest}%
1467 % Also double the backslashes in the display string.
1468 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1469 \backslashparens\pdfoutlinetext}%
1471 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1474 \def\pdfmakeoutlines{%
1475 \begingroup
1476 % Thanh's hack / proper braces in bookmarks
1477 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1478 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1480 % Read toc silently, to get counts of subentries for \pdfoutline.
1481 \def\numchapentry##1##2##3##4{%
1482 \def\thischapnum{##2}%
1483 \def\thissecnum{0}%
1484 \def\thissubsecnum{0}%
1486 \def\numsecentry##1##2##3##4{%
1487 \advancenumber{chap\thischapnum}%
1488 \def\thissecnum{##2}%
1489 \def\thissubsecnum{0}%
1491 \def\numsubsecentry##1##2##3##4{%
1492 \advancenumber{sec\thissecnum}%
1493 \def\thissubsecnum{##2}%
1495 \def\numsubsubsecentry##1##2##3##4{%
1496 \advancenumber{subsec\thissubsecnum}%
1498 \def\thischapnum{0}%
1499 \def\thissecnum{0}%
1500 \def\thissubsecnum{0}%
1502 % use \def rather than \let here because we redefine \chapentry et
1503 % al. a second time, below.
1504 \def\appentry{\numchapentry}%
1505 \def\appsecentry{\numsecentry}%
1506 \def\appsubsecentry{\numsubsecentry}%
1507 \def\appsubsubsecentry{\numsubsubsecentry}%
1508 \def\unnchapentry{\numchapentry}%
1509 \def\unnsecentry{\numsecentry}%
1510 \def\unnsubsecentry{\numsubsecentry}%
1511 \def\unnsubsubsecentry{\numsubsubsecentry}%
1512 \readdatafile{toc}%
1514 % Read toc second time, this time actually producing the outlines.
1515 % The `-' means take the \expnumber as the absolute number of
1516 % subentries, which we calculated on our first read of the .toc above.
1518 % We use the node names as the destinations.
1519 \def\numchapentry##1##2##3##4{%
1520 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1521 \def\numsecentry##1##2##3##4{%
1522 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1523 \def\numsubsecentry##1##2##3##4{%
1524 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1525 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1526 \dopdfoutline{##1}{}{##3}{##4}}%
1528 % PDF outlines are displayed using system fonts, instead of
1529 % document fonts. Therefore we cannot use special characters,
1530 % since the encoding is unknown. For example, the eogonek from
1531 % Latin 2 (0xea) gets translated to a | character. Info from
1532 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1534 % xx to do this right, we have to translate 8-bit characters to
1535 % their "best" equivalent, based on the @documentencoding. Right
1536 % now, I guess we'll just let the pdf reader have its way.
1537 \indexnofonts
1538 \setupdatafile
1539 \catcode`\\=\active \otherbackslash
1540 \input \tocreadfilename
1541 \endgroup
1544 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1545 \ifx\PP\D\let\nextsp\relax
1546 \else\let\nextsp\skipspaces
1547 \ifx\p\space\else\addtokens{\filename}{\PP}%
1548 \advance\filenamelength by 1
1551 \nextsp}
1552 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1553 \ifnum\pdftexversion < 14
1554 \let \startlink \pdfannotlink
1555 \else
1556 \let \startlink \pdfstartlink
1558 % make a live url in pdf output.
1559 \def\pdfurl#1{%
1560 \begingroup
1561 % it seems we really need yet another set of dummies; have not
1562 % tried to figure out what each command should do in the context
1563 % of @url. for now, just make @/ a no-op, that's the only one
1564 % people have actually reported a problem with.
1566 \normalturnoffactive
1567 \def\@{@}%
1568 \let\/=\empty
1569 \makevalueexpandable
1570 \leavevmode\setcolor{\urlcolor}%
1571 \startlink attr{/Border [0 0 0]}%
1572 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1573 \endgroup}
1574 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1575 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1576 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1577 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1578 \def\maketoks{%
1579 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1580 \ifx\first0\adn0
1581 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1582 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1583 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1584 \else
1585 \ifnum0=\countA\else\makelink\fi
1586 \ifx\first.\let\next=\done\else
1587 \let\next=\maketoks
1588 \addtokens{\toksB}{\the\toksD}
1589 \ifx\first,\addtokens{\toksB}{\space}\fi
1591 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1592 \next}
1593 \def\makelink{\addtokens{\toksB}%
1594 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1595 \def\pdflink#1{%
1596 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1597 \setcolor{\linkcolor}#1\endlink}
1598 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1599 \else
1600 \let\pdfmkdest = \gobble
1601 \let\pdfurl = \gobble
1602 \let\endlink = \relax
1603 \let\setcolor = \gobble
1604 \let\pdfsetcolor = \gobble
1605 \let\pdfmakeoutlines = \relax
1606 \fi % \ifx\pdfoutput
1609 \message{fonts,}
1611 % Change the current font style to #1, remembering it in \curfontstyle.
1612 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1613 % italics, not bold italics.
1615 \def\setfontstyle#1{%
1616 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1617 \csname ten#1\endcsname % change the current font
1620 % Select #1 fonts with the current style.
1622 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1624 \def\rm{\fam=0 \setfontstyle{rm}}
1625 \def\it{\fam=\itfam \setfontstyle{it}}
1626 \def\sl{\fam=\slfam \setfontstyle{sl}}
1627 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1628 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1630 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1631 % So we set up a \sf.
1632 \newfam\sffam
1633 \def\sf{\fam=\sffam \setfontstyle{sf}}
1634 \let\li = \sf % Sometimes we call it \li, not \sf.
1636 % We don't need math for this font style.
1637 \def\ttsl{\setfontstyle{ttsl}}
1640 % Default leading.
1641 \newdimen\textleading \textleading = 13.2pt
1643 % Set the baselineskip to #1, and the lineskip and strut size
1644 % correspondingly. There is no deep meaning behind these magic numbers
1645 % used as factors; they just match (closely enough) what Knuth defined.
1647 \def\lineskipfactor{.08333}
1648 \def\strutheightpercent{.70833}
1649 \def\strutdepthpercent {.29167}
1651 % can get a sort of poor man's double spacing by redefining this.
1652 \def\baselinefactor{1}
1654 \def\setleading#1{%
1655 \dimen0 = #1\relax
1656 \normalbaselineskip = \baselinefactor\dimen0
1657 \normallineskip = \lineskipfactor\normalbaselineskip
1658 \normalbaselines
1659 \setbox\strutbox =\hbox{%
1660 \vrule width0pt height\strutheightpercent\baselineskip
1661 depth \strutdepthpercent \baselineskip
1665 % PDF CMaps. See also LaTeX's t1.cmap.
1667 % do nothing with this by default.
1668 \expandafter\let\csname cmapOT1\endcsname\gobble
1669 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1670 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1672 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1673 % (\pdffontattr was introduced many years ago, but people still run
1674 % older pdftex's; it's easy to conditionalize, so we do.)
1675 \ifpdf \ifx\pdffontattr\undefined \else
1676 \begingroup
1677 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1678 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1679 %%DocumentNeededResources: ProcSet (CIDInit)
1680 %%IncludeResource: ProcSet (CIDInit)
1681 %%BeginResource: CMap (TeX-OT1-0)
1682 %%Title: (TeX-OT1-0 TeX OT1 0)
1683 %%Version: 1.000
1684 %%EndComments
1685 /CIDInit /ProcSet findresource begin
1686 12 dict begin
1687 begincmap
1688 /CIDSystemInfo
1689 << /Registry (TeX)
1690 /Ordering (OT1)
1691 /Supplement 0
1692 >> def
1693 /CMapName /TeX-OT1-0 def
1694 /CMapType 2 def
1695 1 begincodespacerange
1696 <00> <7F>
1697 endcodespacerange
1698 8 beginbfrange
1699 <00> <01> <0393>
1700 <09> <0A> <03A8>
1701 <23> <26> <0023>
1702 <28> <3B> <0028>
1703 <3F> <5B> <003F>
1704 <5D> <5E> <005D>
1705 <61> <7A> <0061>
1706 <7B> <7C> <2013>
1707 endbfrange
1708 40 beginbfchar
1709 <02> <0398>
1710 <03> <039B>
1711 <04> <039E>
1712 <05> <03A0>
1713 <06> <03A3>
1714 <07> <03D2>
1715 <08> <03A6>
1716 <0B> <00660066>
1717 <0C> <00660069>
1718 <0D> <0066006C>
1719 <0E> <006600660069>
1720 <0F> <00660066006C>
1721 <10> <0131>
1722 <11> <0237>
1723 <12> <0060>
1724 <13> <00B4>
1725 <14> <02C7>
1726 <15> <02D8>
1727 <16> <00AF>
1728 <17> <02DA>
1729 <18> <00B8>
1730 <19> <00DF>
1731 <1A> <00E6>
1732 <1B> <0153>
1733 <1C> <00F8>
1734 <1D> <00C6>
1735 <1E> <0152>
1736 <1F> <00D8>
1737 <21> <0021>
1738 <22> <201D>
1739 <27> <2019>
1740 <3C> <00A1>
1741 <3D> <003D>
1742 <3E> <00BF>
1743 <5C> <201C>
1744 <5F> <02D9>
1745 <60> <2018>
1746 <7D> <02DD>
1747 <7E> <007E>
1748 <7F> <00A8>
1749 endbfchar
1750 endcmap
1751 CMapName currentdict /CMap defineresource pop
1754 %%EndResource
1755 %%EOF
1756 }\endgroup
1757 \expandafter\edef\csname cmapOT1\endcsname#1{%
1758 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1761 % \cmapOT1IT
1762 \begingroup
1763 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1764 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1765 %%DocumentNeededResources: ProcSet (CIDInit)
1766 %%IncludeResource: ProcSet (CIDInit)
1767 %%BeginResource: CMap (TeX-OT1IT-0)
1768 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1769 %%Version: 1.000
1770 %%EndComments
1771 /CIDInit /ProcSet findresource begin
1772 12 dict begin
1773 begincmap
1774 /CIDSystemInfo
1775 << /Registry (TeX)
1776 /Ordering (OT1IT)
1777 /Supplement 0
1778 >> def
1779 /CMapName /TeX-OT1IT-0 def
1780 /CMapType 2 def
1781 1 begincodespacerange
1782 <00> <7F>
1783 endcodespacerange
1784 8 beginbfrange
1785 <00> <01> <0393>
1786 <09> <0A> <03A8>
1787 <25> <26> <0025>
1788 <28> <3B> <0028>
1789 <3F> <5B> <003F>
1790 <5D> <5E> <005D>
1791 <61> <7A> <0061>
1792 <7B> <7C> <2013>
1793 endbfrange
1794 42 beginbfchar
1795 <02> <0398>
1796 <03> <039B>
1797 <04> <039E>
1798 <05> <03A0>
1799 <06> <03A3>
1800 <07> <03D2>
1801 <08> <03A6>
1802 <0B> <00660066>
1803 <0C> <00660069>
1804 <0D> <0066006C>
1805 <0E> <006600660069>
1806 <0F> <00660066006C>
1807 <10> <0131>
1808 <11> <0237>
1809 <12> <0060>
1810 <13> <00B4>
1811 <14> <02C7>
1812 <15> <02D8>
1813 <16> <00AF>
1814 <17> <02DA>
1815 <18> <00B8>
1816 <19> <00DF>
1817 <1A> <00E6>
1818 <1B> <0153>
1819 <1C> <00F8>
1820 <1D> <00C6>
1821 <1E> <0152>
1822 <1F> <00D8>
1823 <21> <0021>
1824 <22> <201D>
1825 <23> <0023>
1826 <24> <00A3>
1827 <27> <2019>
1828 <3C> <00A1>
1829 <3D> <003D>
1830 <3E> <00BF>
1831 <5C> <201C>
1832 <5F> <02D9>
1833 <60> <2018>
1834 <7D> <02DD>
1835 <7E> <007E>
1836 <7F> <00A8>
1837 endbfchar
1838 endcmap
1839 CMapName currentdict /CMap defineresource pop
1842 %%EndResource
1843 %%EOF
1844 }\endgroup
1845 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1846 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1849 % \cmapOT1TT
1850 \begingroup
1851 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1852 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1853 %%DocumentNeededResources: ProcSet (CIDInit)
1854 %%IncludeResource: ProcSet (CIDInit)
1855 %%BeginResource: CMap (TeX-OT1TT-0)
1856 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1857 %%Version: 1.000
1858 %%EndComments
1859 /CIDInit /ProcSet findresource begin
1860 12 dict begin
1861 begincmap
1862 /CIDSystemInfo
1863 << /Registry (TeX)
1864 /Ordering (OT1TT)
1865 /Supplement 0
1866 >> def
1867 /CMapName /TeX-OT1TT-0 def
1868 /CMapType 2 def
1869 1 begincodespacerange
1870 <00> <7F>
1871 endcodespacerange
1872 5 beginbfrange
1873 <00> <01> <0393>
1874 <09> <0A> <03A8>
1875 <21> <26> <0021>
1876 <28> <5F> <0028>
1877 <61> <7E> <0061>
1878 endbfrange
1879 32 beginbfchar
1880 <02> <0398>
1881 <03> <039B>
1882 <04> <039E>
1883 <05> <03A0>
1884 <06> <03A3>
1885 <07> <03D2>
1886 <08> <03A6>
1887 <0B> <2191>
1888 <0C> <2193>
1889 <0D> <0027>
1890 <0E> <00A1>
1891 <0F> <00BF>
1892 <10> <0131>
1893 <11> <0237>
1894 <12> <0060>
1895 <13> <00B4>
1896 <14> <02C7>
1897 <15> <02D8>
1898 <16> <00AF>
1899 <17> <02DA>
1900 <18> <00B8>
1901 <19> <00DF>
1902 <1A> <00E6>
1903 <1B> <0153>
1904 <1C> <00F8>
1905 <1D> <00C6>
1906 <1E> <0152>
1907 <1F> <00D8>
1908 <20> <2423>
1909 <27> <2019>
1910 <60> <2018>
1911 <7F> <00A8>
1912 endbfchar
1913 endcmap
1914 CMapName currentdict /CMap defineresource pop
1917 %%EndResource
1918 %%EOF
1919 }\endgroup
1920 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1921 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1923 \fi\fi
1926 % Set the font macro #1 to the font named #2, adding on the
1927 % specified font prefix (normally `cm').
1928 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1929 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1930 % empty to omit).
1931 \def\setfont#1#2#3#4#5{%
1932 \font#1=\fontprefix#2#3 scaled #4
1933 \csname cmap#5\endcsname#1%
1935 % This is what gets called when #5 of \setfont is empty.
1936 \let\cmap\gobble
1937 % emacs-page end of cmaps
1939 % Use cm as the default font prefix.
1940 % To specify the font prefix, you must define \fontprefix
1941 % before you read in texinfo.tex.
1942 \ifx\fontprefix\undefined
1943 \def\fontprefix{cm}
1945 % Support font families that don't use the same naming scheme as CM.
1946 \def\rmshape{r}
1947 \def\rmbshape{bx} %where the normal face is bold
1948 \def\bfshape{b}
1949 \def\bxshape{bx}
1950 \def\ttshape{tt}
1951 \def\ttbshape{tt}
1952 \def\ttslshape{sltt}
1953 \def\itshape{ti}
1954 \def\itbshape{bxti}
1955 \def\slshape{sl}
1956 \def\slbshape{bxsl}
1957 \def\sfshape{ss}
1958 \def\sfbshape{ss}
1959 \def\scshape{csc}
1960 \def\scbshape{csc}
1962 % Definitions for a main text size of 11pt. This is the default in
1963 % Texinfo.
1965 \def\definetextfontsizexi{%
1966 % Text fonts (11.2pt, magstep1).
1967 \def\textnominalsize{11pt}
1968 \edef\mainmagstep{\magstephalf}
1969 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1970 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1971 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1972 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1973 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1974 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1975 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1976 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1977 \font\texti=cmmi10 scaled \mainmagstep
1978 \font\textsy=cmsy10 scaled \mainmagstep
1979 \def\textecsize{1095}
1981 % A few fonts for @defun names and args.
1982 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1983 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1984 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1985 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1987 % Fonts for indices, footnotes, small examples (9pt).
1988 \def\smallnominalsize{9pt}
1989 \setfont\smallrm\rmshape{9}{1000}{OT1}
1990 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1991 \setfont\smallbf\bfshape{10}{900}{OT1}
1992 \setfont\smallit\itshape{9}{1000}{OT1IT}
1993 \setfont\smallsl\slshape{9}{1000}{OT1}
1994 \setfont\smallsf\sfshape{9}{1000}{OT1}
1995 \setfont\smallsc\scshape{10}{900}{OT1}
1996 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1997 \font\smalli=cmmi9
1998 \font\smallsy=cmsy9
1999 \def\smallecsize{0900}
2001 % Fonts for small examples (8pt).
2002 \def\smallernominalsize{8pt}
2003 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2004 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2005 \setfont\smallerbf\bfshape{10}{800}{OT1}
2006 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2007 \setfont\smallersl\slshape{8}{1000}{OT1}
2008 \setfont\smallersf\sfshape{8}{1000}{OT1}
2009 \setfont\smallersc\scshape{10}{800}{OT1}
2010 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2011 \font\smalleri=cmmi8
2012 \font\smallersy=cmsy8
2013 \def\smallerecsize{0800}
2015 % Fonts for title page (20.4pt):
2016 \def\titlenominalsize{20pt}
2017 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2018 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2019 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2020 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2021 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2022 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2023 \let\titlebf=\titlerm
2024 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2025 \font\titlei=cmmi12 scaled \magstep3
2026 \font\titlesy=cmsy10 scaled \magstep4
2027 \def\authorrm{\secrm}
2028 \def\authortt{\sectt}
2029 \def\titleecsize{2074}
2031 % Chapter (and unnumbered) fonts (17.28pt).
2032 \def\chapnominalsize{17pt}
2033 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
2034 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
2035 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
2036 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
2037 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2038 \setfont\chapsf\sfbshape{17}{1000}{OT1}
2039 \let\chapbf=\chaprm
2040 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
2041 \font\chapi=cmmi12 scaled \magstep2
2042 \font\chapsy=cmsy10 scaled \magstep3
2043 \def\chapecsize{1728}
2045 % Section fonts (14.4pt).
2046 \def\secnominalsize{14pt}
2047 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
2048 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
2049 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
2050 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
2051 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2052 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
2053 \let\secbf\secrm
2054 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
2055 \font\seci=cmmi12 scaled \magstep1
2056 \font\secsy=cmsy10 scaled \magstep2
2057 \def\sececsize{1440}
2059 % Subsection fonts (13.15pt).
2060 \def\ssecnominalsize{13pt}
2061 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
2062 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
2063 \setfont\ssecsl\slbshape{10}{1315}{OT1}
2064 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
2065 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2066 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
2067 \let\ssecbf\ssecrm
2068 \setfont\ssecsc\scbshape{10}{1315}{OT1}
2069 \font\sseci=cmmi12 scaled \magstephalf
2070 \font\ssecsy=cmsy10 scaled 1315
2071 \def\ssececsize{1200}
2073 % Reduced fonts for @acro in text (10pt).
2074 \def\reducednominalsize{10pt}
2075 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2076 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2077 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2078 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2079 \setfont\reducedsl\slshape{10}{1000}{OT1}
2080 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2081 \setfont\reducedsc\scshape{10}{1000}{OT1}
2082 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2083 \font\reducedi=cmmi10
2084 \font\reducedsy=cmsy10
2085 \def\reducedecsize{1000}
2087 % reset the current fonts
2088 \textfonts
2090 } % end of 11pt text font size definitions
2093 % Definitions to make the main text be 10pt Computer Modern, with
2094 % section, chapter, etc., sizes following suit. This is for the GNU
2095 % Press printing of the Emacs 22 manual. Maybe other manuals in the
2096 % future. Used with @smallbook, which sets the leading to 12pt.
2098 \def\definetextfontsizex{%
2099 % Text fonts (10pt).
2100 \def\textnominalsize{10pt}
2101 \edef\mainmagstep{1000}
2102 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2103 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2104 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2105 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2106 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2107 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2108 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2109 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2110 \font\texti=cmmi10 scaled \mainmagstep
2111 \font\textsy=cmsy10 scaled \mainmagstep
2112 \def\textecsize{1000}
2114 % A few fonts for @defun names and args.
2115 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2116 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2117 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2118 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2120 % Fonts for indices, footnotes, small examples (9pt).
2121 \def\smallnominalsize{9pt}
2122 \setfont\smallrm\rmshape{9}{1000}{OT1}
2123 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2124 \setfont\smallbf\bfshape{10}{900}{OT1}
2125 \setfont\smallit\itshape{9}{1000}{OT1IT}
2126 \setfont\smallsl\slshape{9}{1000}{OT1}
2127 \setfont\smallsf\sfshape{9}{1000}{OT1}
2128 \setfont\smallsc\scshape{10}{900}{OT1}
2129 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2130 \font\smalli=cmmi9
2131 \font\smallsy=cmsy9
2132 \def\smallecsize{0900}
2134 % Fonts for small examples (8pt).
2135 \def\smallernominalsize{8pt}
2136 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2137 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2138 \setfont\smallerbf\bfshape{10}{800}{OT1}
2139 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2140 \setfont\smallersl\slshape{8}{1000}{OT1}
2141 \setfont\smallersf\sfshape{8}{1000}{OT1}
2142 \setfont\smallersc\scshape{10}{800}{OT1}
2143 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2144 \font\smalleri=cmmi8
2145 \font\smallersy=cmsy8
2146 \def\smallerecsize{0800}
2148 % Fonts for title page (20.4pt):
2149 \def\titlenominalsize{20pt}
2150 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2151 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2152 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2153 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2154 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2155 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2156 \let\titlebf=\titlerm
2157 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2158 \font\titlei=cmmi12 scaled \magstep3
2159 \font\titlesy=cmsy10 scaled \magstep4
2160 \def\authorrm{\secrm}
2161 \def\authortt{\sectt}
2162 \def\titleecsize{2074}
2164 % Chapter fonts (14.4pt).
2165 \def\chapnominalsize{14pt}
2166 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2167 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2168 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2169 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2170 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2171 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2172 \let\chapbf\chaprm
2173 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2174 \font\chapi=cmmi12 scaled \magstep1
2175 \font\chapsy=cmsy10 scaled \magstep2
2176 \def\chapecsize{1440}
2178 % Section fonts (12pt).
2179 \def\secnominalsize{12pt}
2180 \setfont\secrm\rmbshape{12}{1000}{OT1}
2181 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2182 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2183 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2184 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2185 \setfont\secsf\sfbshape{12}{1000}{OT1}
2186 \let\secbf\secrm
2187 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2188 \font\seci=cmmi12
2189 \font\secsy=cmsy10 scaled \magstep1
2190 \def\sececsize{1200}
2192 % Subsection fonts (10pt).
2193 \def\ssecnominalsize{10pt}
2194 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2195 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2196 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2197 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2198 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2199 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2200 \let\ssecbf\ssecrm
2201 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2202 \font\sseci=cmmi10
2203 \font\ssecsy=cmsy10
2204 \def\ssececsize{1000}
2206 % Reduced fonts for @acro in text (9pt).
2207 \def\reducednominalsize{9pt}
2208 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2209 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2210 \setfont\reducedbf\bfshape{10}{900}{OT1}
2211 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2212 \setfont\reducedsl\slshape{9}{1000}{OT1}
2213 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2214 \setfont\reducedsc\scshape{10}{900}{OT1}
2215 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2216 \font\reducedi=cmmi9
2217 \font\reducedsy=cmsy9
2218 \def\reducedecsize{0900}
2220 % reduce space between paragraphs
2221 \divide\parskip by 2
2223 % reset the current fonts
2224 \textfonts
2226 } % end of 10pt text font size definitions
2229 % We provide the user-level command
2230 % @fonttextsize 10
2231 % (or 11) to redefine the text font size. pt is assumed.
2233 \def\xword{10}
2234 \def\xiword{11}
2236 \parseargdef\fonttextsize{%
2237 \def\textsizearg{#1}%
2238 \wlog{doing @fonttextsize \textsizearg}%
2240 % Set \globaldefs so that documents can use this inside @tex, since
2241 % makeinfo 4.8 does not support it, but we need it nonetheless.
2243 \begingroup \globaldefs=1
2244 \ifx\textsizearg\xword \definetextfontsizex
2245 \else \ifx\textsizearg\xiword \definetextfontsizexi
2246 \else
2247 \errhelp=\EMsimple
2248 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2249 \fi\fi
2250 \endgroup
2254 % In order for the font changes to affect most math symbols and letters,
2255 % we have to define the \textfont of the standard families. Since
2256 % texinfo doesn't allow for producing subscripts and superscripts except
2257 % in the main text, we don't bother to reset \scriptfont and
2258 % \scriptscriptfont (which would also require loading a lot more fonts).
2260 \def\resetmathfonts{%
2261 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2262 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2263 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2266 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2267 % of just \STYLE. We do this because \STYLE needs to also set the
2268 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2269 % \tenSTYLE to set the current font.
2271 % Each font-changing command also sets the names \lsize (one size lower)
2272 % and \lllsize (three sizes lower). These relative commands are used in
2273 % the LaTeX logo and acronyms.
2275 % This all needs generalizing, badly.
2277 \def\textfonts{%
2278 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2279 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2280 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2281 \let\tenttsl=\textttsl
2282 \def\curfontsize{text}%
2283 \def\lsize{reduced}\def\lllsize{smaller}%
2284 \resetmathfonts \setleading{\textleading}}
2285 \def\titlefonts{%
2286 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2287 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2288 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2289 \let\tenttsl=\titlettsl
2290 \def\curfontsize{title}%
2291 \def\lsize{chap}\def\lllsize{subsec}%
2292 \resetmathfonts \setleading{25pt}}
2293 \def\titlefont#1{{\titlefonts\rm #1}}
2294 \def\chapfonts{%
2295 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2296 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2297 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2298 \let\tenttsl=\chapttsl
2299 \def\curfontsize{chap}%
2300 \def\lsize{sec}\def\lllsize{text}%
2301 \resetmathfonts \setleading{19pt}}
2302 \def\secfonts{%
2303 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2304 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2305 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2306 \let\tenttsl=\secttsl
2307 \def\curfontsize{sec}%
2308 \def\lsize{subsec}\def\lllsize{reduced}%
2309 \resetmathfonts \setleading{16pt}}
2310 \def\subsecfonts{%
2311 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2312 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2313 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2314 \let\tenttsl=\ssecttsl
2315 \def\curfontsize{ssec}%
2316 \def\lsize{text}\def\lllsize{small}%
2317 \resetmathfonts \setleading{15pt}}
2318 \let\subsubsecfonts = \subsecfonts
2319 \def\reducedfonts{%
2320 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2321 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2322 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2323 \let\tenttsl=\reducedttsl
2324 \def\curfontsize{reduced}%
2325 \def\lsize{small}\def\lllsize{smaller}%
2326 \resetmathfonts \setleading{10.5pt}}
2327 \def\smallfonts{%
2328 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2329 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2330 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2331 \let\tenttsl=\smallttsl
2332 \def\curfontsize{small}%
2333 \def\lsize{smaller}\def\lllsize{smaller}%
2334 \resetmathfonts \setleading{10.5pt}}
2335 \def\smallerfonts{%
2336 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2337 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2338 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2339 \let\tenttsl=\smallerttsl
2340 \def\curfontsize{smaller}%
2341 \def\lsize{smaller}\def\lllsize{smaller}%
2342 \resetmathfonts \setleading{9.5pt}}
2344 % Set the fonts to use with the @small... environments.
2345 \let\smallexamplefonts = \smallfonts
2347 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2348 % can fit this many characters:
2349 % 8.5x11=86 smallbook=72 a4=90 a5=69
2350 % If we use \scriptfonts (8pt), then we can fit this many characters:
2351 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2352 % For me, subjectively, the few extra characters that fit aren't worth
2353 % the additional smallness of 8pt. So I'm making the default 9pt.
2355 % By the way, for comparison, here's what fits with @example (10pt):
2356 % 8.5x11=71 smallbook=60 a4=75 a5=58
2358 % I wish the USA used A4 paper.
2359 % --karl, 24jan03.
2362 % Set up the default fonts, so we can use them for creating boxes.
2364 \definetextfontsizexi
2366 % Define these so they can be easily changed for other fonts.
2367 \def\angleleft{$\langle$}
2368 \def\angleright{$\rangle$}
2370 % Count depth in font-changes, for error checks
2371 \newcount\fontdepth \fontdepth=0
2373 % Fonts for short table of contents.
2374 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2375 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2376 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2377 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2379 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
2380 %% serif) and @ii for TeX italic
2382 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
2383 % unless the following character is such as not to need one.
2384 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
2385 \ptexslash\fi\fi\fi}
2386 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
2387 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
2389 % like \smartslanted except unconditionally uses \ttsl.
2390 % @var is set to this for defun arguments.
2391 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
2393 % like \smartslanted except unconditionally use \sl. We never want
2394 % ttsl for book titles, do we?
2395 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
2397 \let\i=\smartitalic
2398 \let\slanted=\smartslanted
2399 \let\var=\smartslanted
2400 \let\dfn=\smartslanted
2401 \let\emph=\smartitalic
2403 % @b, explicit bold.
2404 \def\b#1{{\bf #1}}
2405 \let\strong=\b
2407 % @sansserif, explicit sans.
2408 \def\sansserif#1{{\sf #1}}
2410 % We can't just use \exhyphenpenalty, because that only has effect at
2411 % the end of a paragraph. Restore normal hyphenation at the end of the
2412 % group within which \nohyphenation is presumably called.
2414 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2415 \def\restorehyphenation{\hyphenchar\font = `- }
2417 % Set sfcode to normal for the chars that usually have another value.
2418 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2419 % sometimes \x has an active definition that messes things up.
2421 \catcode`@=11
2422 \def\plainfrenchspacing{%
2423 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2424 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2425 \def\endofsentencespacefactor{1000}% for @. and friends
2427 \def\plainnonfrenchspacing{%
2428 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2429 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2430 \def\endofsentencespacefactor{3000}% for @. and friends
2432 \catcode`@=\other
2433 \def\endofsentencespacefactor{3000}% default
2435 \def\t#1{%
2436 {\tt \rawbackslash \plainfrenchspacing #1}%
2437 \null
2439 \def\samp#1{`\tclose{#1}'\null}
2440 \setfont\keyrm\rmshape{8}{1000}{OT1}
2441 \font\keysy=cmsy9
2442 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2443 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2444 \vbox{\hrule\kern-0.4pt
2445 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2446 \kern-0.4pt\hrule}%
2447 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2448 \def\key #1{{\nohyphenation \uppercase{#1}}\null}
2449 % The old definition, with no lozenge:
2450 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
2451 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2453 % @file, @option are the same as @samp.
2454 \let\file=\samp
2455 \let\option=\samp
2457 % @code is a modification of @t,
2458 % which makes spaces the same size as normal in the surrounding text.
2459 \def\tclose#1{%
2461 % Change normal interword space to be same as for the current font.
2462 \spaceskip = \fontdimen2\font
2464 % Switch to typewriter.
2467 % But `\ ' produces the large typewriter interword space.
2468 \def\ {{\spaceskip = 0pt{} }}%
2470 % Turn off hyphenation.
2471 \nohyphenation
2473 \rawbackslash
2474 \plainfrenchspacing
2477 \null
2480 % We *must* turn on hyphenation at `-' and `_' in @code.
2481 % Otherwise, it is too hard to avoid overfull hboxes
2482 % in the Emacs manual, the Library manual, etc.
2484 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2485 % both hyphenation at - and hyphenation within words.
2486 % We must therefore turn them both off (\tclose does that)
2487 % and arrange explicitly to hyphenate at a dash.
2488 % -- rms.
2490 \catcode`\-=\active \catcode`\_=\active
2491 \catcode`\'=\active \catcode`\`=\active
2493 \global\def\code{\begingroup
2494 \catcode\rquoteChar=\active \catcode\lquoteChar=\active
2495 \let'\codequoteright \let`\codequoteleft
2497 \catcode\dashChar=\active \catcode\underChar=\active
2498 \ifallowcodebreaks
2499 \let-\codedash
2500 \let_\codeunder
2501 \else
2502 \let-\realdash
2503 \let_\realunder
2505 \codex
2509 \def\realdash{-}
2510 \def\codedash{-\discretionary{}{}{}}
2511 \def\codeunder{%
2512 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2513 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2514 % will therefore expand the active definition of _, which is us
2515 % (inside @code that is), therefore an endless loop.
2516 \ifusingtt{\ifmmode
2517 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2518 \else\normalunderscore \fi
2519 \discretionary{}{}{}}%
2520 {\_}%
2522 \def\codex #1{\tclose{#1}\endgroup}
2524 % An additional complication: the above will allow breaks after, e.g.,
2525 % each of the four underscores in __typeof__. This is undesirable in
2526 % some manuals, especially if they don't have long identifiers in
2527 % general. @allowcodebreaks provides a way to control this.
2529 \newif\ifallowcodebreaks \allowcodebreakstrue
2531 \def\keywordtrue{true}
2532 \def\keywordfalse{false}
2534 \parseargdef\allowcodebreaks{%
2535 \def\txiarg{#1}%
2536 \ifx\txiarg\keywordtrue
2537 \allowcodebreakstrue
2538 \else\ifx\txiarg\keywordfalse
2539 \allowcodebreaksfalse
2540 \else
2541 \errhelp = \EMsimple
2542 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2543 \fi\fi
2546 % @kbd is like @code, except that if the argument is just one @key command,
2547 % then @kbd has no effect.
2549 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2550 % `example' (@kbd uses ttsl only inside of @example and friends),
2551 % or `code' (@kbd uses normal tty font always).
2552 \parseargdef\kbdinputstyle{%
2553 \def\txiarg{#1}%
2554 \ifx\txiarg\worddistinct
2555 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2556 \else\ifx\txiarg\wordexample
2557 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2558 \else\ifx\txiarg\wordcode
2559 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2560 \else
2561 \errhelp = \EMsimple
2562 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2563 \fi\fi\fi
2565 \def\worddistinct{distinct}
2566 \def\wordexample{example}
2567 \def\wordcode{code}
2569 % Default is `distinct.'
2570 \kbdinputstyle distinct
2572 \def\xkey{\key}
2573 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2574 \ifx\one\xkey\ifx\threex\three \key{#2}%
2575 \else{\tclose{\kbdfont\look}}\fi
2576 \else{\tclose{\kbdfont\look}}\fi}
2578 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2579 \let\indicateurl=\code
2580 \let\env=\code
2581 \let\command=\code
2583 % @clicksequence{File @click{} Open ...}
2584 \def\clicksequence#1{\begingroup #1\endgroup}
2586 % @clickstyle @arrow (by default)
2587 \parseargdef\clickstyle{\def\click{#1}}
2588 \def\click{\arrow}
2590 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2591 % second argument specifying the text to display and an optional third
2592 % arg as text to display instead of (rather than in addition to) the url
2593 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2594 % a hypertex \special here.
2596 \def\uref#1{\douref #1,,,\finish}
2597 \def\douref#1,#2,#3,#4\finish{\begingroup
2598 \unsepspaces
2599 \pdfurl{#1}%
2600 \setbox0 = \hbox{\ignorespaces #3}%
2601 \ifdim\wd0 > 0pt
2602 \unhbox0 % third arg given, show only that
2603 \else
2604 \setbox0 = \hbox{\ignorespaces #2}%
2605 \ifdim\wd0 > 0pt
2606 \ifpdf
2607 \unhbox0 % PDF: 2nd arg given, show only it
2608 \else
2609 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2611 \else
2612 \code{#1}% only url given, so show it
2615 \endlink
2616 \endgroup}
2618 % @url synonym for @uref, since that's how everyone uses it.
2620 \let\url=\uref
2622 % rms does not like angle brackets --karl, 17may97.
2623 % So now @email is just like @uref, unless we are pdf.
2625 %\def\email#1{\angleleft{\tt #1}\angleright}
2626 \ifpdf
2627 \def\email#1{\doemail#1,,\finish}
2628 \def\doemail#1,#2,#3\finish{\begingroup
2629 \unsepspaces
2630 \pdfurl{mailto:#1}%
2631 \setbox0 = \hbox{\ignorespaces #2}%
2632 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2633 \endlink
2634 \endgroup}
2635 \else
2636 \let\email=\uref
2639 % Check if we are currently using a typewriter font. Since all the
2640 % Computer Modern typewriter fonts have zero interword stretch (and
2641 % shrink), and it is reasonable to expect all typewriter fonts to have
2642 % this property, we can check that font parameter.
2644 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2646 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2647 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2649 \def\dmn#1{\thinspace #1}
2651 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2653 % @l was never documented to mean ``switch to the Lisp font'',
2654 % and it is not used as such in any manual I can find. We need it for
2655 % Polish suppressed-l. --karl, 22sep96.
2656 %\def\l#1{{\li #1}\null}
2658 % Explicit font changes: @r, @sc, undocumented @ii.
2659 \def\r#1{{\rm #1}} % roman font
2660 \def\sc#1{{\smallcaps#1}} % smallcaps font
2661 \def\ii#1{{\it #1}} % italic font
2663 % @acronym for "FBI", "NATO", and the like.
2664 % We print this one point size smaller, since it's intended for
2665 % all-uppercase.
2667 \def\acronym#1{\doacronym #1,,\finish}
2668 \def\doacronym#1,#2,#3\finish{%
2669 {\selectfonts\lsize #1}%
2670 \def\temp{#2}%
2671 \ifx\temp\empty \else
2672 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2676 % @abbr for "Comput. J." and the like.
2677 % No font change, but don't do end-of-sentence spacing.
2679 \def\abbr#1{\doabbr #1,,\finish}
2680 \def\doabbr#1,#2,#3\finish{%
2681 {\plainfrenchspacing #1}%
2682 \def\temp{#2}%
2683 \ifx\temp\empty \else
2684 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2688 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2690 \def\pounds{{\it\$}}
2692 % @euro{} comes from a separate font, depending on the current style.
2693 % We use the free feym* fonts from the eurosym package by Henrik
2694 % Theiling, which support regular, slanted, bold and bold slanted (and
2695 % "outlined" (blackboard board, sort of) versions, which we don't need).
2696 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2698 % Although only regular is the truly official Euro symbol, we ignore
2699 % that. The Euro is designed to be slightly taller than the regular
2700 % font height.
2702 % feymr - regular
2703 % feymo - slanted
2704 % feybr - bold
2705 % feybo - bold slanted
2707 % There is no good (free) typewriter version, to my knowledge.
2708 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2709 % Hmm.
2711 % Also doesn't work in math. Do we need to do math with euro symbols?
2712 % Hope not.
2715 \def\euro{{\eurofont e}}
2716 \def\eurofont{%
2717 % We set the font at each command, rather than predefining it in
2718 % \textfonts and the other font-switching commands, so that
2719 % installations which never need the symbol don't have to have the
2720 % font installed.
2722 % There is only one designed size (nominal 10pt), so we always scale
2723 % that to the current nominal size.
2725 % By the way, simply using "at 1em" works for cmr10 and the like, but
2726 % does not work for cmbx10 and other extended/shrunken fonts.
2728 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2730 \ifx\curfontstyle\bfstylename
2731 % bold:
2732 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2733 \else
2734 % regular:
2735 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2737 \thiseurofont
2740 % Hacks for glyphs from the EC fonts similar to \euro. We don't
2741 % use \let for the aliases, because sometimes we redefine the original
2742 % macro, and the alias should reflect the redefinition.
2743 \def\guillemetleft{{\ecfont \char"13}}
2744 \def\guillemotleft{\guillemetleft}
2745 \def\guillemetright{{\ecfont \char"14}}
2746 \def\guillemotright{\guillemetright}
2747 \def\guilsinglleft{{\ecfont \char"0E}}
2748 \def\guilsinglright{{\ecfont \char"0F}}
2749 \def\quotedblbase{{\ecfont \char"12}}
2750 \def\quotesinglbase{{\ecfont \char"0D}}
2752 \def\ecfont{%
2753 % We can't distinguish serif/sanserif and italic/slanted, but this
2754 % is used for crude hacks anyway (like adding French and German
2755 % quotes to documents typeset with CM, where we lose kerning), so
2756 % hopefully nobody will notice/care.
2757 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
2758 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
2759 \ifx\curfontstyle\bfstylename
2760 % bold:
2761 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
2762 \else
2763 % regular:
2764 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
2766 \thisecfont
2769 % @registeredsymbol - R in a circle. The font for the R should really
2770 % be smaller yet, but lllsize is the best we can do for now.
2771 % Adapted from the plain.tex definition of \copyright.
2773 \def\registeredsymbol{%
2774 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2775 \hfil\crcr\Orb}}%
2779 % @textdegree - the normal degrees sign.
2781 \def\textdegree{$^\circ$}
2783 % Laurent Siebenmann reports \Orb undefined with:
2784 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2785 % so we'll define it if necessary.
2787 \ifx\Orb\undefined
2788 \def\Orb{\mathhexbox20D}
2791 % Quotes.
2792 \chardef\quotedblleft="5C
2793 \chardef\quotedblright=`\"
2794 \chardef\quoteleft=`\`
2795 \chardef\quoteright=`\'
2798 \message{page headings,}
2800 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2801 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2803 % First the title page. Must do @settitle before @titlepage.
2804 \newif\ifseenauthor
2805 \newif\iffinishedtitlepage
2807 % Do an implicit @contents or @shortcontents after @end titlepage if the
2808 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2810 \newif\ifsetcontentsaftertitlepage
2811 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2812 \newif\ifsetshortcontentsaftertitlepage
2813 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2815 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2816 \endgroup\page\hbox{}\page}
2818 \envdef\titlepage{%
2819 % Open one extra group, as we want to close it in the middle of \Etitlepage.
2820 \begingroup
2821 \parindent=0pt \textfonts
2822 % Leave some space at the very top of the page.
2823 \vglue\titlepagetopglue
2824 % No rule at page bottom unless we print one at the top with @title.
2825 \finishedtitlepagetrue
2827 % Most title ``pages'' are actually two pages long, with space
2828 % at the top of the second. We don't want the ragged left on the second.
2829 \let\oldpage = \page
2830 \def\page{%
2831 \iffinishedtitlepage\else
2832 \finishtitlepage
2834 \let\page = \oldpage
2835 \page
2836 \null
2840 \def\Etitlepage{%
2841 \iffinishedtitlepage\else
2842 \finishtitlepage
2844 % It is important to do the page break before ending the group,
2845 % because the headline and footline are only empty inside the group.
2846 % If we use the new definition of \page, we always get a blank page
2847 % after the title page, which we certainly don't want.
2848 \oldpage
2849 \endgroup
2851 % Need this before the \...aftertitlepage checks so that if they are
2852 % in effect the toc pages will come out with page numbers.
2853 \HEADINGSon
2855 % If they want short, they certainly want long too.
2856 \ifsetshortcontentsaftertitlepage
2857 \shortcontents
2858 \contents
2859 \global\let\shortcontents = \relax
2860 \global\let\contents = \relax
2863 \ifsetcontentsaftertitlepage
2864 \contents
2865 \global\let\contents = \relax
2866 \global\let\shortcontents = \relax
2870 \def\finishtitlepage{%
2871 \vskip4pt \hrule height 2pt width \hsize
2872 \vskip\titlepagebottomglue
2873 \finishedtitlepagetrue
2876 %%% Macros to be used within @titlepage:
2878 \let\subtitlerm=\tenrm
2879 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2881 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2882 \let\tt=\authortt}
2884 \parseargdef\title{%
2885 \checkenv\titlepage
2886 \leftline{\titlefonts\rm #1}
2887 % print a rule at the page bottom also.
2888 \finishedtitlepagefalse
2889 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2892 \parseargdef\subtitle{%
2893 \checkenv\titlepage
2894 {\subtitlefont \rightline{#1}}%
2897 % @author should come last, but may come many times.
2898 % It can also be used inside @quotation.
2900 \parseargdef\author{%
2901 \def\temp{\quotation}%
2902 \ifx\thisenv\temp
2903 \def\quotationauthor{#1}% printed in \Equotation.
2904 \else
2905 \checkenv\titlepage
2906 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2907 {\authorfont \leftline{#1}}%
2912 %%% Set up page headings and footings.
2914 \let\thispage=\folio
2916 \newtoks\evenheadline % headline on even pages
2917 \newtoks\oddheadline % headline on odd pages
2918 \newtoks\evenfootline % footline on even pages
2919 \newtoks\oddfootline % footline on odd pages
2921 % Now make TeX use those variables
2922 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2923 \else \the\evenheadline \fi}}
2924 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2925 \else \the\evenfootline \fi}\HEADINGShook}
2926 \let\HEADINGShook=\relax
2928 % Commands to set those variables.
2929 % For example, this is what @headings on does
2930 % @evenheading @thistitle|@thispage|@thischapter
2931 % @oddheading @thischapter|@thispage|@thistitle
2932 % @evenfooting @thisfile||
2933 % @oddfooting ||@thisfile
2936 \def\evenheading{\parsearg\evenheadingxxx}
2937 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2938 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2939 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2941 \def\oddheading{\parsearg\oddheadingxxx}
2942 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2943 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2944 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2946 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2948 \def\evenfooting{\parsearg\evenfootingxxx}
2949 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2950 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2951 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2953 \def\oddfooting{\parsearg\oddfootingxxx}
2954 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2955 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2956 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2958 % Leave some space for the footline. Hopefully ok to assume
2959 % @evenfooting will not be used by itself.
2960 \global\advance\pageheight by -12pt
2961 \global\advance\vsize by -12pt
2964 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2966 % @evenheadingmarks top \thischapter <- chapter at the top of a page
2967 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
2969 % The same set of arguments for:
2971 % @oddheadingmarks
2972 % @evenfootingmarks
2973 % @oddfootingmarks
2974 % @everyheadingmarks
2975 % @everyfootingmarks
2977 \def\evenheadingmarks{\headingmarks{even}{heading}}
2978 \def\oddheadingmarks{\headingmarks{odd}{heading}}
2979 \def\evenfootingmarks{\headingmarks{even}{footing}}
2980 \def\oddfootingmarks{\headingmarks{odd}{footing}}
2981 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
2982 \headingmarks{odd}{heading}{#1} }
2983 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
2984 \headingmarks{odd}{footing}{#1} }
2985 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
2986 \def\headingmarks#1#2#3 {%
2987 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
2988 \global\expandafter\let\csname get#1#2marks\endcsname \temp
2991 \everyheadingmarks bottom
2992 \everyfootingmarks bottom
2994 % @headings double turns headings on for double-sided printing.
2995 % @headings single turns headings on for single-sided printing.
2996 % @headings off turns them off.
2997 % @headings on same as @headings double, retained for compatibility.
2998 % @headings after turns on double-sided headings after this page.
2999 % @headings doubleafter turns on double-sided headings after this page.
3000 % @headings singleafter turns on single-sided headings after this page.
3001 % By default, they are off at the start of a document,
3002 % and turned `on' after @end titlepage.
3004 \def\headings #1 {\csname HEADINGS#1\endcsname}
3006 \def\HEADINGSoff{%
3007 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
3008 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
3009 \HEADINGSoff
3010 % When we turn headings on, set the page number to 1.
3011 % For double-sided printing, put current file name in lower left corner,
3012 % chapter name on inside top of right hand pages, document
3013 % title on inside top of left hand pages, and page numbers on outside top
3014 % edge of all pages.
3015 \def\HEADINGSdouble{%
3016 \global\pageno=1
3017 \global\evenfootline={\hfil}
3018 \global\oddfootline={\hfil}
3019 \global\evenheadline={\line{\folio\hfil\thistitle}}
3020 \global\oddheadline={\line{\thischapter\hfil\folio}}
3021 \global\let\contentsalignmacro = \chapoddpage
3023 \let\contentsalignmacro = \chappager
3025 % For single-sided printing, chapter title goes across top left of page,
3026 % page number on top right.
3027 \def\HEADINGSsingle{%
3028 \global\pageno=1
3029 \global\evenfootline={\hfil}
3030 \global\oddfootline={\hfil}
3031 \global\evenheadline={\line{\thischapter\hfil\folio}}
3032 \global\oddheadline={\line{\thischapter\hfil\folio}}
3033 \global\let\contentsalignmacro = \chappager
3035 \def\HEADINGSon{\HEADINGSdouble}
3037 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3038 \let\HEADINGSdoubleafter=\HEADINGSafter
3039 \def\HEADINGSdoublex{%
3040 \global\evenfootline={\hfil}
3041 \global\oddfootline={\hfil}
3042 \global\evenheadline={\line{\folio\hfil\thistitle}}
3043 \global\oddheadline={\line{\thischapter\hfil\folio}}
3044 \global\let\contentsalignmacro = \chapoddpage
3047 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3048 \def\HEADINGSsinglex{%
3049 \global\evenfootline={\hfil}
3050 \global\oddfootline={\hfil}
3051 \global\evenheadline={\line{\thischapter\hfil\folio}}
3052 \global\oddheadline={\line{\thischapter\hfil\folio}}
3053 \global\let\contentsalignmacro = \chappager
3056 % Subroutines used in generating headings
3057 % This produces Day Month Year style of output.
3058 % Only define if not already defined, in case a txi-??.tex file has set
3059 % up a different format (e.g., txi-cs.tex does this).
3060 \ifx\today\undefined
3061 \def\today{%
3062 \number\day\space
3063 \ifcase\month
3064 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3065 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3066 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3068 \space\number\year}
3071 % @settitle line... specifies the title of the document, for headings.
3072 % It generates no output of its own.
3073 \def\thistitle{\putwordNoTitle}
3074 \def\settitle{\parsearg{\gdef\thistitle}}
3077 \message{tables,}
3078 % Tables -- @table, @ftable, @vtable, @item(x).
3080 % default indentation of table text
3081 \newdimen\tableindent \tableindent=.8in
3082 % default indentation of @itemize and @enumerate text
3083 \newdimen\itemindent \itemindent=.3in
3084 % margin between end of table item and start of table text.
3085 \newdimen\itemmargin \itemmargin=.1in
3087 % used internally for \itemindent minus \itemmargin
3088 \newdimen\itemmax
3090 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3091 % these defs.
3092 % They also define \itemindex
3093 % to index the item name in whatever manner is desired (perhaps none).
3095 \newif\ifitemxneedsnegativevskip
3097 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3099 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3100 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3102 \def\itemzzz #1{\begingroup %
3103 \advance\hsize by -\rightskip
3104 \advance\hsize by -\tableindent
3105 \setbox0=\hbox{\itemindicate{#1}}%
3106 \itemindex{#1}%
3107 \nobreak % This prevents a break before @itemx.
3109 % If the item text does not fit in the space we have, put it on a line
3110 % by itself, and do not allow a page break either before or after that
3111 % line. We do not start a paragraph here because then if the next
3112 % command is, e.g., @kindex, the whatsit would get put into the
3113 % horizontal list on a line by itself, resulting in extra blank space.
3114 \ifdim \wd0>\itemmax
3116 % Make this a paragraph so we get the \parskip glue and wrapping,
3117 % but leave it ragged-right.
3118 \begingroup
3119 \advance\leftskip by-\tableindent
3120 \advance\hsize by\tableindent
3121 \advance\rightskip by0pt plus1fil
3122 \leavevmode\unhbox0\par
3123 \endgroup
3125 % We're going to be starting a paragraph, but we don't want the
3126 % \parskip glue -- logically it's part of the @item we just started.
3127 \nobreak \vskip-\parskip
3129 % Stop a page break at the \parskip glue coming up. However, if
3130 % what follows is an environment such as @example, there will be no
3131 % \parskip glue; then the negative vskip we just inserted would
3132 % cause the example and the item to crash together. So we use this
3133 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3134 % \parskip glue after all. Section titles are handled this way also.
3136 \penalty 10001
3137 \endgroup
3138 \itemxneedsnegativevskipfalse
3139 \else
3140 % The item text fits into the space. Start a paragraph, so that the
3141 % following text (if any) will end up on the same line.
3142 \noindent
3143 % Do this with kerns and \unhbox so that if there is a footnote in
3144 % the item text, it can migrate to the main vertical list and
3145 % eventually be printed.
3146 \nobreak\kern-\tableindent
3147 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3148 \unhbox0
3149 \nobreak\kern\dimen0
3150 \endgroup
3151 \itemxneedsnegativevskiptrue
3155 \def\item{\errmessage{@item while not in a list environment}}
3156 \def\itemx{\errmessage{@itemx while not in a list environment}}
3158 % @table, @ftable, @vtable.
3159 \envdef\table{%
3160 \let\itemindex\gobble
3161 \tablecheck{table}%
3163 \envdef\ftable{%
3164 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3165 \tablecheck{ftable}%
3167 \envdef\vtable{%
3168 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3169 \tablecheck{vtable}%
3171 \def\tablecheck#1{%
3172 \ifnum \the\catcode`\^^M=\active
3173 \endgroup
3174 \errmessage{This command won't work in this context; perhaps the problem is
3175 that we are \inenvironment\thisenv}%
3176 \def\next{\doignore{#1}}%
3177 \else
3178 \let\next\tablex
3180 \next
3182 \def\tablex#1{%
3183 \def\itemindicate{#1}%
3184 \parsearg\tabley
3186 \def\tabley#1{%
3188 \makevalueexpandable
3189 \edef\temp{\noexpand\tablez #1\space\space\space}%
3190 \expandafter
3191 }\temp \endtablez
3193 \def\tablez #1 #2 #3 #4\endtablez{%
3194 \aboveenvbreak
3195 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3196 \ifnum 0#2>0 \tableindent=#2\mil \fi
3197 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3198 \itemmax=\tableindent
3199 \advance \itemmax by -\itemmargin
3200 \advance \leftskip by \tableindent
3201 \exdentamount=\tableindent
3202 \parindent = 0pt
3203 \parskip = \smallskipamount
3204 \ifdim \parskip=0pt \parskip=2pt \fi
3205 \let\item = \internalBitem
3206 \let\itemx = \internalBitemx
3208 \def\Etable{\endgraf\afterenvbreak}
3209 \let\Eftable\Etable
3210 \let\Evtable\Etable
3211 \let\Eitemize\Etable
3212 \let\Eenumerate\Etable
3214 % This is the counter used by @enumerate, which is really @itemize
3216 \newcount \itemno
3218 \envdef\itemize{\parsearg\doitemize}
3220 \def\doitemize#1{%
3221 \aboveenvbreak
3222 \itemmax=\itemindent
3223 \advance\itemmax by -\itemmargin
3224 \advance\leftskip by \itemindent
3225 \exdentamount=\itemindent
3226 \parindent=0pt
3227 \parskip=\smallskipamount
3228 \ifdim\parskip=0pt \parskip=2pt \fi
3229 \def\itemcontents{#1}%
3230 % @itemize with no arg is equivalent to @itemize @bullet.
3231 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3232 \let\item=\itemizeitem
3235 % Definition of @item while inside @itemize and @enumerate.
3237 \def\itemizeitem{%
3238 \advance\itemno by 1 % for enumerations
3239 {\let\par=\endgraf \smallbreak}% reasonable place to break
3241 % If the document has an @itemize directly after a section title, a
3242 % \nobreak will be last on the list, and \sectionheading will have
3243 % done a \vskip-\parskip. In that case, we don't want to zero
3244 % parskip, or the item text will crash with the heading. On the
3245 % other hand, when there is normal text preceding the item (as there
3246 % usually is), we do want to zero parskip, or there would be too much
3247 % space. In that case, we won't have a \nobreak before. At least
3248 % that's the theory.
3249 \ifnum\lastpenalty<10000 \parskip=0in \fi
3250 \noindent
3251 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3252 \vadjust{\penalty 1200}}% not good to break after first line of item.
3253 \flushcr
3256 % \splitoff TOKENS\endmark defines \first to be the first token in
3257 % TOKENS, and \rest to be the remainder.
3259 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3261 % Allow an optional argument of an uppercase letter, lowercase letter,
3262 % or number, to specify the first label in the enumerated list. No
3263 % argument is the same as `1'.
3265 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3266 \def\enumeratey #1 #2\endenumeratey{%
3267 % If we were given no argument, pretend we were given `1'.
3268 \def\thearg{#1}%
3269 \ifx\thearg\empty \def\thearg{1}\fi
3271 % Detect if the argument is a single token. If so, it might be a
3272 % letter. Otherwise, the only valid thing it can be is a number.
3273 % (We will always have one token, because of the test we just made.
3274 % This is a good thing, since \splitoff doesn't work given nothing at
3275 % all -- the first parameter is undelimited.)
3276 \expandafter\splitoff\thearg\endmark
3277 \ifx\rest\empty
3278 % Only one token in the argument. It could still be anything.
3279 % A ``lowercase letter'' is one whose \lccode is nonzero.
3280 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3281 % not equal to itself.
3282 % Otherwise, we assume it's a number.
3284 % We need the \relax at the end of the \ifnum lines to stop TeX from
3285 % continuing to look for a <number>.
3287 \ifnum\lccode\expandafter`\thearg=0\relax
3288 \numericenumerate % a number (we hope)
3289 \else
3290 % It's a letter.
3291 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3292 \lowercaseenumerate % lowercase letter
3293 \else
3294 \uppercaseenumerate % uppercase letter
3297 \else
3298 % Multiple tokens in the argument. We hope it's a number.
3299 \numericenumerate
3303 % An @enumerate whose labels are integers. The starting integer is
3304 % given in \thearg.
3306 \def\numericenumerate{%
3307 \itemno = \thearg
3308 \startenumeration{\the\itemno}%
3311 % The starting (lowercase) letter is in \thearg.
3312 \def\lowercaseenumerate{%
3313 \itemno = \expandafter`\thearg
3314 \startenumeration{%
3315 % Be sure we're not beyond the end of the alphabet.
3316 \ifnum\itemno=0
3317 \errmessage{No more lowercase letters in @enumerate; get a bigger
3318 alphabet}%
3320 \char\lccode\itemno
3324 % The starting (uppercase) letter is in \thearg.
3325 \def\uppercaseenumerate{%
3326 \itemno = \expandafter`\thearg
3327 \startenumeration{%
3328 % Be sure we're not beyond the end of the alphabet.
3329 \ifnum\itemno=0
3330 \errmessage{No more uppercase letters in @enumerate; get a bigger
3331 alphabet}
3333 \char\uccode\itemno
3337 % Call \doitemize, adding a period to the first argument and supplying the
3338 % common last two arguments. Also subtract one from the initial value in
3339 % \itemno, since @item increments \itemno.
3341 \def\startenumeration#1{%
3342 \advance\itemno by -1
3343 \doitemize{#1.}\flushcr
3346 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3347 % to @enumerate.
3349 \def\alphaenumerate{\enumerate{a}}
3350 \def\capsenumerate{\enumerate{A}}
3351 \def\Ealphaenumerate{\Eenumerate}
3352 \def\Ecapsenumerate{\Eenumerate}
3355 % @multitable macros
3356 % Amy Hendrickson, 8/18/94, 3/6/96
3358 % @multitable ... @end multitable will make as many columns as desired.
3359 % Contents of each column will wrap at width given in preamble. Width
3360 % can be specified either with sample text given in a template line,
3361 % or in percent of \hsize, the current width of text on page.
3363 % Table can continue over pages but will only break between lines.
3365 % To make preamble:
3367 % Either define widths of columns in terms of percent of \hsize:
3368 % @multitable @columnfractions .25 .3 .45
3369 % @item ...
3371 % Numbers following @columnfractions are the percent of the total
3372 % current hsize to be used for each column. You may use as many
3373 % columns as desired.
3376 % Or use a template:
3377 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3378 % @item ...
3379 % using the widest term desired in each column.
3381 % Each new table line starts with @item, each subsequent new column
3382 % starts with @tab. Empty columns may be produced by supplying @tab's
3383 % with nothing between them for as many times as empty columns are needed,
3384 % ie, @tab@tab@tab will produce two empty columns.
3386 % @item, @tab do not need to be on their own lines, but it will not hurt
3387 % if they are.
3389 % Sample multitable:
3391 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3392 % @item first col stuff @tab second col stuff @tab third col
3393 % @item
3394 % first col stuff
3395 % @tab
3396 % second col stuff
3397 % @tab
3398 % third col
3399 % @item first col stuff @tab second col stuff
3400 % @tab Many paragraphs of text may be used in any column.
3402 % They will wrap at the width determined by the template.
3403 % @item@tab@tab This will be in third column.
3404 % @end multitable
3406 % Default dimensions may be reset by user.
3407 % @multitableparskip is vertical space between paragraphs in table.
3408 % @multitableparindent is paragraph indent in table.
3409 % @multitablecolmargin is horizontal space to be left between columns.
3410 % @multitablelinespace is space to leave between table items, baseline
3411 % to baseline.
3412 % 0pt means it depends on current normal line spacing.
3414 \newskip\multitableparskip
3415 \newskip\multitableparindent
3416 \newdimen\multitablecolspace
3417 \newskip\multitablelinespace
3418 \multitableparskip=0pt
3419 \multitableparindent=6pt
3420 \multitablecolspace=12pt
3421 \multitablelinespace=0pt
3423 % Macros used to set up halign preamble:
3425 \let\endsetuptable\relax
3426 \def\xendsetuptable{\endsetuptable}
3427 \let\columnfractions\relax
3428 \def\xcolumnfractions{\columnfractions}
3429 \newif\ifsetpercent
3431 % #1 is the @columnfraction, usually a decimal number like .5, but might
3432 % be just 1. We just use it, whatever it is.
3434 \def\pickupwholefraction#1 {%
3435 \global\advance\colcount by 1
3436 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3437 \setuptable
3440 \newcount\colcount
3441 \def\setuptable#1{%
3442 \def\firstarg{#1}%
3443 \ifx\firstarg\xendsetuptable
3444 \let\go = \relax
3445 \else
3446 \ifx\firstarg\xcolumnfractions
3447 \global\setpercenttrue
3448 \else
3449 \ifsetpercent
3450 \let\go\pickupwholefraction
3451 \else
3452 \global\advance\colcount by 1
3453 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3454 % separator; typically that is always in the input, anyway.
3455 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3458 \ifx\go\pickupwholefraction
3459 % Put the argument back for the \pickupwholefraction call, so
3460 % we'll always have a period there to be parsed.
3461 \def\go{\pickupwholefraction#1}%
3462 \else
3463 \let\go = \setuptable
3464 \fi%
3469 % multitable-only commands.
3471 % @headitem starts a heading row, which we typeset in bold.
3472 % Assignments have to be global since we are inside the implicit group
3473 % of an alignment entry. Note that \everycr resets \everytab.
3474 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
3476 % A \tab used to include \hskip1sp. But then the space in a template
3477 % line is not enough. That is bad. So let's go back to just `&' until
3478 % we encounter the problem it was intended to solve again.
3479 % --karl, nathan@acm.org, 20apr99.
3480 \def\tab{\checkenv\multitable &\the\everytab}%
3482 % @multitable ... @end multitable definitions:
3484 \newtoks\everytab % insert after every tab.
3486 \envdef\multitable{%
3487 \vskip\parskip
3488 \startsavinginserts
3490 % @item within a multitable starts a normal row.
3491 % We use \def instead of \let so that if one of the multitable entries
3492 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3493 % \endtemplate) expanding \doitemize.
3494 \def\item{\crcr}%
3496 \tolerance=9500
3497 \hbadness=9500
3498 \setmultitablespacing
3499 \parskip=\multitableparskip
3500 \parindent=\multitableparindent
3501 \overfullrule=0pt
3502 \global\colcount=0
3504 \everycr = {%
3505 \noalign{%
3506 \global\everytab={}%
3507 \global\colcount=0 % Reset the column counter.
3508 % Check for saved footnotes, etc.
3509 \checkinserts
3510 % Keeps underfull box messages off when table breaks over pages.
3511 %\filbreak
3512 % Maybe so, but it also creates really weird page breaks when the
3513 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3514 % problem manifests itself, so it can be fixed for real --karl.
3518 \parsearg\domultitable
3520 \def\domultitable#1{%
3521 % To parse everything between @multitable and @item:
3522 \setuptable#1 \endsetuptable
3524 % This preamble sets up a generic column definition, which will
3525 % be used as many times as user calls for columns.
3526 % \vtop will set a single line and will also let text wrap and
3527 % continue for many paragraphs if desired.
3528 \halign\bgroup &%
3529 \global\advance\colcount by 1
3530 \multistrut
3531 \vtop{%
3532 % Use the current \colcount to find the correct column width:
3533 \hsize=\expandafter\csname col\the\colcount\endcsname
3535 % In order to keep entries from bumping into each other
3536 % we will add a \leftskip of \multitablecolspace to all columns after
3537 % the first one.
3539 % If a template has been used, we will add \multitablecolspace
3540 % to the width of each template entry.
3542 % If the user has set preamble in terms of percent of \hsize we will
3543 % use that dimension as the width of the column, and the \leftskip
3544 % will keep entries from bumping into each other. Table will start at
3545 % left margin and final column will justify at right margin.
3547 % Make sure we don't inherit \rightskip from the outer environment.
3548 \rightskip=0pt
3549 \ifnum\colcount=1
3550 % The first column will be indented with the surrounding text.
3551 \advance\hsize by\leftskip
3552 \else
3553 \ifsetpercent \else
3554 % If user has not set preamble in terms of percent of \hsize
3555 % we will advance \hsize by \multitablecolspace.
3556 \advance\hsize by \multitablecolspace
3558 % In either case we will make \leftskip=\multitablecolspace:
3559 \leftskip=\multitablecolspace
3561 % Ignoring space at the beginning and end avoids an occasional spurious
3562 % blank line, when TeX decides to break the line at the space before the
3563 % box from the multistrut, so the strut ends up on a line by itself.
3564 % For example:
3565 % @multitable @columnfractions .11 .89
3566 % @item @code{#}
3567 % @tab Legal holiday which is valid in major parts of the whole country.
3568 % Is automatically provided with highlighting sequences respectively
3569 % marking characters.
3570 \noindent\ignorespaces##\unskip\multistrut
3571 }\cr
3573 \def\Emultitable{%
3574 \crcr
3575 \egroup % end the \halign
3576 \global\setpercentfalse
3579 \def\setmultitablespacing{%
3580 \def\multistrut{\strut}% just use the standard line spacing
3582 % Compute \multitablelinespace (if not defined by user) for use in
3583 % \multitableparskip calculation. We used define \multistrut based on
3584 % this, but (ironically) that caused the spacing to be off.
3585 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3586 \ifdim\multitablelinespace=0pt
3587 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3588 \global\advance\multitablelinespace by-\ht0
3590 %% Test to see if parskip is larger than space between lines of
3591 %% table. If not, do nothing.
3592 %% If so, set to same dimension as multitablelinespace.
3593 \ifdim\multitableparskip>\multitablelinespace
3594 \global\multitableparskip=\multitablelinespace
3595 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3596 %% than skip between lines in the table.
3597 \fi%
3598 \ifdim\multitableparskip=0pt
3599 \global\multitableparskip=\multitablelinespace
3600 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3601 %% than skip between lines in the table.
3602 \fi}
3605 \message{conditionals,}
3607 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3608 % @ifnotxml always succeed. They currently do nothing; we don't
3609 % attempt to check whether the conditionals are properly nested. But we
3610 % have to remember that they are conditionals, so that @end doesn't
3611 % attempt to close an environment group.
3613 \def\makecond#1{%
3614 \expandafter\let\csname #1\endcsname = \relax
3615 \expandafter\let\csname iscond.#1\endcsname = 1
3617 \makecond{iftex}
3618 \makecond{ifnotdocbook}
3619 \makecond{ifnothtml}
3620 \makecond{ifnotinfo}
3621 \makecond{ifnotplaintext}
3622 \makecond{ifnotxml}
3624 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3626 \def\direntry{\doignore{direntry}}
3627 \def\documentdescription{\doignore{documentdescription}}
3628 \def\docbook{\doignore{docbook}}
3629 \def\html{\doignore{html}}
3630 \def\ifdocbook{\doignore{ifdocbook}}
3631 \def\ifhtml{\doignore{ifhtml}}
3632 \def\ifinfo{\doignore{ifinfo}}
3633 \def\ifnottex{\doignore{ifnottex}}
3634 \def\ifplaintext{\doignore{ifplaintext}}
3635 \def\ifxml{\doignore{ifxml}}
3636 \def\ignore{\doignore{ignore}}
3637 \def\menu{\doignore{menu}}
3638 \def\xml{\doignore{xml}}
3640 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3642 % A count to remember the depth of nesting.
3643 \newcount\doignorecount
3645 \def\doignore#1{\begingroup
3646 % Scan in ``verbatim'' mode:
3647 \obeylines
3648 \catcode`\@ = \other
3649 \catcode`\{ = \other
3650 \catcode`\} = \other
3652 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3653 \spaceisspace
3655 % Count number of #1's that we've seen.
3656 \doignorecount = 0
3658 % Swallow text until we reach the matching `@end #1'.
3659 \dodoignore{#1}%
3662 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3663 \obeylines %
3665 \gdef\dodoignore#1{%
3666 % #1 contains the command name as a string, e.g., `ifinfo'.
3668 % Define a command to find the next `@end #1'.
3669 \long\def\doignoretext##1^^M@end #1{%
3670 \doignoretextyyy##1^^M@#1\_STOP_}%
3672 % And this command to find another #1 command, at the beginning of a
3673 % line. (Otherwise, we would consider a line `@c @ifset', for
3674 % example, to count as an @ifset for nesting.)
3675 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3677 % And now expand that command.
3678 \doignoretext ^^M%
3682 \def\doignoreyyy#1{%
3683 \def\temp{#1}%
3684 \ifx\temp\empty % Nothing found.
3685 \let\next\doignoretextzzz
3686 \else % Found a nested condition, ...
3687 \advance\doignorecount by 1
3688 \let\next\doignoretextyyy % ..., look for another.
3689 % If we're here, #1 ends with ^^M\ifinfo (for example).
3691 \next #1% the token \_STOP_ is present just after this macro.
3694 % We have to swallow the remaining "\_STOP_".
3696 \def\doignoretextzzz#1{%
3697 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3698 \let\next\enddoignore
3699 \else % Still inside a nested condition.
3700 \advance\doignorecount by -1
3701 \let\next\doignoretext % Look for the next @end.
3703 \next
3706 % Finish off ignored text.
3707 { \obeylines%
3708 % Ignore anything after the last `@end #1'; this matters in verbatim
3709 % environments, where otherwise the newline after an ignored conditional
3710 % would result in a blank line in the output.
3711 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3715 % @set VAR sets the variable VAR to an empty value.
3716 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3718 % Since we want to separate VAR from REST-OF-LINE (which might be
3719 % empty), we can't just use \parsearg; we have to insert a space of our
3720 % own to delimit the rest of the line, and then take it out again if we
3721 % didn't need it.
3722 % We rely on the fact that \parsearg sets \catcode`\ =10.
3724 \parseargdef\set{\setyyy#1 \endsetyyy}
3725 \def\setyyy#1 #2\endsetyyy{%
3727 \makevalueexpandable
3728 \def\temp{#2}%
3729 \edef\next{\gdef\makecsname{SET#1}}%
3730 \ifx\temp\empty
3731 \next{}%
3732 \else
3733 \setzzz#2\endsetzzz
3737 % Remove the trailing space \setxxx inserted.
3738 \def\setzzz#1 \endsetzzz{\next{#1}}
3740 % @clear VAR clears (i.e., unsets) the variable VAR.
3742 \parseargdef\clear{%
3744 \makevalueexpandable
3745 \global\expandafter\let\csname SET#1\endcsname=\relax
3749 % @value{foo} gets the text saved in variable foo.
3750 \def\value{\begingroup\makevalueexpandable\valuexxx}
3751 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3753 \catcode`\- = \active \catcode`\_ = \active
3755 \gdef\makevalueexpandable{%
3756 \let\value = \expandablevalue
3757 % We don't want these characters active, ...
3758 \catcode`\-=\other \catcode`\_=\other
3759 % ..., but we might end up with active ones in the argument if
3760 % we're called from @code, as @code{@value{foo-bar_}}, though.
3761 % So \let them to their normal equivalents.
3762 \let-\realdash \let_\normalunderscore
3766 % We have this subroutine so that we can handle at least some @value's
3767 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3768 % The command has to be fully expandable (if the variable is set), since
3769 % the result winds up in the index file. This means that if the
3770 % variable's value contains other Texinfo commands, it's almost certain
3771 % it will fail (although perhaps we could fix that with sufficient work
3772 % to do a one-level expansion on the result, instead of complete).
3774 \def\expandablevalue#1{%
3775 \expandafter\ifx\csname SET#1\endcsname\relax
3776 {[No value for ``#1'']}%
3777 \message{Variable `#1', used in @value, is not set.}%
3778 \else
3779 \csname SET#1\endcsname
3783 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3784 % with @set.
3786 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3788 \makecond{ifset}
3789 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3790 \def\doifset#1#2{%
3792 \makevalueexpandable
3793 \let\next=\empty
3794 \expandafter\ifx\csname SET#2\endcsname\relax
3795 #1% If not set, redefine \next.
3797 \expandafter
3798 }\next
3800 \def\ifsetfail{\doignore{ifset}}
3802 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3803 % defined with @set, or has been undefined with @clear.
3805 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3806 % above code: if the variable is not set, do nothing, if it is set,
3807 % then redefine \next to \ifclearfail.
3809 \makecond{ifclear}
3810 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3811 \def\ifclearfail{\doignore{ifclear}}
3813 % @dircategory CATEGORY -- specify a category of the dir file
3814 % which this file should belong to. Ignore this in TeX.
3815 \let\dircategory=\comment
3817 % @defininfoenclose.
3818 \let\definfoenclose=\comment
3821 \message{indexing,}
3822 % Index generation facilities
3824 % Define \newwrite to be identical to plain tex's \newwrite
3825 % except not \outer, so it can be used within macros and \if's.
3826 \edef\newwrite{\makecsname{ptexnewwrite}}
3828 % \newindex {foo} defines an index named foo.
3829 % It automatically defines \fooindex such that
3830 % \fooindex ...rest of line... puts an entry in the index foo.
3831 % It also defines \fooindfile to be the number of the output channel for
3832 % the file that accumulates this index. The file's extension is foo.
3833 % The name of an index should be no more than 2 characters long
3834 % for the sake of vms.
3836 \def\newindex#1{%
3837 \iflinks
3838 \expandafter\newwrite \csname#1indfile\endcsname
3839 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3841 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3842 \noexpand\doindex{#1}}
3845 % @defindex foo == \newindex{foo}
3847 \def\defindex{\parsearg\newindex}
3849 % Define @defcodeindex, like @defindex except put all entries in @code.
3851 \def\defcodeindex{\parsearg\newcodeindex}
3853 \def\newcodeindex#1{%
3854 \iflinks
3855 \expandafter\newwrite \csname#1indfile\endcsname
3856 \openout \csname#1indfile\endcsname \jobname.#1
3858 \expandafter\xdef\csname#1index\endcsname{%
3859 \noexpand\docodeindex{#1}}%
3863 % @synindex foo bar makes index foo feed into index bar.
3864 % Do this instead of @defindex foo if you don't want it as a separate index.
3866 % @syncodeindex foo bar similar, but put all entries made for index foo
3867 % inside @code.
3869 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3870 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3872 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3873 % #3 the target index (bar).
3874 \def\dosynindex#1#2#3{%
3875 % Only do \closeout if we haven't already done it, else we'll end up
3876 % closing the target index.
3877 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3878 % The \closeout helps reduce unnecessary open files; the limit on the
3879 % Acorn RISC OS is a mere 16 files.
3880 \expandafter\closeout\csname#2indfile\endcsname
3881 \expandafter\let\csname\donesynindex#2\endcsname = 1
3883 % redefine \fooindfile:
3884 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3885 \expandafter\let\csname#2indfile\endcsname=\temp
3886 % redefine \fooindex:
3887 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3890 % Define \doindex, the driver for all \fooindex macros.
3891 % Argument #1 is generated by the calling \fooindex macro,
3892 % and it is "foo", the name of the index.
3894 % \doindex just uses \parsearg; it calls \doind for the actual work.
3895 % This is because \doind is more useful to call from other macros.
3897 % There is also \dosubind {index}{topic}{subtopic}
3898 % which makes an entry in a two-level index such as the operation index.
3900 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3901 \def\singleindexer #1{\doind{\indexname}{#1}}
3903 % like the previous two, but they put @code around the argument.
3904 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3905 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3907 % Take care of Texinfo commands that can appear in an index entry.
3908 % Since there are some commands we want to expand, and others we don't,
3909 % we have to laboriously prevent expansion for those that we don't.
3911 \def\indexdummies{%
3912 \escapechar = `\\ % use backslash in output files.
3913 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3914 \def\ {\realbackslash\space }%
3916 % Need these in case \tex is in effect and \{ is a \delimiter again.
3917 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3918 % braces and backslashes are used only as delimiters.
3919 \let\{ = \mylbrace
3920 \let\} = \myrbrace
3922 % I don't entirely understand this, but when an index entry is
3923 % generated from a macro call, the \endinput which \scanmacro inserts
3924 % causes processing to be prematurely terminated. This is,
3925 % apparently, because \indexsorttmp is fully expanded, and \endinput
3926 % is an expandable command. The redefinition below makes \endinput
3927 % disappear altogether for that purpose -- although logging shows that
3928 % processing continues to some further point. On the other hand, it
3929 % seems \endinput does not hurt in the printed index arg, since that
3930 % is still getting written without apparent harm.
3932 % Sample source (mac-idx3.tex, reported by Graham Percival to
3933 % help-texinfo, 22may06):
3934 % @macro funindex {WORD}
3935 % @findex xyz
3936 % @end macro
3937 % ...
3938 % @funindex commtest
3940 % The above is not enough to reproduce the bug, but it gives the flavor.
3942 % Sample whatsit resulting:
3943 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
3945 % So:
3946 \let\endinput = \empty
3948 % Do the redefinitions.
3949 \commondummies
3952 % For the aux and toc files, @ is the escape character. So we want to
3953 % redefine everything using @ as the escape character (instead of
3954 % \realbackslash, still used for index files). When everything uses @,
3955 % this will be simpler.
3957 \def\atdummies{%
3958 \def\@{@@}%
3959 \def\ {@ }%
3960 \let\{ = \lbraceatcmd
3961 \let\} = \rbraceatcmd
3963 % Do the redefinitions.
3964 \commondummies
3965 \otherbackslash
3968 % Called from \indexdummies and \atdummies.
3970 \def\commondummies{%
3972 % \definedummyword defines \#1 as \string\#1\space, thus effectively
3973 % preventing its expansion. This is used only for control% words,
3974 % not control letters, because the \space would be incorrect for
3975 % control characters, but is needed to separate the control word
3976 % from whatever follows.
3978 % For control letters, we have \definedummyletter, which omits the
3979 % space.
3981 % These can be used both for control words that take an argument and
3982 % those that do not. If it is followed by {arg} in the input, then
3983 % that will dutifully get written to the index (or wherever).
3985 \def\definedummyword ##1{\def##1{\string##1\space}}%
3986 \def\definedummyletter##1{\def##1{\string##1}}%
3987 \let\definedummyaccent\definedummyletter
3989 \commondummiesnofonts
3991 \definedummyletter\_%
3993 % Non-English letters.
3994 \definedummyword\AA
3995 \definedummyword\AE
3996 \definedummyword\L
3997 \definedummyword\OE
3998 \definedummyword\O
3999 \definedummyword\aa
4000 \definedummyword\ae
4001 \definedummyword\l
4002 \definedummyword\oe
4003 \definedummyword\o
4004 \definedummyword\ss
4005 \definedummyword\exclamdown
4006 \definedummyword\questiondown
4007 \definedummyword\ordf
4008 \definedummyword\ordm
4010 % Although these internal commands shouldn't show up, sometimes they do.
4011 \definedummyword\bf
4012 \definedummyword\gtr
4013 \definedummyword\hat
4014 \definedummyword\less
4015 \definedummyword\sf
4016 \definedummyword\sl
4017 \definedummyword\tclose
4018 \definedummyword\tt
4020 \definedummyword\LaTeX
4021 \definedummyword\TeX
4023 % Assorted special characters.
4024 \definedummyword\bullet
4025 \definedummyword\comma
4026 \definedummyword\copyright
4027 \definedummyword\registeredsymbol
4028 \definedummyword\dots
4029 \definedummyword\enddots
4030 \definedummyword\equiv
4031 \definedummyword\error
4032 \definedummyword\euro
4033 \definedummyword\guillemetleft
4034 \definedummyword\guillemetright
4035 \definedummyword\guilsinglleft
4036 \definedummyword\guilsinglright
4037 \definedummyword\expansion
4038 \definedummyword\minus
4039 \definedummyword\pounds
4040 \definedummyword\point
4041 \definedummyword\print
4042 \definedummyword\quotedblbase
4043 \definedummyword\quotedblleft
4044 \definedummyword\quotedblright
4045 \definedummyword\quoteleft
4046 \definedummyword\quoteright
4047 \definedummyword\quotesinglbase
4048 \definedummyword\result
4049 \definedummyword\textdegree
4051 % We want to disable all macros so that they are not expanded by \write.
4052 \macrolist
4054 \normalturnoffactive
4056 % Handle some cases of @value -- where it does not contain any
4057 % (non-fully-expandable) commands.
4058 \makevalueexpandable
4061 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4063 \def\commondummiesnofonts{%
4064 % Control letters and accents.
4065 \definedummyletter\!%
4066 \definedummyaccent\"%
4067 \definedummyaccent\'%
4068 \definedummyletter\*%
4069 \definedummyaccent\,%
4070 \definedummyletter\.%
4071 \definedummyletter\/%
4072 \definedummyletter\:%
4073 \definedummyaccent\=%
4074 \definedummyletter\?%
4075 \definedummyaccent\^%
4076 \definedummyaccent\`%
4077 \definedummyaccent\~%
4078 \definedummyword\u
4079 \definedummyword\v
4080 \definedummyword\H
4081 \definedummyword\dotaccent
4082 \definedummyword\ringaccent
4083 \definedummyword\tieaccent
4084 \definedummyword\ubaraccent
4085 \definedummyword\udotaccent
4086 \definedummyword\dotless
4088 % Texinfo font commands.
4089 \definedummyword\b
4090 \definedummyword\i
4091 \definedummyword\r
4092 \definedummyword\sc
4093 \definedummyword\t
4095 % Commands that take arguments.
4096 \definedummyword\acronym
4097 \definedummyword\cite
4098 \definedummyword\code
4099 \definedummyword\command
4100 \definedummyword\dfn
4101 \definedummyword\emph
4102 \definedummyword\env
4103 \definedummyword\file
4104 \definedummyword\kbd
4105 \definedummyword\key
4106 \definedummyword\math
4107 \definedummyword\option
4108 \definedummyword\pxref
4109 \definedummyword\ref
4110 \definedummyword\samp
4111 \definedummyword\strong
4112 \definedummyword\tie
4113 \definedummyword\uref
4114 \definedummyword\url
4115 \definedummyword\var
4116 \definedummyword\verb
4117 \definedummyword\w
4118 \definedummyword\xref
4121 % \indexnofonts is used when outputting the strings to sort the index
4122 % by, and when constructing control sequence names. It eliminates all
4123 % control sequences and just writes whatever the best ASCII sort string
4124 % would be for a given command (usually its argument).
4126 \def\indexnofonts{%
4127 % Accent commands should become @asis.
4128 \def\definedummyaccent##1{\let##1\asis}%
4129 % We can just ignore other control letters.
4130 \def\definedummyletter##1{\let##1\empty}%
4131 % Hopefully, all control words can become @asis.
4132 \let\definedummyword\definedummyaccent
4134 \commondummiesnofonts
4136 % Don't no-op \tt, since it isn't a user-level command
4137 % and is used in the definitions of the active chars like <, >, |, etc.
4138 % Likewise with the other plain tex font commands.
4139 %\let\tt=\asis
4141 \def\ { }%
4142 \def\@{@}%
4143 % how to handle braces?
4144 \def\_{\normalunderscore}%
4146 % Non-English letters.
4147 \def\AA{AA}%
4148 \def\AE{AE}%
4149 \def\L{L}%
4150 \def\OE{OE}%
4151 \def\O{O}%
4152 \def\aa{aa}%
4153 \def\ae{ae}%
4154 \def\l{l}%
4155 \def\oe{oe}%
4156 \def\o{o}%
4157 \def\ss{ss}%
4158 \def\exclamdown{!}%
4159 \def\questiondown{?}%
4160 \def\ordf{a}%
4161 \def\ordm{o}%
4163 \def\LaTeX{LaTeX}%
4164 \def\TeX{TeX}%
4166 % Assorted special characters.
4167 % (The following {} will end up in the sort string, but that's ok.)
4168 \def\bullet{bullet}%
4169 \def\comma{,}%
4170 \def\copyright{copyright}%
4171 \def\registeredsymbol{R}%
4172 \def\dots{...}%
4173 \def\enddots{...}%
4174 \def\equiv{==}%
4175 \def\error{error}%
4176 \def\euro{euro}%
4177 \def\guillemetleft{<<}%
4178 \def\guillemetright{>>}%
4179 \def\guilsinglleft{<}%
4180 \def\guilsinglright{>}%
4181 \def\expansion{==>}%
4182 \def\minus{-}%
4183 \def\pounds{pounds}%
4184 \def\point{.}%
4185 \def\print{-|}%
4186 \def\quotedblbase{"}%
4187 \def\quotedblleft{"}%
4188 \def\quotedblright{"}%
4189 \def\quoteleft{`}%
4190 \def\quoteright{'}%
4191 \def\quotesinglbase{,}%
4192 \def\result{=>}%
4193 \def\textdegree{degrees}%
4195 % We need to get rid of all macros, leaving only the arguments (if present).
4196 % Of course this is not nearly correct, but it is the best we can do for now.
4197 % makeinfo does not expand macros in the argument to @deffn, which ends up
4198 % writing an index entry, and texindex isn't prepared for an index sort entry
4199 % that starts with \.
4201 % Since macro invocations are followed by braces, we can just redefine them
4202 % to take a single TeX argument. The case of a macro invocation that
4203 % goes to end-of-line is not handled.
4205 \macrolist
4208 \let\indexbackslash=0 %overridden during \printindex.
4209 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4211 % Most index entries go through here, but \dosubind is the general case.
4212 % #1 is the index name, #2 is the entry text.
4213 \def\doind#1#2{\dosubind{#1}{#2}{}}
4215 % Workhorse for all \fooindexes.
4216 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4217 % empty if called from \doind, as we usually are (the main exception
4218 % is with most defuns, which call us directly).
4220 \def\dosubind#1#2#3{%
4221 \iflinks
4223 % Store the main index entry text (including the third arg).
4224 \toks0 = {#2}%
4225 % If third arg is present, precede it with a space.
4226 \def\thirdarg{#3}%
4227 \ifx\thirdarg\empty \else
4228 \toks0 = \expandafter{\the\toks0 \space #3}%
4231 \edef\writeto{\csname#1indfile\endcsname}%
4233 \safewhatsit\dosubindwrite
4238 % Write the entry in \toks0 to the index file:
4240 \def\dosubindwrite{%
4241 % Put the index entry in the margin if desired.
4242 \ifx\SETmarginindex\relax\else
4243 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4246 % Remember, we are within a group.
4247 \indexdummies % Must do this here, since \bf, etc expand at this stage
4248 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4249 % so it will be output as is; and it will print as backslash.
4251 % Process the index entry with all font commands turned off, to
4252 % get the string to sort by.
4253 {\indexnofonts
4254 \edef\temp{\the\toks0}% need full expansion
4255 \xdef\indexsorttmp{\temp}%
4258 % Set up the complete index entry, with both the sort key and
4259 % the original text, including any font commands. We write
4260 % three arguments to \entry to the .?? file (four in the
4261 % subentry case), texindex reduces to two when writing the .??s
4262 % sorted result.
4263 \edef\temp{%
4264 \write\writeto{%
4265 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4267 \temp
4270 % Take care of unwanted page breaks/skips around a whatsit:
4272 % If a skip is the last thing on the list now, preserve it
4273 % by backing up by \lastskip, doing the \write, then inserting
4274 % the skip again. Otherwise, the whatsit generated by the
4275 % \write or \pdfdest will make \lastskip zero. The result is that
4276 % sequences like this:
4277 % @end defun
4278 % @tindex whatever
4279 % @defun ...
4280 % will have extra space inserted, because the \medbreak in the
4281 % start of the @defun won't see the skip inserted by the @end of
4282 % the previous defun.
4284 % But don't do any of this if we're not in vertical mode. We
4285 % don't want to do a \vskip and prematurely end a paragraph.
4287 % Avoid page breaks due to these extra skips, too.
4289 % But wait, there is a catch there:
4290 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4291 % sufficient for this purpose, as it ignores stretch and shrink parts
4292 % of the skip. The only way seems to be to check the textual
4293 % representation of the skip.
4295 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4296 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4298 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4300 \newskip\whatsitskip
4301 \newcount\whatsitpenalty
4303 % ..., ready, GO:
4305 \def\safewhatsit#1{%
4306 \ifhmode
4308 \else
4309 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4310 \whatsitskip = \lastskip
4311 \edef\lastskipmacro{\the\lastskip}%
4312 \whatsitpenalty = \lastpenalty
4314 % If \lastskip is nonzero, that means the last item was a
4315 % skip. And since a skip is discardable, that means this
4316 % -\whatsitskip glue we're inserting is preceded by a
4317 % non-discardable item, therefore it is not a potential
4318 % breakpoint, therefore no \nobreak needed.
4319 \ifx\lastskipmacro\zeroskipmacro
4320 \else
4321 \vskip-\whatsitskip
4326 \ifx\lastskipmacro\zeroskipmacro
4327 % If \lastskip was zero, perhaps the last item was a penalty, and
4328 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4329 % to re-insert the same penalty (values >10000 are used for various
4330 % signals); since we just inserted a non-discardable item, any
4331 % following glue (such as a \parskip) would be a breakpoint. For example:
4333 % @deffn deffn-whatever
4334 % @vindex index-whatever
4335 % Description.
4336 % would allow a break between the index-whatever whatsit
4337 % and the "Description." paragraph.
4338 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4339 \else
4340 % On the other hand, if we had a nonzero \lastskip,
4341 % this make-up glue would be preceded by a non-discardable item
4342 % (the whatsit from the \write), so we must insert a \nobreak.
4343 \nobreak\vskip\whatsitskip
4348 % The index entry written in the file actually looks like
4349 % \entry {sortstring}{page}{topic}
4350 % or
4351 % \entry {sortstring}{page}{topic}{subtopic}
4352 % The texindex program reads in these files and writes files
4353 % containing these kinds of lines:
4354 % \initial {c}
4355 % before the first topic whose initial is c
4356 % \entry {topic}{pagelist}
4357 % for a topic that is used without subtopics
4358 % \primary {topic}
4359 % for the beginning of a topic that is used with subtopics
4360 % \secondary {subtopic}{pagelist}
4361 % for each subtopic.
4363 % Define the user-accessible indexing commands
4364 % @findex, @vindex, @kindex, @cindex.
4366 \def\findex {\fnindex}
4367 \def\kindex {\kyindex}
4368 \def\cindex {\cpindex}
4369 \def\vindex {\vrindex}
4370 \def\tindex {\tpindex}
4371 \def\pindex {\pgindex}
4373 \def\cindexsub {\begingroup\obeylines\cindexsub}
4374 {\obeylines %
4375 \gdef\cindexsub "#1" #2^^M{\endgroup %
4376 \dosubind{cp}{#2}{#1}}}
4378 % Define the macros used in formatting output of the sorted index material.
4380 % @printindex causes a particular index (the ??s file) to get printed.
4381 % It does not print any chapter heading (usually an @unnumbered).
4383 \parseargdef\printindex{\begingroup
4384 \dobreak \chapheadingskip{10000}%
4386 \smallfonts \rm
4387 \tolerance = 9500
4388 \plainfrenchspacing
4389 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4391 % See if the index file exists and is nonempty.
4392 % Change catcode of @ here so that if the index file contains
4393 % \initial {@}
4394 % as its first line, TeX doesn't complain about mismatched braces
4395 % (because it thinks @} is a control sequence).
4396 \catcode`\@ = 11
4397 \openin 1 \jobname.#1s
4398 \ifeof 1
4399 % \enddoublecolumns gets confused if there is no text in the index,
4400 % and it loses the chapter title and the aux file entries for the
4401 % index. The easiest way to prevent this problem is to make sure
4402 % there is some text.
4403 \putwordIndexNonexistent
4404 \else
4406 % If the index file exists but is empty, then \openin leaves \ifeof
4407 % false. We have to make TeX try to read something from the file, so
4408 % it can discover if there is anything in it.
4409 \read 1 to \temp
4410 \ifeof 1
4411 \putwordIndexIsEmpty
4412 \else
4413 % Index files are almost Texinfo source, but we use \ as the escape
4414 % character. It would be better to use @, but that's too big a change
4415 % to make right now.
4416 \def\indexbackslash{\backslashcurfont}%
4417 \catcode`\\ = 0
4418 \escapechar = `\\
4419 \begindoublecolumns
4420 \input \jobname.#1s
4421 \enddoublecolumns
4424 \closein 1
4425 \endgroup}
4427 % These macros are used by the sorted index file itself.
4428 % Change them to control the appearance of the index.
4430 \def\initial#1{{%
4431 % Some minor font changes for the special characters.
4432 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4434 % Remove any glue we may have, we'll be inserting our own.
4435 \removelastskip
4437 % We like breaks before the index initials, so insert a bonus.
4438 \nobreak
4439 \vskip 0pt plus 3\baselineskip
4440 \penalty 0
4441 \vskip 0pt plus -3\baselineskip
4443 % Typeset the initial. Making this add up to a whole number of
4444 % baselineskips increases the chance of the dots lining up from column
4445 % to column. It still won't often be perfect, because of the stretch
4446 % we need before each entry, but it's better.
4448 % No shrink because it confuses \balancecolumns.
4449 \vskip 1.67\baselineskip plus .5\baselineskip
4450 \leftline{\secbf #1}%
4451 % Do our best not to break after the initial.
4452 \nobreak
4453 \vskip .33\baselineskip plus .1\baselineskip
4456 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4457 % then page number (#2) flushed to the right margin. It is used for index
4458 % and table of contents entries. The paragraph is indented by \leftskip.
4460 % A straightforward implementation would start like this:
4461 % \def\entry#1#2{...
4462 % But this freezes the catcodes in the argument, and can cause problems to
4463 % @code, which sets - active. This problem was fixed by a kludge---
4464 % ``-'' was active throughout whole index, but this isn't really right.
4466 % The right solution is to prevent \entry from swallowing the whole text.
4467 % --kasal, 21nov03
4468 \def\entry{%
4469 \begingroup
4471 % Start a new paragraph if necessary, so our assignments below can't
4472 % affect previous text.
4473 \par
4475 % Do not fill out the last line with white space.
4476 \parfillskip = 0in
4478 % No extra space above this paragraph.
4479 \parskip = 0in
4481 % Do not prefer a separate line ending with a hyphen to fewer lines.
4482 \finalhyphendemerits = 0
4484 % \hangindent is only relevant when the entry text and page number
4485 % don't both fit on one line. In that case, bob suggests starting the
4486 % dots pretty far over on the line. Unfortunately, a large
4487 % indentation looks wrong when the entry text itself is broken across
4488 % lines. So we use a small indentation and put up with long leaders.
4490 % \hangafter is reset to 1 (which is the value we want) at the start
4491 % of each paragraph, so we need not do anything with that.
4492 \hangindent = 2em
4494 % When the entry text needs to be broken, just fill out the first line
4495 % with blank space.
4496 \rightskip = 0pt plus1fil
4498 % A bit of stretch before each entry for the benefit of balancing
4499 % columns.
4500 \vskip 0pt plus1pt
4502 % Swallow the left brace of the text (first parameter):
4503 \afterassignment\doentry
4504 \let\temp =
4506 \def\doentry{%
4507 \bgroup % Instead of the swallowed brace.
4508 \noindent
4509 \aftergroup\finishentry
4510 % And now comes the text of the entry.
4512 \def\finishentry#1{%
4513 % #1 is the page number.
4515 % The following is kludged to not output a line of dots in the index if
4516 % there are no page numbers. The next person who breaks this will be
4517 % cursed by a Unix daemon.
4518 \setbox\boxA = \hbox{#1}%
4519 \ifdim\wd\boxA = 0pt
4521 \else
4523 % If we must, put the page number on a line of its own, and fill out
4524 % this line with blank space. (The \hfil is overwhelmed with the
4525 % fill leaders glue in \indexdotfill if the page number does fit.)
4526 \hfil\penalty50
4527 \null\nobreak\indexdotfill % Have leaders before the page number.
4529 % The `\ ' here is removed by the implicit \unskip that TeX does as
4530 % part of (the primitive) \par. Without it, a spurious underfull
4531 % \hbox ensues.
4532 \ifpdf
4533 \pdfgettoks#1.%
4534 \ \the\toksA
4535 \else
4536 \ #1%
4539 \par
4540 \endgroup
4543 % Like plain.tex's \dotfill, except uses up at least 1 em.
4544 \def\indexdotfill{\cleaders
4545 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4547 \def\primary #1{\line{#1\hfil}}
4549 \newskip\secondaryindent \secondaryindent=0.5cm
4550 \def\secondary#1#2{{%
4551 \parfillskip=0in
4552 \parskip=0in
4553 \hangindent=1in
4554 \hangafter=1
4555 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4556 \ifpdf
4557 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4558 \else
4561 \par
4564 % Define two-column mode, which we use to typeset indexes.
4565 % Adapted from the TeXbook, page 416, which is to say,
4566 % the manmac.tex format used to print the TeXbook itself.
4567 \catcode`\@=11
4569 \newbox\partialpage
4570 \newdimen\doublecolumnhsize
4572 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4573 % Grab any single-column material above us.
4574 \output = {%
4576 % Here is a possibility not foreseen in manmac: if we accumulate a
4577 % whole lot of material, we might end up calling this \output
4578 % routine twice in a row (see the doublecol-lose test, which is
4579 % essentially a couple of indexes with @setchapternewpage off). In
4580 % that case we just ship out what is in \partialpage with the normal
4581 % output routine. Generally, \partialpage will be empty when this
4582 % runs and this will be a no-op. See the indexspread.tex test case.
4583 \ifvoid\partialpage \else
4584 \onepageout{\pagecontents\partialpage}%
4587 \global\setbox\partialpage = \vbox{%
4588 % Unvbox the main output page.
4589 \unvbox\PAGE
4590 \kern-\topskip \kern\baselineskip
4593 \eject % run that output routine to set \partialpage
4595 % Use the double-column output routine for subsequent pages.
4596 \output = {\doublecolumnout}%
4598 % Change the page size parameters. We could do this once outside this
4599 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4600 % format, but then we repeat the same computation. Repeating a couple
4601 % of assignments once per index is clearly meaningless for the
4602 % execution time, so we may as well do it in one place.
4604 % First we halve the line length, less a little for the gutter between
4605 % the columns. We compute the gutter based on the line length, so it
4606 % changes automatically with the paper format. The magic constant
4607 % below is chosen so that the gutter has the same value (well, +-<1pt)
4608 % as it did when we hard-coded it.
4610 % We put the result in a separate register, \doublecolumhsize, so we
4611 % can restore it in \pagesofar, after \hsize itself has (potentially)
4612 % been clobbered.
4614 \doublecolumnhsize = \hsize
4615 \advance\doublecolumnhsize by -.04154\hsize
4616 \divide\doublecolumnhsize by 2
4617 \hsize = \doublecolumnhsize
4619 % Double the \vsize as well. (We don't need a separate register here,
4620 % since nobody clobbers \vsize.)
4621 \vsize = 2\vsize
4624 % The double-column output routine for all double-column pages except
4625 % the last.
4627 \def\doublecolumnout{%
4628 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4629 % Get the available space for the double columns -- the normal
4630 % (undoubled) page height minus any material left over from the
4631 % previous page.
4632 \dimen@ = \vsize
4633 \divide\dimen@ by 2
4634 \advance\dimen@ by -\ht\partialpage
4636 % box0 will be the left-hand column, box2 the right.
4637 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4638 \onepageout\pagesofar
4639 \unvbox255
4640 \penalty\outputpenalty
4643 % Re-output the contents of the output page -- any previous material,
4644 % followed by the two boxes we just split, in box0 and box2.
4645 \def\pagesofar{%
4646 \unvbox\partialpage
4648 \hsize = \doublecolumnhsize
4649 \wd0=\hsize \wd2=\hsize
4650 \hbox to\pagewidth{\box0\hfil\box2}%
4653 % All done with double columns.
4654 \def\enddoublecolumns{%
4655 % The following penalty ensures that the page builder is exercised
4656 % _before_ we change the output routine. This is necessary in the
4657 % following situation:
4659 % The last section of the index consists only of a single entry.
4660 % Before this section, \pagetotal is less than \pagegoal, so no
4661 % break occurs before the last section starts. However, the last
4662 % section, consisting of \initial and the single \entry, does not
4663 % fit on the page and has to be broken off. Without the following
4664 % penalty the page builder will not be exercised until \eject
4665 % below, and by that time we'll already have changed the output
4666 % routine to the \balancecolumns version, so the next-to-last
4667 % double-column page will be processed with \balancecolumns, which
4668 % is wrong: The two columns will go to the main vertical list, with
4669 % the broken-off section in the recent contributions. As soon as
4670 % the output routine finishes, TeX starts reconsidering the page
4671 % break. The two columns and the broken-off section both fit on the
4672 % page, because the two columns now take up only half of the page
4673 % goal. When TeX sees \eject from below which follows the final
4674 % section, it invokes the new output routine that we've set after
4675 % \balancecolumns below; \onepageout will try to fit the two columns
4676 % and the final section into the vbox of \pageheight (see
4677 % \pagebody), causing an overfull box.
4679 % Note that glue won't work here, because glue does not exercise the
4680 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4681 \penalty0
4683 \output = {%
4684 % Split the last of the double-column material. Leave it on the
4685 % current page, no automatic page break.
4686 \balancecolumns
4688 % If we end up splitting too much material for the current page,
4689 % though, there will be another page break right after this \output
4690 % invocation ends. Having called \balancecolumns once, we do not
4691 % want to call it again. Therefore, reset \output to its normal
4692 % definition right away. (We hope \balancecolumns will never be
4693 % called on to balance too much material, but if it is, this makes
4694 % the output somewhat more palatable.)
4695 \global\output = {\onepageout{\pagecontents\PAGE}}%
4697 \eject
4698 \endgroup % started in \begindoublecolumns
4700 % \pagegoal was set to the doubled \vsize above, since we restarted
4701 % the current page. We're now back to normal single-column
4702 % typesetting, so reset \pagegoal to the normal \vsize (after the
4703 % \endgroup where \vsize got restored).
4704 \pagegoal = \vsize
4707 % Called at the end of the double column material.
4708 \def\balancecolumns{%
4709 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4710 \dimen@ = \ht0
4711 \advance\dimen@ by \topskip
4712 \advance\dimen@ by-\baselineskip
4713 \divide\dimen@ by 2 % target to split to
4714 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4715 \splittopskip = \topskip
4716 % Loop until we get a decent breakpoint.
4718 \vbadness = 10000
4719 \loop
4720 \global\setbox3 = \copy0
4721 \global\setbox1 = \vsplit3 to \dimen@
4722 \ifdim\ht3>\dimen@
4723 \global\advance\dimen@ by 1pt
4724 \repeat
4726 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4727 \setbox0=\vbox to\dimen@{\unvbox1}%
4728 \setbox2=\vbox to\dimen@{\unvbox3}%
4730 \pagesofar
4732 \catcode`\@ = \other
4735 \message{sectioning,}
4736 % Chapters, sections, etc.
4738 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4739 % sections so that we can refer to them unambiguously in the pdf
4740 % outlines by their "section number". We avoid collisions with chapter
4741 % numbers by starting them at 10000. (If a document ever has 10000
4742 % chapters, we're in trouble anyway, I'm sure.)
4743 \newcount\unnumberedno \unnumberedno = 10000
4744 \newcount\chapno
4745 \newcount\secno \secno=0
4746 \newcount\subsecno \subsecno=0
4747 \newcount\subsubsecno \subsubsecno=0
4749 % This counter is funny since it counts through charcodes of letters A, B, ...
4750 \newcount\appendixno \appendixno = `\@
4752 % \def\appendixletter{\char\the\appendixno}
4753 % We do the following ugly conditional instead of the above simple
4754 % construct for the sake of pdftex, which needs the actual
4755 % letter in the expansion, not just typeset.
4757 \def\appendixletter{%
4758 \ifnum\appendixno=`A A%
4759 \else\ifnum\appendixno=`B B%
4760 \else\ifnum\appendixno=`C C%
4761 \else\ifnum\appendixno=`D D%
4762 \else\ifnum\appendixno=`E E%
4763 \else\ifnum\appendixno=`F F%
4764 \else\ifnum\appendixno=`G G%
4765 \else\ifnum\appendixno=`H H%
4766 \else\ifnum\appendixno=`I I%
4767 \else\ifnum\appendixno=`J J%
4768 \else\ifnum\appendixno=`K K%
4769 \else\ifnum\appendixno=`L L%
4770 \else\ifnum\appendixno=`M M%
4771 \else\ifnum\appendixno=`N N%
4772 \else\ifnum\appendixno=`O O%
4773 \else\ifnum\appendixno=`P P%
4774 \else\ifnum\appendixno=`Q Q%
4775 \else\ifnum\appendixno=`R R%
4776 \else\ifnum\appendixno=`S S%
4777 \else\ifnum\appendixno=`T T%
4778 \else\ifnum\appendixno=`U U%
4779 \else\ifnum\appendixno=`V V%
4780 \else\ifnum\appendixno=`W W%
4781 \else\ifnum\appendixno=`X X%
4782 \else\ifnum\appendixno=`Y Y%
4783 \else\ifnum\appendixno=`Z Z%
4784 % The \the is necessary, despite appearances, because \appendixletter is
4785 % expanded while writing the .toc file. \char\appendixno is not
4786 % expandable, thus it is written literally, thus all appendixes come out
4787 % with the same letter (or @) in the toc without it.
4788 \else\char\the\appendixno
4789 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4790 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4792 % Each @chapter defines these (using marks) as the number+name, number
4793 % and name of the chapter. Page headings and footings can use
4794 % these. @section does likewise.
4795 \def\thischapter{}
4796 \def\thischapternum{}
4797 \def\thischaptername{}
4798 \def\thissection{}
4799 \def\thissectionnum{}
4800 \def\thissectionname{}
4802 \newcount\absseclevel % used to calculate proper heading level
4803 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4805 % @raisesections: treat @section as chapter, @subsection as section, etc.
4806 \def\raisesections{\global\advance\secbase by -1}
4807 \let\up=\raisesections % original BFox name
4809 % @lowersections: treat @chapter as section, @section as subsection, etc.
4810 \def\lowersections{\global\advance\secbase by 1}
4811 \let\down=\lowersections % original BFox name
4813 % we only have subsub.
4814 \chardef\maxseclevel = 3
4816 % A numbered section within an unnumbered changes to unnumbered too.
4817 % To achive this, remember the "biggest" unnum. sec. we are currently in:
4818 \chardef\unmlevel = \maxseclevel
4820 % Trace whether the current chapter is an appendix or not:
4821 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4822 \def\chapheadtype{N}
4824 % Choose a heading macro
4825 % #1 is heading type
4826 % #2 is heading level
4827 % #3 is text for heading
4828 \def\genhead#1#2#3{%
4829 % Compute the abs. sec. level:
4830 \absseclevel=#2
4831 \advance\absseclevel by \secbase
4832 % Make sure \absseclevel doesn't fall outside the range:
4833 \ifnum \absseclevel < 0
4834 \absseclevel = 0
4835 \else
4836 \ifnum \absseclevel > 3
4837 \absseclevel = 3
4840 % The heading type:
4841 \def\headtype{#1}%
4842 \if \headtype U%
4843 \ifnum \absseclevel < \unmlevel
4844 \chardef\unmlevel = \absseclevel
4846 \else
4847 % Check for appendix sections:
4848 \ifnum \absseclevel = 0
4849 \edef\chapheadtype{\headtype}%
4850 \else
4851 \if \headtype A\if \chapheadtype N%
4852 \errmessage{@appendix... within a non-appendix chapter}%
4853 \fi\fi
4855 % Check for numbered within unnumbered:
4856 \ifnum \absseclevel > \unmlevel
4857 \def\headtype{U}%
4858 \else
4859 \chardef\unmlevel = 3
4862 % Now print the heading:
4863 \if \headtype U%
4864 \ifcase\absseclevel
4865 \unnumberedzzz{#3}%
4866 \or \unnumberedseczzz{#3}%
4867 \or \unnumberedsubseczzz{#3}%
4868 \or \unnumberedsubsubseczzz{#3}%
4870 \else
4871 \if \headtype A%
4872 \ifcase\absseclevel
4873 \appendixzzz{#3}%
4874 \or \appendixsectionzzz{#3}%
4875 \or \appendixsubseczzz{#3}%
4876 \or \appendixsubsubseczzz{#3}%
4878 \else
4879 \ifcase\absseclevel
4880 \chapterzzz{#3}%
4881 \or \seczzz{#3}%
4882 \or \numberedsubseczzz{#3}%
4883 \or \numberedsubsubseczzz{#3}%
4887 \suppressfirstparagraphindent
4890 % an interface:
4891 \def\numhead{\genhead N}
4892 \def\apphead{\genhead A}
4893 \def\unnmhead{\genhead U}
4895 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4896 % all lower-level sectioning counters to zero.
4898 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4899 % (e.g., figures), q.v. By default (before any chapter), that is empty.
4900 \let\chaplevelprefix = \empty
4902 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4903 \def\chapterzzz#1{%
4904 % section resetting is \global in case the chapter is in a group, such
4905 % as an @include file.
4906 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4907 \global\advance\chapno by 1
4909 % Used for \float.
4910 \gdef\chaplevelprefix{\the\chapno.}%
4911 \resetallfloatnos
4913 \message{\putwordChapter\space \the\chapno}%
4915 % Write the actual heading.
4916 \chapmacro{#1}{Ynumbered}{\the\chapno}%
4918 % So @section and the like are numbered underneath this chapter.
4919 \global\let\section = \numberedsec
4920 \global\let\subsection = \numberedsubsec
4921 \global\let\subsubsection = \numberedsubsubsec
4924 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4925 \def\appendixzzz#1{%
4926 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4927 \global\advance\appendixno by 1
4928 \gdef\chaplevelprefix{\appendixletter.}%
4929 \resetallfloatnos
4931 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4932 \message{\appendixnum}%
4934 \chapmacro{#1}{Yappendix}{\appendixletter}%
4936 \global\let\section = \appendixsec
4937 \global\let\subsection = \appendixsubsec
4938 \global\let\subsubsection = \appendixsubsubsec
4941 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4942 \def\unnumberedzzz#1{%
4943 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4944 \global\advance\unnumberedno by 1
4946 % Since an unnumbered has no number, no prefix for figures.
4947 \global\let\chaplevelprefix = \empty
4948 \resetallfloatnos
4950 % This used to be simply \message{#1}, but TeX fully expands the
4951 % argument to \message. Therefore, if #1 contained @-commands, TeX
4952 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4953 % expanded @cite (which turns out to cause errors because \cite is meant
4954 % to be executed, not expanded).
4956 % Anyway, we don't want the fully-expanded definition of @cite to appear
4957 % as a result of the \message, we just want `@cite' itself. We use
4958 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4959 % simply yielding the contents of <toks register>. (We also do this for
4960 % the toc entries.)
4961 \toks0 = {#1}%
4962 \message{(\the\toks0)}%
4964 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4966 \global\let\section = \unnumberedsec
4967 \global\let\subsection = \unnumberedsubsec
4968 \global\let\subsubsection = \unnumberedsubsubsec
4971 % @centerchap is like @unnumbered, but the heading is centered.
4972 \outer\parseargdef\centerchap{%
4973 % Well, we could do the following in a group, but that would break
4974 % an assumption that \chapmacro is called at the outermost level.
4975 % Thus we are safer this way: --kasal, 24feb04
4976 \let\centerparametersmaybe = \centerparameters
4977 \unnmhead0{#1}%
4978 \let\centerparametersmaybe = \relax
4981 % @top is like @unnumbered.
4982 \let\top\unnumbered
4984 % Sections.
4985 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4986 \def\seczzz#1{%
4987 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4988 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
4991 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4992 \def\appendixsectionzzz#1{%
4993 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4994 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
4996 \let\appendixsec\appendixsection
4998 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4999 \def\unnumberedseczzz#1{%
5000 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5001 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5004 % Subsections.
5005 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
5006 \def\numberedsubseczzz#1{%
5007 \global\subsubsecno=0 \global\advance\subsecno by 1
5008 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5011 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
5012 \def\appendixsubseczzz#1{%
5013 \global\subsubsecno=0 \global\advance\subsecno by 1
5014 \sectionheading{#1}{subsec}{Yappendix}%
5015 {\appendixletter.\the\secno.\the\subsecno}%
5018 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
5019 \def\unnumberedsubseczzz#1{%
5020 \global\subsubsecno=0 \global\advance\subsecno by 1
5021 \sectionheading{#1}{subsec}{Ynothing}%
5022 {\the\unnumberedno.\the\secno.\the\subsecno}%
5025 % Subsubsections.
5026 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
5027 \def\numberedsubsubseczzz#1{%
5028 \global\advance\subsubsecno by 1
5029 \sectionheading{#1}{subsubsec}{Ynumbered}%
5030 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5033 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
5034 \def\appendixsubsubseczzz#1{%
5035 \global\advance\subsubsecno by 1
5036 \sectionheading{#1}{subsubsec}{Yappendix}%
5037 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5040 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
5041 \def\unnumberedsubsubseczzz#1{%
5042 \global\advance\subsubsecno by 1
5043 \sectionheading{#1}{subsubsec}{Ynothing}%
5044 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5047 % These macros control what the section commands do, according
5048 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5049 % Define them by default for a numbered chapter.
5050 \let\section = \numberedsec
5051 \let\subsection = \numberedsubsec
5052 \let\subsubsection = \numberedsubsubsec
5054 % Define @majorheading, @heading and @subheading
5056 % NOTE on use of \vbox for chapter headings, section headings, and such:
5057 % 1) We use \vbox rather than the earlier \line to permit
5058 % overlong headings to fold.
5059 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5060 % heading is obnoxious; this forbids it.
5061 % 3) Likewise, headings look best if no \parindent is used, and
5062 % if justification is not attempted. Hence \raggedright.
5065 \def\majorheading{%
5066 {\advance\chapheadingskip by 10pt \chapbreak }%
5067 \parsearg\chapheadingzzz
5070 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5071 \def\chapheadingzzz#1{%
5072 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5073 \parindent=0pt\raggedright
5074 \rm #1\hfill}}%
5075 \bigskip \par\penalty 200\relax
5076 \suppressfirstparagraphindent
5079 % @heading, @subheading, @subsubheading.
5080 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5081 \suppressfirstparagraphindent}
5082 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5083 \suppressfirstparagraphindent}
5084 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5085 \suppressfirstparagraphindent}
5087 % These macros generate a chapter, section, etc. heading only
5088 % (including whitespace, linebreaking, etc. around it),
5089 % given all the information in convenient, parsed form.
5091 %%% Args are the skip and penalty (usually negative)
5092 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5094 %%% Define plain chapter starts, and page on/off switching for it
5095 % Parameter controlling skip before chapter headings (if needed)
5097 \newskip\chapheadingskip
5099 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5100 \def\chappager{\par\vfill\supereject}
5101 % Because \domark is called before \chapoddpage, the filler page will
5102 % get the headings for the next chapter, which is wrong. But we don't
5103 % care -- we just disable all headings on the filler page.
5104 \def\chapoddpage{%
5105 \chappager
5106 \ifodd\pageno \else
5107 \begingroup
5108 \evenheadline={\hfil}\evenfootline={\hfil}%
5109 \oddheadline={\hfil}\oddfootline={\hfil}%
5110 \hbox to 0pt{}%
5111 \chappager
5112 \endgroup
5116 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5118 \def\CHAPPAGoff{%
5119 \global\let\contentsalignmacro = \chappager
5120 \global\let\pchapsepmacro=\chapbreak
5121 \global\let\pagealignmacro=\chappager}
5123 \def\CHAPPAGon{%
5124 \global\let\contentsalignmacro = \chappager
5125 \global\let\pchapsepmacro=\chappager
5126 \global\let\pagealignmacro=\chappager
5127 \global\def\HEADINGSon{\HEADINGSsingle}}
5129 \def\CHAPPAGodd{%
5130 \global\let\contentsalignmacro = \chapoddpage
5131 \global\let\pchapsepmacro=\chapoddpage
5132 \global\let\pagealignmacro=\chapoddpage
5133 \global\def\HEADINGSon{\HEADINGSdouble}}
5135 \CHAPPAGon
5137 % Chapter opening.
5139 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5140 % Yappendix, Yomitfromtoc), #3 the chapter number.
5142 % To test against our argument.
5143 \def\Ynothingkeyword{Ynothing}
5144 \def\Yomitfromtockeyword{Yomitfromtoc}
5145 \def\Yappendixkeyword{Yappendix}
5147 \def\chapmacro#1#2#3{%
5148 % Insert the first mark before the heading break (see notes for \domark).
5149 \let\prevchapterdefs=\lastchapterdefs
5150 \let\prevsectiondefs=\lastsectiondefs
5151 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5152 \gdef\thissection{}}%
5154 \def\temptype{#2}%
5155 \ifx\temptype\Ynothingkeyword
5156 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5157 \gdef\thischapter{\thischaptername}}%
5158 \else\ifx\temptype\Yomitfromtockeyword
5159 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5160 \gdef\thischapter{}}%
5161 \else\ifx\temptype\Yappendixkeyword
5162 \toks0={#1}%
5163 \xdef\lastchapterdefs{%
5164 \gdef\noexpand\thischaptername{\the\toks0}%
5165 \gdef\noexpand\thischapternum{\appendixletter}%
5166 \gdef\noexpand\thischapter{\putwordAppendix{} \noexpand\thischapternum:
5167 \noexpand\thischaptername}%
5169 \else
5170 \toks0={#1}%
5171 \xdef\lastchapterdefs{%
5172 \gdef\noexpand\thischaptername{\the\toks0}%
5173 \gdef\noexpand\thischapternum{\the\chapno}%
5174 \gdef\noexpand\thischapter{\putwordChapter{} \noexpand\thischapternum:
5175 \noexpand\thischaptername}%
5177 \fi\fi\fi
5179 % Output the mark. Pass it through \safewhatsit, to take care of
5180 % the preceding space.
5181 \safewhatsit\domark
5183 % Insert the chapter heading break.
5184 \pchapsepmacro
5186 % Now the second mark, after the heading break. No break points
5187 % between here and the heading.
5188 \let\prevchapterdefs=\lastchapterdefs
5189 \let\prevsectiondefs=\lastsectiondefs
5190 \domark
5193 \chapfonts \rm
5195 % Have to define \lastsection before calling \donoderef, because the
5196 % xref code eventually uses it. On the other hand, it has to be called
5197 % after \pchapsepmacro, or the headline will change too soon.
5198 \gdef\lastsection{#1}%
5200 % Only insert the separating space if we have a chapter/appendix
5201 % number, and don't print the unnumbered ``number''.
5202 \ifx\temptype\Ynothingkeyword
5203 \setbox0 = \hbox{}%
5204 \def\toctype{unnchap}%
5205 \else\ifx\temptype\Yomitfromtockeyword
5206 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5207 \def\toctype{omit}%
5208 \else\ifx\temptype\Yappendixkeyword
5209 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5210 \def\toctype{app}%
5211 \else
5212 \setbox0 = \hbox{#3\enspace}%
5213 \def\toctype{numchap}%
5214 \fi\fi\fi
5216 % Write the toc entry for this chapter. Must come before the
5217 % \donoderef, because we include the current node name in the toc
5218 % entry, and \donoderef resets it to empty.
5219 \writetocentry{\toctype}{#1}{#3}%
5221 % For pdftex, we have to write out the node definition (aka, make
5222 % the pdfdest) after any page break, but before the actual text has
5223 % been typeset. If the destination for the pdf outline is after the
5224 % text, then jumping from the outline may wind up with the text not
5225 % being visible, for instance under high magnification.
5226 \donoderef{#2}%
5228 % Typeset the actual heading.
5229 \nobreak % Avoid page breaks at the interline glue.
5230 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
5231 \hangindent=\wd0 \centerparametersmaybe
5232 \unhbox0 #1\par}%
5234 \nobreak\bigskip % no page break after a chapter title
5235 \nobreak
5238 % @centerchap -- centered and unnumbered.
5239 \let\centerparametersmaybe = \relax
5240 \def\centerparameters{%
5241 \advance\rightskip by 3\rightskip
5242 \leftskip = \rightskip
5243 \parfillskip = 0pt
5247 % I don't think this chapter style is supported any more, so I'm not
5248 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5250 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5252 \def\unnchfopen #1{%
5253 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5254 \parindent=0pt\raggedright
5255 \rm #1\hfill}}\bigskip \par\nobreak
5257 \def\chfopen #1#2{\chapoddpage {\chapfonts
5258 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5259 \par\penalty 5000 %
5261 \def\centerchfopen #1{%
5262 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5263 \parindent=0pt
5264 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
5266 \def\CHAPFopen{%
5267 \global\let\chapmacro=\chfopen
5268 \global\let\centerchapmacro=\centerchfopen}
5271 % Section titles. These macros combine the section number parts and
5272 % call the generic \sectionheading to do the printing.
5274 \newskip\secheadingskip
5275 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5277 % Subsection titles.
5278 \newskip\subsecheadingskip
5279 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5281 % Subsubsection titles.
5282 \def\subsubsecheadingskip{\subsecheadingskip}
5283 \def\subsubsecheadingbreak{\subsecheadingbreak}
5286 % Print any size, any type, section title.
5288 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5289 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5290 % section number.
5292 \def\seckeyword{sec}
5294 \def\sectionheading#1#2#3#4{%
5296 % Switch to the right set of fonts.
5297 \csname #2fonts\endcsname \rm
5299 \def\sectionlevel{#2}%
5300 \def\temptype{#3}%
5302 % Insert first mark before the heading break (see notes for \domark).
5303 \let\prevsectiondefs=\lastsectiondefs
5304 \ifx\temptype\Ynothingkeyword
5305 \ifx\sectionlevel\seckeyword
5306 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5307 \gdef\thissection{\thissectionname}}%
5309 \else\ifx\temptype\Yomitfromtockeyword
5310 % Don't redefine \thissection.
5311 \else\ifx\temptype\Yappendixkeyword
5312 \ifx\sectionlevel\seckeyword
5313 \toks0={#1}%
5314 \xdef\lastsectiondefs{%
5315 \gdef\noexpand\thissectionname{\the\toks0}%
5316 \gdef\noexpand\thissectionnum{#4}%
5317 \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5318 \noexpand\thissectionname}%
5321 \else
5322 \ifx\sectionlevel\seckeyword
5323 \toks0={#1}%
5324 \xdef\lastsectiondefs{%
5325 \gdef\noexpand\thissectionname{\the\toks0}%
5326 \gdef\noexpand\thissectionnum{#4}%
5327 \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5328 \noexpand\thissectionname}%
5331 \fi\fi\fi
5333 % Output the mark. Pass it through \safewhatsit, to take care of
5334 % the preceding space.
5335 \safewhatsit\domark
5337 % Insert space above the heading.
5338 \csname #2headingbreak\endcsname
5340 % Now the second mark, after the heading break. No break points
5341 % between here and the heading.
5342 \let\prevsectiondefs=\lastsectiondefs
5343 \domark
5345 % Only insert the space after the number if we have a section number.
5346 \ifx\temptype\Ynothingkeyword
5347 \setbox0 = \hbox{}%
5348 \def\toctype{unn}%
5349 \gdef\lastsection{#1}%
5350 \else\ifx\temptype\Yomitfromtockeyword
5351 % for @headings -- no section number, don't include in toc,
5352 % and don't redefine \lastsection.
5353 \setbox0 = \hbox{}%
5354 \def\toctype{omit}%
5355 \let\sectionlevel=\empty
5356 \else\ifx\temptype\Yappendixkeyword
5357 \setbox0 = \hbox{#4\enspace}%
5358 \def\toctype{app}%
5359 \gdef\lastsection{#1}%
5360 \else
5361 \setbox0 = \hbox{#4\enspace}%
5362 \def\toctype{num}%
5363 \gdef\lastsection{#1}%
5364 \fi\fi\fi
5366 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5367 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5369 % Write the node reference (= pdf destination for pdftex).
5370 % Again, see comments in \chapmacro.
5371 \donoderef{#3}%
5373 % Interline glue will be inserted when the vbox is completed.
5374 % That glue will be a valid breakpoint for the page, since it'll be
5375 % preceded by a whatsit (usually from the \donoderef, or from the
5376 % \writetocentry if there was no node). We don't want to allow that
5377 % break, since then the whatsits could end up on page n while the
5378 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5379 \nobreak
5381 % Output the actual section heading.
5382 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
5383 \hangindent=\wd0 % zero if no section number
5384 \unhbox0 #1}%
5386 % Add extra space after the heading -- half of whatever came above it.
5387 % Don't allow stretch, though.
5388 \kern .5 \csname #2headingskip\endcsname
5390 % Do not let the kern be a potential breakpoint, as it would be if it
5391 % was followed by glue.
5392 \nobreak
5394 % We'll almost certainly start a paragraph next, so don't let that
5395 % glue accumulate. (Not a breakpoint because it's preceded by a
5396 % discardable item.)
5397 \vskip-\parskip
5399 % This is purely so the last item on the list is a known \penalty >
5400 % 10000. This is so \startdefun can avoid allowing breakpoints after
5401 % section headings. Otherwise, it would insert a valid breakpoint between:
5403 % @section sec-whatever
5404 % @deffn def-whatever
5405 \penalty 10001
5409 \message{toc,}
5410 % Table of contents.
5411 \newwrite\tocfile
5413 % Write an entry to the toc file, opening it if necessary.
5414 % Called from @chapter, etc.
5416 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5417 % We append the current node name (if any) and page number as additional
5418 % arguments for the \{chap,sec,...}entry macros which will eventually
5419 % read this. The node name is used in the pdf outlines as the
5420 % destination to jump to.
5422 % We open the .toc file for writing here instead of at @setfilename (or
5423 % any other fixed time) so that @contents can be anywhere in the document.
5424 % But if #1 is `omit', then we don't do anything. This is used for the
5425 % table of contents chapter openings themselves.
5427 \newif\iftocfileopened
5428 \def\omitkeyword{omit}%
5430 \def\writetocentry#1#2#3{%
5431 \edef\writetoctype{#1}%
5432 \ifx\writetoctype\omitkeyword \else
5433 \iftocfileopened\else
5434 \immediate\openout\tocfile = \jobname.toc
5435 \global\tocfileopenedtrue
5438 \iflinks
5439 {\atdummies
5440 \edef\temp{%
5441 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5442 \temp
5447 % Tell \shipout to create a pdf destination on each page, if we're
5448 % writing pdf. These are used in the table of contents. We can't
5449 % just write one on every page because the title pages are numbered
5450 % 1 and 2 (the page numbers aren't printed), and so are the first
5451 % two pages of the document. Thus, we'd have two destinations named
5452 % `1', and two named `2'.
5453 \ifpdf \global\pdfmakepagedesttrue \fi
5457 % These characters do not print properly in the Computer Modern roman
5458 % fonts, so we must take special care. This is more or less redundant
5459 % with the Texinfo input format setup at the end of this file.
5461 \def\activecatcodes{%
5462 \catcode`\"=\active
5463 \catcode`\$=\active
5464 \catcode`\<=\active
5465 \catcode`\>=\active
5466 \catcode`\\=\active
5467 \catcode`\^=\active
5468 \catcode`\_=\active
5469 \catcode`\|=\active
5470 \catcode`\~=\active
5474 % Read the toc file, which is essentially Texinfo input.
5475 \def\readtocfile{%
5476 \setupdatafile
5477 \activecatcodes
5478 \input \tocreadfilename
5481 \newskip\contentsrightmargin \contentsrightmargin=1in
5482 \newcount\savepageno
5483 \newcount\lastnegativepageno \lastnegativepageno = -1
5485 % Prepare to read what we've written to \tocfile.
5487 \def\startcontents#1{%
5488 % If @setchapternewpage on, and @headings double, the contents should
5489 % start on an odd page, unlike chapters. Thus, we maintain
5490 % \contentsalignmacro in parallel with \pagealignmacro.
5491 % From: Torbjorn Granlund <tege@matematik.su.se>
5492 \contentsalignmacro
5493 \immediate\closeout\tocfile
5495 % Don't need to put `Contents' or `Short Contents' in the headline.
5496 % It is abundantly clear what they are.
5497 \chapmacro{#1}{Yomitfromtoc}{}%
5499 \savepageno = \pageno
5500 \begingroup % Set up to handle contents files properly.
5501 \raggedbottom % Worry more about breakpoints than the bottom.
5502 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5504 % Roman numerals for page numbers.
5505 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5508 % redefined for the two-volume lispref. We always output on
5509 % \jobname.toc even if this is redefined.
5511 \def\tocreadfilename{\jobname.toc}
5513 % Normal (long) toc.
5515 \def\contents{%
5516 \startcontents{\putwordTOC}%
5517 \openin 1 \tocreadfilename\space
5518 \ifeof 1 \else
5519 \readtocfile
5521 \vfill \eject
5522 \contentsalignmacro % in case @setchapternewpage odd is in effect
5523 \ifeof 1 \else
5524 \pdfmakeoutlines
5526 \closein 1
5527 \endgroup
5528 \lastnegativepageno = \pageno
5529 \global\pageno = \savepageno
5532 % And just the chapters.
5533 \def\summarycontents{%
5534 \startcontents{\putwordShortTOC}%
5536 \let\numchapentry = \shortchapentry
5537 \let\appentry = \shortchapentry
5538 \let\unnchapentry = \shortunnchapentry
5539 % We want a true roman here for the page numbers.
5540 \secfonts
5541 \let\rm=\shortcontrm \let\bf=\shortcontbf
5542 \let\sl=\shortcontsl \let\tt=\shortconttt
5544 \hyphenpenalty = 10000
5545 \advance\baselineskip by 1pt % Open it up a little.
5546 \def\numsecentry##1##2##3##4{}
5547 \let\appsecentry = \numsecentry
5548 \let\unnsecentry = \numsecentry
5549 \let\numsubsecentry = \numsecentry
5550 \let\appsubsecentry = \numsecentry
5551 \let\unnsubsecentry = \numsecentry
5552 \let\numsubsubsecentry = \numsecentry
5553 \let\appsubsubsecentry = \numsecentry
5554 \let\unnsubsubsecentry = \numsecentry
5555 \openin 1 \tocreadfilename\space
5556 \ifeof 1 \else
5557 \readtocfile
5559 \closein 1
5560 \vfill \eject
5561 \contentsalignmacro % in case @setchapternewpage odd is in effect
5562 \endgroup
5563 \lastnegativepageno = \pageno
5564 \global\pageno = \savepageno
5566 \let\shortcontents = \summarycontents
5568 % Typeset the label for a chapter or appendix for the short contents.
5569 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
5571 \def\shortchaplabel#1{%
5572 % This space should be enough, since a single number is .5em, and the
5573 % widest letter (M) is 1em, at least in the Computer Modern fonts.
5574 % But use \hss just in case.
5575 % (This space doesn't include the extra space that gets added after
5576 % the label; that gets put in by \shortchapentry above.)
5578 % We'd like to right-justify chapter numbers, but that looks strange
5579 % with appendix letters. And right-justifying numbers and
5580 % left-justifying letters looks strange when there is less than 10
5581 % chapters. Have to read the whole toc once to know how many chapters
5582 % there are before deciding ...
5583 \hbox to 1em{#1\hss}%
5586 % These macros generate individual entries in the table of contents.
5587 % The first argument is the chapter or section name.
5588 % The last argument is the page number.
5589 % The arguments in between are the chapter number, section number, ...
5591 % Chapters, in the main contents.
5592 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5594 % Chapters, in the short toc.
5595 % See comments in \dochapentry re vbox and related settings.
5596 \def\shortchapentry#1#2#3#4{%
5597 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5600 % Appendices, in the main contents.
5601 % Need the word Appendix, and a fixed-size box.
5603 \def\appendixbox#1{%
5604 % We use M since it's probably the widest letter.
5605 \setbox0 = \hbox{\putwordAppendix{} M}%
5606 \hbox to \wd0{\putwordAppendix{} #1\hss}}
5608 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5610 % Unnumbered chapters.
5611 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5612 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5614 % Sections.
5615 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5616 \let\appsecentry=\numsecentry
5617 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5619 % Subsections.
5620 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5621 \let\appsubsecentry=\numsubsecentry
5622 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5624 % And subsubsections.
5625 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5626 \let\appsubsubsecentry=\numsubsubsecentry
5627 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5629 % This parameter controls the indentation of the various levels.
5630 % Same as \defaultparindent.
5631 \newdimen\tocindent \tocindent = 15pt
5633 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5634 % page number.
5636 % If the toc has to be broken over pages, we want it to be at chapters
5637 % if at all possible; hence the \penalty.
5638 \def\dochapentry#1#2{%
5639 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5640 \begingroup
5641 \chapentryfonts
5642 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5643 \endgroup
5644 \nobreak\vskip .25\baselineskip plus.1\baselineskip
5647 \def\dosecentry#1#2{\begingroup
5648 \secentryfonts \leftskip=\tocindent
5649 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5650 \endgroup}
5652 \def\dosubsecentry#1#2{\begingroup
5653 \subsecentryfonts \leftskip=2\tocindent
5654 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5655 \endgroup}
5657 \def\dosubsubsecentry#1#2{\begingroup
5658 \subsubsecentryfonts \leftskip=3\tocindent
5659 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5660 \endgroup}
5662 % We use the same \entry macro as for the index entries.
5663 \let\tocentry = \entry
5665 % Space between chapter (or whatever) number and the title.
5666 \def\labelspace{\hskip1em \relax}
5668 \def\dopageno#1{{\rm #1}}
5669 \def\doshortpageno#1{{\rm #1}}
5671 \def\chapentryfonts{\secfonts \rm}
5672 \def\secentryfonts{\textfonts}
5673 \def\subsecentryfonts{\textfonts}
5674 \def\subsubsecentryfonts{\textfonts}
5677 \message{environments,}
5678 % @foo ... @end foo.
5680 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
5682 % Since these characters are used in examples, they should be an even number of
5683 % \tt widths. Each \tt character is 1en, so two makes it 1em.
5685 \def\point{$\star$}
5686 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
5687 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
5688 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
5689 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
5690 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
5692 % The @error{} command.
5693 % Adapted from the TeXbook's \boxit.
5695 \newbox\errorbox
5697 {\tentt \global\dimen0 = 3em}% Width of the box.
5698 \dimen2 = .55pt % Thickness of rules
5699 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
5700 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
5702 \setbox\errorbox=\hbox to \dimen0{\hfil
5703 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
5704 \advance\hsize by -2\dimen2 % Rules.
5705 \vbox{%
5706 \hrule height\dimen2
5707 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
5708 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
5709 \kern3pt\vrule width\dimen2}% Space to right.
5710 \hrule height\dimen2}
5711 \hfil}
5713 \def\error{\leavevmode\lower.7ex\copy\errorbox}
5715 % @tex ... @end tex escapes into raw Tex temporarily.
5716 % One exception: @ is still an escape character, so that @end tex works.
5717 % But \@ or @@ will get a plain tex @ character.
5719 \envdef\tex{%
5720 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5721 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5722 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5723 \catcode `\%=14
5724 \catcode `\+=\other
5725 \catcode `\"=\other
5726 \catcode `\|=\other
5727 \catcode `\<=\other
5728 \catcode `\>=\other
5729 \escapechar=`\\
5731 \let\b=\ptexb
5732 \let\bullet=\ptexbullet
5733 \let\c=\ptexc
5734 \let\,=\ptexcomma
5735 \let\.=\ptexdot
5736 \let\dots=\ptexdots
5737 \let\equiv=\ptexequiv
5738 \let\!=\ptexexclam
5739 \let\i=\ptexi
5740 \let\indent=\ptexindent
5741 \let\noindent=\ptexnoindent
5742 \let\{=\ptexlbrace
5743 \let\+=\tabalign
5744 \let\}=\ptexrbrace
5745 \let\/=\ptexslash
5746 \let\*=\ptexstar
5747 \let\t=\ptext
5748 \expandafter \let\csname top\endcsname=\ptextop % outer
5749 \let\frenchspacing=\plainfrenchspacing
5751 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5752 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5753 \def\@{@}%
5755 % There is no need to define \Etex.
5757 % Define @lisp ... @end lisp.
5758 % @lisp environment forms a group so it can rebind things,
5759 % including the definition of @end lisp (which normally is erroneous).
5761 % Amount to narrow the margins by for @lisp.
5762 \newskip\lispnarrowing \lispnarrowing=0.4in
5764 % This is the definition that ^^M gets inside @lisp, @example, and other
5765 % such environments. \null is better than a space, since it doesn't
5766 % have any width.
5767 \def\lisppar{\null\endgraf}
5769 % This space is always present above and below environments.
5770 \newskip\envskipamount \envskipamount = 0pt
5772 % Make spacing and below environment symmetrical. We use \parskip here
5773 % to help in doing that, since in @example-like environments \parskip
5774 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
5775 % start of the next paragraph will insert \parskip.
5777 \def\aboveenvbreak{{%
5778 % =10000 instead of <10000 because of a special case in \itemzzz and
5779 % \sectionheading, q.v.
5780 \ifnum \lastpenalty=10000 \else
5781 \advance\envskipamount by \parskip
5782 \endgraf
5783 \ifdim\lastskip<\envskipamount
5784 \removelastskip
5785 % it's not a good place to break if the last penalty was \nobreak
5786 % or better ...
5787 \ifnum\lastpenalty<10000 \penalty-50 \fi
5788 \vskip\envskipamount
5793 \let\afterenvbreak = \aboveenvbreak
5795 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
5796 % also clear it, so that its embedded environments do the narrowing again.
5797 \let\nonarrowing=\relax
5799 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
5800 % environment contents.
5801 \font\circle=lcircle10
5802 \newdimen\circthick
5803 \newdimen\cartouter\newdimen\cartinner
5804 \newskip\normbskip\newskip\normpskip\newskip\normlskip
5805 \circthick=\fontdimen8\circle
5807 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
5808 \def\ctr{{\hskip 6pt\circle\char'010}}
5809 \def\cbl{{\circle\char'012\hskip -6pt}}
5810 \def\cbr{{\hskip 6pt\circle\char'011}}
5811 \def\carttop{\hbox to \cartouter{\hskip\lskip
5812 \ctl\leaders\hrule height\circthick\hfil\ctr
5813 \hskip\rskip}}
5814 \def\cartbot{\hbox to \cartouter{\hskip\lskip
5815 \cbl\leaders\hrule height\circthick\hfil\cbr
5816 \hskip\rskip}}
5818 \newskip\lskip\newskip\rskip
5820 \envdef\cartouche{%
5821 \ifhmode\par\fi % can't be in the midst of a paragraph.
5822 \startsavinginserts
5823 \lskip=\leftskip \rskip=\rightskip
5824 \leftskip=0pt\rightskip=0pt % we want these *outside*.
5825 \cartinner=\hsize \advance\cartinner by-\lskip
5826 \advance\cartinner by-\rskip
5827 \cartouter=\hsize
5828 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
5829 % side, and for 6pt waste from
5830 % each corner char, and rule thickness
5831 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
5832 % Flag to tell @lisp, etc., not to narrow margin.
5833 \let\nonarrowing = t%
5834 \vbox\bgroup
5835 \baselineskip=0pt\parskip=0pt\lineskip=0pt
5836 \carttop
5837 \hbox\bgroup
5838 \hskip\lskip
5839 \vrule\kern3pt
5840 \vbox\bgroup
5841 \kern3pt
5842 \hsize=\cartinner
5843 \baselineskip=\normbskip
5844 \lineskip=\normlskip
5845 \parskip=\normpskip
5846 \vskip -\parskip
5847 \comment % For explanation, see the end of \def\group.
5849 \def\Ecartouche{%
5850 \ifhmode\par\fi
5851 \kern3pt
5852 \egroup
5853 \kern3pt\vrule
5854 \hskip\rskip
5855 \egroup
5856 \cartbot
5857 \egroup
5858 \checkinserts
5862 % This macro is called at the beginning of all the @example variants,
5863 % inside a group.
5864 \def\nonfillstart{%
5865 \aboveenvbreak
5866 \hfuzz = 12pt % Don't be fussy
5867 \sepspaces % Make spaces be word-separators rather than space tokens.
5868 \let\par = \lisppar % don't ignore blank lines
5869 \obeylines % each line of input is a line of output
5870 \parskip = 0pt
5871 \parindent = 0pt
5872 \emergencystretch = 0pt % don't try to avoid overfull boxes
5873 \ifx\nonarrowing\relax
5874 \advance \leftskip by \lispnarrowing
5875 \exdentamount=\lispnarrowing
5876 \else
5877 \let\nonarrowing = \relax
5879 \let\exdent=\nofillexdent
5882 % If you want all examples etc. small: @set dispenvsize small.
5883 % If you want even small examples the full size: @set dispenvsize nosmall.
5884 % This affects the following displayed environments:
5885 % @example, @display, @format, @lisp
5887 \def\smallword{small}
5888 \def\nosmallword{nosmall}
5889 \let\SETdispenvsize\relax
5890 \def\setnormaldispenv{%
5891 \ifx\SETdispenvsize\smallword
5892 % end paragraph for sake of leading, in case document has no blank
5893 % line. This is redundant with what happens in \aboveenvbreak, but
5894 % we need to do it before changing the fonts, and it's inconvenient
5895 % to change the fonts afterward.
5896 \ifnum \lastpenalty=10000 \else \endgraf \fi
5897 \smallexamplefonts \rm
5900 \def\setsmalldispenv{%
5901 \ifx\SETdispenvsize\nosmallword
5902 \else
5903 \ifnum \lastpenalty=10000 \else \endgraf \fi
5904 \smallexamplefonts \rm
5908 % We often define two environments, @foo and @smallfoo.
5909 % Let's do it by one command:
5910 \def\makedispenv #1#2{
5911 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5912 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5913 \expandafter\let\csname E#1\endcsname \afterenvbreak
5914 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5917 % Define two synonyms:
5918 \def\maketwodispenvs #1#2#3{
5919 \makedispenv{#1}{#3}
5920 \makedispenv{#2}{#3}
5923 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5925 % @smallexample and @smalllisp: use smaller fonts.
5926 % Originally contributed by Pavel@xerox.
5928 \maketwodispenvs {lisp}{example}{%
5929 \nonfillstart
5930 \tt\quoteexpand
5931 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
5932 \gobble % eat return
5934 % @display/@smalldisplay: same as @lisp except keep current font.
5936 \makedispenv {display}{%
5937 \nonfillstart
5938 \gobble
5941 % @format/@smallformat: same as @display except don't narrow margins.
5943 \makedispenv{format}{%
5944 \let\nonarrowing = t%
5945 \nonfillstart
5946 \gobble
5949 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
5950 \envdef\flushleft{%
5951 \let\nonarrowing = t%
5952 \nonfillstart
5953 \gobble
5955 \let\Eflushleft = \afterenvbreak
5957 % @flushright.
5959 \envdef\flushright{%
5960 \let\nonarrowing = t%
5961 \nonfillstart
5962 \advance\leftskip by 0pt plus 1fill
5963 \gobble
5965 \let\Eflushright = \afterenvbreak
5968 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
5969 % and narrows the margins. We keep \parskip nonzero in general, since
5970 % we're doing normal filling. So, when using \aboveenvbreak and
5971 % \afterenvbreak, temporarily make \parskip 0.
5973 \envdef\quotation{%
5974 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
5975 \parindent=0pt
5977 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
5978 \ifx\nonarrowing\relax
5979 \advance\leftskip by \lispnarrowing
5980 \advance\rightskip by \lispnarrowing
5981 \exdentamount = \lispnarrowing
5982 \else
5983 \let\nonarrowing = \relax
5985 \parsearg\quotationlabel
5988 % We have retained a nonzero parskip for the environment, since we're
5989 % doing normal filling.
5991 \def\Equotation{%
5992 \par
5993 \ifx\quotationauthor\undefined\else
5994 % indent a bit.
5995 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5997 {\parskip=0pt \afterenvbreak}%
6000 % If we're given an argument, typeset it in bold with a colon after.
6001 \def\quotationlabel#1{%
6002 \def\temp{#1}%
6003 \ifx\temp\empty \else
6004 {\bf #1: }%
6009 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6010 % If we want to allow any <char> as delimiter,
6011 % we need the curly braces so that makeinfo sees the @verb command, eg:
6012 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6014 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6016 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6017 % active too. Otherwise, they get lost as the first character on a
6018 % verbatim line.
6019 \def\dospecials{%
6020 \do\ \do\\\do\{\do\}\do\$\do\&%
6021 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6022 \do\<\do\>\do\|\do\@\do+\do\"%
6025 % [Knuth] p. 380
6026 \def\uncatcodespecials{%
6027 \def\do##1{\catcode`##1=\other}\dospecials}
6029 % [Knuth] pp. 380,381,391
6030 % Disable Spanish ligatures ?` and !` of \tt font
6031 \begingroup
6032 \catcode`\`=\active\gdef`{\relax\lq}
6033 \endgroup
6035 % Setup for the @verb command.
6037 % Eight spaces for a tab
6038 \begingroup
6039 \catcode`\^^I=\active
6040 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6041 \endgroup
6043 \def\setupverb{%
6044 \tt % easiest (and conventionally used) font for verbatim
6045 \def\par{\leavevmode\endgraf}%
6046 \catcode`\`=\active
6047 \tabeightspaces
6048 % Respect line breaks,
6049 % print special symbols as themselves, and
6050 % make each space count
6051 % must do in this order:
6052 \obeylines \uncatcodespecials \sepspaces
6055 % Setup for the @verbatim environment
6057 % Real tab expansion
6058 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6060 \def\starttabbox{\setbox0=\hbox\bgroup}
6062 % Allow an option to not replace quotes with a regular directed right
6063 % quote/apostrophe (char 0x27), but instead use the undirected quote
6064 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
6065 % the default, but it works for pasting with more pdf viewers (at least
6066 % evince), the lilypond developers report. xpdf does work with the
6067 % regular 0x27.
6069 \def\codequoteright{%
6070 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
6071 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
6073 \else \char'15 \fi
6074 \else \char'15 \fi
6077 % and a similar option for the left quote char vs. a grave accent.
6078 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
6079 % the code environments to do likewise.
6081 \def\codequoteleft{%
6082 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
6083 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
6085 \else \char'22 \fi
6086 \else \char'22 \fi
6089 \begingroup
6090 \catcode`\^^I=\active
6091 \gdef\tabexpand{%
6092 \catcode`\^^I=\active
6093 \def^^I{\leavevmode\egroup
6094 \dimen0=\wd0 % the width so far, or since the previous tab
6095 \divide\dimen0 by\tabw
6096 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
6097 \advance\dimen0 by\tabw % advance to next multiple of \tabw
6098 \wd0=\dimen0 \box0 \starttabbox
6101 \catcode`\'=\active
6102 \gdef\rquoteexpand{\catcode\rquoteChar=\active \def'{\codequoteright}}%
6104 \catcode`\`=\active
6105 \gdef\lquoteexpand{\catcode\lquoteChar=\active \def`{\codequoteleft}}%
6107 \gdef\quoteexpand{\rquoteexpand \lquoteexpand}%
6108 \endgroup
6110 % start the verbatim environment.
6111 \def\setupverbatim{%
6112 \let\nonarrowing = t%
6113 \nonfillstart
6114 % Easiest (and conventionally used) font for verbatim
6116 \def\par{\leavevmode\egroup\box0\endgraf}%
6117 \catcode`\`=\active
6118 \tabexpand
6119 \quoteexpand
6120 % Respect line breaks,
6121 % print special symbols as themselves, and
6122 % make each space count
6123 % must do in this order:
6124 \obeylines \uncatcodespecials \sepspaces
6125 \everypar{\starttabbox}%
6128 % Do the @verb magic: verbatim text is quoted by unique
6129 % delimiter characters. Before first delimiter expect a
6130 % right brace, after last delimiter expect closing brace:
6132 % \def\doverb'{'<char>#1<char>'}'{#1}
6134 % [Knuth] p. 382; only eat outer {}
6135 \begingroup
6136 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6137 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6138 \endgroup
6140 \def\verb{\begingroup\setupverb\doverb}
6143 % Do the @verbatim magic: define the macro \doverbatim so that
6144 % the (first) argument ends when '@end verbatim' is reached, ie:
6146 % \def\doverbatim#1@end verbatim{#1}
6148 % For Texinfo it's a lot easier than for LaTeX,
6149 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6150 % we need not redefine '\', '{' and '}'.
6152 % Inspired by LaTeX's verbatim command set [latex.ltx]
6154 \begingroup
6155 \catcode`\ =\active
6156 \obeylines %
6157 % ignore everything up to the first ^^M, that's the newline at the end
6158 % of the @verbatim input line itself. Otherwise we get an extra blank
6159 % line in the output.
6160 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6161 % We really want {...\end verbatim} in the body of the macro, but
6162 % without the active space; thus we have to use \xdef and \gobble.
6163 \endgroup
6165 \envdef\verbatim{%
6166 \setupverbatim\doverbatim
6168 \let\Everbatim = \afterenvbreak
6171 % @verbatiminclude FILE - insert text of file in verbatim environment.
6173 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6175 \def\doverbatiminclude#1{%
6177 \makevalueexpandable
6178 \setupverbatim
6179 \input #1
6180 \afterenvbreak
6184 % @copying ... @end copying.
6185 % Save the text away for @insertcopying later.
6187 % We save the uninterpreted tokens, rather than creating a box.
6188 % Saving the text in a box would be much easier, but then all the
6189 % typesetting commands (@smallbook, font changes, etc.) have to be done
6190 % beforehand -- and a) we want @copying to be done first in the source
6191 % file; b) letting users define the frontmatter in as flexible order as
6192 % possible is very desirable.
6194 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6195 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6197 \def\insertcopying{%
6198 \begingroup
6199 \parindent = 0pt % paragraph indentation looks wrong on title page
6200 \scanexp\copyingtext
6201 \endgroup
6205 \message{defuns,}
6206 % @defun etc.
6208 \newskip\defbodyindent \defbodyindent=.4in
6209 \newskip\defargsindent \defargsindent=50pt
6210 \newskip\deflastargmargin \deflastargmargin=18pt
6211 \newcount\defunpenalty
6213 % Start the processing of @deffn:
6214 \def\startdefun{%
6215 \ifnum\lastpenalty<10000
6216 \medbreak
6217 \defunpenalty=10003 % Will keep this @deffn together with the
6218 % following @def command, see below.
6219 \else
6220 % If there are two @def commands in a row, we'll have a \nobreak,
6221 % which is there to keep the function description together with its
6222 % header. But if there's nothing but headers, we need to allow a
6223 % break somewhere. Check specifically for penalty 10002, inserted
6224 % by \printdefunline, instead of 10000, since the sectioning
6225 % commands also insert a nobreak penalty, and we don't want to allow
6226 % a break between a section heading and a defun.
6228 % As a minor refinement, we avoid "club" headers by signalling
6229 % with penalty of 10003 after the very first @deffn in the
6230 % sequence (see above), and penalty of 10002 after any following
6231 % @def command.
6232 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6234 % Similarly, after a section heading, do not allow a break.
6235 % But do insert the glue.
6236 \medskip % preceded by discardable penalty, so not a breakpoint
6239 \parindent=0in
6240 \advance\leftskip by \defbodyindent
6241 \exdentamount=\defbodyindent
6244 \def\dodefunx#1{%
6245 % First, check whether we are in the right environment:
6246 \checkenv#1%
6248 % As above, allow line break if we have multiple x headers in a row.
6249 % It's not a great place, though.
6250 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6252 % And now, it's time to reuse the body of the original defun:
6253 \expandafter\gobbledefun#1%
6255 \def\gobbledefun#1\startdefun{}
6257 % \printdefunline \deffnheader{text}
6259 \def\printdefunline#1#2{%
6260 \begingroup
6261 % call \deffnheader:
6262 #1#2 \endheader
6263 % common ending:
6264 \interlinepenalty = 10000
6265 \advance\rightskip by 0pt plus 1fil
6266 \endgraf
6267 \nobreak\vskip -\parskip
6268 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6269 % Some of the @defun-type tags do not enable magic parentheses,
6270 % rendering the following check redundant. But we don't optimize.
6271 \checkparencounts
6272 \endgroup
6275 \def\Edefun{\endgraf\medbreak}
6277 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6278 % the only thing remaining is to define \deffnheader.
6280 \def\makedefun#1{%
6281 \expandafter\let\csname E#1\endcsname = \Edefun
6282 \edef\temp{\noexpand\domakedefun
6283 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6284 \temp
6287 % \domakedefun \deffn \deffnx \deffnheader
6289 % Define \deffn and \deffnx, without parameters.
6290 % \deffnheader has to be defined explicitly.
6292 \def\domakedefun#1#2#3{%
6293 \envdef#1{%
6294 \startdefun
6295 \parseargusing\activeparens{\printdefunline#3}%
6297 \def#2{\dodefunx#1}%
6298 \def#3%
6301 %%% Untyped functions:
6303 % @deffn category name args
6304 \makedefun{deffn}{\deffngeneral{}}
6306 % @deffn category class name args
6307 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6309 % \defopon {category on}class name args
6310 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6312 % \deffngeneral {subind}category name args
6314 \def\deffngeneral#1#2 #3 #4\endheader{%
6315 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6316 \dosubind{fn}{\code{#3}}{#1}%
6317 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6320 %%% Typed functions:
6322 % @deftypefn category type name args
6323 \makedefun{deftypefn}{\deftypefngeneral{}}
6325 % @deftypeop category class type name args
6326 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6328 % \deftypeopon {category on}class type name args
6329 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6331 % \deftypefngeneral {subind}category type name args
6333 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6334 \dosubind{fn}{\code{#4}}{#1}%
6335 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6338 %%% Typed variables:
6340 % @deftypevr category type var args
6341 \makedefun{deftypevr}{\deftypecvgeneral{}}
6343 % @deftypecv category class type var args
6344 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6346 % \deftypecvof {category of}class type var args
6347 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6349 % \deftypecvgeneral {subind}category type var args
6351 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6352 \dosubind{vr}{\code{#4}}{#1}%
6353 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6356 %%% Untyped variables:
6358 % @defvr category var args
6359 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6361 % @defcv category class var args
6362 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6364 % \defcvof {category of}class var args
6365 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6367 %%% Type:
6368 % @deftp category name args
6369 \makedefun{deftp}#1 #2 #3\endheader{%
6370 \doind{tp}{\code{#2}}%
6371 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6374 % Remaining @defun-like shortcuts:
6375 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6376 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6377 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6378 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6379 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6380 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6381 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6382 \makedefun{defmethod}{\defopon\putwordMethodon}
6383 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6384 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6385 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6387 % \defname, which formats the name of the @def (not the args).
6388 % #1 is the category, such as "Function".
6389 % #2 is the return type, if any.
6390 % #3 is the function name.
6392 % We are followed by (but not passed) the arguments, if any.
6394 \def\defname#1#2#3{%
6395 % Get the values of \leftskip and \rightskip as they were outside the @def...
6396 \advance\leftskip by -\defbodyindent
6398 % How we'll format the type name. Putting it in brackets helps
6399 % distinguish it from the body text that may end up on the next line
6400 % just below it.
6401 \def\temp{#1}%
6402 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6404 % Figure out line sizes for the paragraph shape.
6405 % The first line needs space for \box0; but if \rightskip is nonzero,
6406 % we need only space for the part of \box0 which exceeds it:
6407 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6408 % The continuations:
6409 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6410 % (plain.tex says that \dimen1 should be used only as global.)
6411 \parshape 2 0in \dimen0 \defargsindent \dimen2
6413 % Put the type name to the right margin.
6414 \noindent
6415 \hbox to 0pt{%
6416 \hfil\box0 \kern-\hsize
6417 % \hsize has to be shortened this way:
6418 \kern\leftskip
6419 % Intentionally do not respect \rightskip, since we need the space.
6422 % Allow all lines to be underfull without complaint:
6423 \tolerance=10000 \hbadness=10000
6424 \exdentamount=\defbodyindent
6426 % defun fonts. We use typewriter by default (used to be bold) because:
6427 % . we're printing identifiers, they should be in tt in principle.
6428 % . in languages with many accents, such as Czech or French, it's
6429 % common to leave accents off identifiers. The result looks ok in
6430 % tt, but exceedingly strange in rm.
6431 % . we don't want -- and --- to be treated as ligatures.
6432 % . this still does not fix the ?` and !` ligatures, but so far no
6433 % one has made identifiers using them :).
6434 \df \tt
6435 \def\temp{#2}% return value type
6436 \ifx\temp\empty\else \tclose{\temp} \fi
6437 #3% output function name
6439 {\rm\enskip}% hskip 0.5 em of \tenrm
6441 \boldbrax
6442 % arguments will be output next, if any.
6445 % Print arguments in slanted roman (not ttsl), inconsistently with using
6446 % tt for the name. This is because literal text is sometimes needed in
6447 % the argument list (groff manual), and ttsl and tt are not very
6448 % distinguishable. Prevent hyphenation at `-' chars.
6450 \def\defunargs#1{%
6451 % use sl by default (not ttsl),
6452 % tt for the names.
6453 \df \sl \hyphenchar\font=0
6455 % On the other hand, if an argument has two dashes (for instance), we
6456 % want a way to get ttsl. Let's try @var for that.
6457 \let\var=\ttslanted
6459 \sl\hyphenchar\font=45
6462 % We want ()&[] to print specially on the defun line.
6464 \def\activeparens{%
6465 \catcode`\(=\active \catcode`\)=\active
6466 \catcode`\[=\active \catcode`\]=\active
6467 \catcode`\&=\active
6470 % Make control sequences which act like normal parenthesis chars.
6471 \let\lparen = ( \let\rparen = )
6473 % Be sure that we always have a definition for `(', etc. For example,
6474 % if the fn name has parens in it, \boldbrax will not be in effect yet,
6475 % so TeX would otherwise complain about undefined control sequence.
6477 \activeparens
6478 \global\let(=\lparen \global\let)=\rparen
6479 \global\let[=\lbrack \global\let]=\rbrack
6480 \global\let& = \&
6482 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
6483 \gdef\magicamp{\let&=\amprm}
6486 \newcount\parencount
6488 % If we encounter &foo, then turn on ()-hacking afterwards
6489 \newif\ifampseen
6490 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
6492 \def\parenfont{%
6493 \ifampseen
6494 % At the first level, print parens in roman,
6495 % otherwise use the default font.
6496 \ifnum \parencount=1 \rm \fi
6497 \else
6498 % The \sf parens (in \boldbrax) actually are a little bolder than
6499 % the contained text. This is especially needed for [ and ] .
6503 \def\infirstlevel#1{%
6504 \ifampseen
6505 \ifnum\parencount=1
6510 \def\bfafterword#1 {#1 \bf}
6512 \def\opnr{%
6513 \global\advance\parencount by 1
6514 {\parenfont(}%
6515 \infirstlevel \bfafterword
6517 \def\clnr{%
6518 {\parenfont)}%
6519 \infirstlevel \sl
6520 \global\advance\parencount by -1
6523 \newcount\brackcount
6524 \def\lbrb{%
6525 \global\advance\brackcount by 1
6526 {\bf[}%
6528 \def\rbrb{%
6529 {\bf]}%
6530 \global\advance\brackcount by -1
6533 \def\checkparencounts{%
6534 \ifnum\parencount=0 \else \badparencount \fi
6535 \ifnum\brackcount=0 \else \badbrackcount \fi
6537 % these should not use \errmessage; the glibc manual, at least, actually
6538 % has such constructs (when documenting function pointers).
6539 \def\badparencount{%
6540 \message{Warning: unbalanced parentheses in @def...}%
6541 \global\parencount=0
6543 \def\badbrackcount{%
6544 \message{Warning: unbalanced square brackets in @def...}%
6545 \global\brackcount=0
6549 \message{macros,}
6550 % @macro.
6552 % To do this right we need a feature of e-TeX, \scantokens,
6553 % which we arrange to emulate with a temporary file in ordinary TeX.
6554 \ifx\eTeXversion\undefined
6555 \newwrite\macscribble
6556 \def\scantokens#1{%
6557 \toks0={#1}%
6558 \immediate\openout\macscribble=\jobname.tmp
6559 \immediate\write\macscribble{\the\toks0}%
6560 \immediate\closeout\macscribble
6561 \input \jobname.tmp
6565 \def\scanmacro#1{%
6566 \begingroup
6567 \newlinechar`\^^M
6568 \let\xeatspaces\eatspaces
6569 % Undo catcode changes of \startcontents and \doprintindex
6570 % When called from @insertcopying or (short)caption, we need active
6571 % backslash to get it printed correctly. Previously, we had
6572 % \catcode`\\=\other instead. We'll see whether a problem appears
6573 % with macro expansion. --kasal, 19aug04
6574 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6575 % ... and \example
6576 \spaceisspace
6578 % Append \endinput to make sure that TeX does not see the ending newline.
6579 % I've verified that it is necessary both for e-TeX and for ordinary TeX
6580 % --kasal, 29nov03
6581 \scantokens{#1\endinput}%
6582 \endgroup
6585 \def\scanexp#1{%
6586 \edef\temp{\noexpand\scanmacro{#1}}%
6587 \temp
6590 \newcount\paramno % Count of parameters
6591 \newtoks\macname % Macro name
6592 \newif\ifrecursive % Is it recursive?
6594 % List of all defined macros in the form
6595 % \definedummyword\macro1\definedummyword\macro2...
6596 % Currently is also contains all @aliases; the list can be split
6597 % if there is a need.
6598 \def\macrolist{}
6600 % Add the macro to \macrolist
6601 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6602 \def\addtomacrolistxxx#1{%
6603 \toks0 = \expandafter{\macrolist\definedummyword#1}%
6604 \xdef\macrolist{\the\toks0}%
6607 % Utility routines.
6608 % This does \let #1 = #2, with \csnames; that is,
6609 % \let \csname#1\endcsname = \csname#2\endcsname
6610 % (except of course we have to play expansion games).
6612 \def\cslet#1#2{%
6613 \expandafter\let
6614 \csname#1\expandafter\endcsname
6615 \csname#2\endcsname
6618 % Trim leading and trailing spaces off a string.
6619 % Concepts from aro-bend problem 15 (see CTAN).
6620 {\catcode`\@=11
6621 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6622 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6623 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6624 \def\unbrace#1{#1}
6625 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6628 % Trim a single trailing ^^M off a string.
6629 {\catcode`\^^M=\other \catcode`\Q=3%
6630 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6631 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6632 \gdef\eatcrb#1Q#2Q{#1}%
6635 % Macro bodies are absorbed as an argument in a context where
6636 % all characters are catcode 10, 11 or 12, except \ which is active
6637 % (as in normal texinfo). It is necessary to change the definition of \.
6639 % Non-ASCII encodings make 8-bit characters active, so un-activate
6640 % them to avoid their expansion. Must do this non-globally, to
6641 % confine the change to the current group.
6643 % It's necessary to have hard CRs when the macro is executed. This is
6644 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
6645 % body, and then making it the \newlinechar in \scanmacro.
6647 \def\scanctxt{%
6648 \catcode`\"=\other
6649 \catcode`\+=\other
6650 \catcode`\<=\other
6651 \catcode`\>=\other
6652 \catcode`\@=\other
6653 \catcode`\^=\other
6654 \catcode`\_=\other
6655 \catcode`\|=\other
6656 \catcode`\~=\other
6657 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
6660 \def\scanargctxt{%
6661 \scanctxt
6662 \catcode`\\=\other
6663 \catcode`\^^M=\other
6666 \def\macrobodyctxt{%
6667 \scanctxt
6668 \catcode`\{=\other
6669 \catcode`\}=\other
6670 \catcode`\^^M=\other
6671 \usembodybackslash
6674 \def\macroargctxt{%
6675 \scanctxt
6676 \catcode`\\=\other
6679 % \mbodybackslash is the definition of \ in @macro bodies.
6680 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6681 % where N is the macro parameter number.
6682 % We define \csname macarg.\endcsname to be \realbackslash, so
6683 % \\ in macro replacement text gets you a backslash.
6685 {\catcode`@=0 @catcode`@\=@active
6686 @gdef@usembodybackslash{@let\=@mbodybackslash}
6687 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6689 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6691 \def\macro{\recursivefalse\parsearg\macroxxx}
6692 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6694 \def\macroxxx#1{%
6695 \getargs{#1}% now \macname is the macname and \argl the arglist
6696 \ifx\argl\empty % no arguments
6697 \paramno=0%
6698 \else
6699 \expandafter\parsemargdef \argl;%
6701 \if1\csname ismacro.\the\macname\endcsname
6702 \message{Warning: redefining \the\macname}%
6703 \else
6704 \expandafter\ifx\csname \the\macname\endcsname \relax
6705 \else \errmessage{Macro name \the\macname\space already defined}\fi
6706 \global\cslet{macsave.\the\macname}{\the\macname}%
6707 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6708 \addtomacrolist{\the\macname}%
6710 \begingroup \macrobodyctxt
6711 \ifrecursive \expandafter\parsermacbody
6712 \else \expandafter\parsemacbody
6713 \fi}
6715 \parseargdef\unmacro{%
6716 \if1\csname ismacro.#1\endcsname
6717 \global\cslet{#1}{macsave.#1}%
6718 \global\expandafter\let \csname ismacro.#1\endcsname=0%
6719 % Remove the macro name from \macrolist:
6720 \begingroup
6721 \expandafter\let\csname#1\endcsname \relax
6722 \let\definedummyword\unmacrodo
6723 \xdef\macrolist{\macrolist}%
6724 \endgroup
6725 \else
6726 \errmessage{Macro #1 not defined}%
6730 % Called by \do from \dounmacro on each macro. The idea is to omit any
6731 % macro definitions that have been changed to \relax.
6733 \def\unmacrodo#1{%
6734 \ifx #1\relax
6735 % remove this
6736 \else
6737 \noexpand\definedummyword \noexpand#1%
6741 % This makes use of the obscure feature that if the last token of a
6742 % <parameter list> is #, then the preceding argument is delimited by
6743 % an opening brace, and that opening brace is not consumed.
6744 \def\getargs#1{\getargsxxx#1{}}
6745 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
6746 \def\getmacname #1 #2\relax{\macname={#1}}
6747 \def\getmacargs#1{\def\argl{#1}}
6749 % Parse the optional {params} list. Set up \paramno and \paramlist
6750 % so \defmacro knows what to do. Define \macarg.blah for each blah
6751 % in the params list, to be ##N where N is the position in that list.
6752 % That gets used by \mbodybackslash (above).
6754 % We need to get `macro parameter char #' into several definitions.
6755 % The technique used is stolen from LaTeX: let \hash be something
6756 % unexpandable, insert that wherever you need a #, and then redefine
6757 % it to # just before using the token list produced.
6759 % The same technique is used to protect \eatspaces till just before
6760 % the macro is used.
6762 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
6763 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
6764 \def\parsemargdefxxx#1,{%
6765 \if#1;\let\next=\relax
6766 \else \let\next=\parsemargdefxxx
6767 \advance\paramno by 1%
6768 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
6769 {\xeatspaces{\hash\the\paramno}}%
6770 \edef\paramlist{\paramlist\hash\the\paramno,}%
6771 \fi\next}
6773 % These two commands read recursive and nonrecursive macro bodies.
6774 % (They're different since rec and nonrec macros end differently.)
6776 \long\def\parsemacbody#1@end macro%
6777 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6778 \long\def\parsermacbody#1@end rmacro%
6779 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6781 % This defines the macro itself. There are six cases: recursive and
6782 % nonrecursive macros of zero, one, and many arguments.
6783 % Much magic with \expandafter here.
6784 % \xdef is used so that macro definitions will survive the file
6785 % they're defined in; @include reads the file inside a group.
6786 \def\defmacro{%
6787 \let\hash=##% convert placeholders to macro parameter chars
6788 \ifrecursive
6789 \ifcase\paramno
6791 \expandafter\xdef\csname\the\macname\endcsname{%
6792 \noexpand\scanmacro{\temp}}%
6793 \or % 1
6794 \expandafter\xdef\csname\the\macname\endcsname{%
6795 \bgroup\noexpand\macroargctxt
6796 \noexpand\braceorline
6797 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6798 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6799 \egroup\noexpand\scanmacro{\temp}}%
6800 \else % many
6801 \expandafter\xdef\csname\the\macname\endcsname{%
6802 \bgroup\noexpand\macroargctxt
6803 \noexpand\csname\the\macname xx\endcsname}%
6804 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6805 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6806 \expandafter\expandafter
6807 \expandafter\xdef
6808 \expandafter\expandafter
6809 \csname\the\macname xxx\endcsname
6810 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
6812 \else
6813 \ifcase\paramno
6815 \expandafter\xdef\csname\the\macname\endcsname{%
6816 \noexpand\norecurse{\the\macname}%
6817 \noexpand\scanmacro{\temp}\egroup}%
6818 \or % 1
6819 \expandafter\xdef\csname\the\macname\endcsname{%
6820 \bgroup\noexpand\macroargctxt
6821 \noexpand\braceorline
6822 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6823 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6824 \egroup
6825 \noexpand\norecurse{\the\macname}%
6826 \noexpand\scanmacro{\temp}\egroup}%
6827 \else % many
6828 \expandafter\xdef\csname\the\macname\endcsname{%
6829 \bgroup\noexpand\macroargctxt
6830 \expandafter\noexpand\csname\the\macname xx\endcsname}%
6831 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6832 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6833 \expandafter\expandafter
6834 \expandafter\xdef
6835 \expandafter\expandafter
6836 \csname\the\macname xxx\endcsname
6837 \paramlist{%
6838 \egroup
6839 \noexpand\norecurse{\the\macname}%
6840 \noexpand\scanmacro{\temp}\egroup}%
6842 \fi}
6844 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
6846 % \braceorline decides whether the next nonwhitespace character is a
6847 % {. If so it reads up to the closing }, if not, it reads the whole
6848 % line. Whatever was read is then fed to the next control sequence
6849 % as an argument (by \parsebrace or \parsearg)
6850 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
6851 \def\braceorlinexxx{%
6852 \ifx\nchar\bgroup\else
6853 \expandafter\parsearg
6854 \fi \macnamexxx}
6857 % @alias.
6858 % We need some trickery to remove the optional spaces around the equal
6859 % sign. Just make them active and then expand them all to nothing.
6860 \def\alias{\parseargusing\obeyspaces\aliasxxx}
6861 \def\aliasxxx #1{\aliasyyy#1\relax}
6862 \def\aliasyyy #1=#2\relax{%
6864 \expandafter\let\obeyedspace=\empty
6865 \addtomacrolist{#1}%
6866 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
6868 \next
6872 \message{cross references,}
6874 \newwrite\auxfile
6875 \newif\ifhavexrefs % True if xref values are known.
6876 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
6878 % @inforef is relatively simple.
6879 \def\inforef #1{\inforefzzz #1,,,,**}
6880 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
6881 node \samp{\ignorespaces#1{}}}
6883 % @node's only job in TeX is to define \lastnode, which is used in
6884 % cross-references. The @node line might or might not have commas, and
6885 % might or might not have spaces before the first comma, like:
6886 % @node foo , bar , ...
6887 % We don't want such trailing spaces in the node name.
6889 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
6891 % also remove a trailing comma, in case of something like this:
6892 % @node Help-Cross, , , Cross-refs
6893 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
6894 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
6896 \let\nwnode=\node
6897 \let\lastnode=\empty
6899 % Write a cross-reference definition for the current node. #1 is the
6900 % type (Ynumbered, Yappendix, Ynothing).
6902 \def\donoderef#1{%
6903 \ifx\lastnode\empty\else
6904 \setref{\lastnode}{#1}%
6905 \global\let\lastnode=\empty
6909 % @anchor{NAME} -- define xref target at arbitrary point.
6911 \newcount\savesfregister
6913 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
6914 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
6915 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
6917 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
6918 % anchor), which consists of three parts:
6919 % 1) NAME-title - the current sectioning name taken from \lastsection,
6920 % or the anchor name.
6921 % 2) NAME-snt - section number and type, passed as the SNT arg, or
6922 % empty for anchors.
6923 % 3) NAME-pg - the page number.
6925 % This is called from \donoderef, \anchor, and \dofloat. In the case of
6926 % floats, there is an additional part, which is not written here:
6927 % 4) NAME-lof - the text as it should appear in a @listoffloats.
6929 \def\setref#1#2{%
6930 \pdfmkdest{#1}%
6931 \iflinks
6933 \atdummies % preserve commands, but don't expand them
6934 \edef\writexrdef##1##2{%
6935 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6936 ##1}{##2}}% these are parameters of \writexrdef
6938 \toks0 = \expandafter{\lastsection}%
6939 \immediate \writexrdef{title}{\the\toks0 }%
6940 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6941 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout
6946 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
6947 % the node name, #2 the name of the Info cross-reference, #3 the printed
6948 % node name, #4 the name of the Info file, #5 the name of the printed
6949 % manual. All but the node name can be omitted.
6951 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
6952 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
6953 \def\ref#1{\xrefX[#1,,,,,,,]}
6954 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
6955 \unsepspaces
6956 \def\printedmanual{\ignorespaces #5}%
6957 \def\printedrefname{\ignorespaces #3}%
6958 \setbox1=\hbox{\printedmanual\unskip}%
6959 \setbox0=\hbox{\printedrefname\unskip}%
6960 \ifdim \wd0 = 0pt
6961 % No printed node name was explicitly given.
6962 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
6963 % Use the node name inside the square brackets.
6964 \def\printedrefname{\ignorespaces #1}%
6965 \else
6966 % Use the actual chapter/section title appear inside
6967 % the square brackets. Use the real section title if we have it.
6968 \ifdim \wd1 > 0pt
6969 % It is in another manual, so we don't have it.
6970 \def\printedrefname{\ignorespaces #1}%
6971 \else
6972 \ifhavexrefs
6973 % We know the real title if we have the xref values.
6974 \def\printedrefname{\refx{#1-title}{}}%
6975 \else
6976 % Otherwise just copy the Info node name.
6977 \def\printedrefname{\ignorespaces #1}%
6978 \fi%
6983 % Make link in pdf output.
6984 \ifpdf
6985 {\indexnofonts
6986 \turnoffactive
6987 % This expands tokens, so do it after making catcode changes, so _
6988 % etc. don't get their TeX definitions.
6989 \getfilename{#4}%
6991 % See comments at \activebackslashdouble.
6992 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
6993 \backslashparens\pdfxrefdest}%
6995 \leavevmode
6996 \startlink attr{/Border [0 0 0]}%
6997 \ifnum\filenamelength>0
6998 goto file{\the\filename.pdf} name{\pdfxrefdest}%
6999 \else
7000 goto name{\pdfmkpgn{\pdfxrefdest}}%
7003 \setcolor{\linkcolor}%
7006 % Float references are printed completely differently: "Figure 1.2"
7007 % instead of "[somenode], p.3". We distinguish them by the
7008 % LABEL-title being set to a magic string.
7010 % Have to otherify everything special to allow the \csname to
7011 % include an _ in the xref name, etc.
7012 \indexnofonts
7013 \turnoffactive
7014 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7015 \csname XR#1-title\endcsname
7017 \iffloat\Xthisreftitle
7018 % If the user specified the print name (third arg) to the ref,
7019 % print it instead of our usual "Figure 1.2".
7020 \ifdim\wd0 = 0pt
7021 \refx{#1-snt}{}%
7022 \else
7023 \printedrefname
7026 % if the user also gave the printed manual name (fifth arg), append
7027 % "in MANUALNAME".
7028 \ifdim \wd1 > 0pt
7029 \space \putwordin{} \cite{\printedmanual}%
7031 \else
7032 % node/anchor (non-float) references.
7034 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7035 % insert empty discretionaries after hyphens, which means that it will
7036 % not find a line break at a hyphen in a node names. Since some manuals
7037 % are best written with fairly long node names, containing hyphens, this
7038 % is a loss. Therefore, we give the text of the node name again, so it
7039 % is as if TeX is seeing it for the first time.
7040 \ifdim \wd1 > 0pt
7041 \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7042 \else
7043 % _ (for example) has to be the character _ for the purposes of the
7044 % control sequence corresponding to the node, but it has to expand
7045 % into the usual \leavevmode...\vrule stuff for purposes of
7046 % printing. So we \turnoffactive for the \refx-snt, back on for the
7047 % printing, back off for the \refx-pg.
7048 {\turnoffactive
7049 % Only output a following space if the -snt ref is nonempty; for
7050 % @unnumbered and @anchor, it won't be.
7051 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7052 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7054 % output the `[mynode]' via a macro so it can be overridden.
7055 \xrefprintnodename\printedrefname
7057 % But we always want a comma and a space:
7058 ,\space
7060 % output the `page 3'.
7061 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7064 \endlink
7065 \endgroup}
7067 % This macro is called from \xrefX for the `[nodename]' part of xref
7068 % output. It's a separate macro only so it can be changed more easily,
7069 % since square brackets don't work well in some documents. Particularly
7070 % one that Bob is working on :).
7072 \def\xrefprintnodename#1{[#1]}
7074 % Things referred to by \setref.
7076 \def\Ynothing{}
7077 \def\Yomitfromtoc{}
7078 \def\Ynumbered{%
7079 \ifnum\secno=0
7080 \putwordChapter@tie \the\chapno
7081 \else \ifnum\subsecno=0
7082 \putwordSection@tie \the\chapno.\the\secno
7083 \else \ifnum\subsubsecno=0
7084 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7085 \else
7086 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7087 \fi\fi\fi
7089 \def\Yappendix{%
7090 \ifnum\secno=0
7091 \putwordAppendix@tie @char\the\appendixno{}%
7092 \else \ifnum\subsecno=0
7093 \putwordSection@tie @char\the\appendixno.\the\secno
7094 \else \ifnum\subsubsecno=0
7095 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7096 \else
7097 \putwordSection@tie
7098 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7099 \fi\fi\fi
7102 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7103 % If its value is nonempty, SUFFIX is output afterward.
7105 \def\refx#1#2{%
7107 \indexnofonts
7108 \otherbackslash
7109 \expandafter\global\expandafter\let\expandafter\thisrefX
7110 \csname XR#1\endcsname
7112 \ifx\thisrefX\relax
7113 % If not defined, say something at least.
7114 \angleleft un\-de\-fined\angleright
7115 \iflinks
7116 \ifhavexrefs
7117 \message{\linenumber Undefined cross reference `#1'.}%
7118 \else
7119 \ifwarnedxrefs\else
7120 \global\warnedxrefstrue
7121 \message{Cross reference values unknown; you must run TeX again.}%
7125 \else
7126 % It's defined, so just use it.
7127 \thisrefX
7129 #2% Output the suffix in any case.
7132 % This is the macro invoked by entries in the aux file. Usually it's
7133 % just a \def (we prepend XR to the control sequence name to avoid
7134 % collisions). But if this is a float type, we have more work to do.
7136 \def\xrdef#1#2{%
7137 {% The node name might contain 8-bit characters, which in our current
7138 % implementation are changed to commands like @'e. Don't let these
7139 % mess up the control sequence name.
7140 \indexnofonts
7141 \turnoffactive
7142 \xdef\safexrefname{#1}%
7145 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7147 % Was that xref control sequence that we just defined for a float?
7148 \expandafter\iffloat\csname XR\safexrefname\endcsname
7149 % it was a float, and we have the (safe) float type in \iffloattype.
7150 \expandafter\let\expandafter\floatlist
7151 \csname floatlist\iffloattype\endcsname
7153 % Is this the first time we've seen this float type?
7154 \expandafter\ifx\floatlist\relax
7155 \toks0 = {\do}% yes, so just \do
7156 \else
7157 % had it before, so preserve previous elements in list.
7158 \toks0 = \expandafter{\floatlist\do}%
7161 % Remember this xref in the control sequence \floatlistFLOATTYPE,
7162 % for later use in \listoffloats.
7163 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
7164 {\safexrefname}}%
7168 % Read the last existing aux file, if any. No error if none exists.
7170 \def\tryauxfile{%
7171 \openin 1 \jobname.aux
7172 \ifeof 1 \else
7173 \readdatafile{aux}%
7174 \global\havexrefstrue
7176 \closein 1
7179 \def\setupdatafile{%
7180 \catcode`\^^@=\other
7181 \catcode`\^^A=\other
7182 \catcode`\^^B=\other
7183 \catcode`\^^C=\other
7184 \catcode`\^^D=\other
7185 \catcode`\^^E=\other
7186 \catcode`\^^F=\other
7187 \catcode`\^^G=\other
7188 \catcode`\^^H=\other
7189 \catcode`\^^K=\other
7190 \catcode`\^^L=\other
7191 \catcode`\^^N=\other
7192 \catcode`\^^P=\other
7193 \catcode`\^^Q=\other
7194 \catcode`\^^R=\other
7195 \catcode`\^^S=\other
7196 \catcode`\^^T=\other
7197 \catcode`\^^U=\other
7198 \catcode`\^^V=\other
7199 \catcode`\^^W=\other
7200 \catcode`\^^X=\other
7201 \catcode`\^^Z=\other
7202 \catcode`\^^[=\other
7203 \catcode`\^^\=\other
7204 \catcode`\^^]=\other
7205 \catcode`\^^^=\other
7206 \catcode`\^^_=\other
7207 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
7208 % in xref tags, i.e., node names. But since ^^e4 notation isn't
7209 % supported in the main text, it doesn't seem desirable. Furthermore,
7210 % that is not enough: for node names that actually contain a ^
7211 % character, we would end up writing a line like this: 'xrdef {'hat
7212 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
7213 % argument, and \hat is not an expandable control sequence. It could
7214 % all be worked out, but why? Either we support ^^ or we don't.
7216 % The other change necessary for this was to define \auxhat:
7217 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
7218 % and then to call \auxhat in \setq.
7220 \catcode`\^=\other
7222 % Special characters. Should be turned off anyway, but...
7223 \catcode`\~=\other
7224 \catcode`\[=\other
7225 \catcode`\]=\other
7226 \catcode`\"=\other
7227 \catcode`\_=\other
7228 \catcode`\|=\other
7229 \catcode`\<=\other
7230 \catcode`\>=\other
7231 \catcode`\$=\other
7232 \catcode`\#=\other
7233 \catcode`\&=\other
7234 \catcode`\%=\other
7235 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
7237 % This is to support \ in node names and titles, since the \
7238 % characters end up in a \csname. It's easier than
7239 % leaving it active and making its active definition an actual \
7240 % character. What I don't understand is why it works in the *value*
7241 % of the xrdef. Seems like it should be a catcode12 \, and that
7242 % should not typeset properly. But it works, so I'm moving on for
7243 % now. --karl, 15jan04.
7244 \catcode`\\=\other
7246 % Make the characters 128-255 be printing characters.
7248 \count1=128
7249 \def\loop{%
7250 \catcode\count1=\other
7251 \advance\count1 by 1
7252 \ifnum \count1<256 \loop \fi
7256 % @ is our escape character in .aux files, and we need braces.
7257 \catcode`\{=1
7258 \catcode`\}=2
7259 \catcode`\@=0
7262 \def\readdatafile#1{%
7263 \begingroup
7264 \setupdatafile
7265 \input\jobname.#1
7266 \endgroup}
7269 \message{insertions,}
7270 % including footnotes.
7272 \newcount \footnoteno
7274 % The trailing space in the following definition for supereject is
7275 % vital for proper filling; pages come out unaligned when you do a
7276 % pagealignmacro call if that space before the closing brace is
7277 % removed. (Generally, numeric constants should always be followed by a
7278 % space to prevent strange expansion errors.)
7279 \def\supereject{\par\penalty -20000\footnoteno =0 }
7281 % @footnotestyle is meaningful for info output only.
7282 \let\footnotestyle=\comment
7284 {\catcode `\@=11
7286 % Auto-number footnotes. Otherwise like plain.
7287 \gdef\footnote{%
7288 \let\indent=\ptexindent
7289 \let\noindent=\ptexnoindent
7290 \global\advance\footnoteno by \@ne
7291 \edef\thisfootno{$^{\the\footnoteno}$}%
7293 % In case the footnote comes at the end of a sentence, preserve the
7294 % extra spacing after we do the footnote number.
7295 \let\@sf\empty
7296 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
7298 % Remove inadvertent blank space before typesetting the footnote number.
7299 \unskip
7300 \thisfootno\@sf
7301 \dofootnote
7304 % Don't bother with the trickery in plain.tex to not require the
7305 % footnote text as a parameter. Our footnotes don't need to be so general.
7307 % Oh yes, they do; otherwise, @ifset (and anything else that uses
7308 % \parseargline) fails inside footnotes because the tokens are fixed when
7309 % the footnote is read. --karl, 16nov96.
7311 \gdef\dofootnote{%
7312 \insert\footins\bgroup
7313 % We want to typeset this text as a normal paragraph, even if the
7314 % footnote reference occurs in (for example) a display environment.
7315 % So reset some parameters.
7316 \hsize=\pagewidth
7317 \interlinepenalty\interfootnotelinepenalty
7318 \splittopskip\ht\strutbox % top baseline for broken footnotes
7319 \splitmaxdepth\dp\strutbox
7320 \floatingpenalty\@MM
7321 \leftskip\z@skip
7322 \rightskip\z@skip
7323 \spaceskip\z@skip
7324 \xspaceskip\z@skip
7325 \parindent\defaultparindent
7327 \smallfonts \rm
7329 % Because we use hanging indentation in footnotes, a @noindent appears
7330 % to exdent this text, so make it be a no-op. makeinfo does not use
7331 % hanging indentation so @noindent can still be needed within footnote
7332 % text after an @example or the like (not that this is good style).
7333 \let\noindent = \relax
7335 % Hang the footnote text off the number. Use \everypar in case the
7336 % footnote extends for more than one paragraph.
7337 \everypar = {\hang}%
7338 \textindent{\thisfootno}%
7340 % Don't crash into the line above the footnote text. Since this
7341 % expands into a box, it must come within the paragraph, lest it
7342 % provide a place where TeX can split the footnote.
7343 \footstrut
7344 \futurelet\next\fo@t
7346 }%end \catcode `\@=11
7348 % In case a @footnote appears in a vbox, save the footnote text and create
7349 % the real \insert just after the vbox finished. Otherwise, the insertion
7350 % would be lost.
7351 % Similarly, if a @footnote appears inside an alignment, save the footnote
7352 % text to a box and make the \insert when a row of the table is finished.
7353 % And the same can be done for other insert classes. --kasal, 16nov03.
7355 % Replace the \insert primitive by a cheating macro.
7356 % Deeper inside, just make sure that the saved insertions are not spilled
7357 % out prematurely.
7359 \def\startsavinginserts{%
7360 \ifx \insert\ptexinsert
7361 \let\insert\saveinsert
7362 \else
7363 \let\checkinserts\relax
7367 % This \insert replacement works for both \insert\footins{foo} and
7368 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
7370 \def\saveinsert#1{%
7371 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
7372 \afterassignment\next
7373 % swallow the left brace
7374 \let\temp =
7376 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
7377 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
7379 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
7381 \def\placesaveins#1{%
7382 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
7383 {\box#1}%
7386 % eat @SAVE -- beware, all of them have catcode \other:
7388 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
7389 \gdef\gobblesave @SAVE{}
7392 % initialization:
7393 \def\newsaveins #1{%
7394 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
7395 \next
7397 \def\newsaveinsX #1{%
7398 \csname newbox\endcsname #1%
7399 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7400 \checksaveins #1}%
7403 % initialize:
7404 \let\checkinserts\empty
7405 \newsaveins\footins
7406 \newsaveins\margin
7409 % @image. We use the macros from epsf.tex to support this.
7410 % If epsf.tex is not installed and @image is used, we complain.
7412 % Check for and read epsf.tex up front. If we read it only at @image
7413 % time, we might be inside a group, and then its definitions would get
7414 % undone and the next image would fail.
7415 \openin 1 = epsf.tex
7416 \ifeof 1 \else
7417 % Do not bother showing banner with epsf.tex v2.7k (available in
7418 % doc/epsf.tex and on ctan).
7419 \def\epsfannounce{\toks0 = }%
7420 \input epsf.tex
7422 \closein 1
7424 % We will only complain once about lack of epsf.tex.
7425 \newif\ifwarnednoepsf
7426 \newhelp\noepsfhelp{epsf.tex must be installed for images to
7427 work. It is also included in the Texinfo distribution, or you can get
7428 it from ftp://tug.org/tex/epsf.tex.}
7430 \def\image#1{%
7431 \ifx\epsfbox\undefined
7432 \ifwarnednoepsf \else
7433 \errhelp = \noepsfhelp
7434 \errmessage{epsf.tex not found, images will be ignored}%
7435 \global\warnednoepsftrue
7437 \else
7438 \imagexxx #1,,,,,\finish
7442 % Arguments to @image:
7443 % #1 is (mandatory) image filename; we tack on .eps extension.
7444 % #2 is (optional) width, #3 is (optional) height.
7445 % #4 is (ignored optional) html alt text.
7446 % #5 is (ignored optional) extension.
7447 % #6 is just the usual extra ignored arg for parsing this stuff.
7448 \newif\ifimagevmode
7449 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7450 \catcode`\^^M = 5 % in case we're inside an example
7451 \normalturnoffactive % allow _ et al. in names
7452 % If the image is by itself, center it.
7453 \ifvmode
7454 \imagevmodetrue
7455 \nobreak\medskip
7456 % Usually we'll have text after the image which will insert
7457 % \parskip glue, so insert it here too to equalize the space
7458 % above and below.
7459 \nobreak\vskip\parskip
7460 \nobreak
7463 % Leave vertical mode so that indentation from an enclosing
7464 % environment such as @quotation is respected. On the other hand, if
7465 % it's at the top level, we don't want the normal paragraph indentation.
7466 \noindent
7468 % Output the image.
7469 \ifpdf
7470 \dopdfimage{#1}{#2}{#3}%
7471 \else
7472 % \epsfbox itself resets \epsf?size at each figure.
7473 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
7474 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7475 \epsfbox{#1.eps}%
7478 \ifimagevmode \medskip \fi % space after the standalone image
7479 \endgroup}
7482 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7483 % etc. We don't actually implement floating yet, we always include the
7484 % float "here". But it seemed the best name for the future.
7486 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7488 % There may be a space before second and/or third parameter; delete it.
7489 \def\eatcommaspace#1, {#1,}
7491 % #1 is the optional FLOATTYPE, the text label for this float, typically
7492 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
7493 % this float will not be numbered and cannot be referred to.
7495 % #2 is the optional xref label. Also must be present for the float to
7496 % be referable.
7498 % #3 is the optional positioning argument; for now, it is ignored. It
7499 % will somehow specify the positions allowed to float to (here, top, bottom).
7501 % We keep a separate counter for each FLOATTYPE, which we reset at each
7502 % chapter-level command.
7503 \let\resetallfloatnos=\empty
7505 \def\dofloat#1,#2,#3,#4\finish{%
7506 \let\thiscaption=\empty
7507 \let\thisshortcaption=\empty
7509 % don't lose footnotes inside @float.
7511 % BEWARE: when the floats start float, we have to issue warning whenever an
7512 % insert appears inside a float which could possibly float. --kasal, 26may04
7514 \startsavinginserts
7516 % We can't be used inside a paragraph.
7517 \par
7519 \vtop\bgroup
7520 \def\floattype{#1}%
7521 \def\floatlabel{#2}%
7522 \def\floatloc{#3}% we do nothing with this yet.
7524 \ifx\floattype\empty
7525 \let\safefloattype=\empty
7526 \else
7528 % the floattype might have accents or other special characters,
7529 % but we need to use it in a control sequence name.
7530 \indexnofonts
7531 \turnoffactive
7532 \xdef\safefloattype{\floattype}%
7536 % If label is given but no type, we handle that as the empty type.
7537 \ifx\floatlabel\empty \else
7538 % We want each FLOATTYPE to be numbered separately (Figure 1,
7539 % Table 1, Figure 2, ...). (And if no label, no number.)
7541 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7542 \global\advance\floatno by 1
7545 % This magic value for \lastsection is output by \setref as the
7546 % XREFLABEL-title value. \xrefX uses it to distinguish float
7547 % labels (which have a completely different output format) from
7548 % node and anchor labels. And \xrdef uses it to construct the
7549 % lists of floats.
7551 \edef\lastsection{\floatmagic=\safefloattype}%
7552 \setref{\floatlabel}{Yfloat}%
7556 % start with \parskip glue, I guess.
7557 \vskip\parskip
7559 % Don't suppress indentation if a float happens to start a section.
7560 \restorefirstparagraphindent
7563 % we have these possibilities:
7564 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7565 % @float Foo,lbl & no caption: Foo 1.1
7566 % @float Foo & @caption{Cap}: Foo: Cap
7567 % @float Foo & no caption: Foo
7568 % @float ,lbl & Caption{Cap}: 1.1: Cap
7569 % @float ,lbl & no caption: 1.1
7570 % @float & @caption{Cap}: Cap
7571 % @float & no caption:
7573 \def\Efloat{%
7574 \let\floatident = \empty
7576 % In all cases, if we have a float type, it comes first.
7577 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7579 % If we have an xref label, the number comes next.
7580 \ifx\floatlabel\empty \else
7581 \ifx\floattype\empty \else % if also had float type, need tie first.
7582 \appendtomacro\floatident{\tie}%
7584 % the number.
7585 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
7588 % Start the printed caption with what we've constructed in
7589 % \floatident, but keep it separate; we need \floatident again.
7590 \let\captionline = \floatident
7592 \ifx\thiscaption\empty \else
7593 \ifx\floatident\empty \else
7594 \appendtomacro\captionline{: }% had ident, so need a colon between
7597 % caption text.
7598 \appendtomacro\captionline{\scanexp\thiscaption}%
7601 % If we have anything to print, print it, with space before.
7602 % Eventually this needs to become an \insert.
7603 \ifx\captionline\empty \else
7604 \vskip.5\parskip
7605 \captionline
7607 % Space below caption.
7608 \vskip\parskip
7611 % If have an xref label, write the list of floats info. Do this
7612 % after the caption, to avoid chance of it being a breakpoint.
7613 \ifx\floatlabel\empty \else
7614 % Write the text that goes in the lof to the aux file as
7615 % \floatlabel-lof. Besides \floatident, we include the short
7616 % caption if specified, else the full caption if specified, else nothing.
7618 \atdummies
7620 % since we read the caption text in the macro world, where ^^M
7621 % is turned into a normal character, we have to scan it back, so
7622 % we don't write the literal three characters "^^M" into the aux file.
7623 \scanexp{%
7624 \xdef\noexpand\gtemp{%
7625 \ifx\thisshortcaption\empty
7626 \thiscaption
7627 \else
7628 \thisshortcaption
7632 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7633 \ifx\gtemp\empty \else : \gtemp \fi}}%
7636 \egroup % end of \vtop
7638 % place the captured inserts
7640 % BEWARE: when the floats start floating, we have to issue warning
7641 % whenever an insert appears inside a float which could possibly
7642 % float. --kasal, 26may04
7644 \checkinserts
7647 % Append the tokens #2 to the definition of macro #1, not expanding either.
7649 \def\appendtomacro#1#2{%
7650 \expandafter\def\expandafter#1\expandafter{#1#2}%
7653 % @caption, @shortcaption
7655 \def\caption{\docaption\thiscaption}
7656 \def\shortcaption{\docaption\thisshortcaption}
7657 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7658 \def\defcaption#1#2{\egroup \def#1{#2}}
7660 % The parameter is the control sequence identifying the counter we are
7661 % going to use. Create it if it doesn't exist and assign it to \floatno.
7662 \def\getfloatno#1{%
7663 \ifx#1\relax
7664 % Haven't seen this figure type before.
7665 \csname newcount\endcsname #1%
7667 % Remember to reset this floatno at the next chap.
7668 \expandafter\gdef\expandafter\resetallfloatnos
7669 \expandafter{\resetallfloatnos #1=0 }%
7671 \let\floatno#1%
7674 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
7675 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
7676 % first read the @float command.
7678 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7680 % Magic string used for the XREFLABEL-title value, so \xrefX can
7681 % distinguish floats from other xref types.
7682 \def\floatmagic{!!float!!}
7684 % #1 is the control sequence we are passed; we expand into a conditional
7685 % which is true if #1 represents a float ref. That is, the magic
7686 % \lastsection value which we \setref above.
7688 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7690 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
7691 % (safe) float type for this float. We set \iffloattype to #2.
7693 \def\doiffloat#1=#2=#3\finish{%
7694 \def\temp{#1}%
7695 \def\iffloattype{#2}%
7696 \ifx\temp\floatmagic
7699 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7701 \parseargdef\listoffloats{%
7702 \def\floattype{#1}% floattype
7704 % the floattype might have accents or other special characters,
7705 % but we need to use it in a control sequence name.
7706 \indexnofonts
7707 \turnoffactive
7708 \xdef\safefloattype{\floattype}%
7711 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7712 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7713 \ifhavexrefs
7714 % if the user said @listoffloats foo but never @float foo.
7715 \message{\linenumber No `\safefloattype' floats to list.}%
7717 \else
7718 \begingroup
7719 \leftskip=\tocindent % indent these entries like a toc
7720 \let\do=\listoffloatsdo
7721 \csname floatlist\safefloattype\endcsname
7722 \endgroup
7726 % This is called on each entry in a list of floats. We're passed the
7727 % xref label, in the form LABEL-title, which is how we save it in the
7728 % aux file. We strip off the -title and look up \XRLABEL-lof, which
7729 % has the text we're supposed to typeset here.
7731 % Figures without xref labels will not be included in the list (since
7732 % they won't appear in the aux file).
7734 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7735 \def\listoffloatsdoentry#1-title\finish{{%
7736 % Can't fully expand XR#1-lof because it can contain anything. Just
7737 % pass the control sequence. On the other hand, XR#1-pg is just the
7738 % page number, and we want to fully expand that so we can get a link
7739 % in pdf output.
7740 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
7742 % use the same \entry macro we use to generate the TOC and index.
7743 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7744 \writeentry
7748 \message{localization,}
7750 % @documentlanguage is usually given very early, just after
7751 % @setfilename. If done too late, it may not override everything
7752 % properly. Single argument is the language (de) or locale (de_DE)
7753 % abbreviation. It would be nice if we could set up a hyphenation file.
7756 \catcode`\_ = \active
7757 \globaldefs=1
7758 \parseargdef\documentlanguage{\begingroup
7759 \let_=\normalunderscore % normal _ character for filenames
7760 \tex % read txi-??.tex file in plain TeX.
7761 % Read the file by the name they passed if it exists.
7762 \openin 1 txi-#1.tex
7763 \ifeof 1
7764 \documentlanguagetrywithoutunderscore{#1_\finish}%
7765 \else
7766 \input txi-#1.tex
7768 \closein 1
7769 \endgroup
7770 \endgroup}
7773 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
7774 % try txi-de.tex.
7776 \def\documentlanguagetrywithoutunderscore#1_#2\finish{%
7777 \openin 1 txi-#1.tex
7778 \ifeof 1
7779 \errhelp = \nolanghelp
7780 \errmessage{Cannot read language file txi-#1.tex}%
7781 \else
7782 \input txi-#1.tex
7784 \closein 1
7787 \newhelp\nolanghelp{The given language definition file cannot be found or
7788 is empty. Maybe you need to install it? In the current directory
7789 should work if nowhere else does.}
7791 % Set the catcode of characters 128 through 255 to the specified number.
7793 \def\setnonasciicharscatcode#1{%
7794 \count255=128
7795 \loop\ifnum\count255<256
7796 \global\catcode\count255=#1\relax
7797 \advance\count255 by 1
7798 \repeat
7801 \def\setnonasciicharscatcodenonglobal#1{%
7802 \count255=128
7803 \loop\ifnum\count255<256
7804 \catcode\count255=#1\relax
7805 \advance\count255 by 1
7806 \repeat
7809 % @documentencoding sets the definition of non-ASCII characters
7810 % according to the specified encoding.
7812 \parseargdef\documentencoding{%
7813 % Encoding being declared for the document.
7814 \def\declaredencoding{\csname #1.enc\endcsname}%
7816 % Supported encodings: names converted to tokens in order to be able
7817 % to compare them with \ifx.
7818 \def\ascii{\csname US-ASCII.enc\endcsname}%
7819 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
7820 \def\latone{\csname ISO-8859-1.enc\endcsname}%
7821 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
7822 \def\utfeight{\csname UTF-8.enc\endcsname}%
7824 \ifx \declaredencoding \ascii
7825 \asciichardefs
7827 \else \ifx \declaredencoding \lattwo
7828 \setnonasciicharscatcode\active
7829 \lattwochardefs
7831 \else \ifx \declaredencoding \latone
7832 \setnonasciicharscatcode\active
7833 \latonechardefs
7835 \else \ifx \declaredencoding \latnine
7836 \setnonasciicharscatcode\active
7837 \latninechardefs
7839 \else \ifx \declaredencoding \utfeight
7840 \setnonasciicharscatcode\active
7841 \utfeightchardefs
7843 \else
7844 \message{Unknown document encoding #1, ignoring.}%
7846 \fi % utfeight
7847 \fi % latnine
7848 \fi % latone
7849 \fi % lattwo
7850 \fi % ascii
7853 % A message to be logged when using a character that isn't available
7854 % the default font encoding (OT1).
7856 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
7858 % Take account of \c (plain) vs. \, (Texinfo) difference.
7859 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
7861 % First, make active non-ASCII characters in order for them to be
7862 % correctly categorized when TeX reads the replacement text of
7863 % macros containing the character definitions.
7864 \setnonasciicharscatcode\active
7866 % Latin1 (ISO-8859-1) character definitions.
7867 \def\latonechardefs{%
7868 \gdef^^a0{~}
7869 \gdef^^a1{\exclamdown}
7870 \gdef^^a2{\missingcharmsg{CENT SIGN}}
7871 \gdef^^a3{{\pounds}}
7872 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7873 \gdef^^a5{\missingcharmsg{YEN SIGN}}
7874 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
7875 \gdef^^a7{\S}
7876 \gdef^^a8{\"{}}
7877 \gdef^^a9{\copyright}
7878 \gdef^^aa{\ordf}
7879 \gdef^^ab{\missingcharmsg{LEFT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7880 \gdef^^ac{$\lnot$}
7881 \gdef^^ad{\-}
7882 \gdef^^ae{\registeredsymbol}
7883 \gdef^^af{\={}}
7885 \gdef^^b0{\textdegree}
7886 \gdef^^b1{$\pm$}
7887 \gdef^^b2{$^2$}
7888 \gdef^^b3{$^3$}
7889 \gdef^^b4{\'{}}
7890 \gdef^^b5{$\mu$}
7891 \gdef^^b6{\P}
7893 \gdef^^b7{$^.$}
7894 \gdef^^b8{\cedilla\ }
7895 \gdef^^b9{$^1$}
7896 \gdef^^ba{\ordm}
7898 \gdef^^bb{\missingcharmsg{RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7899 \gdef^^bc{$1\over4$}
7900 \gdef^^bd{$1\over2$}
7901 \gdef^^be{$3\over4$}
7902 \gdef^^bf{\questiondown}
7904 \gdef^^c0{\`A}
7905 \gdef^^c1{\'A}
7906 \gdef^^c2{\^A}
7907 \gdef^^c3{\~A}
7908 \gdef^^c4{\"A}
7909 \gdef^^c5{\ringaccent A}
7910 \gdef^^c6{\AE}
7911 \gdef^^c7{\cedilla C}
7912 \gdef^^c8{\`E}
7913 \gdef^^c9{\'E}
7914 \gdef^^ca{\^E}
7915 \gdef^^cb{\"E}
7916 \gdef^^cc{\`I}
7917 \gdef^^cd{\'I}
7918 \gdef^^ce{\^I}
7919 \gdef^^cf{\"I}
7921 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER ETH}}
7922 \gdef^^d1{\~N}
7923 \gdef^^d2{\`O}
7924 \gdef^^d3{\'O}
7925 \gdef^^d4{\^O}
7926 \gdef^^d5{\~O}
7927 \gdef^^d6{\"O}
7928 \gdef^^d7{$\times$}
7929 \gdef^^d8{\O}
7930 \gdef^^d9{\`U}
7931 \gdef^^da{\'U}
7932 \gdef^^db{\^U}
7933 \gdef^^dc{\"U}
7934 \gdef^^dd{\'Y}
7935 \gdef^^de{\missingcharmsg{LATIN CAPITAL LETTER THORN}}
7936 \gdef^^df{\ss}
7938 \gdef^^e0{\`a}
7939 \gdef^^e1{\'a}
7940 \gdef^^e2{\^a}
7941 \gdef^^e3{\~a}
7942 \gdef^^e4{\"a}
7943 \gdef^^e5{\ringaccent a}
7944 \gdef^^e6{\ae}
7945 \gdef^^e7{\cedilla c}
7946 \gdef^^e8{\`e}
7947 \gdef^^e9{\'e}
7948 \gdef^^ea{\^e}
7949 \gdef^^eb{\"e}
7950 \gdef^^ec{\`{\dotless i}}
7951 \gdef^^ed{\'{\dotless i}}
7952 \gdef^^ee{\^{\dotless i}}
7953 \gdef^^ef{\"{\dotless i}}
7955 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER ETH}}
7956 \gdef^^f1{\~n}
7957 \gdef^^f2{\`o}
7958 \gdef^^f3{\'o}
7959 \gdef^^f4{\^o}
7960 \gdef^^f5{\~o}
7961 \gdef^^f6{\"o}
7962 \gdef^^f7{$\div$}
7963 \gdef^^f8{\o}
7964 \gdef^^f9{\`u}
7965 \gdef^^fa{\'u}
7966 \gdef^^fb{\^u}
7967 \gdef^^fc{\"u}
7968 \gdef^^fd{\'y}
7969 \gdef^^fe{\missingcharmsg{LATIN SMALL LETTER THORN}}
7970 \gdef^^ff{\"y}
7973 % Latin9 (ISO-8859-15) encoding character definitions.
7974 \def\latninechardefs{%
7975 % Encoding is almost identical to Latin1.
7976 \latonechardefs
7978 \gdef^^a4{\euro}
7979 \gdef^^a6{\v S}
7980 \gdef^^a8{\v s}
7981 \gdef^^b4{\v Z}
7982 \gdef^^b8{\v z}
7983 \gdef^^bc{\OE}
7984 \gdef^^bd{\oe}
7985 \gdef^^be{\"Y}
7988 % Latin2 (ISO-8859-2) character definitions.
7989 \def\lattwochardefs{%
7990 \gdef^^a0{~}
7991 \gdef^^a1{\missingcharmsg{LATIN CAPITAL LETTER A WITH OGONEK}}
7992 \gdef^^a2{\u{}}
7993 \gdef^^a3{\L}
7994 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7995 \gdef^^a5{\v L}
7996 \gdef^^a6{\'S}
7997 \gdef^^a7{\S}
7998 \gdef^^a8{\"{}}
7999 \gdef^^a9{\v S}
8000 \gdef^^aa{\cedilla S}
8001 \gdef^^ab{\v T}
8002 \gdef^^ac{\'Z}
8003 \gdef^^ad{\-}
8004 \gdef^^ae{\v Z}
8005 \gdef^^af{\dotaccent Z}
8007 \gdef^^b0{\textdegree}
8008 \gdef^^b1{\missingcharmsg{LATIN SMALL LETTER A WITH OGONEK}}
8009 \gdef^^b2{\missingcharmsg{OGONEK}}
8010 \gdef^^b3{\l}
8011 \gdef^^b4{\'{}}
8012 \gdef^^b5{\v l}
8013 \gdef^^b6{\'s}
8014 \gdef^^b7{\v{}}
8015 \gdef^^b8{\cedilla\ }
8016 \gdef^^b9{\v s}
8017 \gdef^^ba{\cedilla s}
8018 \gdef^^bb{\v t}
8019 \gdef^^bc{\'z}
8020 \gdef^^bd{\H{}}
8021 \gdef^^be{\v z}
8022 \gdef^^bf{\dotaccent z}
8024 \gdef^^c0{\'R}
8025 \gdef^^c1{\'A}
8026 \gdef^^c2{\^A}
8027 \gdef^^c3{\u A}
8028 \gdef^^c4{\"A}
8029 \gdef^^c5{\'L}
8030 \gdef^^c6{\'C}
8031 \gdef^^c7{\cedilla C}
8032 \gdef^^c8{\v C}
8033 \gdef^^c9{\'E}
8034 \gdef^^ca{\missingcharmsg{LATIN CAPITAL LETTER E WITH OGONEK}}
8035 \gdef^^cb{\"E}
8036 \gdef^^cc{\v E}
8037 \gdef^^cd{\'I}
8038 \gdef^^ce{\^I}
8039 \gdef^^cf{\v D}
8041 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER D WITH STROKE}}
8042 \gdef^^d1{\'N}
8043 \gdef^^d2{\v N}
8044 \gdef^^d3{\'O}
8045 \gdef^^d4{\^O}
8046 \gdef^^d5{\H O}
8047 \gdef^^d6{\"O}
8048 \gdef^^d7{$\times$}
8049 \gdef^^d8{\v R}
8050 \gdef^^d9{\ringaccent U}
8051 \gdef^^da{\'U}
8052 \gdef^^db{\H U}
8053 \gdef^^dc{\"U}
8054 \gdef^^dd{\'Y}
8055 \gdef^^de{\cedilla T}
8056 \gdef^^df{\ss}
8058 \gdef^^e0{\'r}
8059 \gdef^^e1{\'a}
8060 \gdef^^e2{\^a}
8061 \gdef^^e3{\u a}
8062 \gdef^^e4{\"a}
8063 \gdef^^e5{\'l}
8064 \gdef^^e6{\'c}
8065 \gdef^^e7{\cedilla c}
8066 \gdef^^e8{\v c}
8067 \gdef^^e9{\'e}
8068 \gdef^^ea{\missingcharmsg{LATIN SMALL LETTER E WITH OGONEK}}
8069 \gdef^^eb{\"e}
8070 \gdef^^ec{\v e}
8071 \gdef^^ed{\'\i}
8072 \gdef^^ee{\^\i}
8073 \gdef^^ef{\v d}
8075 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER D WITH STROKE}}
8076 \gdef^^f1{\'n}
8077 \gdef^^f2{\v n}
8078 \gdef^^f3{\'o}
8079 \gdef^^f4{\^o}
8080 \gdef^^f5{\H o}
8081 \gdef^^f6{\"o}
8082 \gdef^^f7{$\div$}
8083 \gdef^^f8{\v r}
8084 \gdef^^f9{\ringaccent u}
8085 \gdef^^fa{\'u}
8086 \gdef^^fb{\H u}
8087 \gdef^^fc{\"u}
8088 \gdef^^fd{\'y}
8089 \gdef^^fe{\cedilla t}
8090 \gdef^^ff{\dotaccent{}}
8093 % UTF-8 character definitions.
8095 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8096 % changes for Texinfo conventions. It is included here under the GPL by
8097 % permission from Frank Mittelbach and the LaTeX team.
8099 \newcount\countUTFx
8100 \newcount\countUTFy
8101 \newcount\countUTFz
8103 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8104 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8106 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8107 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8109 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8110 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8112 \gdef\UTFviiiDefined#1{%
8113 \ifx #1\relax
8114 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8115 \else
8116 \expandafter #1%
8120 \begingroup
8121 \catcode`\~13
8122 \catcode`\"12
8124 \def\UTFviiiLoop{%
8125 \global\catcode\countUTFx\active
8126 \uccode`\~\countUTFx
8127 \uppercase\expandafter{\UTFviiiTmp}%
8128 \advance\countUTFx by 1
8129 \ifnum\countUTFx < \countUTFy
8130 \expandafter\UTFviiiLoop
8131 \fi}
8133 \countUTFx = "C2
8134 \countUTFy = "E0
8135 \def\UTFviiiTmp{%
8136 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
8137 \UTFviiiLoop
8139 \countUTFx = "E0
8140 \countUTFy = "F0
8141 \def\UTFviiiTmp{%
8142 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
8143 \UTFviiiLoop
8145 \countUTFx = "F0
8146 \countUTFy = "F4
8147 \def\UTFviiiTmp{%
8148 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
8149 \UTFviiiLoop
8150 \endgroup
8152 \begingroup
8153 \catcode`\"=12
8154 \catcode`\<=12
8155 \catcode`\.=12
8156 \catcode`\,=12
8157 \catcode`\;=12
8158 \catcode`\!=12
8159 \catcode`\~=13
8161 \gdef\DeclareUnicodeCharacter#1#2{%
8162 \countUTFz = "#1\relax
8163 \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
8164 \begingroup
8165 \parseXMLCharref
8166 \def\UTFviiiTwoOctets##1##2{%
8167 \csname u8:##1\string ##2\endcsname}%
8168 \def\UTFviiiThreeOctets##1##2##3{%
8169 \csname u8:##1\string ##2\string ##3\endcsname}%
8170 \def\UTFviiiFourOctets##1##2##3##4{%
8171 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
8172 \expandafter\expandafter\expandafter\expandafter
8173 \expandafter\expandafter\expandafter
8174 \gdef\UTFviiiTmp{#2}%
8175 \endgroup}
8177 \gdef\parseXMLCharref{%
8178 \ifnum\countUTFz < "A0\relax
8179 \errhelp = \EMsimple
8180 \errmessage{Cannot define Unicode char value < 00A0}%
8181 \else\ifnum\countUTFz < "800\relax
8182 \parseUTFviiiA,%
8183 \parseUTFviiiB C\UTFviiiTwoOctets.,%
8184 \else\ifnum\countUTFz < "10000\relax
8185 \parseUTFviiiA;%
8186 \parseUTFviiiA,%
8187 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
8188 \else
8189 \parseUTFviiiA;%
8190 \parseUTFviiiA,%
8191 \parseUTFviiiA!%
8192 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
8193 \fi\fi\fi
8196 \gdef\parseUTFviiiA#1{%
8197 \countUTFx = \countUTFz
8198 \divide\countUTFz by 64
8199 \countUTFy = \countUTFz
8200 \multiply\countUTFz by 64
8201 \advance\countUTFx by -\countUTFz
8202 \advance\countUTFx by 128
8203 \uccode `#1\countUTFx
8204 \countUTFz = \countUTFy}
8206 \gdef\parseUTFviiiB#1#2#3#4{%
8207 \advance\countUTFz by "#10\relax
8208 \uccode `#3\countUTFz
8209 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
8210 \endgroup
8212 \def\utfeightchardefs{%
8213 \DeclareUnicodeCharacter{00A0}{\tie}
8214 \DeclareUnicodeCharacter{00A1}{\exclamdown}
8215 \DeclareUnicodeCharacter{00A3}{\pounds}
8216 \DeclareUnicodeCharacter{00A8}{\"{ }}
8217 \DeclareUnicodeCharacter{00A9}{\copyright}
8218 \DeclareUnicodeCharacter{00AA}{\ordf}
8219 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
8220 \DeclareUnicodeCharacter{00AD}{\-}
8221 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
8222 \DeclareUnicodeCharacter{00AF}{\={ }}
8224 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
8225 \DeclareUnicodeCharacter{00B4}{\'{ }}
8226 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
8227 \DeclareUnicodeCharacter{00BA}{\ordm}
8228 \DeclareUnicodeCharacter{00BB}{\guillemetright}
8229 \DeclareUnicodeCharacter{00BF}{\questiondown}
8231 \DeclareUnicodeCharacter{00C0}{\`A}
8232 \DeclareUnicodeCharacter{00C1}{\'A}
8233 \DeclareUnicodeCharacter{00C2}{\^A}
8234 \DeclareUnicodeCharacter{00C3}{\~A}
8235 \DeclareUnicodeCharacter{00C4}{\"A}
8236 \DeclareUnicodeCharacter{00C5}{\AA}
8237 \DeclareUnicodeCharacter{00C6}{\AE}
8238 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
8239 \DeclareUnicodeCharacter{00C8}{\`E}
8240 \DeclareUnicodeCharacter{00C9}{\'E}
8241 \DeclareUnicodeCharacter{00CA}{\^E}
8242 \DeclareUnicodeCharacter{00CB}{\"E}
8243 \DeclareUnicodeCharacter{00CC}{\`I}
8244 \DeclareUnicodeCharacter{00CD}{\'I}
8245 \DeclareUnicodeCharacter{00CE}{\^I}
8246 \DeclareUnicodeCharacter{00CF}{\"I}
8248 \DeclareUnicodeCharacter{00D1}{\~N}
8249 \DeclareUnicodeCharacter{00D2}{\`O}
8250 \DeclareUnicodeCharacter{00D3}{\'O}
8251 \DeclareUnicodeCharacter{00D4}{\^O}
8252 \DeclareUnicodeCharacter{00D5}{\~O}
8253 \DeclareUnicodeCharacter{00D6}{\"O}
8254 \DeclareUnicodeCharacter{00D8}{\O}
8255 \DeclareUnicodeCharacter{00D9}{\`U}
8256 \DeclareUnicodeCharacter{00DA}{\'U}
8257 \DeclareUnicodeCharacter{00DB}{\^U}
8258 \DeclareUnicodeCharacter{00DC}{\"U}
8259 \DeclareUnicodeCharacter{00DD}{\'Y}
8260 \DeclareUnicodeCharacter{00DF}{\ss}
8262 \DeclareUnicodeCharacter{00E0}{\`a}
8263 \DeclareUnicodeCharacter{00E1}{\'a}
8264 \DeclareUnicodeCharacter{00E2}{\^a}
8265 \DeclareUnicodeCharacter{00E3}{\~a}
8266 \DeclareUnicodeCharacter{00E4}{\"a}
8267 \DeclareUnicodeCharacter{00E5}{\aa}
8268 \DeclareUnicodeCharacter{00E6}{\ae}
8269 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
8270 \DeclareUnicodeCharacter{00E8}{\`e}
8271 \DeclareUnicodeCharacter{00E9}{\'e}
8272 \DeclareUnicodeCharacter{00EA}{\^e}
8273 \DeclareUnicodeCharacter{00EB}{\"e}
8274 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
8275 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
8276 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
8277 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
8279 \DeclareUnicodeCharacter{00F1}{\~n}
8280 \DeclareUnicodeCharacter{00F2}{\`o}
8281 \DeclareUnicodeCharacter{00F3}{\'o}
8282 \DeclareUnicodeCharacter{00F4}{\^o}
8283 \DeclareUnicodeCharacter{00F5}{\~o}
8284 \DeclareUnicodeCharacter{00F6}{\"o}
8285 \DeclareUnicodeCharacter{00F8}{\o}
8286 \DeclareUnicodeCharacter{00F9}{\`u}
8287 \DeclareUnicodeCharacter{00FA}{\'u}
8288 \DeclareUnicodeCharacter{00FB}{\^u}
8289 \DeclareUnicodeCharacter{00FC}{\"u}
8290 \DeclareUnicodeCharacter{00FD}{\'y}
8291 \DeclareUnicodeCharacter{00FF}{\"y}
8293 \DeclareUnicodeCharacter{0100}{\=A}
8294 \DeclareUnicodeCharacter{0101}{\=a}
8295 \DeclareUnicodeCharacter{0102}{\u{A}}
8296 \DeclareUnicodeCharacter{0103}{\u{a}}
8297 \DeclareUnicodeCharacter{0106}{\'C}
8298 \DeclareUnicodeCharacter{0107}{\'c}
8299 \DeclareUnicodeCharacter{0108}{\^C}
8300 \DeclareUnicodeCharacter{0109}{\^c}
8301 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
8302 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
8303 \DeclareUnicodeCharacter{010C}{\v{C}}
8304 \DeclareUnicodeCharacter{010D}{\v{c}}
8305 \DeclareUnicodeCharacter{010E}{\v{D}}
8307 \DeclareUnicodeCharacter{0112}{\=E}
8308 \DeclareUnicodeCharacter{0113}{\=e}
8309 \DeclareUnicodeCharacter{0114}{\u{E}}
8310 \DeclareUnicodeCharacter{0115}{\u{e}}
8311 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
8312 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
8313 \DeclareUnicodeCharacter{011A}{\v{E}}
8314 \DeclareUnicodeCharacter{011B}{\v{e}}
8315 \DeclareUnicodeCharacter{011C}{\^G}
8316 \DeclareUnicodeCharacter{011D}{\^g}
8317 \DeclareUnicodeCharacter{011E}{\u{G}}
8318 \DeclareUnicodeCharacter{011F}{\u{g}}
8320 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8321 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8322 \DeclareUnicodeCharacter{0124}{\^H}
8323 \DeclareUnicodeCharacter{0125}{\^h}
8324 \DeclareUnicodeCharacter{0128}{\~I}
8325 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8326 \DeclareUnicodeCharacter{012A}{\=I}
8327 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8328 \DeclareUnicodeCharacter{012C}{\u{I}}
8329 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8331 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8332 \DeclareUnicodeCharacter{0131}{\dotless{i}}
8333 \DeclareUnicodeCharacter{0132}{IJ}
8334 \DeclareUnicodeCharacter{0133}{ij}
8335 \DeclareUnicodeCharacter{0134}{\^J}
8336 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8337 \DeclareUnicodeCharacter{0139}{\'L}
8338 \DeclareUnicodeCharacter{013A}{\'l}
8340 \DeclareUnicodeCharacter{0141}{\L}
8341 \DeclareUnicodeCharacter{0142}{\l}
8342 \DeclareUnicodeCharacter{0143}{\'N}
8343 \DeclareUnicodeCharacter{0144}{\'n}
8344 \DeclareUnicodeCharacter{0147}{\v{N}}
8345 \DeclareUnicodeCharacter{0148}{\v{n}}
8346 \DeclareUnicodeCharacter{014C}{\=O}
8347 \DeclareUnicodeCharacter{014D}{\=o}
8348 \DeclareUnicodeCharacter{014E}{\u{O}}
8349 \DeclareUnicodeCharacter{014F}{\u{o}}
8351 \DeclareUnicodeCharacter{0150}{\H{O}}
8352 \DeclareUnicodeCharacter{0151}{\H{o}}
8353 \DeclareUnicodeCharacter{0152}{\OE}
8354 \DeclareUnicodeCharacter{0153}{\oe}
8355 \DeclareUnicodeCharacter{0154}{\'R}
8356 \DeclareUnicodeCharacter{0155}{\'r}
8357 \DeclareUnicodeCharacter{0158}{\v{R}}
8358 \DeclareUnicodeCharacter{0159}{\v{r}}
8359 \DeclareUnicodeCharacter{015A}{\'S}
8360 \DeclareUnicodeCharacter{015B}{\'s}
8361 \DeclareUnicodeCharacter{015C}{\^S}
8362 \DeclareUnicodeCharacter{015D}{\^s}
8363 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8364 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8366 \DeclareUnicodeCharacter{0160}{\v{S}}
8367 \DeclareUnicodeCharacter{0161}{\v{s}}
8368 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8369 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8370 \DeclareUnicodeCharacter{0164}{\v{T}}
8372 \DeclareUnicodeCharacter{0168}{\~U}
8373 \DeclareUnicodeCharacter{0169}{\~u}
8374 \DeclareUnicodeCharacter{016A}{\=U}
8375 \DeclareUnicodeCharacter{016B}{\=u}
8376 \DeclareUnicodeCharacter{016C}{\u{U}}
8377 \DeclareUnicodeCharacter{016D}{\u{u}}
8378 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8379 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8381 \DeclareUnicodeCharacter{0170}{\H{U}}
8382 \DeclareUnicodeCharacter{0171}{\H{u}}
8383 \DeclareUnicodeCharacter{0174}{\^W}
8384 \DeclareUnicodeCharacter{0175}{\^w}
8385 \DeclareUnicodeCharacter{0176}{\^Y}
8386 \DeclareUnicodeCharacter{0177}{\^y}
8387 \DeclareUnicodeCharacter{0178}{\"Y}
8388 \DeclareUnicodeCharacter{0179}{\'Z}
8389 \DeclareUnicodeCharacter{017A}{\'z}
8390 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8391 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8392 \DeclareUnicodeCharacter{017D}{\v{Z}}
8393 \DeclareUnicodeCharacter{017E}{\v{z}}
8395 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8396 \DeclareUnicodeCharacter{01C5}{D\v{z}}
8397 \DeclareUnicodeCharacter{01C6}{d\v{z}}
8398 \DeclareUnicodeCharacter{01C7}{LJ}
8399 \DeclareUnicodeCharacter{01C8}{Lj}
8400 \DeclareUnicodeCharacter{01C9}{lj}
8401 \DeclareUnicodeCharacter{01CA}{NJ}
8402 \DeclareUnicodeCharacter{01CB}{Nj}
8403 \DeclareUnicodeCharacter{01CC}{nj}
8404 \DeclareUnicodeCharacter{01CD}{\v{A}}
8405 \DeclareUnicodeCharacter{01CE}{\v{a}}
8406 \DeclareUnicodeCharacter{01CF}{\v{I}}
8408 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8409 \DeclareUnicodeCharacter{01D1}{\v{O}}
8410 \DeclareUnicodeCharacter{01D2}{\v{o}}
8411 \DeclareUnicodeCharacter{01D3}{\v{U}}
8412 \DeclareUnicodeCharacter{01D4}{\v{u}}
8414 \DeclareUnicodeCharacter{01E2}{\={\AE}}
8415 \DeclareUnicodeCharacter{01E3}{\={\ae}}
8416 \DeclareUnicodeCharacter{01E6}{\v{G}}
8417 \DeclareUnicodeCharacter{01E7}{\v{g}}
8418 \DeclareUnicodeCharacter{01E8}{\v{K}}
8419 \DeclareUnicodeCharacter{01E9}{\v{k}}
8421 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8422 \DeclareUnicodeCharacter{01F1}{DZ}
8423 \DeclareUnicodeCharacter{01F2}{Dz}
8424 \DeclareUnicodeCharacter{01F3}{dz}
8425 \DeclareUnicodeCharacter{01F4}{\'G}
8426 \DeclareUnicodeCharacter{01F5}{\'g}
8427 \DeclareUnicodeCharacter{01F8}{\`N}
8428 \DeclareUnicodeCharacter{01F9}{\`n}
8429 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8430 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8431 \DeclareUnicodeCharacter{01FE}{\'{\O}}
8432 \DeclareUnicodeCharacter{01FF}{\'{\o}}
8434 \DeclareUnicodeCharacter{021E}{\v{H}}
8435 \DeclareUnicodeCharacter{021F}{\v{h}}
8437 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8438 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8439 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8440 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8441 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8442 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8444 \DeclareUnicodeCharacter{0232}{\=Y}
8445 \DeclareUnicodeCharacter{0233}{\=y}
8446 \DeclareUnicodeCharacter{0237}{\dotless{j}}
8448 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8449 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8450 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8451 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8452 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8453 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8454 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8455 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8456 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8457 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8458 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8459 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8461 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8462 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8464 \DeclareUnicodeCharacter{1E20}{\=G}
8465 \DeclareUnicodeCharacter{1E21}{\=g}
8466 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8467 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8468 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8469 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8470 \DeclareUnicodeCharacter{1E26}{\"H}
8471 \DeclareUnicodeCharacter{1E27}{\"h}
8473 \DeclareUnicodeCharacter{1E30}{\'K}
8474 \DeclareUnicodeCharacter{1E31}{\'k}
8475 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8476 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8477 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8478 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8479 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8480 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8481 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8482 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8483 \DeclareUnicodeCharacter{1E3E}{\'M}
8484 \DeclareUnicodeCharacter{1E3F}{\'m}
8486 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8487 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8488 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8489 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8490 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8491 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8492 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8493 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8494 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8495 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8497 \DeclareUnicodeCharacter{1E54}{\'P}
8498 \DeclareUnicodeCharacter{1E55}{\'p}
8499 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8500 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8501 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8502 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8503 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8504 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8505 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8506 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8508 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8509 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8510 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8511 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8512 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8513 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8514 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8515 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8516 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8517 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8519 \DeclareUnicodeCharacter{1E7C}{\~V}
8520 \DeclareUnicodeCharacter{1E7D}{\~v}
8521 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8522 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8524 \DeclareUnicodeCharacter{1E80}{\`W}
8525 \DeclareUnicodeCharacter{1E81}{\`w}
8526 \DeclareUnicodeCharacter{1E82}{\'W}
8527 \DeclareUnicodeCharacter{1E83}{\'w}
8528 \DeclareUnicodeCharacter{1E84}{\"W}
8529 \DeclareUnicodeCharacter{1E85}{\"w}
8530 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8531 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8532 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8533 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8534 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8535 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8536 \DeclareUnicodeCharacter{1E8C}{\"X}
8537 \DeclareUnicodeCharacter{1E8D}{\"x}
8538 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8539 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8541 \DeclareUnicodeCharacter{1E90}{\^Z}
8542 \DeclareUnicodeCharacter{1E91}{\^z}
8543 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8544 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8545 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
8546 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
8547 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
8548 \DeclareUnicodeCharacter{1E97}{\"t}
8549 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
8550 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
8552 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
8553 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
8555 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
8556 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
8557 \DeclareUnicodeCharacter{1EBC}{\~E}
8558 \DeclareUnicodeCharacter{1EBD}{\~e}
8560 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
8561 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
8562 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
8563 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
8565 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
8566 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
8568 \DeclareUnicodeCharacter{1EF2}{\`Y}
8569 \DeclareUnicodeCharacter{1EF3}{\`y}
8570 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
8572 \DeclareUnicodeCharacter{1EF8}{\~Y}
8573 \DeclareUnicodeCharacter{1EF9}{\~y}
8575 \DeclareUnicodeCharacter{2013}{--}
8576 \DeclareUnicodeCharacter{2014}{---}
8577 \DeclareUnicodeCharacter{2018}{\quoteleft}
8578 \DeclareUnicodeCharacter{2019}{\quoteright}
8579 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
8580 \DeclareUnicodeCharacter{201C}{\quotedblleft}
8581 \DeclareUnicodeCharacter{201D}{\quotedblright}
8582 \DeclareUnicodeCharacter{201E}{\quotedblbase}
8583 \DeclareUnicodeCharacter{2022}{\bullet}
8584 \DeclareUnicodeCharacter{2026}{\dots}
8585 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
8586 \DeclareUnicodeCharacter{203A}{\guilsinglright}
8587 \DeclareUnicodeCharacter{20AC}{\euro}
8589 \DeclareUnicodeCharacter{2192}{\expansion}
8590 \DeclareUnicodeCharacter{21D2}{\result}
8592 \DeclareUnicodeCharacter{2212}{\minus}
8593 \DeclareUnicodeCharacter{2217}{\point}
8594 \DeclareUnicodeCharacter{2261}{\equiv}
8595 }% end of \utfeightchardefs
8598 % US-ASCII character definitions.
8599 \def\asciichardefs{% nothing need be done
8600 \relax
8603 % Make non-ASCII characters printable again for compatibility with
8604 % existing Texinfo documents that may use them, even without declaring a
8605 % document encoding.
8607 \setnonasciicharscatcode \other
8610 \message{formatting,}
8612 \newdimen\defaultparindent \defaultparindent = 15pt
8614 \chapheadingskip = 15pt plus 4pt minus 2pt
8615 \secheadingskip = 12pt plus 3pt minus 2pt
8616 \subsecheadingskip = 9pt plus 2pt minus 2pt
8618 % Prevent underfull vbox error messages.
8619 \vbadness = 10000
8621 % Don't be so finicky about underfull hboxes, either.
8622 \hbadness = 2000
8624 % Following George Bush, get rid of widows and orphans.
8625 \widowpenalty=10000
8626 \clubpenalty=10000
8628 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
8629 % using an old version of TeX, don't do anything. We want the amount of
8630 % stretch added to depend on the line length, hence the dependence on
8631 % \hsize. We call this whenever the paper size is set.
8633 \def\setemergencystretch{%
8634 \ifx\emergencystretch\thisisundefined
8635 % Allow us to assign to \emergencystretch anyway.
8636 \def\emergencystretch{\dimen0}%
8637 \else
8638 \emergencystretch = .15\hsize
8642 % Parameters in order: 1) textheight; 2) textwidth;
8643 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
8644 % 7) physical page height; 8) physical page width.
8646 % We also call \setleading{\textleading}, so the caller should define
8647 % \textleading. The caller should also set \parskip.
8649 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
8650 \voffset = #3\relax
8651 \topskip = #6\relax
8652 \splittopskip = \topskip
8654 \vsize = #1\relax
8655 \advance\vsize by \topskip
8656 \outervsize = \vsize
8657 \advance\outervsize by 2\topandbottommargin
8658 \pageheight = \vsize
8660 \hsize = #2\relax
8661 \outerhsize = \hsize
8662 \advance\outerhsize by 0.5in
8663 \pagewidth = \hsize
8665 \normaloffset = #4\relax
8666 \bindingoffset = #5\relax
8668 \ifpdf
8669 \pdfpageheight #7\relax
8670 \pdfpagewidth #8\relax
8671 % if we don't reset these, they will remain at "1 true in" of
8672 % whatever layout pdftex was dumped with.
8673 \pdfhorigin = 1 true in
8674 \pdfvorigin = 1 true in
8677 \setleading{\textleading}
8679 \parindent = \defaultparindent
8680 \setemergencystretch
8683 % @letterpaper (the default).
8684 \def\letterpaper{{\globaldefs = 1
8685 \parskip = 3pt plus 2pt minus 1pt
8686 \textleading = 13.2pt
8688 % If page is nothing but text, make it come out even.
8689 \internalpagesizes{607.2pt}{6in}% that's 46 lines
8690 {\voffset}{.25in}%
8691 {\bindingoffset}{36pt}%
8692 {11in}{8.5in}%
8695 % Use @smallbook to reset parameters for 7x9.25 trim size.
8696 \def\smallbook{{\globaldefs = 1
8697 \parskip = 2pt plus 1pt
8698 \textleading = 12pt
8700 \internalpagesizes{7.5in}{5in}%
8701 {-.2in}{0in}%
8702 {\bindingoffset}{16pt}%
8703 {9.25in}{7in}%
8705 \lispnarrowing = 0.3in
8706 \tolerance = 700
8707 \hfuzz = 1pt
8708 \contentsrightmargin = 0pt
8709 \defbodyindent = .5cm
8712 % Use @smallerbook to reset parameters for 6x9 trim size.
8713 % (Just testing, parameters still in flux.)
8714 \def\smallerbook{{\globaldefs = 1
8715 \parskip = 1.5pt plus 1pt
8716 \textleading = 12pt
8718 \internalpagesizes{7.4in}{4.8in}%
8719 {-.2in}{-.4in}%
8720 {0pt}{14pt}%
8721 {9in}{6in}%
8723 \lispnarrowing = 0.25in
8724 \tolerance = 700
8725 \hfuzz = 1pt
8726 \contentsrightmargin = 0pt
8727 \defbodyindent = .4cm
8730 % Use @afourpaper to print on European A4 paper.
8731 \def\afourpaper{{\globaldefs = 1
8732 \parskip = 3pt plus 2pt minus 1pt
8733 \textleading = 13.2pt
8735 % Double-side printing via postscript on Laserjet 4050
8736 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
8737 % To change the settings for a different printer or situation, adjust
8738 % \normaloffset until the front-side and back-side texts align. Then
8739 % do the same for \bindingoffset. You can set these for testing in
8740 % your texinfo source file like this:
8741 % @tex
8742 % \global\normaloffset = -6mm
8743 % \global\bindingoffset = 10mm
8744 % @end tex
8745 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
8746 {\voffset}{\hoffset}%
8747 {\bindingoffset}{44pt}%
8748 {297mm}{210mm}%
8750 \tolerance = 700
8751 \hfuzz = 1pt
8752 \contentsrightmargin = 0pt
8753 \defbodyindent = 5mm
8756 % Use @afivepaper to print on European A5 paper.
8757 % From romildo@urano.iceb.ufop.br, 2 July 2000.
8758 % He also recommends making @example and @lisp be small.
8759 \def\afivepaper{{\globaldefs = 1
8760 \parskip = 2pt plus 1pt minus 0.1pt
8761 \textleading = 12.5pt
8763 \internalpagesizes{160mm}{120mm}%
8764 {\voffset}{\hoffset}%
8765 {\bindingoffset}{8pt}%
8766 {210mm}{148mm}%
8768 \lispnarrowing = 0.2in
8769 \tolerance = 800
8770 \hfuzz = 1.2pt
8771 \contentsrightmargin = 0pt
8772 \defbodyindent = 2mm
8773 \tableindent = 12mm
8776 % A specific text layout, 24x15cm overall, intended for A4 paper.
8777 \def\afourlatex{{\globaldefs = 1
8778 \afourpaper
8779 \internalpagesizes{237mm}{150mm}%
8780 {\voffset}{4.6mm}%
8781 {\bindingoffset}{7mm}%
8782 {297mm}{210mm}%
8784 % Must explicitly reset to 0 because we call \afourpaper.
8785 \globaldefs = 0
8788 % Use @afourwide to print on A4 paper in landscape format.
8789 \def\afourwide{{\globaldefs = 1
8790 \afourpaper
8791 \internalpagesizes{241mm}{165mm}%
8792 {\voffset}{-2.95mm}%
8793 {\bindingoffset}{7mm}%
8794 {297mm}{210mm}%
8795 \globaldefs = 0
8798 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
8799 % Perhaps we should allow setting the margins, \topskip, \parskip,
8800 % and/or leading, also. Or perhaps we should compute them somehow.
8802 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
8803 \def\pagesizesyyy#1,#2,#3\finish{{%
8804 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
8805 \globaldefs = 1
8807 \parskip = 3pt plus 2pt minus 1pt
8808 \setleading{\textleading}%
8810 \dimen0 = #1\relax
8811 \advance\dimen0 by \voffset
8813 \dimen2 = \hsize
8814 \advance\dimen2 by \normaloffset
8816 \internalpagesizes{#1}{\hsize}%
8817 {\voffset}{\normaloffset}%
8818 {\bindingoffset}{44pt}%
8819 {\dimen0}{\dimen2}%
8822 % Set default to letter.
8824 \letterpaper
8827 \message{and turning on texinfo input format.}
8829 % Define macros to output various characters with catcode for normal text.
8830 \catcode`\"=\other
8831 \catcode`\~=\other
8832 \catcode`\^=\other
8833 \catcode`\_=\other
8834 \catcode`\|=\other
8835 \catcode`\<=\other
8836 \catcode`\>=\other
8837 \catcode`\+=\other
8838 \catcode`\$=\other
8839 \def\normaldoublequote{"}
8840 \def\normaltilde{~}
8841 \def\normalcaret{^}
8842 \def\normalunderscore{_}
8843 \def\normalverticalbar{|}
8844 \def\normalless{<}
8845 \def\normalgreater{>}
8846 \def\normalplus{+}
8847 \def\normaldollar{$}%$ font-lock fix
8849 % This macro is used to make a character print one way in \tt
8850 % (where it can probably be output as-is), and another way in other fonts,
8851 % where something hairier probably needs to be done.
8853 % #1 is what to print if we are indeed using \tt; #2 is what to print
8854 % otherwise. Since all the Computer Modern typewriter fonts have zero
8855 % interword stretch (and shrink), and it is reasonable to expect all
8856 % typewriter fonts to have this, we can check that font parameter.
8858 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
8860 % Same as above, but check for italic font. Actually this also catches
8861 % non-italic slanted fonts since it is impossible to distinguish them from
8862 % italic fonts. But since this is only used by $ and it uses \sl anyway
8863 % this is not a problem.
8864 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
8866 % Turn off all special characters except @
8867 % (and those which the user can use as if they were ordinary).
8868 % Most of these we simply print from the \tt font, but for some, we can
8869 % use math or other variants that look better in normal text.
8871 \catcode`\"=\active
8872 \def\activedoublequote{{\tt\char34}}
8873 \let"=\activedoublequote
8874 \catcode`\~=\active
8875 \def~{{\tt\char126}}
8876 \chardef\hat=`\^
8877 \catcode`\^=\active
8878 \def^{{\tt \hat}}
8880 \catcode`\_=\active
8881 \def_{\ifusingtt\normalunderscore\_}
8882 \let\realunder=_
8883 % Subroutine for the previous macro.
8884 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
8886 \catcode`\|=\active
8887 \def|{{\tt\char124}}
8888 \chardef \less=`\<
8889 \catcode`\<=\active
8890 \def<{{\tt \less}}
8891 \chardef \gtr=`\>
8892 \catcode`\>=\active
8893 \def>{{\tt \gtr}}
8894 \catcode`\+=\active
8895 \def+{{\tt \char 43}}
8896 \catcode`\$=\active
8897 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
8899 % If a .fmt file is being used, characters that might appear in a file
8900 % name cannot be active until we have parsed the command line.
8901 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
8902 % \otherifyactive is called near the end of this file.
8903 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
8905 % Used sometimes to turn off (effectively) the active characters even after
8906 % parsing them.
8907 \def\turnoffactive{%
8908 \normalturnoffactive
8909 \otherbackslash
8912 \catcode`\@=0
8914 % \backslashcurfont outputs one backslash character in current font,
8915 % as in \char`\\.
8916 \global\chardef\backslashcurfont=`\\
8917 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
8919 % \realbackslash is an actual character `\' with catcode other, and
8920 % \doublebackslash is two of them (for the pdf outlines).
8921 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
8923 % In texinfo, backslash is an active character; it prints the backslash
8924 % in fixed width font.
8925 \catcode`\\=\active
8926 @def@normalbackslash{{@tt@backslashcurfont}}
8927 % On startup, @fixbackslash assigns:
8928 % @let \ = @normalbackslash
8930 % \rawbackslash defines an active \ to do \backslashcurfont.
8931 % \otherbackslash defines an active \ to be a literal `\' character with
8932 % catcode other.
8933 @gdef@rawbackslash{@let\=@backslashcurfont}
8934 @gdef@otherbackslash{@let\=@realbackslash}
8936 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
8937 % the literal character `\'.
8939 @def@normalturnoffactive{%
8940 @let\=@normalbackslash
8941 @let"=@normaldoublequote
8942 @let~=@normaltilde
8943 @let^=@normalcaret
8944 @let_=@normalunderscore
8945 @let|=@normalverticalbar
8946 @let<=@normalless
8947 @let>=@normalgreater
8948 @let+=@normalplus
8949 @let$=@normaldollar %$ font-lock fix
8950 @unsepspaces
8953 % Make _ and + \other characters, temporarily.
8954 % This is canceled by @fixbackslash.
8955 @otherifyactive
8957 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
8958 % That is what \eatinput is for; after that, the `\' should revert to printing
8959 % a backslash.
8961 @gdef@eatinput input texinfo{@fixbackslash}
8962 @global@let\ = @eatinput
8964 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
8965 % the first `\' in the file would cause an error. This macro tries to fix
8966 % that, assuming it is called before the first `\' could plausibly occur.
8967 % Also turn back on active characters that might appear in the input
8968 % file name, in case not using a pre-dumped format.
8970 @gdef@fixbackslash{%
8971 @ifx\@eatinput @let\ = @normalbackslash @fi
8972 @catcode`+=@active
8973 @catcode`@_=@active
8976 % Say @foo, not \foo, in error messages.
8977 @escapechar = `@@
8979 % These look ok in all fonts, so just make them not special.
8980 @catcode`@& = @other
8981 @catcode`@# = @other
8982 @catcode`@% = @other
8985 @c Local variables:
8986 @c eval: (add-hook 'write-file-hooks 'time-stamp)
8987 @c page-delimiter: "^\\\\message"
8988 @c time-stamp-start: "def\\\\texinfoversion{"
8989 @c time-stamp-format: "%:y-%02m-%02d.%02H"
8990 @c time-stamp-end: "}"
8991 @c End:
8993 @c vim:sw=2: