Add DCO entries for Andrei Scherer and Stefan Mueller.
[libgcrypt.git] / build-aux / texinfo.tex
1 % texinfo.tex -- TeX macros to handle Texinfo files.
2 %
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
5 %
6 \def\texinfoversion{2006-10-04.17}
7 %
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free
10 % Software Foundation, Inc.
11 %
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 2, or (at
15 % your option) any later version.
16 %
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.
21 %
22 % You should have received a copy of the GNU General Public License
23 % along with this texinfo.tex file; see the file COPYING.  If not, write
24 % to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 % Boston, MA 02110-1301, USA.
26 %
27 % As a special exception, when this file is read by TeX when processing
28 % a Texinfo source document, you may use the result without
29 % restriction.  (This has been our intent since Texinfo was invented.)
30 %
31 % Please try the latest version of texinfo.tex before submitting bug
32 % reports; you can get the latest version from:
33 %   http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
34 %   ftp://tug.org/tex/texinfo.tex
35 %     (and all CTAN mirrors, see http://www.ctan.org).
36 % The texinfo.tex in any given distribution could well be out
37 % of date, so if that's what you're using, please check.
38 %
39 % Send bug reports to bug-texinfo@gnu.org.  Please include including a
40 % complete document in each bug report with which we can reproduce the
41 % problem.  Patches are, of course, greatly appreciated.
42 %
43 % To process a Texinfo manual with TeX, it's most reliable to use the
44 % texi2dvi shell script that comes with the distribution.  For a simple
45 % manual foo.texi, however, you can get away with this:
46 %   tex foo.texi
47 %   texindex foo.??
48 %   tex foo.texi
49 %   tex foo.texi
50 %   dvips foo.dvi -o  # or whatever; this makes foo.ps.
51 % The extra TeX runs get the cross-reference information correct.
52 % Sometimes one run after texindex suffices, and sometimes you need more
53 % than two; texi2dvi does it as many times as necessary.
54 %
55 % It is possible to adapt texinfo.tex for other languages, to some
56 % extent.  You can get the existing language-specific files from the
57 % full Texinfo distribution.
58 %
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60
61
62 \message{Loading texinfo [version \texinfoversion]:}
63
64 % If in a .fmt file, print the version number
65 % and turn on active characters that we couldn't do earlier because
66 % they might have appeared in the input file name.
67 \everyjob{\message{[Texinfo version \texinfoversion]}%
68   \catcode`+=\active \catcode`\_=\active}
69
70 \message{Basics,}
71 \chardef\other=12
72
73 % We never want plain's \outer definition of \+ in Texinfo.
74 % For @tex, we can use \tabalign.
75 \let\+ = \relax
76
77 % Save some plain tex macros whose names we will redefine.
78 \let\ptexb=\b
79 \let\ptexbullet=\bullet
80 \let\ptexc=\c
81 \let\ptexcomma=\,
82 \let\ptexdot=\.
83 \let\ptexdots=\dots
84 \let\ptexend=\end
85 \let\ptexequiv=\equiv
86 \let\ptexexclam=\!
87 \let\ptexfootnote=\footnote
88 \let\ptexgtr=>
89 \let\ptexhat=^
90 \let\ptexi=\i
91 \let\ptexindent=\indent
92 \let\ptexinsert=\insert
93 \let\ptexlbrace=\{
94 \let\ptexless=<
95 \let\ptexnewwrite\newwrite
96 \let\ptexnoindent=\noindent
97 \let\ptexplus=+
98 \let\ptexrbrace=\}
99 \let\ptexslash=\/
100 \let\ptexstar=\*
101 \let\ptext=\t
102
103 % If this character appears in an error message or help string, it
104 % starts a new line in the output.
105 \newlinechar = `^^J
106
107 % Use TeX 3.0's \inputlineno to get the line number, for better error
108 % messages, but if we're using an old version of TeX, don't do anything.
109 %
110 \ifx\inputlineno\thisisundefined
111   \let\linenumber = \empty % Pre-3.0.
112 \else
113   \def\linenumber{l.\the\inputlineno:\space}
114 \fi
115
116 % Set up fixed words for English if not already set.
117 \ifx\putwordAppendix\undefined  \gdef\putwordAppendix{Appendix}\fi
118 \ifx\putwordChapter\undefined   \gdef\putwordChapter{Chapter}\fi
119 \ifx\putwordfile\undefined      \gdef\putwordfile{file}\fi
120 \ifx\putwordin\undefined        \gdef\putwordin{in}\fi
121 \ifx\putwordIndexIsEmpty\undefined     \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
122 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
123 \ifx\putwordInfo\undefined      \gdef\putwordInfo{Info}\fi
124 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
125 \ifx\putwordMethodon\undefined  \gdef\putwordMethodon{Method on}\fi
126 \ifx\putwordNoTitle\undefined   \gdef\putwordNoTitle{No Title}\fi
127 \ifx\putwordof\undefined        \gdef\putwordof{of}\fi
128 \ifx\putwordon\undefined        \gdef\putwordon{on}\fi
129 \ifx\putwordpage\undefined      \gdef\putwordpage{page}\fi
130 \ifx\putwordsection\undefined   \gdef\putwordsection{section}\fi
131 \ifx\putwordSection\undefined   \gdef\putwordSection{Section}\fi
132 \ifx\putwordsee\undefined       \gdef\putwordsee{see}\fi
133 \ifx\putwordSee\undefined       \gdef\putwordSee{See}\fi
134 \ifx\putwordShortTOC\undefined  \gdef\putwordShortTOC{Short Contents}\fi
135 \ifx\putwordTOC\undefined       \gdef\putwordTOC{Table of Contents}\fi
136 %
137 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
138 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
139 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
140 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
141 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
142 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
143 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
144 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
145 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
146 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
147 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
148 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
149 %
150 \ifx\putwordDefmac\undefined    \gdef\putwordDefmac{Macro}\fi
151 \ifx\putwordDefspec\undefined   \gdef\putwordDefspec{Special Form}\fi
152 \ifx\putwordDefvar\undefined    \gdef\putwordDefvar{Variable}\fi
153 \ifx\putwordDefopt\undefined    \gdef\putwordDefopt{User Option}\fi
154 \ifx\putwordDeffunc\undefined   \gdef\putwordDeffunc{Function}\fi
155
156 % Since the category of space is not known, we have to be careful.
157 \chardef\spacecat = 10
158 \def\spaceisspace{\catcode`\ =\spacecat}
159
160 % sometimes characters are active, so we need control sequences.
161 \chardef\colonChar = `\:
162 \chardef\commaChar = `\,
163 \chardef\dashChar  = `\-
164 \chardef\dotChar   = `\.
165 \chardef\exclamChar= `\!
166 \chardef\lquoteChar= `\`
167 \chardef\questChar = `\?
168 \chardef\rquoteChar= `\'
169 \chardef\semiChar  = `\;
170 \chardef\underChar = `\_
171
172 % Ignore a token.
173 %
174 \def\gobble#1{}
175
176 % The following is used inside several \edef's.
177 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
178
179 % Hyphenation fixes.
180 \hyphenation{
181   Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
182   ap-pen-dix bit-map bit-maps
183   data-base data-bases eshell fall-ing half-way long-est man-u-script
184   man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
185   par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
186   spell-ing spell-ings
187   stand-alone strong-est time-stamp time-stamps which-ever white-space
188   wide-spread wrap-around
189 }
190
191 % Margin to add to right of even pages, to left of odd pages.
192 \newdimen\bindingoffset
193 \newdimen\normaloffset
194 \newdimen\pagewidth \newdimen\pageheight
195
196 % For a final copy, take out the rectangles
197 % that mark overfull boxes (in case you have decided
198 % that the text looks ok even though it passes the margin).
199 %
200 \def\finalout{\overfullrule=0pt}
201
202 % @| inserts a changebar to the left of the current line.  It should
203 % surround any changed text.  This approach does *not* work if the
204 % change spans more than two lines of output.  To handle that, we would
205 % have adopt a much more difficult approach (putting marks into the main
206 % vertical list for the beginning and end of each change).
207 %
208 \def\|{%
209   % \vadjust can only be used in horizontal mode.
210   \leavevmode
211   %
212   % Append this vertical mode material after the current line in the output.
213   \vadjust{%
214     % We want to insert a rule with the height and depth of the current
215     % leading; that is exactly what \strutbox is supposed to record.
216     \vskip-\baselineskip
217     %
218     % \vadjust-items are inserted at the left edge of the type.  So
219     % the \llap here moves out into the left-hand margin.
220     \llap{%
221       %
222       % For a thicker or thinner bar, change the `1pt'.
223       \vrule height\baselineskip width1pt
224       %
225       % This is the space between the bar and the text.
226       \hskip 12pt
227     }%
228   }%
229 }
230
231 % Sometimes it is convenient to have everything in the transcript file
232 % and nothing on the terminal.  We don't just call \tracingall here,
233 % since that produces some useless output on the terminal.  We also make
234 % some effort to order the tracing commands to reduce output in the log
235 % file; cf. trace.sty in LaTeX.
236 %
237 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
238 \def\loggingall{%
239   \tracingstats2
240   \tracingpages1
241   \tracinglostchars2  % 2 gives us more in etex
242   \tracingparagraphs1
243   \tracingoutput1
244   \tracingmacros2
245   \tracingrestores1
246   \showboxbreadth\maxdimen \showboxdepth\maxdimen
247   \ifx\eTeXversion\undefined\else % etex gives us more logging
248     \tracingscantokens1
249     \tracingifs1
250     \tracinggroups1
251     \tracingnesting2
252     \tracingassigns1
253   \fi
254   \tracingcommands3  % 3 gives us more in etex
255   \errorcontextlines16
256 }%
257
258 % add check for \lastpenalty to plain's definitions.  If the last thing
259 % we did was a \nobreak, we don't want to insert more space.
260 %
261 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
262   \removelastskip\penalty-50\smallskip\fi\fi}
263 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
264   \removelastskip\penalty-100\medskip\fi\fi}
265 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
266   \removelastskip\penalty-200\bigskip\fi\fi}
267
268 % For @cropmarks command.
269 % Do @cropmarks to get crop marks.
270 %
271 \newif\ifcropmarks
272 \let\cropmarks = \cropmarkstrue
273 %
274 % Dimensions to add cropmarks at corners.
275 % Added by P. A. MacKay, 12 Nov. 1986
276 %
277 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
278 \newdimen\cornerlong  \cornerlong=1pc
279 \newdimen\cornerthick \cornerthick=.3pt
280 \newdimen\topandbottommargin \topandbottommargin=.75in
281
282 % Main output routine.
283 \chardef\PAGE = 255
284 \output = {\onepageout{\pagecontents\PAGE}}
285
286 \newbox\headlinebox
287 \newbox\footlinebox
288
289 % \onepageout takes a vbox as an argument.  Note that \pagecontents
290 % does insertions, but you have to call it yourself.
291 \def\onepageout#1{%
292   \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
293   %
294   \ifodd\pageno  \advance\hoffset by \bindingoffset
295   \else \advance\hoffset by -\bindingoffset\fi
296   %
297   % Do this outside of the \shipout so @code etc. will be expanded in
298   % the headline as they should be, not taken literally (outputting ''code).
299   \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
300   \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
301   %
302   {%
303     % Have to do this stuff outside the \shipout because we want it to
304     % take effect in \write's, yet the group defined by the \vbox ends
305     % before the \shipout runs.
306     %
307     \indexdummies         % don't expand commands in the output.
308     \normalturnoffactive  % \ in index entries must not stay \, e.g., if
309                % the page break happens to be in the middle of an example.
310                % We don't want .vr (or whatever) entries like this:
311                % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
312                % "\acronym" won't work when it's read back in;
313                % it needs to be
314                % {\code {{\tt \backslashcurfont }acronym}
315     \shipout\vbox{%
316       % Do this early so pdf references go to the beginning of the page.
317       \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
318       %
319       \ifcropmarks \vbox to \outervsize\bgroup
320         \hsize = \outerhsize
321         \vskip-\topandbottommargin
322         \vtop to0pt{%
323           \line{\ewtop\hfil\ewtop}%
324           \nointerlineskip
325           \line{%
326             \vbox{\moveleft\cornerthick\nstop}%
327             \hfill
328             \vbox{\moveright\cornerthick\nstop}%
329           }%
330           \vss}%
331         \vskip\topandbottommargin
332         \line\bgroup
333           \hfil % center the page within the outer (page) hsize.
334           \ifodd\pageno\hskip\bindingoffset\fi
335           \vbox\bgroup
336       \fi
337       %
338       \unvbox\headlinebox
339       \pagebody{#1}%
340       \ifdim\ht\footlinebox > 0pt
341         % Only leave this space if the footline is nonempty.
342         % (We lessened \vsize for it in \oddfootingyyy.)
343         % The \baselineskip=24pt in plain's \makefootline has no effect.
344         \vskip 24pt
345         \unvbox\footlinebox
346       \fi
347       %
348       \ifcropmarks
349           \egroup % end of \vbox\bgroup
350         \hfil\egroup % end of (centering) \line\bgroup
351         \vskip\topandbottommargin plus1fill minus1fill
352         \boxmaxdepth = \cornerthick
353         \vbox to0pt{\vss
354           \line{%
355             \vbox{\moveleft\cornerthick\nsbot}%
356             \hfill
357             \vbox{\moveright\cornerthick\nsbot}%
358           }%
359           \nointerlineskip
360           \line{\ewbot\hfil\ewbot}%
361         }%
362       \egroup % \vbox from first cropmarks clause
363       \fi
364     }% end of \shipout\vbox
365   }% end of group with \indexdummies
366   \advancepageno
367   \ifnum\outputpenalty>-20000 \else\dosupereject\fi
368 }
369
370 \newinsert\margin \dimen\margin=\maxdimen
371
372 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
373 {\catcode`\@ =11
374 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
375 % marginal hacks, juha@viisa.uucp (Juha Takala)
376 \ifvoid\margin\else % marginal info is present
377   \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
378 \dimen@=\dp#1 \unvbox#1
379 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
380 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
381 }
382
383 % Here are the rules for the cropmarks.  Note that they are
384 % offset so that the space between them is truly \outerhsize or \outervsize
385 % (P. A. MacKay, 12 November, 1986)
386 %
387 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
388 \def\nstop{\vbox
389   {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
390 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
391 \def\nsbot{\vbox
392   {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
393
394 % Parse an argument, then pass it to #1.  The argument is the rest of
395 % the input line (except we remove a trailing comment).  #1 should be a
396 % macro which expects an ordinary undelimited TeX argument.
397 %
398 \def\parsearg{\parseargusing{}}
399 \def\parseargusing#1#2{%
400   \def\argtorun{#2}%
401   \begingroup
402     \obeylines
403     \spaceisspace
404     #1%
405     \parseargline\empty% Insert the \empty token, see \finishparsearg below.
406 }
407
408 {\obeylines %
409   \gdef\parseargline#1^^M{%
410     \endgroup % End of the group started in \parsearg.
411     \argremovecomment #1\comment\ArgTerm%
412   }%
413 }
414
415 % First remove any @comment, then any @c comment.
416 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
417 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
418
419 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
420 %
421 % \argremovec might leave us with trailing space, e.g.,
422 %    @end itemize  @c foo
423 % This space token undergoes the same procedure and is eventually removed
424 % by \finishparsearg.
425 %
426 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
427 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
428 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
429   \def\temp{#3}%
430   \ifx\temp\empty
431     % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
432     \let\temp\finishparsearg
433   \else
434     \let\temp\argcheckspaces
435   \fi
436   % Put the space token in:
437   \temp#1 #3\ArgTerm
438 }
439
440 % If a _delimited_ argument is enclosed in braces, they get stripped; so
441 % to get _exactly_ the rest of the line, we had to prevent such situation.
442 % We prepended an \empty token at the very beginning and we expand it now,
443 % just before passing the control to \argtorun.
444 % (Similarily, we have to think about #3 of \argcheckspacesY above: it is
445 % either the null string, or it ends with \^^M---thus there is no danger
446 % that a pair of braces would be stripped.
447 %
448 % But first, we have to remove the trailing space token.
449 %
450 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
451
452 % \parseargdef\foo{...}
453 %       is roughly equivalent to
454 % \def\foo{\parsearg\Xfoo}
455 % \def\Xfoo#1{...}
456 %
457 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
458 % favourite TeX trick.  --kasal, 16nov03
459
460 \def\parseargdef#1{%
461   \expandafter \doparseargdef \csname\string#1\endcsname #1%
462 }
463 \def\doparseargdef#1#2{%
464   \def#2{\parsearg#1}%
465   \def#1##1%
466 }
467
468 % Several utility definitions with active space:
469 {
470   \obeyspaces
471   \gdef\obeyedspace{ }
472
473   % Make each space character in the input produce a normal interword
474   % space in the output.  Don't allow a line break at this space, as this
475   % is used only in environments like @example, where each line of input
476   % should produce a line of output anyway.
477   %
478   \gdef\sepspaces{\obeyspaces\let =\tie}
479
480   % If an index command is used in an @example environment, any spaces
481   % therein should become regular spaces in the raw index file, not the
482   % expansion of \tie (\leavevmode \penalty \@M \ ).
483   \gdef\unsepspaces{\let =\space}
484 }
485
486
487 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
488
489 % Define the framework for environments in texinfo.tex.  It's used like this:
490 %
491 %   \envdef\foo{...}
492 %   \def\Efoo{...}
493 %
494 % It's the responsibility of \envdef to insert \begingroup before the
495 % actual body; @end closes the group after calling \Efoo.  \envdef also
496 % defines \thisenv, so the current environment is known; @end checks
497 % whether the environment name matches.  The \checkenv macro can also be
498 % used to check whether the current environment is the one expected.
499 %
500 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
501 % are not treated as enviroments; they don't open a group.  (The
502 % implementation of @end takes care not to call \endgroup in this
503 % special case.)
504
505
506 % At runtime, environments start with this:
507 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
508 % initialize
509 \let\thisenv\empty
510
511 % ... but they get defined via ``\envdef\foo{...}'':
512 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
513 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
514
515 % Check whether we're in the right environment:
516 \def\checkenv#1{%
517   \def\temp{#1}%
518   \ifx\thisenv\temp
519   \else
520     \badenverr
521   \fi
522 }
523
524 % Evironment mismatch, #1 expected:
525 \def\badenverr{%
526   \errhelp = \EMsimple
527   \errmessage{This command can appear only \inenvironment\temp,
528     not \inenvironment\thisenv}%
529 }
530 \def\inenvironment#1{%
531   \ifx#1\empty
532     out of any environment%
533   \else
534     in environment \expandafter\string#1%
535   \fi
536 }
537
538 % @end foo executes the definition of \Efoo.
539 % But first, it executes a specialized version of \checkenv
540 %
541 \parseargdef\end{%
542   \if 1\csname iscond.#1\endcsname
543   \else
544     % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
545     \expandafter\checkenv\csname#1\endcsname
546     \csname E#1\endcsname
547     \endgroup
548   \fi
549 }
550
551 \newhelp\EMsimple{Press RETURN to continue.}
552
553
554 %% Simple single-character @ commands
555
556 % @@ prints an @
557 % Kludge this until the fonts are right (grr).
558 \def\@{{\tt\char64}}
559
560 % This is turned off because it was never documented
561 % and you can use @w{...} around a quote to suppress ligatures.
562 %% Define @` and @' to be the same as ` and '
563 %% but suppressing ligatures.
564 %\def\`{{`}}
565 %\def\'{{'}}
566
567 % Used to generate quoted braces.
568 \def\mylbrace {{\tt\char123}}
569 \def\myrbrace {{\tt\char125}}
570 \let\{=\mylbrace
571 \let\}=\myrbrace
572 \begingroup
573   % Definitions to produce \{ and \} commands for indices,
574   % and @{ and @} for the aux/toc files.
575   \catcode`\{ = \other \catcode`\} = \other
576   \catcode`\[ = 1 \catcode`\] = 2
577   \catcode`\! = 0 \catcode`\\ = \other
578   !gdef!lbracecmd[\{]%
579   !gdef!rbracecmd[\}]%
580   !gdef!lbraceatcmd[@{]%
581   !gdef!rbraceatcmd[@}]%
582 !endgroup
583
584 % @comma{} to avoid , parsing problems.
585 \let\comma = ,
586
587 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
588 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
589 \let\, = \c
590 \let\dotaccent = \.
591 \def\ringaccent#1{{\accent23 #1}}
592 \let\tieaccent = \t
593 \let\ubaraccent = \b
594 \let\udotaccent = \d
595
596 % Other special characters: @questiondown @exclamdown @ordf @ordm
597 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
598 \def\questiondown{?`}
599 \def\exclamdown{!`}
600 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
601 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
602
603 % Dotless i and dotless j, used for accents.
604 \def\imacro{i}
605 \def\jmacro{j}
606 \def\dotless#1{%
607   \def\temp{#1}%
608   \ifx\temp\imacro \ptexi
609   \else\ifx\temp\jmacro \j
610   \else \errmessage{@dotless can be used only with i or j}%
611   \fi\fi
612 }
613
614 % The \TeX{} logo, as in plain, but resetting the spacing so that a
615 % period following counts as ending a sentence.  (Idea found in latex.)
616 %
617 \edef\TeX{\TeX \spacefactor=1000 }
618
619 % @LaTeX{} logo.  Not quite the same results as the definition in
620 % latex.ltx, since we use a different font for the raised A; it's most
621 % convenient for us to use an explicitly smaller font, rather than using
622 % the \scriptstyle font (since we don't reset \scriptstyle and
623 % \scriptscriptstyle).
624 %
625 \def\LaTeX{%
626   L\kern-.36em
627   {\setbox0=\hbox{T}%
628    \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
629   \kern-.15em
630   \TeX
631 }
632
633 % Be sure we're in horizontal mode when doing a tie, since we make space
634 % equivalent to this in @example-like environments. Otherwise, a space
635 % at the beginning of a line will start with \penalty -- and
636 % since \penalty is valid in vertical mode, we'd end up putting the
637 % penalty on the vertical list instead of in the new paragraph.
638 {\catcode`@ = 11
639  % Avoid using \@M directly, because that causes trouble
640  % if the definition is written into an index file.
641  \global\let\tiepenalty = \@M
642  \gdef\tie{\leavevmode\penalty\tiepenalty\ }
643 }
644
645 % @: forces normal size whitespace following.
646 \def\:{\spacefactor=1000 }
647
648 % @* forces a line break.
649 \def\*{\hfil\break\hbox{}\ignorespaces}
650
651 % @/ allows a line break.
652 \let\/=\allowbreak
653
654 % @. is an end-of-sentence period.
655 \def\.{.\spacefactor=\endofsentencespacefactor\space}
656
657 % @! is an end-of-sentence bang.
658 \def\!{!\spacefactor=\endofsentencespacefactor\space}
659
660 % @? is an end-of-sentence query.
661 \def\?{?\spacefactor=\endofsentencespacefactor\space}
662
663 % @frenchspacing on|off  says whether to put extra space after punctuation.
664 %
665 \def\onword{on}
666 \def\offword{off}
667 %
668 \parseargdef\frenchspacing{%
669   \def\temp{#1}%
670   \ifx\temp\onword \plainfrenchspacing
671   \else\ifx\temp\offword \plainnonfrenchspacing
672   \else
673     \errhelp = \EMsimple
674     \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
675   \fi\fi
676 }
677
678 % @w prevents a word break.  Without the \leavevmode, @w at the
679 % beginning of a paragraph, when TeX is still in vertical mode, would
680 % produce a whole line of output instead of starting the paragraph.
681 \def\w#1{\leavevmode\hbox{#1}}
682
683 % @group ... @end group forces ... to be all on one page, by enclosing
684 % it in a TeX vbox.  We use \vtop instead of \vbox to construct the box
685 % to keep its height that of a normal line.  According to the rules for
686 % \topskip (p.114 of the TeXbook), the glue inserted is
687 % max (\topskip - \ht (first item), 0).  If that height is large,
688 % therefore, no glue is inserted, and the space between the headline and
689 % the text is small, which looks bad.
690 %
691 % Another complication is that the group might be very large.  This can
692 % cause the glue on the previous page to be unduly stretched, because it
693 % does not have much material.  In this case, it's better to add an
694 % explicit \vfill so that the extra space is at the bottom.  The
695 % threshold for doing this is if the group is more than \vfilllimit
696 % percent of a page (\vfilllimit can be changed inside of @tex).
697 %
698 \newbox\groupbox
699 \def\vfilllimit{0.7}
700 %
701 \envdef\group{%
702   \ifnum\catcode`\^^M=\active \else
703     \errhelp = \groupinvalidhelp
704     \errmessage{@group invalid in context where filling is enabled}%
705   \fi
706   \startsavinginserts
707   %
708   \setbox\groupbox = \vtop\bgroup
709     % Do @comment since we are called inside an environment such as
710     % @example, where each end-of-line in the input causes an
711     % end-of-line in the output.  We don't want the end-of-line after
712     % the `@group' to put extra space in the output.  Since @group
713     % should appear on a line by itself (according to the Texinfo
714     % manual), we don't worry about eating any user text.
715     \comment
716 }
717 %
718 % The \vtop produces a box with normal height and large depth; thus, TeX puts
719 % \baselineskip glue before it, and (when the next line of text is done)
720 % \lineskip glue after it.  Thus, space below is not quite equal to space
721 % above.  But it's pretty close.
722 \def\Egroup{%
723     % To get correct interline space between the last line of the group
724     % and the first line afterwards, we have to propagate \prevdepth.
725     \endgraf % Not \par, as it may have been set to \lisppar.
726     \global\dimen1 = \prevdepth
727   \egroup           % End the \vtop.
728   % \dimen0 is the vertical size of the group's box.
729   \dimen0 = \ht\groupbox  \advance\dimen0 by \dp\groupbox
730   % \dimen2 is how much space is left on the page (more or less).
731   \dimen2 = \pageheight   \advance\dimen2 by -\pagetotal
732   % if the group doesn't fit on the current page, and it's a big big
733   % group, force a page break.
734   \ifdim \dimen0 > \dimen2
735     \ifdim \pagetotal < \vfilllimit\pageheight
736       \page
737     \fi
738   \fi
739   \box\groupbox
740   \prevdepth = \dimen1
741   \checkinserts
742 }
743 %
744 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
745 % message, so this ends up printing `@group can only ...'.
746 %
747 \newhelp\groupinvalidhelp{%
748 group can only be used in environments such as @example,^^J%
749 where each line of input produces a line of output.}
750
751 % @need space-in-mils
752 % forces a page break if there is not space-in-mils remaining.
753
754 \newdimen\mil  \mil=0.001in
755
756 % Old definition--didn't work.
757 %\parseargdef\need{\par %
758 %% This method tries to make TeX break the page naturally
759 %% if the depth of the box does not fit.
760 %{\baselineskip=0pt%
761 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
762 %\prevdepth=-1000pt
763 %}}
764
765 \parseargdef\need{%
766   % Ensure vertical mode, so we don't make a big box in the middle of a
767   % paragraph.
768   \par
769   %
770   % If the @need value is less than one line space, it's useless.
771   \dimen0 = #1\mil
772   \dimen2 = \ht\strutbox
773   \advance\dimen2 by \dp\strutbox
774   \ifdim\dimen0 > \dimen2
775     %
776     % Do a \strut just to make the height of this box be normal, so the
777     % normal leading is inserted relative to the preceding line.
778     % And a page break here is fine.
779     \vtop to #1\mil{\strut\vfil}%
780     %
781     % TeX does not even consider page breaks if a penalty added to the
782     % main vertical list is 10000 or more.  But in order to see if the
783     % empty box we just added fits on the page, we must make it consider
784     % page breaks.  On the other hand, we don't want to actually break the
785     % page after the empty box.  So we use a penalty of 9999.
786     %
787     % There is an extremely small chance that TeX will actually break the
788     % page at this \penalty, if there are no other feasible breakpoints in
789     % sight.  (If the user is using lots of big @group commands, which
790     % almost-but-not-quite fill up a page, TeX will have a hard time doing
791     % good page breaking, for example.)  However, I could not construct an
792     % example where a page broke at this \penalty; if it happens in a real
793     % document, then we can reconsider our strategy.
794     \penalty9999
795     %
796     % Back up by the size of the box, whether we did a page break or not.
797     \kern -#1\mil
798     %
799     % Do not allow a page break right after this kern.
800     \nobreak
801   \fi
802 }
803
804 % @br   forces paragraph break (and is undocumented).
805
806 \let\br = \par
807
808 % @page forces the start of a new page.
809 %
810 \def\page{\par\vfill\supereject}
811
812 % @exdent text....
813 % outputs text on separate line in roman font, starting at standard page margin
814
815 % This records the amount of indent in the innermost environment.
816 % That's how much \exdent should take out.
817 \newskip\exdentamount
818
819 % This defn is used inside fill environments such as @defun.
820 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
821
822 % This defn is used inside nofill environments such as @example.
823 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
824   \leftline{\hskip\leftskip{\rm#1}}}}
825
826 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
827 % paragraph.  For more general purposes, use the \margin insertion
828 % class.  WHICH is `l' or `r'.
829 %
830 \newskip\inmarginspacing \inmarginspacing=1cm
831 \def\strutdepth{\dp\strutbox}
832 %
833 \def\doinmargin#1#2{\strut\vadjust{%
834   \nobreak
835   \kern-\strutdepth
836   \vtop to \strutdepth{%
837     \baselineskip=\strutdepth
838     \vss
839     % if you have multiple lines of stuff to put here, you'll need to
840     % make the vbox yourself of the appropriate size.
841     \ifx#1l%
842       \llap{\ignorespaces #2\hskip\inmarginspacing}%
843     \else
844       \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
845     \fi
846     \null
847   }%
848 }}
849 \def\inleftmargin{\doinmargin l}
850 \def\inrightmargin{\doinmargin r}
851 %
852 % @inmargin{TEXT [, RIGHT-TEXT]}
853 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
854 % else use TEXT for both).
855 %
856 \def\inmargin#1{\parseinmargin #1,,\finish}
857 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
858   \setbox0 = \hbox{\ignorespaces #2}%
859   \ifdim\wd0 > 0pt
860     \def\lefttext{#1}%  have both texts
861     \def\righttext{#2}%
862   \else
863     \def\lefttext{#1}%  have only one text
864     \def\righttext{#1}%
865   \fi
866   %
867   \ifodd\pageno
868     \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
869   \else
870     \def\temp{\inleftmargin\lefttext}%
871   \fi
872   \temp
873 }
874
875 % @include file    insert text of that file as input.
876 %
877 \def\include{\parseargusing\filenamecatcodes\includezzz}
878 \def\includezzz#1{%
879   \pushthisfilestack
880   \def\thisfile{#1}%
881   {%
882     \makevalueexpandable
883     \def\temp{\input #1 }%
884     \expandafter
885   }\temp
886   \popthisfilestack
887 }
888 \def\filenamecatcodes{%
889   \catcode`\\=\other
890   \catcode`~=\other
891   \catcode`^=\other
892   \catcode`_=\other
893   \catcode`|=\other
894   \catcode`<=\other
895   \catcode`>=\other
896   \catcode`+=\other
897   \catcode`-=\other
898 }
899
900 \def\pushthisfilestack{%
901   \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
902 }
903 \def\pushthisfilestackX{%
904   \expandafter\pushthisfilestackY\thisfile\StackTerm
905 }
906 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
907   \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
908 }
909
910 \def\popthisfilestack{\errthisfilestackempty}
911 \def\errthisfilestackempty{\errmessage{Internal error:
912   the stack of filenames is empty.}}
913
914 \def\thisfile{}
915
916 % @center line
917 % outputs that line, centered.
918 %
919 \parseargdef\center{%
920   \ifhmode
921     \let\next\centerH
922   \else
923     \let\next\centerV
924   \fi
925   \next{\hfil \ignorespaces#1\unskip \hfil}%
926 }
927 \def\centerH#1{%
928   {%
929     \hfil\break
930     \advance\hsize by -\leftskip
931     \advance\hsize by -\rightskip
932     \line{#1}%
933     \break
934   }%
935 }
936 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
937
938 % @sp n   outputs n lines of vertical space
939
940 \parseargdef\sp{\vskip #1\baselineskip}
941
942 % @comment ...line which is ignored...
943 % @c is the same as @comment
944 % @ignore ... @end ignore  is another way to write a comment
945
946 \def\comment{\begingroup \catcode`\^^M=\other%
947 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
948 \commentxxx}
949 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
950
951 \let\c=\comment
952
953 % @paragraphindent NCHARS
954 % We'll use ems for NCHARS, close enough.
955 % NCHARS can also be the word `asis' or `none'.
956 % We cannot feasibly implement @paragraphindent asis, though.
957 %
958 \def\asisword{asis} % no translation, these are keywords
959 \def\noneword{none}
960 %
961 \parseargdef\paragraphindent{%
962   \def\temp{#1}%
963   \ifx\temp\asisword
964   \else
965     \ifx\temp\noneword
966       \defaultparindent = 0pt
967     \else
968       \defaultparindent = #1em
969     \fi
970   \fi
971   \parindent = \defaultparindent
972 }
973
974 % @exampleindent NCHARS
975 % We'll use ems for NCHARS like @paragraphindent.
976 % It seems @exampleindent asis isn't necessary, but
977 % I preserve it to make it similar to @paragraphindent.
978 \parseargdef\exampleindent{%
979   \def\temp{#1}%
980   \ifx\temp\asisword
981   \else
982     \ifx\temp\noneword
983       \lispnarrowing = 0pt
984     \else
985       \lispnarrowing = #1em
986     \fi
987   \fi
988 }
989
990 % @firstparagraphindent WORD
991 % If WORD is `none', then suppress indentation of the first paragraph
992 % after a section heading.  If WORD is `insert', then do indent at such
993 % paragraphs.
994 %
995 % The paragraph indentation is suppressed or not by calling
996 % \suppressfirstparagraphindent, which the sectioning commands do.
997 % We switch the definition of this back and forth according to WORD.
998 % By default, we suppress indentation.
999 %
1000 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1001 \def\insertword{insert}
1002 %
1003 \parseargdef\firstparagraphindent{%
1004   \def\temp{#1}%
1005   \ifx\temp\noneword
1006     \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1007   \else\ifx\temp\insertword
1008     \let\suppressfirstparagraphindent = \relax
1009   \else
1010     \errhelp = \EMsimple
1011     \errmessage{Unknown @firstparagraphindent option `\temp'}%
1012   \fi\fi
1013 }
1014
1015 % Here is how we actually suppress indentation.  Redefine \everypar to
1016 % \kern backwards by \parindent, and then reset itself to empty.
1017 %
1018 % We also make \indent itself not actually do anything until the next
1019 % paragraph.
1020 %
1021 \gdef\dosuppressfirstparagraphindent{%
1022   \gdef\indent{%
1023     \restorefirstparagraphindent
1024     \indent
1025   }%
1026   \gdef\noindent{%
1027     \restorefirstparagraphindent
1028     \noindent
1029   }%
1030   \global\everypar = {%
1031     \kern -\parindent
1032     \restorefirstparagraphindent
1033   }%
1034 }
1035
1036 \gdef\restorefirstparagraphindent{%
1037   \global \let \indent = \ptexindent
1038   \global \let \noindent = \ptexnoindent
1039   \global \everypar = {}%
1040 }
1041
1042
1043 % @asis just yields its argument.  Used with @table, for example.
1044 %
1045 \def\asis#1{#1}
1046
1047 % @math outputs its argument in math mode.
1048 %
1049 % One complication: _ usually means subscripts, but it could also mean
1050 % an actual _ character, as in @math{@var{some_variable} + 1}.  So make
1051 % _ active, and distinguish by seeing if the current family is \slfam,
1052 % which is what @var uses.
1053 {
1054   \catcode`\_ = \active
1055   \gdef\mathunderscore{%
1056     \catcode`\_=\active
1057     \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1058   }
1059 }
1060 % Another complication: we want \\ (and @\) to output a \ character.
1061 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1062 % this is not advertised and we don't care.  Texinfo does not
1063 % otherwise define @\.
1064 %
1065 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1066 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1067 %
1068 \def\math{%
1069   \tex
1070   \mathunderscore
1071   \let\\ = \mathbackslash
1072   \mathactive
1073   $\finishmath
1074 }
1075 \def\finishmath#1{#1$\endgroup}  % Close the group opened by \tex.
1076
1077 % Some active characters (such as <) are spaced differently in math.
1078 % We have to reset their definitions in case the @math was an argument
1079 % to a command which sets the catcodes (such as @item or @section).
1080 %
1081 {
1082   \catcode`^ = \active
1083   \catcode`< = \active
1084   \catcode`> = \active
1085   \catcode`+ = \active
1086   \gdef\mathactive{%
1087     \let^ = \ptexhat
1088     \let< = \ptexless
1089     \let> = \ptexgtr
1090     \let+ = \ptexplus
1091   }
1092 }
1093
1094 % @bullet and @minus need the same treatment as @math, just above.
1095 \def\bullet{$\ptexbullet$}
1096 \def\minus{$-$}
1097
1098 % @dots{} outputs an ellipsis using the current font.
1099 % We do .5em per period so that it has the same spacing in the cm
1100 % typewriter fonts as three actual period characters; on the other hand,
1101 % in other typewriter fonts three periods are wider than 1.5em.  So do
1102 % whichever is larger.
1103 %
1104 \def\dots{%
1105   \leavevmode
1106   \setbox0=\hbox{...}% get width of three periods
1107   \ifdim\wd0 > 1.5em
1108     \dimen0 = \wd0
1109   \else
1110     \dimen0 = 1.5em
1111   \fi
1112   \hbox to \dimen0{%
1113     \hskip 0pt plus.25fil
1114     .\hskip 0pt plus1fil
1115     .\hskip 0pt plus1fil
1116     .\hskip 0pt plus.5fil
1117   }%
1118 }
1119
1120 % @enddots{} is an end-of-sentence ellipsis.
1121 %
1122 \def\enddots{%
1123   \dots
1124   \spacefactor=\endofsentencespacefactor
1125 }
1126
1127 % @comma{} is so commas can be inserted into text without messing up
1128 % Texinfo's parsing.
1129 %
1130 \let\comma = ,
1131
1132 % @refill is a no-op.
1133 \let\refill=\relax
1134
1135 % If working on a large document in chapters, it is convenient to
1136 % be able to disable indexing, cross-referencing, and contents, for test runs.
1137 % This is done with @novalidate (before @setfilename).
1138 %
1139 \newif\iflinks \linkstrue % by default we want the aux files.
1140 \let\novalidate = \linksfalse
1141
1142 % @setfilename is done at the beginning of every texinfo file.
1143 % So open here the files we need to have open while reading the input.
1144 % This makes it possible to make a .fmt file for texinfo.
1145 \def\setfilename{%
1146    \fixbackslash  % Turn off hack to swallow `\input texinfo'.
1147    \iflinks
1148      \tryauxfile
1149      % Open the new aux file.  TeX will close it automatically at exit.
1150      \immediate\openout\auxfile=\jobname.aux
1151    \fi % \openindices needs to do some work in any case.
1152    \openindices
1153    \let\setfilename=\comment % Ignore extra @setfilename cmds.
1154    %
1155    % If texinfo.cnf is present on the system, read it.
1156    % Useful for site-wide @afourpaper, etc.
1157    \openin 1 texinfo.cnf
1158    \ifeof 1 \else \input texinfo.cnf \fi
1159    \closein 1
1160    %
1161    \comment % Ignore the actual filename.
1162 }
1163
1164 % Called from \setfilename.
1165 %
1166 \def\openindices{%
1167   \newindex{cp}%
1168   \newcodeindex{fn}%
1169   \newcodeindex{vr}%
1170   \newcodeindex{tp}%
1171   \newcodeindex{ky}%
1172   \newcodeindex{pg}%
1173 }
1174
1175 % @bye.
1176 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1177
1178
1179 \message{pdf,}
1180 % adobe `portable' document format
1181 \newcount\tempnum
1182 \newcount\lnkcount
1183 \newtoks\filename
1184 \newcount\filenamelength
1185 \newcount\pgn
1186 \newtoks\toksA
1187 \newtoks\toksB
1188 \newtoks\toksC
1189 \newtoks\toksD
1190 \newbox\boxA
1191 \newcount\countA
1192 \newif\ifpdf
1193 \newif\ifpdfmakepagedest
1194
1195 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1196 % can be set).  So we test for \relax and 0 as well as \undefined,
1197 % borrowed from ifpdf.sty.
1198 \ifx\pdfoutput\undefined
1199 \else
1200   \ifx\pdfoutput\relax
1201   \else
1202     \ifcase\pdfoutput
1203     \else
1204       \pdftrue
1205     \fi
1206   \fi
1207 \fi
1208
1209 % PDF uses PostScript string constants for the names of xref targets,
1210 % for display in the outlines, and in other places.  Thus, we have to
1211 % double any backslashes.  Otherwise, a name like "\node" will be
1212 % interpreted as a newline (\n), followed by o, d, e.  Not good.
1213 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1214 % (and related messages, the final outcome is that it is up to the TeX
1215 % user to double the backslashes and otherwise make the string valid, so
1216 % that's what we do).
1217
1218 % double active backslashes.
1219 %
1220 {\catcode`\@=0 \catcode`\\=\active
1221  @gdef@activebackslashdouble{%
1222    @catcode`@\=@active
1223    @let\=@doublebackslash}
1224 }
1225
1226 % To handle parens, we must adopt a different approach, since parens are
1227 % not active characters.  hyperref.dtx (which has the same problem as
1228 % us) handles it with this amazing macro to replace tokens.  I've
1229 % tinkered with it a little for texinfo, but it's definitely from there.
1230 %
1231 % #1 is the tokens to replace.
1232 % #2 is the replacement.
1233 % #3 is the control sequence with the string.
1234 %
1235 \def\HyPsdSubst#1#2#3{%
1236   \def\HyPsdReplace##1#1##2\END{%
1237     ##1%
1238     \ifx\\##2\\%
1239     \else
1240       #2%
1241       \HyReturnAfterFi{%
1242         \HyPsdReplace##2\END
1243       }%
1244     \fi
1245   }%
1246   \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1247 }
1248 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1249
1250 % #1 is a control sequence in which to do the replacements.
1251 \def\backslashparens#1{%
1252   \xdef#1{#1}% redefine it as its expansion; the definition is simply
1253              % \lastnode when called from \setref -> \pdfmkdest.
1254   \HyPsdSubst{(}{\realbackslash(}{#1}%
1255   \HyPsdSubst{)}{\realbackslash)}{#1}%
1256 }
1257
1258 \ifpdf
1259   \input pdfcolor
1260   \pdfcatalog{/PageMode /UseOutlines}%
1261   % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1262   \def\dopdfimage#1#2#3{%
1263     \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1264     \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1265     % without \immediate, pdftex seg faults when the same image is
1266     % included twice.  (Version 3.14159-pre-1.0-unofficial-20010704.)
1267     \ifnum\pdftexversion < 14
1268       \immediate\pdfimage
1269     \else
1270       \immediate\pdfximage
1271     \fi
1272       \ifdim \wd0 >0pt width \imagewidth \fi
1273       \ifdim \wd2 >0pt height \imageheight \fi
1274       \ifnum\pdftexversion<13
1275          #1.pdf%
1276        \else
1277          {#1.pdf}%
1278        \fi
1279     \ifnum\pdftexversion < 14 \else
1280       \pdfrefximage \pdflastximage
1281     \fi}
1282   \def\pdfmkdest#1{{%
1283     % We have to set dummies so commands such as @code, and characters
1284     % such as \, aren't expanded when present in a section title.
1285     \atdummies
1286     \activebackslashdouble
1287     \def\pdfdestname{#1}%
1288     \backslashparens\pdfdestname
1289     \pdfdest name{\pdfdestname} xyz%
1290   }}%
1291   %
1292   % used to mark target names; must be expandable.
1293   \def\pdfmkpgn#1{#1}%
1294   %
1295   \let\linkcolor = \Blue  % was Cyan, but that seems light?
1296   \def\endlink{\Black\pdfendlink}
1297   % Adding outlines to PDF; macros for calculating structure of outlines
1298   % come from Petr Olsak
1299   \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1300     \else \csname#1\endcsname \fi}
1301   \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1302     \advance\tempnum by 1
1303     \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1304   %
1305   % #1 is the section text, which is what will be displayed in the
1306   % outline by the pdf viewer.  #2 is the pdf expression for the number
1307   % of subentries (or empty, for subsubsections).  #3 is the node text,
1308   % which might be empty if this toc entry had no corresponding node.
1309   % #4 is the page number
1310   %
1311   \def\dopdfoutline#1#2#3#4{%
1312     % Generate a link to the node text if that exists; else, use the
1313     % page number.  We could generate a destination for the section
1314     % text in the case where a section has no node, but it doesn't
1315     % seem worth the trouble, since most documents are normally structured.
1316     \def\pdfoutlinedest{#3}%
1317     \ifx\pdfoutlinedest\empty
1318       \def\pdfoutlinedest{#4}%
1319     \else
1320       % Doubled backslashes in the name.
1321       {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1322        \backslashparens\pdfoutlinedest}%
1323     \fi
1324     %
1325     % Also double the backslashes in the display string.
1326     {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1327      \backslashparens\pdfoutlinetext}%
1328     %
1329     \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1330   }
1331   %
1332   \def\pdfmakeoutlines{%
1333     \begingroup
1334       % Thanh's hack / proper braces in bookmarks
1335       \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1336       \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1337       %
1338       % Read toc silently, to get counts of subentries for \pdfoutline.
1339       \def\numchapentry##1##2##3##4{%
1340         \def\thischapnum{##2}%
1341         \def\thissecnum{0}%
1342         \def\thissubsecnum{0}%
1343       }%
1344       \def\numsecentry##1##2##3##4{%
1345         \advancenumber{chap\thischapnum}%
1346         \def\thissecnum{##2}%
1347         \def\thissubsecnum{0}%
1348       }%
1349       \def\numsubsecentry##1##2##3##4{%
1350         \advancenumber{sec\thissecnum}%
1351         \def\thissubsecnum{##2}%
1352       }%
1353       \def\numsubsubsecentry##1##2##3##4{%
1354         \advancenumber{subsec\thissubsecnum}%
1355       }%
1356       \def\thischapnum{0}%
1357       \def\thissecnum{0}%
1358       \def\thissubsecnum{0}%
1359       %
1360       % use \def rather than \let here because we redefine \chapentry et
1361       % al. a second time, below.
1362       \def\appentry{\numchapentry}%
1363       \def\appsecentry{\numsecentry}%
1364       \def\appsubsecentry{\numsubsecentry}%
1365       \def\appsubsubsecentry{\numsubsubsecentry}%
1366       \def\unnchapentry{\numchapentry}%
1367       \def\unnsecentry{\numsecentry}%
1368       \def\unnsubsecentry{\numsubsecentry}%
1369       \def\unnsubsubsecentry{\numsubsubsecentry}%
1370       \readdatafile{toc}%
1371       %
1372       % Read toc second time, this time actually producing the outlines.
1373       % The `-' means take the \expnumber as the absolute number of
1374       % subentries, which we calculated on our first read of the .toc above.
1375       %
1376       % We use the node names as the destinations.
1377       \def\numchapentry##1##2##3##4{%
1378         \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1379       \def\numsecentry##1##2##3##4{%
1380         \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1381       \def\numsubsecentry##1##2##3##4{%
1382         \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1383       \def\numsubsubsecentry##1##2##3##4{% count is always zero
1384         \dopdfoutline{##1}{}{##3}{##4}}%
1385       %
1386       % PDF outlines are displayed using system fonts, instead of
1387       % document fonts.  Therefore we cannot use special characters,
1388       % since the encoding is unknown.  For example, the eogonek from
1389       % Latin 2 (0xea) gets translated to a | character.  Info from
1390       % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1391       %
1392       % xx to do this right, we have to translate 8-bit characters to
1393       % their "best" equivalent, based on the @documentencoding.  Right
1394       % now, I guess we'll just let the pdf reader have its way.
1395       \indexnofonts
1396       \setupdatafile
1397       \catcode`\\=\active \otherbackslash
1398       \input \jobname.toc
1399     \endgroup
1400   }
1401   %
1402   \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1403     \ifx\PP\D\let\nextsp\relax
1404     \else\let\nextsp\skipspaces
1405       \ifx\p\space\else\addtokens{\filename}{\PP}%
1406         \advance\filenamelength by 1
1407       \fi
1408     \fi
1409     \nextsp}
1410   \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1411   \ifnum\pdftexversion < 14
1412     \let \startlink \pdfannotlink
1413   \else
1414     \let \startlink \pdfstartlink
1415   \fi
1416   % make a live url in pdf output.
1417   \def\pdfurl#1{%
1418     \begingroup
1419       % it seems we really need yet another set of dummies; have not
1420       % tried to figure out what each command should do in the context
1421       % of @url.  for now, just make @/ a no-op, that's the only one
1422       % people have actually reported a problem with.
1423       %
1424       \normalturnoffactive
1425       \def\@{@}%
1426       \let\/=\empty
1427       \makevalueexpandable
1428       \leavevmode\Red
1429       \startlink attr{/Border [0 0 0]}%
1430         user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1431     \endgroup}
1432   \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1433   \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1434   \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1435   \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1436   \def\maketoks{%
1437     \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1438     \ifx\first0\adn0
1439     \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1440     \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1441     \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1442     \else
1443       \ifnum0=\countA\else\makelink\fi
1444       \ifx\first.\let\next=\done\else
1445         \let\next=\maketoks
1446         \addtokens{\toksB}{\the\toksD}
1447         \ifx\first,\addtokens{\toksB}{\space}\fi
1448       \fi
1449     \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1450     \next}
1451   \def\makelink{\addtokens{\toksB}%
1452     {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1453   \def\pdflink#1{%
1454     \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1455     \linkcolor #1\endlink}
1456   \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1457 \else
1458   \let\pdfmkdest = \gobble
1459   \let\pdfurl = \gobble
1460   \let\endlink = \relax
1461   \let\linkcolor = \relax
1462   \let\pdfmakeoutlines = \relax
1463 \fi  % \ifx\pdfoutput
1464
1465
1466 \message{fonts,}
1467
1468 % Change the current font style to #1, remembering it in \curfontstyle.
1469 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1470 % italics, not bold italics.
1471 %
1472 \def\setfontstyle#1{%
1473   \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1474   \csname ten#1\endcsname  % change the current font
1475 }
1476
1477 % Select #1 fonts with the current style.
1478 %
1479 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1480
1481 \def\rm{\fam=0 \setfontstyle{rm}}
1482 \def\it{\fam=\itfam \setfontstyle{it}}
1483 \def\sl{\fam=\slfam \setfontstyle{sl}}
1484 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1485 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1486
1487 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1488 % So we set up a \sf.
1489 \newfam\sffam
1490 \def\sf{\fam=\sffam \setfontstyle{sf}}
1491 \let\li = \sf % Sometimes we call it \li, not \sf.
1492
1493 % We don't need math for this font style.
1494 \def\ttsl{\setfontstyle{ttsl}}
1495
1496
1497 % Default leading.
1498 \newdimen\textleading  \textleading = 13.2pt
1499
1500 % Set the baselineskip to #1, and the lineskip and strut size
1501 % correspondingly.  There is no deep meaning behind these magic numbers
1502 % used as factors; they just match (closely enough) what Knuth defined.
1503 %
1504 \def\lineskipfactor{.08333}
1505 \def\strutheightpercent{.70833}
1506 \def\strutdepthpercent {.29167}
1507 %
1508 \def\setleading#1{%
1509   \normalbaselineskip = #1\relax
1510   \normallineskip = \lineskipfactor\normalbaselineskip
1511   \normalbaselines
1512   \setbox\strutbox =\hbox{%
1513     \vrule width0pt height\strutheightpercent\baselineskip
1514                     depth \strutdepthpercent \baselineskip
1515   }%
1516 }
1517
1518
1519 % Set the font macro #1 to the font named #2, adding on the
1520 % specified font prefix (normally `cm').
1521 % #3 is the font's design size, #4 is a scale factor
1522 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1523
1524
1525 % Use cm as the default font prefix.
1526 % To specify the font prefix, you must define \fontprefix
1527 % before you read in texinfo.tex.
1528 \ifx\fontprefix\undefined
1529 \def\fontprefix{cm}
1530 \fi
1531 % Support font families that don't use the same naming scheme as CM.
1532 \def\rmshape{r}
1533 \def\rmbshape{bx}               %where the normal face is bold
1534 \def\bfshape{b}
1535 \def\bxshape{bx}
1536 \def\ttshape{tt}
1537 \def\ttbshape{tt}
1538 \def\ttslshape{sltt}
1539 \def\itshape{ti}
1540 \def\itbshape{bxti}
1541 \def\slshape{sl}
1542 \def\slbshape{bxsl}
1543 \def\sfshape{ss}
1544 \def\sfbshape{ss}
1545 \def\scshape{csc}
1546 \def\scbshape{csc}
1547
1548 % Definitions for a main text size of 11pt.  This is the default in
1549 % Texinfo.
1550 %
1551 \def\definetextfontsizexi{
1552 % Text fonts (11.2pt, magstep1).
1553 \def\textnominalsize{11pt}
1554 \edef\mainmagstep{\magstephalf}
1555 \setfont\textrm\rmshape{10}{\mainmagstep}
1556 \setfont\texttt\ttshape{10}{\mainmagstep}
1557 \setfont\textbf\bfshape{10}{\mainmagstep}
1558 \setfont\textit\itshape{10}{\mainmagstep}
1559 \setfont\textsl\slshape{10}{\mainmagstep}
1560 \setfont\textsf\sfshape{10}{\mainmagstep}
1561 \setfont\textsc\scshape{10}{\mainmagstep}
1562 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1563 \font\texti=cmmi10 scaled \mainmagstep
1564 \font\textsy=cmsy10 scaled \mainmagstep
1565
1566 % A few fonts for @defun names and args.
1567 \setfont\defbf\bfshape{10}{\magstep1}
1568 \setfont\deftt\ttshape{10}{\magstep1}
1569 \setfont\defttsl\ttslshape{10}{\magstep1}
1570 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1571
1572 % Fonts for indices, footnotes, small examples (9pt).
1573 \def\smallnominalsize{9pt}
1574 \setfont\smallrm\rmshape{9}{1000}
1575 \setfont\smalltt\ttshape{9}{1000}
1576 \setfont\smallbf\bfshape{10}{900}
1577 \setfont\smallit\itshape{9}{1000}
1578 \setfont\smallsl\slshape{9}{1000}
1579 \setfont\smallsf\sfshape{9}{1000}
1580 \setfont\smallsc\scshape{10}{900}
1581 \setfont\smallttsl\ttslshape{10}{900}
1582 \font\smalli=cmmi9
1583 \font\smallsy=cmsy9
1584
1585 % Fonts for small examples (8pt).
1586 \def\smallernominalsize{8pt}
1587 \setfont\smallerrm\rmshape{8}{1000}
1588 \setfont\smallertt\ttshape{8}{1000}
1589 \setfont\smallerbf\bfshape{10}{800}
1590 \setfont\smallerit\itshape{8}{1000}
1591 \setfont\smallersl\slshape{8}{1000}
1592 \setfont\smallersf\sfshape{8}{1000}
1593 \setfont\smallersc\scshape{10}{800}
1594 \setfont\smallerttsl\ttslshape{10}{800}
1595 \font\smalleri=cmmi8
1596 \font\smallersy=cmsy8
1597
1598 % Fonts for title page (20.4pt):
1599 \def\titlenominalsize{20pt}
1600 \setfont\titlerm\rmbshape{12}{\magstep3}
1601 \setfont\titleit\itbshape{10}{\magstep4}
1602 \setfont\titlesl\slbshape{10}{\magstep4}
1603 \setfont\titlett\ttbshape{12}{\magstep3}
1604 \setfont\titlettsl\ttslshape{10}{\magstep4}
1605 \setfont\titlesf\sfbshape{17}{\magstep1}
1606 \let\titlebf=\titlerm
1607 \setfont\titlesc\scbshape{10}{\magstep4}
1608 \font\titlei=cmmi12 scaled \magstep3
1609 \font\titlesy=cmsy10 scaled \magstep4
1610 \def\authorrm{\secrm}
1611 \def\authortt{\sectt}
1612
1613 % Chapter (and unnumbered) fonts (17.28pt).
1614 \def\chapnominalsize{17pt}
1615 \setfont\chaprm\rmbshape{12}{\magstep2}
1616 \setfont\chapit\itbshape{10}{\magstep3}
1617 \setfont\chapsl\slbshape{10}{\magstep3}
1618 \setfont\chaptt\ttbshape{12}{\magstep2}
1619 \setfont\chapttsl\ttslshape{10}{\magstep3}
1620 \setfont\chapsf\sfbshape{17}{1000}
1621 \let\chapbf=\chaprm
1622 \setfont\chapsc\scbshape{10}{\magstep3}
1623 \font\chapi=cmmi12 scaled \magstep2
1624 \font\chapsy=cmsy10 scaled \magstep3
1625
1626 % Section fonts (14.4pt).
1627 \def\secnominalsize{14pt}
1628 \setfont\secrm\rmbshape{12}{\magstep1}
1629 \setfont\secit\itbshape{10}{\magstep2}
1630 \setfont\secsl\slbshape{10}{\magstep2}
1631 \setfont\sectt\ttbshape{12}{\magstep1}
1632 \setfont\secttsl\ttslshape{10}{\magstep2}
1633 \setfont\secsf\sfbshape{12}{\magstep1}
1634 \let\secbf\secrm
1635 \setfont\secsc\scbshape{10}{\magstep2}
1636 \font\seci=cmmi12 scaled \magstep1
1637 \font\secsy=cmsy10 scaled \magstep2
1638
1639 % Subsection fonts (13.15pt).
1640 \def\ssecnominalsize{13pt}
1641 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1642 \setfont\ssecit\itbshape{10}{1315}
1643 \setfont\ssecsl\slbshape{10}{1315}
1644 \setfont\ssectt\ttbshape{12}{\magstephalf}
1645 \setfont\ssecttsl\ttslshape{10}{1315}
1646 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1647 \let\ssecbf\ssecrm
1648 \setfont\ssecsc\scbshape{10}{1315}
1649 \font\sseci=cmmi12 scaled \magstephalf
1650 \font\ssecsy=cmsy10 scaled 1315
1651
1652 % Reduced fonts for @acro in text (10pt).
1653 \def\reducednominalsize{10pt}
1654 \setfont\reducedrm\rmshape{10}{1000}
1655 \setfont\reducedtt\ttshape{10}{1000}
1656 \setfont\reducedbf\bfshape{10}{1000}
1657 \setfont\reducedit\itshape{10}{1000}
1658 \setfont\reducedsl\slshape{10}{1000}
1659 \setfont\reducedsf\sfshape{10}{1000}
1660 \setfont\reducedsc\scshape{10}{1000}
1661 \setfont\reducedttsl\ttslshape{10}{1000}
1662 \font\reducedi=cmmi10
1663 \font\reducedsy=cmsy10
1664
1665 % reset the current fonts
1666 \textfonts
1667 \rm
1668 } % end of 11pt text font size definitions
1669
1670
1671 % Definitions to make the main text be 10pt Computer Modern, with
1672 % section, chapter, etc., sizes following suit.  This is for the GNU
1673 % Press printing of the Emacs 22 manual.  Maybe other manuals in the
1674 % future.  Used with @smallbook, which sets the leading to 12pt.
1675 %
1676 \def\definetextfontsizex{%
1677 % Text fonts (10pt).
1678 \def\textnominalsize{10pt}
1679 \edef\mainmagstep{1000}
1680 \setfont\textrm\rmshape{10}{\mainmagstep}
1681 \setfont\texttt\ttshape{10}{\mainmagstep}
1682 \setfont\textbf\bfshape{10}{\mainmagstep}
1683 \setfont\textit\itshape{10}{\mainmagstep}
1684 \setfont\textsl\slshape{10}{\mainmagstep}
1685 \setfont\textsf\sfshape{10}{\mainmagstep}
1686 \setfont\textsc\scshape{10}{\mainmagstep}
1687 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1688 \font\texti=cmmi10 scaled \mainmagstep
1689 \font\textsy=cmsy10 scaled \mainmagstep
1690
1691 % A few fonts for @defun names and args.
1692 \setfont\defbf\bfshape{10}{\magstephalf}
1693 \setfont\deftt\ttshape{10}{\magstephalf}
1694 \setfont\defttsl\ttslshape{10}{\magstephalf}
1695 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1696
1697 % Fonts for indices, footnotes, small examples (9pt).
1698 \def\smallnominalsize{9pt}
1699 \setfont\smallrm\rmshape{9}{1000}
1700 \setfont\smalltt\ttshape{9}{1000}
1701 \setfont\smallbf\bfshape{10}{900}
1702 \setfont\smallit\itshape{9}{1000}
1703 \setfont\smallsl\slshape{9}{1000}
1704 \setfont\smallsf\sfshape{9}{1000}
1705 \setfont\smallsc\scshape{10}{900}
1706 \setfont\smallttsl\ttslshape{10}{900}
1707 \font\smalli=cmmi9
1708 \font\smallsy=cmsy9
1709
1710 % Fonts for small examples (8pt).
1711 \def\smallernominalsize{8pt}
1712 \setfont\smallerrm\rmshape{8}{1000}
1713 \setfont\smallertt\ttshape{8}{1000}
1714 \setfont\smallerbf\bfshape{10}{800}
1715 \setfont\smallerit\itshape{8}{1000}
1716 \setfont\smallersl\slshape{8}{1000}
1717 \setfont\smallersf\sfshape{8}{1000}
1718 \setfont\smallersc\scshape{10}{800}
1719 \setfont\smallerttsl\ttslshape{10}{800}
1720 \font\smalleri=cmmi8
1721 \font\smallersy=cmsy8
1722
1723 % Fonts for title page (20.4pt):
1724 \def\titlenominalsize{20pt}
1725 \setfont\titlerm\rmbshape{12}{\magstep3}
1726 \setfont\titleit\itbshape{10}{\magstep4}
1727 \setfont\titlesl\slbshape{10}{\magstep4}
1728 \setfont\titlett\ttbshape{12}{\magstep3}
1729 \setfont\titlettsl\ttslshape{10}{\magstep4}
1730 \setfont\titlesf\sfbshape{17}{\magstep1}
1731 \let\titlebf=\titlerm
1732 \setfont\titlesc\scbshape{10}{\magstep4}
1733 \font\titlei=cmmi12 scaled \magstep3
1734 \font\titlesy=cmsy10 scaled \magstep4
1735 \def\authorrm{\secrm}
1736 \def\authortt{\sectt}
1737
1738 % Chapter fonts (14.4pt).
1739 \def\chapnominalsize{14pt}
1740 \setfont\chaprm\rmbshape{12}{\magstep1}
1741 \setfont\chapit\itbshape{10}{\magstep2}
1742 \setfont\chapsl\slbshape{10}{\magstep2}
1743 \setfont\chaptt\ttbshape{12}{\magstep1}
1744 \setfont\chapttsl\ttslshape{10}{\magstep2}
1745 \setfont\chapsf\sfbshape{12}{\magstep1}
1746 \let\chapbf\chaprm
1747 \setfont\chapsc\scbshape{10}{\magstep2}
1748 \font\chapi=cmmi12 scaled \magstep1
1749 \font\chapsy=cmsy10 scaled \magstep2
1750
1751 % Section fonts (12pt).
1752 \def\secnominalsize{12pt}
1753 \setfont\secrm\rmbshape{12}{1000}
1754 \setfont\secit\itbshape{10}{\magstep1}
1755 \setfont\secsl\slbshape{10}{\magstep1}
1756 \setfont\sectt\ttbshape{12}{1000}
1757 \setfont\secttsl\ttslshape{10}{\magstep1}
1758 \setfont\secsf\sfbshape{12}{1000}
1759 \let\secbf\secrm
1760 \setfont\secsc\scbshape{10}{\magstep1}
1761 \font\seci=cmmi12
1762 \font\secsy=cmsy10 scaled \magstep1
1763
1764 % Subsection fonts (10pt).
1765 \def\ssecnominalsize{10pt}
1766 \setfont\ssecrm\rmbshape{10}{1000}
1767 \setfont\ssecit\itbshape{10}{1000}
1768 \setfont\ssecsl\slbshape{10}{1000}
1769 \setfont\ssectt\ttbshape{10}{1000}
1770 \setfont\ssecttsl\ttslshape{10}{1000}
1771 \setfont\ssecsf\sfbshape{10}{1000}
1772 \let\ssecbf\ssecrm
1773 \setfont\ssecsc\scbshape{10}{1000}
1774 \font\sseci=cmmi10
1775 \font\ssecsy=cmsy10
1776
1777 % Reduced fonts for @acro in text (9pt).
1778 \def\reducednominalsize{9pt}
1779 \setfont\reducedrm\rmshape{9}{1000}
1780 \setfont\reducedtt\ttshape{9}{1000}
1781 \setfont\reducedbf\bfshape{10}{900}
1782 \setfont\reducedit\itshape{9}{1000}
1783 \setfont\reducedsl\slshape{9}{1000}
1784 \setfont\reducedsf\sfshape{9}{1000}
1785 \setfont\reducedsc\scshape{10}{900}
1786 \setfont\reducedttsl\ttslshape{10}{900}
1787 \font\reducedi=cmmi9
1788 \font\reducedsy=cmsy9
1789
1790 % reduce space between paragraphs
1791 \divide\parskip by 2
1792
1793 % reset the current fonts
1794 \textfonts
1795 \rm
1796 } % end of 10pt text font size definitions
1797
1798
1799 % We provide the user-level command
1800 %   @fonttextsize 10
1801 % (or 11) to redefine the text font size.  pt is assumed.
1802 %
1803 \def\xword{10}
1804 \def\xiword{11}
1805 %
1806 \parseargdef\fonttextsize{%
1807   \def\textsizearg{#1}%
1808   \wlog{doing @fonttextsize \textsizearg}%
1809   %
1810   % Set \globaldefs so that documents can use this inside @tex, since
1811   % makeinfo 4.8 does not support it, but we need it nonetheless.
1812   %
1813  \begingroup \globaldefs=1
1814   \ifx\textsizearg\xword \definetextfontsizex
1815   \else \ifx\textsizearg\xiword \definetextfontsizexi
1816   \else
1817     \errhelp=\EMsimple
1818     \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
1819   \fi\fi
1820  \endgroup
1821 }
1822
1823
1824 % In order for the font changes to affect most math symbols and letters,
1825 % we have to define the \textfont of the standard families.  Since
1826 % texinfo doesn't allow for producing subscripts and superscripts except
1827 % in the main text, we don't bother to reset \scriptfont and
1828 % \scriptscriptfont (which would also require loading a lot more fonts).
1829 %
1830 \def\resetmathfonts{%
1831   \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1832   \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1833   \textfont\ttfam=\tentt \textfont\sffam=\tensf
1834 }
1835
1836 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1837 % of just \STYLE.  We do this because \STYLE needs to also set the
1838 % current \fam for math mode.  Our \STYLE (e.g., \rm) commands hardwire
1839 % \tenSTYLE to set the current font.
1840 %
1841 % Each font-changing command also sets the names \lsize (one size lower)
1842 % and \lllsize (three sizes lower).  These relative commands are used in
1843 % the LaTeX logo and acronyms.
1844 %
1845 % This all needs generalizing, badly.
1846 %
1847 \def\textfonts{%
1848   \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1849   \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1850   \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1851   \let\tenttsl=\textttsl
1852   \def\curfontsize{text}%
1853   \def\lsize{reduced}\def\lllsize{smaller}%
1854   \resetmathfonts \setleading{\textleading}}
1855 \def\titlefonts{%
1856   \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1857   \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1858   \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1859   \let\tenttsl=\titlettsl
1860   \def\curfontsize{title}%
1861   \def\lsize{chap}\def\lllsize{subsec}%
1862   \resetmathfonts \setleading{25pt}}
1863 \def\titlefont#1{{\titlefonts\rm #1}}
1864 \def\chapfonts{%
1865   \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1866   \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1867   \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
1868   \let\tenttsl=\chapttsl
1869   \def\curfontsize{chap}%
1870   \def\lsize{sec}\def\lllsize{text}%
1871   \resetmathfonts \setleading{19pt}}
1872 \def\secfonts{%
1873   \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1874   \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1875   \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1876   \let\tenttsl=\secttsl
1877   \def\curfontsize{sec}%
1878   \def\lsize{subsec}\def\lllsize{reduced}%
1879   \resetmathfonts \setleading{16pt}}
1880 \def\subsecfonts{%
1881   \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1882   \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1883   \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1884   \let\tenttsl=\ssecttsl
1885   \def\curfontsize{ssec}%
1886   \def\lsize{text}\def\lllsize{small}%
1887   \resetmathfonts \setleading{15pt}}
1888 \let\subsubsecfonts = \subsecfonts
1889 \def\reducedfonts{%
1890   \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1891   \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1892   \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1893   \let\tenttsl=\reducedttsl
1894   \def\curfontsize{reduced}%
1895   \def\lsize{small}\def\lllsize{smaller}%
1896   \resetmathfonts \setleading{10.5pt}}
1897 \def\smallfonts{%
1898   \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1899   \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1900   \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1901   \let\tenttsl=\smallttsl
1902   \def\curfontsize{small}%
1903   \def\lsize{smaller}\def\lllsize{smaller}%
1904   \resetmathfonts \setleading{10.5pt}}
1905 \def\smallerfonts{%
1906   \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1907   \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1908   \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1909   \let\tenttsl=\smallerttsl
1910   \def\curfontsize{smaller}%
1911   \def\lsize{smaller}\def\lllsize{smaller}%
1912   \resetmathfonts \setleading{9.5pt}}
1913
1914 % Set the fonts to use with the @small... environments.
1915 \let\smallexamplefonts = \smallfonts
1916
1917 % About \smallexamplefonts.  If we use \smallfonts (9pt), @smallexample
1918 % can fit this many characters:
1919 %   8.5x11=86   smallbook=72  a4=90  a5=69
1920 % If we use \scriptfonts (8pt), then we can fit this many characters:
1921 %   8.5x11=90+  smallbook=80  a4=90+  a5=77
1922 % For me, subjectively, the few extra characters that fit aren't worth
1923 % the additional smallness of 8pt.  So I'm making the default 9pt.
1924 %
1925 % By the way, for comparison, here's what fits with @example (10pt):
1926 %   8.5x11=71  smallbook=60  a4=75  a5=58
1927 %
1928 % I wish the USA used A4 paper.
1929 % --karl, 24jan03.
1930
1931
1932 % Set up the default fonts, so we can use them for creating boxes.
1933 %
1934 \definetextfontsizexi
1935
1936 % Define these so they can be easily changed for other fonts.
1937 \def\angleleft{$\langle$}
1938 \def\angleright{$\rangle$}
1939
1940 % Count depth in font-changes, for error checks
1941 \newcount\fontdepth \fontdepth=0
1942
1943 % Fonts for short table of contents.
1944 \setfont\shortcontrm\rmshape{12}{1000}
1945 \setfont\shortcontbf\bfshape{10}{\magstep1}  % no cmb12
1946 \setfont\shortcontsl\slshape{12}{1000}
1947 \setfont\shortconttt\ttshape{12}{1000}
1948
1949 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1950 %% serif) and @ii for TeX italic
1951
1952 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1953 % unless the following character is such as not to need one.
1954 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1955                     \ptexslash\fi\fi\fi}
1956 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1957 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1958
1959 % like \smartslanted except unconditionally uses \ttsl.
1960 % @var is set to this for defun arguments.
1961 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1962
1963 % like \smartslanted except unconditionally use \sl.  We never want
1964 % ttsl for book titles, do we?
1965 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1966
1967 \let\i=\smartitalic
1968 \let\slanted=\smartslanted
1969 \let\var=\smartslanted
1970 \let\dfn=\smartslanted
1971 \let\emph=\smartitalic
1972
1973 % @b, explicit bold.
1974 \def\b#1{{\bf #1}}
1975 \let\strong=\b
1976
1977 % @sansserif, explicit sans.
1978 \def\sansserif#1{{\sf #1}}
1979
1980 % We can't just use \exhyphenpenalty, because that only has effect at
1981 % the end of a paragraph.  Restore normal hyphenation at the end of the
1982 % group within which \nohyphenation is presumably called.
1983 %
1984 \def\nohyphenation{\hyphenchar\font = -1  \aftergroup\restorehyphenation}
1985 \def\restorehyphenation{\hyphenchar\font = `- }
1986
1987 % Set sfcode to normal for the chars that usually have another value.
1988 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1989 % sometimes \x has an active definition that messes things up.
1990 %
1991 \catcode`@=11
1992   \def\plainfrenchspacing{%
1993     \sfcode\dotChar  =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
1994     \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
1995     \def\endofsentencespacefactor{1000}% for @. and friends
1996   }
1997   \def\plainnonfrenchspacing{%
1998     \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
1999     \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2000     \def\endofsentencespacefactor{3000}% for @. and friends
2001   }
2002 \catcode`@=\other
2003 \def\endofsentencespacefactor{3000}% default
2004
2005 \def\t#1{%
2006   {\tt \rawbackslash \plainfrenchspacing #1}%
2007   \null
2008 }
2009 \def\samp#1{`\tclose{#1}'\null}
2010 \setfont\keyrm\rmshape{8}{1000}
2011 \font\keysy=cmsy9
2012 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2013   \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2014     \vbox{\hrule\kern-0.4pt
2015      \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2016     \kern-0.4pt\hrule}%
2017   \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2018 % The old definition, with no lozenge:
2019 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
2020 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2021
2022 % @file, @option are the same as @samp.
2023 \let\file=\samp
2024 \let\option=\samp
2025
2026 % @code is a modification of @t,
2027 % which makes spaces the same size as normal in the surrounding text.
2028 \def\tclose#1{%
2029   {%
2030     % Change normal interword space to be same as for the current font.
2031     \spaceskip = \fontdimen2\font
2032     %
2033     % Switch to typewriter.
2034     \tt
2035     %
2036     % But `\ ' produces the large typewriter interword space.
2037     \def\ {{\spaceskip = 0pt{} }}%
2038     %
2039     % Turn off hyphenation.
2040     \nohyphenation
2041     %
2042     \rawbackslash
2043     \plainfrenchspacing
2044     #1%
2045   }%
2046   \null
2047 }
2048
2049 % We *must* turn on hyphenation at `-' and `_' in @code.
2050 % Otherwise, it is too hard to avoid overfull hboxes
2051 % in the Emacs manual, the Library manual, etc.
2052
2053 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2054 % both hyphenation at - and hyphenation within words.
2055 % We must therefore turn them both off (\tclose does that)
2056 % and arrange explicitly to hyphenate at a dash.
2057 %  -- rms.
2058 {
2059   \catcode`\-=\active \catcode`\_=\active
2060   \catcode`\'=\active \catcode`\`=\active
2061   %
2062   \global\def\code{\begingroup
2063     \catcode\rquoteChar=\active \catcode\lquoteChar=\active
2064     \let'\codequoteright \let`\codequoteleft
2065     %
2066     \catcode\dashChar=\active  \catcode\underChar=\active
2067     \ifallowcodebreaks
2068      \let-\codedash
2069      \let_\codeunder
2070     \else
2071      \let-\realdash
2072      \let_\realunder
2073     \fi
2074     \codex
2075   }
2076 }
2077
2078 \def\realdash{-}
2079 \def\codedash{-\discretionary{}{}{}}
2080 \def\codeunder{%
2081   % this is all so @math{@code{var_name}+1} can work.  In math mode, _
2082   % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2083   % will therefore expand the active definition of _, which is us
2084   % (inside @code that is), therefore an endless loop.
2085   \ifusingtt{\ifmmode
2086                \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2087              \else\normalunderscore \fi
2088              \discretionary{}{}{}}%
2089             {\_}%
2090 }
2091 \def\codex #1{\tclose{#1}\endgroup}
2092
2093 % An additional complication: the above will allow breaks after, e.g.,
2094 % each of the four underscores in __typeof__.  This is undesirable in
2095 % some manuals, especially if they don't have long identifiers in
2096 % general.  @allowcodebreaks provides a way to control this.
2097 %
2098 \newif\ifallowcodebreaks  \allowcodebreakstrue
2099
2100 \def\keywordtrue{true}
2101 \def\keywordfalse{false}
2102
2103 \parseargdef\allowcodebreaks{%
2104   \def\txiarg{#1}%
2105   \ifx\txiarg\keywordtrue
2106     \allowcodebreakstrue
2107   \else\ifx\txiarg\keywordfalse
2108     \allowcodebreaksfalse
2109   \else
2110     \errhelp = \EMsimple
2111     \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2112   \fi\fi
2113 }
2114
2115 % @kbd is like @code, except that if the argument is just one @key command,
2116 % then @kbd has no effect.
2117
2118 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2119 %   `example' (@kbd uses ttsl only inside of @example and friends),
2120 %   or `code' (@kbd uses normal tty font always).
2121 \parseargdef\kbdinputstyle{%
2122   \def\txiarg{#1}%
2123   \ifx\txiarg\worddistinct
2124     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2125   \else\ifx\txiarg\wordexample
2126     \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2127   \else\ifx\txiarg\wordcode
2128     \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2129   \else
2130     \errhelp = \EMsimple
2131     \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2132   \fi\fi\fi
2133 }
2134 \def\worddistinct{distinct}
2135 \def\wordexample{example}
2136 \def\wordcode{code}
2137
2138 % Default is `distinct.'
2139 \kbdinputstyle distinct
2140
2141 \def\xkey{\key}
2142 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2143 \ifx\one\xkey\ifx\threex\three \key{#2}%
2144 \else{\tclose{\kbdfont\look}}\fi
2145 \else{\tclose{\kbdfont\look}}\fi}
2146
2147 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2148 \let\indicateurl=\code
2149 \let\env=\code
2150 \let\command=\code
2151
2152 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2153 % second argument specifying the text to display and an optional third
2154 % arg as text to display instead of (rather than in addition to) the url
2155 % itself.  First (mandatory) arg is the url.  Perhaps eventually put in
2156 % a hypertex \special here.
2157 %
2158 \def\uref#1{\douref #1,,,\finish}
2159 \def\douref#1,#2,#3,#4\finish{\begingroup
2160   \unsepspaces
2161   \pdfurl{#1}%
2162   \setbox0 = \hbox{\ignorespaces #3}%
2163   \ifdim\wd0 > 0pt
2164     \unhbox0 % third arg given, show only that
2165   \else
2166     \setbox0 = \hbox{\ignorespaces #2}%
2167     \ifdim\wd0 > 0pt
2168       \ifpdf
2169         \unhbox0             % PDF: 2nd arg given, show only it
2170       \else
2171         \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2172       \fi
2173     \else
2174       \code{#1}% only url given, so show it
2175     \fi
2176   \fi
2177   \endlink
2178 \endgroup}
2179
2180 % @url synonym for @uref, since that's how everyone uses it.
2181 %
2182 \let\url=\uref
2183
2184 % rms does not like angle brackets --karl, 17may97.
2185 % So now @email is just like @uref, unless we are pdf.
2186 %
2187 %\def\email#1{\angleleft{\tt #1}\angleright}
2188 \ifpdf
2189   \def\email#1{\doemail#1,,\finish}
2190   \def\doemail#1,#2,#3\finish{\begingroup
2191     \unsepspaces
2192     \pdfurl{mailto:#1}%
2193     \setbox0 = \hbox{\ignorespaces #2}%
2194     \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2195     \endlink
2196   \endgroup}
2197 \else
2198   \let\email=\uref
2199 \fi
2200
2201 % Check if we are currently using a typewriter font.  Since all the
2202 % Computer Modern typewriter fonts have zero interword stretch (and
2203 % shrink), and it is reasonable to expect all typewriter fonts to have
2204 % this property, we can check that font parameter.
2205 %
2206 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2207
2208 % Typeset a dimension, e.g., `in' or `pt'.  The only reason for the
2209 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2210 %
2211 \def\dmn#1{\thinspace #1}
2212
2213 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2214
2215 % @l was never documented to mean ``switch to the Lisp font'',
2216 % and it is not used as such in any manual I can find.  We need it for
2217 % Polish suppressed-l.  --karl, 22sep96.
2218 %\def\l#1{{\li #1}\null}
2219
2220 % Explicit font changes: @r, @sc, undocumented @ii.
2221 \def\r#1{{\rm #1}}              % roman font
2222 \def\sc#1{{\smallcaps#1}}       % smallcaps font
2223 \def\ii#1{{\it #1}}             % italic font
2224
2225 % @acronym for "FBI", "NATO", and the like.
2226 % We print this one point size smaller, since it's intended for
2227 % all-uppercase.
2228 %
2229 \def\acronym#1{\doacronym #1,,\finish}
2230 \def\doacronym#1,#2,#3\finish{%
2231   {\selectfonts\lsize #1}%
2232   \def\temp{#2}%
2233   \ifx\temp\empty \else
2234     \space ({\unsepspaces \ignorespaces \temp \unskip})%
2235   \fi
2236 }
2237
2238 % @abbr for "Comput. J." and the like.
2239 % No font change, but don't do end-of-sentence spacing.
2240 %
2241 \def\abbr#1{\doabbr #1,,\finish}
2242 \def\doabbr#1,#2,#3\finish{%
2243   {\plainfrenchspacing #1}%
2244   \def\temp{#2}%
2245   \ifx\temp\empty \else
2246     \space ({\unsepspaces \ignorespaces \temp \unskip})%
2247   \fi
2248 }
2249
2250 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2251 %
2252 \def\pounds{{\it\$}}
2253
2254 % @euro{} comes from a separate font, depending on the current style.
2255 % We use the free feym* fonts from the eurosym package by Henrik
2256 % Theiling, which support regular, slanted, bold and bold slanted (and
2257 % "outlined" (blackboard board, sort of) versions, which we don't need).
2258 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2259 %
2260 % Although only regular is the truly official Euro symbol, we ignore
2261 % that.  The Euro is designed to be slightly taller than the regular
2262 % font height.
2263 %
2264 % feymr - regular
2265 % feymo - slanted
2266 % feybr - bold
2267 % feybo - bold slanted
2268 %
2269 % There is no good (free) typewriter version, to my knowledge.
2270 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2271 % Hmm.
2272 %
2273 % Also doesn't work in math.  Do we need to do math with euro symbols?
2274 % Hope not.
2275 %
2276 %
2277 \def\euro{{\eurofont e}}
2278 \def\eurofont{%
2279   % We set the font at each command, rather than predefining it in
2280   % \textfonts and the other font-switching commands, so that
2281   % installations which never need the symbol don't have to have the
2282   % font installed.
2283   %
2284   % There is only one designed size (nominal 10pt), so we always scale
2285   % that to the current nominal size.
2286   %
2287   % By the way, simply using "at 1em" works for cmr10 and the like, but
2288   % does not work for cmbx10 and other extended/shrunken fonts.
2289   %
2290   \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2291   %
2292   \ifx\curfontstyle\bfstylename
2293     % bold:
2294     \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2295   \else
2296     % regular:
2297     \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2298   \fi
2299   \thiseurofont
2300 }
2301
2302 % @registeredsymbol - R in a circle.  The font for the R should really
2303 % be smaller yet, but lllsize is the best we can do for now.
2304 % Adapted from the plain.tex definition of \copyright.
2305 %
2306 \def\registeredsymbol{%
2307   $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2308                \hfil\crcr\Orb}}%
2309     }$%
2310 }
2311
2312 % @textdegree - the normal degrees sign.
2313 %
2314 \def\textdegree{$^\circ$}
2315
2316 % Laurent Siebenmann reports \Orb undefined with:
2317 %  Textures 1.7.7 (preloaded format=plain 93.10.14)  (68K)  16 APR 2004 02:38
2318 % so we'll define it if necessary.
2319 %
2320 \ifx\Orb\undefined
2321 \def\Orb{\mathhexbox20D}
2322 \fi
2323
2324
2325 \message{page headings,}
2326
2327 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2328 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2329
2330 % First the title page.  Must do @settitle before @titlepage.
2331 \newif\ifseenauthor
2332 \newif\iffinishedtitlepage
2333
2334 % Do an implicit @contents or @shortcontents after @end titlepage if the
2335 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2336 %
2337 \newif\ifsetcontentsaftertitlepage
2338  \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2339 \newif\ifsetshortcontentsaftertitlepage
2340  \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2341
2342 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2343         \endgroup\page\hbox{}\page}
2344
2345 \envdef\titlepage{%
2346   % Open one extra group, as we want to close it in the middle of \Etitlepage.
2347   \begingroup
2348     \parindent=0pt \textfonts
2349     % Leave some space at the very top of the page.
2350     \vglue\titlepagetopglue
2351     % No rule at page bottom unless we print one at the top with @title.
2352     \finishedtitlepagetrue
2353     %
2354     % Most title ``pages'' are actually two pages long, with space
2355     % at the top of the second.  We don't want the ragged left on the second.
2356     \let\oldpage = \page
2357     \def\page{%
2358       \iffinishedtitlepage\else
2359          \finishtitlepage
2360       \fi
2361       \let\page = \oldpage
2362       \page
2363       \null
2364     }%
2365 }
2366
2367 \def\Etitlepage{%
2368     \iffinishedtitlepage\else
2369         \finishtitlepage
2370     \fi
2371     % It is important to do the page break before ending the group,
2372     % because the headline and footline are only empty inside the group.
2373     % If we use the new definition of \page, we always get a blank page
2374     % after the title page, which we certainly don't want.
2375     \oldpage
2376   \endgroup
2377   %
2378   % Need this before the \...aftertitlepage checks so that if they are
2379   % in effect the toc pages will come out with page numbers.
2380   \HEADINGSon
2381   %
2382   % If they want short, they certainly want long too.
2383   \ifsetshortcontentsaftertitlepage
2384     \shortcontents
2385     \contents
2386     \global\let\shortcontents = \relax
2387     \global\let\contents = \relax
2388   \fi
2389   %
2390   \ifsetcontentsaftertitlepage
2391     \contents
2392     \global\let\contents = \relax
2393     \global\let\shortcontents = \relax
2394   \fi
2395 }
2396
2397 \def\finishtitlepage{%
2398   \vskip4pt \hrule height 2pt width \hsize
2399   \vskip\titlepagebottomglue
2400   \finishedtitlepagetrue
2401 }
2402
2403 %%% Macros to be used within @titlepage:
2404
2405 \let\subtitlerm=\tenrm
2406 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2407
2408 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2409                 \let\tt=\authortt}
2410
2411 \parseargdef\title{%
2412   \checkenv\titlepage
2413   \leftline{\titlefonts\rm #1}
2414   % print a rule at the page bottom also.
2415   \finishedtitlepagefalse
2416   \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2417 }
2418
2419 \parseargdef\subtitle{%
2420   \checkenv\titlepage
2421   {\subtitlefont \rightline{#1}}%
2422 }
2423
2424 % @author should come last, but may come many times.
2425 % It can also be used inside @quotation.
2426 %
2427 \parseargdef\author{%
2428   \def\temp{\quotation}%
2429   \ifx\thisenv\temp
2430     \def\quotationauthor{#1}% printed in \Equotation.
2431   \else
2432     \checkenv\titlepage
2433     \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2434     {\authorfont \leftline{#1}}%
2435   \fi
2436 }
2437
2438
2439 %%% Set up page headings and footings.
2440
2441 \let\thispage=\folio
2442
2443 \newtoks\evenheadline    % headline on even pages
2444 \newtoks\oddheadline     % headline on odd pages
2445 \newtoks\evenfootline    % footline on even pages
2446 \newtoks\oddfootline     % footline on odd pages
2447
2448 % Now make TeX use those variables
2449 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2450                             \else \the\evenheadline \fi}}
2451 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2452                             \else \the\evenfootline \fi}\HEADINGShook}
2453 \let\HEADINGShook=\relax
2454
2455 % Commands to set those variables.
2456 % For example, this is what  @headings on  does
2457 % @evenheading @thistitle|@thispage|@thischapter
2458 % @oddheading @thischapter|@thispage|@thistitle
2459 % @evenfooting @thisfile||
2460 % @oddfooting ||@thisfile
2461
2462
2463 \def\evenheading{\parsearg\evenheadingxxx}
2464 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2465 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2466 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2467
2468 \def\oddheading{\parsearg\oddheadingxxx}
2469 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2470 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2471 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2472
2473 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2474
2475 \def\evenfooting{\parsearg\evenfootingxxx}
2476 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2477 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2478 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2479
2480 \def\oddfooting{\parsearg\oddfootingxxx}
2481 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2482 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2483   \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2484   %
2485   % Leave some space for the footline.  Hopefully ok to assume
2486   % @evenfooting will not be used by itself.
2487   \global\advance\pageheight by -12pt
2488   \global\advance\vsize by -12pt
2489 }
2490
2491 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2492
2493
2494 % @headings double      turns headings on for double-sided printing.
2495 % @headings single      turns headings on for single-sided printing.
2496 % @headings off         turns them off.
2497 % @headings on          same as @headings double, retained for compatibility.
2498 % @headings after       turns on double-sided headings after this page.
2499 % @headings doubleafter turns on double-sided headings after this page.
2500 % @headings singleafter turns on single-sided headings after this page.
2501 % By default, they are off at the start of a document,
2502 % and turned `on' after @end titlepage.
2503
2504 \def\headings #1 {\csname HEADINGS#1\endcsname}
2505
2506 \def\HEADINGSoff{%
2507 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2508 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2509 \HEADINGSoff
2510 % When we turn headings on, set the page number to 1.
2511 % For double-sided printing, put current file name in lower left corner,
2512 % chapter name on inside top of right hand pages, document
2513 % title on inside top of left hand pages, and page numbers on outside top
2514 % edge of all pages.
2515 \def\HEADINGSdouble{%
2516 \global\pageno=1
2517 \global\evenfootline={\hfil}
2518 \global\oddfootline={\hfil}
2519 \global\evenheadline={\line{\folio\hfil\thistitle}}
2520 \global\oddheadline={\line{\thischapter\hfil\folio}}
2521 \global\let\contentsalignmacro = \chapoddpage
2522 }
2523 \let\contentsalignmacro = \chappager
2524
2525 % For single-sided printing, chapter title goes across top left of page,
2526 % page number on top right.
2527 \def\HEADINGSsingle{%
2528 \global\pageno=1
2529 \global\evenfootline={\hfil}
2530 \global\oddfootline={\hfil}
2531 \global\evenheadline={\line{\thischapter\hfil\folio}}
2532 \global\oddheadline={\line{\thischapter\hfil\folio}}
2533 \global\let\contentsalignmacro = \chappager
2534 }
2535 \def\HEADINGSon{\HEADINGSdouble}
2536
2537 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2538 \let\HEADINGSdoubleafter=\HEADINGSafter
2539 \def\HEADINGSdoublex{%
2540 \global\evenfootline={\hfil}
2541 \global\oddfootline={\hfil}
2542 \global\evenheadline={\line{\folio\hfil\thistitle}}
2543 \global\oddheadline={\line{\thischapter\hfil\folio}}
2544 \global\let\contentsalignmacro = \chapoddpage
2545 }
2546
2547 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2548 \def\HEADINGSsinglex{%
2549 \global\evenfootline={\hfil}
2550 \global\oddfootline={\hfil}
2551 \global\evenheadline={\line{\thischapter\hfil\folio}}
2552 \global\oddheadline={\line{\thischapter\hfil\folio}}
2553 \global\let\contentsalignmacro = \chappager
2554 }
2555
2556 % Subroutines used in generating headings
2557 % This produces Day Month Year style of output.
2558 % Only define if not already defined, in case a txi-??.tex file has set
2559 % up a different format (e.g., txi-cs.tex does this).
2560 \ifx\today\undefined
2561 \def\today{%
2562   \number\day\space
2563   \ifcase\month
2564   \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2565   \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2566   \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2567   \fi
2568   \space\number\year}
2569 \fi
2570
2571 % @settitle line...  specifies the title of the document, for headings.
2572 % It generates no output of its own.
2573 \def\thistitle{\putwordNoTitle}
2574 \def\settitle{\parsearg{\gdef\thistitle}}
2575
2576
2577 \message{tables,}
2578 % Tables -- @table, @ftable, @vtable, @item(x).
2579
2580 % default indentation of table text
2581 \newdimen\tableindent \tableindent=.8in
2582 % default indentation of @itemize and @enumerate text
2583 \newdimen\itemindent  \itemindent=.3in
2584 % margin between end of table item and start of table text.
2585 \newdimen\itemmargin  \itemmargin=.1in
2586
2587 % used internally for \itemindent minus \itemmargin
2588 \newdimen\itemmax
2589
2590 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2591 % these defs.
2592 % They also define \itemindex
2593 % to index the item name in whatever manner is desired (perhaps none).
2594
2595 \newif\ifitemxneedsnegativevskip
2596
2597 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2598
2599 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2600 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2601
2602 \def\itemzzz #1{\begingroup %
2603   \advance\hsize by -\rightskip
2604   \advance\hsize by -\tableindent
2605   \setbox0=\hbox{\itemindicate{#1}}%
2606   \itemindex{#1}%
2607   \nobreak % This prevents a break before @itemx.
2608   %
2609   % If the item text does not fit in the space we have, put it on a line
2610   % by itself, and do not allow a page break either before or after that
2611   % line.  We do not start a paragraph here because then if the next
2612   % command is, e.g., @kindex, the whatsit would get put into the
2613   % horizontal list on a line by itself, resulting in extra blank space.
2614   \ifdim \wd0>\itemmax
2615     %
2616     % Make this a paragraph so we get the \parskip glue and wrapping,
2617     % but leave it ragged-right.
2618     \begingroup
2619       \advance\leftskip by-\tableindent
2620       \advance\hsize by\tableindent
2621       \advance\rightskip by0pt plus1fil
2622       \leavevmode\unhbox0\par
2623     \endgroup
2624     %
2625     % We're going to be starting a paragraph, but we don't want the
2626     % \parskip glue -- logically it's part of the @item we just started.
2627     \nobreak \vskip-\parskip
2628     %
2629     % Stop a page break at the \parskip glue coming up.  However, if
2630     % what follows is an environment such as @example, there will be no
2631     % \parskip glue; then the negative vskip we just inserted would
2632     % cause the example and the item to crash together.  So we use this
2633     % bizarre value of 10001 as a signal to \aboveenvbreak to insert
2634     % \parskip glue after all.  Section titles are handled this way also.
2635     %
2636     \penalty 10001
2637     \endgroup
2638     \itemxneedsnegativevskipfalse
2639   \else
2640     % The item text fits into the space.  Start a paragraph, so that the
2641     % following text (if any) will end up on the same line.
2642     \noindent
2643     % Do this with kerns and \unhbox so that if there is a footnote in
2644     % the item text, it can migrate to the main vertical list and
2645     % eventually be printed.
2646     \nobreak\kern-\tableindent
2647     \dimen0 = \itemmax  \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2648     \unhbox0
2649     \nobreak\kern\dimen0
2650     \endgroup
2651     \itemxneedsnegativevskiptrue
2652   \fi
2653 }
2654
2655 \def\item{\errmessage{@item while not in a list environment}}
2656 \def\itemx{\errmessage{@itemx while not in a list environment}}
2657
2658 % @table, @ftable, @vtable.
2659 \envdef\table{%
2660   \let\itemindex\gobble
2661   \tablecheck{table}%
2662 }
2663 \envdef\ftable{%
2664   \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2665   \tablecheck{ftable}%
2666 }
2667 \envdef\vtable{%
2668   \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2669   \tablecheck{vtable}%
2670 }
2671 \def\tablecheck#1{%
2672   \ifnum \the\catcode`\^^M=\active
2673     \endgroup
2674     \errmessage{This command won't work in this context; perhaps the problem is
2675       that we are \inenvironment\thisenv}%
2676     \def\next{\doignore{#1}}%
2677   \else
2678     \let\next\tablex
2679   \fi
2680   \next
2681 }
2682 \def\tablex#1{%
2683   \def\itemindicate{#1}%
2684   \parsearg\tabley
2685 }
2686 \def\tabley#1{%
2687   {%
2688     \makevalueexpandable
2689     \edef\temp{\noexpand\tablez #1\space\space\space}%
2690     \expandafter
2691   }\temp \endtablez
2692 }
2693 \def\tablez #1 #2 #3 #4\endtablez{%
2694   \aboveenvbreak
2695   \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2696   \ifnum 0#2>0 \tableindent=#2\mil \fi
2697   \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2698   \itemmax=\tableindent
2699   \advance \itemmax by -\itemmargin
2700   \advance \leftskip by \tableindent
2701   \exdentamount=\tableindent
2702   \parindent = 0pt
2703   \parskip = \smallskipamount
2704   \ifdim \parskip=0pt \parskip=2pt \fi
2705   \let\item = \internalBitem
2706   \let\itemx = \internalBitemx
2707 }
2708 \def\Etable{\endgraf\afterenvbreak}
2709 \let\Eftable\Etable
2710 \let\Evtable\Etable
2711 \let\Eitemize\Etable
2712 \let\Eenumerate\Etable
2713
2714 % This is the counter used by @enumerate, which is really @itemize
2715
2716 \newcount \itemno
2717
2718 \envdef\itemize{\parsearg\doitemize}
2719
2720 \def\doitemize#1{%
2721   \aboveenvbreak
2722   \itemmax=\itemindent
2723   \advance\itemmax by -\itemmargin
2724   \advance\leftskip by \itemindent
2725   \exdentamount=\itemindent
2726   \parindent=0pt
2727   \parskip=\smallskipamount
2728   \ifdim\parskip=0pt \parskip=2pt \fi
2729   \def\itemcontents{#1}%
2730   % @itemize with no arg is equivalent to @itemize @bullet.
2731   \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2732   \let\item=\itemizeitem
2733 }
2734
2735 % Definition of @item while inside @itemize and @enumerate.
2736 %
2737 \def\itemizeitem{%
2738   \advance\itemno by 1  % for enumerations
2739   {\let\par=\endgraf \smallbreak}% reasonable place to break
2740   {%
2741    % If the document has an @itemize directly after a section title, a
2742    % \nobreak will be last on the list, and \sectionheading will have
2743    % done a \vskip-\parskip.  In that case, we don't want to zero
2744    % parskip, or the item text will crash with the heading.  On the
2745    % other hand, when there is normal text preceding the item (as there
2746    % usually is), we do want to zero parskip, or there would be too much
2747    % space.  In that case, we won't have a \nobreak before.  At least
2748    % that's the theory.
2749    \ifnum\lastpenalty<10000 \parskip=0in \fi
2750    \noindent
2751    \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2752    \vadjust{\penalty 1200}}% not good to break after first line of item.
2753   \flushcr
2754 }
2755
2756 % \splitoff TOKENS\endmark defines \first to be the first token in
2757 % TOKENS, and \rest to be the remainder.
2758 %
2759 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2760
2761 % Allow an optional argument of an uppercase letter, lowercase letter,
2762 % or number, to specify the first label in the enumerated list.  No
2763 % argument is the same as `1'.
2764 %
2765 \envparseargdef\enumerate{\enumeratey #1  \endenumeratey}
2766 \def\enumeratey #1 #2\endenumeratey{%
2767   % If we were given no argument, pretend we were given `1'.
2768   \def\thearg{#1}%
2769   \ifx\thearg\empty \def\thearg{1}\fi
2770   %
2771   % Detect if the argument is a single token.  If so, it might be a
2772   % letter.  Otherwise, the only valid thing it can be is a number.
2773   % (We will always have one token, because of the test we just made.
2774   % This is a good thing, since \splitoff doesn't work given nothing at
2775   % all -- the first parameter is undelimited.)
2776   \expandafter\splitoff\thearg\endmark
2777   \ifx\rest\empty
2778     % Only one token in the argument.  It could still be anything.
2779     % A ``lowercase letter'' is one whose \lccode is nonzero.
2780     % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2781     %   not equal to itself.
2782     % Otherwise, we assume it's a number.
2783     %
2784     % We need the \relax at the end of the \ifnum lines to stop TeX from
2785     % continuing to look for a <number>.
2786     %
2787     \ifnum\lccode\expandafter`\thearg=0\relax
2788       \numericenumerate % a number (we hope)
2789     \else
2790       % It's a letter.
2791       \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2792         \lowercaseenumerate % lowercase letter
2793       \else
2794         \uppercaseenumerate % uppercase letter
2795       \fi
2796     \fi
2797   \else
2798     % Multiple tokens in the argument.  We hope it's a number.
2799     \numericenumerate
2800   \fi
2801 }
2802
2803 % An @enumerate whose labels are integers.  The starting integer is
2804 % given in \thearg.
2805 %
2806 \def\numericenumerate{%
2807   \itemno = \thearg
2808   \startenumeration{\the\itemno}%
2809 }
2810
2811 % The starting (lowercase) letter is in \thearg.
2812 \def\lowercaseenumerate{%
2813   \itemno = \expandafter`\thearg
2814   \startenumeration{%
2815     % Be sure we're not beyond the end of the alphabet.
2816     \ifnum\itemno=0
2817       \errmessage{No more lowercase letters in @enumerate; get a bigger
2818                   alphabet}%
2819     \fi
2820     \char\lccode\itemno
2821   }%
2822 }
2823
2824 % The starting (uppercase) letter is in \thearg.
2825 \def\uppercaseenumerate{%
2826   \itemno = \expandafter`\thearg
2827   \startenumeration{%
2828     % Be sure we're not beyond the end of the alphabet.
2829     \ifnum\itemno=0
2830       \errmessage{No more uppercase letters in @enumerate; get a bigger
2831                   alphabet}
2832     \fi
2833     \char\uccode\itemno
2834   }%
2835 }
2836
2837 % Call \doitemize, adding a period to the first argument and supplying the
2838 % common last two arguments.  Also subtract one from the initial value in
2839 % \itemno, since @item increments \itemno.
2840 %
2841 \def\startenumeration#1{%
2842   \advance\itemno by -1
2843   \doitemize{#1.}\flushcr
2844 }
2845
2846 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2847 % to @enumerate.
2848 %
2849 \def\alphaenumerate{\enumerate{a}}
2850 \def\capsenumerate{\enumerate{A}}
2851 \def\Ealphaenumerate{\Eenumerate}
2852 \def\Ecapsenumerate{\Eenumerate}
2853
2854
2855 % @multitable macros
2856 % Amy Hendrickson, 8/18/94, 3/6/96
2857 %
2858 % @multitable ... @end multitable will make as many columns as desired.
2859 % Contents of each column will wrap at width given in preamble.  Width
2860 % can be specified either with sample text given in a template line,
2861 % or in percent of \hsize, the current width of text on page.
2862
2863 % Table can continue over pages but will only break between lines.
2864
2865 % To make preamble:
2866 %
2867 % Either define widths of columns in terms of percent of \hsize:
2868 %   @multitable @columnfractions .25 .3 .45
2869 %   @item ...
2870 %
2871 %   Numbers following @columnfractions are the percent of the total
2872 %   current hsize to be used for each column. You may use as many
2873 %   columns as desired.
2874
2875
2876 % Or use a template:
2877 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2878 %   @item ...
2879 %   using the widest term desired in each column.
2880
2881 % Each new table line starts with @item, each subsequent new column
2882 % starts with @tab. Empty columns may be produced by supplying @tab's
2883 % with nothing between them for as many times as empty columns are needed,
2884 % ie, @tab@tab@tab will produce two empty columns.
2885
2886 % @item, @tab do not need to be on their own lines, but it will not hurt
2887 % if they are.
2888
2889 % Sample multitable:
2890
2891 %   @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2892 %   @item first col stuff @tab second col stuff @tab third col
2893 %   @item
2894 %   first col stuff
2895 %   @tab
2896 %   second col stuff
2897 %   @tab
2898 %   third col
2899 %   @item first col stuff @tab second col stuff
2900 %   @tab Many paragraphs of text may be used in any column.
2901 %
2902 %         They will wrap at the width determined by the template.
2903 %   @item@tab@tab This will be in third column.
2904 %   @end multitable
2905
2906 % Default dimensions may be reset by user.
2907 % @multitableparskip is vertical space between paragraphs in table.
2908 % @multitableparindent is paragraph indent in table.
2909 % @multitablecolmargin is horizontal space to be left between columns.
2910 % @multitablelinespace is space to leave between table items, baseline
2911 %                                                            to baseline.
2912 %   0pt means it depends on current normal line spacing.
2913 %
2914 \newskip\multitableparskip
2915 \newskip\multitableparindent
2916 \newdimen\multitablecolspace
2917 \newskip\multitablelinespace
2918 \multitableparskip=0pt
2919 \multitableparindent=6pt
2920 \multitablecolspace=12pt
2921 \multitablelinespace=0pt
2922
2923 % Macros used to set up halign preamble:
2924 %
2925 \let\endsetuptable\relax
2926 \def\xendsetuptable{\endsetuptable}
2927 \let\columnfractions\relax
2928 \def\xcolumnfractions{\columnfractions}
2929 \newif\ifsetpercent
2930
2931 % #1 is the @columnfraction, usually a decimal number like .5, but might
2932 % be just 1.  We just use it, whatever it is.
2933 %
2934 \def\pickupwholefraction#1 {%
2935   \global\advance\colcount by 1
2936   \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2937   \setuptable
2938 }
2939
2940 \newcount\colcount
2941 \def\setuptable#1{%
2942   \def\firstarg{#1}%
2943   \ifx\firstarg\xendsetuptable
2944     \let\go = \relax
2945   \else
2946     \ifx\firstarg\xcolumnfractions
2947       \global\setpercenttrue
2948     \else
2949       \ifsetpercent
2950          \let\go\pickupwholefraction
2951       \else
2952          \global\advance\colcount by 1
2953          \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2954                    % separator; typically that is always in the input, anyway.
2955          \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2956       \fi
2957     \fi
2958     \ifx\go\pickupwholefraction
2959       % Put the argument back for the \pickupwholefraction call, so
2960       % we'll always have a period there to be parsed.
2961       \def\go{\pickupwholefraction#1}%
2962     \else
2963       \let\go = \setuptable
2964     \fi%
2965   \fi
2966   \go
2967 }
2968
2969 % multitable-only commands.
2970 %
2971 % @headitem starts a heading row, which we typeset in bold.
2972 % Assignments have to be global since we are inside the implicit group
2973 % of an alignment entry.  Note that \everycr resets \everytab.
2974 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
2975 %
2976 % A \tab used to include \hskip1sp.  But then the space in a template
2977 % line is not enough.  That is bad.  So let's go back to just `&' until
2978 % we encounter the problem it was intended to solve again.
2979 %                                       --karl, nathan@acm.org, 20apr99.
2980 \def\tab{\checkenv\multitable &\the\everytab}%
2981
2982 % @multitable ... @end multitable definitions:
2983 %
2984 \newtoks\everytab  % insert after every tab.
2985 %
2986 \envdef\multitable{%
2987   \vskip\parskip
2988   \startsavinginserts
2989   %
2990   % @item within a multitable starts a normal row.
2991   % We use \def instead of \let so that if one of the multitable entries
2992   % contains an @itemize, we don't choke on the \item (seen as \crcr aka
2993   % \endtemplate) expanding \doitemize.
2994   \def\item{\crcr}%
2995   %
2996   \tolerance=9500
2997   \hbadness=9500
2998   \setmultitablespacing
2999   \parskip=\multitableparskip
3000   \parindent=\multitableparindent
3001   \overfullrule=0pt
3002   \global\colcount=0
3003   %
3004   \everycr = {%
3005     \noalign{%
3006       \global\everytab={}%
3007       \global\colcount=0 % Reset the column counter.
3008       % Check for saved footnotes, etc.
3009       \checkinserts
3010       % Keeps underfull box messages off when table breaks over pages.
3011       %\filbreak
3012         % Maybe so, but it also creates really weird page breaks when the
3013         % table breaks over pages. Wouldn't \vfil be better?  Wait until the
3014         % problem manifests itself, so it can be fixed for real --karl.
3015     }%
3016   }%
3017   %
3018   \parsearg\domultitable
3019 }
3020 \def\domultitable#1{%
3021   % To parse everything between @multitable and @item:
3022   \setuptable#1 \endsetuptable
3023   %
3024   % This preamble sets up a generic column definition, which will
3025   % be used as many times as user calls for columns.
3026   % \vtop will set a single line and will also let text wrap and
3027   % continue for many paragraphs if desired.
3028   \halign\bgroup &%
3029     \global\advance\colcount by 1
3030     \multistrut
3031     \vtop{%
3032       % Use the current \colcount to find the correct column width:
3033       \hsize=\expandafter\csname col\the\colcount\endcsname
3034       %
3035       % In order to keep entries from bumping into each other
3036       % we will add a \leftskip of \multitablecolspace to all columns after
3037       % the first one.
3038       %
3039       % If a template has been used, we will add \multitablecolspace
3040       % to the width of each template entry.
3041       %
3042       % If the user has set preamble in terms of percent of \hsize we will
3043       % use that dimension as the width of the column, and the \leftskip
3044       % will keep entries from bumping into each other.  Table will start at
3045       % left margin and final column will justify at right margin.
3046       %
3047       % Make sure we don't inherit \rightskip from the outer environment.
3048       \rightskip=0pt
3049       \ifnum\colcount=1
3050         % The first column will be indented with the surrounding text.
3051         \advance\hsize by\leftskip
3052       \else
3053         \ifsetpercent \else
3054           % If user has not set preamble in terms of percent of \hsize
3055           % we will advance \hsize by \multitablecolspace.
3056           \advance\hsize by \multitablecolspace
3057         \fi
3058        % In either case we will make \leftskip=\multitablecolspace:
3059       \leftskip=\multitablecolspace
3060       \fi
3061       % Ignoring space at the beginning and end avoids an occasional spurious
3062       % blank line, when TeX decides to break the line at the space before the
3063       % box from the multistrut, so the strut ends up on a line by itself.
3064       % For example:
3065       % @multitable @columnfractions .11 .89
3066       % @item @code{#}
3067       % @tab Legal holiday which is valid in major parts of the whole country.
3068       % Is automatically provided with highlighting sequences respectively
3069       % marking characters.
3070       \noindent\ignorespaces##\unskip\multistrut
3071     }\cr
3072 }
3073 \def\Emultitable{%
3074   \crcr
3075   \egroup % end the \halign
3076   \global\setpercentfalse
3077 }
3078
3079 \def\setmultitablespacing{%
3080   \def\multistrut{\strut}% just use the standard line spacing
3081   %
3082   % Compute \multitablelinespace (if not defined by user) for use in
3083   % \multitableparskip calculation.  We used define \multistrut based on
3084   % this, but (ironically) that caused the spacing to be off.
3085   % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3086 \ifdim\multitablelinespace=0pt
3087 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3088 \global\advance\multitablelinespace by-\ht0
3089 \fi
3090 %% Test to see if parskip is larger than space between lines of
3091 %% table. If not, do nothing.
3092 %%        If so, set to same dimension as multitablelinespace.
3093 \ifdim\multitableparskip>\multitablelinespace
3094 \global\multitableparskip=\multitablelinespace
3095 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3096                                       %% than skip between lines in the table.
3097 \fi%
3098 \ifdim\multitableparskip=0pt
3099 \global\multitableparskip=\multitablelinespace
3100 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3101                                       %% than skip between lines in the table.
3102 \fi}
3103
3104
3105 \message{conditionals,}
3106
3107 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3108 % @ifnotxml always succeed.  They currently do nothing; we don't
3109 % attempt to check whether the conditionals are properly nested.  But we
3110 % have to remember that they are conditionals, so that @end doesn't
3111 % attempt to close an environment group.
3112 %
3113 \def\makecond#1{%
3114   \expandafter\let\csname #1\endcsname = \relax
3115   \expandafter\let\csname iscond.#1\endcsname = 1
3116 }
3117 \makecond{iftex}
3118 \makecond{ifnotdocbook}
3119 \makecond{ifnothtml}
3120 \makecond{ifnotinfo}
3121 \makecond{ifnotplaintext}
3122 \makecond{ifnotxml}
3123
3124 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3125 %
3126 \def\direntry{\doignore{direntry}}
3127 \def\documentdescription{\doignore{documentdescription}}
3128 \def\docbook{\doignore{docbook}}
3129 \def\html{\doignore{html}}
3130 \def\ifdocbook{\doignore{ifdocbook}}
3131 \def\ifhtml{\doignore{ifhtml}}
3132 \def\ifinfo{\doignore{ifinfo}}
3133 \def\ifnottex{\doignore{ifnottex}}
3134 \def\ifplaintext{\doignore{ifplaintext}}
3135 \def\ifxml{\doignore{ifxml}}
3136 \def\ignore{\doignore{ignore}}
3137 \def\menu{\doignore{menu}}
3138 \def\xml{\doignore{xml}}
3139
3140 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3141 %
3142 % A count to remember the depth of nesting.
3143 \newcount\doignorecount
3144
3145 \def\doignore#1{\begingroup
3146   % Scan in ``verbatim'' mode:
3147   \obeylines
3148   \catcode`\@ = \other
3149   \catcode`\{ = \other
3150   \catcode`\} = \other
3151   %
3152   % Make sure that spaces turn into tokens that match what \doignoretext wants.
3153   \spaceisspace
3154   %
3155   % Count number of #1's that we've seen.
3156   \doignorecount = 0
3157   %
3158   % Swallow text until we reach the matching `@end #1'.
3159   \dodoignore{#1}%
3160 }
3161
3162 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3163   \obeylines %
3164   %
3165   \gdef\dodoignore#1{%
3166     % #1 contains the command name as a string, e.g., `ifinfo'.
3167     %
3168     % Define a command to find the next `@end #1'.
3169     \long\def\doignoretext##1^^M@end #1{%
3170       \doignoretextyyy##1^^M@#1\_STOP_}%
3171     %
3172     % And this command to find another #1 command, at the beginning of a
3173     % line.  (Otherwise, we would consider a line `@c @ifset', for
3174     % example, to count as an @ifset for nesting.)
3175     \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3176     %
3177     % And now expand that command.
3178     \doignoretext ^^M%
3179   }%
3180 }
3181
3182 \def\doignoreyyy#1{%
3183   \def\temp{#1}%
3184   \ifx\temp\empty                       % Nothing found.
3185     \let\next\doignoretextzzz
3186   \else                                 % Found a nested condition, ...
3187     \advance\doignorecount by 1
3188     \let\next\doignoretextyyy           % ..., look for another.
3189     % If we're here, #1 ends with ^^M\ifinfo (for example).
3190   \fi
3191   \next #1% the token \_STOP_ is present just after this macro.
3192 }
3193
3194 % We have to swallow the remaining "\_STOP_".
3195 %
3196 \def\doignoretextzzz#1{%
3197   \ifnum\doignorecount = 0      % We have just found the outermost @end.
3198     \let\next\enddoignore
3199   \else                         % Still inside a nested condition.
3200     \advance\doignorecount by -1
3201     \let\next\doignoretext      % Look for the next @end.
3202   \fi
3203   \next
3204 }
3205
3206 % Finish off ignored text.
3207 { \obeylines%
3208   % Ignore anything after the last `@end #1'; this matters in verbatim
3209   % environments, where otherwise the newline after an ignored conditional
3210   % would result in a blank line in the output.
3211   \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3212 }
3213
3214
3215 % @set VAR sets the variable VAR to an empty value.
3216 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3217 %
3218 % Since we want to separate VAR from REST-OF-LINE (which might be
3219 % empty), we can't just use \parsearg; we have to insert a space of our
3220 % own to delimit the rest of the line, and then take it out again if we
3221 % didn't need it.
3222 % We rely on the fact that \parsearg sets \catcode`\ =10.
3223 %
3224 \parseargdef\set{\setyyy#1 \endsetyyy}
3225 \def\setyyy#1 #2\endsetyyy{%
3226   {%
3227     \makevalueexpandable
3228     \def\temp{#2}%
3229     \edef\next{\gdef\makecsname{SET#1}}%
3230     \ifx\temp\empty
3231       \next{}%
3232     \else
3233       \setzzz#2\endsetzzz
3234     \fi
3235   }%
3236 }
3237 % Remove the trailing space \setxxx inserted.
3238 \def\setzzz#1 \endsetzzz{\next{#1}}
3239
3240 % @clear VAR clears (i.e., unsets) the variable VAR.
3241 %
3242 \parseargdef\clear{%
3243   {%
3244     \makevalueexpandable
3245     \global\expandafter\let\csname SET#1\endcsname=\relax
3246   }%
3247 }
3248
3249 % @value{foo} gets the text saved in variable foo.
3250 \def\value{\begingroup\makevalueexpandable\valuexxx}
3251 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3252 {
3253   \catcode`\- = \active \catcode`\_ = \active
3254   %
3255   \gdef\makevalueexpandable{%
3256     \let\value = \expandablevalue
3257     % We don't want these characters active, ...
3258     \catcode`\-=\other \catcode`\_=\other
3259     % ..., but we might end up with active ones in the argument if
3260     % we're called from @code, as @code{@value{foo-bar_}}, though.
3261     % So \let them to their normal equivalents.
3262     \let-\realdash \let_\normalunderscore
3263   }
3264 }
3265
3266 % We have this subroutine so that we can handle at least some @value's
3267 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3268 % The command has to be fully expandable (if the variable is set), since
3269 % the result winds up in the index file.  This means that if the
3270 % variable's value contains other Texinfo commands, it's almost certain
3271 % it will fail (although perhaps we could fix that with sufficient work
3272 % to do a one-level expansion on the result, instead of complete).
3273 %
3274 \def\expandablevalue#1{%
3275   \expandafter\ifx\csname SET#1\endcsname\relax
3276     {[No value for ``#1'']}%
3277     \message{Variable `#1', used in @value, is not set.}%
3278   \else
3279     \csname SET#1\endcsname
3280   \fi
3281 }
3282
3283 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3284 % with @set.
3285 %
3286 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3287 %
3288 \makecond{ifset}
3289 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3290 \def\doifset#1#2{%
3291   {%
3292     \makevalueexpandable
3293     \let\next=\empty
3294     \expandafter\ifx\csname SET#2\endcsname\relax
3295       #1% If not set, redefine \next.
3296     \fi
3297     \expandafter
3298   }\next
3299 }
3300 \def\ifsetfail{\doignore{ifset}}
3301
3302 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3303 % defined with @set, or has been undefined with @clear.
3304 %
3305 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3306 % above code: if the variable is not set, do nothing, if it is set,
3307 % then redefine \next to \ifclearfail.
3308 %
3309 \makecond{ifclear}
3310 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3311 \def\ifclearfail{\doignore{ifclear}}
3312
3313 % @dircategory CATEGORY  -- specify a category of the dir file
3314 % which this file should belong to.  Ignore this in TeX.
3315 \let\dircategory=\comment
3316
3317 % @defininfoenclose.
3318 \let\definfoenclose=\comment
3319
3320
3321 \message{indexing,}
3322 % Index generation facilities
3323
3324 % Define \newwrite to be identical to plain tex's \newwrite
3325 % except not \outer, so it can be used within macros and \if's.
3326 \edef\newwrite{\makecsname{ptexnewwrite}}
3327
3328 % \newindex {foo} defines an index named foo.
3329 % It automatically defines \fooindex such that
3330 % \fooindex ...rest of line... puts an entry in the index foo.
3331 % It also defines \fooindfile to be the number of the output channel for
3332 % the file that accumulates this index.  The file's extension is foo.
3333 % The name of an index should be no more than 2 characters long
3334 % for the sake of vms.
3335 %
3336 \def\newindex#1{%
3337   \iflinks
3338     \expandafter\newwrite \csname#1indfile\endcsname
3339     \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3340   \fi
3341   \expandafter\xdef\csname#1index\endcsname{%     % Define @#1index
3342     \noexpand\doindex{#1}}
3343 }
3344
3345 % @defindex foo  ==  \newindex{foo}
3346 %
3347 \def\defindex{\parsearg\newindex}
3348
3349 % Define @defcodeindex, like @defindex except put all entries in @code.
3350 %
3351 \def\defcodeindex{\parsearg\newcodeindex}
3352 %
3353 \def\newcodeindex#1{%
3354   \iflinks
3355     \expandafter\newwrite \csname#1indfile\endcsname
3356     \openout \csname#1indfile\endcsname \jobname.#1
3357   \fi
3358   \expandafter\xdef\csname#1index\endcsname{%
3359     \noexpand\docodeindex{#1}}%
3360 }
3361
3362
3363 % @synindex foo bar    makes index foo feed into index bar.
3364 % Do this instead of @defindex foo if you don't want it as a separate index.
3365 %
3366 % @syncodeindex foo bar   similar, but put all entries made for index foo
3367 % inside @code.
3368 %
3369 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3370 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3371
3372 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3373 % #3 the target index (bar).
3374 \def\dosynindex#1#2#3{%
3375   % Only do \closeout if we haven't already done it, else we'll end up
3376   % closing the target index.
3377   \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3378     % The \closeout helps reduce unnecessary open files; the limit on the
3379     % Acorn RISC OS is a mere 16 files.
3380     \expandafter\closeout\csname#2indfile\endcsname
3381     \expandafter\let\csname\donesynindex#2\endcsname = 1
3382   \fi
3383   % redefine \fooindfile:
3384   \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3385   \expandafter\let\csname#2indfile\endcsname=\temp
3386   % redefine \fooindex:
3387   \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3388 }
3389
3390 % Define \doindex, the driver for all \fooindex macros.
3391 % Argument #1 is generated by the calling \fooindex macro,
3392 %  and it is "foo", the name of the index.
3393
3394 % \doindex just uses \parsearg; it calls \doind for the actual work.
3395 % This is because \doind is more useful to call from other macros.
3396
3397 % There is also \dosubind {index}{topic}{subtopic}
3398 % which makes an entry in a two-level index such as the operation index.
3399
3400 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3401 \def\singleindexer #1{\doind{\indexname}{#1}}
3402
3403 % like the previous two, but they put @code around the argument.
3404 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3405 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3406
3407 % Take care of Texinfo commands that can appear in an index entry.
3408 % Since there are some commands we want to expand, and others we don't,
3409 % we have to laboriously prevent expansion for those that we don't.
3410 %
3411 \def\indexdummies{%
3412   \escapechar = `\\     % use backslash in output files.
3413   \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3414   \def\ {\realbackslash\space }%
3415   %
3416   % Need these in case \tex is in effect and \{ is a \delimiter again.
3417   % But can't use \lbracecmd and \rbracecmd because texindex assumes
3418   % braces and backslashes are used only as delimiters.
3419   \let\{ = \mylbrace
3420   \let\} = \myrbrace
3421   %
3422   % I don't entirely understand this, but when an index entry is
3423   % generated from a macro call, the \endinput which \scanmacro inserts
3424   % causes processing to be prematurely terminated.  This is,
3425   % apparently, because \indexsorttmp is fully expanded, and \endinput
3426   % is an expandable command.  The redefinition below makes \endinput
3427   % disappear altogether for that purpose -- although logging shows that
3428   % processing continues to some further point.  On the other hand, it
3429   % seems \endinput does not hurt in the printed index arg, since that
3430   % is still getting written without apparent harm.
3431   %
3432   % Sample source (mac-idx3.tex, reported by Graham Percival to
3433   % help-texinfo, 22may06):
3434   % @macro funindex {WORD}
3435   % @findex xyz
3436   % @end macro
3437   % ...
3438   % @funindex commtest
3439   %
3440   % The above is not enough to reproduce the bug, but it gives the flavor.
3441   %
3442   % Sample whatsit resulting:
3443   % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
3444   %
3445   % So:
3446   \let\endinput = \empty
3447   %
3448   % Do the redefinitions.
3449   \commondummies
3450 }
3451
3452 % For the aux and toc files, @ is the escape character.  So we want to
3453 % redefine everything using @ as the escape character (instead of
3454 % \realbackslash, still used for index files).  When everything uses @,
3455 % this will be simpler.
3456 %
3457 \def\atdummies{%
3458   \def\@{@@}%
3459   \def\ {@ }%
3460   \let\{ = \lbraceatcmd
3461   \let\} = \rbraceatcmd
3462   %
3463   % Do the redefinitions.
3464   \commondummies
3465   \otherbackslash
3466 }
3467
3468 % Called from \indexdummies and \atdummies.
3469 %
3470 \def\commondummies{%
3471   %
3472   % \definedummyword defines \#1 as \string\#1\space, thus effectively
3473   % preventing its expansion.  This is used only for control% words,
3474   % not control letters, because the \space would be incorrect for
3475   % control characters, but is needed to separate the control word
3476   % from whatever follows.
3477   %
3478   % For control letters, we have \definedummyletter, which omits the
3479   % space.
3480   %
3481   % These can be used both for control words that take an argument and
3482   % those that do not.  If it is followed by {arg} in the input, then
3483   % that will dutifully get written to the index (or wherever).
3484   %
3485   \def\definedummyword  ##1{\def##1{\string##1\space}}%
3486   \def\definedummyletter##1{\def##1{\string##1}}%
3487   \let\definedummyaccent\definedummyletter
3488   %
3489   \commondummiesnofonts
3490   %
3491   \definedummyletter\_%
3492   %
3493   % Non-English letters.
3494   \definedummyword\AA
3495   \definedummyword\AE
3496   \definedummyword\L
3497   \definedummyword\OE
3498   \definedummyword\O
3499   \definedummyword\aa
3500   \definedummyword\ae
3501   \definedummyword\l
3502   \definedummyword\oe
3503   \definedummyword\o
3504   \definedummyword\ss
3505   \definedummyword\exclamdown
3506   \definedummyword\questiondown
3507   \definedummyword\ordf
3508   \definedummyword\ordm
3509   %
3510   % Although these internal commands shouldn't show up, sometimes they do.
3511   \definedummyword\bf
3512   \definedummyword\gtr
3513   \definedummyword\hat
3514   \definedummyword\less
3515   \definedummyword\sf
3516   \definedummyword\sl
3517   \definedummyword\tclose
3518   \definedummyword\tt
3519   %
3520   \definedummyword\LaTeX
3521   \definedummyword\TeX
3522   %
3523   % Assorted special characters.
3524   \definedummyword\bullet
3525   \definedummyword\comma
3526   \definedummyword\copyright
3527   \definedummyword\registeredsymbol
3528   \definedummyword\dots
3529   \definedummyword\enddots
3530   \definedummyword\equiv
3531   \definedummyword\error
3532   \definedummyword\euro
3533   \definedummyword\expansion
3534   \definedummyword\minus
3535   \definedummyword\pounds
3536   \definedummyword\point
3537   \definedummyword\print
3538   \definedummyword\result
3539   \definedummyword\textdegree
3540   %
3541   % We want to disable all macros so that they are not expanded by \write.
3542   \macrolist
3543   %
3544   \normalturnoffactive
3545   %
3546   % Handle some cases of @value -- where it does not contain any
3547   % (non-fully-expandable) commands.
3548   \makevalueexpandable
3549 }
3550
3551 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3552 %
3553 \def\commondummiesnofonts{%
3554   % Control letters and accents.
3555   \definedummyletter\!%
3556   \definedummyaccent\"%
3557   \definedummyaccent\'%
3558   \definedummyletter\*%
3559   \definedummyaccent\,%
3560   \definedummyletter\.%
3561   \definedummyletter\/%
3562   \definedummyletter\:%
3563   \definedummyaccent\=%
3564   \definedummyletter\?%
3565   \definedummyaccent\^%
3566   \definedummyaccent\`%
3567   \definedummyaccent\~%
3568   \definedummyword\u
3569   \definedummyword\v
3570   \definedummyword\H
3571   \definedummyword\dotaccent
3572   \definedummyword\ringaccent
3573   \definedummyword\tieaccent
3574   \definedummyword\ubaraccent
3575   \definedummyword\udotaccent
3576   \definedummyword\dotless
3577   %
3578   % Texinfo font commands.
3579   \definedummyword\b
3580   \definedummyword\i
3581   \definedummyword\r
3582   \definedummyword\sc
3583   \definedummyword\t
3584   %
3585   % Commands that take arguments.
3586   \definedummyword\acronym
3587   \definedummyword\cite
3588   \definedummyword\code
3589   \definedummyword\command
3590   \definedummyword\dfn
3591   \definedummyword\emph
3592   \definedummyword\env
3593   \definedummyword\file
3594   \definedummyword\kbd
3595   \definedummyword\key
3596   \definedummyword\math
3597   \definedummyword\option
3598   \definedummyword\pxref
3599   \definedummyword\ref
3600   \definedummyword\samp
3601   \definedummyword\strong
3602   \definedummyword\tie
3603   \definedummyword\uref
3604   \definedummyword\url
3605   \definedummyword\var
3606   \definedummyword\verb
3607   \definedummyword\w
3608   \definedummyword\xref
3609 }
3610
3611 % \indexnofonts is used when outputting the strings to sort the index
3612 % by, and when constructing control sequence names.  It eliminates all
3613 % control sequences and just writes whatever the best ASCII sort string
3614 % would be for a given command (usually its argument).
3615 %
3616 \def\indexnofonts{%
3617   % Accent commands should become @asis.
3618   \def\definedummyaccent##1{\let##1\asis}%
3619   % We can just ignore other control letters.
3620   \def\definedummyletter##1{\let##1\empty}%
3621   % Hopefully, all control words can become @asis.
3622   \let\definedummyword\definedummyaccent
3623   %
3624   \commondummiesnofonts
3625   %
3626   % Don't no-op \tt, since it isn't a user-level command
3627   % and is used in the definitions of the active chars like <, >, |, etc.
3628   % Likewise with the other plain tex font commands.
3629   %\let\tt=\asis
3630   %
3631   \def\ { }%
3632   \def\@{@}%
3633   % how to handle braces?
3634   \def\_{\normalunderscore}%
3635   %
3636   % Non-English letters.
3637   \def\AA{AA}%
3638   \def\AE{AE}%
3639   \def\L{L}%
3640   \def\OE{OE}%
3641   \def\O{O}%
3642   \def\aa{aa}%
3643   \def\ae{ae}%
3644   \def\l{l}%
3645   \def\oe{oe}%
3646   \def\o{o}%
3647   \def\ss{ss}%
3648   \def\exclamdown{!}%
3649   \def\questiondown{?}%
3650   \def\ordf{a}%
3651   \def\ordm{o}%
3652   %
3653   \def\LaTeX{LaTeX}%
3654   \def\TeX{TeX}%
3655   %
3656   % Assorted special characters.
3657   % (The following {} will end up in the sort string, but that's ok.)
3658   \def\bullet{bullet}%
3659   \def\comma{,}%
3660   \def\copyright{copyright}%
3661   \def\registeredsymbol{R}%
3662   \def\dots{...}%
3663   \def\enddots{...}%
3664   \def\equiv{==}%
3665   \def\error{error}%
3666   \def\euro{euro}%
3667   \def\expansion{==>}%
3668   \def\minus{-}%
3669   \def\pounds{pounds}%
3670   \def\point{.}%
3671   \def\print{-|}%
3672   \def\result{=>}%
3673   \def\textdegree{degrees}%
3674   %
3675   % We need to get rid of all macros, leaving only the arguments (if present).
3676   % Of course this is not nearly correct, but it is the best we can do for now.
3677   % makeinfo does not expand macros in the argument to @deffn, which ends up
3678   % writing an index entry, and texindex isn't prepared for an index sort entry
3679   % that starts with \.
3680   %
3681   % Since macro invocations are followed by braces, we can just redefine them
3682   % to take a single TeX argument.  The case of a macro invocation that
3683   % goes to end-of-line is not handled.
3684   %
3685   \macrolist
3686 }
3687
3688 \let\indexbackslash=0  %overridden during \printindex.
3689 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3690
3691 % Most index entries go through here, but \dosubind is the general case.
3692 % #1 is the index name, #2 is the entry text.
3693 \def\doind#1#2{\dosubind{#1}{#2}{}}
3694