1 % texinfo.tex -- TeX macros to handle Texinfo files.
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
6 \def\texinfoversion{2007-03-14.11}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007 Free Software Foundation, Inc.
12 % This texinfo.tex file is free software; you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation; either version 2, or (at
15 % your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this 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.
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.)
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.
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.
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:
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.
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.
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
62 \message{Loading texinfo [version \texinfoversion]:}
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}
73 % We never want plain's \outer definition of \+ in Texinfo.
74 % For @tex, we can use \tabalign.
77 % Save some plain tex macros whose names we will redefine.
79 \let\ptexbullet=\bullet
87 \let\ptexfootnote=\footnote
91 \let\ptexindent=\indent
92 \let\ptexinsert=\insert
95 \let\ptexnewwrite\newwrite
96 \let\ptexnoindent=\noindent
103 % If this character appears in an error message or help string, it
104 % starts a new line in the output.
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.
110 \ifx\inputlineno\thisisundefined
111 \let\linenumber = \empty % Pre-3.0.
113 \def\linenumber{l.\the\inputlineno:\space}
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
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
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
156 % Since the category of space is not known, we have to be careful.
157 \chardef\spacecat = 10
158 \def\spaceisspace{\catcode`\ =\spacecat}
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 = `\_
176 % The following is used inside several \edef's.
177 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
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
187 stand-alone strong-est time-stamp time-stamps which-ever white-space
188 wide-spread wrap-around
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
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).
200 \def\finalout{\overfullrule=0pt}
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).
209 % \vadjust can only be used in horizontal mode.
212 % Append this vertical mode material after the current line in the output.
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.
218 % \vadjust-items are inserted at the left edge of the type. So
219 % the \llap here moves out into the left-hand margin.
222 % For a thicker or thinner bar, change the `1pt'.
223 \vrule height\baselineskip width1pt
225 % This is the space between the bar and the text.
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.
237 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
241 \tracinglostchars2 % 2 gives us more in etex
246 \showboxbreadth\maxdimen \showboxdepth\maxdimen
247 \ifx\eTeXversion\undefined\else % etex gives us more logging
254 \tracingcommands3 % 3 gives us more in etex
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.
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}
268 % For @cropmarks command.
269 % Do @cropmarks to get crop marks.
272 \let\cropmarks = \cropmarkstrue
274 % Dimensions to add cropmarks at corners.
275 % Added by P. A. MacKay, 12 Nov. 1986
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
282 % Main output routine.
284 \output = {\onepageout{\pagecontents\PAGE}}
289 % \onepageout takes a vbox as an argument. Note that \pagecontents
290 % does insertions, but you have to call it yourself.
292 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
294 \ifodd\pageno \advance\hoffset by \bindingoffset
295 \else \advance\hoffset by -\bindingoffset\fi
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}%
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.
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;
314 % {\code {{\tt \backslashcurfont }acronym}
316 % Do this early so pdf references go to the beginning of the page.
317 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
319 \ifcropmarks \vbox to \outervsize\bgroup
321 \vskip-\topandbottommargin
323 \line{\ewtop\hfil\ewtop}%
326 \vbox{\moveleft\cornerthick\nstop}%
328 \vbox{\moveright\cornerthick\nstop}%
331 \vskip\topandbottommargin
333 \hfil % center the page within the outer (page) hsize.
334 \ifodd\pageno\hskip\bindingoffset\fi
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.
349 \egroup % end of \vbox\bgroup
350 \hfil\egroup % end of (centering) \line\bgroup
351 \vskip\topandbottommargin plus1fill minus1fill
352 \boxmaxdepth = \cornerthick
355 \vbox{\moveleft\cornerthick\nsbot}%
357 \vbox{\moveright\cornerthick\nsbot}%
360 \line{\ewbot\hfil\ewbot}%
362 \egroup % \vbox from first cropmarks clause
364 }% end of \shipout\vbox
365 }% end of group with \indexdummies
367 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
370 \newinsert\margin \dimen\margin=\maxdimen
372 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
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}
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)
387 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
389 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
390 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
392 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
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.
398 \def\parsearg{\parseargusing{}}
399 \def\parseargusing#1#2{%
405 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
409 \gdef\parseargline#1^^M{%
410 \endgroup % End of the group started in \parsearg.
411 \argremovecomment #1\comment\ArgTerm%
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}
419 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
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.
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{%
431 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
432 \let\temp\finishparsearg
434 \let\temp\argcheckspaces
436 % Put the space token in:
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.
448 % But first, we have to remove the trailing space token.
450 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
452 % \parseargdef\foo{...}
453 % is roughly equivalent to
454 % \def\foo{\parsearg\Xfoo}
457 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
458 % favourite TeX trick. --kasal, 16nov03
461 \expandafter \doparseargdef \csname\string#1\endcsname #1%
463 \def\doparseargdef#1#2{%
468 % Several utility definitions with active space:
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.
478 \gdef\sepspaces{\obeyspaces\let =\tie}
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}
487 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
489 % Define the framework for environments in texinfo.tex. It's used like this:
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.
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
506 % At runtime, environments start with this:
507 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
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}}
515 % Check whether we're in the right environment:
524 % Evironment mismatch, #1 expected:
527 \errmessage{This command can appear only \inenvironment\temp,
528 not \inenvironment\thisenv}%
530 \def\inenvironment#1{%
532 out of any environment%
534 in environment \expandafter\string#1%
538 % @end foo executes the definition of \Efoo.
539 % But first, it executes a specialized version of \checkenv
542 \if 1\csname iscond.#1\endcsname
544 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
545 \expandafter\checkenv\csname#1\endcsname
546 \csname E#1\endcsname
551 \newhelp\EMsimple{Press RETURN to continue.}
554 %% Simple single-character @ commands
557 % Kludge this until the fonts are right (grr).
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.
567 % Used to generate quoted braces.
568 \def\mylbrace {{\tt\char123}}
569 \def\myrbrace {{\tt\char125}}
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
580 !gdef!lbraceatcmd[@{]%
581 !gdef!rbraceatcmd[@}]%
584 % @comma{} to avoid , parsing problems.
587 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
588 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
591 \def\ringaccent#1{{\accent23 #1}}
596 % Other special characters: @questiondown @exclamdown @ordf @ordm
597 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
598 \def\questiondown{?`}
600 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
601 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
603 % Dotless i and dotless j, used for accents.
608 \ifx\temp\imacro \ptexi
609 \else\ifx\temp\jmacro \j
610 \else \errmessage{@dotless can be used only with i or j}%
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.)
617 \edef\TeX{\TeX \spacefactor=1000 }
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).
628 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
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.
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\ }
645 % @: forces normal size whitespace following.
646 \def\:{\spacefactor=1000 }
648 % @* forces a line break.
649 \def\*{\hfil\break\hbox{}\ignorespaces}
651 % @/ allows a line break.
654 % @. is an end-of-sentence period.
655 \def\.{.\spacefactor=\endofsentencespacefactor\space}
657 % @! is an end-of-sentence bang.
658 \def\!{!\spacefactor=\endofsentencespacefactor\space}
660 % @? is an end-of-sentence query.
661 \def\?{?\spacefactor=\endofsentencespacefactor\space}
663 % @frenchspacing on|off says whether to put extra space after punctuation.
668 \parseargdef\frenchspacing{%
670 \ifx\temp\onword \plainfrenchspacing
671 \else\ifx\temp\offword \plainnonfrenchspacing
674 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
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}}
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.
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).
702 \ifnum\catcode`\^^M=\active \else
703 \errhelp = \groupinvalidhelp
704 \errmessage{@group invalid in context where filling is enabled}%
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.
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.
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
744 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
745 % message, so this ends up printing `@group can only ...'.
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.}
751 % @need space-in-mils
752 % forces a page break if there is not space-in-mils remaining.
754 \newdimen\mil \mil=0.001in
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.
761 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
766 % Ensure vertical mode, so we don't make a big box in the middle of a
770 % If the @need value is less than one line space, it's useless.
772 \dimen2 = \ht\strutbox
773 \advance\dimen2 by \dp\strutbox
774 \ifdim\dimen0 > \dimen2
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}%
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.
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.
796 % Back up by the size of the box, whether we did a page break or not.
799 % Do not allow a page break right after this kern.
804 % @br forces paragraph break (and is undocumented).
808 % @page forces the start of a new page.
810 \def\page{\par\vfill\supereject}
813 % outputs text on separate line in roman font, starting at standard page margin
815 % This records the amount of indent in the innermost environment.
816 % That's how much \exdent should take out.
817 \newskip\exdentamount
819 % This defn is used inside fill environments such as @defun.
820 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
822 % This defn is used inside nofill environments such as @example.
823 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
824 \leftline{\hskip\leftskip{\rm#1}}}}
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'.
830 \newskip\inmarginspacing \inmarginspacing=1cm
831 \def\strutdepth{\dp\strutbox}
833 \def\doinmargin#1#2{\strut\vadjust{%
836 \vtop to \strutdepth{%
837 \baselineskip=\strutdepth
839 % if you have multiple lines of stuff to put here, you'll need to
840 % make the vbox yourself of the appropriate size.
842 \llap{\ignorespaces #2\hskip\inmarginspacing}%
844 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
849 \def\inleftmargin{\doinmargin l}
850 \def\inrightmargin{\doinmargin r}
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).
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}%
860 \def\lefttext{#1}% have both texts
863 \def\lefttext{#1}% have only one text
868 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
870 \def\temp{\inleftmargin\lefttext}%
875 % @include file insert text of that file as input.
877 \def\include{\parseargusing\filenamecatcodes\includezzz}
883 \def\temp{\input #1 }%
888 \def\filenamecatcodes{%
900 \def\pushthisfilestack{%
901 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
903 \def\pushthisfilestackX{%
904 \expandafter\pushthisfilestackY\thisfile\StackTerm
906 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
907 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
910 \def\popthisfilestack{\errthisfilestackempty}
911 \def\errthisfilestackempty{\errmessage{Internal error:
912 the stack of filenames is empty.}}
917 % outputs that line, centered.
919 \parseargdef\center{%
925 \next{\hfil \ignorespaces#1\unskip \hfil}%
930 \advance\hsize by -\leftskip
931 \advance\hsize by -\rightskip
936 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
938 % @sp n outputs n lines of vertical space
940 \parseargdef\sp{\vskip #1\baselineskip}
942 % @comment ...line which is ignored...
943 % @c is the same as @comment
944 % @ignore ... @end ignore is another way to write a comment
946 \def\comment{\begingroup \catcode`\^^M=\other%
947 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
949 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
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.
958 \def\asisword{asis} % no translation, these are keywords
961 \parseargdef\paragraphindent{%
966 \defaultparindent = 0pt
968 \defaultparindent = #1em
971 \parindent = \defaultparindent
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{%
985 \lispnarrowing = #1em
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
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.
1000 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1001 \def\insertword{insert}
1003 \parseargdef\firstparagraphindent{%
1006 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1007 \else\ifx\temp\insertword
1008 \let\suppressfirstparagraphindent = \relax
1010 \errhelp = \EMsimple
1011 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1015 % Here is how we actually suppress indentation. Redefine \everypar to
1016 % \kern backwards by \parindent, and then reset itself to empty.
1018 % We also make \indent itself not actually do anything until the next
1021 \gdef\dosuppressfirstparagraphindent{%
1023 \restorefirstparagraphindent
1027 \restorefirstparagraphindent
1030 \global\everypar = {%
1032 \restorefirstparagraphindent
1036 \gdef\restorefirstparagraphindent{%
1037 \global \let \indent = \ptexindent
1038 \global \let \noindent = \ptexnoindent
1039 \global \everypar = {}%
1043 % @asis just yields its argument. Used with @table, for example.
1047 % @math outputs its argument in math mode.
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.
1054 \catcode`\_ = \active
1055 \gdef\mathunderscore{%
1057 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
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 @\.
1065 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1066 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1071 \let\\ = \mathbackslash
1075 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
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).
1082 \catcode`^ = \active
1083 \catcode`< = \active
1084 \catcode`> = \active
1085 \catcode`+ = \active
1094 % @bullet and @minus need the same treatment as @math, just above.
1095 \def\bullet{$\ptexbullet$}
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.
1106 \setbox0=\hbox{...}% get width of three periods
1113 \hskip 0pt plus.25fil
1114 .\hskip 0pt plus1fil
1115 .\hskip 0pt plus1fil
1116 .\hskip 0pt plus.5fil
1120 % @enddots{} is an end-of-sentence ellipsis.
1124 \spacefactor=\endofsentencespacefactor
1127 % @comma{} is so commas can be inserted into text without messing up
1128 % Texinfo's parsing.
1132 % @refill is a no-op.
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).
1139 \newif\iflinks \linkstrue % by default we want the aux files.
1140 \let\novalidate = \linksfalse
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.
1146 \fixbackslash % Turn off hack to swallow `\input texinfo'.
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.
1153 \let\setfilename=\comment % Ignore extra @setfilename cmds.
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
1161 \comment % Ignore the actual filename.
1164 % Called from \setfilename.
1176 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1180 % adobe `portable' document format
1184 \newcount\filenamelength
1193 \newif\ifpdfmakepagedest
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
1200 \ifx\pdfoutput\relax
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).
1218 % double active backslashes.
1220 {\catcode`\@=0 \catcode`\\=\active
1221 @gdef@activebackslashdouble{%
1223 @let\=@doublebackslash}
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, with minor
1229 % changes for Texinfo. It is included here under the GPL by permission
1230 % from the author, Heiko Oberdiek.
1232 % #1 is the tokens to replace.
1233 % #2 is the replacement.
1234 % #3 is the control sequence with the string.
1236 \def\HyPsdSubst#1#2#3{%
1237 \def\HyPsdReplace##1#1##2\END{%
1243 \HyPsdReplace##2\END
1247 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1249 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1251 % #1 is a control sequence in which to do the replacements.
1252 \def\backslashparens#1{%
1253 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1254 % \lastnode when called from \setref -> \pdfmkdest.
1255 \HyPsdSubst{(}{\realbackslash(}{#1}%
1256 \HyPsdSubst{)}{\realbackslash)}{#1}%
1259 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1260 with PDF output, and none of those formats could be found. (.eps cannot
1261 be supported due to the design of the PDF format; use regular TeX (DVI
1266 \pdfcatalog{/PageMode /UseOutlines}
1268 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1269 \def\dopdfimage#1#2#3{%
1270 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1271 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1273 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1274 % others). Let's try in that order.
1275 \let\pdfimgext=\empty
1277 \openin 1 #1.png \ifeof 1
1278 \openin 1 #1.jpg \ifeof 1
1279 \openin 1 #1.jpeg \ifeof 1
1280 \openin 1 #1.JPG \ifeof 1
1281 \openin 1 #1.pdf \ifeof 1
1282 \errhelp = \nopdfimagehelp
1283 \errmessage{Could not find image file #1 for pdf}%
1284 \else \gdef\pdfimgext{pdf}%
1286 \else \gdef\pdfimgext{JPG}%
1288 \else \gdef\pdfimgext{jpeg}%
1290 \else \gdef\pdfimgext{jpg}%
1292 \else \gdef\pdfimgext{png}%
1297 % without \immediate, pdftex seg faults when the same image is
1298 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1299 \ifnum\pdftexversion < 14
1302 \immediate\pdfximage
1304 \ifdim \wd0 >0pt width \imagewidth \fi
1305 \ifdim \wd2 >0pt height \imageheight \fi
1306 \ifnum\pdftexversion<13
1311 \ifnum\pdftexversion < 14 \else
1312 \pdfrefximage \pdflastximage
1316 % We have to set dummies so commands such as @code, and characters
1317 % such as \, aren't expanded when present in a section title.
1320 \activebackslashdouble
1321 \makevalueexpandable
1322 \def\pdfdestname{#1}%
1323 \backslashparens\pdfdestname
1324 \pdfdest name{\pdfdestname} xyz%
1327 % used to mark target names; must be expandable.
1330 \let\linkcolor = \Blue % was Cyan, but that seems light?
1331 \def\endlink{\Black\pdfendlink}
1333 % Adding outlines to PDF; macros for calculating structure of outlines
1334 % come from Petr Olsak
1335 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1336 \else \csname#1\endcsname \fi}
1337 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1338 \advance\tempnum by 1
1339 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1341 % #1 is the section text, which is what will be displayed in the
1342 % outline by the pdf viewer. #2 is the pdf expression for the number
1343 % of subentries (or empty, for subsubsections). #3 is the node text,
1344 % which might be empty if this toc entry had no corresponding node.
1345 % #4 is the page number
1347 \def\dopdfoutline#1#2#3#4{%
1348 % Generate a link to the node text if that exists; else, use the
1349 % page number. We could generate a destination for the section
1350 % text in the case where a section has no node, but it doesn't
1351 % seem worth the trouble, since most documents are normally structured.
1352 \def\pdfoutlinedest{#3}%
1353 \ifx\pdfoutlinedest\empty
1354 \def\pdfoutlinedest{#4}%
1356 % Doubled backslashes in the name.
1357 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1358 \backslashparens\pdfoutlinedest}%
1361 % Also double the backslashes in the display string.
1362 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1363 \backslashparens\pdfoutlinetext}%
1365 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1368 \def\pdfmakeoutlines{%
1370 % Thanh's hack / proper braces in bookmarks
1371 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1372 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1374 % Read toc silently, to get counts of subentries for \pdfoutline.
1375 \def\numchapentry##1##2##3##4{%
1376 \def\thischapnum{##2}%
1378 \def\thissubsecnum{0}%
1380 \def\numsecentry##1##2##3##4{%
1381 \advancenumber{chap\thischapnum}%
1382 \def\thissecnum{##2}%
1383 \def\thissubsecnum{0}%
1385 \def\numsubsecentry##1##2##3##4{%
1386 \advancenumber{sec\thissecnum}%
1387 \def\thissubsecnum{##2}%
1389 \def\numsubsubsecentry##1##2##3##4{%
1390 \advancenumber{subsec\thissubsecnum}%
1392 \def\thischapnum{0}%
1394 \def\thissubsecnum{0}%
1396 % use \def rather than \let here because we redefine \chapentry et
1397 % al. a second time, below.
1398 \def\appentry{\numchapentry}%
1399 \def\appsecentry{\numsecentry}%
1400 \def\appsubsecentry{\numsubsecentry}%
1401 \def\appsubsubsecentry{\numsubsubsecentry}%
1402 \def\unnchapentry{\numchapentry}%
1403 \def\unnsecentry{\numsecentry}%
1404 \def\unnsubsecentry{\numsubsecentry}%
1405 \def\unnsubsubsecentry{\numsubsubsecentry}%
1408 % Read toc second time, this time actually producing the outlines.
1409 % The `-' means take the \expnumber as the absolute number of
1410 % subentries, which we calculated on our first read of the .toc above.
1412 % We use the node names as the destinations.
1413 \def\numchapentry##1##2##3##4{%
1414 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1415 \def\numsecentry##1##2##3##4{%
1416 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1417 \def\numsubsecentry##1##2##3##4{%
1418 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1419 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1420 \dopdfoutline{##1}{}{##3}{##4}}%
1422 % PDF outlines are displayed using system fonts, instead of
1423 % document fonts. Therefore we cannot use special characters,
1424 % since the encoding is unknown. For example, the eogonek from
1425 % Latin 2 (0xea) gets translated to a | character. Info from
1426 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1428 % xx to do this right, we have to translate 8-bit characters to
1429 % their "best" equivalent, based on the @documentencoding. Right
1430 % now, I guess we'll just let the pdf reader have its way.
1433 \catcode`\\=\active \otherbackslash
1438 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1439 \ifx\PP\D\let\nextsp\relax
1440 \else\let\nextsp\skipspaces
1441 \ifx\p\space\else\addtokens{\filename}{\PP}%
1442 \advance\filenamelength by 1
1446 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1447 \ifnum\pdftexversion < 14
1448 \let \startlink \pdfannotlink
1450 \let \startlink \pdfstartlink
1452 % make a live url in pdf output.
1455 % it seems we really need yet another set of dummies; have not
1456 % tried to figure out what each command should do in the context
1457 % of @url. for now, just make @/ a no-op, that's the only one
1458 % people have actually reported a problem with.
1460 \normalturnoffactive
1463 \makevalueexpandable
1465 \startlink attr{/Border [0 0 0]}%
1466 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1468 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1469 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1470 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1471 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1473 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1475 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1476 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1477 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1479 \ifnum0=\countA\else\makelink\fi
1480 \ifx\first.\let\next=\done\else
1482 \addtokens{\toksB}{\the\toksD}
1483 \ifx\first,\addtokens{\toksB}{\space}\fi
1485 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1487 \def\makelink{\addtokens{\toksB}%
1488 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1490 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1491 \linkcolor #1\endlink}
1492 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1494 \let\pdfmkdest = \gobble
1495 \let\pdfurl = \gobble
1496 \let\endlink = \relax
1497 \let\linkcolor = \relax
1498 \let\pdfmakeoutlines = \relax
1499 \fi % \ifx\pdfoutput
1504 % Change the current font style to #1, remembering it in \curfontstyle.
1505 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1506 % italics, not bold italics.
1508 \def\setfontstyle#1{%
1509 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1510 \csname ten#1\endcsname % change the current font
1513 % Select #1 fonts with the current style.
1515 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1517 \def\rm{\fam=0 \setfontstyle{rm}}
1518 \def\it{\fam=\itfam \setfontstyle{it}}
1519 \def\sl{\fam=\slfam \setfontstyle{sl}}
1520 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1521 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1523 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1524 % So we set up a \sf.
1526 \def\sf{\fam=\sffam \setfontstyle{sf}}
1527 \let\li = \sf % Sometimes we call it \li, not \sf.
1529 % We don't need math for this font style.
1530 \def\ttsl{\setfontstyle{ttsl}}
1534 \newdimen\textleading \textleading = 13.2pt
1536 % Set the baselineskip to #1, and the lineskip and strut size
1537 % correspondingly. There is no deep meaning behind these magic numbers
1538 % used as factors; they just match (closely enough) what Knuth defined.
1540 \def\lineskipfactor{.08333}
1541 \def\strutheightpercent{.70833}
1542 \def\strutdepthpercent {.29167}
1545 \normalbaselineskip = #1\relax
1546 \normallineskip = \lineskipfactor\normalbaselineskip
1548 \setbox\strutbox =\hbox{%
1549 \vrule width0pt height\strutheightpercent\baselineskip
1550 depth \strutdepthpercent \baselineskip
1555 % Set the font macro #1 to the font named #2, adding on the
1556 % specified font prefix (normally `cm').
1557 % #3 is the font's design size, #4 is a scale factor
1558 \def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4}
1561 % Use cm as the default font prefix.
1562 % To specify the font prefix, you must define \fontprefix
1563 % before you read in texinfo.tex.
1564 \ifx\fontprefix\undefined
1567 % Support font families that don't use the same naming scheme as CM.
1569 \def\rmbshape{bx} %where the normal face is bold
1574 \def\ttslshape{sltt}
1584 % Definitions for a main text size of 11pt. This is the default in
1587 \def\definetextfontsizexi{%
1588 % Text fonts (11.2pt, magstep1).
1589 \def\textnominalsize{11pt}
1590 \edef\mainmagstep{\magstephalf}
1591 \setfont\textrm\rmshape{10}{\mainmagstep}
1592 \setfont\texttt\ttshape{10}{\mainmagstep}
1593 \setfont\textbf\bfshape{10}{\mainmagstep}
1594 \setfont\textit\itshape{10}{\mainmagstep}
1595 \setfont\textsl\slshape{10}{\mainmagstep}
1596 \setfont\textsf\sfshape{10}{\mainmagstep}
1597 \setfont\textsc\scshape{10}{\mainmagstep}
1598 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1599 \font\texti=cmmi10 scaled \mainmagstep
1600 \font\textsy=cmsy10 scaled \mainmagstep
1602 % A few fonts for @defun names and args.
1603 \setfont\defbf\bfshape{10}{\magstep1}
1604 \setfont\deftt\ttshape{10}{\magstep1}
1605 \setfont\defttsl\ttslshape{10}{\magstep1}
1606 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1608 % Fonts for indices, footnotes, small examples (9pt).
1609 \def\smallnominalsize{9pt}
1610 \setfont\smallrm\rmshape{9}{1000}
1611 \setfont\smalltt\ttshape{9}{1000}
1612 \setfont\smallbf\bfshape{10}{900}
1613 \setfont\smallit\itshape{9}{1000}
1614 \setfont\smallsl\slshape{9}{1000}
1615 \setfont\smallsf\sfshape{9}{1000}
1616 \setfont\smallsc\scshape{10}{900}
1617 \setfont\smallttsl\ttslshape{10}{900}
1621 % Fonts for small examples (8pt).
1622 \def\smallernominalsize{8pt}
1623 \setfont\smallerrm\rmshape{8}{1000}
1624 \setfont\smallertt\ttshape{8}{1000}
1625 \setfont\smallerbf\bfshape{10}{800}
1626 \setfont\smallerit\itshape{8}{1000}
1627 \setfont\smallersl\slshape{8}{1000}
1628 \setfont\smallersf\sfshape{8}{1000}
1629 \setfont\smallersc\scshape{10}{800}
1630 \setfont\smallerttsl\ttslshape{10}{800}
1631 \font\smalleri=cmmi8
1632 \font\smallersy=cmsy8
1634 % Fonts for title page (20.4pt):
1635 \def\titlenominalsize{20pt}
1636 \setfont\titlerm\rmbshape{12}{\magstep3}
1637 \setfont\titleit\itbshape{10}{\magstep4}
1638 \setfont\titlesl\slbshape{10}{\magstep4}
1639 \setfont\titlett\ttbshape{12}{\magstep3}
1640 \setfont\titlettsl\ttslshape{10}{\magstep4}
1641 \setfont\titlesf\sfbshape{17}{\magstep1}
1642 \let\titlebf=\titlerm
1643 \setfont\titlesc\scbshape{10}{\magstep4}
1644 \font\titlei=cmmi12 scaled \magstep3
1645 \font\titlesy=cmsy10 scaled \magstep4
1646 \def\authorrm{\secrm}
1647 \def\authortt{\sectt}
1649 % Chapter (and unnumbered) fonts (17.28pt).
1650 \def\chapnominalsize{17pt}
1651 \setfont\chaprm\rmbshape{12}{\magstep2}
1652 \setfont\chapit\itbshape{10}{\magstep3}
1653 \setfont\chapsl\slbshape{10}{\magstep3}
1654 \setfont\chaptt\ttbshape{12}{\magstep2}
1655 \setfont\chapttsl\ttslshape{10}{\magstep3}
1656 \setfont\chapsf\sfbshape{17}{1000}
1658 \setfont\chapsc\scbshape{10}{\magstep3}
1659 \font\chapi=cmmi12 scaled \magstep2
1660 \font\chapsy=cmsy10 scaled \magstep3
1662 % Section fonts (14.4pt).
1663 \def\secnominalsize{14pt}
1664 \setfont\secrm\rmbshape{12}{\magstep1}
1665 \setfont\secit\itbshape{10}{\magstep2}
1666 \setfont\secsl\slbshape{10}{\magstep2}
1667 \setfont\sectt\ttbshape{12}{\magstep1}
1668 \setfont\secttsl\ttslshape{10}{\magstep2}
1669 \setfont\secsf\sfbshape{12}{\magstep1}
1671 \setfont\secsc\scbshape{10}{\magstep2}
1672 \font\seci=cmmi12 scaled \magstep1
1673 \font\secsy=cmsy10 scaled \magstep2
1675 % Subsection fonts (13.15pt).
1676 \def\ssecnominalsize{13pt}
1677 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1678 \setfont\ssecit\itbshape{10}{1315}
1679 \setfont\ssecsl\slbshape{10}{1315}
1680 \setfont\ssectt\ttbshape{12}{\magstephalf}
1681 \setfont\ssecttsl\ttslshape{10}{1315}
1682 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1684 \setfont\ssecsc\scbshape{10}{1315}
1685 \font\sseci=cmmi12 scaled \magstephalf
1686 \font\ssecsy=cmsy10 scaled 1315
1688 % Reduced fonts for @acro in text (10pt).
1689 \def\reducednominalsize{10pt}
1690 \setfont\reducedrm\rmshape{10}{1000}
1691 \setfont\reducedtt\ttshape{10}{1000}
1692 \setfont\reducedbf\bfshape{10}{1000}
1693 \setfont\reducedit\itshape{10}{1000}
1694 \setfont\reducedsl\slshape{10}{1000}
1695 \setfont\reducedsf\sfshape{10}{1000}
1696 \setfont\reducedsc\scshape{10}{1000}
1697 \setfont\reducedttsl\ttslshape{10}{1000}
1698 \font\reducedi=cmmi10
1699 \font\reducedsy=cmsy10
1701 % reset the current fonts
1704 } % end of 11pt text font size definitions
1707 % Definitions to make the main text be 10pt Computer Modern, with
1708 % section, chapter, etc., sizes following suit. This is for the GNU
1709 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1710 % future. Used with @smallbook, which sets the leading to 12pt.
1712 \def\definetextfontsizex{%
1713 % Text fonts (10pt).
1714 \def\textnominalsize{10pt}
1715 \edef\mainmagstep{1000}
1716 \setfont\textrm\rmshape{10}{\mainmagstep}
1717 \setfont\texttt\ttshape{10}{\mainmagstep}
1718 \setfont\textbf\bfshape{10}{\mainmagstep}
1719 \setfont\textit\itshape{10}{\mainmagstep}
1720 \setfont\textsl\slshape{10}{\mainmagstep}
1721 \setfont\textsf\sfshape{10}{\mainmagstep}
1722 \setfont\textsc\scshape{10}{\mainmagstep}
1723 \setfont\textttsl\ttslshape{10}{\mainmagstep}
1724 \font\texti=cmmi10 scaled \mainmagstep
1725 \font\textsy=cmsy10 scaled \mainmagstep
1727 % A few fonts for @defun names and args.
1728 \setfont\defbf\bfshape{10}{\magstephalf}
1729 \setfont\deftt\ttshape{10}{\magstephalf}
1730 \setfont\defttsl\ttslshape{10}{\magstephalf}
1731 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1733 % Fonts for indices, footnotes, small examples (9pt).
1734 \def\smallnominalsize{9pt}
1735 \setfont\smallrm\rmshape{9}{1000}
1736 \setfont\smalltt\ttshape{9}{1000}
1737 \setfont\smallbf\bfshape{10}{900}
1738 \setfont\smallit\itshape{9}{1000}
1739 \setfont\smallsl\slshape{9}{1000}
1740 \setfont\smallsf\sfshape{9}{1000}
1741 \setfont\smallsc\scshape{10}{900}
1742 \setfont\smallttsl\ttslshape{10}{900}
1746 % Fonts for small examples (8pt).
1747 \def\smallernominalsize{8pt}
1748 \setfont\smallerrm\rmshape{8}{1000}
1749 \setfont\smallertt\ttshape{8}{1000}
1750 \setfont\smallerbf\bfshape{10}{800}
1751 \setfont\smallerit\itshape{8}{1000}
1752 \setfont\smallersl\slshape{8}{1000}
1753 \setfont\smallersf\sfshape{8}{1000}
1754 \setfont\smallersc\scshape{10}{800}
1755 \setfont\smallerttsl\ttslshape{10}{800}
1756 \font\smalleri=cmmi8
1757 \font\smallersy=cmsy8
1759 % Fonts for title page (20.4pt):
1760 \def\titlenominalsize{20pt}
1761 \setfont\titlerm\rmbshape{12}{\magstep3}
1762 \setfont\titleit\itbshape{10}{\magstep4}
1763 \setfont\titlesl\slbshape{10}{\magstep4}
1764 \setfont\titlett\ttbshape{12}{\magstep3}
1765 \setfont\titlettsl\ttslshape{10}{\magstep4}
1766 \setfont\titlesf\sfbshape{17}{\magstep1}
1767 \let\titlebf=\titlerm
1768 \setfont\titlesc\scbshape{10}{\magstep4}
1769 \font\titlei=cmmi12 scaled \magstep3
1770 \font\titlesy=cmsy10 scaled \magstep4
1771 \def\authorrm{\secrm}
1772 \def\authortt{\sectt}
1774 % Chapter fonts (14.4pt).
1775 \def\chapnominalsize{14pt}
1776 \setfont\chaprm\rmbshape{12}{\magstep1}
1777 \setfont\chapit\itbshape{10}{\magstep2}
1778 \setfont\chapsl\slbshape{10}{\magstep2}
1779 \setfont\chaptt\ttbshape{12}{\magstep1}
1780 \setfont\chapttsl\ttslshape{10}{\magstep2}
1781 \setfont\chapsf\sfbshape{12}{\magstep1}
1783 \setfont\chapsc\scbshape{10}{\magstep2}
1784 \font\chapi=cmmi12 scaled \magstep1
1785 \font\chapsy=cmsy10 scaled \magstep2
1787 % Section fonts (12pt).
1788 \def\secnominalsize{12pt}
1789 \setfont\secrm\rmbshape{12}{1000}
1790 \setfont\secit\itbshape{10}{\magstep1}
1791 \setfont\secsl\slbshape{10}{\magstep1}
1792 \setfont\sectt\ttbshape{12}{1000}
1793 \setfont\secttsl\ttslshape{10}{\magstep1}
1794 \setfont\secsf\sfbshape{12}{1000}
1796 \setfont\secsc\scbshape{10}{\magstep1}
1798 \font\secsy=cmsy10 scaled \magstep1
1800 % Subsection fonts (10pt).
1801 \def\ssecnominalsize{10pt}
1802 \setfont\ssecrm\rmbshape{10}{1000}
1803 \setfont\ssecit\itbshape{10}{1000}
1804 \setfont\ssecsl\slbshape{10}{1000}
1805 \setfont\ssectt\ttbshape{10}{1000}
1806 \setfont\ssecttsl\ttslshape{10}{1000}
1807 \setfont\ssecsf\sfbshape{10}{1000}
1809 \setfont\ssecsc\scbshape{10}{1000}
1813 % Reduced fonts for @acro in text (9pt).
1814 \def\reducednominalsize{9pt}
1815 \setfont\reducedrm\rmshape{9}{1000}
1816 \setfont\reducedtt\ttshape{9}{1000}
1817 \setfont\reducedbf\bfshape{10}{900}
1818 \setfont\reducedit\itshape{9}{1000}
1819 \setfont\reducedsl\slshape{9}{1000}
1820 \setfont\reducedsf\sfshape{9}{1000}
1821 \setfont\reducedsc\scshape{10}{900}
1822 \setfont\reducedttsl\ttslshape{10}{900}
1823 \font\reducedi=cmmi9
1824 \font\reducedsy=cmsy9
1826 % reduce space between paragraphs
1827 \divide\parskip by 2
1829 % reset the current fonts
1832 } % end of 10pt text font size definitions
1835 % We provide the user-level command
1837 % (or 11) to redefine the text font size. pt is assumed.
1842 \parseargdef\fonttextsize{%
1843 \def\textsizearg{#1}%
1844 \wlog{doing @fonttextsize \textsizearg}%
1846 % Set \globaldefs so that documents can use this inside @tex, since
1847 % makeinfo 4.8 does not support it, but we need it nonetheless.
1849 \begingroup \globaldefs=1
1850 \ifx\textsizearg\xword \definetextfontsizex
1851 \else \ifx\textsizearg\xiword \definetextfontsizexi
1854 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
1860 % In order for the font changes to affect most math symbols and letters,
1861 % we have to define the \textfont of the standard families. Since
1862 % texinfo doesn't allow for producing subscripts and superscripts except
1863 % in the main text, we don't bother to reset \scriptfont and
1864 % \scriptscriptfont (which would also require loading a lot more fonts).
1866 \def\resetmathfonts{%
1867 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
1868 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
1869 \textfont\ttfam=\tentt \textfont\sffam=\tensf
1872 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1873 % of just \STYLE. We do this because \STYLE needs to also set the
1874 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
1875 % \tenSTYLE to set the current font.
1877 % Each font-changing command also sets the names \lsize (one size lower)
1878 % and \lllsize (three sizes lower). These relative commands are used in
1879 % the LaTeX logo and acronyms.
1881 % This all needs generalizing, badly.
1884 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
1885 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
1886 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
1887 \let\tenttsl=\textttsl
1888 \def\curfontsize{text}%
1889 \def\lsize{reduced}\def\lllsize{smaller}%
1890 \resetmathfonts \setleading{\textleading}}
1892 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
1893 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
1894 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
1895 \let\tenttsl=\titlettsl
1896 \def\curfontsize{title}%
1897 \def\lsize{chap}\def\lllsize{subsec}%
1898 \resetmathfonts \setleading{25pt}}
1899 \def\titlefont#1{{\titlefonts\rm #1}}
1901 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
1902 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
1903 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
1904 \let\tenttsl=\chapttsl
1905 \def\curfontsize{chap}%
1906 \def\lsize{sec}\def\lllsize{text}%
1907 \resetmathfonts \setleading{19pt}}
1909 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
1910 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
1911 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
1912 \let\tenttsl=\secttsl
1913 \def\curfontsize{sec}%
1914 \def\lsize{subsec}\def\lllsize{reduced}%
1915 \resetmathfonts \setleading{16pt}}
1917 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
1918 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
1919 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
1920 \let\tenttsl=\ssecttsl
1921 \def\curfontsize{ssec}%
1922 \def\lsize{text}\def\lllsize{small}%
1923 \resetmathfonts \setleading{15pt}}
1924 \let\subsubsecfonts = \subsecfonts
1926 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
1927 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
1928 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
1929 \let\tenttsl=\reducedttsl
1930 \def\curfontsize{reduced}%
1931 \def\lsize{small}\def\lllsize{smaller}%
1932 \resetmathfonts \setleading{10.5pt}}
1934 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
1935 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
1936 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
1937 \let\tenttsl=\smallttsl
1938 \def\curfontsize{small}%
1939 \def\lsize{smaller}\def\lllsize{smaller}%
1940 \resetmathfonts \setleading{10.5pt}}
1942 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
1943 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
1944 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
1945 \let\tenttsl=\smallerttsl
1946 \def\curfontsize{smaller}%
1947 \def\lsize{smaller}\def\lllsize{smaller}%
1948 \resetmathfonts \setleading{9.5pt}}
1950 % Set the fonts to use with the @small... environments.
1951 \let\smallexamplefonts = \smallfonts
1953 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
1954 % can fit this many characters:
1955 % 8.5x11=86 smallbook=72 a4=90 a5=69
1956 % If we use \scriptfonts (8pt), then we can fit this many characters:
1957 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
1958 % For me, subjectively, the few extra characters that fit aren't worth
1959 % the additional smallness of 8pt. So I'm making the default 9pt.
1961 % By the way, for comparison, here's what fits with @example (10pt):
1962 % 8.5x11=71 smallbook=60 a4=75 a5=58
1964 % I wish the USA used A4 paper.
1968 % Set up the default fonts, so we can use them for creating boxes.
1970 \definetextfontsizexi
1972 % Define these so they can be easily changed for other fonts.
1973 \def\angleleft{$\langle$}
1974 \def\angleright{$\rangle$}
1976 % Count depth in font-changes, for error checks
1977 \newcount\fontdepth \fontdepth=0
1979 % Fonts for short table of contents.
1980 \setfont\shortcontrm\rmshape{12}{1000}
1981 \setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12
1982 \setfont\shortcontsl\slshape{12}{1000}
1983 \setfont\shortconttt\ttshape{12}{1000}
1985 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1986 %% serif) and @ii for TeX italic
1988 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1989 % unless the following character is such as not to need one.
1990 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
1991 \ptexslash\fi\fi\fi}
1992 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1993 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1995 % like \smartslanted except unconditionally uses \ttsl.
1996 % @var is set to this for defun arguments.
1997 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1999 % like \smartslanted except unconditionally use \sl. We never want
2000 % ttsl for book titles, do we?
2001 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
2004 \let\slanted=\smartslanted
2005 \let\var=\smartslanted
2006 \let\dfn=\smartslanted
2007 \let\emph=\smartitalic
2009 % @b, explicit bold.
2013 % @sansserif, explicit sans.
2014 \def\sansserif#1{{\sf #1}}
2016 % We can't just use \exhyphenpenalty, because that only has effect at
2017 % the end of a paragraph. Restore normal hyphenation at the end of the
2018 % group within which \nohyphenation is presumably called.
2020 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2021 \def\restorehyphenation{\hyphenchar\font = `- }
2023 % Set sfcode to normal for the chars that usually have another value.
2024 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2025 % sometimes \x has an active definition that messes things up.
2028 \def\plainfrenchspacing{%
2029 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2030 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2031 \def\endofsentencespacefactor{1000}% for @. and friends
2033 \def\plainnonfrenchspacing{%
2034 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2035 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2036 \def\endofsentencespacefactor{3000}% for @. and friends
2039 \def\endofsentencespacefactor{3000}% default
2042 {\tt \rawbackslash \plainfrenchspacing #1}%
2045 \def\samp#1{`\tclose{#1}'\null}
2046 \setfont\keyrm\rmshape{8}{1000}
2048 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2049 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2050 \vbox{\hrule\kern-0.4pt
2051 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2053 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2054 \def\key #1{{\nohyphenation \uppercase{#1}}\null}
2055 % The old definition, with no lozenge:
2056 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
2057 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2059 % @file, @option are the same as @samp.
2063 % @code is a modification of @t,
2064 % which makes spaces the same size as normal in the surrounding text.
2067 % Change normal interword space to be same as for the current font.
2068 \spaceskip = \fontdimen2\font
2070 % Switch to typewriter.
2073 % But `\ ' produces the large typewriter interword space.
2074 \def\ {{\spaceskip = 0pt{} }}%
2076 % Turn off hyphenation.
2086 % We *must* turn on hyphenation at `-' and `_' in @code.
2087 % Otherwise, it is too hard to avoid overfull hboxes
2088 % in the Emacs manual, the Library manual, etc.
2090 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2091 % both hyphenation at - and hyphenation within words.
2092 % We must therefore turn them both off (\tclose does that)
2093 % and arrange explicitly to hyphenate at a dash.
2096 \catcode`\-=\active \catcode`\_=\active
2097 \catcode`\'=\active \catcode`\`=\active
2099 \global\def\code{\begingroup
2100 \catcode\rquoteChar=\active \catcode\lquoteChar=\active
2101 \let'\codequoteright \let`\codequoteleft
2103 \catcode\dashChar=\active \catcode\underChar=\active
2116 \def\codedash{-\discretionary{}{}{}}
2118 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2119 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2120 % will therefore expand the active definition of _, which is us
2121 % (inside @code that is), therefore an endless loop.
2123 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2124 \else\normalunderscore \fi
2125 \discretionary{}{}{}}%
2128 \def\codex #1{\tclose{#1}\endgroup}
2130 % An additional complication: the above will allow breaks after, e.g.,
2131 % each of the four underscores in __typeof__. This is undesirable in
2132 % some manuals, especially if they don't have long identifiers in
2133 % general. @allowcodebreaks provides a way to control this.
2135 \newif\ifallowcodebreaks \allowcodebreakstrue
2137 \def\keywordtrue{true}
2138 \def\keywordfalse{false}
2140 \parseargdef\allowcodebreaks{%
2142 \ifx\txiarg\keywordtrue
2143 \allowcodebreakstrue
2144 \else\ifx\txiarg\keywordfalse
2145 \allowcodebreaksfalse
2147 \errhelp = \EMsimple
2148 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2152 % @kbd is like @code, except that if the argument is just one @key command,
2153 % then @kbd has no effect.
2155 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2156 % `example' (@kbd uses ttsl only inside of @example and friends),
2157 % or `code' (@kbd uses normal tty font always).
2158 \parseargdef\kbdinputstyle{%
2160 \ifx\txiarg\worddistinct
2161 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2162 \else\ifx\txiarg\wordexample
2163 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2164 \else\ifx\txiarg\wordcode
2165 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2167 \errhelp = \EMsimple
2168 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2171 \def\worddistinct{distinct}
2172 \def\wordexample{example}
2175 % Default is `distinct.'
2176 \kbdinputstyle distinct
2179 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2180 \ifx\one\xkey\ifx\threex\three \key{#2}%
2181 \else{\tclose{\kbdfont\look}}\fi
2182 \else{\tclose{\kbdfont\look}}\fi}
2184 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2185 \let\indicateurl=\code
2189 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2190 % second argument specifying the text to display and an optional third
2191 % arg as text to display instead of (rather than in addition to) the url
2192 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2193 % a hypertex \special here.
2195 \def\uref#1{\douref #1,,,\finish}
2196 \def\douref#1,#2,#3,#4\finish{\begingroup
2199 \setbox0 = \hbox{\ignorespaces #3}%
2201 \unhbox0 % third arg given, show only that
2203 \setbox0 = \hbox{\ignorespaces #2}%
2206 \unhbox0 % PDF: 2nd arg given, show only it
2208 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2211 \code{#1}% only url given, so show it
2217 % @url synonym for @uref, since that's how everyone uses it.
2221 % rms does not like angle brackets --karl, 17may97.
2222 % So now @email is just like @uref, unless we are pdf.
2224 %\def\email#1{\angleleft{\tt #1}\angleright}
2226 \def\email#1{\doemail#1,,\finish}
2227 \def\doemail#1,#2,#3\finish{\begingroup
2230 \setbox0 = \hbox{\ignorespaces #2}%
2231 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2238 % Check if we are currently using a typewriter font. Since all the
2239 % Computer Modern typewriter fonts have zero interword stretch (and
2240 % shrink), and it is reasonable to expect all typewriter fonts to have
2241 % this property, we can check that font parameter.
2243 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2245 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2246 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2248 \def\dmn#1{\thinspace #1}
2250 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par}
2252 % @l was never documented to mean ``switch to the Lisp font'',
2253 % and it is not used as such in any manual I can find. We need it for
2254 % Polish suppressed-l. --karl, 22sep96.
2255 %\def\l#1{{\li #1}\null}
2257 % Explicit font changes: @r, @sc, undocumented @ii.
2258 \def\r#1{{\rm #1}} % roman font
2259 \def\sc#1{{\smallcaps#1}} % smallcaps font
2260 \def\ii#1{{\it #1}} % italic font
2262 % @acronym for "FBI", "NATO", and the like.
2263 % We print this one point size smaller, since it's intended for
2266 \def\acronym#1{\doacronym #1,,\finish}
2267 \def\doacronym#1,#2,#3\finish{%
2268 {\selectfonts\lsize #1}%
2270 \ifx\temp\empty \else
2271 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2275 % @abbr for "Comput. J." and the like.
2276 % No font change, but don't do end-of-sentence spacing.
2278 \def\abbr#1{\doabbr #1,,\finish}
2279 \def\doabbr#1,#2,#3\finish{%
2280 {\plainfrenchspacing #1}%
2282 \ifx\temp\empty \else
2283 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2287 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2289 \def\pounds{{\it\$}}
2291 % @euro{} comes from a separate font, depending on the current style.
2292 % We use the free feym* fonts from the eurosym package by Henrik
2293 % Theiling, which support regular, slanted, bold and bold slanted (and
2294 % "outlined" (blackboard board, sort of) versions, which we don't need).
2295 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2297 % Although only regular is the truly official Euro symbol, we ignore
2298 % that. The Euro is designed to be slightly taller than the regular
2304 % feybo - bold slanted
2306 % There is no good (free) typewriter version, to my knowledge.
2307 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2310 % Also doesn't work in math. Do we need to do math with euro symbols?
2314 \def\euro{{\eurofont e}}
2316 % We set the font at each command, rather than predefining it in
2317 % \textfonts and the other font-switching commands, so that
2318 % installations which never need the symbol don't have to have the
2321 % There is only one designed size (nominal 10pt), so we always scale
2322 % that to the current nominal size.
2324 % By the way, simply using "at 1em" works for cmr10 and the like, but
2325 % does not work for cmbx10 and other extended/shrunken fonts.
2327 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2329 \ifx\curfontstyle\bfstylename
2331 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2334 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2339 % @registeredsymbol - R in a circle. The font for the R should really
2340 % be smaller yet, but lllsize is the best we can do for now.
2341 % Adapted from the plain.tex definition of \copyright.
2343 \def\registeredsymbol{%
2344 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2349 % @textdegree - the normal degrees sign.
2351 \def\textdegree{$^\circ$}
2353 % Laurent Siebenmann reports \Orb undefined with:
2354 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2355 % so we'll define it if necessary.
2358 \def\Orb{\mathhexbox20D}
2362 \message{page headings,}
2364 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2365 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2367 % First the title page. Must do @settitle before @titlepage.
2369 \newif\iffinishedtitlepage
2371 % Do an implicit @contents or @shortcontents after @end titlepage if the
2372 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2374 \newif\ifsetcontentsaftertitlepage
2375 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2376 \newif\ifsetshortcontentsaftertitlepage
2377 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2379 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2380 \endgroup\page\hbox{}\page}
2383 % Open one extra group, as we want to close it in the middle of \Etitlepage.
2385 \parindent=0pt \textfonts
2386 % Leave some space at the very top of the page.
2387 \vglue\titlepagetopglue
2388 % No rule at page bottom unless we print one at the top with @title.
2389 \finishedtitlepagetrue
2391 % Most title ``pages'' are actually two pages long, with space
2392 % at the top of the second. We don't want the ragged left on the second.
2393 \let\oldpage = \page
2395 \iffinishedtitlepage\else
2398 \let\page = \oldpage
2405 \iffinishedtitlepage\else
2408 % It is important to do the page break before ending the group,
2409 % because the headline and footline are only empty inside the group.
2410 % If we use the new definition of \page, we always get a blank page
2411 % after the title page, which we certainly don't want.
2415 % Need this before the \...aftertitlepage checks so that if they are
2416 % in effect the toc pages will come out with page numbers.
2419 % If they want short, they certainly want long too.
2420 \ifsetshortcontentsaftertitlepage
2423 \global\let\shortcontents = \relax
2424 \global\let\contents = \relax
2427 \ifsetcontentsaftertitlepage
2429 \global\let\contents = \relax
2430 \global\let\shortcontents = \relax
2434 \def\finishtitlepage{%
2435 \vskip4pt \hrule height 2pt width \hsize
2436 \vskip\titlepagebottomglue
2437 \finishedtitlepagetrue
2440 %%% Macros to be used within @titlepage:
2442 \let\subtitlerm=\tenrm
2443 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2445 \def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines
2448 \parseargdef\title{%
2450 \leftline{\titlefonts\rm #1}
2451 % print a rule at the page bottom also.
2452 \finishedtitlepagefalse
2453 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2456 \parseargdef\subtitle{%
2458 {\subtitlefont \rightline{#1}}%
2461 % @author should come last, but may come many times.
2462 % It can also be used inside @quotation.
2464 \parseargdef\author{%
2465 \def\temp{\quotation}%
2467 \def\quotationauthor{#1}% printed in \Equotation.
2470 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2471 {\authorfont \leftline{#1}}%
2476 %%% Set up page headings and footings.
2478 \let\thispage=\folio
2480 \newtoks\evenheadline % headline on even pages
2481 \newtoks\oddheadline % headline on odd pages
2482 \newtoks\evenfootline % footline on even pages
2483 \newtoks\oddfootline % footline on odd pages
2485 % Now make TeX use those variables
2486 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2487 \else \the\evenheadline \fi}}
2488 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2489 \else \the\evenfootline \fi}\HEADINGShook}
2490 \let\HEADINGShook=\relax
2492 % Commands to set those variables.
2493 % For example, this is what @headings on does
2494 % @evenheading @thistitle|@thispage|@thischapter
2495 % @oddheading @thischapter|@thispage|@thistitle
2496 % @evenfooting @thisfile||
2497 % @oddfooting ||@thisfile
2500 \def\evenheading{\parsearg\evenheadingxxx}
2501 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2502 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2503 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2505 \def\oddheading{\parsearg\oddheadingxxx}
2506 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2507 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2508 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2510 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2512 \def\evenfooting{\parsearg\evenfootingxxx}
2513 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2514 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2515 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2517 \def\oddfooting{\parsearg\oddfootingxxx}
2518 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2519 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2520 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2522 % Leave some space for the footline. Hopefully ok to assume
2523 % @evenfooting will not be used by itself.
2524 \global\advance\pageheight by -12pt
2525 \global\advance\vsize by -12pt
2528 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2531 % @headings double turns headings on for double-sided printing.
2532 % @headings single turns headings on for single-sided printing.
2533 % @headings off turns them off.
2534 % @headings on same as @headings double, retained for compatibility.
2535 % @headings after turns on double-sided headings after this page.
2536 % @headings doubleafter turns on double-sided headings after this page.
2537 % @headings singleafter turns on single-sided headings after this page.
2538 % By default, they are off at the start of a document,
2539 % and turned `on' after @end titlepage.
2541 \def\headings #1 {\csname HEADINGS#1\endcsname}
2544 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
2545 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
2547 % When we turn headings on, set the page number to 1.
2548 % For double-sided printing, put current file name in lower left corner,
2549 % chapter name on inside top of right hand pages, document
2550 % title on inside top of left hand pages, and page numbers on outside top
2551 % edge of all pages.
2552 \def\HEADINGSdouble{%
2554 \global\evenfootline={\hfil}
2555 \global\oddfootline={\hfil}
2556 \global\evenheadline={\line{\folio\hfil\thistitle}}
2557 \global\oddheadline={\line{\thischapter\hfil\folio}}
2558 \global\let\contentsalignmacro = \chapoddpage
2560 \let\contentsalignmacro = \chappager
2562 % For single-sided printing, chapter title goes across top left of page,
2563 % page number on top right.
2564 \def\HEADINGSsingle{%
2566 \global\evenfootline={\hfil}
2567 \global\oddfootline={\hfil}
2568 \global\evenheadline={\line{\thischapter\hfil\folio}}
2569 \global\oddheadline={\line{\thischapter\hfil\folio}}
2570 \global\let\contentsalignmacro = \chappager
2572 \def\HEADINGSon{\HEADINGSdouble}
2574 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
2575 \let\HEADINGSdoubleafter=\HEADINGSafter
2576 \def\HEADINGSdoublex{%
2577 \global\evenfootline={\hfil}
2578 \global\oddfootline={\hfil}
2579 \global\evenheadline={\line{\folio\hfil\thistitle}}
2580 \global\oddheadline={\line{\thischapter\hfil\folio}}
2581 \global\let\contentsalignmacro = \chapoddpage
2584 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
2585 \def\HEADINGSsinglex{%
2586 \global\evenfootline={\hfil}
2587 \global\oddfootline={\hfil}
2588 \global\evenheadline={\line{\thischapter\hfil\folio}}
2589 \global\oddheadline={\line{\thischapter\hfil\folio}}
2590 \global\let\contentsalignmacro = \chappager
2593 % Subroutines used in generating headings
2594 % This produces Day Month Year style of output.
2595 % Only define if not already defined, in case a txi-??.tex file has set
2596 % up a different format (e.g., txi-cs.tex does this).
2597 \ifx\today\undefined
2601 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2602 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2603 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2608 % @settitle line... specifies the title of the document, for headings.
2609 % It generates no output of its own.
2610 \def\thistitle{\putwordNoTitle}
2611 \def\settitle{\parsearg{\gdef\thistitle}}
2615 % Tables -- @table, @ftable, @vtable, @item(x).
2617 % default indentation of table text
2618 \newdimen\tableindent \tableindent=.8in
2619 % default indentation of @itemize and @enumerate text
2620 \newdimen\itemindent \itemindent=.3in
2621 % margin between end of table item and start of table text.
2622 \newdimen\itemmargin \itemmargin=.1in
2624 % used internally for \itemindent minus \itemmargin
2627 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2629 % They also define \itemindex
2630 % to index the item name in whatever manner is desired (perhaps none).
2632 \newif\ifitemxneedsnegativevskip
2634 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
2636 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2637 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2639 \def\itemzzz #1{\begingroup %
2640 \advance\hsize by -\rightskip
2641 \advance\hsize by -\tableindent
2642 \setbox0=\hbox{\itemindicate{#1}}%
2644 \nobreak % This prevents a break before @itemx.
2646 % If the item text does not fit in the space we have, put it on a line
2647 % by itself, and do not allow a page break either before or after that
2648 % line. We do not start a paragraph here because then if the next
2649 % command is, e.g., @kindex, the whatsit would get put into the
2650 % horizontal list on a line by itself, resulting in extra blank space.
2651 \ifdim \wd0>\itemmax
2653 % Make this a paragraph so we get the \parskip glue and wrapping,
2654 % but leave it ragged-right.
2656 \advance\leftskip by-\tableindent
2657 \advance\hsize by\tableindent
2658 \advance\rightskip by0pt plus1fil
2659 \leavevmode\unhbox0\par
2662 % We're going to be starting a paragraph, but we don't want the
2663 % \parskip glue -- logically it's part of the @item we just started.
2664 \nobreak \vskip-\parskip
2666 % Stop a page break at the \parskip glue coming up. However, if
2667 % what follows is an environment such as @example, there will be no
2668 % \parskip glue; then the negative vskip we just inserted would
2669 % cause the example and the item to crash together. So we use this
2670 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
2671 % \parskip glue after all. Section titles are handled this way also.
2675 \itemxneedsnegativevskipfalse
2677 % The item text fits into the space. Start a paragraph, so that the
2678 % following text (if any) will end up on the same line.
2680 % Do this with kerns and \unhbox so that if there is a footnote in
2681 % the item text, it can migrate to the main vertical list and
2682 % eventually be printed.
2683 \nobreak\kern-\tableindent
2684 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
2686 \nobreak\kern\dimen0
2688 \itemxneedsnegativevskiptrue
2692 \def\item{\errmessage{@item while not in a list environment}}
2693 \def\itemx{\errmessage{@itemx while not in a list environment}}
2695 % @table, @ftable, @vtable.
2697 \let\itemindex\gobble
2701 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
2702 \tablecheck{ftable}%
2705 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
2706 \tablecheck{vtable}%
2709 \ifnum \the\catcode`\^^M=\active
2711 \errmessage{This command won't work in this context; perhaps the problem is
2712 that we are \inenvironment\thisenv}%
2713 \def\next{\doignore{#1}}%
2720 \def\itemindicate{#1}%
2725 \makevalueexpandable
2726 \edef\temp{\noexpand\tablez #1\space\space\space}%
2730 \def\tablez #1 #2 #3 #4\endtablez{%
2732 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
2733 \ifnum 0#2>0 \tableindent=#2\mil \fi
2734 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
2735 \itemmax=\tableindent
2736 \advance \itemmax by -\itemmargin
2737 \advance \leftskip by \tableindent
2738 \exdentamount=\tableindent
2740 \parskip = \smallskipamount
2741 \ifdim \parskip=0pt \parskip=2pt \fi
2742 \let\item = \internalBitem
2743 \let\itemx = \internalBitemx
2745 \def\Etable{\endgraf\afterenvbreak}
2748 \let\Eitemize\Etable
2749 \let\Eenumerate\Etable
2751 % This is the counter used by @enumerate, which is really @itemize
2755 \envdef\itemize{\parsearg\doitemize}
2759 \itemmax=\itemindent
2760 \advance\itemmax by -\itemmargin
2761 \advance\leftskip by \itemindent
2762 \exdentamount=\itemindent
2764 \parskip=\smallskipamount
2765 \ifdim\parskip=0pt \parskip=2pt \fi
2766 \def\itemcontents{#1}%
2767 % @itemize with no arg is equivalent to @itemize @bullet.
2768 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2769 \let\item=\itemizeitem
2772 % Definition of @item while inside @itemize and @enumerate.
2775 \advance\itemno by 1 % for enumerations
2776 {\let\par=\endgraf \smallbreak}% reasonable place to break
2778 % If the document has an @itemize directly after a section title, a
2779 % \nobreak will be last on the list, and \sectionheading will have
2780 % done a \vskip-\parskip. In that case, we don't want to zero
2781 % parskip, or the item text will crash with the heading. On the
2782 % other hand, when there is normal text preceding the item (as there
2783 % usually is), we do want to zero parskip, or there would be too much
2784 % space. In that case, we won't have a \nobreak before. At least
2785 % that's the theory.
2786 \ifnum\lastpenalty<10000 \parskip=0in \fi
2788 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
2789 \vadjust{\penalty 1200}}% not good to break after first line of item.
2793 % \splitoff TOKENS\endmark defines \first to be the first token in
2794 % TOKENS, and \rest to be the remainder.
2796 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2798 % Allow an optional argument of an uppercase letter, lowercase letter,
2799 % or number, to specify the first label in the enumerated list. No
2800 % argument is the same as `1'.
2802 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
2803 \def\enumeratey #1 #2\endenumeratey{%
2804 % If we were given no argument, pretend we were given `1'.
2806 \ifx\thearg\empty \def\thearg{1}\fi
2808 % Detect if the argument is a single token. If so, it might be a
2809 % letter. Otherwise, the only valid thing it can be is a number.
2810 % (We will always have one token, because of the test we just made.
2811 % This is a good thing, since \splitoff doesn't work given nothing at
2812 % all -- the first parameter is undelimited.)
2813 \expandafter\splitoff\thearg\endmark
2815 % Only one token in the argument. It could still be anything.
2816 % A ``lowercase letter'' is one whose \lccode is nonzero.
2817 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2818 % not equal to itself.
2819 % Otherwise, we assume it's a number.
2821 % We need the \relax at the end of the \ifnum lines to stop TeX from
2822 % continuing to look for a <number>.
2824 \ifnum\lccode\expandafter`\thearg=0\relax
2825 \numericenumerate % a number (we hope)
2828 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
2829 \lowercaseenumerate % lowercase letter
2831 \uppercaseenumerate % uppercase letter
2835 % Multiple tokens in the argument. We hope it's a number.
2840 % An @enumerate whose labels are integers. The starting integer is
2843 \def\numericenumerate{%
2845 \startenumeration{\the\itemno}%
2848 % The starting (lowercase) letter is in \thearg.
2849 \def\lowercaseenumerate{%
2850 \itemno = \expandafter`\thearg
2852 % Be sure we're not beyond the end of the alphabet.
2854 \errmessage{No more lowercase letters in @enumerate; get a bigger
2861 % The starting (uppercase) letter is in \thearg.
2862 \def\uppercaseenumerate{%
2863 \itemno = \expandafter`\thearg
2865 % Be sure we're not beyond the end of the alphabet.
2867 \errmessage{No more uppercase letters in @enumerate; get a bigger
2874 % Call \doitemize, adding a period to the first argument and supplying the
2875 % common last two arguments. Also subtract one from the initial value in
2876 % \itemno, since @item increments \itemno.
2878 \def\startenumeration#1{%
2879 \advance\itemno by -1
2880 \doitemize{#1.}\flushcr
2883 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2886 \def\alphaenumerate{\enumerate{a}}
2887 \def\capsenumerate{\enumerate{A}}
2888 \def\Ealphaenumerate{\Eenumerate}
2889 \def\Ecapsenumerate{\Eenumerate}
2892 % @multitable macros
2893 % Amy Hendrickson, 8/18/94, 3/6/96
2895 % @multitable ... @end multitable will make as many columns as desired.
2896 % Contents of each column will wrap at width given in preamble. Width
2897 % can be specified either with sample text given in a template line,
2898 % or in percent of \hsize, the current width of text on page.
2900 % Table can continue over pages but will only break between lines.
2904 % Either define widths of columns in terms of percent of \hsize:
2905 % @multitable @columnfractions .25 .3 .45
2908 % Numbers following @columnfractions are the percent of the total
2909 % current hsize to be used for each column. You may use as many
2910 % columns as desired.
2913 % Or use a template:
2914 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2916 % using the widest term desired in each column.
2918 % Each new table line starts with @item, each subsequent new column
2919 % starts with @tab. Empty columns may be produced by supplying @tab's
2920 % with nothing between them for as many times as empty columns are needed,
2921 % ie, @tab@tab@tab will produce two empty columns.
2923 % @item, @tab do not need to be on their own lines, but it will not hurt
2926 % Sample multitable:
2928 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2929 % @item first col stuff @tab second col stuff @tab third col
2936 % @item first col stuff @tab second col stuff
2937 % @tab Many paragraphs of text may be used in any column.
2939 % They will wrap at the width determined by the template.
2940 % @item@tab@tab This will be in third column.
2943 % Default dimensions may be reset by user.
2944 % @multitableparskip is vertical space between paragraphs in table.
2945 % @multitableparindent is paragraph indent in table.
2946 % @multitablecolmargin is horizontal space to be left between columns.
2947 % @multitablelinespace is space to leave between table items, baseline
2949 % 0pt means it depends on current normal line spacing.
2951 \newskip\multitableparskip
2952 \newskip\multitableparindent
2953 \newdimen\multitablecolspace
2954 \newskip\multitablelinespace
2955 \multitableparskip=0pt
2956 \multitableparindent=6pt
2957 \multitablecolspace=12pt
2958 \multitablelinespace=0pt
2960 % Macros used to set up halign preamble:
2962 \let\endsetuptable\relax
2963 \def\xendsetuptable{\endsetuptable}
2964 \let\columnfractions\relax
2965 \def\xcolumnfractions{\columnfractions}
2968 % #1 is the @columnfraction, usually a decimal number like .5, but might
2969 % be just 1. We just use it, whatever it is.
2971 \def\pickupwholefraction#1 {%
2972 \global\advance\colcount by 1
2973 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
2980 \ifx\firstarg\xendsetuptable
2983 \ifx\firstarg\xcolumnfractions
2984 \global\setpercenttrue
2987 \let\go\pickupwholefraction
2989 \global\advance\colcount by 1
2990 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
2991 % separator; typically that is always in the input, anyway.
2992 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
2995 \ifx\go\pickupwholefraction
2996 % Put the argument back for the \pickupwholefraction call, so
2997 % we'll always have a period there to be parsed.
2998 \def\go{\pickupwholefraction#1}%
3000 \let\go = \setuptable
3006 % multitable-only commands.
3008 % @headitem starts a heading row, which we typeset in bold.
3009 % Assignments have to be global since we are inside the implicit group
3010 % of an alignment entry. Note that \everycr resets \everytab.
3011 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
3013 % A \tab used to include \hskip1sp. But then the space in a template
3014 % line is not enough. That is bad. So let's go back to just `&' until
3015 % we encounter the problem it was intended to solve again.
3016 % --karl, nathan@acm.org, 20apr99.
3017 \def\tab{\checkenv\multitable &\the\everytab}%
3019 % @multitable ... @end multitable definitions:
3021 \newtoks\everytab % insert after every tab.
3023 \envdef\multitable{%
3027 % @item within a multitable starts a normal row.
3028 % We use \def instead of \let so that if one of the multitable entries
3029 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3030 % \endtemplate) expanding \doitemize.
3035 \setmultitablespacing
3036 \parskip=\multitableparskip
3037 \parindent=\multitableparindent
3043 \global\everytab={}%
3044 \global\colcount=0 % Reset the column counter.
3045 % Check for saved footnotes, etc.
3047 % Keeps underfull box messages off when table breaks over pages.
3049 % Maybe so, but it also creates really weird page breaks when the
3050 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3051 % problem manifests itself, so it can be fixed for real --karl.
3055 \parsearg\domultitable
3057 \def\domultitable#1{%
3058 % To parse everything between @multitable and @item:
3059 \setuptable#1 \endsetuptable
3061 % This preamble sets up a generic column definition, which will
3062 % be used as many times as user calls for columns.
3063 % \vtop will set a single line and will also let text wrap and
3064 % continue for many paragraphs if desired.
3066 \global\advance\colcount by 1
3069 % Use the current \colcount to find the correct column width:
3070 \hsize=\expandafter\csname col\the\colcount\endcsname
3072 % In order to keep entries from bumping into each other
3073 % we will add a \leftskip of \multitablecolspace to all columns after
3076 % If a template has been used, we will add \multitablecolspace
3077 % to the width of each template entry.
3079 % If the user has set preamble in terms of percent of \hsize we will
3080 % use that dimension as the width of the column, and the \leftskip
3081 % will keep entries from bumping into each other. Table will start at
3082 % left margin and final column will justify at right margin.
3084 % Make sure we don't inherit \rightskip from the outer environment.
3087 % The first column will be indented with the surrounding text.
3088 \advance\hsize by\leftskip
3091 % If user has not set preamble in terms of percent of \hsize
3092 % we will advance \hsize by \multitablecolspace.
3093 \advance\hsize by \multitablecolspace
3095 % In either case we will make \leftskip=\multitablecolspace:
3096 \leftskip=\multitablecolspace
3098 % Ignoring space at the beginning and end avoids an occasional spurious
3099 % blank line, when TeX decides to break the line at the space before the
3100 % box from the multistrut, so the strut ends up on a line by itself.
3102 % @multitable @columnfractions .11 .89
3104 % @tab Legal holiday which is valid in major parts of the whole country.
3105 % Is automatically provided with highlighting sequences respectively
3106 % marking characters.
3107 \noindent\ignorespaces##\unskip\multistrut
3112 \egroup % end the \halign
3113 \global\setpercentfalse
3116 \def\setmultitablespacing{%
3117 \def\multistrut{\strut}% just use the standard line spacing
3119 % Compute \multitablelinespace (if not defined by user) for use in
3120 % \multitableparskip calculation. We used define \multistrut based on
3121 % this, but (ironically) that caused the spacing to be off.
3122 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3123 \ifdim\multitablelinespace=0pt
3124 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3125 \global\advance\multitablelinespace by-\ht0
3127 %% Test to see if parskip is larger than space between lines of
3128 %% table. If not, do nothing.
3129 %% If so, set to same dimension as multitablelinespace.
3130 \ifdim\multitableparskip>\multitablelinespace
3131 \global\multitableparskip=\multitablelinespace
3132 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3133 %% than skip between lines in the table.
3135 \ifdim\multitableparskip=0pt
3136 \global\multitableparskip=\multitablelinespace
3137 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3138 %% than skip between lines in the table.
3142 \message{conditionals,}
3144 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3145 % @ifnotxml always succeed. They currently do nothing; we don't
3146 % attempt to check whether the conditionals are properly nested. But we
3147 % have to remember that they are conditionals, so that @end doesn't
3148 % attempt to close an environment group.
3151 \expandafter\let\csname #1\endcsname = \relax
3152 \expandafter\let\csname iscond.#1\endcsname = 1
3155 \makecond{ifnotdocbook}
3156 \makecond{ifnothtml}
3157 \makecond{ifnotinfo}
3158 \makecond{ifnotplaintext}
3161 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3163 \def\direntry{\doignore{direntry}}
3164 \def\documentdescription{\doignore{documentdescription}}
3165 \def\docbook{\doignore{docbook}}
3166 \def\html{\doignore{html}}
3167 \def\ifdocbook{\doignore{ifdocbook}}
3168 \def\ifhtml{\doignore{ifhtml}}
3169 \def\ifinfo{\doignore{ifinfo}}
3170 \def\ifnottex{\doignore{ifnottex}}
3171 \def\ifplaintext{\doignore{ifplaintext}}
3172 \def\ifxml{\doignore{ifxml}}
3173 \def\ignore{\doignore{ignore}}
3174 \def\menu{\doignore{menu}}
3175 \def\xml{\doignore{xml}}
3177 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3179 % A count to remember the depth of nesting.
3180 \newcount\doignorecount
3182 \def\doignore#1{\begingroup
3183 % Scan in ``verbatim'' mode:
3185 \catcode`\@ = \other
3186 \catcode`\{ = \other
3187 \catcode`\} = \other
3189 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3192 % Count number of #1's that we've seen.
3195 % Swallow text until we reach the matching `@end #1'.
3199 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3202 \gdef\dodoignore#1{%
3203 % #1 contains the command name as a string, e.g., `ifinfo'.
3205 % Define a command to find the next `@end #1'.
3206 \long\def\doignoretext##1^^M@end #1{%
3207 \doignoretextyyy##1^^M@#1\_STOP_}%
3209 % And this command to find another #1 command, at the beginning of a
3210 % line. (Otherwise, we would consider a line `@c @ifset', for
3211 % example, to count as an @ifset for nesting.)
3212 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3214 % And now expand that command.
3219 \def\doignoreyyy#1{%
3221 \ifx\temp\empty % Nothing found.
3222 \let\next\doignoretextzzz
3223 \else % Found a nested condition, ...
3224 \advance\doignorecount by 1
3225 \let\next\doignoretextyyy % ..., look for another.
3226 % If we're here, #1 ends with ^^M\ifinfo (for example).
3228 \next #1% the token \_STOP_ is present just after this macro.
3231 % We have to swallow the remaining "\_STOP_".
3233 \def\doignoretextzzz#1{%
3234 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3235 \let\next\enddoignore
3236 \else % Still inside a nested condition.
3237 \advance\doignorecount by -1
3238 \let\next\doignoretext % Look for the next @end.
3243 % Finish off ignored text.
3245 % Ignore anything after the last `@end #1'; this matters in verbatim
3246 % environments, where otherwise the newline after an ignored conditional
3247 % would result in a blank line in the output.
3248 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3252 % @set VAR sets the variable VAR to an empty value.
3253 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3255 % Since we want to separate VAR from REST-OF-LINE (which might be
3256 % empty), we can't just use \parsearg; we have to insert a space of our
3257 % own to delimit the rest of the line, and then take it out again if we
3259 % We rely on the fact that \parsearg sets \catcode`\ =10.
3261 \parseargdef\set{\setyyy#1 \endsetyyy}
3262 \def\setyyy#1 #2\endsetyyy{%
3264 \makevalueexpandable
3266 \edef\next{\gdef\makecsname{SET#1}}%
3274 % Remove the trailing space \setxxx inserted.
3275 \def\setzzz#1 \endsetzzz{\next{#1}}
3277 % @clear VAR clears (i.e., unsets) the variable VAR.
3279 \parseargdef\clear{%
3281 \makevalueexpandable
3282 \global\expandafter\let\csname SET#1\endcsname=\relax
3286 % @value{foo} gets the text saved in variable foo.
3287 \def\value{\begingroup\makevalueexpandable\valuexxx}
3288 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3290 \catcode`\- = \active \catcode`\_ = \active
3292 \gdef\makevalueexpandable{%
3293 \let\value = \expandablevalue
3294 % We don't want these characters active, ...
3295 \catcode`\-=\other \catcode`\_=\other
3296 % ..., but we might end up with active ones in the argument if
3297 % we're called from @code, as @code{@value{foo-bar_}}, though.
3298 % So \let them to their normal equivalents.
3299 \let-\realdash \let_\normalunderscore
3303 % We have this subroutine so that we can handle at least some @value's
3304 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3305 % The command has to be fully expandable (if the variable is set), since
3306 % the result winds up in the index file. This means that if the
3307 % variable's value contains other Texinfo commands, it's almost certain
3308 % it will fail (although perhaps we could fix that with sufficient work
3309 % to do a one-level expansion on the result, instead of complete).
3311 \def\expandablevalue#1{%
3312 \expandafter\ifx\csname SET#1\endcsname\relax
3313 {[No value for ``#1'']}%
3314 \message{Variable `#1', used in @value, is not set.}%
3316 \csname SET#1\endcsname
3320 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3323 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3326 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3329 \makevalueexpandable
3331 \expandafter\ifx\csname SET#2\endcsname\relax
3332 #1% If not set, redefine \next.
3337 \def\ifsetfail{\doignore{ifset}}
3339 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3340 % defined with @set, or has been undefined with @clear.
3342 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3343 % above code: if the variable is not set, do nothing, if it is set,
3344 % then redefine \next to \ifclearfail.
3347 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3348 \def\ifclearfail{\doignore{ifclear}}
3350 % @dircategory CATEGORY -- specify a category of the dir file
3351 % which this file should belong to. Ignore this in TeX.
3352 \let\dircategory=\comment
3354 % @defininfoenclose.
3355 \let\definfoenclose=\comment
3359 % Index generation facilities
3361 % Define \newwrite to be identical to plain tex's \newwrite
3362 % except not \outer, so it can be used within macros and \if's.
3363 \edef\newwrite{\makecsname{ptexnewwrite}}
3365 % \newindex {foo} defines an index named foo.
3366 % It automatically defines \fooindex such that
3367 % \fooindex ...rest of line... puts an entry in the index foo.
3368 % It also defines \fooindfile to be the number of the output channel for
3369 % the file that accumulates this index. The file's extension is foo.
3370 % The name of an index should be no more than 2 characters long
3371 % for the sake of vms.
3375 \expandafter\newwrite \csname#1indfile\endcsname
3376 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3378 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3379 \noexpand\doindex{#1}}
3382 % @defindex foo == \newindex{foo}
3384 \def\defindex{\parsearg\newindex}
3386 % Define @defcodeindex, like @defindex except put all entries in @code.
3388 \def\defcodeindex{\parsearg\newcodeindex}
3390 \def\newcodeindex#1{%
3392 \expandafter\newwrite \csname#1indfile\endcsname
3393 \openout \csname#1indfile\endcsname \jobname.#1
3395 \expandafter\xdef\csname#1index\endcsname{%
3396 \noexpand\docodeindex{#1}}%
3400 % @synindex foo bar makes index foo feed into index bar.
3401 % Do this instead of @defindex foo if you don't want it as a separate index.
3403 % @syncodeindex foo bar similar, but put all entries made for index foo
3406 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3407 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3409 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3410 % #3 the target index (bar).
3411 \def\dosynindex#1#2#3{%
3412 % Only do \closeout if we haven't already done it, else we'll end up
3413 % closing the target index.
3414 \expandafter \ifx\csname donesynindex#2\endcsname \undefined
3415 % The \closeout helps reduce unnecessary open files; the limit on the
3416 % Acorn RISC OS is a mere 16 files.
3417 \expandafter\closeout\csname#2indfile\endcsname
3418 \expandafter\let\csname\donesynindex#2\endcsname = 1
3420 % redefine \fooindfile:
3421 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3422 \expandafter\let\csname#2indfile\endcsname=\temp
3423 % redefine \fooindex:
3424 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3427 % Define \doindex, the driver for all \fooindex macros.
3428 % Argument #1 is generated by the calling \fooindex macro,
3429 % and it is "foo", the name of the index.
3431 % \doindex just uses \parsearg; it calls \doind for the actual work.
3432 % This is because \doind is more useful to call from other macros.
3434 % There is also \dosubind {index}{topic}{subtopic}
3435 % which makes an entry in a two-level index such as the operation index.
3437 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3438 \def\singleindexer #1{\doind{\indexname}{#1}}
3440 % like the previous two, but they put @code around the argument.
3441 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3442 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3444 % Take care of Texinfo commands that can appear in an index entry.
3445 % Since there are some commands we want to expand, and others we don't,
3446 % we have to laboriously prevent expansion for those that we don't.
3449 \escapechar = `\\ % use backslash in output files.
3450 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3451 \def\ {\realbackslash\space }%
3453 % Need these in case \tex is in effect and \{ is a \delimiter again.
3454 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3455 % braces and backslashes are used only as delimiters.
3459 % I don't entirely understand this, but when an index entry is
3460 % generated from a macro call, the \endinput which \scanmacro inserts
3461 % causes processing to be prematurely terminated. This is,
3462 % apparently, because \indexsorttmp is fully expanded, and \endinput
3463 % is an expandable command. The redefinition below makes \endinput
3464 % disappear altogether for that purpose -- although logging shows that
3465 % processing continues to some further point. On the other hand, it
3466 % seems \endinput does not hurt in the printed index arg, since that
3467 % is still getting written without apparent harm.
3469 % Sample source (mac-idx3.tex, reported by Graham Percival to
3470 % help-texinfo, 22may06):
3471 % @macro funindex {WORD}
3475 % @funindex commtest
3477 % The above is not enough to reproduce the bug, but it gives the flavor.
3479 % Sample whatsit resulting:
3480 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
3483 \let\endinput = \empty
3485 % Do the redefinitions.
3489 % For the aux and toc files, @ is the escape character. So we want to
3490 % redefine everything using @ as the escape character (instead of
3491 % \realbackslash, still used for index files). When everything uses @,
3492 % this will be simpler.
3497 \let\{ = \lbraceatcmd
3498 \let\} = \rbraceatcmd
3500 % Do the redefinitions.
3505 % Called from \indexdummies and \atdummies.
3507 \def\commondummies{%
3509 % \definedummyword defines \#1 as \string\#1\space, thus effectively
3510 % preventing its expansion. This is used only for control% words,
3511 % not control letters, because the \space would be incorrect for
3512 % control characters, but is needed to separate the control word
3513 % from whatever follows.
3515 % For control letters, we have \definedummyletter, which omits the
3518 % These can be used both for control words that take an argument and
3519 % those that do not. If it is followed by {arg} in the input, then
3520 % that will dutifully get written to the index (or wherever).
3522 \def\definedummyword ##1{\def##1{\string##1\space}}%
3523 \def\definedummyletter##1{\def##1{\string##1}}%
3524 \let\definedummyaccent\definedummyletter
3526 \commondummiesnofonts
3528 \definedummyletter\_%
3530 % Non-English letters.
3542 \definedummyword\exclamdown
3543 \definedummyword\questiondown
3544 \definedummyword\ordf
3545 \definedummyword\ordm
3547 % Although these internal commands shouldn't show up, sometimes they do.
3549 \definedummyword\gtr
3550 \definedummyword\hat
3551 \definedummyword\less
3554 \definedummyword\tclose
3557 \definedummyword\LaTeX
3558 \definedummyword\TeX
3560 % Assorted special characters.
3561 \definedummyword\bullet
3562 \definedummyword\comma
3563 \definedummyword\copyright
3564 \definedummyword\registeredsymbol
3565 \definedummyword\dots
3566 \definedummyword\enddots
3567 \definedummyword\equiv
3568 \definedummyword\error
3569 \definedummyword\euro
3570 \definedummyword\expansion
3571 \definedummyword\minus
3572 \definedummyword\pounds
3573 \definedummyword\point
3574 \definedummyword\print
3575 \definedummyword\result
3576 \definedummyword\textdegree
3578 % We want to disable all macros so that they are not expanded by \write.
3581 \normalturnoffactive
3583 % Handle some cases of @value -- where it does not contain any
3584 % (non-fully-expandable) commands.
3585 \makevalueexpandable
3588 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3590 \def\commondummiesnofonts{%
3591 % Control letters and accents.
3592 \definedummyletter\!%
3593 \definedummyaccent\"%
3594 \definedummyaccent\'%
3595 \definedummyletter\*%
3596 \definedummyaccent\,%
3597 \definedummyletter\.%
3598 \definedummyletter\/%
3599 \definedummyletter\:%
3600 \definedummyaccent\=%
3601 \definedummyletter\?%
3602 \definedummyaccent\^%
3603 \definedummyaccent\`%
3604 \definedummyaccent\~%
3608 \definedummyword\dotaccent
3609 \definedummyword\ringaccent
3610 \definedummyword\tieaccent
3611 \definedummyword\ubaraccent
3612 \definedummyword\udotaccent
3613 \definedummyword\dotless
3615 % Texinfo font commands.
3622 % Commands that take arguments.
3623 \definedummyword\acronym
3624 \definedummyword\cite
3625 \definedummyword\code
3626 \definedummyword\command
3627 \definedummyword\dfn
3628 \definedummyword\emph
3629 \definedummyword\env
3630 \definedummyword\file
3631 \definedummyword\kbd
3632 \definedummyword\key
3633 \definedummyword\math
3634 \definedummyword\option
3635 \definedummyword\pxref
3636 \definedummyword\ref
3637 \definedummyword\samp
3638 \definedummyword\strong
3639 \definedummyword\tie
3640 \definedummyword\uref
3641 \definedummyword\url
3642 \definedummyword\var
3643 \definedummyword\verb
3645 \definedummyword\xref
3648 % \indexnofonts is used when outputting the strings to sort the index
3649 % by, and when constructing control sequence names. It eliminates all
3650 % control sequences and just writes whatever the best ASCII sort string
3651 % would be for a given command (usually its argument).
3654 % Accent commands should become @asis.
3655 \def\definedummyaccent##1{\let##1\asis}%
3656 % We can just ignore other control letters.
3657 \def\definedummyletter##1{\let##1\empty}%
3658 % Hopefully, all control words can become @asis.
3659 \let\definedummyword\definedummyaccent
3661 \commondummiesnofonts
3663 % Don't no-op \tt, since it isn't a user-level command
3664 % and is used in the definitions of the active chars like <, >, |, etc.
3665 % Likewise with the other plain tex font commands.
3670 % how to handle braces?
3671 \def\_{\normalunderscore}%
3673 % Non-English letters.
3686 \def\questiondown{?}%
3693 % Assorted special characters.
3694 % (The following {} will end up in the sort string, but that's ok.)
3695 \def\bullet{bullet}%
3697 \def\copyright{copyright}%
3698 \def\registeredsymbol{R}%
3704 \def\expansion{==>}%
3706 \def\pounds{pounds}%
3710 \def\textdegree{degrees}%
3712 % We need to get rid of all macros, leaving only the arguments (if present).
3713 % Of course this is not nearly correct, but it is the best we can do for now.
3714 % makeinfo does not expand macros in the argument to @deffn, which ends up
3715 % writing an index entry, and texindex isn't prepared for an index sort entry
3716 % that starts with \.
3718 % Since macro invocations are followed by braces, we can just redefine them
3719 % to take a single TeX argument. The case of a macro invocation that
3720 % goes to end-of-line is not handled.
3725 \let\indexbackslash=0 %overridden during \printindex.
3726 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
3728 % Most index entries go through here, but \dosubind is the general case.
3729 % #1 is the index name, #2 is the entry text.
3730 \def\doind#1#2{\dosubind{#1}{#2}{}}
3732 % Workhorse for all \fooindexes.
3733 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3734 % empty if called from \doind, as we usually are (the main exception
3735 % is with most defuns, which call us directly).
3737 \def\dosubind#1#2#3{%
3740 % Store the main index entry text (including the third arg).
3742 % If third arg is present, precede it with a space.
3744 \ifx\thirdarg\empty \else
3745 \toks0 = \expandafter{\the\toks0 \space #3}%
3748 \edef\writeto{\csname#1indfile\endcsname}%
3759 % Write the entry in \toks0 to the index file:
3761 \def\dosubindwrite{%
3762 % Put the index entry in the margin if desired.
3763 \ifx\SETmarginindex\relax\else
3764 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
3767 % Remember, we are within a group.
3768 \indexdummies % Must do this here, since \bf, etc expand at this stage
3769 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3770 % so it will be output as is; and it will print as backslash.
3772 % Process the index entry with all font commands turned off, to
3773 % get the string to sort by.
3775 \edef\temp{\the\toks0}% need full expansion
3776 \xdef\indexsorttmp{\temp}%
3779 % Set up the complete index entry, with both the sort key and
3780 % the original text, including any font commands. We write
3781 % three arguments to \entry to the .?? file (four in the
3782 % subentry case), texindex reduces to two when writing the .??s
3786 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3791 % Take care of unwanted page breaks:
3793 % If a skip is the last thing on the list now, preserve it
3794 % by backing up by \lastskip, doing the \write, then inserting
3795 % the skip again. Otherwise, the whatsit generated by the
3796 % \write will make \lastskip zero. The result is that sequences
3801 % will have extra space inserted, because the \medbreak in the
3802 % start of the @defun won't see the skip inserted by the @end of
3803 % the previous defun.
3805 % But don't do any of this if we're not in vertical mode. We
3806 % don't want to do a \vskip and prematurely end a paragraph.
3808 % Avoid page breaks due to these extra skips, too.
3810 % But wait, there is a catch there:
3811 % We'll have to check whether \lastskip is zero skip. \ifdim is not
3812 % sufficient for this purpose, as it ignores stretch and shrink parts
3813 % of the skip. The only way seems to be to check the textual
3814 % representation of the skip.
3816 % The following is almost like \def\zeroskipmacro{0.0pt} except that
3817 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3819 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
3823 \def\dosubindsanitize{%
3824 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3826 \edef\lastskipmacro{\the\lastskip}%
3827 \count255 = \lastpenalty
3829 % If \lastskip is nonzero, that means the last item was a
3830 % skip. And since a skip is discardable, that means this
3831 % -\skip0 glue we're inserting is preceded by a
3832 % non-discardable item, therefore it is not a potential
3833 % breakpoint, therefore no \nobreak needed.
3834 \ifx\lastskipmacro\zeroskipmacro
3841 \ifx\lastskipmacro\zeroskipmacro
3842 % If \lastskip was zero, perhaps the last item was a penalty, and
3843 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
3844 % to re-insert the same penalty (values >10000 are used for various
3845 % signals); since we just inserted a non-discardable item, any
3846 % following glue (such as a \parskip) would be a breakpoint. For example:
3848 % @deffn deffn-whatever
3849 % @vindex index-whatever
3851 % would allow a break between the index-whatever whatsit
3852 % and the "Description." paragraph.
3853 \ifnum\count255>9999 \penalty\count255 \fi
3855 % On the other hand, if we had a nonzero \lastskip,
3856 % this make-up glue would be preceded by a non-discardable item
3857 % (the whatsit from the \write), so we must insert a \nobreak.
3858 \nobreak\vskip\skip0
3862 % The index entry written in the file actually looks like
3863 % \entry {sortstring}{page}{topic}
3865 % \entry {sortstring}{page}{topic}{subtopic}
3866 % The texindex program reads in these files and writes files
3867 % containing these kinds of lines:
3869 % before the first topic whose initial is c
3870 % \entry {topic}{pagelist}
3871 % for a topic that is used without subtopics
3873 % for the beginning of a topic that is used with subtopics
3874 % \secondary {subtopic}{pagelist}
3875 % for each subtopic.
3877 % Define the user-accessible indexing commands
3878 % @findex, @vindex, @kindex, @cindex.
3880 \def\findex {\fnindex}
3881 \def\kindex {\kyindex}
3882 \def\cindex {\cpindex}
3883 \def\vindex {\vrindex}
3884 \def\tindex {\tpindex}
3885 \def\pindex {\pgindex}
3887 \def\cindexsub {\begingroup\obeylines\cindexsub}
3889 \gdef\cindexsub "#1" #2^^M{\endgroup %
3890 \dosubind{cp}{#2}{#1}}}
3892 % Define the macros used in formatting output of the sorted index material.
3894 % @printindex causes a particular index (the ??s file) to get printed.
3895 % It does not print any chapter heading (usually an @unnumbered).
3897 \parseargdef\printindex{\begingroup
3898 \dobreak \chapheadingskip{10000}%
3902 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
3904 % See if the index file exists and is nonempty.
3905 % Change catcode of @ here so that if the index file contains
3907 % as its first line, TeX doesn't complain about mismatched braces
3908 % (because it thinks @} is a control sequence).
3910 \openin 1 \jobname.#1s
3912 % \enddoublecolumns gets confused if there is no text in the index,
3913 % and it loses the chapter title and the aux file entries for the
3914 % index. The easiest way to prevent this problem is to make sure
3915 % there is some text.
3916 \putwordIndexNonexistent
3919 % If the index file exists but is empty, then \openin leaves \ifeof
3920 % false. We have to make TeX try to read something from the file, so
3921 % it can discover if there is anything in it.
3924 \putwordIndexIsEmpty
3926 % Index files are almost Texinfo source, but we use \ as the escape
3927 % character. It would be better to use @, but that's too big a change
3928 % to make right now.
3929 \def\indexbackslash{\backslashcurfont}%
3940 % These macros are used by the sorted index file itself.
3941 % Change them to control the appearance of the index.
3944 % Some minor font changes for the special characters.
3945 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
3947 % Remove any glue we may have, we'll be inserting our own.
3950 % We like breaks before the index initials, so insert a bonus.
3952 \vskip 0pt plus 3\baselineskip
3954 \vskip 0pt plus -3\baselineskip
3956 % Typeset the initial. Making this add up to a whole number of
3957 % baselineskips increases the chance of the dots lining up from column
3958 % to column. It still won't often be perfect, because of the stretch
3959 % we need before each entry, but it's better.
3961 % No shrink because it confuses \balancecolumns.
3962 \vskip 1.67\baselineskip plus .5\baselineskip
3963 \leftline{\secbf #1}%
3964 % Do our best not to break after the initial.
3966 \vskip .33\baselineskip plus .1\baselineskip
3969 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3970 % then page number (#2) flushed to the right margin. It is used for index
3971 % and table of contents entries. The paragraph is indented by \leftskip.
3973 % A straightforward implementation would start like this:
3974 % \def\entry#1#2{...
3975 % But this frozes the catcodes in the argument, and can cause problems to
3976 % @code, which sets - active. This problem was fixed by a kludge---
3977 % ``-'' was active throughout whole index, but this isn't really right.
3979 % The right solution is to prevent \entry from swallowing the whole text.
3984 % Start a new paragraph if necessary, so our assignments below can't
3985 % affect previous text.
3988 % Do not fill out the last line with white space.
3991 % No extra space above this paragraph.
3994 % Do not prefer a separate line ending with a hyphen to fewer lines.
3995 \finalhyphendemerits = 0
3997 % \hangindent is only relevant when the entry text and page number
3998 % don't both fit on one line. In that case, bob suggests starting the
3999 % dots pretty far over on the line. Unfortunately, a large
4000 % indentation looks wrong when the entry text itself is broken across
4001 % lines. So we use a small indentation and put up with long leaders.
4003 % \hangafter is reset to 1 (which is the value we want) at the start
4004 % of each paragraph, so we need not do anything with that.
4007 % When the entry text needs to be broken, just fill out the first line
4009 \rightskip = 0pt plus1fil
4011 % A bit of stretch before each entry for the benefit of balancing
4015 % Swallow the left brace of the text (first parameter):
4016 \afterassignment\doentry
4020 \bgroup % Instead of the swallowed brace.
4022 \aftergroup\finishentry
4023 % And now comes the text of the entry.
4025 \def\finishentry#1{%
4026 % #1 is the page number.
4028 % The following is kludged to not output a line of dots in the index if
4029 % there are no page numbers. The next person who breaks this will be
4030 % cursed by a Unix daemon.
4033 \edef\tempc{\tempa}%
4034 \edef\tempd{\tempb}%
4039 % If we must, put the page number on a line of its own, and fill out
4040 % this line with blank space. (The \hfil is overwhelmed with the
4041 % fill leaders glue in \indexdotfill if the page number does fit.)
4043 \null\nobreak\indexdotfill % Have leaders before the page number.
4045 % The `\ ' here is removed by the implicit \unskip that TeX does as
4046 % part of (the primitive) \par. Without it, a spurious underfull
4059 % Like plain.tex's \dotfill, except uses up at least 1 em.
4060 \def\indexdotfill{\cleaders
4061 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4063 \def\primary #1{\line{#1\hfil}}
4065 \newskip\secondaryindent \secondaryindent=0.5cm
4066 \def\secondary#1#2{{%
4071 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4073 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4080 % Define two-column mode, which we use to typeset indexes.
4081 % Adapted from the TeXbook, page 416, which is to say,
4082 % the manmac.tex format used to print the TeXbook itself.
4086 \newdimen\doublecolumnhsize
4088 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4089 % Grab any single-column material above us.
4092 % Here is a possibility not foreseen in manmac: if we accumulate a
4093 % whole lot of material, we might end up calling this \output
4094 % routine twice in a row (see the doublecol-lose test, which is
4095 % essentially a couple of indexes with @setchapternewpage off). In
4096 % that case we just ship out what is in \partialpage with the normal
4097 % output routine. Generally, \partialpage will be empty when this
4098 % runs and this will be a no-op. See the indexspread.tex test case.
4099 \ifvoid\partialpage \else
4100 \onepageout{\pagecontents\partialpage}%
4103 \global\setbox\partialpage = \vbox{%
4104 % Unvbox the main output page.
4106 \kern-\topskip \kern\baselineskip
4109 \eject % run that output routine to set \partialpage
4111 % Use the double-column output routine for subsequent pages.
4112 \output = {\doublecolumnout}%
4114 % Change the page size parameters. We could do this once outside this
4115 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4116 % format, but then we repeat the same computation. Repeating a couple
4117 % of assignments once per index is clearly meaningless for the
4118 % execution time, so we may as well do it in one place.
4120 % First we halve the line length, less a little for the gutter between
4121 % the columns. We compute the gutter based on the line length, so it
4122 % changes automatically with the paper format. The magic constant
4123 % below is chosen so that the gutter has the same value (well, +-<1pt)
4124 % as it did when we hard-coded it.
4126 % We put the result in a separate register, \doublecolumhsize, so we
4127 % can restore it in \pagesofar, after \hsize itself has (potentially)
4130 \doublecolumnhsize = \hsize
4131 \advance\doublecolumnhsize by -.04154\hsize
4132 \divide\doublecolumnhsize by 2
4133 \hsize = \doublecolumnhsize
4135 % Double the \vsize as well. (We don't need a separate register here,
4136 % since nobody clobbers \vsize.)
4140 % The double-column output routine for all double-column pages except
4143 \def\doublecolumnout{%
4144 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4145 % Get the available space for the double columns -- the normal
4146 % (undoubled) page height minus any material left over from the
4150 \advance\dimen@ by -\ht\partialpage
4152 % box0 will be the left-hand column, box2 the right.
4153 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4154 \onepageout\pagesofar
4156 \penalty\outputpenalty
4159 % Re-output the contents of the output page -- any previous material,
4160 % followed by the two boxes we just split, in box0 and box2.
4164 \hsize = \doublecolumnhsize
4165 \wd0=\hsize \wd2=\hsize
4166 \hbox to\pagewidth{\box0\hfil\box2}%
4169 % All done with double columns.
4170 \def\enddoublecolumns{%
4171 % The following penalty ensures that the page builder is exercised
4172 % _before_ we change the output routine. This is necessary in the
4173 % following situation:
4175 % The last section of the index consists only of a single entry.
4176 % Before this section, \pagetotal is less than \pagegoal, so no
4177 % break occurs before the last section starts. However, the last
4178 % section, consisting of \initial and the single \entry, does not
4179 % fit on the page and has to be broken off. Without the following
4180 % penalty the page builder will not be exercised until \eject
4181 % below, and by that time we'll already have changed the output
4182 % routine to the \balancecolumns version, so the next-to-last
4183 % double-column page will be processed with \balancecolumns, which
4184 % is wrong: The two columns will go to the main vertical list, with
4185 % the broken-off section in the recent contributions. As soon as
4186 % the output routine finishes, TeX starts reconsidering the page
4187 % break. The two columns and the broken-off section both fit on the
4188 % page, because the two columns now take up only half of the page
4189 % goal. When TeX sees \eject from below which follows the final
4190 % section, it invokes the new output routine that we've set after
4191 % \balancecolumns below; \onepageout will try to fit the two columns
4192 % and the final section into the vbox of \pageheight (see
4193 % \pagebody), causing an overfull box.
4195 % Note that glue won't work here, because glue does not exercise the
4196 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4200 % Split the last of the double-column material. Leave it on the
4201 % current page, no automatic page break.
4204 % If we end up splitting too much material for the current page,
4205 % though, there will be another page break right after this \output
4206 % invocation ends. Having called \balancecolumns once, we do not
4207 % want to call it again. Therefore, reset \output to its normal
4208 % definition right away. (We hope \balancecolumns will never be
4209 % called on to balance too much material, but if it is, this makes
4210 % the output somewhat more palatable.)
4211 \global\output = {\onepageout{\pagecontents\PAGE}}%
4214 \endgroup % started in \begindoublecolumns
4216 % \pagegoal was set to the doubled \vsize above, since we restarted
4217 % the current page. We're now back to normal single-column
4218 % typesetting, so reset \pagegoal to the normal \vsize (after the
4219 % \endgroup where \vsize got restored).
4223 % Called at the end of the double column material.
4224 \def\balancecolumns{%
4225 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4227 \advance\dimen@ by \topskip
4228 \advance\dimen@ by-\baselineskip
4229 \divide\dimen@ by 2 % target to split to
4230 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4231 \splittopskip = \topskip
4232 % Loop until we get a decent breakpoint.
4236 \global\setbox3 = \copy0
4237 \global\setbox1 = \vsplit3 to \dimen@
4239 \global\advance\dimen@ by 1pt
4242 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4243 \setbox0=\vbox to\dimen@{\unvbox1}%
4244 \setbox2=\vbox to\dimen@{\unvbox3}%
4248 \catcode`\@ = \other
4251 \message{sectioning,}
4252 % Chapters, sections, etc.
4254 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4255 % sections so that we can refer to them unambiguously in the pdf
4256 % outlines by their "section number". We avoid collisions with chapter
4257 % numbers by starting them at 10000. (If a document ever has 10000
4258 % chapters, we're in trouble anyway, I'm sure.)
4259 \newcount\unnumberedno \unnumberedno = 10000
4261 \newcount\secno \secno=0
4262 \newcount\subsecno \subsecno=0
4263 \newcount\subsubsecno \subsubsecno=0
4265 % This counter is funny since it counts through charcodes of letters A, B, ...
4266 \newcount\appendixno \appendixno = `\@
4268 % \def\appendixletter{\char\the\appendixno}
4269 % We do the following ugly conditional instead of the above simple
4270 % construct for the sake of pdftex, which needs the actual
4271 % letter in the expansion, not just typeset.
4273 \def\appendixletter{%
4274 \ifnum\appendixno=`A A%
4275 \else\ifnum\appendixno=`B B%
4276 \else\ifnum\appendixno=`C C%
4277 \else\ifnum\appendixno=`D D%
4278 \else\ifnum\appendixno=`E E%
4279 \else\ifnum\appendixno=`F F%
4280 \else\ifnum\appendixno=`G G%
4281 \else\ifnum\appendixno=`H H%
4282 \else\ifnum\appendixno=`I I%
4283 \else\ifnum\appendixno=`J J%
4284 \else\ifnum\appendixno=`K K%
4285 \else\ifnum\appendixno=`L L%
4286 \else\ifnum\appendixno=`M M%
4287 \else\ifnum\appendixno=`N N%
4288 \else\ifnum\appendixno=`O O%
4289 \else\ifnum\appendixno=`P P%
4290 \else\ifnum\appendixno=`Q Q%
4291 \else\ifnum\appendixno=`R R%
4292 \else\ifnum\appendixno=`S S%
4293 \else\ifnum\appendixno=`T T%
4294 \else\ifnum\appendixno=`U U%
4295 \else\ifnum\appendixno=`V V%
4296 \else\ifnum\appendixno=`W W%
4297 \else\ifnum\appendixno=`X X%
4298 \else\ifnum\appendixno=`Y Y%
4299 \else\ifnum\appendixno=`Z Z%
4300 % The \the is necessary, despite appearances, because \appendixletter is
4301 % expanded while writing the .toc file. \char\appendixno is not
4302 % expandable, thus it is written literally, thus all appendixes come out
4303 % with the same letter (or @) in the toc without it.
4304 \else\char\the\appendixno
4305 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4306 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4308 % Each @chapter defines this as the name of the chapter.
4309 % page headings and footings can use it. @section does likewise.
4310 % However, they are not reliable, because we don't use marks.
4314 \newcount\absseclevel % used to calculate proper heading level
4315 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4317 % @raisesections: treat @section as chapter, @subsection as section, etc.
4318 \def\raisesections{\global\advance\secbase by -1}
4319 \let\up=\raisesections % original BFox name
4321 % @lowersections: treat @chapter as section, @section as subsection, etc.
4322 \def\lowersections{\global\advance\secbase by 1}
4323 \let\down=\lowersections % original BFox name
4325 % we only have subsub.
4326 \chardef\maxseclevel = 3
4328 % A numbered section within an unnumbered changes to unnumbered too.
4329 % To achive this, remember the "biggest" unnum. sec. we are currently in:
4330 \chardef\unmlevel = \maxseclevel
4332 % Trace whether the current chapter is an appendix or not:
4333 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4334 \def\chapheadtype{N}
4336 % Choose a heading macro
4337 % #1 is heading type
4338 % #2 is heading level
4339 % #3 is text for heading
4340 \def\genhead#1#2#3{%
4341 % Compute the abs. sec. level:
4343 \advance\absseclevel by \secbase
4344 % Make sure \absseclevel doesn't fall outside the range:
4345 \ifnum \absseclevel < 0
4348 \ifnum \absseclevel > 3
4355 \ifnum \absseclevel < \unmlevel
4356 \chardef\unmlevel = \absseclevel
4359 % Check for appendix sections:
4360 \ifnum \absseclevel = 0
4361 \edef\chapheadtype{\headtype}%
4363 \if \headtype A\if \chapheadtype N%
4364 \errmessage{@appendix... within a non-appendix chapter}%
4367 % Check for numbered within unnumbered:
4368 \ifnum \absseclevel > \unmlevel
4371 \chardef\unmlevel = 3
4374 % Now print the heading:
4378 \or \unnumberedseczzz{#3}%
4379 \or \unnumberedsubseczzz{#3}%
4380 \or \unnumberedsubsubseczzz{#3}%
4386 \or \appendixsectionzzz{#3}%
4387 \or \appendixsubseczzz{#3}%
4388 \or \appendixsubsubseczzz{#3}%
4394 \or \numberedsubseczzz{#3}%
4395 \or \numberedsubsubseczzz{#3}%
4399 \suppressfirstparagraphindent
4403 \def\numhead{\genhead N}
4404 \def\apphead{\genhead A}
4405 \def\unnmhead{\genhead U}
4407 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4408 % all lower-level sectioning counters to zero.
4410 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4411 % (e.g., figures), q.v. By default (before any chapter), that is empty.
4412 \let\chaplevelprefix = \empty
4414 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4416 % section resetting is \global in case the chapter is in a group, such
4417 % as an @include file.
4418 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4419 \global\advance\chapno by 1
4422 \gdef\chaplevelprefix{\the\chapno.}%
4425 \message{\putwordChapter\space \the\chapno}%
4427 % Write the actual heading.
4428 \chapmacro{#1}{Ynumbered}{\the\chapno}%
4430 % So @section and the like are numbered underneath this chapter.
4431 \global\let\section = \numberedsec
4432 \global\let\subsection = \numberedsubsec
4433 \global\let\subsubsection = \numberedsubsubsec
4436 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4437 \def\appendixzzz#1{%
4438 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4439 \global\advance\appendixno by 1
4440 \gdef\chaplevelprefix{\appendixletter.}%
4443 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4444 \message{\appendixnum}%
4446 \chapmacro{#1}{Yappendix}{\appendixletter}%
4448 \global\let\section = \appendixsec
4449 \global\let\subsection = \appendixsubsec
4450 \global\let\subsubsection = \appendixsubsubsec
4453 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4454 \def\unnumberedzzz#1{%
4455 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4456 \global\advance\unnumberedno by 1
4458 % Since an unnumbered has no number, no prefix for figures.
4459 \global\let\chaplevelprefix = \empty
4462 % This used to be simply \message{#1}, but TeX fully expands the
4463 % argument to \message. Therefore, if #1 contained @-commands, TeX
4464 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4465 % expanded @cite (which turns out to cause errors because \cite is meant
4466 % to be executed, not expanded).
4468 % Anyway, we don't want the fully-expanded definition of @cite to appear
4469 % as a result of the \message, we just want `@cite' itself. We use
4470 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4471 % simply yielding the contents of <toks register>. (We also do this for
4474 \message{(\the\toks0)}%
4476 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
4478 \global\let\section = \unnumberedsec
4479 \global\let\subsection = \unnumberedsubsec
4480 \global\let\subsubsection = \unnumberedsubsubsec
4483 % @centerchap is like @unnumbered, but the heading is centered.
4484 \outer\parseargdef\centerchap{%
4485 % Well, we could do the following in a group, but that would break
4486 % an assumption that \chapmacro is called at the outermost level.
4487 % Thus we are safer this way: --kasal, 24feb04
4488 \let\centerparametersmaybe = \centerparameters
4490 \let\centerparametersmaybe = \relax
4493 % @top is like @unnumbered.
4497 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4499 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4500 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
4503 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4504 \def\appendixsectionzzz#1{%
4505 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4506 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
4508 \let\appendixsec\appendixsection
4510 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4511 \def\unnumberedseczzz#1{%
4512 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
4513 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
4517 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
4518 \def\numberedsubseczzz#1{%
4519 \global\subsubsecno=0 \global\advance\subsecno by 1
4520 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
4523 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
4524 \def\appendixsubseczzz#1{%
4525 \global\subsubsecno=0 \global\advance\subsecno by 1
4526 \sectionheading{#1}{subsec}{Yappendix}%
4527 {\appendixletter.\the\secno.\the\subsecno}%
4530 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
4531 \def\unnumberedsubseczzz#1{%
4532 \global\subsubsecno=0 \global\advance\subsecno by 1
4533 \sectionheading{#1}{subsec}{Ynothing}%
4534 {\the\unnumberedno.\the\secno.\the\subsecno}%
4538 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
4539 \def\numberedsubsubseczzz#1{%
4540 \global\advance\subsubsecno by 1
4541 \sectionheading{#1}{subsubsec}{Ynumbered}%
4542 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
4545 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
4546 \def\appendixsubsubseczzz#1{%
4547 \global\advance\subsubsecno by 1
4548 \sectionheading{#1}{subsubsec}{Yappendix}%
4549 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
4552 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
4553 \def\unnumberedsubsubseczzz#1{%
4554 \global\advance\subsubsecno by 1
4555 \sectionheading{#1}{subsubsec}{Ynothing}%
4556 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
4559 % These macros control what the section commands do, according
4560 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4561 % Define them by default for a numbered chapter.
4562 \let\section = \numberedsec
4563 \let\subsection = \numberedsubsec
4564 \let\subsubsection = \numberedsubsubsec
4566 % Define @majorheading, @heading and @subheading
4568 % NOTE on use of \vbox for chapter headings, section headings, and such:
4569 % 1) We use \vbox rather than the earlier \line to permit
4570 % overlong headings to fold.
4571 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
4572 % heading is obnoxious; this forbids it.
4573 % 3) Likewise, headings look best if no \parindent is used, and
4574 % if justification is not attempted. Hence \raggedright.
4578 {\advance\chapheadingskip by 10pt \chapbreak }%
4579 \parsearg\chapheadingzzz
4582 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4583 \def\chapheadingzzz#1{%
4584 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4585 \parindent=0pt\raggedright
4587 \bigskip \par\penalty 200\relax
4588 \suppressfirstparagraphindent
4591 % @heading, @subheading, @subsubheading.
4592 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
4593 \suppressfirstparagraphindent}
4594 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
4595 \suppressfirstparagraphindent}
4596 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
4597 \suppressfirstparagraphindent}
4599 % These macros generate a chapter, section, etc. heading only
4600 % (including whitespace, linebreaking, etc. around it),
4601 % given all the information in convenient, parsed form.
4603 %%% Args are the skip and penalty (usually negative)
4604 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
4606 %%% Define plain chapter starts, and page on/off switching for it
4607 % Parameter controlling skip before chapter headings (if needed)
4609 \newskip\chapheadingskip
4611 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
4612 \def\chappager{\par\vfill\supereject}
4613 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi}
4615 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
4618 \global\let\contentsalignmacro = \chappager
4619 \global\let\pchapsepmacro=\chapbreak
4620 \global\let\pagealignmacro=\chappager}
4623 \global\let\contentsalignmacro = \chappager
4624 \global\let\pchapsepmacro=\chappager
4625 \global\let\pagealignmacro=\chappager
4626 \global\def\HEADINGSon{\HEADINGSsingle}}
4629 \global\let\contentsalignmacro = \chapoddpage
4630 \global\let\pchapsepmacro=\chapoddpage
4631 \global\let\pagealignmacro=\chapoddpage
4632 \global\def\HEADINGSon{\HEADINGSdouble}}
4638 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4639 % Yappendix, Yomitfromtoc), #3 the chapter number.
4641 % To test against our argument.
4642 \def\Ynothingkeyword{Ynothing}
4643 \def\Yomitfromtockeyword{Yomitfromtoc}
4644 \def\Yappendixkeyword{Yappendix}
4646 \def\chapmacro#1#2#3{%
4651 % Have to define \thissection before calling \donoderef, because the
4652 % xref code eventually uses it. On the other hand, it has to be called
4653 % after \pchapsepmacro, or the headline will change too soon.
4654 \gdef\thissection{#1}%
4655 \gdef\thischaptername{#1}%
4657 % Only insert the separating space if we have a chapter/appendix
4658 % number, and don't print the unnumbered ``number''.
4660 \ifx\temptype\Ynothingkeyword
4662 \def\toctype{unnchap}%
4663 \gdef\thischapternum{}%
4664 \gdef\thischapter{#1}%
4665 \else\ifx\temptype\Yomitfromtockeyword
4666 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
4668 \gdef\thischapternum{}%
4669 \gdef\thischapter{}%
4670 \else\ifx\temptype\Yappendixkeyword
4671 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
4673 \xdef\thischapternum{\appendixletter}%
4674 % We don't substitute the actual chapter name into \thischapter
4675 % because we don't want its macros evaluated now. And we don't
4676 % use \thissection because that changes with each section.
4678 \xdef\thischapter{\putwordAppendix{} \appendixletter:
4679 \noexpand\thischaptername}%
4681 \setbox0 = \hbox{#3\enspace}%
4682 \def\toctype{numchap}%
4683 \xdef\thischapternum{\the\chapno}%
4684 \xdef\thischapter{\putwordChapter{} \the\chapno:
4685 \noexpand\thischaptername}%
4688 % Write the toc entry for this chapter. Must come before the
4689 % \donoderef, because we include the current node name in the toc
4690 % entry, and \donoderef resets it to empty.
4691 \writetocentry{\toctype}{#1}{#3}%
4693 % For pdftex, we have to write out the node definition (aka, make
4694 % the pdfdest) after any page break, but before the actual text has
4695 % been typeset. If the destination for the pdf outline is after the
4696 % text, then jumping from the outline may wind up with the text not
4697 % being visible, for instance under high magnification.
4700 % Typeset the actual heading.
4701 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4702 \hangindent=\wd0 \centerparametersmaybe
4705 \nobreak\bigskip % no page break after a chapter title
4709 % @centerchap -- centered and unnumbered.
4710 \let\centerparametersmaybe = \relax
4711 \def\centerparameters{%
4712 \advance\rightskip by 3\rightskip
4713 \leftskip = \rightskip
4718 % I don't think this chapter style is supported any more, so I'm not
4719 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
4721 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
4723 \def\unnchfopen #1{%
4724 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4725 \parindent=0pt\raggedright
4726 \rm #1\hfill}}\bigskip \par\nobreak
4728 \def\chfopen #1#2{\chapoddpage {\chapfonts
4729 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
4732 \def\centerchfopen #1{%
4733 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
4735 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4738 \global\let\chapmacro=\chfopen
4739 \global\let\centerchapmacro=\centerchfopen}
4742 % Section titles. These macros combine the section number parts and
4743 % call the generic \sectionheading to do the printing.
4745 \newskip\secheadingskip
4746 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
4748 % Subsection titles.
4749 \newskip\subsecheadingskip
4750 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
4752 % Subsubsection titles.
4753 \def\subsubsecheadingskip{\subsecheadingskip}
4754 \def\subsubsecheadingbreak{\subsecheadingbreak}
4757 % Print any size, any type, section title.
4759 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4760 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4763 \def\sectionheading#1#2#3#4{%
4765 % Switch to the right set of fonts.
4766 \csname #2fonts\endcsname \rm
4768 % Insert space above the heading.
4769 \csname #2headingbreak\endcsname
4771 % Only insert the space after the number if we have a section number.
4772 \def\sectionlevel{#2}%
4775 \ifx\temptype\Ynothingkeyword
4778 \gdef\thissection{#1}%
4779 \else\ifx\temptype\Yomitfromtockeyword
4780 % for @headings -- no section number, don't include in toc,
4781 % and don't redefine \thissection.
4784 \let\sectionlevel=\empty
4785 \else\ifx\temptype\Yappendixkeyword
4786 \setbox0 = \hbox{#4\enspace}%
4788 \gdef\thissection{#1}%
4790 \setbox0 = \hbox{#4\enspace}%
4792 \gdef\thissection{#1}%
4795 % Write the toc entry (before \donoderef). See comments in \chapmacro.
4796 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
4798 % Write the node reference (= pdf destination for pdftex).
4799 % Again, see comments in \chapmacro.
4802 % Interline glue will be inserted when the vbox is completed.
4803 % That glue will be a valid breakpoint for the page, since it'll be
4804 % preceded by a whatsit (usually from the \donoderef, or from the
4805 % \writetocentry if there was no node). We don't want to allow that
4806 % break, since then the whatsits could end up on page n while the
4807 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
4810 % Output the actual section heading.
4811 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
4812 \hangindent=\wd0 % zero if no section number
4815 % Add extra space after the heading -- half of whatever came above it.
4816 % Don't allow stretch, though.
4817 \kern .5 \csname #2headingskip\endcsname
4819 % Do not let the kern be a potential breakpoint, as it would be if it
4820 % was followed by glue.
4823 % We'll almost certainly start a paragraph next, so don't let that
4824 % glue accumulate. (Not a breakpoint because it's preceded by a
4825 % discardable item.)
4828 % This is purely so the last item on the list is a known \penalty >
4829 % 10000. This is so \startdefun can avoid allowing breakpoints after
4830 % section headings. Otherwise, it would insert a valid breakpoint between:
4832 % @section sec-whatever
4833 % @deffn def-whatever
4839 % Table of contents.
4842 % Write an entry to the toc file, opening it if necessary.
4843 % Called from @chapter, etc.
4845 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4846 % We append the current node name (if any) and page number as additional
4847 % arguments for the \{chap,sec,...}entry macros which will eventually
4848 % read this. The node name is used in the pdf outlines as the
4849 % destination to jump to.
4851 % We open the .toc file for writing here instead of at @setfilename (or
4852 % any other fixed time) so that @contents can be anywhere in the document.
4853 % But if #1 is `omit', then we don't do anything. This is used for the
4854 % table of contents chapter openings themselves.
4856 \newif\iftocfileopened
4857 \def\omitkeyword{omit}%
4859 \def\writetocentry#1#2#3{%
4860 \edef\writetoctype{#1}%
4861 \ifx\writetoctype\omitkeyword \else
4862 \iftocfileopened\else
4863 \immediate\openout\tocfile = \jobname.toc
4864 \global\tocfileopenedtrue
4870 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
4876 % Tell \shipout to create a pdf destination on each page, if we're
4877 % writing pdf. These are used in the table of contents. We can't
4878 % just write one on every page because the title pages are numbered
4879 % 1 and 2 (the page numbers aren't printed), and so are the first
4880 % two pages of the document. Thus, we'd have two destinations named
4881 % `1', and two named `2'.
4882 \ifpdf \global\pdfmakepagedesttrue \fi
4886 % These characters do not print properly in the Computer Modern roman
4887 % fonts, so we must take special care. This is more or less redundant
4888 % with the Texinfo input format setup at the end of this file.
4890 \def\activecatcodes{%
4903 % Read the toc file, which is essentially Texinfo input.
4910 \newskip\contentsrightmargin \contentsrightmargin=1in
4911 \newcount\savepageno
4912 \newcount\lastnegativepageno \lastnegativepageno = -1
4914 % Prepare to read what we've written to \tocfile.
4916 \def\startcontents#1{%
4917 % If @setchapternewpage on, and @headings double, the contents should
4918 % start on an odd page, unlike chapters. Thus, we maintain
4919 % \contentsalignmacro in parallel with \pagealignmacro.
4920 % From: Torbjorn Granlund <tege@matematik.su.se>
4922 \immediate\closeout\tocfile
4924 % Don't need to put `Contents' or `Short Contents' in the headline.
4925 % It is abundantly clear what they are.
4927 \chapmacro{#1}{Yomitfromtoc}{}%
4929 \savepageno = \pageno
4930 \begingroup % Set up to handle contents files properly.
4931 \raggedbottom % Worry more about breakpoints than the bottom.
4932 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
4934 % Roman numerals for page numbers.
4935 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
4939 % Normal (long) toc.
4941 \startcontents{\putwordTOC}%
4942 \openin 1 \jobname.toc
4947 \contentsalignmacro % in case @setchapternewpage odd is in effect
4953 \lastnegativepageno = \pageno
4954 \global\pageno = \savepageno
4957 % And just the chapters.
4958 \def\summarycontents{%
4959 \startcontents{\putwordShortTOC}%
4961 \let\numchapentry = \shortchapentry
4962 \let\appentry = \shortchapentry
4963 \let\unnchapentry = \shortunnchapentry
4964 % We want a true roman here for the page numbers.
4966 \let\rm=\shortcontrm \let\bf=\shortcontbf
4967 \let\sl=\shortcontsl \let\tt=\shortconttt
4969 \hyphenpenalty = 10000
4970 \advance\baselineskip by 1pt % Open it up a little.
4971 \def\numsecentry##1##2##3##4{}
4972 \let\appsecentry = \numsecentry
4973 \let\unnsecentry = \numsecentry
4974 \let\numsubsecentry = \numsecentry
4975 \let\appsubsecentry = \numsecentry
4976 \let\unnsubsecentry = \numsecentry
4977 \let\numsubsubsecentry = \numsecentry
4978 \let\appsubsubsecentry = \numsecentry
4979 \let\unnsubsubsecentry = \numsecentry
4980 \openin 1 \jobname.toc
4986 \contentsalignmacro % in case @setchapternewpage odd is in effect
4988 \lastnegativepageno = \pageno
4989 \global\pageno = \savepageno
4991 \let\shortcontents = \summarycontents
4993 % Typeset the label for a chapter or appendix for the short contents.
4994 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4996 \def\shortchaplabel#1{%
4997 % This space should be enough, since a single number is .5em, and the
4998 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4999 % But use \hss just in case.
5000 % (This space doesn't include the extra space that gets added after
5001 % the label; that gets put in by \shortchapentry above.)
5003 % We'd like to right-justify chapter numbers, but that looks strange
5004 % with appendix letters. And right-justifying numbers and
5005 % left-justifying letters looks strange when there is less than 10
5006 % chapters. Have to read the whole toc once to know how many chapters
5007 % there are before deciding ...
5008 \hbox to 1em{#1\hss}%
5011 % These macros generate individual entries in the table of contents.
5012 % The first argument is the chapter or section name.
5013 % The last argument is the page number.
5014 % The arguments in between are the chapter number, section number, ...
5016 % Chapters, in the main contents.
5017 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5019 % Chapters, in the short toc.
5020 % See comments in \dochapentry re vbox and related settings.
5021 \def\shortchapentry#1#2#3#4{%
5022 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5025 % Appendices, in the main contents.
5026 % Need the word Appendix, and a fixed-size box.
5028 \def\appendixbox#1{%
5029 % We use M since it's probably the widest letter.
5030 \setbox0 = \hbox{\putwordAppendix{} M}%
5031 \hbox to \wd0{\putwordAppendix{} #1\hss}}
5033 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5035 % Unnumbered chapters.
5036 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5037 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5040 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5041 \let\appsecentry=\numsecentry
5042 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5045 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5046 \let\appsubsecentry=\numsubsecentry
5047 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5049 % And subsubsections.
5050 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5051 \let\appsubsubsecentry=\numsubsubsecentry
5052 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5054 % This parameter controls the indentation of the various levels.
5055 % Same as \defaultparindent.
5056 \newdimen\tocindent \tocindent = 15pt
5058 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5061 % If the toc has to be broken over pages, we want it to be at chapters
5062 % if at all possible; hence the \penalty.
5063 \def\dochapentry#1#2{%
5064 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5067 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5069 \nobreak\vskip .25\baselineskip plus.1\baselineskip
5072 \def\dosecentry#1#2{\begingroup
5073 \secentryfonts \leftskip=\tocindent
5074 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5077 \def\dosubsecentry#1#2{\begingroup
5078 \subsecentryfonts \leftskip=2\tocindent
5079 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5082 \def\dosubsubsecentry#1#2{\begingroup
5083 \subsubsecentryfonts \leftskip=3\tocindent
5084 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5087 % We use the same \entry macro as for the index entries.
5088 \let\tocentry = \entry
5090 % Space between chapter (or whatever) number and the title.
5091 \def\labelspace{\hskip1em \relax}
5093 \def\dopageno#1{{\rm #1}}
5094 \def\doshortpageno#1{{\rm #1}}
5096 \def\chapentryfonts{\secfonts \rm}
5097 \def\secentryfonts{\textfonts}
5098 \def\subsecentryfonts{\textfonts}
5099 \def\subsubsecentryfonts{\textfonts}
5102 \message{environments,}
5103 % @foo ... @end foo.
5105 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
5107 % Since these characters are used in examples, it should be an even number of
5108 % \tt widths. Each \tt character is 1en, so two makes it 1em.
5111 \def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
5112 \def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}}
5113 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
5114 \def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}}
5116 % The @error{} command.
5117 % Adapted from the TeXbook's \boxit.
5121 {\tentt \global\dimen0 = 3em}% Width of the box.
5122 \dimen2 = .55pt % Thickness of rules
5123 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
5124 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
5126 \setbox\errorbox=\hbox to \dimen0{\hfil
5127 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
5128 \advance\hsize by -2\dimen2 % Rules.
5130 \hrule height\dimen2
5131 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
5132 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
5133 \kern3pt\vrule width\dimen2}% Space to right.
5134 \hrule height\dimen2}
5137 \def\error{\leavevmode\lower.7ex\copy\errorbox}
5139 % @tex ... @end tex escapes into raw Tex temporarily.
5140 % One exception: @ is still an escape character, so that @end tex works.
5141 % But \@ or @@ will get a plain tex @ character.
5144 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5145 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5146 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5156 \let\bullet=\ptexbullet
5161 \let\equiv=\ptexequiv
5164 \let\indent=\ptexindent
5165 \let\noindent=\ptexnoindent
5172 \let\frenchspacing=\plainfrenchspacing
5174 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5175 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5178 % There is no need to define \Etex.
5180 % Define @lisp ... @end lisp.
5181 % @lisp environment forms a group so it can rebind things,
5182 % including the definition of @end lisp (which normally is erroneous).
5184 % Amount to narrow the margins by for @lisp.
5185 \newskip\lispnarrowing \lispnarrowing=0.4in
5187 % This is the definition that ^^M gets inside @lisp, @example, and other
5188 % such environments. \null is better than a space, since it doesn't
5190 \def\lisppar{\null\endgraf}
5192 % This space is always present above and below environments.
5193 \newskip\envskipamount \envskipamount = 0pt
5195 % Make spacing and below environment symmetrical. We use \parskip here
5196 % to help in doing that, since in @example-like environments \parskip
5197 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
5198 % start of the next paragraph will insert \parskip.
5200 \def\aboveenvbreak{{%
5201 % =10000 instead of <10000 because of a special case in \itemzzz and
5202 % \sectionheading, q.v.
5203 \ifnum \lastpenalty=10000 \else
5204 \advance\envskipamount by \parskip
5206 \ifdim\lastskip<\envskipamount
5208 % it's not a good place to break if the last penalty was \nobreak
5210 \ifnum\lastpenalty<10000 \penalty-50 \fi
5211 \vskip\envskipamount
5216 \let\afterenvbreak = \aboveenvbreak
5218 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
5219 % also clear it, so that its embedded environments do the narrowing again.
5220 \let\nonarrowing=\relax
5222 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
5223 % environment contents.
5224 \font\circle=lcircle10
5226 \newdimen\cartouter\newdimen\cartinner
5227 \newskip\normbskip\newskip\normpskip\newskip\normlskip
5228 \circthick=\fontdimen8\circle
5230 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
5231 \def\ctr{{\hskip 6pt\circle\char'010}}
5232 \def\cbl{{\circle\char'012\hskip -6pt}}
5233 \def\cbr{{\hskip 6pt\circle\char'011}}
5234 \def\carttop{\hbox to \cartouter{\hskip\lskip
5235 \ctl\leaders\hrule height\circthick\hfil\ctr
5237 \def\cartbot{\hbox to \cartouter{\hskip\lskip
5238 \cbl\leaders\hrule height\circthick\hfil\cbr
5241 \newskip\lskip\newskip\rskip
5244 \ifhmode\par\fi % can't be in the midst of a paragraph.
5246 \lskip=\leftskip \rskip=\rightskip
5247 \leftskip=0pt\rightskip=0pt % we want these *outside*.
5248 \cartinner=\hsize \advance\cartinner by-\lskip
5249 \advance\cartinner by-\rskip
5251 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
5252 % side, and for 6pt waste from
5253 % each corner char, and rule thickness
5254 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
5255 % Flag to tell @lisp, etc., not to narrow margin.
5256 \let\nonarrowing = t%
5258 \baselineskip=0pt\parskip=0pt\lineskip=0pt
5266 \baselineskip=\normbskip
5267 \lineskip=\normlskip
5270 \comment % For explanation, see the end of \def\group.
5285 % This macro is called at the beginning of all the @example variants,
5289 \hfuzz = 12pt % Don't be fussy
5290 \sepspaces % Make spaces be word-separators rather than space tokens.
5291 \let\par = \lisppar % don't ignore blank lines
5292 \obeylines % each line of input is a line of output
5295 \emergencystretch = 0pt % don't try to avoid overfull boxes
5296 \ifx\nonarrowing\relax
5297 \advance \leftskip by \lispnarrowing
5298 \exdentamount=\lispnarrowing
5300 \let\nonarrowing = \relax
5302 \let\exdent=\nofillexdent
5305 % If you want all examples etc. small: @set dispenvsize small.
5306 % If you want even small examples the full size: @set dispenvsize nosmall.
5307 % This affects the following displayed environments:
5308 % @example, @display, @format, @lisp
5310 \def\smallword{small}
5311 \def\nosmallword{nosmall}
5312 \let\SETdispenvsize\relax
5313 \def\setnormaldispenv{%
5314 \ifx\SETdispenvsize\smallword
5315 % end paragraph for sake of leading, in case document has no blank
5316 % line. This is redundant with what happens in \aboveenvbreak, but
5317 % we need to do it before changing the fonts, and it's inconvenient
5318 % to change the fonts afterward.
5319 \ifnum \lastpenalty=10000 \else \endgraf \fi
5320 \smallexamplefonts \rm
5323 \def\setsmalldispenv{%
5324 \ifx\SETdispenvsize\nosmallword
5326 \ifnum \lastpenalty=10000 \else \endgraf \fi
5327 \smallexamplefonts \rm
5331 % We often define two environments, @foo and @smallfoo.
5332 % Let's do it by one command:
5333 \def\makedispenv #1#2{
5334 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
5335 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
5336 \expandafter\let\csname E#1\endcsname \afterenvbreak
5337 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
5340 % Define two synonyms:
5341 \def\maketwodispenvs #1#2#3{
5342 \makedispenv{#1}{#3}
5343 \makedispenv{#2}{#3}
5346 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
5348 % @smallexample and @smalllisp: use smaller fonts.
5349 % Originally contributed by Pavel@xerox.
5351 \maketwodispenvs {lisp}{example}{%
5354 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
5355 \gobble % eat return
5357 % @display/@smalldisplay: same as @lisp except keep current font.
5359 \makedispenv {display}{%
5364 % @format/@smallformat: same as @display except don't narrow margins.
5366 \makedispenv{format}{%
5367 \let\nonarrowing = t%
5372 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
5374 \let\nonarrowing = t%
5378 \let\Eflushleft = \afterenvbreak
5382 \envdef\flushright{%
5383 \let\nonarrowing = t%
5385 \advance\leftskip by 0pt plus 1fill
5388 \let\Eflushright = \afterenvbreak
5391 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
5392 % and narrows the margins. We keep \parskip nonzero in general, since
5393 % we're doing normal filling. So, when using \aboveenvbreak and
5394 % \afterenvbreak, temporarily make \parskip 0.
5397 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
5400 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
5401 \ifx\nonarrowing\relax
5402 \advance\leftskip by \lispnarrowing
5403 \advance\rightskip by \lispnarrowing
5404 \exdentamount = \lispnarrowing
5406 \let\nonarrowing = \relax
5408 \parsearg\quotationlabel
5411 % We have retained a nonzero parskip for the environment, since we're
5412 % doing normal filling.
5416 \ifx\quotationauthor\undefined\else
5418 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
5420 {\parskip=0pt \afterenvbreak}%
5423 % If we're given an argument, typeset it in bold with a colon after.
5424 \def\quotationlabel#1{%
5426 \ifx\temp\empty \else
5432 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
5433 % If we want to allow any <char> as delimiter,
5434 % we need the curly braces so that makeinfo sees the @verb command, eg:
5435 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
5437 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
5439 % [Knuth] p.344; only we need to do the other characters Texinfo sets
5440 % active too. Otherwise, they get lost as the first character on a
5443 \do\ \do\\\do\{\do\}\do\$\do\&%
5444 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
5445 \do\<\do\>\do\|\do\@\do+\do\"%
5449 \def\uncatcodespecials{%
5450 \def\do##1{\catcode`##1=\other}\dospecials}
5452 % [Knuth] pp. 380,381,391
5453 % Disable Spanish ligatures ?` and !` of \tt font
5455 \catcode`\`=\active\gdef`{\relax\lq}
5458 % Setup for the @verb command.
5460 % Eight spaces for a tab
5462 \catcode`\^^I=\active
5463 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
5467 \tt % easiest (and conventionally used) font for verbatim
5468 \def\par{\leavevmode\endgraf}%
5471 % Respect line breaks,
5472 % print special symbols as themselves, and
5473 % make each space count
5474 % must do in this order:
5475 \obeylines \uncatcodespecials \sepspaces
5478 % Setup for the @verbatim environment
5480 % Real tab expansion
5481 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
5483 \def\starttabbox{\setbox0=\hbox\bgroup}
5485 % Allow an option to not replace quotes with a regular directed right
5486 % quote/apostrophe (char 0x27), but instead use the undirected quote
5487 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
5488 % the default, but it works for pasting with more pdf viewers (at least
5489 % evince), the lilypond developers report. xpdf does work with the
5492 \def\codequoteright{%
5493 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
5500 % and a similar option for the left quote char vs. a grave accent.
5501 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
5502 % the code environments to do likewise.
5504 \def\codequoteleft{%
5505 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
5513 \catcode`\^^I=\active
5515 \catcode`\^^I=\active
5516 \def^^I{\leavevmode\egroup
5517 \dimen0=\wd0 % the width so far, or since the previous tab
5518 \divide\dimen0 by\tabw
5519 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
5520 \advance\dimen0 by\tabw % advance to next multiple of \tabw
5521 \wd0=\dimen0 \box0 \starttabbox
5525 \gdef\rquoteexpand{\catcode\rquoteChar=\active \def'{\codequoteright}}%
5528 \gdef\lquoteexpand{\catcode\lquoteChar=\active \def`{\codequoteleft}}%
5530 \gdef\quoteexpand{\rquoteexpand \lquoteexpand}%
5533 % start the verbatim environment.
5534 \def\setupverbatim{%
5535 \let\nonarrowing = t%
5537 % Easiest (and conventionally used) font for verbatim
5539 \def\par{\leavevmode\egroup\box0\endgraf}%
5543 % Respect line breaks,
5544 % print special symbols as themselves, and
5545 % make each space count
5546 % must do in this order:
5547 \obeylines \uncatcodespecials \sepspaces
5548 \everypar{\starttabbox}%
5551 % Do the @verb magic: verbatim text is quoted by unique
5552 % delimiter characters. Before first delimiter expect a
5553 % right brace, after last delimiter expect closing brace:
5555 % \def\doverb'{'<char>#1<char>'}'{#1}
5557 % [Knuth] p. 382; only eat outer {}
5559 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
5560 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
5563 \def\verb{\begingroup\setupverb\doverb}
5566 % Do the @verbatim magic: define the macro \doverbatim so that
5567 % the (first) argument ends when '@end verbatim' is reached, ie:
5569 % \def\doverbatim#1@end verbatim{#1}
5571 % For Texinfo it's a lot easier than for LaTeX,
5572 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
5573 % we need not redefine '\', '{' and '}'.
5575 % Inspired by LaTeX's verbatim command set [latex.ltx]
5580 % ignore everything up to the first ^^M, that's the newline at the end
5581 % of the @verbatim input line itself. Otherwise we get an extra blank
5582 % line in the output.
5583 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
5584 % We really want {...\end verbatim} in the body of the macro, but
5585 % without the active space; thus we have to use \xdef and \gobble.
5589 \setupverbatim\doverbatim
5591 \let\Everbatim = \afterenvbreak
5594 % @verbatiminclude FILE - insert text of file in verbatim environment.
5596 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
5598 \def\doverbatiminclude#1{%
5600 \makevalueexpandable
5607 % @copying ... @end copying.
5608 % Save the text away for @insertcopying later.
5610 % We save the uninterpreted tokens, rather than creating a box.
5611 % Saving the text in a box would be much easier, but then all the
5612 % typesetting commands (@smallbook, font changes, etc.) have to be done
5613 % beforehand -- and a) we want @copying to be done first in the source
5614 % file; b) letting users define the frontmatter in as flexible order as
5615 % possible is very desirable.
5617 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
5618 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
5620 \def\insertcopying{%
5622 \parindent = 0pt % paragraph indentation looks wrong on title page
5623 \scanexp\copyingtext
5631 \newskip\defbodyindent \defbodyindent=.4in
5632 \newskip\defargsindent \defargsindent=50pt
5633 \newskip\deflastargmargin \deflastargmargin=18pt
5635 % Start the processing of @deffn:
5637 \ifnum\lastpenalty<10000
5640 % If there are two @def commands in a row, we'll have a \nobreak,
5641 % which is there to keep the function description together with its
5642 % header. But if there's nothing but headers, we need to allow a
5643 % break somewhere. Check specifically for penalty 10002, inserted
5644 % by \defargscommonending, instead of 10000, since the sectioning
5645 % commands also insert a nobreak penalty, and we don't want to allow
5646 % a break between a section heading and a defun.
5648 \ifnum\lastpenalty=10002 \penalty2000 \fi
5650 % Similarly, after a section heading, do not allow a break.
5651 % But do insert the glue.
5652 \medskip % preceded by discardable penalty, so not a breakpoint
5656 \advance\leftskip by \defbodyindent
5657 \exdentamount=\defbodyindent
5661 % First, check whether we are in the right environment:
5664 % As above, allow line break if we have multiple x headers in a row.
5665 % It's not a great place, though.
5666 \ifnum\lastpenalty=10002 \penalty3000 \fi
5668 % And now, it's time to reuse the body of the original defun:
5669 \expandafter\gobbledefun#1%
5671 \def\gobbledefun#1\startdefun{}
5673 % \printdefunline \deffnheader{text}
5675 \def\printdefunline#1#2{%
5677 % call \deffnheader:
5680 \interlinepenalty = 10000
5681 \advance\rightskip by 0pt plus 1fil
5683 \nobreak\vskip -\parskip
5684 \penalty 10002 % signal to \startdefun and \dodefunx
5685 % Some of the @defun-type tags do not enable magic parentheses,
5686 % rendering the following check redundant. But we don't optimize.
5691 \def\Edefun{\endgraf\medbreak}
5693 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5694 % the only thing remainnig is to define \deffnheader.
5697 \expandafter\let\csname E#1\endcsname = \Edefun
5698 \edef\temp{\noexpand\domakedefun
5699 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
5703 % \domakedefun \deffn \deffnx \deffnheader
5705 % Define \deffn and \deffnx, without parameters.
5706 % \deffnheader has to be defined explicitly.
5708 \def\domakedefun#1#2#3{%
5711 \parseargusing\activeparens{\printdefunline#3}%
5713 \def#2{\dodefunx#1}%
5717 %%% Untyped functions:
5719 % @deffn category name args
5720 \makedefun{deffn}{\deffngeneral{}}
5722 % @deffn category class name args
5723 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
5725 % \defopon {category on}class name args
5726 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5728 % \deffngeneral {subind}category name args
5730 \def\deffngeneral#1#2 #3 #4\endheader{%
5731 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
5732 \dosubind{fn}{\code{#3}}{#1}%
5733 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
5736 %%% Typed functions:
5738 % @deftypefn category type name args
5739 \makedefun{deftypefn}{\deftypefngeneral{}}
5741 % @deftypeop category class type name args
5742 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
5744 % \deftypeopon {category on}class type name args
5745 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
5747 % \deftypefngeneral {subind}category type name args
5749 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
5750 \dosubind{fn}{\code{#4}}{#1}%
5751 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5754 %%% Typed variables:
5756 % @deftypevr category type var args
5757 \makedefun{deftypevr}{\deftypecvgeneral{}}
5759 % @deftypecv category class type var args
5760 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
5762 % \deftypecvof {category of}class type var args
5763 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
5765 % \deftypecvgeneral {subind}category type var args
5767 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
5768 \dosubind{vr}{\code{#4}}{#1}%
5769 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
5772 %%% Untyped variables:
5774 % @defvr category var args
5775 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
5777 % @defcv category class var args
5778 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
5780 % \defcvof {category of}class var args
5781 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
5784 % @deftp category name args
5785 \makedefun{deftp}#1 #2 #3\endheader{%
5786 \doind{tp}{\code{#2}}%
5787 \defname{#1}{}{#2}\defunargs{#3\unskip}%
5790 % Remaining @defun-like shortcuts:
5791 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
5792 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
5793 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
5794 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
5795 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
5796 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
5797 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
5798 \makedefun{defmethod}{\defopon\putwordMethodon}
5799 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
5800 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
5801 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
5803 % \defname, which formats the name of the @def (not the args).
5804 % #1 is the category, such as "Function".
5805 % #2 is the return type, if any.
5806 % #3 is the function name.
5808 % We are followed by (but not passed) the arguments, if any.
5810 \def\defname#1#2#3{%
5811 % Get the values of \leftskip and \rightskip as they were outside the @def...
5812 \advance\leftskip by -\defbodyindent
5814 % How we'll format the type name. Putting it in brackets helps
5815 % distinguish it from the body text that may end up on the next line
5818 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
5820 % Figure out line sizes for the paragraph shape.
5821 % The first line needs space for \box0; but if \rightskip is nonzero,
5822 % we need only space for the part of \box0 which exceeds it:
5823 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
5824 % The continuations:
5825 \dimen2=\hsize \advance\dimen2 by -\defargsindent
5826 % (plain.tex says that \dimen1 should be used only as global.)
5827 \parshape 2 0in \dimen0 \defargsindent \dimen2
5829 % Put the type name to the right margin.
5832 \hfil\box0 \kern-\hsize
5833 % \hsize has to be shortened this way:
5835 % Intentionally do not respect \rightskip, since we need the space.
5838 % Allow all lines to be underfull without complaint:
5839 \tolerance=10000 \hbadness=10000
5840 \exdentamount=\defbodyindent
5842 % defun fonts. We use typewriter by default (used to be bold) because:
5843 % . we're printing identifiers, they should be in tt in principle.
5844 % . in languages with many accents, such as Czech or French, it's
5845 % common to leave accents off identifiers. The result looks ok in
5846 % tt, but exceedingly strange in rm.
5847 % . we don't want -- and --- to be treated as ligatures.
5848 % . this still does not fix the ?` and !` ligatures, but so far no
5849 % one has made identifiers using them :).
5851 \def\temp{#2}% return value type
5852 \ifx\temp\empty\else \tclose{\temp} \fi
5853 #3% output function name
5855 {\rm\enskip}% hskip 0.5 em of \tenrm
5858 % arguments will be output next, if any.
5861 % Print arguments in slanted roman (not ttsl), inconsistently with using
5862 % tt for the name. This is because literal text is sometimes needed in
5863 % the argument list (groff manual), and ttsl and tt are not very
5864 % distinguishable. Prevent hyphenation at `-' chars.
5867 % use sl by default (not ttsl),
5869 \df \sl \hyphenchar\font=0
5871 % On the other hand, if an argument has two dashes (for instance), we
5872 % want a way to get ttsl. Let's try @var for that.
5875 \sl\hyphenchar\font=45
5878 % We want ()&[] to print specially on the defun line.
5881 \catcode`\(=\active \catcode`\)=\active
5882 \catcode`\[=\active \catcode`\]=\active
5886 % Make control sequences which act like normal parenthesis chars.
5887 \let\lparen = ( \let\rparen = )
5889 % Be sure that we always have a definition for `(', etc. For example,
5890 % if the fn name has parens in it, \boldbrax will not be in effect yet,
5891 % so TeX would otherwise complain about undefined control sequence.
5894 \global\let(=\lparen \global\let)=\rparen
5895 \global\let[=\lbrack \global\let]=\rbrack
5898 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
5899 \gdef\magicamp{\let&=\amprm}
5902 \newcount\parencount
5904 % If we encounter &foo, then turn on ()-hacking afterwards
5906 \def\amprm#1 {\ampseentrue{\bf\ }}
5910 % At the first level, print parens in roman,
5911 % otherwise use the default font.
5912 \ifnum \parencount=1 \rm \fi
5914 % The \sf parens (in \boldbrax) actually are a little bolder than
5915 % the contained text. This is especially needed for [ and ] .
5919 \def\infirstlevel#1{%
5926 \def\bfafterword#1 {#1 \bf}
5929 \global\advance\parencount by 1
5931 \infirstlevel \bfafterword
5936 \global\advance\parencount by -1
5939 \newcount\brackcount
5941 \global\advance\brackcount by 1
5946 \global\advance\brackcount by -1
5949 \def\checkparencounts{%
5950 \ifnum\parencount=0 \else \badparencount \fi
5951 \ifnum\brackcount=0 \else \badbrackcount \fi
5953 \def\badparencount{%
5954 \errmessage{Unbalanced parentheses in @def}%
5955 \global\parencount=0
5957 \def\badbrackcount{%
5958 \errmessage{Unbalanced square braces in @def}%
5959 \global\brackcount=0
5966 % To do this right we need a feature of e-TeX, \scantokens,
5967 % which we arrange to emulate with a temporary file in ordinary TeX.
5968 \ifx\eTeXversion\undefined
5969 \newwrite\macscribble
5972 \immediate\openout\macscribble=\jobname.tmp
5973 \immediate\write\macscribble{\the\toks0}%
5974 \immediate\closeout\macscribble
5982 \let\xeatspaces\eatspaces
5983 % Undo catcode changes of \startcontents and \doprintindex
5984 % When called from @insertcopying or (short)caption, we need active
5985 % backslash to get it printed correctly. Previously, we had
5986 % \catcode`\\=\other instead. We'll see whether a problem appears
5987 % with macro expansion. --kasal, 19aug04
5988 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
5992 % Append \endinput to make sure that TeX does not see the ending newline.
5993 % I've verified that it is necessary both for e-TeX and for ordinary TeX
5995 \scantokens{#1\endinput}%
6000 \edef\temp{\noexpand\scanmacro{#1}}%
6004 \newcount\paramno % Count of parameters
6005 \newtoks\macname % Macro name
6006 \newif\ifrecursive % Is it recursive?
6008 % List of all defined macros in the form
6009 % \definedummyword\macro1\definedummyword\macro2...
6010 % Currently is also contains all @aliases; the list can be split
6011 % if there is a need.
6014 % Add the macro to \macrolist
6015 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6016 \def\addtomacrolistxxx#1{%
6017 \toks0 = \expandafter{\macrolist\definedummyword#1}%
6018 \xdef\macrolist{\the\toks0}%
6022 % This does \let #1 = #2, with \csnames; that is,
6023 % \let \csname#1\endcsname = \csname#2\endcsname
6024 % (except of course we have to play expansion games).
6028 \csname#1\expandafter\endcsname
6032 % Trim leading and trailing spaces off a string.
6033 % Concepts from aro-bend problem 15 (see CTAN).
6035 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6036 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6037 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6039 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6042 % Trim a single trailing ^^M off a string.
6043 {\catcode`\^^M=\other \catcode`\Q=3%
6044 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6045 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6046 \gdef\eatcrb#1Q#2Q{#1}%
6049 % Macro bodies are absorbed as an argument in a context where
6050 % all characters are catcode 10, 11 or 12, except \ which is active
6051 % (as in normal texinfo). It is necessary to change the definition of \.
6053 % It's necessary to have hard CRs when the macro is executed. This is
6054 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
6055 % body, and then making it the \newlinechar in \scanmacro.
6072 \catcode`\^^M=\other
6075 \def\macrobodyctxt{%
6079 \catcode`\^^M=\other
6088 % \mbodybackslash is the definition of \ in @macro bodies.
6089 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6090 % where N is the macro parameter number.
6091 % We define \csname macarg.\endcsname to be \realbackslash, so
6092 % \\ in macro replacement text gets you a backslash.
6094 {\catcode`@=0 @catcode`@\=@active
6095 @gdef@usembodybackslash{@let\=@mbodybackslash}
6096 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6098 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6100 \def\macro{\recursivefalse\parsearg\macroxxx}
6101 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6104 \getargs{#1}% now \macname is the macname and \argl the arglist
6105 \ifx\argl\empty % no arguments
6108 \expandafter\parsemargdef \argl;%
6110 \if1\csname ismacro.\the\macname\endcsname
6111 \message{Warning: redefining \the\macname}%
6113 \expandafter\ifx\csname \the\macname\endcsname \relax
6114 \else \errmessage{Macro name \the\macname\space already defined}\fi
6115 \global\cslet{macsave.\the\macname}{\the\macname}%
6116 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6117 \addtomacrolist{\the\macname}%
6119 \begingroup \macrobodyctxt
6120 \ifrecursive \expandafter\parsermacbody
6121 \else \expandafter\parsemacbody
6124 \parseargdef\unmacro{%
6125 \if1\csname ismacro.#1\endcsname
6126 \global\cslet{#1}{macsave.#1}%
6127 \global\expandafter\let \csname ismacro.#1\endcsname=0%
6128 % Remove the macro name from \macrolist:
6130 \expandafter\let\csname#1\endcsname \relax
6131 \let\definedummyword\unmacrodo
6132 \xdef\macrolist{\macrolist}%
6135 \errmessage{Macro #1 not defined}%
6139 % Called by \do from \dounmacro on each macro. The idea is to omit any
6140 % macro definitions that have been changed to \relax.
6146 \noexpand\definedummyword \noexpand#1%
6150 % This makes use of the obscure feature that if the last token of a
6151 % <parameter list> is #, then the preceding argument is delimited by
6152 % an opening brace, and that opening brace is not consumed.
6153 \def\getargs#1{\getargsxxx#1{}}
6154 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
6155 \def\getmacname #1 #2\relax{\macname={#1}}
6156 \def\getmacargs#1{\def\argl{#1}}
6158 % Parse the optional {params} list. Set up \paramno and \paramlist
6159 % so \defmacro knows what to do. Define \macarg.blah for each blah
6160 % in the params list, to be ##N where N is the position in that list.
6161 % That gets used by \mbodybackslash (above).
6163 % We need to get `macro parameter char #' into several definitions.
6164 % The technique used is stolen from LaTeX: let \hash be something
6165 % unexpandable, insert that wherever you need a #, and then redefine
6166 % it to # just before using the token list produced.
6168 % The same technique is used to protect \eatspaces till just before
6169 % the macro is used.
6171 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
6172 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
6173 \def\parsemargdefxxx#1,{%
6174 \if#1;\let\next=\relax
6175 \else \let\next=\parsemargdefxxx
6176 \advance\paramno by 1%
6177 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
6178 {\xeatspaces{\hash\the\paramno}}%
6179 \edef\paramlist{\paramlist\hash\the\paramno,}%
6182 % These two commands read recursive and nonrecursive macro bodies.
6183 % (They're different since rec and nonrec macros end differently.)
6185 \long\def\parsemacbody#1@end macro%
6186 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6187 \long\def\parsermacbody#1@end rmacro%
6188 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6190 % This defines the macro itself. There are six cases: recursive and
6191 % nonrecursive macros of zero, one, and many arguments.
6192 % Much magic with \expandafter here.
6193 % \xdef is used so that macro definitions will survive the file
6194 % they're defined in; @include reads the file inside a group.
6196 \let\hash=##% convert placeholders to macro parameter chars
6200 \expandafter\xdef\csname\the\macname\endcsname{%
6201 \noexpand\scanmacro{\temp}}%
6203 \expandafter\xdef\csname\the\macname\endcsname{%
6204 \bgroup\noexpand\macroargctxt
6205 \noexpand\braceorline
6206 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6207 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6208 \egroup\noexpand\scanmacro{\temp}}%
6210 \expandafter\xdef\csname\the\macname\endcsname{%
6211 \bgroup\noexpand\macroargctxt
6212 \noexpand\csname\the\macname xx\endcsname}%
6213 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6214 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6215 \expandafter\expandafter
6217 \expandafter\expandafter
6218 \csname\the\macname xxx\endcsname
6219 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
6224 \expandafter\xdef\csname\the\macname\endcsname{%
6225 \noexpand\norecurse{\the\macname}%
6226 \noexpand\scanmacro{\temp}\egroup}%
6228 \expandafter\xdef\csname\the\macname\endcsname{%
6229 \bgroup\noexpand\macroargctxt
6230 \noexpand\braceorline
6231 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6232 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6234 \noexpand\norecurse{\the\macname}%
6235 \noexpand\scanmacro{\temp}\egroup}%
6237 \expandafter\xdef\csname\the\macname\endcsname{%
6238 \bgroup\noexpand\macroargctxt
6239 \expandafter\noexpand\csname\the\macname xx\endcsname}%
6240 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6241 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6242 \expandafter\expandafter
6244 \expandafter\expandafter
6245 \csname\the\macname xxx\endcsname
6248 \noexpand\norecurse{\the\macname}%
6249 \noexpand\scanmacro{\temp}\egroup}%
6253 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
6255 % \braceorline decides whether the next nonwhitespace character is a
6256 % {. If so it reads up to the closing }, if not, it reads the whole
6257 % line. Whatever was read is then fed to the next control sequence
6258 % as an argument (by \parsebrace or \parsearg)
6259 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
6260 \def\braceorlinexxx{%
6261 \ifx\nchar\bgroup\else
6262 \expandafter\parsearg
6267 % We need some trickery to remove the optional spaces around the equal
6268 % sign. Just make them active and then expand them all to nothing.
6269 \def\alias{\parseargusing\obeyspaces\aliasxxx}
6270 \def\aliasxxx #1{\aliasyyy#1\relax}
6271 \def\aliasyyy #1=#2\relax{%
6273 \expandafter\let\obeyedspace=\empty
6274 \addtomacrolist{#1}%
6275 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
6281 \message{cross references,}
6284 \newif\ifhavexrefs % True if xref values are known.
6285 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
6287 % @inforef is relatively simple.
6288 \def\inforef #1{\inforefzzz #1,,,,**}
6289 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
6290 node \samp{\ignorespaces#1{}}}
6292 % @node's only job in TeX is to define \lastnode, which is used in
6293 % cross-references. The @node line might or might not have commas, and
6294 % might or might not have spaces before the first comma, like:
6295 % @node foo , bar , ...
6296 % We don't want such trailing spaces in the node name.
6298 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
6300 % also remove a trailing comma, in case of something like this:
6301 % @node Help-Cross, , , Cross-refs
6302 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
6303 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
6306 \let\lastnode=\empty
6308 % Write a cross-reference definition for the current node. #1 is the
6309 % type (Ynumbered, Yappendix, Ynothing).
6312 \ifx\lastnode\empty\else
6313 \setref{\lastnode}{#1}%
6314 \global\let\lastnode=\empty
6318 % @anchor{NAME} -- define xref target at arbitrary point.
6320 \newcount\savesfregister
6322 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
6323 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
6324 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
6326 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
6327 % anchor), which consists of three parts:
6328 % 1) NAME-title - the current sectioning name taken from \thissection,
6329 % or the anchor name.
6330 % 2) NAME-snt - section number and type, passed as the SNT arg, or
6331 % empty for anchors.
6332 % 3) NAME-pg - the page number.
6334 % This is called from \donoderef, \anchor, and \dofloat. In the case of
6335 % floats, there is an additional part, which is not written here:
6336 % 4) NAME-lof - the text as it should appear in a @listoffloats.
6342 \atdummies % preserve commands, but don't expand them
6343 \edef\writexrdef##1##2{%
6344 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
6345 ##1}{##2}}% these are parameters of \writexrdef
6347 \toks0 = \expandafter{\thissection}%
6348 \immediate \writexrdef{title}{\the\toks0 }%
6349 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
6350 \writexrdef{pg}{\folio}% will be written later, during \shipout
6355 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
6356 % the node name, #2 the name of the Info cross-reference, #3 the printed
6357 % node name, #4 the name of the Info file, #5 the name of the printed
6358 % manual. All but the node name can be omitted.
6360 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
6361 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
6362 \def\ref#1{\xrefX[#1,,,,,,,]}
6363 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
6365 \def\printedmanual{\ignorespaces #5}%
6366 \def\printedrefname{\ignorespaces #3}%
6367 \setbox1=\hbox{\printedmanual\unskip}%
6368 \setbox0=\hbox{\printedrefname\unskip}%
6370 % No printed node name was explicitly given.
6371 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
6372 % Use the node name inside the square brackets.
6373 \def\printedrefname{\ignorespaces #1}%
6375 % Use the actual chapter/section title appear inside
6376 % the square brackets. Use the real section title if we have it.
6378 % It is in another manual, so we don't have it.
6379 \def\printedrefname{\ignorespaces #1}%
6382 % We know the real title if we have the xref values.
6383 \def\printedrefname{\refx{#1-title}{}}%
6385 % Otherwise just copy the Info node name.
6386 \def\printedrefname{\ignorespaces #1}%
6392 % Make link in pdf output.
6398 % See comments at \activebackslashdouble.
6399 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
6400 \backslashparens\pdfxrefdest}%
6402 \ifnum\filenamelength>0
6403 \startlink attr{/Border [0 0 0]}%
6404 goto file{\the\filename.pdf} name{\pdfxrefdest}%
6406 \startlink attr{/Border [0 0 0]}%
6407 goto name{\pdfmkpgn{\pdfxrefdest}}%
6413 % Float references are printed completely differently: "Figure 1.2"
6414 % instead of "[somenode], p.3". We distinguish them by the
6415 % LABEL-title being set to a magic string.
6417 % Have to otherify everything special to allow the \csname to
6418 % include an _ in the xref name, etc.
6421 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
6422 \csname XR#1-title\endcsname
6424 \iffloat\Xthisreftitle
6425 % If the user specified the print name (third arg) to the ref,
6426 % print it instead of our usual "Figure 1.2".
6433 % if the user also gave the printed manual name (fifth arg), append
6436 \space \putwordin{} \cite{\printedmanual}%
6439 % node/anchor (non-float) references.
6441 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
6442 % insert empty discretionaries after hyphens, which means that it will
6443 % not find a line break at a hyphen in a node names. Since some manuals
6444 % are best written with fairly long node names, containing hyphens, this
6445 % is a loss. Therefore, we give the text of the node name again, so it
6446 % is as if TeX is seeing it for the first time.
6448 \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
6450 % _ (for example) has to be the character _ for the purposes of the
6451 % control sequence corresponding to the node, but it has to expand
6452 % into the usual \leavevmode...\vrule stuff for purposes of
6453 % printing. So we \turnoffactive for the \refx-snt, back on for the
6454 % printing, back off for the \refx-pg.
6456 % Only output a following space if the -snt ref is nonempty; for
6457 % @unnumbered and @anchor, it won't be.
6458 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
6459 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
6461 % output the `[mynode]' via a macro so it can be overridden.
6462 \xrefprintnodename\printedrefname
6464 % But we always want a comma and a space:
6467 % output the `page 3'.
6468 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
6474 % This macro is called from \xrefX for the `[nodename]' part of xref
6475 % output. It's a separate macro only so it can be changed more easily,
6476 % since square brackets don't work well in some documents. Particularly
6477 % one that Bob is working on :).
6479 \def\xrefprintnodename#1{[#1]}
6481 % Things referred to by \setref.
6487 \putwordChapter@tie \the\chapno
6488 \else \ifnum\subsecno=0
6489 \putwordSection@tie \the\chapno.\the\secno
6490 \else \ifnum\subsubsecno=0
6491 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
6493 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
6498 \putwordAppendix@tie @char\the\appendixno{}%
6499 \else \ifnum\subsecno=0
6500 \putwordSection@tie @char\the\appendixno.\the\secno
6501 \else \ifnum\subsubsecno=0
6502 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
6505 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
6509 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
6510 % If its value is nonempty, SUFFIX is output afterward.
6516 \expandafter\global\expandafter\let\expandafter\thisrefX
6517 \csname XR#1\endcsname
6520 % If not defined, say something at least.
6521 \angleleft un\-de\-fined\angleright
6524 \message{\linenumber Undefined cross reference `#1'.}%
6527 \global\warnedxrefstrue
6528 \message{Cross reference values unknown; you must run TeX again.}%
6533 % It's defined, so just use it.
6536 #2% Output the suffix in any case.
6539 % This is the macro invoked by entries in the aux file. Usually it's
6540 % just a \def (we prepend XR to the control sequence name to avoid
6541 % collisions). But if this is a float type, we have more work to do.
6544 {% The node name might contain 8-bit characters, which in our current
6545 % implementation are changed to commands like @'e. Don't let these
6546 % mess up the control sequence name.
6549 \xdef\safexrefname{#1}%
6552 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
6554 % Was that xref control sequence that we just defined for a float?
6555 \expandafter\iffloat\csname XR\safexrefname\endcsname
6556 % it was a float, and we have the (safe) float type in \iffloattype.
6557 \expandafter\let\expandafter\floatlist
6558 \csname floatlist\iffloattype\endcsname
6560 % Is this the first time we've seen this float type?
6561 \expandafter\ifx\floatlist\relax
6562 \toks0 = {\do}% yes, so just \do
6564 % had it before, so preserve previous elements in list.
6565 \toks0 = \expandafter{\floatlist\do}%
6568 % Remember this xref in the control sequence \floatlistFLOATTYPE,
6569 % for later use in \listoffloats.
6570 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
6575 % Read the last existing aux file, if any. No error if none exists.
6578 \openin 1 \jobname.aux
6581 \global\havexrefstrue
6586 \def\setupdatafile{%
6587 \catcode`\^^@=\other
6588 \catcode`\^^A=\other
6589 \catcode`\^^B=\other
6590 \catcode`\^^C=\other
6591 \catcode`\^^D=\other
6592 \catcode`\^^E=\other
6593 \catcode`\^^F=\other
6594 \catcode`\^^G=\other
6595 \catcode`\^^H=\other
6596 \catcode`\^^K=\other
6597 \catcode`\^^L=\other
6598 \catcode`\^^N=\other
6599 \catcode`\^^P=\other
6600 \catcode`\^^Q=\other
6601 \catcode`\^^R=\other
6602 \catcode`\^^S=\other
6603 \catcode`\^^T=\other
6604 \catcode`\^^U=\other
6605 \catcode`\^^V=\other
6606 \catcode`\^^W=\other
6607 \catcode`\^^X=\other
6608 \catcode`\^^Z=\other
6609 \catcode`\^^[=\other
6610 \catcode`\^^\=\other
6611 \catcode`\^^]=\other
6612 \catcode`\^^^=\other
6613 \catcode`\^^_=\other
6614 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6615 % in xref tags, i.e., node names. But since ^^e4 notation isn't
6616 % supported in the main text, it doesn't seem desirable. Furthermore,
6617 % that is not enough: for node names that actually contain a ^
6618 % character, we would end up writing a line like this: 'xrdef {'hat
6619 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6620 % argument, and \hat is not an expandable control sequence. It could
6621 % all be worked out, but why? Either we support ^^ or we don't.
6623 % The other change necessary for this was to define \auxhat:
6624 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6625 % and then to call \auxhat in \setq.
6629 % Special characters. Should be turned off anyway, but...
6642 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
6644 % This is to support \ in node names and titles, since the \
6645 % characters end up in a \csname. It's easier than
6646 % leaving it active and making its active definition an actual \
6647 % character. What I don't understand is why it works in the *value*
6648 % of the xrdef. Seems like it should be a catcode12 \, and that
6649 % should not typeset properly. But it works, so I'm moving on for
6650 % now. --karl, 15jan04.
6653 % Make the characters 128-255 be printing characters.
6657 \catcode\count1=\other
6658 \advance\count1 by 1
6659 \ifnum \count1<256 \loop \fi
6663 % @ is our escape character in .aux files, and we need braces.
6669 \def\readdatafile#1{%
6676 \message{insertions,}
6677 % including footnotes.
6679 \newcount \footnoteno
6681 % The trailing space in the following definition for supereject is
6682 % vital for proper filling; pages come out unaligned when you do a
6683 % pagealignmacro call if that space before the closing brace is
6684 % removed. (Generally, numeric constants should always be followed by a
6685 % space to prevent strange expansion errors.)
6686 \def\supereject{\par\penalty -20000\footnoteno =0 }
6688 % @footnotestyle is meaningful for info output only.
6689 \let\footnotestyle=\comment
6693 % Auto-number footnotes. Otherwise like plain.
6695 \let\indent=\ptexindent
6696 \let\noindent=\ptexnoindent
6697 \global\advance\footnoteno by \@ne
6698 \edef\thisfootno{$^{\the\footnoteno}$}%
6700 % In case the footnote comes at the end of a sentence, preserve the
6701 % extra spacing after we do the footnote number.
6703 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
6705 % Remove inadvertent blank space before typesetting the footnote number.
6711 % Don't bother with the trickery in plain.tex to not require the
6712 % footnote text as a parameter. Our footnotes don't need to be so general.
6714 % Oh yes, they do; otherwise, @ifset (and anything else that uses
6715 % \parseargline) fails inside footnotes because the tokens are fixed when
6716 % the footnote is read. --karl, 16nov96.
6719 \insert\footins\bgroup
6720 % We want to typeset this text as a normal paragraph, even if the
6721 % footnote reference occurs in (for example) a display environment.
6722 % So reset some parameters.
6724 \interlinepenalty\interfootnotelinepenalty
6725 \splittopskip\ht\strutbox % top baseline for broken footnotes
6726 \splitmaxdepth\dp\strutbox
6727 \floatingpenalty\@MM
6732 \parindent\defaultparindent
6736 % Because we use hanging indentation in footnotes, a @noindent appears
6737 % to exdent this text, so make it be a no-op. makeinfo does not use
6738 % hanging indentation so @noindent can still be needed within footnote
6739 % text after an @example or the like (not that this is good style).
6740 \let\noindent = \relax
6742 % Hang the footnote text off the number. Use \everypar in case the
6743 % footnote extends for more than one paragraph.
6744 \everypar = {\hang}%
6745 \textindent{\thisfootno}%
6747 % Don't crash into the line above the footnote text. Since this
6748 % expands into a box, it must come within the paragraph, lest it
6749 % provide a place where TeX can split the footnote.
6751 \futurelet\next\fo@t
6753 }%end \catcode `\@=11
6755 % In case a @footnote appears in a vbox, save the footnote text and create
6756 % the real \insert just after the vbox finished. Otherwise, the insertion
6758 % Similarily, if a @footnote appears inside an alignment, save the footnote
6759 % text to a box and make the \insert when a row of the table is finished.
6760 % And the same can be done for other insert classes. --kasal, 16nov03.
6762 % Replace the \insert primitive by a cheating macro.
6763 % Deeper inside, just make sure that the saved insertions are not spilled
6766 \def\startsavinginserts{%
6767 \ifx \insert\ptexinsert
6768 \let\insert\saveinsert
6770 \let\checkinserts\relax
6774 % This \insert replacement works for both \insert\footins{foo} and
6775 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
6778 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
6779 \afterassignment\next
6780 % swallow the left brace
6783 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
6784 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
6786 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
6788 \def\placesaveins#1{%
6789 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
6793 % eat @SAVE -- beware, all of them have catcode \other:
6795 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
6796 \gdef\gobblesave @SAVE{}
6800 \def\newsaveins #1{%
6801 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
6804 \def\newsaveinsX #1{%
6805 \csname newbox\endcsname #1%
6806 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
6811 \let\checkinserts\empty
6816 % @image. We use the macros from epsf.tex to support this.
6817 % If epsf.tex is not installed and @image is used, we complain.
6819 % Check for and read epsf.tex up front. If we read it only at @image
6820 % time, we might be inside a group, and then its definitions would get
6821 % undone and the next image would fail.
6822 \openin 1 = epsf.tex
6824 % Do not bother showing banner with epsf.tex v2.7k (available in
6825 % doc/epsf.tex and on ctan).
6826 \def\epsfannounce{\toks0 = }%
6831 % We will only complain once about lack of epsf.tex.
6832 \newif\ifwarnednoepsf
6833 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6834 work. It is also included in the Texinfo distribution, or you can get
6835 it from ftp://tug.org/tex/epsf.tex.}
6838 \ifx\epsfbox\undefined
6839 \ifwarnednoepsf \else
6840 \errhelp = \noepsfhelp
6841 \errmessage{epsf.tex not found, images will be ignored}%
6842 \global\warnednoepsftrue
6845 \imagexxx #1,,,,,\finish
6849 % Arguments to @image:
6850 % #1 is (mandatory) image filename; we tack on .eps extension.
6851 % #2 is (optional) width, #3 is (optional) height.
6852 % #4 is (ignored optional) html alt text.
6853 % #5 is (ignored optional) extension.
6854 % #6 is just the usual extra ignored arg for parsing this stuff.
6856 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
6857 \catcode`\^^M = 5 % in case we're inside an example
6858 \normalturnoffactive % allow _ et al. in names
6859 % If the image is by itself, center it.
6863 % Usually we'll have text after the image which will insert
6864 % \parskip glue, so insert it here too to equalize the space
6866 \nobreak\vskip\parskip
6873 \dopdfimage{#1}{#2}{#3}%
6875 % \epsfbox itself resets \epsf?size at each figure.
6876 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
6877 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
6881 \ifimagevmode \egroup \bigbreak \fi % space after the image
6885 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
6886 % etc. We don't actually implement floating yet, we always include the
6887 % float "here". But it seemed the best name for the future.
6889 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
6891 % There may be a space before second and/or third parameter; delete it.
6892 \def\eatcommaspace#1, {#1,}
6894 % #1 is the optional FLOATTYPE, the text label for this float, typically
6895 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
6896 % this float will not be numbered and cannot be referred to.
6898 % #2 is the optional xref label. Also must be present for the float to
6901 % #3 is the optional positioning argument; for now, it is ignored. It
6902 % will somehow specify the positions allowed to float to (here, top, bottom).
6904 % We keep a separate counter for each FLOATTYPE, which we reset at each
6905 % chapter-level command.
6906 \let\resetallfloatnos=\empty
6908 \def\dofloat#1,#2,#3,#4\finish{%
6909 \let\thiscaption=\empty
6910 \let\thisshortcaption=\empty
6912 % don't lose footnotes inside @float.
6914 % BEWARE: when the floats start float, we have to issue warning whenever an
6915 % insert appears inside a float which could possibly float. --kasal, 26may04
6919 % We can't be used inside a paragraph.
6924 \def\floatlabel{#2}%
6925 \def\floatloc{#3}% we do nothing with this yet.
6927 \ifx\floattype\empty
6928 \let\safefloattype=\empty
6931 % the floattype might have accents or other special characters,
6932 % but we need to use it in a control sequence name.
6935 \xdef\safefloattype{\floattype}%
6939 % If label is given but no type, we handle that as the empty type.
6940 \ifx\floatlabel\empty \else
6941 % We want each FLOATTYPE to be numbered separately (Figure 1,
6942 % Table 1, Figure 2, ...). (And if no label, no number.)
6944 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
6945 \global\advance\floatno by 1
6948 % This magic value for \thissection is output by \setref as the
6949 % XREFLABEL-title value. \xrefX uses it to distinguish float
6950 % labels (which have a completely different output format) from
6951 % node and anchor labels. And \xrdef uses it to construct the
6954 \edef\thissection{\floatmagic=\safefloattype}%
6955 \setref{\floatlabel}{Yfloat}%
6959 % start with \parskip glue, I guess.
6962 % Don't suppress indentation if a float happens to start a section.
6963 \restorefirstparagraphindent
6966 % we have these possibilities:
6967 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
6968 % @float Foo,lbl & no caption: Foo 1.1
6969 % @float Foo & @caption{Cap}: Foo: Cap
6970 % @float Foo & no caption: Foo
6971 % @float ,lbl & Caption{Cap}: 1.1: Cap
6972 % @float ,lbl & no caption: 1.1
6973 % @float & @caption{Cap}: Cap
6974 % @float & no caption:
6977 \let\floatident = \empty
6979 % In all cases, if we have a float type, it comes first.
6980 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
6982 % If we have an xref label, the number comes next.
6983 \ifx\floatlabel\empty \else
6984 \ifx\floattype\empty \else % if also had float type, need tie first.
6985 \appendtomacro\floatident{\tie}%
6988 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
6991 % Start the printed caption with what we've constructed in
6992 % \floatident, but keep it separate; we need \floatident again.
6993 \let\captionline = \floatident
6995 \ifx\thiscaption\empty \else
6996 \ifx\floatident\empty \else
6997 \appendtomacro\captionline{: }% had ident, so need a colon between
7001 \appendtomacro\captionline{\scanexp\thiscaption}%
7004 % If we have anything to print, print it, with space before.
7005 % Eventually this needs to become an \insert.
7006 \ifx\captionline\empty \else
7010 % Space below caption.
7014 % If have an xref label, write the list of floats info. Do this
7015 % after the caption, to avoid chance of it being a breakpoint.
7016 \ifx\floatlabel\empty \else
7017 % Write the text that goes in the lof to the aux file as
7018 % \floatlabel-lof. Besides \floatident, we include the short
7019 % caption if specified, else the full caption if specified, else nothing.
7023 % since we read the caption text in the macro world, where ^^M
7024 % is turned into a normal character, we have to scan it back, so
7025 % we don't write the literal three characters "^^M" into the aux file.
7027 \xdef\noexpand\gtemp{%
7028 \ifx\thisshortcaption\empty
7035 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7036 \ifx\gtemp\empty \else : \gtemp \fi}}%
7039 \egroup % end of \vtop
7041 % place the captured inserts
7043 % BEWARE: when the floats start floating, we have to issue warning
7044 % whenever an insert appears inside a float which could possibly
7045 % float. --kasal, 26may04
7050 % Append the tokens #2 to the definition of macro #1, not expanding either.
7052 \def\appendtomacro#1#2{%
7053 \expandafter\def\expandafter#1\expandafter{#1#2}%
7056 % @caption, @shortcaption
7058 \def\caption{\docaption\thiscaption}
7059 \def\shortcaption{\docaption\thisshortcaption}
7060 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7061 \def\defcaption#1#2{\egroup \def#1{#2}}
7063 % The parameter is the control sequence identifying the counter we are
7064 % going to use. Create it if it doesn't exist and assign it to \floatno.
7067 % Haven't seen this figure type before.
7068 \csname newcount\endcsname #1%
7070 % Remember to reset this floatno at the next chap.
7071 \expandafter\gdef\expandafter\resetallfloatnos
7072 \expandafter{\resetallfloatnos #1=0 }%
7077 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
7078 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
7079 % first read the @float command.
7081 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7083 % Magic string used for the XREFLABEL-title value, so \xrefX can
7084 % distinguish floats from other xref types.
7085 \def\floatmagic{!!float!!}
7087 % #1 is the control sequence we are passed; we expand into a conditional
7088 % which is true if #1 represents a float ref. That is, the magic
7089 % \thissection value which we \setref above.
7091 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7093 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
7094 % (safe) float type for this float. We set \iffloattype to #2.
7096 \def\doiffloat#1=#2=#3\finish{%
7098 \def\iffloattype{#2}%
7099 \ifx\temp\floatmagic
7102 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7104 \parseargdef\listoffloats{%
7105 \def\floattype{#1}% floattype
7107 % the floattype might have accents or other special characters,
7108 % but we need to use it in a control sequence name.
7111 \xdef\safefloattype{\floattype}%
7114 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7115 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7117 % if the user said @listoffloats foo but never @float foo.
7118 \message{\linenumber No `\safefloattype' floats to list.}%
7122 \leftskip=\tocindent % indent these entries like a toc
7123 \let\do=\listoffloatsdo
7124 \csname floatlist\safefloattype\endcsname
7129 % This is called on each entry in a list of floats. We're passed the
7130 % xref label, in the form LABEL-title, which is how we save it in the
7131 % aux file. We strip off the -title and look up \XRLABEL-lof, which
7132 % has the text we're supposed to typeset here.
7134 % Figures without xref labels will not be included in the list (since
7135 % they won't appear in the aux file).
7137 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7138 \def\listoffloatsdoentry#1-title\finish{{%
7139 % Can't fully expand XR#1-lof because it can contain anything. Just
7140 % pass the control sequence. On the other hand, XR#1-pg is just the
7141 % page number, and we want to fully expand that so we can get a link
7143 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
7145 % use the same \entry macro we use to generate the TOC and index.
7146 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7151 \message{localization,}
7153 % @documentlanguage is usually given very early, just after
7154 % @setfilename. If done too late, it may not override everything
7155 % properly. Single argument is the language abbreviation.
7156 % It would be nice if we could set up a hyphenation file here.
7158 \parseargdef\documentlanguage{%
7159 \tex % read txi-??.tex file in plain TeX.
7160 % Read the file if it exists.
7161 \openin 1 txi-#1.tex
7163 \errhelp = \nolanghelp
7164 \errmessage{Cannot read language file txi-#1.tex}%
7171 \newhelp\nolanghelp{The given language definition file cannot be found or
7172 is empty. Maybe you need to install it? In the current directory
7173 should work if nowhere else does.}
7175 % Set the catcode of characters 128 through 255 to the specified number.
7177 \def\setnonasciicharscatcode#1{%
7179 \loop\ifnum\count255<256
7180 \global\catcode\count255=#1
7181 \advance\count255 by 1
7185 % @documentencoding sets the definition of non-ASCII characters
7186 % according to the specified encoding.
7188 \parseargdef\documentencoding{%
7189 % Encoding being declared for the document.
7190 \def\declaredencoding{\csname #1.enc\endcsname}%
7192 % Supported encodings: names converted to tokens in order to be able
7193 % to compare them with \ifx.
7194 \def\ascii{\csname US-ASCII.enc\endcsname}%
7195 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
7196 \def\latone{\csname ISO-8859-1.enc\endcsname}%
7197 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
7198 \def\utfeight{\csname UTF-8.enc\endcsname}%
7200 \ifx \declaredencoding \ascii
7203 \else \ifx \declaredencoding \lattwo
7204 \setnonasciicharscatcode\active
7207 \else \ifx \declaredencoding \latone
7208 \setnonasciicharscatcode\active
7211 \else \ifx \declaredencoding \latnine
7212 \setnonasciicharscatcode\active
7215 \else \ifx \declaredencoding \utfeight
7216 \setnonasciicharscatcode\active
7220 \message{Unknown document encoding #1, ignoring.}%
7229 % A message to be logged when using a character that isn't available
7230 % the default font encoding (OT1).
7232 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
7234 % Take account of \c (plain) vs. \, (Texinfo) difference.
7235 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
7237 % First, make active non-ASCII characters in order for them to be
7238 % correctly categorized when TeX reads the replacement text of
7239 % macros containing the character definitions.
7240 \setnonasciicharscatcode\active
7242 % Latin1 (ISO-8859-1) character definitions.
7243 \def\latonechardefs{%
7245 \gdef^^a1{\exclamdown}
7246 \gdef^^a2{\missingcharmsg{CENT SIGN}}
7247 \gdef^^a3{{\pounds}}
7248 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7249 \gdef^^a5{\missingcharmsg{YEN SIGN}}
7250 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
7253 \gdef^^a9{\copyright}
7255 \gdef^^ab{\missingcharmsg{LEFT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7258 \gdef^^ae{\registeredsymbol}
7261 \gdef^^b0{\textdegree}
7270 \gdef^^b8{\cedilla\ }
7274 \gdef^^bb{\missingcharmsg{RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK}}
7275 \gdef^^bc{$1\over4$}
7276 \gdef^^bd{$1\over2$}
7277 \gdef^^be{$3\over4$}
7278 \gdef^^bf{\questiondown}
7285 \gdef^^c5{\ringaccent A}
7287 \gdef^^c7{\cedilla C}
7297 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER ETH}}
7311 \gdef^^de{\missingcharmsg{LATIN CAPITAL LETTER THORN}}
7319 \gdef^^e5{\ringaccent a}
7321 \gdef^^e7{\cedilla c}
7326 \gdef^^ec{\`{\dotless i}}
7327 \gdef^^ed{\'{\dotless i}}
7328 \gdef^^ee{\^{\dotless i}}
7329 \gdef^^ef{\"{\dotless i}}
7331 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER ETH}}
7345 \gdef^^fe{\missingcharmsg{LATIN SMALL LETTER THORN}}
7349 % Latin9 (ISO-8859-15) encoding character definitions.
7350 \def\latninechardefs{%
7351 % Encoding is almost identical to Latin1.
7364 % Latin2 (ISO-8859-2) character definitions.
7365 \def\lattwochardefs{%
7367 \gdef^^a1{\missingcharmsg{LATIN CAPITAL LETTER A WITH OGONEK}}
7370 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
7376 \gdef^^aa{\cedilla S}
7381 \gdef^^af{\dotaccent Z}
7383 \gdef^^b0{\textdegree}
7384 \gdef^^b1{\missingcharmsg{LATIN SMALL LETTER A WITH OGONEK}}
7385 \gdef^^b2{\missingcharmsg{OGONEK}}
7391 \gdef^^b8{\cedilla\ }
7393 \gdef^^ba{\cedilla s}
7398 \gdef^^bf{\dotaccent z}
7407 \gdef^^c7{\cedilla C}
7410 \gdef^^ca{\missingcharmsg{LATIN CAPITAL LETTER E WITH OGONEK}}
7417 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER D WITH STROKE}}
7426 \gdef^^d9{\ringaccent U}
7431 \gdef^^de{\cedilla T}
7441 \gdef^^e7{\cedilla c}
7444 \gdef^^ea{\missingcharmsg{LATIN SMALL LETTER E WITH OGONEK}}
7451 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER D WITH STROKE}}
7460 \gdef^^f9{\ringaccent u}
7465 \gdef^^fe{\cedilla t}
7466 \gdef^^ff{\dotaccent{}}
7469 % UTF-8 character definitions.
7471 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
7472 % changes for Texinfo conventions. It is included here under the GPL by
7473 % permission from Frank Mittelbach and the LaTeX team.
7479 \gdef\UTFviiiTwoOctets#1#2{\expandafter
7480 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
7482 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
7483 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
7485 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
7486 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
7488 \gdef\UTFviiiDefined#1{%
7490 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
7501 \global\catcode\countUTFx\active
7502 \uccode`\~\countUTFx
7503 \uppercase\expandafter{\UTFviiiTmp}%
7504 \advance\countUTFx by 1
7505 \ifnum\countUTFx < \countUTFy
7506 \expandafter\UTFviiiLoop
7512 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
7518 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
7524 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
7537 \gdef\DeclareUnicodeCharacter#1#2{%
7538 \countUTFz = "#1\relax
7539 \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
7542 \def\UTFviiiTwoOctets##1##2{%
7543 \csname u8:##1\string ##2\endcsname}%
7544 \def\UTFviiiThreeOctets##1##2##3{%
7545 \csname u8:##1\string ##2\string ##3\endcsname}%
7546 \def\UTFviiiFourOctets##1##2##3##4{%
7547 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
7548 \expandafter\expandafter\expandafter\expandafter
7549 \expandafter\expandafter\expandafter
7550 \gdef\UTFviiiTmp{#2}%
7553 \gdef\parseXMLCharref{%
7554 \ifnum\countUTFz < "A0\relax
7555 \errhelp = \EMsimple
7556 \errmessage{Cannot define Unicode char value < 00A0}%
7557 \else\ifnum\countUTFz < "800\relax
7559 \parseUTFviiiB C\UTFviiiTwoOctets.,%
7560 \else\ifnum\countUTFz < "10000\relax
7563 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
7568 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
7572 \gdef\parseUTFviiiA#1{%
7573 \countUTFx = \countUTFz
7574 \divide\countUTFz by 64
7575 \countUTFy = \countUTFz
7576 \multiply\countUTFz by 64
7577 \advance\countUTFx by -\countUTFz
7578 \advance\countUTFx by 128
7579 \uccode `#1\countUTFx
7580 \countUTFz = \countUTFy}
7582 \gdef\parseUTFviiiB#1#2#3#4{%
7583 \advance\countUTFz by "#10\relax
7584 \uccode `#3\countUTFz
7585 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
7588 \def\utfeightchardefs{%
7589 \DeclareUnicodeCharacter{00A0}{\tie}
7590 \DeclareUnicodeCharacter{00A1}{\exclamdown}
7591 \DeclareUnicodeCharacter{00A3}{\pounds}
7592 \DeclareUnicodeCharacter{00A8}{\"{ }}
7593 \DeclareUnicodeCharacter{00A9}{\copyright}
7594 \DeclareUnicodeCharacter{00AA}{\ordf}
7595 \DeclareUnicodeCharacter{00AD}{\-}
7596 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
7597 \DeclareUnicodeCharacter{00AF}{\={ }}
7599 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
7600 \DeclareUnicodeCharacter{00B4}{\'{ }}
7601 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
7602 \DeclareUnicodeCharacter{00BA}{\ordm}
7603 \DeclareUnicodeCharacter{00BF}{\questiondown}
7605 \DeclareUnicodeCharacter{00C0}{\`A}
7606 \DeclareUnicodeCharacter{00C1}{\'A}
7607 \DeclareUnicodeCharacter{00C2}{\^A}
7608 \DeclareUnicodeCharacter{00C3}{\~A}
7609 \DeclareUnicodeCharacter{00C4}{\"A}
7610 \DeclareUnicodeCharacter{00C5}{\AA}
7611 \DeclareUnicodeCharacter{00C6}{\AE}
7612 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
7613 \DeclareUnicodeCharacter{00C8}{\`E}
7614 \DeclareUnicodeCharacter{00C9}{\'E}
7615 \DeclareUnicodeCharacter{00CA}{\^E}
7616 \DeclareUnicodeCharacter{00CB}{\"E}
7617 \DeclareUnicodeCharacter{00CC}{\`I}
7618 \DeclareUnicodeCharacter{00CD}{\'I}
7619 \DeclareUnicodeCharacter{00CE}{\^I}
7620 \DeclareUnicodeCharacter{00CF}{\"I}
7622 \DeclareUnicodeCharacter{00D1}{\~N}
7623 \DeclareUnicodeCharacter{00D2}{\`O}
7624 \DeclareUnicodeCharacter{00D3}{\'O}
7625 \DeclareUnicodeCharacter{00D4}{\^O}
7626 \DeclareUnicodeCharacter{00D5}{\~O}
7627 \DeclareUnicodeCharacter{00D6}{\"O}
7628 \DeclareUnicodeCharacter{00D8}{\O}
7629 \DeclareUnicodeCharacter{00D9}{\`U}
7630 \DeclareUnicodeCharacter{00DA}{\'U}
7631 \DeclareUnicodeCharacter{00DB}{\^U}
7632 \DeclareUnicodeCharacter{00DC}{\"U}
7633 \DeclareUnicodeCharacter{00DD}{\'Y}
7634 \DeclareUnicodeCharacter{00DF}{\ss}
7636 \DeclareUnicodeCharacter{00E0}{\`a}
7637 \DeclareUnicodeCharacter{00E1}{\'a}
7638 \DeclareUnicodeCharacter{00E2}{\^a}
7639 \DeclareUnicodeCharacter{00E3}{\~a}
7640 \DeclareUnicodeCharacter{00E4}{\"a}
7641 \DeclareUnicodeCharacter{00E5}{\aa}
7642 \DeclareUnicodeCharacter{00E6}{\ae}
7643 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
7644 \DeclareUnicodeCharacter{00E8}{\`e}
7645 \DeclareUnicodeCharacter{00E9}{\'e}
7646 \DeclareUnicodeCharacter{00EA}{\^e}
7647 \DeclareUnicodeCharacter{00EB}{\"e}
7648 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
7649 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
7650 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
7651 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
7653 \DeclareUnicodeCharacter{00F1}{\~n}
7654 \DeclareUnicodeCharacter{00F2}{\`o}
7655 \DeclareUnicodeCharacter{00F3}{\'o}
7656 \DeclareUnicodeCharacter{00F4}{\^o}
7657 \DeclareUnicodeCharacter{00F5}{\~o}
7658 \DeclareUnicodeCharacter{00F6}{\"o}
7659 \DeclareUnicodeCharacter{00F8}{\o}
7660 \DeclareUnicodeCharacter{00F9}{\`u}
7661 \DeclareUnicodeCharacter{00FA}{\'u}
7662 \DeclareUnicodeCharacter{00FB}{\^u}
7663 \DeclareUnicodeCharacter{00FC}{\"u}
7664 \DeclareUnicodeCharacter{00FD}{\'y}
7665 \DeclareUnicodeCharacter{00FF}{\"y}
7667 \DeclareUnicodeCharacter{0100}{\=A}
7668 \DeclareUnicodeCharacter{0101}{\=a}
7669 \DeclareUnicodeCharacter{0102}{\u{A}}
7670 \DeclareUnicodeCharacter{0103}{\u{a}}
7671 \DeclareUnicodeCharacter{0106}{\'C}
7672 \DeclareUnicodeCharacter{0107}{\'c}
7673 \DeclareUnicodeCharacter{0108}{\^C}
7674 \DeclareUnicodeCharacter{0109}{\^c}
7675 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
7676 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
7677 \DeclareUnicodeCharacter{010C}{\v{C}}
7678 \DeclareUnicodeCharacter{010D}{\v{c}}
7679 \DeclareUnicodeCharacter{010E}{\v{D}}
7681 \DeclareUnicodeCharacter{0112}{\=E}
7682 \DeclareUnicodeCharacter{0113}{\=e}
7683 \DeclareUnicodeCharacter{0114}{\u{E}}
7684 \DeclareUnicodeCharacter{0115}{\u{e}}
7685 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
7686 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
7687 \DeclareUnicodeCharacter{011A}{\v{E}}
7688 \DeclareUnicodeCharacter{011B}{\v{e}}
7689 \DeclareUnicodeCharacter{011C}{\^G}
7690 \DeclareUnicodeCharacter{011D}{\^g}
7691 \DeclareUnicodeCharacter{011E}{\u{G}}
7692 \DeclareUnicodeCharacter{011F}{\u{g}}
7694 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
7695 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
7696 \DeclareUnicodeCharacter{0124}{\^H}
7697 \DeclareUnicodeCharacter{0125}{\^h}
7698 \DeclareUnicodeCharacter{0128}{\~I}
7699 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
7700 \DeclareUnicodeCharacter{012A}{\=I}
7701 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
7702 \DeclareUnicodeCharacter{012C}{\u{I}}
7703 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
7705 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
7706 \DeclareUnicodeCharacter{0131}{\dotless{i}}
7707 \DeclareUnicodeCharacter{0132}{IJ}
7708 \DeclareUnicodeCharacter{0133}{ij}
7709 \DeclareUnicodeCharacter{0134}{\^J}
7710 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
7711 \DeclareUnicodeCharacter{0139}{\'L}
7712 \DeclareUnicodeCharacter{013A}{\'l}
7714 \DeclareUnicodeCharacter{0141}{\L}
7715 \DeclareUnicodeCharacter{0142}{\l}
7716 \DeclareUnicodeCharacter{0143}{\'N}
7717 \DeclareUnicodeCharacter{0144}{\'n}
7718 \DeclareUnicodeCharacter{0147}{\v{N}}
7719 \DeclareUnicodeCharacter{0148}{\v{n}}
7720 \DeclareUnicodeCharacter{014C}{\=O}
7721 \DeclareUnicodeCharacter{014D}{\=o}
7722 \DeclareUnicodeCharacter{014E}{\u{O}}
7723 \DeclareUnicodeCharacter{014F}{\u{o}}
7725 \DeclareUnicodeCharacter{0150}{\H{O}}
7726 \DeclareUnicodeCharacter{0151}{\H{o}}
7727 \DeclareUnicodeCharacter{0152}{\OE}
7728 \DeclareUnicodeCharacter{0153}{\oe}
7729 \DeclareUnicodeCharacter{0154}{\'R}
7730 \DeclareUnicodeCharacter{0155}{\'r}
7731 \DeclareUnicodeCharacter{0158}{\v{R}}
7732 \DeclareUnicodeCharacter{0159}{\v{r}}
7733 \DeclareUnicodeCharacter{015A}{\'S}
7734 \DeclareUnicodeCharacter{015B}{\'s}
7735 \DeclareUnicodeCharacter{015C}{\^S}
7736 \DeclareUnicodeCharacter{015D}{\^s}
7737 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
7738 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
7740 \DeclareUnicodeCharacter{0160}{\v{S}}
7741 \DeclareUnicodeCharacter{0161}{\v{s}}
7742 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
7743 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
7744 \DeclareUnicodeCharacter{0164}{\v{T}}
7746 \DeclareUnicodeCharacter{0168}{\~U}
7747 \DeclareUnicodeCharacter{0169}{\~u}
7748 \DeclareUnicodeCharacter{016A}{\=U}
7749 \DeclareUnicodeCharacter{016B}{\=u}
7750 \DeclareUnicodeCharacter{016C}{\u{U}}
7751 \DeclareUnicodeCharacter{016D}{\u{u}}
7752 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
7753 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
7755 \DeclareUnicodeCharacter{0170}{\H{U}}
7756 \DeclareUnicodeCharacter{0171}{\H{u}}
7757 \DeclareUnicodeCharacter{0174}{\^W}
7758 \DeclareUnicodeCharacter{0175}{\^w}
7759 \DeclareUnicodeCharacter{0176}{\^Y}
7760 \DeclareUnicodeCharacter{0177}{\^y}
7761 \DeclareUnicodeCharacter{0178}{\"Y}
7762 \DeclareUnicodeCharacter{0179}{\'Z}
7763 \DeclareUnicodeCharacter{017A}{\'z}
7764 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
7765 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
7766 \DeclareUnicodeCharacter{017D}{\v{Z}}
7767 \DeclareUnicodeCharacter{017E}{\v{z}}
7769 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
7770 \DeclareUnicodeCharacter{01C5}{D\v{z}}
7771 \DeclareUnicodeCharacter{01C6}{d\v{z}}
7772 \DeclareUnicodeCharacter{01C7}{LJ}
7773 \DeclareUnicodeCharacter{01C8}{Lj}
7774 \DeclareUnicodeCharacter{01C9}{lj}
7775 \DeclareUnicodeCharacter{01CA}{NJ}
7776 \DeclareUnicodeCharacter{01CB}{Nj}
7777 \DeclareUnicodeCharacter{01CC}{nj}
7778 \DeclareUnicodeCharacter{01CD}{\v{A}}
7779 \DeclareUnicodeCharacter{01CE}{\v{a}}
7780 \DeclareUnicodeCharacter{01CF}{\v{I}}
7782 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
7783 \DeclareUnicodeCharacter{01D1}{\v{O}}
7784 \DeclareUnicodeCharacter{01D2}{\v{o}}
7785 \DeclareUnicodeCharacter{01D3}{\v{U}}
7786 \DeclareUnicodeCharacter{01D4}{\v{u}}
7788 \DeclareUnicodeCharacter{01E2}{\={\AE}}
7789 \DeclareUnicodeCharacter{01E3}{\={\ae}}
7790 \DeclareUnicodeCharacter{01E6}{\v{G}}
7791 \DeclareUnicodeCharacter{01E7}{\v{g}}
7792 \DeclareUnicodeCharacter{01E8}{\v{K}}
7793 \DeclareUnicodeCharacter{01E9}{\v{k}}
7795 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
7796 \DeclareUnicodeCharacter{01F1}{DZ}
7797 \DeclareUnicodeCharacter{01F2}{Dz}
7798 \DeclareUnicodeCharacter{01F3}{dz}
7799 \DeclareUnicodeCharacter{01F4}{\'G}
7800 \DeclareUnicodeCharacter{01F5}{\'g}
7801 \DeclareUnicodeCharacter{01F8}{\`N}
7802 \DeclareUnicodeCharacter{01F9}{\`n}
7803 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
7804 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
7805 \DeclareUnicodeCharacter{01FE}{\'{\O}}
7806 \DeclareUnicodeCharacter{01FF}{\'{\o}}
7808 \DeclareUnicodeCharacter{021E}{\v{H}}
7809 \DeclareUnicodeCharacter{021F}{\v{h}}
7811 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
7812 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
7813 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
7814 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
7815 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
7816 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
7818 \DeclareUnicodeCharacter{0232}{\=Y}
7819 \DeclareUnicodeCharacter{0233}{\=y}
7820 \DeclareUnicodeCharacter{0237}{\dotless{j}}
7822 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
7823 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
7824 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
7825 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
7826 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
7827 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
7828 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
7829 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
7830 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
7831 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
7832 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
7833 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
7835 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
7836 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
7838 \DeclareUnicodeCharacter{1E20}{\=G}
7839 \DeclareUnicodeCharacter{1E21}{\=g}
7840 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
7841 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
7842 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
7843 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
7844 \DeclareUnicodeCharacter{1E26}{\"H}
7845 \DeclareUnicodeCharacter{1E27}{\"h}
7847 \DeclareUnicodeCharacter{1E30}{\'K}
7848 \DeclareUnicodeCharacter{1E31}{\'k}
7849 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
7850 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
7851 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
7852 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
7853 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
7854 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
7855 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
7856 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
7857 \DeclareUnicodeCharacter{1E3E}{\'M}
7858 \DeclareUnicodeCharacter{1E3F}{\'m}
7860 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
7861 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
7862 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
7863 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
7864 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
7865 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
7866 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
7867 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
7868 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
7869 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
7871 \DeclareUnicodeCharacter{1E54}{\'P}
7872 \DeclareUnicodeCharacter{1E55}{\'p}
7873 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
7874 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
7875 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
7876 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
7877 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
7878 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
7879 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
7880 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
7882 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
7883 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
7884 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
7885 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
7886 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
7887 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
7888 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
7889 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
7890 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
7891 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
7893 \DeclareUnicodeCharacter{1E7C}{\~V}
7894 \DeclareUnicodeCharacter{1E7D}{\~v}
7895 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
7896 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
7898 \DeclareUnicodeCharacter{1E80}{\`W}
7899 \DeclareUnicodeCharacter{1E81}{\`w}
7900 \DeclareUnicodeCharacter{1E82}{\'W}
7901 \DeclareUnicodeCharacter{1E83}{\'w}
7902 \DeclareUnicodeCharacter{1E84}{\"W}
7903 \DeclareUnicodeCharacter{1E85}{\"w}
7904 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
7905 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
7906 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
7907 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
7908 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
7909 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
7910 \DeclareUnicodeCharacter{1E8C}{\"X}
7911 \DeclareUnicodeCharacter{1E8D}{\"x}
7912 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
7913 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
7915 \DeclareUnicodeCharacter{1E90}{\^Z}
7916 \DeclareUnicodeCharacter{1E91}{\^z}
7917 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
7918 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
7919 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
7920 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
7921 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
7922 \DeclareUnicodeCharacter{1E97}{\"t}
7923 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
7924 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
7926 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
7927 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
7929 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
7930 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
7931 \DeclareUnicodeCharacter{1EBC}{\~E}
7932 \DeclareUnicodeCharacter{1EBD}{\~e}
7934 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
7935 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
7936 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
7937 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
7939 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
7940 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
7942 \DeclareUnicodeCharacter{1EF2}{\`Y}
7943 \DeclareUnicodeCharacter{1EF3}{\`y}
7944 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
7946 \DeclareUnicodeCharacter{1EF8}{\~Y}
7947 \DeclareUnicodeCharacter{1EF9}{\~y}
7949 \DeclareUnicodeCharacter{2013}{--}
7950 \DeclareUnicodeCharacter{2014}{---}
7951 \DeclareUnicodeCharacter{2022}{\bullet}
7952 \DeclareUnicodeCharacter{2026}{\dots}
7953 \DeclareUnicodeCharacter{20AC}{\euro}
7955 \DeclareUnicodeCharacter{2192}{\expansion}
7956 \DeclareUnicodeCharacter{21D2}{\result}
7958 \DeclareUnicodeCharacter{2212}{\minus}
7959 \DeclareUnicodeCharacter{2217}{\point}
7960 \DeclareUnicodeCharacter{2261}{\equiv}
7961 }% end of \utfeightchardefs
7964 % US-ASCII character definitions.
7965 \def\asciichardefs{% nothing need be done
7969 % Make non-ASCII characters printable again for compatibility with
7970 % existing Texinfo documents that may use them, even without declaring a
7971 % document encoding.
7973 \setnonasciicharscatcode \other
7976 \message{formatting,}
7978 \newdimen\defaultparindent \defaultparindent = 15pt
7980 \chapheadingskip = 15pt plus 4pt minus 2pt
7981 \secheadingskip = 12pt plus 3pt minus 2pt
7982 \subsecheadingskip = 9pt plus 2pt minus 2pt
7984 % Prevent underfull vbox error messages.
7987 % Don't be so finicky about underfull hboxes, either.
7990 % Following George Bush, just get rid of widows and orphans.
7994 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
7995 % using an old version of TeX, don't do anything. We want the amount of
7996 % stretch added to depend on the line length, hence the dependence on
7997 % \hsize. We call this whenever the paper size is set.
7999 \def\setemergencystretch{%
8000 \ifx\emergencystretch\thisisundefined
8001 % Allow us to assign to \emergencystretch anyway.
8002 \def\emergencystretch{\dimen0}%
8004 \emergencystretch = .15\hsize
8008 % Parameters in order: 1) textheight; 2) textwidth;
8009 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
8010 % 7) physical page height; 8) physical page width.
8012 % We also call \setleading{\textleading}, so the caller should define
8013 % \textleading. The caller should also set \parskip.
8015 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
8018 \splittopskip = \topskip
8021 \advance\vsize by \topskip
8022 \outervsize = \vsize
8023 \advance\outervsize by 2\topandbottommargin
8024 \pageheight = \vsize
8027 \outerhsize = \hsize
8028 \advance\outerhsize by 0.5in
8031 \normaloffset = #4\relax
8032 \bindingoffset = #5\relax
8035 \pdfpageheight #7\relax
8036 \pdfpagewidth #8\relax
8039 \setleading{\textleading}
8041 \parindent = \defaultparindent
8042 \setemergencystretch
8045 % @letterpaper (the default).
8046 \def\letterpaper{{\globaldefs = 1
8047 \parskip = 3pt plus 2pt minus 1pt
8048 \textleading = 13.2pt
8050 % If page is nothing but text, make it come out even.
8051 \internalpagesizes{46\baselineskip}{6in}%
8053 {\bindingoffset}{36pt}%
8057 % Use @smallbook to reset parameters for 7x9.25 trim size.
8058 \def\smallbook{{\globaldefs = 1
8059 \parskip = 2pt plus 1pt
8062 \internalpagesizes{7.5in}{5in}%
8064 {\bindingoffset}{16pt}%
8067 \lispnarrowing = 0.3in
8070 \contentsrightmargin = 0pt
8071 \defbodyindent = .5cm
8074 % Use @smallerbook to reset parameters for 6x9 trim size.
8075 % (Just testing, parameters still in flux.)
8076 \def\smallerbook{{\globaldefs = 1
8077 \parskip = 1.5pt plus 1pt
8080 \internalpagesizes{7.4in}{4.8in}%
8085 \lispnarrowing = 0.25in
8088 \contentsrightmargin = 0pt
8089 \defbodyindent = .4cm
8092 % Use @afourpaper to print on European A4 paper.
8093 \def\afourpaper{{\globaldefs = 1
8094 \parskip = 3pt plus 2pt minus 1pt
8095 \textleading = 13.2pt
8097 % Double-side printing via postscript on Laserjet 4050
8098 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
8099 % To change the settings for a different printer or situation, adjust
8100 % \normaloffset until the front-side and back-side texts align. Then
8101 % do the same for \bindingoffset. You can set these for testing in
8102 % your texinfo source file like this:
8104 % \global\normaloffset = -6mm
8105 % \global\bindingoffset = 10mm
8107 \internalpagesizes{51\baselineskip}{160mm}
8108 {\voffset}{\hoffset}%
8109 {\bindingoffset}{44pt}%
8114 \contentsrightmargin = 0pt
8115 \defbodyindent = 5mm
8118 % Use @afivepaper to print on European A5 paper.
8119 % From romildo@urano.iceb.ufop.br, 2 July 2000.
8120 % He also recommends making @example and @lisp be small.
8121 \def\afivepaper{{\globaldefs = 1
8122 \parskip = 2pt plus 1pt minus 0.1pt
8123 \textleading = 12.5pt
8125 \internalpagesizes{160mm}{120mm}%
8126 {\voffset}{\hoffset}%
8127 {\bindingoffset}{8pt}%
8130 \lispnarrowing = 0.2in
8133 \contentsrightmargin = 0pt
8134 \defbodyindent = 2mm
8138 % A specific text layout, 24x15cm overall, intended for A4 paper.
8139 \def\afourlatex{{\globaldefs = 1
8141 \internalpagesizes{237mm}{150mm}%
8143 {\bindingoffset}{7mm}%
8146 % Must explicitly reset to 0 because we call \afourpaper.
8150 % Use @afourwide to print on A4 paper in landscape format.
8151 \def\afourwide{{\globaldefs = 1
8153 \internalpagesizes{241mm}{165mm}%
8154 {\voffset}{-2.95mm}%
8155 {\bindingoffset}{7mm}%
8160 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
8161 % Perhaps we should allow setting the margins, \topskip, \parskip,
8162 % and/or leading, also. Or perhaps we should compute them somehow.
8164 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
8165 \def\pagesizesyyy#1,#2,#3\finish{{%
8166 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
8169 \parskip = 3pt plus 2pt minus 1pt
8170 \setleading{\textleading}%
8173 \advance\dimen0 by \voffset
8176 \advance\dimen2 by \normaloffset
8178 \internalpagesizes{#1}{\hsize}%
8179 {\voffset}{\normaloffset}%
8180 {\bindingoffset}{44pt}%
8184 % Set default to letter.
8189 \message{and turning on texinfo input format.}
8191 % Define macros to output various characters with catcode for normal text.
8201 \def\normaldoublequote{"}
8204 \def\normalunderscore{_}
8205 \def\normalverticalbar{|}
8207 \def\normalgreater{>}
8209 \def\normaldollar{$}%$ font-lock fix
8211 % This macro is used to make a character print one way in \tt
8212 % (where it can probably be output as-is), and another way in other fonts,
8213 % where something hairier probably needs to be done.
8215 % #1 is what to print if we are indeed using \tt; #2 is what to print
8216 % otherwise. Since all the Computer Modern typewriter fonts have zero
8217 % interword stretch (and shrink), and it is reasonable to expect all
8218 % typewriter fonts to have this, we can check that font parameter.
8220 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
8222 % Same as above, but check for italic font. Actually this also catches
8223 % non-italic slanted fonts since it is impossible to distinguish them from
8224 % italic fonts. But since this is only used by $ and it uses \sl anyway
8225 % this is not a problem.
8226 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
8228 % Turn off all special characters except @
8229 % (and those which the user can use as if they were ordinary).
8230 % Most of these we simply print from the \tt font, but for some, we can
8231 % use math or other variants that look better in normal text.
8234 \def\activedoublequote{{\tt\char34}}
8235 \let"=\activedoublequote
8237 \def~{{\tt\char126}}
8243 \def_{\ifusingtt\normalunderscore\_}
8245 % Subroutine for the previous macro.
8246 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
8249 \def|{{\tt\char124}}
8257 \def+{{\tt \char 43}}
8259 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
8261 % If a .fmt file is being used, characters that might appear in a file
8262 % name cannot be active until we have parsed the command line.
8263 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
8264 % \otherifyactive is called near the end of this file.
8265 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
8267 % Used sometimes to turn off (effectively) the active characters even after
8269 \def\turnoffactive{%
8270 \normalturnoffactive
8276 % \backslashcurfont outputs one backslash character in current font,
8278 \global\chardef\backslashcurfont=`\\
8279 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
8281 % \realbackslash is an actual character `\' with catcode other, and
8282 % \doublebackslash is two of them (for the pdf outlines).
8283 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
8285 % In texinfo, backslash is an active character; it prints the backslash
8286 % in fixed width font.
8288 @def@normalbackslash{{@tt@backslashcurfont}}
8289 % On startup, @fixbackslash assigns:
8290 % @let \ = @normalbackslash
8292 % \rawbackslash defines an active \ to do \backslashcurfont.
8293 % \otherbackslash defines an active \ to be a literal `\' character with
8295 @gdef@rawbackslash{@let\=@backslashcurfont}
8296 @gdef@otherbackslash{@let\=@realbackslash}
8298 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
8299 % the literal character `\'.
8301 @def@normalturnoffactive{%
8302 @let\=@normalbackslash
8303 @let"=@normaldoublequote
8306 @let_=@normalunderscore
8307 @let|=@normalverticalbar
8309 @let>=@normalgreater
8311 @let$=@normaldollar %$ font-lock fix
8315 % Make _ and + \other characters, temporarily.
8316 % This is canceled by @fixbackslash.
8319 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
8320 % That is what \eatinput is for; after that, the `\' should revert to printing
8323 @gdef@eatinput input texinfo{@fixbackslash}
8324 @global@let\ = @eatinput
8326 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
8327 % the first `\' in the file would cause an error. This macro tries to fix
8328 % that, assuming it is called before the first `\' could plausibly occur.
8329 % Also turn back on active characters that might appear in the input
8330 % file name, in case not using a pre-dumped format.
8332 @gdef@fixbackslash{%
8333 @ifx\@eatinput @let\ = @normalbackslash @fi
8338 % Say @foo, not \foo, in error messages.
8341 % These look ok in all fonts, so just make them not special.
8342 @catcode`@& = @other
8343 @catcode`@# = @other
8344 @catcode`@% = @other
8348 @c eval: (add-hook 'write-file-hooks 'time-stamp)
8349 @c page-delimiter: "^\\\\message"
8350 @c time-stamp-start: "def\\\\texinfoversion{"
8351 @c time-stamp-format: "%:y-%02m-%02d.%02H"
8352 @c time-stamp-end: "}"
8358 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115