1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 %%%%%%% MODIFIED TO FORMAT THE GAMBIT-C MANUAL %%%%%%%
3 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5 % texinfo.tex -- TeX macros to handle Texinfo files.
7 % Load plain if necessary, i.e., if running under initex.
8 \expandafter\ifx\csname fmtname
\endcsname\relax\input plain
\fi
10 \def\texinfoversion{2004-
04-
07.08}
12 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
13 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software
16 % This texinfo.tex file is free software; you can redistribute it and/or
17 % modify it under the terms of the GNU General Public License as
18 % published by the Free Software Foundation; either version 2, or (at
19 % your option) any later version.
21 % This texinfo.tex file is distributed in the hope that it will be
22 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
23 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24 % General Public License for more details.
26 % You should have received a copy of the GNU General Public License
27 % along with this texinfo.tex file; see the file COPYING. If not, write
28 % to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
29 % Boston, MA 02111-1307, USA.
31 % As a special exception, when this file is read by TeX when processing
32 % a Texinfo source document, you may use the result without
33 % restriction. (This has been our intent since Texinfo was invented.)
35 % Please try the latest version of texinfo.tex before submitting bug
36 % reports; you can get the latest version from:
37 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
38 % ftp://tug.org/tex/texinfo.tex
39 % (and all CTAN mirrors, see http://www.ctan.org).
40 % The texinfo.tex in any given distribution could well be out
41 % of date, so if that's what you're using, please check.
43 % Send bug reports to bug-texinfo@gnu.org. Please include including a
44 % complete document in each bug report with which we can reproduce the
45 % problem. Patches are, of course, greatly appreciated.
47 % To process a Texinfo manual with TeX, it's most reliable to use the
48 % texi2dvi shell script that comes with the distribution. For a simple
49 % manual foo.texi, however, you can get away with this:
54 % dvips foo.dvi -o # or whatever; this makes foo.ps.
55 % The extra TeX runs get the cross-reference information correct.
56 % Sometimes one run after texindex suffices, and sometimes you need more
57 % than two; texi2dvi does it as many times as necessary.
59 % It is possible to adapt texinfo.tex for other languages, to some
60 % extent. You can get the existing language-specific files from the
61 % full Texinfo distribution.
63 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
66 \message{Loading texinfo
[version
\texinfoversion]:
}
67 \message{MODIFIED TO FORMAT THE GAMBIT-C MANUAL
}%search "\gamb" for modifications
69 % If in a .fmt file, print the version number
70 % and turn on active characters that we couldn't do earlier because
71 % they might have appeared in the input file name.
72 \everyjob{\message{[Texinfo version
\texinfoversion]}%
73 \catcode`+=
\active \catcode`
\_=
\active}
78 % We never want plain's \outer definition of \+ in Texinfo.
79 % For @tex, we can use \tabalign.
82 % Save some plain tex macros whose names we will redefine.
84 \let\ptexbullet=
\bullet
92 \let\ptexfootnote=
\footnote
96 \let\ptexindent=
\indent
97 \let\ptexnoindent=
\noindent
98 \let\ptexinsert=
\insert
107 % If this character appears in an error message or help string, it
108 % starts a new line in the output.
111 % Use TeX 3.0's \inputlineno to get the line number, for better error
112 % messages, but if we're using an old version of TeX, don't do anything.
114 \ifx\inputlineno\thisisundefined
115 \let\linenumber =
\empty % Pre-3.0.
117 \def\linenumber{l.
\the\inputlineno:
\space}
120 % Set up fixed words for English if not already set.
121 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix
}\fi
122 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter
}\fi
123 \ifx\putwordfile\undefined \gdef\putwordfile{file
}\fi
124 \ifx\putwordin\undefined \gdef\putwordin{in
}\fi
125 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)
}\fi
126 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)
}\fi
127 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info
}\fi
128 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of
}\fi
129 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on
}\fi
130 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title
}\fi
131 \ifx\putwordof\undefined \gdef\putwordof{of
}\fi
132 \ifx\putwordon\undefined \gdef\putwordon{on
}\fi
133 \ifx\putwordpage\undefined \gdef\putwordpage{page
}\fi
134 \ifx\putwordsection\undefined \gdef\putwordsection{section
}\fi
135 \ifx\putwordSection\undefined \gdef\putwordSection{Section
}\fi
136 \ifx\putwordsee\undefined \gdef\putwordsee{see
}\fi
137 \ifx\putwordSee\undefined \gdef\putwordSee{See
}\fi
138 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents
}\fi
139 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents
}\fi
141 \ifx\putwordMJan\undefined \gdef\putwordMJan{January
}\fi
142 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February
}\fi
143 \ifx\putwordMMar\undefined \gdef\putwordMMar{March
}\fi
144 \ifx\putwordMApr\undefined \gdef\putwordMApr{April
}\fi
145 \ifx\putwordMMay\undefined \gdef\putwordMMay{May
}\fi
146 \ifx\putwordMJun\undefined \gdef\putwordMJun{June
}\fi
147 \ifx\putwordMJul\undefined \gdef\putwordMJul{July
}\fi
148 \ifx\putwordMAug\undefined \gdef\putwordMAug{August
}\fi
149 \ifx\putwordMSep\undefined \gdef\putwordMSep{September
}\fi
150 \ifx\putwordMOct\undefined \gdef\putwordMOct{October
}\fi
151 \ifx\putwordMNov\undefined \gdef\putwordMNov{November
}\fi
152 \ifx\putwordMDec\undefined \gdef\putwordMDec{December
}\fi
154 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro
}\fi
155 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form
}\fi
156 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable
}\fi
157 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option
}\fi
158 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function
}\fi
160 % In some macros, we cannot use the `\? notation---the left quote is
161 % in some cases the escape char.
162 \chardef\colonChar = `\:
163 \chardef\commaChar = `\,
164 \chardef\dotChar = `\.
165 \chardef\exclamChar= `\!
166 \chardef\questChar = `\?
167 \chardef\semiChar = `\;
168 \chardef\underChar = `
\_
170 \chardef\spaceChar = `\
%
171 \chardef\spacecat =
10
172 \def\spaceisspace{\catcode\spaceChar=
\spacecat}
178 % The following is used inside several \edef's.
179 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
183 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
184 ap-pen-dix bit-map bit-maps
185 data-base data-bases eshell fall-ing half-way long-est man-u-script
186 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
187 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
189 stand-alone strong-est time-stamp time-stamps which-ever white-space
190 wide-spread wrap-around
193 % Margin to add to right of even pages, to left of odd pages.
194 \newdimen\bindingoffset
195 \newdimen\normaloffset
196 \newdimen\pagewidth \newdimen\pageheight
198 % For a final copy, take out the rectangles
199 % that mark overfull boxes (in case you have decided
200 % that the text looks ok even though it passes the margin).
202 \def\finalout{\overfullrule=
0pt
}
204 % @| inserts a changebar to the left of the current line. It should
205 % surround any changed text. This approach does *not* work if the
206 % change spans more than two lines of output. To handle that, we would
207 % have adopt a much more difficult approach (putting marks into the main
208 % vertical list for the beginning and end of each change).
211 % \vadjust can only be used in horizontal mode.
214 % Append this vertical mode material after the current line in the output.
216 % We want to insert a rule with the height and depth of the current
217 % leading; that is exactly what \strutbox is supposed to record.
220 % \vadjust-items are inserted at the left edge of the type. So
221 % the \llap here moves out into the left-hand margin.
224 % For a thicker or thinner bar, change the `1pt'.
225 \vrule height
\baselineskip width1pt
227 % This is the space between the bar and the text.
233 % Sometimes it is convenient to have everything in the transcript file
234 % and nothing on the terminal. We don't just call \tracingall here,
235 % since that produces some useless output on the terminal. We also make
236 % some effort to order the tracing commands to reduce output in the log
237 % file; cf. trace.sty in LaTeX.
239 \def\gloggingall{\begingroup \globaldefs =
1 \loggingall \endgroup}%
243 \tracinglostchars2 % 2 gives us more in etex
248 \showboxbreadth\maxdimen \showboxdepth\maxdimen
249 \ifx\eTeXversion\undefined\else % etex gives us more logging
256 \tracingcommands3 % 3 gives us more in etex
260 % add check for \lastpenalty to plain's definitions. If the last thing
261 % we did was a \nobreak, we don't want to insert more space.
263 \def\smallbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\smallskipamount
264 \removelastskip\penalty-
50\smallskip\fi\fi}
265 \def\medbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\medskipamount
266 \removelastskip\penalty-
100\medskip\fi\fi}
267 \def\bigbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\bigskipamount
268 \removelastskip\penalty-
200\bigskip\fi\fi}
270 % For @cropmarks command.
271 % Do @cropmarks to get crop marks.
274 \let\cropmarks =
\cropmarkstrue
276 % Dimensions to add cropmarks at corners.
277 % Added by P. A. MacKay, 12 Nov. 1986
279 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
280 \newdimen\cornerlong \cornerlong=
1pc
281 \newdimen\cornerthick \cornerthick=
.3pt
282 \newdimen\topandbottommargin \topandbottommargin=
.75in
284 % Main output routine.
286 \output =
{\onepageout{\pagecontents\PAGE}}
291 % \onepageout takes a vbox as an argument. Note that \pagecontents
292 % does insertions, but you have to call it yourself.
294 \ifcropmarks \hoffset=
0pt
\else \hoffset=
\normaloffset \fi
296 \ifodd\pageno \advance\hoffset by
\bindingoffset
297 \else \advance\hoffset by -
\bindingoffset\fi
299 % Do this outside of the \shipout so @code etc. will be expanded in
300 % the headline as they should be, not taken literally (outputting ''code).
301 \setbox\headlinebox =
\vbox{\let\hsize=
\pagewidth \makeheadline}%
302 \setbox\footlinebox =
\vbox{\let\hsize=
\pagewidth \makefootline}%
305 % Have to do this stuff outside the \shipout because we want it to
306 % take effect in \write's, yet the group defined by the \vbox ends
307 % before the \shipout runs.
309 \escapechar = `\\
% use backslash in output files.
310 \indexdummies % don't expand commands in the output.
311 \normalturnoffactive % \ in index entries must not stay \, e.g., if
312 % the page break happens to be in the middle of an example.
314 % Do this early so pdf references go to the beginning of the page.
315 \ifpdfmakepagedest \pdfdest name
{\the\pageno} xyz
\fi
317 \ifcropmarks \vbox to
\outervsize\bgroup
319 \vskip-
\topandbottommargin
321 \line{\ewtop\hfil\ewtop}%
324 \vbox{\moveleft\cornerthick\nstop}%
326 \vbox{\moveright\cornerthick\nstop}%
329 \vskip\topandbottommargin
331 \hfil % center the page within the outer (page) hsize.
332 \ifodd\pageno\hskip\bindingoffset\fi
338 \ifdim\ht\footlinebox >
0pt
339 % Only leave this space if the footline is nonempty.
340 % (We lessened \vsize for it in \oddfootingxxx.)
341 % The \baselineskip=24pt in plain's \makefootline has no effect.
342 \vskip 2\baselineskip
347 \egroup % end of \vbox\bgroup
348 \hfil\egroup % end of (centering) \line\bgroup
349 \vskip\topandbottommargin plus1fill minus1fill
350 \boxmaxdepth =
\cornerthick
353 \vbox{\moveleft\cornerthick\nsbot}%
355 \vbox{\moveright\cornerthick\nsbot}%
358 \line{\ewbot\hfil\ewbot}%
360 \egroup % \vbox from first cropmarks clause
362 }% end of \shipout\vbox
363 }% end of group with \normalturnoffactive
365 \ifnum\outputpenalty>-
20000 \else\dosupereject\fi
368 \newinsert\margin \dimen\margin=
\maxdimen
370 \def\pagebody#1{\vbox to
\pageheight{\boxmaxdepth=
\maxdepth #1}}
372 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
373 % marginal hacks, juha@viisa.uucp (Juha Takala)
374 \ifvoid\margin\else % marginal info is present
375 \rlap{\kern\hsize\vbox to
\z@
{\kern1pt\box\margin \vss}}\fi
376 \dimen@=
\dp#1 \unvbox#1
377 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
378 \ifr@ggedbottom
\kern-
\dimen@
\vfil \fi}
381 % Here are the rules for the cropmarks. Note that they are
382 % offset so that the space between them is truly \outerhsize or \outervsize
383 % (P. A. MacKay, 12 November, 1986)
385 \def\ewtop{\vrule height
\cornerthick depth0pt width
\cornerlong}
387 {\hrule height
\cornerthick depth
\cornerlong width
\cornerthick}}
388 \def\ewbot{\vrule height0pt depth
\cornerthick width
\cornerlong}
390 {\hrule height
\cornerlong depth
\cornerthick width
\cornerthick}}
392 % Parse an argument, then pass it to #1. The argument is the rest of
393 % the input line (except we remove a trailing comment). #1 should be a
394 % macro which expects an ordinary undelimited TeX argument.
396 \def\parsearg{\parseargusing{}}
397 \def\parseargusing#1#2{%
403 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
407 \gdef\parseargline#1^^M
{%
408 \endgroup % End of the group started in \parsearg.
409 \argremovecomment #1\comment\ArgTerm%
413 % First remove any @comment, then any @c comment.
414 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
415 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M
\ArgTerm}
417 % Each occurence of `\^^M' or `<space>\^^M' is replaced by a single space.
419 % \argremovec might leave us with trailing space, e.g.,
420 % @end itemize @c foo
421 % This space token undergoes the same procedure and is eventually removed
422 % by \finishparsearg.
424 \def\argcheckspaces#1\^^M
{\argcheckspacesX#1\^^M \^^M
}
425 \def\argcheckspacesX#1 \^^M
{\argcheckspacesY#1\^^M
}
426 \def\argcheckspacesY#1\^^M
#2\^^M
#3\ArgTerm{%
429 % We cannot use \next here, as it holds the macro to run;
430 % thus we reuse \temp.
431 \let\temp\finishparsearg
433 \let\temp\argcheckspaces
435 % Put the space token in:
439 % If a _delimited_ argument is enclosed in braces, they get stripped; so
440 % to get _exactly_ the rest of the line, we had to prevent such situation.
441 % We prepended an \empty token at the very beginning and we expand it now,
442 % just before passing the control to \next.
443 % (Similarily, we have to think about #3 of \argcheckspacesY above: it is
444 % either the null string, or it ends with \^^M---thus there is no danger
445 % that a pair of braces would be stripped.
447 % But first, we have to remove the trailing space token.
449 \def\finishparsearg#1 \ArgTerm{\expandafter\next\expandafter{#1}}
451 % \parseargdef\foo{...}
452 % is roughly equivalent to
453 % \def\foo{\parsearg\Xfoo}
456 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
457 % favourite TeX trick. --kasal, 16nov03
460 \expandafter \doparseargdef \csname\string#1\endcsname #1%
462 \def\doparseargdef#1#2{%
467 % Several utility definitions with active space:
472 % Make each space character in the input produce a normal interword
473 % space in the output. Don't allow a line break at this space, as this
474 % is used only in environments like @example, where each line of input
475 % should produce a line of output anyway.
477 \gdef\sepspaces{\obeyspaces\let =
\tie}
479 % If an index command is used in an @example environment, any spaces
480 % therein should become regular spaces in the raw index file, not the
481 % expansion of \tie (\leavevmode \penalty \@M \ ).
482 \gdef\unsepspaces{\let =
\space}
486 \def\flushcr{\ifx\par\lisppar \def\next#
#1{}\else \let\next=
\relax \fi \next}
488 % Define the framework for environments in texinfo.tex. It's used like this:
493 % It's the responsibility of \envdef to insert \begingroup before the
494 % actual body; @end closes the group after calling \Efoo. \envdef also
495 % defines \thisenv, so the current environment is known; @end checks
496 % whether the environment name matches. The \checkenv macro can also be
497 % used to check whether the current environment is the one expected.
499 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
500 % are not treated as enviroments; they don't open a group. (The
501 % implementation of @end takes care not to call \endgroup in this
505 % At runtime, environments start with this:
506 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
510 % ... but they get defined via ``\envdef\foo{...}'':
511 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
512 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
514 % Check whether we're in the right environment:
523 % Evironment mismatch, #1 expected:
526 \errmessage{This command can appear only
\inenvironment\temp,
527 not
\inenvironment\thisenv}%
529 \def\inenvironment#1{%
531 out of any environment
%
533 in environment
\expandafter\string#1%
537 % @end foo executes the definition of \Efoo.
538 % But first, it executes a specialized version of \checkenv
541 \if 1\csname iscond.
#1\endcsname
543 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
544 \expandafter\checkenv\csname#1\endcsname
545 \csname E
#1\endcsname
550 \newhelp\EMsimple{Press RETURN to continue.
}
553 %% Simple single-character @ commands
556 % Kludge this until the fonts are right (grr).
559 % This is turned off because it was never documented
560 % and you can use @w{...} around a quote to suppress ligatures.
561 %% Define @` and @' to be the same as ` and '
562 %% but suppressing ligatures.
566 % Used to generate quoted braces.
567 \def\mylbrace {{\tt\char123}}
568 \def\myrbrace {{\tt\char125}}
572 % Definitions to produce \{ and \} commands for indices,
573 % and @{ and @} for the aux file.
574 \catcode`\
{ =
\other \catcode`\
} =
\other
575 \catcode`\
[ =
1 \catcode`\
] =
2
576 \catcode`\! =
0 \catcode`\\ =
\other
579 !gdef!lbraceatcmd
[@
{]%
580 !gdef!rbraceatcmd
[@
}]%
583 % @comma{} to avoid , parsing problems.
586 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
587 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
590 \def\ringaccent#1{{\accent23 #1}}
595 % Other special characters: @questiondown @exclamdown @ordf @ordm
596 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
597 \def\questiondown{?`
}
599 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a
}}}
600 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o
}}}
602 % Dotless i and dotless j, used for accents.
607 \ifx\temp\imacro \ptexi
608 \else\ifx\temp\jmacro \j
609 \else \errmessage{@dotless can be used only with i or j
}%
613 % The \TeX{} logo, as in plain, but resetting the spacing so that a
614 % period following counts as ending a sentence. (Idea found in latex.)
616 \edef\TeX{\TeX \spacefactor=
3000 }
618 % @LaTeX{} logo. Not quite the same results as the definition in
619 % latex.ltx, since we use a different font for the raised A; it's most
620 % convenient for us to use an explicitly smaller font, rather than using
621 % the \scriptstyle font (since we don't reset \scriptstyle and
622 % \scriptscriptstyle).
627 \vbox to
\ht0{\hbox{\selectfonts\lllsize A
}\vss}}%
632 % Be sure we're in horizontal mode when doing a tie, since we make space
633 % equivalent to this in @example-like environments. Otherwise, a space
634 % at the beginning of a line will start with \penalty -- and
635 % since \penalty is valid in vertical mode, we'd end up putting the
636 % penalty on the vertical list instead of in the new paragraph.
638 % Avoid using \@M directly, because that causes trouble
639 % if the definition is written into an index file.
640 \global\let\tiepenalty = \@M
641 \gdef\tie{\leavevmode\penalty\tiepenalty\
}
644 % @: forces normal size whitespace following.
645 \def\:
{\spacefactor=
1000 }
647 % @* forces a line break.
648 \def\*
{\hfil\break\hbox{}\ignorespaces}
650 % @/ allows a line break.
653 % @. is an end-of-sentence period.
654 \def\.
{.
\spacefactor=
3000 }
656 % @! is an end-of-sentence bang.
657 \def\!
{!
\spacefactor=
3000 }
659 % @? is an end-of-sentence query.
660 \def\?
{?
\spacefactor=
3000 }
662 % @w prevents a word break. Without the \leavevmode, @w at the
663 % beginning of a paragraph, when TeX is still in vertical mode, would
664 % produce a whole line of output instead of starting the paragraph.
665 \def\w#1{\leavevmode\hbox{#1}}
667 % @group ... @end group forces ... to be all on one page, by enclosing
668 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
669 % to keep its height that of a normal line. According to the rules for
670 % \topskip (p.114 of the TeXbook), the glue inserted is
671 % max (\topskip - \ht (first item), 0). If that height is large,
672 % therefore, no glue is inserted, and the space between the headline and
673 % the text is small, which looks bad.
675 % Another complication is that the group might be very large. This can
676 % cause the glue on the previous page to be unduly stretched, because it
677 % does not have much material. In this case, it's better to add an
678 % explicit \vfill so that the extra space is at the bottom. The
679 % threshold for doing this is if the group is more than \vfilllimit
680 % percent of a page (\vfilllimit can be changed inside of @tex).
686 \ifnum\catcode`\^^M=
\active \else
687 \errhelp =
\groupinvalidhelp
688 \errmessage{@group invalid in context where filling is enabled
}%
692 \setbox\groupbox =
\vtop\bgroup
693 % Do @comment since we are called inside an environment such as
694 % @example, where each end-of-line in the input causes an
695 % end-of-line in the output. We don't want the end-of-line after
696 % the `@group' to put extra space in the output. Since @group
697 % should appear on a line by itself (according to the Texinfo
698 % manual), we don't worry about eating any user text.
702 % The \vtop produces a box with normal height and large depth; thus, TeX puts
703 % \baselineskip glue before it, and (when the next line of text is done)
704 % \lineskip glue after it. Thus, space below is not quite equal to space
705 % above. But it's pretty close.
707 % To get correct interline space between the last line of the group
708 % and the first line afterwards, we have to propagate \prevdepth.
709 \endgraf % Not \par, as it may have been set to \lisppar.
710 \global\dimen1 =
\prevdepth
711 \egroup % End the \vtop.
712 % \dimen0 is the vertical size of the group's box.
713 \dimen0 =
\ht\groupbox \advance\dimen0 by
\dp\groupbox
714 % \dimen2 is how much space is left on the page (more or less).
715 \dimen2 =
\pageheight \advance\dimen2 by -
\pagetotal
716 % if the group doesn't fit on the current page, and it's a big big
717 % group, force a page break.
718 \ifdim \dimen0 >
\dimen2
719 \ifdim \pagetotal <
\vfilllimit\pageheight
728 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
729 % message, so this ends up printing `@group can only ...'.
731 \newhelp\groupinvalidhelp{%
732 group can only be used in environments such as @example,^^J
%
733 where each line of input produces a line of output.
}
735 % @need space-in-mils
736 % forces a page break if there is not space-in-mils remaining.
738 \newdimen\mil \mil=
0.001in
740 % Old definition--didn't work.
741 %\parseargdef\need{\par %
742 %% This method tries to make TeX break the page naturally
743 %% if the depth of the box does not fit.
745 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
750 % Ensure vertical mode, so we don't make a big box in the middle of a
754 % If the @need value is less than one line space, it's useless.
756 \dimen2 =
\ht\strutbox
757 \advance\dimen2 by
\dp\strutbox
758 \ifdim\dimen0 >
\dimen2
760 % Do a \strut just to make the height of this box be normal, so the
761 % normal leading is inserted relative to the preceding line.
762 % And a page break here is fine.
763 \vtop to
#1\mil{\strut\vfil}%
765 % TeX does not even consider page breaks if a penalty added to the
766 % main vertical list is 10000 or more. But in order to see if the
767 % empty box we just added fits on the page, we must make it consider
768 % page breaks. On the other hand, we don't want to actually break the
769 % page after the empty box. So we use a penalty of 9999.
771 % There is an extremely small chance that TeX will actually break the
772 % page at this \penalty, if there are no other feasible breakpoints in
773 % sight. (If the user is using lots of big @group commands, which
774 % almost-but-not-quite fill up a page, TeX will have a hard time doing
775 % good page breaking, for example.) However, I could not construct an
776 % example where a page broke at this \penalty; if it happens in a real
777 % document, then we can reconsider our strategy.
780 % Back up by the size of the box, whether we did a page break or not.
783 % Do not allow a page break right after this kern.
788 % @br forces paragraph break (and is undocumented).
792 % @page forces the start of a new page.
794 \def\page{\par\vfill\supereject}
797 % outputs text on separate line in roman font, starting at standard page margin
799 % This records the amount of indent in the innermost environment.
800 % That's how much \exdent should take out.
801 \newskip\exdentamount
803 % This defn is used inside fill environments such as @defun.
804 \parseargdef\exdent{\hfil\break\hbox{\kern -
\exdentamount{\rm#1}}\hfil\break}
806 % This defn is used inside nofill environments such as @example.
807 \parseargdef\nofillexdent{{\advance \leftskip by -
\exdentamount
808 \leftline{\hskip\leftskip{\rm#1}}}}
810 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
811 % paragraph. For more general purposes, use the \margin insertion
812 % class. WHICH is `l' or `r'.
814 \newskip\inmarginspacing \inmarginspacing=
1cm
815 \def\strutdepth{\dp\strutbox}
817 \def\doinmargin#1#2{\strut\vadjust{%
820 \vtop to
\strutdepth{%
821 \baselineskip=
\strutdepth
823 % if you have multiple lines of stuff to put here, you'll need to
824 % make the vbox yourself of the appropriate size.
826 \llap{\ignorespaces #2\hskip\inmarginspacing}%
828 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
833 \def\inleftmargin{\doinmargin l
}
834 \def\inrightmargin{\doinmargin r
}
836 % @inmargin{TEXT [, RIGHT-TEXT]}
837 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
838 % else use TEXT for both).
840 \def\inmargin#1{\parseinmargin #1,,
\finish}
841 \def\parseinmargin#1,
#2,
#3\finish{% not perfect, but better than nothing.
842 \setbox0 =
\hbox{\ignorespaces #2}%
844 \def\lefttext{#1}% have both texts
847 \def\lefttext{#1}% have only one text
852 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
854 \def\temp{\inleftmargin\lefttext}%
859 % @include file insert text of that file as input.
861 \def\include{\parseargusing\filenamecatcodes\includezzz}
867 \def\temp{\input #1 }%
872 \def\filenamecatcodes{%
884 \def\pushthisfilestack{%
885 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
887 \def\pushthisfilestackX{%
888 \expandafter\pushthisfilestackY\thisfile\StackTerm
890 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
891 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
894 \def\popthisfilestack{\errthisfilestackempty}
895 \def\errthisfilestackempty{\errmessage{Internal error:
896 the stack of filenames is empty.
}}
901 % outputs that line, centered.
903 \parseargdef\center{%
909 \next{\hfil \ignorespaces#1\unskip \hfil}%
914 \advance\hsize by -
\leftskip
915 \advance\hsize by -
\rightskip
920 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
922 % @sp n outputs n lines of vertical space
924 \parseargdef\sp{\vskip #1\baselineskip}
926 % @comment ...line which is ignored...
927 % @c is the same as @comment
928 % @ignore ... @end ignore is another way to write a comment
930 \def\comment{\begingroup \catcode`\^^M=
\other%
931 \catcode`\@=
\other \catcode`\
{=
\other \catcode`\
}=
\other%
933 {\catcode`\^^M=
\other \gdef\commentxxx#1^^M
{\endgroup}}
937 % @paragraphindent NCHARS
938 % We'll use ems for NCHARS, close enough.
939 % NCHARS can also be the word `asis' or `none'.
940 % We cannot feasibly implement @paragraphindent asis, though.
942 \def\asisword{asis
} % no translation, these are keywords
945 \parseargdef\paragraphindent{%
950 \defaultparindent =
0pt
952 \defaultparindent =
#1em
955 \parindent =
\defaultparindent
958 % @exampleindent NCHARS
959 % We'll use ems for NCHARS like @paragraphindent.
960 % It seems @exampleindent asis isn't necessary, but
961 % I preserve it to make it similar to @paragraphindent.
962 \parseargdef\exampleindent{%
969 \lispnarrowing =
#1em
974 % @firstparagraphindent WORD
975 % If WORD is `none', then suppress indentation of the first paragraph
976 % after a section heading. If WORD is `insert', then do indent at such
979 % The paragraph indentation is suppressed or not by calling
980 % \suppressfirstparagraphindent, which the sectioning commands do.
981 % We switch the definition of this back and forth according to WORD.
982 % By default, we suppress indentation.
984 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
985 \def\insertword{insert
}
987 \parseargdef\firstparagraphindent{%
990 \let\suppressfirstparagraphindent =
\dosuppressfirstparagraphindent
991 \else\ifx\temp\insertword
992 \let\suppressfirstparagraphindent =
\relax
995 \errmessage{Unknown @firstparagraphindent option `
\temp'
}%
999 % Here is how we actually suppress indentation. Redefine \everypar to
1000 % \kern backwards by \parindent, and then reset itself to empty.
1002 % We also make \indent itself not actually do anything until the next
1005 \gdef\dosuppressfirstparagraphindent{%
1007 \restorefirstparagraphindent
1011 \restorefirstparagraphindent
1014 \global\everypar =
{%
1016 \restorefirstparagraphindent
1020 \gdef\restorefirstparagraphindent{%
1021 \global \let \indent =
\ptexindent
1022 \global \let \noindent =
\ptexnoindent
1023 \global \everypar =
{}%
1027 % @asis just yields its argument. Used with @table, for example.
1031 % @math outputs its argument in math mode.
1033 % One complication: _ usually means subscripts, but it could also mean
1034 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1035 % _ active, and distinguish by seeing if the current family is \slfam,
1036 % which is what @var uses.
1038 \catcode\underChar =
\active
1039 \gdef\mathunderscore{%
1040 \catcode\underChar=
\active
1041 \def_{\ifnum\fam=
\slfam \_\else\sb\fi}%
1044 % Another complication: we want \\ (and @\) to output a \ character.
1045 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1046 % this is not advertised and we don't care. Texinfo does not
1047 % otherwise define @\.
1049 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1050 \def\mathbackslash{\ifnum\fam=
\ttfam \mathchar"
075C
\else\backslash \fi}
1055 \let\\ =
\mathbackslash
1059 \def\finishmath#1{#1$
\endgroup} % Close the group opened by \tex.
1061 % Some active characters (such as <) are spaced differently in math.
1062 % We have to reset their definitions in case the @math was an argument
1063 % to a command which sets the catcodes (such as @item or @section).
1066 \catcode`^ =
\active
1067 \catcode`< =
\active
1068 \catcode`> =
\active
1069 \catcode`+ =
\active
1078 % @bullet and @minus need the same treatment as @math, just above.
1079 \def\bullet{$
\ptexbullet$
}
1082 % @dots{} outputs an ellipsis using the current font.
1083 % We do .5em per period so that it has the same spacing in a typewriter
1084 % font as three actual period characters.
1089 \hskip 0pt plus
0.25fil
1091 \hskip 0pt plus
0.5fil
1095 % @enddots{} is an end-of-sentence ellipsis.
1102 % @comma{} is so commas can be inserted into text without messing up
1103 % Texinfo's parsing.
1107 % @refill is a no-op.
1110 % If working on a large document in chapters, it is convenient to
1111 % be able to disable indexing, cross-referencing, and contents, for test runs.
1112 % This is done with @novalidate (before @setfilename).
1114 \newif\iflinks \linkstrue % by default we want the aux files.
1115 \let\novalidate =
\linksfalse
1117 % @setfilename is done at the beginning of every texinfo file.
1118 % So open here the files we need to have open while reading the input.
1119 % This makes it possible to make a .fmt file for texinfo.
1121 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1124 % Open the new aux file. TeX will close it automatically at exit.
1125 \immediate\openout\auxfile=
\jobname.aux
1126 \fi % \openindices needs to do some work in any case.
1128 \let\setfilename=
\comment % Ignore extra @setfilename cmds.
1130 % If texinfo.cnf is present on the system, read it.
1131 % Useful for site-wide @afourpaper, etc.
1132 \openin 1 texinfo.cnf
1133 \ifeof 1 \else \input texinfo.cnf
\fi
1136 \comment % Ignore the actual filename.
1139 % Called from \setfilename.
1151 \outer\def\bye{\pagealignmacro\tracingstats=
1\ptexend}
1155 % adobe `portable' document format
1159 \newcount\filenamelength
1168 \newif\ifpdfmakepagedest
1170 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1171 % can be set). So we test for \relax and 0 as well as \undefined,
1172 % borrowed from ifpdf.sty.
1173 \ifx\pdfoutput\undefined
1175 \ifx\pdfoutput\relax
1186 \pdfcatalog{/PageMode /UseOutlines
}%
1187 \def\dopdfimage#1#2#3{%
1188 \def\imagewidth{#2}%
1189 \def\imageheight{#3}%
1190 % without \immediate, pdftex seg faults when the same image is
1191 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1192 \ifnum\pdftexversion <
14
1195 \immediate\pdfximage
1197 \ifx\empty\imagewidth\else width
\imagewidth \fi
1198 \ifx\empty\imageheight\else height
\imageheight \fi
1199 \ifnum\pdftexversion<
13
1204 \ifnum\pdftexversion <
14 \else
1205 \pdfrefximage \pdflastximage
1208 % We have to set dummies so commands such as @code in a section title
1211 \normalturnoffactive
1212 \pdfdest name
{#1} xyz
%
1215 \let\linkcolor =
\Blue % was Cyan, but that seems light?
1216 \def\endlink{\Black\pdfendlink}
1217 % Adding outlines to PDF; macros for calculating structure of outlines
1218 % come from Petr Olsak
1219 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1220 \else \csname#1\endcsname \fi}
1221 \def\advancenumber#1{\tempnum=
\expnumber{#1}\relax
1222 \advance\tempnum by
1
1223 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1225 % #1 is the section text. #2 is the pdf expression for the number
1226 % of subentries (or empty, for subsubsections). #3 is the node
1227 % text, which might be empty if this toc entry had no
1228 % corresponding node. #4 is the page number.
1230 \def\dopdfoutline#1#2#3#4{%
1231 % Generate a link to the node text if that exists; else, use the
1232 % page number. We could generate a destination for the section
1233 % text in the case where a section has no node, but it doesn't
1234 % seem worthwhile, since most documents are normally structured.
1235 \def\pdfoutlinedest{#3}%
1236 \ifx\pdfoutlinedest\empty \def\pdfoutlinedest{#4}\fi
1238 \pdfoutline goto name
{\pdfmkpgn{\pdfoutlinedest}}#2{#1}%
1241 \def\pdfmakeoutlines{%
1243 % Thanh's hack / proper braces in bookmarks
1244 \edef\mylbrace{\iftrue \string{\else}\fi}\let\
{=
\mylbrace
1245 \edef\myrbrace{\iffalse{\else\string}\fi}\let\
}=
\myrbrace
1247 % Read toc silently, to get counts of subentries for \pdfoutline.
1248 \def\numchapentry#
#1#
#2#
#3#
#4{%
1249 \def\thischapnum{#
#2}%
1250 \let\thissecnum\empty
1251 \let\thissubsecnum\empty
1253 \def\numsecentry#
#1#
#2#
#3#
#4{%
1254 \advancenumber{chap
\thischapnum}%
1255 \def\thissecnum{#
#2}%
1256 \let\thissubsecnum\empty
1258 \def\numsubsecentry#
#1#
#2#
#3#
#4{%
1259 \advancenumber{sec
\thissecnum}%
1260 \def\thissubsecnum{#
#2}%
1262 \def\numsubsubsecentry#
#1#
#2#
#3#
#4{%
1263 \advancenumber{subsec
\thissubsecnum}%
1265 \let\thischapnum\empty
1266 \let\thissecnum\empty
1267 \let\thissubsecnum\empty
1269 % use \def rather than \let here because we redefine \chapentry et
1270 % al. a second time, below.
1271 \def\appentry{\numchapentry}%
1272 \def\appsecentry{\numsecentry}%
1273 \def\appsubsecentry{\numsubsecentry}%
1274 \def\appsubsubsecentry{\numsubsubsecentry}%
1275 \def\unnchapentry{\numchapentry}%
1276 \def\unnsecentry{\numsecentry}%
1277 \def\unnsubsecentry{\numsubsecentry}%
1278 \def\unnsubsubsecentry{\numsubsubsecentry}%
1281 % Read toc second time, this time actually producing the outlines.
1282 % The `-' means take the \expnumber as the absolute number of
1283 % subentries, which we calculated on our first read of the .toc above.
1285 % We use the node names as the destinations.
1286 \def\numchapentry#
#1#
#2#
#3#
#4{%
1287 \dopdfoutline{#
#1}{count-
\expnumber{chap#
#2}}{#
#3}{#
#4}}%
1288 \def\numsecentry#
#1#
#2#
#3#
#4{%
1289 \dopdfoutline{#
#1}{count-
\expnumber{sec#
#2}}{#
#3}{#
#4}}%
1290 \def\numsubsecentry#
#1#
#2#
#3#
#4{%
1291 \dopdfoutline{#
#1}{count-
\expnumber{subsec#
#2}}{#
#3}{#
#4}}%
1292 \def\numsubsubsecentry#
#1#
#2#
#3#
#4{% count is always zero
1293 \dopdfoutline{#
#1}{}{#
#3}{#
#4}}%
1295 % PDF outlines are displayed using system fonts, instead of
1296 % document fonts. Therefore we cannot use special characters,
1297 % since the encoding is unknown. For example, the eogonek from
1298 % Latin 2 (0xea) gets translated to a | character. Info from
1299 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1301 % xx to do this right, we have to translate 8-bit characters to
1302 % their "best" equivalent, based on the @documentencoding. Right
1303 % now, I guess we'll just let the pdf reader have its way.
1310 \def\makelinks #1,
{%
1311 \def\params{#1}\def\E{END
}%
1313 \let\nextmakelinks=
\relax
1315 \let\nextmakelinks=
\makelinks
1316 \ifnum\lnkcount>
0,
\fi
1318 \startlink attr
{/Border
[0 0 0]}
1319 goto name
{\pdfmkpgn{\the\pgn}}%
1321 \advance\lnkcount by
1%
1326 \def\picknum#1{\expandafter\pn#1}
1337 \def\ppn#1{\pgn=
#1\gobble}
1338 \def\ppnn{\pgn=
\first}
1339 \def\pdfmklnk#1{\lnkcount=
0\makelinks #1,END,
}
1340 \def\skipspaces#1{\def\PP{#1}\def\D{|
}%
1341 \ifx\PP\D\let\nextsp\relax
1342 \else\let\nextsp\skipspaces
1343 \ifx\p\space\else\addtokens{\filename}{\PP}%
1344 \advance\filenamelength by
1
1348 \def\getfilename#1{\filenamelength=
0\expandafter\skipspaces#1|
\relax}
1349 \ifnum\pdftexversion <
14
1350 \let \startlink \pdfannotlink
1352 \let \startlink \pdfstartlink
1356 \normalturnoffactive\def\@
{@
}%
1357 \makevalueexpandable
1359 \startlink attr
{/Border
[0 0 0]}%
1360 user
{/Subtype /Link /A << /S /URI /URI (
#1) >>
}%
1362 \def\pdfgettoks#1.
{\setbox\boxA=
\hbox{\toksA=
{#1.
}\toksB=
{}\maketoks}}
1363 \def\addtokens#1#2{\edef\addtoks{\noexpand#1=
{\the#1#2}}\addtoks}
1364 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=
1\let\next=
\maketoks}
1365 \def\poptoks#1#2|ENDTOKS|
{\let\first=
#1\toksD=
{#1}\toksA=
{#2}}
1367 \expandafter\poptoks\the\toksA|ENDTOKS|
\relax
1369 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1370 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1371 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1373 \ifnum0=
\countA\else\makelink\fi
1374 \ifx\first.
\let\next=
\done\else
1376 \addtokens{\toksB}{\the\toksD}
1377 \ifx\first,
\addtokens{\toksB}{\space}\fi
1379 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1381 \def\makelink{\addtokens{\toksB}%
1382 {\noexpand\pdflink{\the\toksC}}\toksC=
{}\global\countA=
0}
1384 \startlink attr
{/Border
[0 0 0]} goto name
{\pdfmkpgn{#1}}
1385 \linkcolor #1\endlink}
1386 \def\done{\edef\st{\global\noexpand\toksA=
{\the\toksB}}\st}
1388 \let\pdfmkdest =
\gobble
1389 \let\pdfurl =
\gobble
1390 \let\endlink =
\relax
1391 \let\linkcolor =
\relax
1392 \let\pdfmakeoutlines =
\relax
1393 \fi % \ifx\pdfoutput
1398 % Change the current font style to #1, remembering it in \curfontstyle.
1399 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1400 % italics, not bold italics.
1402 \def\setfontstyle#1{%
1403 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1404 \csname ten
#1\endcsname % change the current font
1407 % Select #1 fonts with the current style.
1409 \def\selectfonts#1{\csname #1fonts
\endcsname \csname\curfontstyle\endcsname}
1411 \def\rm{\fam=
0 \setfontstyle{rm
}}
1412 \def\it{\fam=
\itfam \setfontstyle{it
}}
1413 \def\sl{\fam=
\slfam \setfontstyle{sl
}}
1414 \def\bf{\fam=
\bffam \setfontstyle{bf
}}
1415 \def\tt{\fam=
\ttfam \setfontstyle{tt
}}
1417 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1418 % So we set up a \sf.
1420 \def\sf{\fam=
\sffam \setfontstyle{sf
}}
1421 \let\li =
\sf % Sometimes we call it \li, not \sf.
1423 % We don't need math for this font style.
1424 \def\ttsl{\setfontstyle{ttsl
}}
1427 \newdimen\textleading \textleading =
13.2pt
1429 % Set the baselineskip to #1, and the lineskip and strut size
1430 % correspondingly. There is no deep meaning behind these magic numbers
1431 % used as factors; they just match (closely enough) what Knuth defined.
1433 \def\lineskipfactor{.08333}
1434 \def\strutheightpercent{.70833}
1435 \def\strutdepthpercent {.29167}
1438 \normalbaselineskip =
#1\relax
1439 \normallineskip =
\lineskipfactor\normalbaselineskip
1441 \setbox\strutbox =
\hbox{%
1442 \vrule width0pt height
\strutheightpercent\baselineskip
1443 depth
\strutdepthpercent \baselineskip
1447 % Set the font macro #1 to the font named #2, adding on the
1448 % specified font prefix (normally `cm').
1449 % #3 is the font's design size, #4 is a scale factor
1450 \def\setfont#1#2#3#4{\font#1=
\fontprefix#2#3 scaled
#4}
1451 \def\setfonttt#1#2#3#4{\font#1=pcrr scaled
#4}
1452 \def\setfontttb#1#2#3#4{\font#1=pcrb scaled
#4}
1453 \def\setfontttsl#1#2#3#4{\font#1=pcrro scaled
#4}
1455 % Use cm as the default font prefix.
1456 % To specify the font prefix, you must define \fontprefix
1457 % before you read in texinfo.tex.
1458 \ifx\fontprefix\undefined
1461 % Support font families that don't use the same naming scheme as CM.
1463 \def\rmbshape{bx
} %where the normal face is bold
1468 \def\ttslshape{sltt
}
1478 % Text fonts (11.2pt, magstep1).
1479 \newcount\mainmagstep
1481 % not really supported.
1482 \mainmagstep=
\magstep1
1483 \setfont\textrm\rmshape{12}{1000}
1484 \setfonttt\texttt\ttshape{12}{1000}
1485 \setfontttb\textttb\ttshape{12}{1000}
1487 \mainmagstep=
\magstephalf
1488 \setfont\textrm\rmshape{10}{\mainmagstep}
1489 \setfonttt\texttt\ttshape{10}{\mainmagstep}
1490 \setfontttb\textttb\ttshape{10}{\mainmagstep}
1492 \setfont\textbf\bfshape{10}{\mainmagstep}
1493 \setfont\textit\itshape{10}{\mainmagstep}
1494 \setfont\textsl\slshape{10}{\mainmagstep}
1495 \setfont\textsf\sfshape{10}{\mainmagstep}
1496 \setfont\textsc\scshape{10}{\mainmagstep}
1497 \setfontttsl\textttsl\ttslshape{10}{\mainmagstep}
1498 \font\texti=cmmi10 scaled
\mainmagstep
1499 \font\textsy=cmsy10 scaled
\mainmagstep
1501 % A few fonts for @defun names and args.
1502 \setfont\defbf\bfshape{10}{\magstep1}
1503 \setfonttt\deftt\ttshape{10}{\magstep1}
1504 \setfontttsl\defttsl\ttslshape{10}{\magstep1}
1505 \def\df{\let\tentt=
\deftt \let\tenbf =
\defbf \let\tenttsl=
\defttsl \bf}
1507 % Fonts for indices, footnotes, small examples (9pt).
1508 \setfont\smallrm\rmshape{9}{1000}
1509 \setfonttt\smalltt\ttshape{9}{1000}
1510 \setfontttb\smallttb\ttshape{9}{1000}
1511 \setfont\smallbf\bfshape{10}{900}
1512 \setfont\smallit\itshape{9}{1000}
1513 \setfont\smallsl\slshape{9}{1000}
1514 \setfont\smallsf\sfshape{9}{1000}
1515 \setfont\smallsc\scshape{10}{900}
1516 \setfontttsl\smallttsl\ttslshape{10}{900}
1520 % Fonts for small examples (8pt).
1521 \setfont\smallerrm\rmshape{8}{1000}
1522 \setfonttt\smallertt\ttshape{8}{1000}
1523 \setfont\smallerbf\bfshape{10}{800}
1524 \setfont\smallerit\itshape{8}{1000}
1525 \setfont\smallersl\slshape{8}{1000}
1526 \setfont\smallersf\sfshape{8}{1000}
1527 \setfont\smallersc\scshape{10}{800}
1528 \setfontttsl\smallerttsl\ttslshape{10}{800}
1529 \font\smalleri=cmmi8
1530 \font\smallersy=cmsy8
1532 % Fonts for title page (20.4pt):
1533 \setfont\titlerm\rmbshape{12}{\magstep3}
1534 \setfont\titleit\itbshape{10}{\magstep4}
1535 \setfont\titlesl\slbshape{10}{\magstep4}
1536 \setfontttb\titlett\ttbshape{12}{\magstep3}
1537 \setfontttsl\titlettsl\ttslshape{10}{\magstep4}
1538 \setfont\titlesf\sfbshape{17}{\magstep1}
1539 \let\titlebf=
\titlerm
1540 \setfont\titlesc\scbshape{10}{\magstep4}
1541 \font\titlei=cmmi12 scaled
\magstep3
1542 \font\titlesy=cmsy10 scaled
\magstep4
1543 \def\authorrm{\secrm}
1544 \def\authortt{\sectt}
1546 % Chapter (and unnumbered) fonts (17.28pt).
1547 \setfont\chaprm\rmbshape{12}{\magstep2}
1548 \setfont\chapit\itbshape{10}{\magstep3}
1549 \setfont\chapsl\slbshape{10}{\magstep3}
1550 \setfontttb\chaptt\ttbshape{12}{\magstep2}
1551 \setfontttsl\chapttsl\ttslshape{10}{\magstep3}
1552 \setfont\chapsf\sfbshape{17}{1000}
1554 \setfont\chapsc\scbshape{10}{\magstep3}
1555 \font\chapi=cmmi12 scaled
\magstep2
1556 \font\chapsy=cmsy10 scaled
\magstep3
1558 % Section fonts (14.4pt).
1559 \setfont\secrm\rmbshape{12}{\magstep1}
1560 \setfont\secit\itbshape{10}{\magstep2}
1561 \setfont\secsl\slbshape{10}{\magstep2}
1562 \setfontttb\sectt\ttbshape{12}{\magstep1}
1563 \setfontttsl\secttsl\ttslshape{10}{\magstep2}
1564 \setfont\secsf\sfbshape{12}{\magstep1}
1566 \setfont\secsc\scbshape{10}{\magstep2}
1567 \font\seci=cmmi12 scaled
\magstep1
1568 \font\secsy=cmsy10 scaled
\magstep2
1570 % Subsection fonts (13.15pt).
1571 \setfont\ssecrm\rmbshape{12}{\magstephalf}
1572 \setfont\ssecit\itbshape{10}{1315}
1573 \setfont\ssecsl\slbshape{10}{1315}
1574 \setfontttb\ssectt\ttbshape{12}{\magstephalf}
1575 \setfontttsl\ssecttsl\ttslshape{10}{1315}
1576 \setfont\ssecsf\sfbshape{12}{\magstephalf}
1578 \setfont\ssecsc\scbshape{10}{\magstep1}
1579 \font\sseci=cmmi12 scaled
\magstephalf
1580 \font\ssecsy=cmsy10 scaled
1315
1582 % Reduced fonts for @acro in text (10pt).
1583 \setfont\reducedrm\rmshape{10}{1000}
1584 \setfont\reducedtt\ttshape{10}{1000}
1585 \setfont\reducedbf\bfshape{10}{1000}
1586 \setfont\reducedit\itshape{10}{1000}
1587 \setfont\reducedsl\slshape{10}{1000}
1588 \setfont\reducedsf\sfshape{10}{1000}
1589 \setfont\reducedsc\scshape{10}{1000}
1590 \setfont\reducedttsl\ttslshape{10}{1000}
1591 \font\reducedi=cmmi10
1592 \font\reducedsy=cmsy10
1594 % In order for the font changes to affect most math symbols and letters,
1595 % we have to define the \textfont of the standard families. Since
1596 % texinfo doesn't allow for producing subscripts and superscripts except
1597 % in the main text, we don't bother to reset \scriptfont and
1598 % \scriptscriptfont (which would also require loading a lot more fonts).
1600 \def\resetmathfonts{%
1601 \textfont0=
\tenrm \textfont1=
\teni \textfont2=
\tensy
1602 \textfont\itfam=
\tenit \textfont\slfam=
\tensl \textfont\bffam=
\tenbf
1603 \textfont\ttfam=
\tentt \textfont\sffam=
\tensf
1606 % The font-changing commands redefine the meanings of \tenSTYLE, instead
1607 % of just \STYLE. We do this because \STYLE needs to also set the
1608 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
1609 % \tenSTYLE to set the current font.
1611 % Each font-changing command also sets the names \lsize (one size lower)
1612 % and \lllsize (three sizes lower). These relative commands are used in
1613 % the LaTeX logo and acronyms.
1615 % This all needs generalizing, badly.
1618 \let\tenrm=
\textrm \let\tenit=
\textit \let\tensl=
\textsl
1619 \let\tenbf=
\textbf \let\tentt=
\texttt \let\smallcaps=
\textsc
1620 \let\tensf=
\textsf \let\teni=
\texti \let\tensy=
\textsy
1621 \let\tenttsl=
\textttsl
1622 \def\lsize{reduced
}\def\lllsize{smaller
}%
1623 \resetmathfonts \setleading{\textleading}}
1625 \let\tenrm=
\titlerm \let\tenit=
\titleit \let\tensl=
\titlesl
1626 \let\tenbf=
\titlebf \let\tentt=
\titlett \let\smallcaps=
\titlesc
1627 \let\tensf=
\titlesf \let\teni=
\titlei \let\tensy=
\titlesy
1628 \let\tenttsl=
\titlettsl
1629 \def\lsize{chap
}\def\lllsize{subsec
}%
1630 \resetmathfonts \setleading{25pt
}}
1631 \def\titlefont#1{{\titlefonts\rm #1}}
1633 \let\tenrm=
\chaprm \let\tenit=
\chapit \let\tensl=
\chapsl
1634 \let\tenbf=
\chapbf \let\tentt=
\chaptt \let\smallcaps=
\chapsc
1635 \let\tensf=
\chapsf \let\teni=
\chapi \let\tensy=
\chapsy \let\tenttsl=
\chapttsl
1636 \def\lsize{sec
}\def\lllsize{text
}%
1637 \resetmathfonts \setleading{19pt
}}
1639 \let\tenrm=
\secrm \let\tenit=
\secit \let\tensl=
\secsl
1640 \let\tenbf=
\secbf \let\tentt=
\sectt \let\smallcaps=
\secsc
1641 \let\tensf=
\secsf \let\teni=
\seci \let\tensy=
\secsy
1642 \let\tenttsl=
\secttsl
1643 \def\lsize{subsec
}\def\lllsize{reduced
}%
1644 \resetmathfonts \setleading{16pt
}}
1646 \let\tenrm=
\ssecrm \let\tenit=
\ssecit \let\tensl=
\ssecsl
1647 \let\tenbf=
\ssecbf \let\tentt=
\ssectt \let\smallcaps=
\ssecsc
1648 \let\tensf=
\ssecsf \let\teni=
\sseci \let\tensy=
\ssecsy
1649 \let\tenttsl=
\ssecttsl
1650 \def\lsize{text
}\def\lllsize{small
}%
1651 \resetmathfonts \setleading{15pt
}}
1652 \let\subsubsecfonts =
\subsecfonts
1654 \let\tenrm=
\reducedrm \let\tenit=
\reducedit \let\tensl=
\reducedsl
1655 \let\tenbf=
\reducedbf \let\tentt=
\reducedtt \let\reducedcaps=
\reducedsc
1656 \let\tensf=
\reducedsf \let\teni=
\reducedi \let\tensy=
\reducedsy
1657 \let\tenttsl=
\reducedttsl
1658 \def\lsize{small
}\def\lllsize{smaller
}%
1659 \resetmathfonts \setleading{10.5pt
}}
1661 \let\tenrm=
\smallrm \let\tenit=
\smallit \let\tensl=
\smallsl
1662 \let\tenbf=
\smallbf \let\tentt=
\smalltt \let\smallcaps=
\smallsc
1663 \let\tensf=
\smallsf \let\teni=
\smalli \let\tensy=
\smallsy
1664 \let\tenttsl=
\smallttsl
1665 \def\lsize{smaller
}\def\lllsize{smaller
}%
1666 \resetmathfonts \setleading{10.5pt
}}
1668 \let\tenrm=
\smallerrm \let\tenit=
\smallerit \let\tensl=
\smallersl
1669 \let\tenbf=
\smallerbf \let\tentt=
\smallertt \let\smallcaps=
\smallersc
1670 \let\tensf=
\smallersf \let\teni=
\smalleri \let\tensy=
\smallersy
1671 \let\tenttsl=
\smallerttsl
1672 \def\lsize{smaller
}\def\lllsize{smaller
}%
1673 \resetmathfonts \setleading{9.5pt
}}
1675 % Set the fonts to use with the @small... environments.
1676 \let\smallexamplefonts =
\smallfonts
1678 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
1679 % can fit this many characters:
1680 % 8.5x11=86 smallbook=72 a4=90 a5=69
1681 % If we use \scriptfonts (8pt), then we can fit this many characters:
1682 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
1683 % For me, subjectively, the few extra characters that fit aren't worth
1684 % the additional smallness of 8pt. So I'm making the default 9pt.
1686 % By the way, for comparison, here's what fits with @example (10pt):
1687 % 8.5x11=71 smallbook=60 a4=75 a5=58
1689 % I wish the USA used A4 paper.
1693 % Set up the default fonts, so we can use them for creating boxes.
1697 % Define these so they can be easily changed for other fonts.
1698 \def\angleleft{$
\langle$
}
1699 \def\angleright{$
\rangle$
}
1701 % Count depth in font-changes, for error checks
1702 \newcount\fontdepth \fontdepth=
0
1704 % Fonts for short table of contents.
1705 \setfont\shortcontrm\rmshape{12}{1000}
1706 \setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12
1707 \setfont\shortcontsl\slshape{12}{1000}
1708 \setfonttt\shortconttt\ttshape{12}{1000}
1710 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
1711 %% serif) and @ii for TeX italic
1713 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
1714 % unless the following character is such as not to need one.
1715 \def\smartitalicx{\ifx\next,
\else\ifx\next-
\else\ifx\next.
\else
1716 \ptexslash\fi\fi\fi}
1717 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
1718 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
1720 % like \smartslanted except unconditionally uses \ttsl.
1721 % @var is set to this for defun arguments.
1722 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
1724 % like \smartslanted except unconditionally use \sl. We never want
1725 % ttsl for book titles, do we?
1726 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
1729 \let\var=
\smartslanted
1730 \let\dfn=
\smartslanted
1731 \let\emph=
\smartitalic
1733 \def\b#1{{\smallttb #1}}
1736 % We can't just use \exhyphenpenalty, because that only has effect at
1737 % the end of a paragraph. Restore normal hyphenation at the end of the
1738 % group within which \nohyphenation is presumably called.
1740 \def\nohyphenation{\hyphenchar\font = -
1 \aftergroup\restorehyphenation}
1741 \def\restorehyphenation{\hyphenchar\font = `-
}
1743 % Set sfcode to normal for the chars that usually have another value.
1744 % Can't use plain's \frenchspacing because it uses the `\x notation, and
1745 % sometimes \x has an active definition that messes things up.
1748 \def\frenchspacing{%
1749 \sfcode\dotChar =\@m
\sfcode\questChar=\@m
\sfcode\exclamChar=\@m
1750 \sfcode\colonChar=\@m
\sfcode\semiChar =\@m
\sfcode\commaChar =\@m
1755 {\tt \rawbackslash \frenchspacing #1}%
1758 \def\samp#1{`
\tclose{#1}'
\null}
1759 \setfont\keyrm\rmshape{8}{1000}
1761 \def\key#1{{\keyrm\textfont2=
\keysy \leavevmode\hbox{%
1762 \raise0.4pt
\hbox{\angleleft}\kern-
.08em
\vtop{%
1763 \vbox{\hrule\kern-
0.4pt
1764 \hbox{\raise0.4pt
\hbox{\vphantom{\angleleft}}#1}}%
1766 \kern-
.06em
\raise0.4pt
\hbox{\angleright}}}}
1767 % The old definition, with no lozenge:
1768 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
1769 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
1771 % @file, @option are the same as @samp.
1775 % @code is a modification of @t,
1776 % which makes spaces the same size as normal in the surrounding text.
1779 % Change normal interword space to be same as for the current font.
1780 \spaceskip =
\fontdimen2\font
1782 % Switch to typewriter.
1785 % But `\ ' produces the large typewriter interword space.
1786 \def\
{{\spaceskip =
0pt
{} }}%
1788 % Turn off hyphenation.
1798 % We *must* turn on hyphenation at `-' and `_' in @code.
1799 % Otherwise, it is too hard to avoid overfull hboxes
1800 % in the Emacs manual, the Library manual, etc.
1802 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
1803 % both hyphenation at - and hyphenation within words.
1804 % We must therefore turn them both off (\tclose does that)
1805 % and arrange explicitly to hyphenate at a dash.
1811 \global\def\code{\begingroup
1812 \catcode`\-=
\active \let-
\codedash
1813 \catcode`
\_=
\active \let_\codeunder
1819 \def\codedash{-
\discretionary{}{}{}}
1821 % this is all so @math{@code{var_name}+1} can work. In math mode, _
1822 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
1823 % will therefore expand the active definition of _, which is us
1824 % (inside @code that is), therefore an endless loop.
1826 \mathchar"
075F
% class 0=ordinary, family 7=ttfam, pos 0x5F=_.
1827 \else\normalunderscore \fi
1828 \discretionary{}{}{}}%
1831 \def\codex #1{\tclose{#1}\endgroup}
1833 % @kbd is like @code, except that if the argument is just one @key command,
1834 % then @kbd has no effect.
1836 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
1837 % `example' (@kbd uses ttsl only inside of @example and friends),
1838 % or `code' (@kbd uses normal tty font always).
1839 \parseargdef\kbdinputstyle{%
1841 \ifx\arg\worddistinct
1842 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
1843 \else\ifx\arg\wordexample
1844 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
1845 \else\ifx\arg\wordcode
1846 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
1848 \errhelp =
\EMsimple
1849 \errmessage{Unknown @kbdinputstyle option `
\arg'
}%
1852 \def\worddistinct{distinct
}
1853 \def\wordexample{example
}
1856 % Default is `distinct.'
1857 \kbdinputstyle distinct
1860 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??
}%
1861 \ifx\one\xkey\ifx\threex\three \key{#2}%
1862 \else{\tclose{\kbdfont\look}}\fi
1863 \else{\tclose{\kbdfont\look}}\fi}
1865 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
1866 \let\indicateurl=
\code
1870 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
1871 % second argument specifying the text to display and an optional third
1872 % arg as text to display instead of (rather than in addition to) the url
1873 % itself. First (mandatory) arg is the url. Perhaps eventually put in
1874 % a hypertex \special here.
1876 \def\uref#1{\douref #1,,,
\finish}
1877 \def\douref#1,
#2,
#3,
#4\finish{\begingroup
1880 \setbox0 =
\hbox{\ignorespaces #3}%
1882 \unhbox0 % third arg given, show only that
1884 \setbox0 =
\hbox{\ignorespaces #2}%
1887 \unhbox0 % PDF: 2nd arg given, show only it
1889 \unhbox0\ (
\code{#1})
% DVI: 2nd arg given, show both it and url
1892 \code{#1}% only url given, so show it
1898 % @url synonym for @uref, since that's how everyone uses it.
1902 % rms does not like angle brackets --karl, 17may97.
1903 % So now @email is just like @uref, unless we are pdf.
1905 %\def\email#1{\angleleft{\tt #1}\angleright}
1907 \def\email#1{\doemail#1,,
\finish}
1908 \def\doemail#1,
#2,
#3\finish{\begingroup
1911 \setbox0 =
\hbox{\ignorespaces #2}%
1912 \ifdim\wd0>
0pt
\unhbox0\else\code{#1}\fi
1919 % Check if we are currently using a typewriter font. Since all the
1920 % Computer Modern typewriter fonts have zero interword stretch (and
1921 % shrink), and it is reasonable to expect all typewriter fonts to have
1922 % this property, we can check that font parameter.
1924 \def\ifmonospace{\ifdim\fontdimen3\font=
0pt
}
1926 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
1927 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
1929 \def\dmn#1{\thinspace #1}
1931 \def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??
\par}
1933 % @l was never documented to mean ``switch to the Lisp font'',
1934 % and it is not used as such in any manual I can find. We need it for
1935 % Polish suppressed-l. --karl, 22sep96.
1936 %\def\l#1{{\li #1}\null}
1938 % Explicit font changes: @r, @sc, undocumented @ii.
1939 \def\r#1{{\rm #1}} % roman font
1940 \def\sc#1{{\smallcaps#1}} % smallcaps font
1941 \def\ii#1{{\it #1}} % italic font
1943 \def\acronym#1{\doacronym #1,,
\finish}
1944 \def\doacronym#1,
#2,
#3\finish{%
1945 {\selectfonts\lsize #1}%
1947 \ifx\temp\empty \else
1948 \space (
{\unsepspaces \ignorespaces \temp \unskip})
%
1952 % @pounds{} is a sterling sign, which is in the CM italic font.
1954 \def\pounds{{\it\$
}}
1956 % @registeredsymbol - R in a circle. The font for the R should really
1957 % be smaller yet, but lllsize is the best we can do for now.
1958 % Adapted from the plain.tex definition of \copyright.
1960 \def\registeredsymbol{%
1961 $^
{{\ooalign{\hfil\raise.07ex
\hbox{\selectfonts\lllsize R
}%
1967 \message{page headings,
}
1969 \newskip\titlepagetopglue \titlepagetopglue =
1.5in
1970 \newskip\titlepagebottomglue \titlepagebottomglue =
2pc
1972 % First the title page. Must do @settitle before @titlepage.
1974 \newif\iffinishedtitlepage
1976 % Do an implicit @contents or @shortcontents after @end titlepage if the
1977 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
1979 \newif\ifsetcontentsaftertitlepage
1980 \let\setcontentsaftertitlepage =
\setcontentsaftertitlepagetrue
1981 \newif\ifsetshortcontentsaftertitlepage
1982 \let\setshortcontentsaftertitlepage =
\setshortcontentsaftertitlepagetrue
1984 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in
\chaprm \centerline{#1}%
1985 \endgroup\page\hbox{}\page}
1988 % Open one extra group, as we want to close it in the middle of \Etitlepage.
1990 \parindent=
0pt
\textfonts
1991 % Leave some space at the very top of the page.
1992 \vglue\titlepagetopglue
1993 % No rule at page bottom unless we print one at the top with @title.
1994 \finishedtitlepagetrue
1996 % Most title ``pages'' are actually two pages long, with space
1997 % at the top of the second. We don't want the ragged left on the second.
1998 \let\oldpage =
\page
2000 \iffinishedtitlepage\else
2003 \let\page =
\oldpage
2010 \iffinishedtitlepage\else
2013 % It is important to do the page break before ending the group,
2014 % because the headline and footline are only empty inside the group.
2015 % If we use the new definition of \page, we always get a blank page
2016 % after the title page, which we certainly don't want.
2020 % Need this before the \...aftertitlepage checks so that if they are
2021 % in effect the toc pages will come out with page numbers.
2024 % If they want short, they certainly want long too.
2025 \ifsetshortcontentsaftertitlepage
2028 \global\let\shortcontents =
\relax
2029 \global\let\contents =
\relax
2032 \ifsetcontentsaftertitlepage
2034 \global\let\contents =
\relax
2035 \global\let\shortcontents =
\relax
2039 \def\finishtitlepage{%
2040 \vskip4pt \hrule height
2pt width
\hsize
2041 \vskip\titlepagebottomglue
2042 \finishedtitlepagetrue
2045 %%% Macros to be used within @titlepage:
2047 \let\subtitlerm=
\tenrm
2048 \def\subtitlefont{\subtitlerm \normalbaselineskip =
13pt
\normalbaselines}
2050 \def\authorfont{\authorrm \normalbaselineskip =
16pt
\normalbaselines
2053 \parseargdef\title{%
2055 \leftline{\titlefonts\rm #1}
2056 % print a rule at the page bottom also.
2057 \finishedtitlepagefalse
2058 \vskip4pt \hrule height
4pt width
\hsize \vskip4pt
2061 \parseargdef\subtitle{%
2063 {\subtitlefont \rightline{#1}}%
2066 % @author should come last, but may come many times.
2067 % It can also be used inside @quotation.
2069 \parseargdef\author{%
2070 \def\temp{\quotation}%
2072 \def\quotationauthor{#1}% printed in \Equotation.
2075 \ifseenauthor\else \vskip 0pt plus
1filll
\seenauthortrue \fi
2076 {\authorfont \leftline{#1}}%
2081 %%% Set up page headings and footings.
2083 \let\thispage=
\folio
2085 \newtoks\evenheadline % headline on even pages
2086 \newtoks\oddheadline % headline on odd pages
2087 \newtoks\evenfootline % footline on even pages
2088 \newtoks\oddfootline % footline on odd pages
2090 % Now make TeX use those variables
2091 \headline=
{{\textfonts\rm \ifodd\pageno \the\oddheadline
2092 \else \the\evenheadline \fi}}
2093 \footline=
{{\textfonts\rm \ifodd\pageno \the\oddfootline
2094 \else \the\evenfootline \fi}\HEADINGShook}
2095 \let\HEADINGShook=
\relax
2097 % Commands to set those variables.
2098 % For example, this is what @headings on does
2099 % @evenheading @thistitle|@thispage|@thischapter
2100 % @oddheading @thischapter|@thispage|@thistitle
2101 % @evenfooting @thisfile||
2102 % @oddfooting ||@thisfile
2105 \def\evenheading{\parsearg\evenheadingxxx}
2106 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|
\finish}
2107 \def\evenheadingyyy #1\|
#2\|
#3\|
#4\finish{%
2108 \global\evenheadline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2110 \def\oddheading{\parsearg\oddheadingxxx}
2111 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|
\finish}
2112 \def\oddheadingyyy #1\|
#2\|
#3\|
#4\finish{%
2113 \global\oddheadline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2115 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2117 \def\evenfooting{\parsearg\evenfootingxxx}
2118 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|
\finish}
2119 \def\evenfootingyyy #1\|
#2\|
#3\|
#4\finish{%
2120 \global\evenfootline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2122 \def\oddfooting{\parsearg\oddfootingxxx}
2123 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|
\finish}
2124 \def\oddfootingyyy #1\|
#2\|
#3\|
#4\finish{%
2125 \global\oddfootline =
{\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2127 % Leave some space for the footline. Hopefully ok to assume
2128 % @evenfooting will not be used by itself.
2129 \global\advance\pageheight by -
\baselineskip
2130 \global\advance\vsize by -
\baselineskip
2133 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2136 % @headings double turns headings on for double-sided printing.
2137 % @headings single turns headings on for single-sided printing.
2138 % @headings off turns them off.
2139 % @headings on same as @headings double, retained for compatibility.
2140 % @headings after turns on double-sided headings after this page.
2141 % @headings doubleafter turns on double-sided headings after this page.
2142 % @headings singleafter turns on single-sided headings after this page.
2143 % By default, they are off at the start of a document,
2144 % and turned `on' after @end titlepage.
2146 \def\headings #1 {\csname HEADINGS
#1\endcsname}
2149 \global\evenheadline=
{\hfil} \global\evenfootline=
{\hfil}
2150 \global\oddheadline=
{\hfil} \global\oddfootline=
{\hfil}}
2152 % When we turn headings on, set the page number to 1.
2153 % For double-sided printing, put current file name in lower left corner,
2154 % chapter name on inside top of right hand pages, document
2155 % title on inside top of left hand pages, and page numbers on outside top
2156 % edge of all pages.
2157 \def\HEADINGSdouble{%
2159 \global\evenfootline=
{\hfil}
2160 \global\oddfootline=
{\hfil}
2161 \global\evenheadline=
{\line{\folio\hfil\thistitle}}
2162 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
2163 \global\let\contentsalignmacro =
\chapoddpage
2165 \let\contentsalignmacro =
\chappager
2167 % For single-sided printing, chapter title goes across top left of page,
2168 % page number on top right.
2169 \def\HEADINGSsingle{%
2171 \global\evenfootline=
{\hfil}
2172 \global\oddfootline=
{\hfil}
2173 \global\evenheadline=
{\line{\thischapter\hfil\folio}}
2174 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
2175 \global\let\contentsalignmacro =
\chappager
2177 \def\HEADINGSon{\HEADINGSdouble}
2179 \def\HEADINGSafter{\let\HEADINGShook=
\HEADINGSdoublex}
2180 \let\HEADINGSdoubleafter=
\HEADINGSafter
2181 \def\HEADINGSdoublex{%
2182 \global\evenfootline=
{\hfil}
2183 \global\oddfootline=
{\hfil}
2184 \global\evenheadline=
{\line{\folio\hfil\thistitle}}
2185 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
2186 \global\let\contentsalignmacro =
\chapoddpage
2189 \def\HEADINGSsingleafter{\let\HEADINGShook=
\HEADINGSsinglex}
2190 \def\HEADINGSsinglex{%
2191 \global\evenfootline=
{\hfil}
2192 \global\oddfootline=
{\hfil}
2193 \global\evenheadline=
{\line{\thischapter\hfil\folio}}
2194 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
2195 \global\let\contentsalignmacro =
\chappager
2198 % Subroutines used in generating headings
2199 % This produces Day Month Year style of output.
2200 % Only define if not already defined, in case a txi-??.tex file has set
2201 % up a different format (e.g., txi-cs.tex does this).
2202 \ifx\today\undefined
2206 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
2207 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
2208 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
2213 % @settitle line... specifies the title of the document, for headings.
2214 % It generates no output of its own.
2215 \def\thistitle{\putwordNoTitle}
2216 \def\settitle{\parsearg{\gdef\thistitle}}
2220 % Tables -- @table, @ftable, @vtable, @item(x).
2222 % default indentation of table text
2223 \newdimen\tableindent \tableindent=
.8in
2224 % default indentation of @itemize and @enumerate text
2225 \newdimen\itemindent \itemindent=
.3in
2226 % margin between end of table item and start of table text.
2227 \newdimen\itemmargin \itemmargin=
.1in
2229 % used internally for \itemindent minus \itemmargin
2232 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
2234 % They also define \itemindex
2235 % to index the item name in whatever manner is desired (perhaps none).
2237 \newif\ifitemxneedsnegativevskip
2239 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-
\parskip\nobreak\fi}
2241 \def\internalBitem{\smallbreak \parsearg\itemzzz}
2242 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
2244 \def\itemzzz #1{\begingroup %
2245 \advance\hsize by -
\rightskip
2246 \advance\hsize by -
\tableindent
2247 \setbox0=
\hbox{\itemindicate{#1}}%
2249 \nobreak % This prevents a break before @itemx.
2251 % If the item text does not fit in the space we have, put it on a line
2252 % by itself, and do not allow a page break either before or after that
2253 % line. We do not start a paragraph here because then if the next
2254 % command is, e.g., @kindex, the whatsit would get put into the
2255 % horizontal list on a line by itself, resulting in extra blank space.
2256 \ifdim \wd0>
\itemmax
2258 % Make this a paragraph so we get the \parskip glue and wrapping,
2259 % but leave it ragged-right.
2261 \advance\leftskip by-
\tableindent
2262 \advance\hsize by
\tableindent
2263 \advance\rightskip by0pt plus1fil
2264 \leavevmode\unhbox0\par
2267 % We're going to be starting a paragraph, but we don't want the
2268 % \parskip glue -- logically it's part of the @item we just started.
2269 \nobreak \vskip-
\parskip
2271 % Stop a page break at the \parskip glue coming up. (Unfortunately
2272 % we can't prevent a possible page break at the following
2273 % \baselineskip glue.) However, if what follows is an environment
2274 % such as @example, there will be no \parskip glue; then
2275 % the negative vskip we just would cause the example and the item to
2276 % crash together. So we use this bizarre value of 10001 as a signal
2277 % to \aboveenvbreak to insert \parskip glue after all.
2278 % (Possibly there are other commands that could be followed by
2279 % @example which need the same treatment, but not section titles; or
2280 % maybe section titles are the only special case and they should be
2284 \itemxneedsnegativevskipfalse
2286 % The item text fits into the space. Start a paragraph, so that the
2287 % following text (if any) will end up on the same line.
2289 % Do this with kerns and \unhbox so that if there is a footnote in
2290 % the item text, it can migrate to the main vertical list and
2291 % eventually be printed.
2292 \nobreak\kern-
\tableindent
2293 \dimen0 =
\itemmax \advance\dimen0 by
\itemmargin \advance\dimen0 by -
\wd0
2295 \nobreak\kern\dimen0
2297 \itemxneedsnegativevskiptrue
2301 \def\item{\errmessage{@item while not in a list environment
}}
2302 \def\itemx{\errmessage{@itemx while not in a list environment
}}
2304 % @table, @ftable, @vtable.
2306 \let\itemindex\gobble
2310 \def\itemindex #
#1{\doind {fn
}{\code{#
#1}}}%
2314 \def\itemindex #
#1{\doind {vr
}{\code{#
#1}}}%
2318 \def\itemindicate{#1}%
2323 \makevalueexpandable
2324 \edef\temp{\noexpand\tablez #1\space\space\space}%
2328 \def\tablez #1 #2 #3 #4\endtablez{%
2330 \ifnum 0#1>
0 \advance \leftskip by
#1\mil \fi
2331 \ifnum 0#2>
0 \tableindent=
#2\mil \fi
2332 \ifnum 0#3>
0 \advance \rightskip by
#3\mil \fi
2333 \itemmax=
\tableindent
2334 \advance \itemmax by -
\itemmargin
2335 \advance \leftskip by
\tableindent
2336 \exdentamount=
\tableindent
2338 \parskip =
\smallskipamount
2339 \ifdim \parskip=
0pt
\parskip=
2pt
\fi
2340 \let\item =
\internalBitem
2341 \let\itemx =
\internalBitemx
2343 \def\Etable{\endgraf\afterenvbreak}
2346 \let\Eitemize\Etable
2347 \let\Eenumerate\Etable
2349 % This is the counter used by @enumerate, which is really @itemize
2353 \envdef\itemize{\parsearg\doitemize}
2357 \itemmax=
\itemindent
2358 \advance\itemmax by -
\itemmargin
2359 \advance\leftskip by
\itemindent
2360 \exdentamount=
\itemindent
2362 \parskip=
\smallskipamount
2363 \ifdim\parskip=
0pt
\parskip=
2pt
\fi
2364 \def\itemcontents{#1}%
2365 % @itemize with no arg is equivalent to @itemize @bullet.
2366 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
2367 \let\item=
\itemizeitem
2370 % Definition of @item while inside @itemize and @enumerate.
2373 \advance\itemno by
1 % for enumerations
2374 {\let\par=
\endgraf \smallbreak}% reasonable place to break
2376 % If the document has an @itemize directly after a section title, a
2377 % \nobreak will be last on the list, and \sectionheading will have
2378 % done a \vskip-\parskip. In that case, we don't want to zero
2379 % parskip, or the item text will crash with the heading. On the
2380 % other hand, when there is normal text preceding the item (as there
2381 % usually is), we do want to zero parskip, or there would be too much
2382 % space. In that case, we won't have a \nobreak before. At least
2383 % that's the theory.
2384 \ifnum\lastpenalty<
10000 \parskip=
0in
\fi
2386 \hbox to
0pt
{\hss \itemcontents \kern\itemmargin}%
2387 \vadjust{\penalty 1200}}% not good to break after first line of item.
2391 % \splitoff TOKENS\endmark defines \first to be the first token in
2392 % TOKENS, and \rest to be the remainder.
2394 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
2396 % Allow an optional argument of an uppercase letter, lowercase letter,
2397 % or number, to specify the first label in the enumerated list. No
2398 % argument is the same as `1'.
2400 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
2401 \def\enumeratey #1 #2\endenumeratey{%
2402 % If we were given no argument, pretend we were given `1'.
2404 \ifx\thearg\empty \def\thearg{1}\fi
2406 % Detect if the argument is a single token. If so, it might be a
2407 % letter. Otherwise, the only valid thing it can be is a number.
2408 % (We will always have one token, because of the test we just made.
2409 % This is a good thing, since \splitoff doesn't work given nothing at
2410 % all -- the first parameter is undelimited.)
2411 \expandafter\splitoff\thearg\endmark
2413 % Only one token in the argument. It could still be anything.
2414 % A ``lowercase letter'' is one whose \lccode is nonzero.
2415 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
2416 % not equal to itself.
2417 % Otherwise, we assume it's a number.
2419 % We need the \relax at the end of the \ifnum lines to stop TeX from
2420 % continuing to look for a <number>.
2422 \ifnum\lccode\expandafter`
\thearg=
0\relax
2423 \numericenumerate % a number (we hope)
2426 \ifnum\lccode\expandafter`
\thearg=
\expandafter`
\thearg\relax
2427 \lowercaseenumerate % lowercase letter
2429 \uppercaseenumerate % uppercase letter
2433 % Multiple tokens in the argument. We hope it's a number.
2438 % An @enumerate whose labels are integers. The starting integer is
2441 \def\numericenumerate{%
2443 \startenumeration{\the\itemno}%
2446 % The starting (lowercase) letter is in \thearg.
2447 \def\lowercaseenumerate{%
2448 \itemno =
\expandafter`
\thearg
2450 % Be sure we're not beyond the end of the alphabet.
2452 \errmessage{No more lowercase letters in @enumerate; get a bigger
2459 % The starting (uppercase) letter is in \thearg.
2460 \def\uppercaseenumerate{%
2461 \itemno =
\expandafter`
\thearg
2463 % Be sure we're not beyond the end of the alphabet.
2465 \errmessage{No more uppercase letters in @enumerate; get a bigger
2472 % Call \doitemize, adding a period to the first argument and supplying the
2473 % common last two arguments. Also subtract one from the initial value in
2474 % \itemno, since @item increments \itemno.
2476 \def\startenumeration#1{%
2477 \advance\itemno by -
1
2478 \doitemize{#1.
}\flushcr
2481 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
2484 \def\alphaenumerate{\enumerate{a
}}
2485 \def\capsenumerate{\enumerate{A
}}
2486 \def\Ealphaenumerate{\Eenumerate}
2487 \def\Ecapsenumerate{\Eenumerate}
2490 % @multitable macros
2491 % Amy Hendrickson, 8/18/94, 3/6/96
2493 % @multitable ... @end multitable will make as many columns as desired.
2494 % Contents of each column will wrap at width given in preamble. Width
2495 % can be specified either with sample text given in a template line,
2496 % or in percent of \hsize, the current width of text on page.
2498 % Table can continue over pages but will only break between lines.
2502 % Either define widths of columns in terms of percent of \hsize:
2503 % @multitable @columnfractions .25 .3 .45
2506 % Numbers following @columnfractions are the percent of the total
2507 % current hsize to be used for each column. You may use as many
2508 % columns as desired.
2511 % Or use a template:
2512 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2514 % using the widest term desired in each column.
2516 % Each new table line starts with @item, each subsequent new column
2517 % starts with @tab. Empty columns may be produced by supplying @tab's
2518 % with nothing between them for as many times as empty columns are needed,
2519 % ie, @tab@tab@tab will produce two empty columns.
2521 % @item, @tab do not need to be on their own lines, but it will not hurt
2524 % Sample multitable:
2526 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
2527 % @item first col stuff @tab second col stuff @tab third col
2534 % @item first col stuff @tab second col stuff
2535 % @tab Many paragraphs of text may be used in any column.
2537 % They will wrap at the width determined by the template.
2538 % @item@tab@tab This will be in third column.
2541 % Default dimensions may be reset by user.
2542 % @multitableparskip is vertical space between paragraphs in table.
2543 % @multitableparindent is paragraph indent in table.
2544 % @multitablecolmargin is horizontal space to be left between columns.
2545 % @multitablelinespace is space to leave between table items, baseline
2547 % 0pt means it depends on current normal line spacing.
2549 \newskip\multitableparskip
2550 \newskip\multitableparindent
2551 \newdimen\multitablecolspace
2552 \newskip\multitablelinespace
2553 \multitableparskip=
0pt
2554 \multitableparindent=
6pt
2555 \multitablecolspace=
12pt
2556 \multitablelinespace=
0pt
2558 % Macros used to set up halign preamble:
2560 \let\endsetuptable\relax
2561 \def\xendsetuptable{\endsetuptable}
2562 \let\columnfractions\relax
2563 \def\xcolumnfractions{\columnfractions}
2566 % #1 is the @columnfraction, usually a decimal number like .5, but might
2567 % be just 1. We just use it, whatever it is.
2569 \def\pickupwholefraction#1 {%
2570 \global\advance\colcount by
1
2571 \expandafter\xdef\csname col
\the\colcount\endcsname{#1\hsize}%
2578 \ifx\firstarg\xendsetuptable
2581 \ifx\firstarg\xcolumnfractions
2582 \global\setpercenttrue
2585 \let\go\pickupwholefraction
2587 \global\advance\colcount by
1
2588 \setbox0=
\hbox{#1\unskip\space}% Add a normal word space as a
2589 % separator; typically that is always in the input, anyway.
2590 \expandafter\xdef\csname col
\the\colcount\endcsname{\the\wd0}%
2593 \ifx\go\pickupwholefraction
2594 % Put the argument back for the \pickupwholefraction call, so
2595 % we'll always have a period there to be parsed.
2596 \def\go{\pickupwholefraction#1}%
2598 \let\go =
\setuptable
2604 % multitable-only commands.
2606 % @headitem starts a heading row, which we typeset in bold.
2607 % Assignments have to be global since we are inside the implicit group
2608 % of an alignment entry. Note that \everycr resets \everytab.
2609 \def\headitem{\checkenv\multitable \crcr \global\everytab=
{\bf}\the\everytab}%
2611 % A \tab used to include \hskip1sp. But then the space in a template
2612 % line is not enough. That is bad. So let's go back to just `&' until
2613 % we encounter the problem it was intended to solve again.
2614 % --karl, nathan@acm.org, 20apr99.
2615 \def\tab{\checkenv\multitable &
\the\everytab}%
2617 % @multitable ... @end multitable definitions:
2619 \newtoks\everytab % insert after every tab.
2621 \envdef\multitable{%
2625 % @item within a multitable starts a normal row.
2630 \setmultitablespacing
2631 \parskip=
\multitableparskip
2632 \parindent=
\multitableparindent
2638 \global\everytab=
{}%
2639 \global\colcount=
0 % Reset the column counter.
2640 % Check for saved footnotes, etc.
2642 % Keeps underfull box messages off when table breaks over pages.
2644 % Maybe so, but it also creates really weird page breaks when the
2645 % table breaks over pages. Wouldn't \vfil be better? Wait until the
2646 % problem manifests itself, so it can be fixed for real --karl.
2650 \parsearg\domultitable
2652 \def\domultitable#1{%
2653 % To parse everything between @multitable and @item:
2654 \setuptable#1 \endsetuptable
2656 % This preamble sets up a generic column definition, which will
2657 % be used as many times as user calls for columns.
2658 % \vtop will set a single line and will also let text wrap and
2659 % continue for many paragraphs if desired.
2661 \global\advance\colcount by
1
2664 % Use the current \colcount to find the correct column width:
2665 \hsize=
\expandafter\csname col
\the\colcount\endcsname
2667 % In order to keep entries from bumping into each other
2668 % we will add a \leftskip of \multitablecolspace to all columns after
2671 % If a template has been used, we will add \multitablecolspace
2672 % to the width of each template entry.
2674 % If the user has set preamble in terms of percent of \hsize we will
2675 % use that dimension as the width of the column, and the \leftskip
2676 % will keep entries from bumping into each other. Table will start at
2677 % left margin and final column will justify at right margin.
2679 % Make sure we don't inherit \rightskip from the outer environment.
2682 % The first column will be indented with the surrounding text.
2683 \advance\hsize by
\leftskip
2686 % If user has not set preamble in terms of percent of \hsize
2687 % we will advance \hsize by \multitablecolspace.
2688 \advance\hsize by
\multitablecolspace
2690 % In either case we will make \leftskip=\multitablecolspace:
2691 \leftskip=
\multitablecolspace
2693 % Ignoring space at the beginning and end avoids an occasional spurious
2694 % blank line, when TeX decides to break the line at the space before the
2695 % box from the multistrut, so the strut ends up on a line by itself.
2697 % @multitable @columnfractions .11 .89
2699 % @tab Legal holiday which is valid in major parts of the whole country.
2700 % Is automatically provided with highlighting sequences respectively
2701 % marking characters.
2702 \noindent\ignorespaces##
\unskip\multistrut
2707 \egroup % end the \halign
2708 \global\setpercentfalse
2711 \def\setmultitablespacing{% test to see if user has set \multitablelinespace.
2712 % If so, do nothing. If not, give it an appropriate dimension based on
2713 % current baselineskip.
2714 \ifdim\multitablelinespace=
0pt
2715 \setbox0=
\vbox{X
}\global\multitablelinespace=
\the\baselineskip
2716 \global\advance\multitablelinespace by-
\ht0
2717 %% strut to put in table in case some entry doesn't have descenders,
2718 %% to keep lines equally spaced
2719 \let\multistrut =
\strut
2721 %% FIXME: what is \box0 supposed to be?
2722 \gdef\multistrut{\vrule height
\multitablelinespace depth
\dp0
2724 %% Test to see if parskip is larger than space between lines of
2725 %% table. If not, do nothing.
2726 %% If so, set to same dimension as multitablelinespace.
2727 \ifdim\multitableparskip>
\multitablelinespace
2728 \global\multitableparskip=
\multitablelinespace
2729 \global\advance\multitableparskip-
7pt
%% to keep parskip somewhat smaller
2730 %% than skip between lines in the table.
2732 \ifdim\multitableparskip=
0pt
2733 \global\multitableparskip=
\multitablelinespace
2734 \global\advance\multitableparskip-
7pt
%% to keep parskip somewhat smaller
2735 %% than skip between lines in the table.
2739 \message{conditionals,
}
2741 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
2742 % @ifnotxml always succeed. They currently do nothing; we don't
2743 % attempt to check whether the conditionals are properly nested. But we
2744 % have to remember that they are conditionals, so that @end doesn't
2745 % attempt to close an environment group.
2748 \expandafter\let\csname #1\endcsname =
\relax
2749 \expandafter\let\csname iscond.
#1\endcsname =
1
2752 \makecond{ifnotdocbook
}
2753 \makecond{ifnothtml
}
2754 \makecond{ifnotinfo
}
2755 \makecond{ifnotplaintext
}
2758 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
2760 \def\direntry{\doignore{direntry
}}
2761 \def\documentdescription{\doignore{documentdescription
}}
2762 \def\docbook{\doignore{docbook
}}
2763 \def\html{\doignore{html
}}
2764 \def\ifdocbook{\doignore{ifdocbook
}}
2765 \def\ifhtml{\doignore{ifhtml
}}
2766 \def\ifinfo{\doignore{ifinfo
}}
2767 \def\ifnottex{\doignore{ifnottex
}}
2768 \def\ifplaintext{\doignore{ifplaintext
}}
2769 \def\ifxml{\doignore{ifxml
}}
2770 \def\ignore{\doignore{ignore
}}
2771 \def\menu{\doignore{menu
}}
2772 \def\xml{\doignore{xml
}}
2774 % Ignore text until a line `@end #1', keeping track of nested conditionals.
2776 % A count to remember the depth of nesting.
2777 \newcount\doignorecount
2779 \def\doignore#1{\begingroup
2780 % Scan in ``verbatim'' mode:
2781 \catcode`\@ =
\other
2782 \catcode`\
{ =
\other
2783 \catcode`\
} =
\other
2785 % Make sure that spaces turn into tokens that match what \doignoretext wants.
2788 % Count number of #1's that we've seen.
2791 % Swallow text until we reach the matching `@end #1'.
2795 { \catcode`_=
11 % We want to use \_STOP_ which cannot appear in texinfo source.
2798 \gdef\dodoignore#1{%
2799 % #1 contains the string `ifinfo'.
2801 % Define a command to find the next `@end #1', which must be on a line
2803 \long\def\doignoretext#
#1^^M@end
#1{\doignoretextyyy#
#1^^M@
#1\_STOP_}%
2804 % And this command to find another #1 command, at the beginning of a
2805 % line. (Otherwise, we would consider a line `@c @ifset', for
2806 % example, to count as an @ifset for nesting.)
2807 \long\def\doignoretextyyy#
#1^^M@
#1#
#2\_STOP_{\doignoreyyy{#
#2}\_STOP_}%
2809 % And now expand that command.
2815 \def\doignoreyyy#1{%
2817 \ifx\temp\empty % Nothing found.
2818 \let\next\doignoretextzzz
2819 \else % Found a nested condition, ...
2820 \advance\doignorecount by
1
2821 \let\next\doignoretextyyy % ..., look for another.
2822 % If we're here, #1 ends with ^^M\ifinfo (for example).
2824 \next #1% the token \_STOP_ is present just after this macro.
2827 % We have to swallow the remaining "\_STOP_".
2829 \def\doignoretextzzz#1{%
2830 \ifnum\doignorecount =
0 % We have just found the outermost @end.
2831 \let\next\enddoignore
2832 \else % Still inside a nested condition.
2833 \advance\doignorecount by -
1
2834 \let\next\doignoretext % Look for the next @end.
2839 % Finish off ignored text.
2840 \def\enddoignore{\endgroup\ignorespaces}
2843 % @set VAR sets the variable VAR to an empty value.
2844 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
2846 % Since we want to separate VAR from REST-OF-LINE (which might be
2847 % empty), we can't just use \parsearg; we have to insert a space of our
2848 % own to delimit the rest of the line, and then take it out again if we
2850 % We rely on the fact that \parsearg sets \catcode`\ =10.
2852 \parseargdef\set{\setyyy#1 \endsetyyy}
2853 \def\setyyy#1 #2\endsetyyy{%
2855 \makevalueexpandable
2857 \edef\next{\gdef\makecsname{SET
#1}}%
2865 % Remove the trailing space \setxxx inserted.
2866 \def\setzzz#1 \endsetzzz{\next{#1}}
2868 % @clear VAR clears (i.e., unsets) the variable VAR.
2870 \parseargdef\clear{%
2872 \makevalueexpandable
2873 \global\expandafter\let\csname SET
#1\endcsname=
\relax
2877 % @value{foo} gets the text saved in variable foo.
2878 \def\value{\begingroup\makevalueexpandable\valuexxx}
2879 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
2881 \catcode`\- =
\active \catcode`
\_ =
\active
2883 \gdef\makevalueexpandable{%
2884 \let\value =
\expandablevalue
2885 % We don't want these characters active, ...
2886 \catcode`\-=
\other \catcode`
\_=
\other
2887 % ..., but we might end up with active ones in the argument if
2888 % we're called from @code, as @code{@value{foo-bar_}}, though.
2889 % So \let them to their normal equivalents.
2890 \let-
\realdash \let_\normalunderscore
2894 % We have this subroutine so that we can handle at least some @value's
2895 % properly in indexes (we call \makevalueexpandable in \indexdummies).
2896 % The command has to be fully expandable (if the variable is set), since
2897 % the result winds up in the index file. This means that if the
2898 % variable's value contains other Texinfo commands, it's almost certain
2899 % it will fail (although perhaps we could fix that with sufficient work
2900 % to do a one-level expansion on the result, instead of complete).
2902 \def\expandablevalue#1{%
2903 \expandafter\ifx\csname SET
#1\endcsname\relax
2904 {[No value for ``
#1''
]}%
2905 \message{Variable `
#1', used in @value, is not set.
}%
2907 \csname SET
#1\endcsname
2911 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
2914 % To get special treatment of `@end ifset,' call \makeond and the redefine.
2917 \def\ifset{\parsearg{\doifset{\let\next=
\ifsetfail}}}
2920 \makevalueexpandable
2922 \expandafter\ifx\csname SET
#2\endcsname\relax
2923 #1% If not set, redefine \next.
2928 \def\ifsetfail{\doignore{ifset
}}
2930 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
2931 % defined with @set, or has been undefined with @clear.
2933 % The `\else' inside the `\doifset' parameter is a trick to reuse the
2934 % above code: if the variable is not set, do nothing, if it is set,
2935 % then redefine \next to \ifclearfail.
2938 \def\ifclear{\parsearg{\doifset{\else \let\next=
\ifclearfail}}}
2939 \def\ifclearfail{\doignore{ifclear
}}
2941 % @dircategory CATEGORY -- specify a category of the dir file
2942 % which this file should belong to. Ignore this in TeX.
2943 \let\dircategory=
\comment
2945 % @defininfoenclose.
2946 \let\definfoenclose=
\comment
2950 % Index generation facilities
2952 % Define \newwrite to be identical to plain tex's \newwrite
2953 % except not \outer, so it can be used within \newindex.
2955 \gdef\newwrite{\alloc@
7\write\chardef\sixt@@n
}}
2957 % \newindex {foo} defines an index named foo.
2958 % It automatically defines \fooindex such that
2959 % \fooindex ...rest of line... puts an entry in the index foo.
2960 % It also defines \fooindfile to be the number of the output channel for
2961 % the file that accumulates this index. The file's extension is foo.
2962 % The name of an index should be no more than 2 characters long
2963 % for the sake of vms.
2967 \expandafter\newwrite \csname#1indfile
\endcsname
2968 \openout \csname#1indfile
\endcsname \jobname.
#1 % Open the file
2970 \expandafter\xdef\csname#1index
\endcsname{% % Define @#1index
2971 \noexpand\doindex{#1}}
2974 % @defindex foo == \newindex{foo}
2976 \def\defindex{\parsearg\newindex}
2978 % Define @defcodeindex, like @defindex except put all entries in @code.
2980 \def\defcodeindex{\parsearg\newcodeindex}
2982 \def\newcodeindex#1{%
2984 \expandafter\newwrite \csname#1indfile
\endcsname
2985 \openout \csname#1indfile
\endcsname \jobname.
#1
2987 \expandafter\xdef\csname#1index
\endcsname{%
2988 \noexpand\docodeindex{#1}}%
2992 % @synindex foo bar makes index foo feed into index bar.
2993 % Do this instead of @defindex foo if you don't want it as a separate index.
2995 % @syncodeindex foo bar similar, but put all entries made for index foo
2998 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
2999 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3001 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3002 % #3 the target index (bar).
3003 \def\dosynindex#1#2#3{%
3004 % Only do \closeout if we haven't already done it, else we'll end up
3005 % closing the target index.
3006 \expandafter \ifx\csname donesynindex
#2\endcsname \undefined
3007 % The \closeout helps reduce unnecessary open files; the limit on the
3008 % Acorn RISC OS is a mere 16 files.
3009 \expandafter\closeout\csname#2indfile
\endcsname
3010 \expandafter\let\csname\donesynindex#2\endcsname =
1
3012 % redefine \fooindfile:
3013 \expandafter\let\expandafter\temp\expandafter=
\csname#3indfile
\endcsname
3014 \expandafter\let\csname#2indfile
\endcsname=
\temp
3015 % redefine \fooindex:
3016 \expandafter\xdef\csname#2index
\endcsname{\noexpand#1{#3}}%
3019 % Define \doindex, the driver for all \fooindex macros.
3020 % Argument #1 is generated by the calling \fooindex macro,
3021 % and it is "foo", the name of the index.
3023 % \doindex just uses \parsearg; it calls \doind for the actual work.
3024 % This is because \doind is more useful to call from other macros.
3026 % There is also \dosubind {index}{topic}{subtopic}
3027 % which makes an entry in a two-level index such as the operation index.
3029 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3030 \def\singleindexer #1{\doind{\indexname}{#1}}
3032 % like the previous two, but they put @code around the argument.
3033 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3034 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3036 % Take care of Texinfo commands that can appear in an index entry.
3037 % Since there are some commands we want to expand, and others we don't,
3038 % we have to laboriously prevent expansion for those that we don't.
3041 \def\@
{@
}% change to @@ when we switch to @ as escape char in index files.
3042 \def\
{\realbackslash\space }%
3043 % Need these in case \tex is in effect and \{ is a \delimiter again.
3044 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3045 % braces and backslashes are used only as delimiters.
3049 % \definedummyword defines \#1 as \realbackslash #1\space, thus
3050 % effectively preventing its expansion. This is used only for control
3051 % words, not control letters, because the \space would be incorrect
3052 % for control characters, but is needed to separate the control word
3053 % from whatever follows.
3055 % For control letters, we have \definedummyletter, which omits the
3058 % These can be used both for control words that take an argument and
3059 % those that do not. If it is followed by {arg} in the input, then
3060 % that will dutifully get written to the index (or wherever).
3062 \def\definedummyword#
#1{%
3063 \expandafter\def\csname #
#1\endcsname{\realbackslash #
#1\space}%
3065 \def\definedummyletter#
#1{%
3066 \expandafter\def\csname #
#1\endcsname{\realbackslash #
#1}%
3069 % Do the redefinitions.
3073 % For the aux file, @ is the escape character. So we want to redefine
3074 % everything using @ instead of \realbackslash. When everything uses
3075 % @, this will be simpler.
3080 \let\
{ =
\lbraceatcmd
3081 \let\
} =
\rbraceatcmd
3083 % (See comments in \indexdummies.)
3084 \def\definedummyword#
#1{%
3085 \expandafter\def\csname #
#1\endcsname{@#
#1\space}%
3087 \def\definedummyletter#
#1{%
3088 \expandafter\def\csname #
#1\endcsname{@#
#1}%
3091 % Do the redefinitions.
3095 % Called from \indexdummies and \atdummies. \definedummyword and
3096 % \definedummyletter must be defined first.
3098 \def\commondummies{%
3100 \normalturnoffactive
3102 \commondummiesnofonts
3104 \definedummyletter{_
}%
3106 % Non-English letters.
3107 \definedummyword{AA
}%
3108 \definedummyword{AE
}%
3109 \definedummyword{L
}%
3110 \definedummyword{OE
}%
3111 \definedummyword{O
}%
3112 \definedummyword{aa
}%
3113 \definedummyword{ae
}%
3114 \definedummyword{l
}%
3115 \definedummyword{oe
}%
3116 \definedummyword{o
}%
3117 \definedummyword{ss
}%
3118 \definedummyword{exclamdown
}%
3119 \definedummyword{questiondown
}%
3120 \definedummyword{ordf
}%
3121 \definedummyword{ordm
}%
3123 % Although these internal commands shouldn't show up, sometimes they do.
3124 \definedummyword{bf
}%
3125 \definedummyword{gtr
}%
3126 \definedummyword{hat
}%
3127 \definedummyword{less
}%
3128 \definedummyword{sf
}%
3129 \definedummyword{sl
}%
3130 \definedummyword{tclose
}%
3131 \definedummyword{tt
}%
3133 \definedummyword{LaTeX
}%
3134 \definedummyword{TeX
}%
3136 % Assorted special characters.
3137 \definedummyword{bullet
}%
3138 \definedummyword{copyright
}%
3139 \definedummyword{registeredsymbol
}%
3140 \definedummyword{dots
}%
3141 \definedummyword{enddots
}%
3142 \definedummyword{equiv
}%
3143 \definedummyword{error
}%
3144 \definedummyword{expansion
}%
3145 \definedummyword{minus
}%
3146 \definedummyword{pounds
}%
3147 \definedummyword{point
}%
3148 \definedummyword{print
}%
3149 \definedummyword{result
}%
3151 % Handle some cases of @value -- where it does not contain any
3152 % (non-fully-expandable) commands.
3153 \makevalueexpandable
3155 % Normal spaces, not active ones.
3158 % No macro expansion.
3162 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
3164 % Better have this without active chars.
3167 \gdef\commondummiesnofonts{%
3168 % Control letters and accents.
3169 \definedummyletter{!
}%
3170 \definedummyletter{"
}%
3171 \definedummyletter{'
}%
3172 \definedummyletter{*
}%
3173 \definedummyletter{,
}%
3174 \definedummyletter{.
}%
3175 \definedummyletter{/
}%
3176 \definedummyletter{:
}%
3177 \definedummyletter{=
}%
3178 \definedummyletter{?
}%
3179 \definedummyletter{^
}%
3180 \definedummyletter{`
}%
3181 \definedummyletter{~
}%
3182 \definedummyword{u
}%
3183 \definedummyword{v
}%
3184 \definedummyword{H
}%
3185 \definedummyword{dotaccent
}%
3186 \definedummyword{ringaccent
}%
3187 \definedummyword{tieaccent
}%
3188 \definedummyword{ubaraccent
}%
3189 \definedummyword{udotaccent
}%
3190 \definedummyword{dotless
}%
3192 % Texinfo font commands.
3193 \definedummyword{b
}%
3194 \definedummyword{i
}%
3195 \definedummyword{r
}%
3196 \definedummyword{sc
}%
3197 \definedummyword{t
}%
3199 % Commands that take arguments.
3200 \definedummyword{acronym
}%
3201 \definedummyword{cite
}%
3202 \definedummyword{code
}%
3203 \definedummyword{command
}%
3204 \definedummyword{dfn
}%
3205 \definedummyword{emph
}%
3206 \definedummyword{env
}%
3207 \definedummyword{file
}%
3208 \definedummyword{kbd
}%
3209 \definedummyword{key
}%
3210 \definedummyword{math
}%
3211 \definedummyword{option
}%
3212 \definedummyword{samp
}%
3213 \definedummyword{strong
}%
3214 \definedummyword{tie
}%
3215 \definedummyword{uref
}%
3216 \definedummyword{url
}%
3217 \definedummyword{var
}%
3218 \definedummyword{verb
}%
3219 \definedummyword{w
}%
3223 % \indexnofonts is used when outputting the strings to sort the index
3224 % by, and when constructing control sequence names. It eliminates all
3225 % control sequences and just writes whatever the best ASCII sort string
3226 % would be for a given command (usually its argument).
3229 \def\definedummyword#
#1{%
3230 \expandafter\let\csname #
#1\endcsname\asis
3232 % We can just ignore the accent commands and other control letters.
3233 \def\definedummyletter#
#1{%
3234 \expandafter\def\csname #
#1\endcsname{}%
3237 \commondummiesnofonts
3239 % Don't no-op \tt, since it isn't a user-level command
3240 % and is used in the definitions of the active chars like <, >, |, etc.
3241 % Likewise with the other plain tex font commands.
3246 % how to handle braces?
3247 \def\_{\normalunderscore}%
3249 % Non-English letters.
3262 \def\questiondown{?
}%
3269 % Assorted special characters.
3270 % (The following {} will end up in the sort string, but that's ok.)
3271 \def\bullet{bullet
}%
3272 \def\copyright{copyright
}%
3273 \def\registeredsymbol{R
}%
3278 \def\expansion{==>
}%
3280 \def\pounds{pounds
}%
3286 \let\indexbackslash=
0 %overridden during \printindex.
3287 \let\SETmarginindex=
\relax % put index entries in margin (undocumented)?
3289 % Most index entries go through here, but \dosubind is the general case.
3290 % #1 is the index name, #2 is the entry text.
3291 \def\doind#1#2{\dosubind{#1}{#2}{}}
3293 % Workhorse for all \fooindexes.
3294 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
3295 % empty if called from \doind, as we usually are (the main exception
3296 % is with most defuns, which call us directly).
3298 \def\dosubind#1#2#3{%
3301 % Store the main index entry text (including the third arg).
3303 % If third arg is present, precede it with a space.
3305 \ifx\thirdarg\empty \else
3306 \toks0 =
\expandafter{\the\toks0 \space #3}%
3309 \edef\writeto{\csname#1indfile
\endcsname}%
3320 % Write the entry in \toks0 to the index file:
3322 \def\dosubindwrite{%
3323 % Put the index entry in the margin if desired.
3324 \ifx\SETmarginindex\relax\else
3325 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt
\the\toks0}}%
3328 % Remember, we are within a group.
3329 \indexdummies % Must do this here, since \bf, etc expand at this stage
3331 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
3332 % so it will be output as is; and it will print as backslash.
3334 % Process the index entry with all font commands turned off, to
3335 % get the string to sort by.
3337 \edef\temp{\the\toks0}% need full expansion
3338 \xdef\indexsorttmp{\temp}%
3341 % Set up the complete index entry, with both the sort key and
3342 % the original text, including any font commands. We write
3343 % three arguments to \entry to the .?? file (four in the
3344 % subentry case), texindex reduces to two when writing the .??s
3348 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
3353 % Take care of unwanted page breaks:
3355 % If a skip is the last thing on the list now, preserve it
3356 % by backing up by \lastskip, doing the \write, then inserting
3357 % the skip again. Otherwise, the whatsit generated by the
3358 % \write will make \lastskip zero. The result is that sequences
3363 % will have extra space inserted, because the \medbreak in the
3364 % start of the @defun won't see the skip inserted by the @end of
3365 % the previous defun.
3367 % But don't do any of this if we're not in vertical mode. We
3368 % don't want to do a \vskip and prematurely end a paragraph.
3370 % Avoid page breaks due to these extra skips, too.
3372 % But wait, there is a catch there:
3373 % We'll have to check whether \lastskip is zero skip. \ifdim is not
3374 % sufficient for this purpose, as it ignores stretch and shrink parts
3375 % of the skip. The only way seems to be to check the textual
3376 % representation of the skip.
3378 % The following is almost like \def\zeroskipmacro{0.0pt} except that
3379 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
3381 \edef\zeroskipmacro{\expandafter\the\csname z@skip
\endcsname}
3385 \def\dosubindsanitize{%
3386 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
3388 \edef\lastskipmacro{\the\lastskip}%
3389 \count255 =
\lastpenalty
3391 % If \lastskip is nonzero, that means the last item was a
3392 % skip. And since a skip is discardable, that means this
3393 % -\skip0 glue we're inserting is preceded by a
3394 % non-discardable item, therefore it is not a potential
3395 % breakpoint, therefore no \nobreak needed.
3396 \ifx\lastskipmacro\zeroskipmacro
3403 \ifx\lastskipmacro\zeroskipmacro
3404 % if \lastskip was zero, perhaps the last item was a
3405 % penalty, and perhaps it was >=10000, e.g., a \nobreak.
3406 % In that case, we want to re-insert the penalty; since we
3407 % just inserted a non-discardable item, any following glue
3408 % (such as a \parskip) would be a breakpoint. For example:
3409 % @deffn deffn-whatever
3410 % @vindex index-whatever
3412 % would allow a break between the index-whatever whatsit
3413 % and the "Description." paragraph.
3414 \ifnum\count255>
9999 \nobreak \fi
3416 % On the other hand, if we had a nonzero \lastskip,
3417 % this make-up glue would be preceded by a non-discardable item
3418 % (the whatsit from the \write), so we must insert a \nobreak.
3419 \nobreak\vskip\skip0
3423 % The index entry written in the file actually looks like
3424 % \entry {sortstring}{page}{topic}
3426 % \entry {sortstring}{page}{topic}{subtopic}
3427 % The texindex program reads in these files and writes files
3428 % containing these kinds of lines:
3430 % before the first topic whose initial is c
3431 % \entry {topic}{pagelist}
3432 % for a topic that is used without subtopics
3434 % for the beginning of a topic that is used with subtopics
3435 % \secondary {subtopic}{pagelist}
3436 % for each subtopic.
3438 % Define the user-accessible indexing commands
3439 % @findex, @vindex, @kindex, @cindex.
3441 \def\findex {\fnindex}
3442 \def\kindex {\kyindex}
3443 \def\cindex {\cpindex}
3444 \def\vindex {\vrindex}
3445 \def\tindex {\tpindex}
3446 \def\pindex {\pgindex}
3448 \def\cindexsub {\begingroup\obeylines\cindexsub}
3450 \gdef\cindexsub "
#1"
#2^^M
{\endgroup %
3451 \dosubind{cp
}{#2}{#1}}}
3453 % Define the macros used in formatting output of the sorted index material.
3455 % @printindex causes a particular index (the ??s file) to get printed.
3456 % It does not print any chapter heading (usually an @unnumbered).
3458 \parseargdef\printindex{\begingroup
3459 \dobreak \chapheadingskip{10000}%
3463 \everypar =
{}% don't want the \kern\-parindent from indentation suppression.
3465 % See if the index file exists and is nonempty.
3466 % Change catcode of @ here so that if the index file contains
3468 % as its first line, TeX doesn't complain about mismatched braces
3469 % (because it thinks @} is a control sequence).
3471 \openin 1 \jobname.
#1s
3473 % \enddoublecolumns gets confused if there is no text in the index,
3474 % and it loses the chapter title and the aux file entries for the
3475 % index. The easiest way to prevent this problem is to make sure
3476 % there is some text.
3477 \putwordIndexNonexistent
3480 % If the index file exists but is empty, then \openin leaves \ifeof
3481 % false. We have to make TeX try to read something from the file, so
3482 % it can discover if there is anything in it.
3485 \putwordIndexIsEmpty
3487 % Index files are almost Texinfo source, but we use \ as the escape
3488 % character. It would be better to use @, but that's too big a change
3489 % to make right now.
3490 \def\indexbackslash{\backslashcurfont}%
3501 % These macros are used by the sorted index file itself.
3502 % Change them to control the appearance of the index.
3505 % Some minor font changes for the special characters.
3506 \let\tentt=
\sectt \let\tt=
\sectt \let\sf=
\sectt
3508 % Remove any glue we may have, we'll be inserting our own.
3511 % We like breaks before the index initials, so insert a bonus.
3514 % Typeset the initial. Making this add up to a whole number of
3515 % baselineskips increases the chance of the dots lining up from column
3516 % to column. It still won't often be perfect, because of the stretch
3517 % we need before each entry, but it's better.
3519 % No shrink because it confuses \balancecolumns.
3520 \vskip 1.67\baselineskip plus
.5\baselineskip
3521 \leftline{\secbf #1}%
3522 \vskip .33\baselineskip plus
.1\baselineskip
3524 % Do our best not to break after the initial.
3528 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
3529 % then page number (#2) flushed to the right margin. It is used for index
3530 % and table of contents entries. The paragraph is indented by \leftskip.
3532 % A straightforward implementation would start like this:
3533 % \def\entry#1#2{...
3534 % But this frozes the catcodes in the argument, and can cause problems to
3535 % @code, which sets - active. This problem was fixed by a kludge---
3536 % ``-'' was active throughout whole index, but this isn't really right.
3538 % The right solution is to prevent \entry from swallowing the whole text.
3543 % Start a new paragraph if necessary, so our assignments below can't
3544 % affect previous text.
3547 % Do not fill out the last line with white space.
3550 % No extra space above this paragraph.
3553 % Do not prefer a separate line ending with a hyphen to fewer lines.
3554 \finalhyphendemerits =
0
3556 % \hangindent is only relevant when the entry text and page number
3557 % don't both fit on one line. In that case, bob suggests starting the
3558 % dots pretty far over on the line. Unfortunately, a large
3559 % indentation looks wrong when the entry text itself is broken across
3560 % lines. So we use a small indentation and put up with long leaders.
3562 % \hangafter is reset to 1 (which is the value we want) at the start
3563 % of each paragraph, so we need not do anything with that.
3566 % When the entry text needs to be broken, just fill out the first line
3568 \rightskip =
0pt plus1fil
3570 % A bit of stretch before each entry for the benefit of balancing
3574 % Swallow the left brace of the text (first parameter):
3575 \afterassignment\doentry
3579 \bgroup % Instead of the swallowed brace.
3581 \aftergroup\finishentry
3582 % And now comes the text of the entry.
3584 \def\finishentry#1{%
3585 % #1 is the page number.
3587 % The following is kludged to not output a line of dots in the index if
3588 % there are no page numbers. The next person who breaks this will be
3589 % cursed by a Unix daemon.
3592 \edef\tempc{\tempa}%
3593 \edef\tempd{\tempb}%
3598 % If we must, put the page number on a line of its own, and fill out
3599 % this line with blank space. (The \hfil is overwhelmed with the
3600 % fill leaders glue in \indexdotfill if the page number does fit.)
3602 \null\nobreak\indexdotfill % Have leaders before the page number.
3604 % The `\ ' here is removed by the implicit \unskip that TeX does as
3605 % part of (the primitive) \par. Without it, a spurious underfull
3618 % Like \dotfill except takes at least 1 em.
3619 \def\indexdotfill{\cleaders
3620 \hbox{$
\mathsurround=
0pt
\mkern1.5mu $
{\it .
}$
\mkern1.5mu$
}\hskip 1em plus
1fill
}
3622 \def\primary #1{\line{#1\hfil}}
3624 \newskip\secondaryindent \secondaryindent=
0.5cm
3625 \def\secondary#1#2{{%
3630 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
3632 \pdfgettoks#2.\
\the\toksA % The page number ends the paragraph.
3639 % Define two-column mode, which we use to typeset indexes.
3640 % Adapted from the TeXbook, page 416, which is to say,
3641 % the manmac.tex format used to print the TeXbook itself.
3645 \newdimen\doublecolumnhsize
3647 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
3648 % Grab any single-column material above us.
3651 % Here is a possibility not foreseen in manmac: if we accumulate a
3652 % whole lot of material, we might end up calling this \output
3653 % routine twice in a row (see the doublecol-lose test, which is
3654 % essentially a couple of indexes with @setchapternewpage off). In
3655 % that case we just ship out what is in \partialpage with the normal
3656 % output routine. Generally, \partialpage will be empty when this
3657 % runs and this will be a no-op. See the indexspread.tex test case.
3658 \ifvoid\partialpage \else
3659 \onepageout{\pagecontents\partialpage}%
3662 \global\setbox\partialpage =
\vbox{%
3663 % Unvbox the main output page.
3665 \kern-
\topskip \kern\baselineskip
3668 \eject % run that output routine to set \partialpage
3670 % Use the double-column output routine for subsequent pages.
3671 \output =
{\doublecolumnout}%
3673 % Change the page size parameters. We could do this once outside this
3674 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
3675 % format, but then we repeat the same computation. Repeating a couple
3676 % of assignments once per index is clearly meaningless for the
3677 % execution time, so we may as well do it in one place.
3679 % First we halve the line length, less a little for the gutter between
3680 % the columns. We compute the gutter based on the line length, so it
3681 % changes automatically with the paper format. The magic constant
3682 % below is chosen so that the gutter has the same value (well, +-<1pt)
3683 % as it did when we hard-coded it.
3685 % We put the result in a separate register, \doublecolumhsize, so we
3686 % can restore it in \pagesofar, after \hsize itself has (potentially)
3689 \doublecolumnhsize =
\hsize
3690 \advance\doublecolumnhsize by -
.04154\hsize
3691 \divide\doublecolumnhsize by
2
3692 \hsize =
\doublecolumnhsize
3694 % Double the \vsize as well. (We don't need a separate register here,
3695 % since nobody clobbers \vsize.)
3699 % The double-column output routine for all double-column pages except
3702 \def\doublecolumnout{%
3703 \splittopskip=
\topskip \splitmaxdepth=
\maxdepth
3704 % Get the available space for the double columns -- the normal
3705 % (undoubled) page height minus any material left over from the
3709 \advance\dimen@ by -
\ht\partialpage
3711 % box0 will be the left-hand column, box2 the right.
3712 \setbox0=
\vsplit255 to
\dimen@
\setbox2=
\vsplit255 to
\dimen@
3713 \onepageout\pagesofar
3715 \penalty\outputpenalty
3718 % Re-output the contents of the output page -- any previous material,
3719 % followed by the two boxes we just split, in box0 and box2.
3723 \hsize =
\doublecolumnhsize
3724 \wd0=
\hsize \wd2=
\hsize
3725 \hbox to
\pagewidth{\box0\hfil\box2}%
3728 % All done with double columns.
3729 \def\enddoublecolumns{%
3731 % Split the last of the double-column material. Leave it on the
3732 % current page, no automatic page break.
3735 % If we end up splitting too much material for the current page,
3736 % though, there will be another page break right after this \output
3737 % invocation ends. Having called \balancecolumns once, we do not
3738 % want to call it again. Therefore, reset \output to its normal
3739 % definition right away. (We hope \balancecolumns will never be
3740 % called on to balance too much material, but if it is, this makes
3741 % the output somewhat more palatable.)
3742 \global\output =
{\onepageout{\pagecontents\PAGE}}%
3745 \endgroup % started in \begindoublecolumns
3747 % \pagegoal was set to the doubled \vsize above, since we restarted
3748 % the current page. We're now back to normal single-column
3749 % typesetting, so reset \pagegoal to the normal \vsize (after the
3750 % \endgroup where \vsize got restored).
3754 % Called at the end of the double column material.
3755 \def\balancecolumns{%
3756 \setbox0 =
\vbox{\unvbox255}% like \box255 but more efficient, see p.120.
3758 \advance\dimen@ by
\topskip
3759 \advance\dimen@ by-
\baselineskip
3760 \divide\dimen@ by
2 % target to split to
3761 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
3762 \splittopskip =
\topskip
3763 % Loop until we get a decent breakpoint.
3767 \global\setbox3 =
\copy0
3768 \global\setbox1 =
\vsplit3 to
\dimen@
3770 \global\advance\dimen@ by
1pt
3773 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
3774 \setbox0=
\vbox to
\dimen@
{\unvbox1}%
3775 \setbox2=
\vbox to
\dimen@
{\unvbox3}%
3779 \catcode`\@ =
\other
3782 \message{sectioning,
}
3783 % Chapters, sections, etc.
3785 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
3786 % sections so that we can refer to them unambiguously in the pdf
3787 % outlines by their "section number". We avoid collisions with chapter
3788 % numbers by starting them at 10000. (If a document ever has 10000
3789 % chapters, we're in trouble anyway, I'm sure.)
3790 \newcount\unnumberedno \unnumberedno =
10000
3792 \newcount\secno \secno=
0
3793 \newcount\subsecno \subsecno=
0
3794 \newcount\subsubsecno \subsubsecno=
0
3796 % This counter is funny since it counts through charcodes of letters A, B, ...
3797 \newcount\appendixno \appendixno = `\@
3799 % \def\appendixletter{\char\the\appendixno}
3800 % We do the following ugly conditional instead of the above simple
3801 % construct for the sake of pdftex, which needs the actual
3802 % letter in the expansion, not just typeset.
3804 \def\appendixletter{%
3805 \ifnum\appendixno=`A A
%
3806 \else\ifnum\appendixno=`B B
%
3807 \else\ifnum\appendixno=`C C
%
3808 \else\ifnum\appendixno=`D D
%
3809 \else\ifnum\appendixno=`E E
%
3810 \else\ifnum\appendixno=`F F
%
3811 \else\ifnum\appendixno=`G G
%
3812 \else\ifnum\appendixno=`H H
%
3813 \else\ifnum\appendixno=`I I
%
3814 \else\ifnum\appendixno=`J J
%
3815 \else\ifnum\appendixno=`K K
%
3816 \else\ifnum\appendixno=`L L
%
3817 \else\ifnum\appendixno=`M M
%
3818 \else\ifnum\appendixno=`N N
%
3819 \else\ifnum\appendixno=`O O
%
3820 \else\ifnum\appendixno=`P P
%
3821 \else\ifnum\appendixno=`Q Q
%
3822 \else\ifnum\appendixno=`R R
%
3823 \else\ifnum\appendixno=`S S
%
3824 \else\ifnum\appendixno=`T T
%
3825 \else\ifnum\appendixno=`U U
%
3826 \else\ifnum\appendixno=`V V
%
3827 \else\ifnum\appendixno=`W W
%
3828 \else\ifnum\appendixno=`X X
%
3829 \else\ifnum\appendixno=`Y Y
%
3830 \else\ifnum\appendixno=`Z Z
%
3831 % The \the is necessary, despite appearances, because \appendixletter is
3832 % expanded while writing the .toc file. \char\appendixno is not
3833 % expandable, thus it is written literally, thus all appendixes come out
3834 % with the same letter (or @) in the toc without it.
3835 \else\char\the\appendixno
3836 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
3837 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
3839 % Each @chapter defines this as the name of the chapter.
3840 % page headings and footings can use it. @section does likewise.
3841 % However, they are not reliable, because we don't use marks.
3845 \newcount\absseclevel % used to calculate proper heading level
3846 \newcount\secbase\secbase=
0 % @raisesections/@lowersections modify this count
3848 % @raisesections: treat @section as chapter, @subsection as section, etc.
3849 \def\raisesections{\global\advance\secbase by -
1}
3850 \let\up=
\raisesections % original BFox name
3852 % @lowersections: treat @chapter as section, @section as subsection, etc.
3853 \def\lowersections{\global\advance\secbase by
1}
3854 \let\down=
\lowersections % original BFox name
3856 % we only have subsub.
3857 \chardef\maxseclevel =
3
3859 % A numbered section within an unnumbered changes to unnumbered too.
3860 % To achive this, remember the "biggest" unnum. sec. we are currently in:
3861 \chardef\unmlevel =
\maxseclevel
3863 % Trace whether the current chapter is an appendix or not:
3864 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
3865 \def\chapheadtype{N
}
3867 % Choose a heading macro
3868 % #1 is heading type
3869 % #2 is heading level
3870 % #3 is text for heading
3871 \def\genhead#1#2#3{%
3872 % Compute the abs. sec. level:
3874 \advance\absseclevel by
\secbase
3875 % Make sure \absseclevel doesn't fall outside the range:
3876 \ifnum \absseclevel <
0
3879 \ifnum \absseclevel >
3
3886 \ifnum \absseclevel <
\unmlevel
3887 \chardef\unmlevel =
\absseclevel
3890 % Check for appendix sections:
3891 \ifnum \absseclevel =
0
3892 \edef\chapheadtype{\headtype}%
3894 \if \headtype A
\if \chapheadtype N
%
3895 \errmessage{@appendix... within a non-appendix chapter
}%
3898 % Check for numbered within unnumbered:
3899 \ifnum \absseclevel >
\unmlevel
3902 \chardef\unmlevel =
3
3905 % Now print the heading:
3909 \or \unnumberedseczzz{#3}%
3910 \or \unnumberedsubseczzz{#3}%
3911 \or \unnumberedsubsubseczzz{#3}%
3917 \or \appendixsectionzzz{#3}%
3918 \or \appendixsubseczzz{#3}%
3919 \or \appendixsubsubseczzz{#3}%
3925 \or \numberedsubseczzz{#3}%
3926 \or \numberedsubsubseczzz{#3}%
3930 \suppressfirstparagraphindent
3934 \def\numhead{\genhead N
}
3935 \def\apphead{\genhead A
}
3936 \def\unnmhead{\genhead U
}
3938 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
3939 % all lower-level sectioning counters to zero.
3941 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
3942 % (e.g., figures), q.v. By default (before any chapter), that is empty.
3943 \let\chaplevelprefix =
\empty
3945 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
3947 % section resetting is \global in case the chapter is in a group, such
3948 % as an @include file.
3949 \global\secno=
0 \global\subsecno=
0 \global\subsubsecno=
0
3950 \global\advance\chapno by
1
3953 \gdef\chaplevelprefix{\the\chapno.
}%
3956 \message{\putwordChapter\space \the\chapno}%
3958 % Write the actual heading.
3959 \chapmacro{#1}{Ynumbered
}{\the\chapno}%
3961 % So @section and the like are numbered underneath this chapter.
3962 \global\let\section =
\numberedsec
3963 \global\let\subsection =
\numberedsubsec
3964 \global\let\subsubsection =
\numberedsubsubsec
3967 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
3968 \def\appendixzzz#1{%
3969 \global\secno=
0 \global\subsecno=
0 \global\subsubsecno=
0
3970 \global\advance\appendixno by
1
3971 \gdef\chaplevelprefix{\appendixletter.
}%
3974 \def\appendixnum{\putwordAppendix\space \appendixletter}%
3975 \message{\appendixnum}%
3977 \chapmacro{#1}{Yappendix
}{\appendixletter}%
3979 \global\let\section =
\appendixsec
3980 \global\let\subsection =
\appendixsubsec
3981 \global\let\subsubsection =
\appendixsubsubsec
3984 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
3985 \def\unnumberedzzz#1{%
3986 \global\secno=
0 \global\subsecno=
0 \global\subsubsecno=
0
3987 \global\advance\unnumberedno by
1
3989 % Since an unnumbered has no number, no prefix for figures.
3990 \global\let\chaplevelprefix =
\empty
3993 % This used to be simply \message{#1}, but TeX fully expands the
3994 % argument to \message. Therefore, if #1 contained @-commands, TeX
3995 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
3996 % expanded @cite (which turns out to cause errors because \cite is meant
3997 % to be executed, not expanded).
3999 % Anyway, we don't want the fully-expanded definition of @cite to appear
4000 % as a result of the \message, we just want `@cite' itself. We use
4001 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
4002 % simply yielding the contents of <toks register>. (We also do this for
4005 \message{(
\the\toks0)
}%
4007 \chapmacro{#1}{Ynothing
}{\the\unnumberedno}%
4009 \global\let\section =
\unnumberedsec
4010 \global\let\subsection =
\unnumberedsubsec
4011 \global\let\subsubsection =
\unnumberedsubsubsec
4014 % @centerchap is like @unnumbered, but the heading is centered.
4015 \outer\parseargdef\centerchap{%
4016 % Well, we could do the following in a group, but that would break
4017 % an assumption that \chapmacro is called at the outermost level.
4018 % Thus we are safer this way: --kasal, 24feb04
4019 \let\centerparametersmaybe =
\centerparameters
4021 \let\centerparametersmaybe =
\relax
4024 % @top is like @unnumbered.
4028 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
4030 \global\subsecno=
0 \global\subsubsecno=
0 \global\advance\secno by
1
4031 \sectionheading{#1}{sec
}{Ynumbered
}{\the\chapno.
\the\secno}%
4034 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
4035 \def\appendixsectionzzz#1{%
4036 \global\subsecno=
0 \global\subsubsecno=
0 \global\advance\secno by
1
4037 \sectionheading{#1}{sec
}{Yappendix
}{\appendixletter.
\the\secno}%
4039 \let\appendixsec\appendixsection
4041 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
4042 \def\unnumberedseczzz#1{%
4043 \global\subsecno=
0 \global\subsubsecno=
0 \global\advance\secno by
1
4044 \sectionheading{#1}{sec
}{Ynothing
}{\the\unnumberedno.
\the\secno}%
4048 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
4049 \def\numberedsubseczzz#1{%
4050 \global\subsubsecno=
0 \global\advance\subsecno by
1
4051 \sectionheading{#1}{subsec
}{Ynumbered
}{\the\chapno.
\the\secno.
\the\subsecno}%
4054 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
4055 \def\appendixsubseczzz#1{%
4056 \global\subsubsecno=
0 \global\advance\subsecno by
1
4057 \sectionheading{#1}{subsec
}{Yappendix
}%
4058 {\appendixletter.
\the\secno.
\the\subsecno}%
4061 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
4062 \def\unnumberedsubseczzz#1{%
4063 \global\subsubsecno=
0 \global\advance\subsecno by
1
4064 \sectionheading{#1}{subsec
}{Ynothing
}%
4065 {\the\unnumberedno.
\the\secno.
\the\subsecno}%
4069 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
4070 \def\numberedsubsubseczzz#1{%
4071 \global\advance\subsubsecno by
1
4072 \sectionheading{#1}{subsubsec
}{Ynumbered
}%
4073 {\the\chapno.
\the\secno.
\the\subsecno.
\the\subsubsecno}%
4076 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
4077 \def\appendixsubsubseczzz#1{%
4078 \global\advance\subsubsecno by
1
4079 \sectionheading{#1}{subsubsec
}{Yappendix
}%
4080 {\appendixletter.
\the\secno.
\the\subsecno.
\the\subsubsecno}%
4083 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
4084 \def\unnumberedsubsubseczzz#1{%
4085 \global\advance\subsubsecno by
1
4086 \sectionheading{#1}{subsubsec
}{Ynothing
}%
4087 {\the\unnumberedno.
\the\secno.
\the\subsecno.
\the\subsubsecno}%
4090 % These macros control what the section commands do, according
4091 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
4092 % Define them by default for a numbered chapter.
4093 \let\section =
\numberedsec
4094 \let\subsection =
\numberedsubsec
4095 \let\subsubsection =
\numberedsubsubsec
4097 % Define @majorheading, @heading and @subheading
4099 % NOTE on use of \vbox for chapter headings, section headings, and such:
4100 % 1) We use \vbox rather than the earlier \line to permit
4101 % overlong headings to fold.
4102 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
4103 % heading is obnoxious; this forbids it.
4104 % 3) Likewise, headings look best if no \parindent is used, and
4105 % if justification is not attempted. Hence \raggedright.
4109 {\advance\chapheadingskip by
10pt
\chapbreak }%
4110 \parsearg\chapheadingzzz
4113 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
4114 \def\chapheadingzzz#1{%
4115 {\chapfonts \vbox{\hyphenpenalty=
10000\tolerance=
5000
4116 \parindent=
0pt
\raggedright
4118 \bigskip \par\penalty 200\relax
4119 \suppressfirstparagraphindent
4122 % @heading, @subheading, @subsubheading.
4123 \parseargdef\heading{\sectionheading{#1}{sec
}{Yomitfromtoc
}{}
4124 \suppressfirstparagraphindent}
4125 \parseargdef\subheading{\sectionheading{#1}{subsec
}{Yomitfromtoc
}{}
4126 \suppressfirstparagraphindent}
4127 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec
}{Yomitfromtoc
}{}
4128 \suppressfirstparagraphindent}
4130 % These macros generate a chapter, section, etc. heading only
4131 % (including whitespace, linebreaking, etc. around it),
4132 % given all the information in convenient, parsed form.
4134 %%% Args are the skip and penalty (usually negative)
4135 \def\dobreak#1#2{\par\ifdim\lastskip<
#1\removelastskip\penalty#2\vskip#1\fi}
4137 %%% Define plain chapter starts, and page on/off switching for it
4138 % Parameter controlling skip before chapter headings (if needed)
4140 \newskip\chapheadingskip
4142 \def\chapbreak{\dobreak \chapheadingskip {-
4000}}
4143 \def\chappager{\par\vfill\supereject}
4144 \def\chapoddpage{\chappager \ifodd\pageno \else \hbox to
0pt
{} \chappager\fi}
4146 \def\setchapternewpage #1 {\csname CHAPPAG
#1\endcsname}
4149 \global\let\contentsalignmacro =
\chappager
4150 \global\let\pchapsepmacro=
\chapbreak
4151 \global\let\pagealignmacro=
\chappager}
4154 \global\let\contentsalignmacro =
\chappager
4155 \global\let\pchapsepmacro=
\chappager
4156 \global\let\pagealignmacro=
\chappager
4157 \global\def\HEADINGSon{\HEADINGSsingle}}
4160 \global\let\contentsalignmacro =
\chapoddpage
4161 \global\let\pchapsepmacro=
\chapoddpage
4162 \global\let\pagealignmacro=
\chapoddpage
4163 \global\def\HEADINGSon{\HEADINGSdouble}}
4169 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
4170 % Yappendix, Yomitfromtoc), #3 the chapter number.
4172 % To test against our argument.
4173 \def\Ynothingkeyword{Ynothing
}
4174 \def\Yomitfromtockeyword{Yomitfromtoc
}
4175 \def\Yappendixkeyword{Yappendix
}
4177 \def\chapmacro#1#2#3{%
4182 % Have to define \thissection before calling \donoderef, because the
4183 % xref code eventually uses it. On the other hand, it has to be called
4184 % after \pchapsepmacro, or the headline will change too soon.
4185 \gdef\thissection{#1}%
4186 \gdef\thischaptername{#1}%
4188 % Only insert the separating space if we have a chapter/appendix
4189 % number, and don't print the unnumbered ``number''.
4191 \ifx\temptype\Ynothingkeyword
4193 \def\toctype{unnchap
}%
4194 \def\thischapter{#1}%
4195 \else\ifx\temptype\Yomitfromtockeyword
4196 \setbox0 =
\hbox{}% contents like unnumbered, but no toc entry
4198 \xdef\thischapter{}%
4199 \else\ifx\temptype\Yappendixkeyword
4200 \setbox0 =
\hbox{\putwordAppendix{} #3\enspace}%
4202 % We don't substitute the actual chapter name into \thischapter
4203 % because we don't want its macros evaluated now. And we don't
4204 % use \thissection because that changes with each section.
4206 \xdef\thischapter{\putwordAppendix{} \appendixletter:
4207 \noexpand\thischaptername}%
4209 \setbox0 =
\hbox{#3\enspace}%
4210 \def\toctype{numchap
}%
4211 \xdef\thischapter{\putwordChapter{} \the\chapno:
4212 \noexpand\thischaptername}%
4215 % Write the toc entry for this chapter. Must come before the
4216 % \donoderef, because we include the current node name in the toc
4217 % entry, and \donoderef resets it to empty.
4218 \writetocentry{\toctype}{#1}{#3}%
4220 % For pdftex, we have to write out the node definition (aka, make
4221 % the pdfdest) after any page break, but before the actual text has
4222 % been typeset. If the destination for the pdf outline is after the
4223 % text, then jumping from the outline may wind up with the text not
4224 % being visible, for instance under high magnification.
4227 % Typeset the actual heading.
4228 \vbox{\hyphenpenalty=
10000 \tolerance=
5000 \parindent=
0pt
\raggedright
4229 \hangindent=
\wd0 \centerparametersmaybe
4232 \nobreak\bigskip % no page break after a chapter title
4236 % @centerchap -- centered and unnumbered.
4237 \let\centerparametersmaybe =
\relax
4238 \def\centerparameters{%
4239 \advance\rightskip by
3\rightskip
4240 \leftskip =
\rightskip
4245 % I don't think this chapter style is supported any more, so I'm not
4246 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
4248 \def\setchapterstyle #1 {\csname CHAPF
#1\endcsname}
4250 \def\unnchfopen #1{%
4251 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=
10000\tolerance=
5000
4252 \parindent=
0pt
\raggedright
4253 \rm #1\hfill}}\bigskip \par\nobreak
4255 \def\chfopen #1#2{\chapoddpage {\chapfonts
4256 \vbox to
3in
{\vfil \hbox to
\hsize{\hfil #2} \hbox to
\hsize{\hfil #1} \vfil}}%
4259 \def\centerchfopen #1{%
4260 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=
10000\tolerance=
5000
4262 \hfill {\rm #1}\hfill}}\bigskip \par\nobreak
4265 \global\let\chapmacro=
\chfopen
4266 \global\let\centerchapmacro=
\centerchfopen}
4269 % Section titles. These macros combine the section number parts and
4270 % call the generic \sectionheading to do the printing.
4272 \newskip\secheadingskip
4273 \def\secheadingbreak{\dobreak \secheadingskip{-
1000}}
4275 % Subsection titles.
4276 \newskip\subsecheadingskip
4277 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-
500}}
4279 % Subsubsection titles.
4280 \def\subsubsecheadingskip{\subsecheadingskip}
4281 \def\subsubsecheadingbreak{\subsecheadingbreak}
4284 % Print any size, any type, section title.
4286 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
4287 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
4290 \def\sectionheading#1#2#3#4{%
4292 % Switch to the right set of fonts.
4293 \csname #2fonts
\endcsname \rm
4295 % Insert space above the heading.
4296 \csname #2headingbreak
\endcsname
4298 % Only insert the space after the number if we have a section number.
4299 \def\sectionlevel{#2}%
4302 \ifx\temptype\Ynothingkeyword
4305 \gdef\thissection{#1}%
4306 \else\ifx\temptype\Yomitfromtockeyword
4307 % for @headings -- no section number, don't include in toc,
4308 % and don't redefine \thissection.
4311 \let\sectionlevel=
\empty
4312 \else\ifx\temptype\Yappendixkeyword
4313 \setbox0 =
\hbox{#4\enspace}%
4315 \gdef\thissection{#1}%
4317 \setbox0 =
\hbox{#4\enspace}%
4319 \gdef\thissection{#1}%
4322 % Write the toc entry (before \donoderef). See comments in \chfplain.
4323 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
4325 % Write the node reference (= pdf destination for pdftex).
4326 % Again, see comments in \chfplain.
4329 % Output the actual section heading.
4330 \vbox{\hyphenpenalty=
10000 \tolerance=
5000 \parindent=
0pt
\raggedright
4331 \hangindent=
\wd0 % zero if no section number
4334 % Add extra space after the heading -- half of whatever came above it.
4335 % Don't allow stretch, though.
4336 \kern .5 \csname #2headingskip
\endcsname
4338 % Do not let the kern be a potential breakpoint, as it would be if it
4339 % was followed by glue.
4342 % We'll almost certainly start a paragraph next, so don't let that
4343 % glue accumulate. (Not a breakpoint because it's preceded by a
4344 % discardable item.)
4347 % This \nobreak is purely so the last item on the list is a \penalty
4348 % of 10000. This is so other code, for instance \parsebodycommon, can
4349 % check for and avoid allowing breakpoints. Otherwise, it would
4350 % insert a valid breakpoint between:
4351 % @section sec-whatever
4352 % @deffn def-whatever
4358 % Table of contents.
4361 % Write an entry to the toc file, opening it if necessary.
4362 % Called from @chapter, etc.
4364 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
4365 % We append the current node name (if any) and page number as additional
4366 % arguments for the \{chap,sec,...}entry macros which will eventually
4367 % read this. The node name is used in the pdf outlines as the
4368 % destination to jump to.
4370 % We open the .toc file for writing here instead of at @setfilename (or
4371 % any other fixed time) so that @contents can be anywhere in the document.
4372 % But if #1 is `omit', then we don't do anything. This is used for the
4373 % table of contents chapter openings themselves.
4375 \newif\iftocfileopened
4376 \def\omitkeyword{omit
}%
4378 \def\writetocentry#1#2#3{%
4379 \edef\writetoctype{#1}%
4380 \ifx\writetoctype\omitkeyword \else
4381 \iftocfileopened\else
4382 \immediate\openout\tocfile =
\jobname.toc
4383 \global\tocfileopenedtrue
4388 \toks2 =
\expandafter{\lastnode}%
4389 \edef\temp{\write\tocfile{\realbackslash #1entry
{\the\toks0}{#3}%
4390 {\the\toks2}{\noexpand\folio}}}%
4395 % Tell \shipout to create a pdf destination on each page, if we're
4396 % writing pdf. These are used in the table of contents. We can't
4397 % just write one on every page because the title pages are numbered
4398 % 1 and 2 (the page numbers aren't printed), and so are the first
4399 % two pages of the document. Thus, we'd have two destinations named
4400 % `1', and two named `2'.
4401 \ifpdf \global\pdfmakepagedesttrue \fi
4404 \newskip\contentsrightmargin \contentsrightmargin=
1in
4405 \newcount\savepageno
4406 \newcount\lastnegativepageno \lastnegativepageno = -
1
4408 % Prepare to read what we've written to \tocfile.
4410 \def\startcontents#1{%
4411 % If @setchapternewpage on, and @headings double, the contents should
4412 % start on an odd page, unlike chapters. Thus, we maintain
4413 % \contentsalignmacro in parallel with \pagealignmacro.
4414 % From: Torbjorn Granlund <tege@matematik.su.se>
4416 \immediate\closeout\tocfile
4418 % Don't need to put `Contents' or `Short Contents' in the headline.
4419 % It is abundantly clear what they are.
4421 \chapmacro{#1}{Yomitfromtoc
}{}%
4423 \savepageno =
\pageno
4424 \begingroup % Set up to handle contents files properly.
4425 \catcode`\\=
0 \catcode`\
{=
1 \catcode`\
}=
2 \catcode`\@=
11
4426 % We can't do this, because then an actual ^ in a section
4427 % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97.
4428 %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi
4429 \raggedbottom % Worry more about breakpoints than the bottom.
4430 \advance\hsize by -
\contentsrightmargin % Don't use the full line length.
4432 % Roman numerals for page numbers.
4433 \ifnum \pageno>
0 \global\pageno =
\lastnegativepageno \fi
4437 % Normal (long) toc.
4439 \startcontents{\putwordTOC}%
4440 \openin 1 \jobname.toc
4445 \contentsalignmacro % in case @setchapternewpage odd is in effect
4451 \lastnegativepageno =
\pageno
4452 \global\pageno =
\savepageno
4455 % And just the chapters.
4456 \def\summarycontents{%
4457 \startcontents{\putwordShortTOC}%
4459 \let\numchapentry =
\shortchapentry
4460 \let\appentry =
\shortchapentry
4461 \let\unnchapentry =
\shortunnchapentry
4462 % We want a true roman here for the page numbers.
4464 \let\rm=
\shortcontrm \let\bf=
\shortcontbf
4465 \let\sl=
\shortcontsl \let\tt=
\shortconttt
4467 \hyphenpenalty =
10000
4468 \advance\baselineskip by
1pt
% Open it up a little.
4469 \def\numsecentry#
#1#
#2#
#3#
#4{}
4470 \let\appsecentry =
\numsecentry
4471 \let\unnsecentry =
\numsecentry
4472 \let\numsubsecentry =
\numsecentry
4473 \let\appsubsecentry =
\numsecentry
4474 \let\unnsubsecentry =
\numsecentry
4475 \let\numsubsubsecentry =
\numsecentry
4476 \let\appsubsubsecentry =
\numsecentry
4477 \let\unnsubsubsecentry =
\numsecentry
4478 \openin 1 \jobname.toc
4484 \contentsalignmacro % in case @setchapternewpage odd is in effect
4486 \lastnegativepageno =
\pageno
4487 \global\pageno =
\savepageno
4489 \let\shortcontents =
\summarycontents
4491 % Typeset the label for a chapter or appendix for the short contents.
4492 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
4494 \def\shortchaplabel#1{%
4495 % This space should be enough, since a single number is .5em, and the
4496 % widest letter (M) is 1em, at least in the Computer Modern fonts.
4497 % But use \hss just in case.
4498 % (This space doesn't include the extra space that gets added after
4499 % the label; that gets put in by \shortchapentry above.)
4501 % We'd like to right-justify chapter numbers, but that looks strange
4502 % with appendix letters. And right-justifying numbers and
4503 % left-justifying letters looks strange when there is less than 10
4504 % chapters. Have to read the whole toc once to know how many chapters
4505 % there are before deciding ...
4506 \hbox to
1em
{#1\hss}%
4509 % These macros generate individual entries in the table of contents.
4510 % The first argument is the chapter or section name.
4511 % The last argument is the page number.
4512 % The arguments in between are the chapter number, section number, ...
4514 % Chapters, in the main contents.
4515 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
4517 % Chapters, in the short toc.
4518 % See comments in \dochapentry re vbox and related settings.
4519 \def\shortchapentry#1#2#3#4{%
4520 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
4523 % Appendices, in the main contents.
4524 % Need the word Appendix, and a fixed-size box.
4526 \def\appendixbox#1{%
4527 % We use M since it's probably the widest letter.
4528 \setbox0 =
\hbox{\putwordAppendix{} M
}%
4529 \hbox to
\wd0{\putwordAppendix{} #1\hss}}
4531 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
4533 % Unnumbered chapters.
4534 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
4535 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
4538 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
4539 \let\appsecentry=
\numsecentry
4540 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
4543 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
4544 \let\appsubsecentry=
\numsubsecentry
4545 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
4547 % And subsubsections.
4548 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
4549 \let\appsubsubsecentry=
\numsubsubsecentry
4550 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
4552 % This parameter controls the indentation of the various levels.
4553 % Same as \defaultparindent.
4554 \newdimen\tocindent \tocindent =
15pt
4556 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
4559 % If the toc has to be broken over pages, we want it to be at chapters
4560 % if at all possible; hence the \penalty.
4561 \def\dochapentry#1#2{%
4562 \penalty-
300 \vskip1\baselineskip plus
.33\baselineskip minus
.25\baselineskip
4565 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4567 \nobreak\vskip .25\baselineskip plus
.1\baselineskip
4570 \def\dosecentry#1#2{\begingroup
4571 \secentryfonts \leftskip=
\tocindent
4572 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4575 \def\dosubsecentry#1#2{\begingroup
4576 \subsecentryfonts \leftskip=
2\tocindent
4577 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4580 \def\dosubsubsecentry#1#2{\begingroup
4581 \subsubsecentryfonts \leftskip=
3\tocindent
4582 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
4585 % We use the same \entry macro as for the index entries.
4586 \let\tocentry =
\entry
4588 % Space between chapter (or whatever) number and the title.
4589 \def\labelspace{\hskip1em \relax}
4591 \def\dopageno#1{{\rm #1}}
4592 \def\doshortpageno#1{{\rm #1}}
4594 \def\chapentryfonts{\secfonts \rm}
4595 \def\secentryfonts{\textfonts}
4596 \def\subsecentryfonts{\textfonts}
4597 \def\subsubsecentryfonts{\textfonts}
4600 \message{environments,
}
4601 % @foo ... @end foo.
4603 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
4605 % Since these characters are used in examples, it should be an even number of
4606 % \tt widths. Each \tt character is 1en, so two makes it 1em.
4609 \def\result{\leavevmode\raise.15ex
\hbox to
1em
{\hfil$
\Rightarrow$
\hfil}}
4610 \def\expansion{\leavevmode\raise.1ex
\hbox to
1em
{\hfil$
\mapsto$
\hfil}}
4611 \def\print{\leavevmode\lower.1ex
\hbox to
1em
{\hfil$
\dashv$
\hfil}}
4612 \def\equiv{\leavevmode\lower.1ex
\hbox to
1em
{\hfil$
\ptexequiv$
\hfil}}
4614 % The @error{} command.
4615 % Adapted from the TeXbook's \boxit.
4619 {\tentt \global\dimen0 =
3em
}% Width of the box.
4620 \dimen2 =
.55pt
% Thickness of rules
4621 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
4622 \setbox0 =
\hbox{\kern-
.75pt
\tensf error
\kern-
1.5pt
}
4624 \setbox\errorbox=
\hbox to
\dimen0{\hfil
4625 \hsize =
\dimen0 \advance\hsize by -
5.8pt
% Space to left+right.
4626 \advance\hsize by -
2\dimen2 % Rules.
4628 \hrule height
\dimen2
4629 \hbox{\vrule width
\dimen2 \kern3pt % Space to left of text.
4630 \vtop{\kern2.4pt
\box0 \kern2.4pt
}% Space above/below.
4631 \kern3pt\vrule width
\dimen2}% Space to right.
4632 \hrule height
\dimen2}
4635 \def\error{\leavevmode\lower.7ex
\copy\errorbox}
4637 % @tex ... @end tex escapes into raw Tex temporarily.
4638 % One exception: @ is still an escape character, so that @end tex works.
4639 % But \@ or @@ will get a plain tex @ character.
4642 \catcode `\\=
0 \catcode `\
{=
1 \catcode `\
}=
2
4643 \catcode `\$=
3 \catcode `\&=
4 \catcode `\#=
6
4644 \catcode `\^=
7 \catcode `
\_=
8 \catcode `\~=
\active \let~=
\tie
4654 \let\bullet=
\ptexbullet
4659 \let\equiv=
\ptexequiv
4662 \let\indent=
\ptexindent
4663 \let\noindent=
\ptexnoindent
4671 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
4672 \def\enddots{\relax\ifmmode\endldots\else$
\mathsurround=
0pt
\endldots\,$
\fi}%
4675 % There is no need to define \Etex.
4677 % Define @lisp ... @end lisp.
4678 % @lisp environment forms a group so it can rebind things,
4679 % including the definition of @end lisp (which normally is erroneous).
4681 % Amount to narrow the margins by for @lisp.
4682 \newskip\lispnarrowing \lispnarrowing=
0.4in
4684 % This is the definition that ^^M gets inside @lisp, @example, and other
4685 % such environments. \null is better than a space, since it doesn't
4687 \def\lisppar{\null\endgraf}
4689 % This space is always present above and below environments.
4690 \newskip\envskipamount \envskipamount =
0pt
4692 % Make spacing and below environment symmetrical. We use \parskip here
4693 % to help in doing that, since in @example-like environments \parskip
4694 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
4695 % start of the next paragraph will insert \parskip.
4697 \def\aboveenvbreak{{%
4698 % =10000 instead of <10000 because of a special case in \itemzzz, q.v.
4699 \ifnum \lastpenalty=
10000 \else
4700 \advance\envskipamount by
\parskip
4702 \ifdim\lastskip<
\envskipamount
4704 % it's not a good place to break if the last penalty was \nobreak
4706 \ifnum\lastpenalty<
10000 \penalty-
50 \fi
4707 \vskip\envskipamount
4712 \let\afterenvbreak =
\aboveenvbreak
4714 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins.
4715 \let\nonarrowing=
\relax
4717 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
4718 % environment contents.
4719 \font\circle=lcircle10
4721 \newdimen\cartouter\newdimen\cartinner
4722 \newskip\normbskip\newskip\normpskip\newskip\normlskip
4723 \circthick=
\fontdimen8\circle
4725 \def\ctl{{\circle\char'
013\hskip -
6pt
}}% 6pt from pl file: 1/2charwidth
4726 \def\ctr{{\hskip 6pt
\circle\char'
010}}
4727 \def\cbl{{\circle\char'
012\hskip -
6pt
}}
4728 \def\cbr{{\hskip 6pt
\circle\char'
011}}
4729 \def\carttop{\hbox to
\cartouter{\hskip\lskip
4730 \ctl\leaders\hrule height
\circthick\hfil\ctr
4732 \def\cartbot{\hbox to
\cartouter{\hskip\lskip
4733 \cbl\leaders\hrule height
\circthick\hfil\cbr
4736 \newskip\lskip\newskip\rskip
4739 \ifhmode\par\fi % can't be in the midst of a paragraph.
4741 \lskip=
\leftskip \rskip=
\rightskip
4742 \leftskip=
0pt
\rightskip=
0pt
% we want these *outside*.
4743 \cartinner=
\hsize \advance\cartinner by-
\lskip
4744 \advance\cartinner by-
\rskip
4746 \advance\cartouter by
18.4pt
% allow for 3pt kerns on either
4747 % side, and for 6pt waste from
4748 % each corner char, and rule thickness
4749 \normbskip=
\baselineskip \normpskip=
\parskip \normlskip=
\lineskip
4750 % Flag to tell @lisp, etc., not to narrow margin.
4751 \let\nonarrowing=
\comment
4753 \baselineskip=
0pt
\parskip=
0pt
\lineskip=
0pt
4761 \baselineskip=
\normbskip
4762 \lineskip=
\normlskip
4765 \comment % For explanation, see the end of \def\group.
4780 % This macro is called at the beginning of all the @example variants,
4784 \hfuzz =
12pt
% Don't be fussy
4785 \sepspaces % Make spaces be word-separators rather than space tokens.
4786 \let\par =
\lisppar % don't ignore blank lines
4787 \obeylines % each line of input is a line of output
4790 \emergencystretch =
0pt
% don't try to avoid overfull boxes
4791 % @cartouche defines \nonarrowing to inhibit narrowing
4792 % at next level down.
4793 \ifx\nonarrowing\relax
4794 \advance \leftskip by
\lispnarrowing
4795 \exdentamount=
\lispnarrowing
4797 \let\exdent=
\nofillexdent
4800 % If you want all examples etc. small: @set dispenvsize small.
4801 % If you want even small examples the full size: @set dispenvsize nosmall.
4802 % This affects the following displayed environments:
4803 % @example, @display, @format, @lisp
4805 \def\smallword{small
}
4806 \def\nosmallword{nosmall
}
4807 \let\SETdispenvsize\relax
4808 \def\setnormaldispenv{%
4809 \ifx\SETdispenvsize\smallword
4810 \smallexamplefonts \rm
4813 \def\setsmalldispenv{%
4814 \ifx\SETdispenvsize\nosmallword
4816 \smallexamplefonts \rm
4820 % We often define two environments, @foo and @smallfoo.
4821 % Let's do it by one command:
4822 \def\makedispenv #1#2{
4823 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
4824 \expandafter\envdef\csname small
#1\endcsname {\setsmalldispenv #2}
4825 \expandafter\let\csname E
#1\endcsname \afterenvbreak
4826 \expandafter\let\csname Esmall
#1\endcsname \afterenvbreak
4829 % Define two synonyms:
4830 \def\maketwodispenvs #1#2#3{
4831 \makedispenv{#1}{#3}
4832 \makedispenv{#2}{#3}
4835 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
4837 % @smallexample and @smalllisp: use smaller fonts.
4838 % Originally contributed by Pavel@xerox.
4840 \maketwodispenvs {lisp
}{example
}{%
4843 \let\kbdfont =
\kbdexamplefont % Allow @kbd to do something special.
4844 \gobble % eat return
4847 % @display/@smalldisplay: same as @lisp except keep current font.
4849 \makedispenv {display
}{%
4854 % @format/@smallformat: same as @display except don't narrow margins.
4856 \makedispenv{format
}{%
4857 \let\nonarrowing = t
%
4862 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
4864 \let\nonarrowing = t
%
4868 \let\Eflushleft =
\afterenvbreak
4872 \envdef\flushright{%
4873 \let\nonarrowing = t
%
4875 \advance\leftskip by
0pt plus
1fill
4878 \let\Eflushright =
\afterenvbreak
4881 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
4882 % and narrows the margins. We keep \parskip nonzero in general, since
4883 % we're doing normal filling. So, when using \aboveenvbreak and
4884 % \afterenvbreak, temporarily make \parskip 0.
4887 {\parskip=
0pt
\aboveenvbreak}% because \aboveenvbreak inserts \parskip
4890 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
4891 \ifx\nonarrowing\relax
4892 \advance\leftskip by
\lispnarrowing
4893 \advance\rightskip by
\lispnarrowing
4894 \exdentamount =
\lispnarrowing
4895 \let\nonarrowing =
\relax
4897 \parsearg\quotationlabel
4900 % We have retained a nonzero parskip for the environment, since we're
4901 % doing normal filling.
4905 \ifx\quotationauthor\undefined\else
4907 \leftline{\kern 2\leftskip \sl ---
\quotationauthor}%
4909 {\parskip=
0pt
\afterenvbreak}%
4912 % If we're given an argument, typeset it in bold with a colon after.
4913 \def\quotationlabel#1{%
4915 \ifx\temp\empty \else
4921 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
4922 % If we want to allow any <char> as delimiter,
4923 % we need the curly braces so that makeinfo sees the @verb command, eg:
4924 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
4926 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
4928 % [Knuth] p.344; only we need to do the other characters Texinfo sets
4929 % active too. Otherwise, they get lost as the first character on a
4932 \do\
\do\\
\do\
{\do\
}\do\$
\do\&
%
4933 \do\#
\do\^
\do\^^K
\do\_\do\^^A
\do\%
\do\~
%
4934 \do\<
\do\>
\do\|
\do\@
\do+
\do\"
%
4938 \def\uncatcodespecials{%
4939 \def\do#
#1{\catcode`#
#1=
\other}\dospecials}
4941 % [Knuth] pp. 380,381,391
4942 % Disable Spanish ligatures ?` and !` of \tt font
4944 \catcode`\`=
\active\gdef`
{\relax\lq}
4947 % Setup for the @verb command.
4949 % Eight spaces for a tab
4951 \catcode`\^^I=
\active
4952 \gdef\tabeightspaces{\catcode`\^^I=
\active\def^^I
{\ \ \ \ \ \ \ \
}}
4956 \tt % easiest (and conventionally used) font for verbatim
4957 \def\par{\leavevmode\endgraf}%
4960 % Respect line breaks,
4961 % print special symbols as themselves, and
4962 % make each space count
4963 % must do in this order:
4964 \obeylines \uncatcodespecials \sepspaces
4967 % Setup for the @verbatim environment
4969 % Real tab expansion
4970 \newdimen\tabw \setbox0=
\hbox{\tt\space} \tabw=
8\wd0 % tab amount
4972 \def\starttabbox{\setbox0=
\hbox\bgroup}
4974 \catcode`\^^I=
\active
4976 \catcode`\^^I=
\active
4977 \def^^I
{\leavevmode\egroup
4978 \dimen0=
\wd0 % the width so far, or since the previous tab
4979 \divide\dimen0 by
\tabw
4980 \multiply\dimen0 by
\tabw % compute previous multiple of \tabw
4981 \advance\dimen0 by
\tabw % advance to next multiple of \tabw
4982 \wd0=
\dimen0 \box0 \starttabbox
4986 \def\setupverbatim{%
4988 \advance\leftskip by -
\defbodyindent
4989 % Easiest (and conventionally used) font for verbatim
4991 \def\par{\leavevmode\egroup\box0\endgraf}%
4994 % Respect line breaks,
4995 % print special symbols as themselves, and
4996 % make each space count
4997 % must do in this order:
4998 \obeylines \uncatcodespecials \sepspaces
4999 \everypar{\starttabbox}%
5002 % Do the @verb magic: verbatim text is quoted by unique
5003 % delimiter characters. Before first delimiter expect a
5004 % right brace, after last delimiter expect closing brace:
5006 % \def\doverb'{'<char>#1<char>'}'{#1}
5008 % [Knuth] p. 382; only eat outer {}
5010 \catcode`
[=
1\catcode`
]=
2\catcode`\
{=
\other\catcode`\
}=
\other
5011 \gdef\doverb{#1[\def\next#
#1#1}[#
#1\endgroup]\next]
5014 \def\verb{\begingroup\setupverb\doverb}
5017 % Do the @verbatim magic: define the macro \doverbatim so that
5018 % the (first) argument ends when '@end verbatim' is reached, ie:
5020 % \def\doverbatim#1@end verbatim{#1}
5022 % For Texinfo it's a lot easier than for LaTeX,
5023 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
5024 % we need not redefine '\', '{' and '}'.
5026 % Inspired by LaTeX's verbatim command set [latex.ltx]
5031 % ignore everything up to the first ^^M, that's the newline at the end
5032 % of the @verbatim input line itself. Otherwise we get an extra blank
5033 % line in the output.
5034 \xdef\doverbatim#1^^M
#2@end verbatim
{#2\noexpand\end\gobble verbatim
}%
5035 % We really want {...\end verbatim} in the body of the macro, but
5036 % without the active space; thus we have to use \xdef and \gobble.
5040 \setupverbatim\doverbatim
5042 \let\Everbatim =
\afterenvbreak
5045 % @verbatiminclude FILE - insert text of file in verbatim environment.
5047 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
5049 \def\doverbatiminclude#1{%
5051 \makevalueexpandable
5058 % @copying ... @end copying.
5059 % Save the text away for @insertcopying later. Many commands won't be
5060 % allowed in this context, but that's ok.
5062 % We save the uninterpreted tokens, rather than creating a box.
5063 % Saving the text in a box would be much easier, but then all the
5064 % typesetting commands (@smallbook, font changes, etc.) have to be done
5065 % beforehand -- and a) we want @copying to be done first in the source
5066 % file; b) letting users define the frontmatter in as flexible order as
5067 % possible is very desirable.
5069 \def\copying{\begingroup
5070 % Define a command to swallow text until we reach `@end copying'.
5071 % \ is the escape char in this texinfo.tex file, so it is the
5072 % delimiter for the command; @ will be the escape char when we read
5073 % it, but that doesn't matter.
5074 \long\def\docopying#
#1\end copying
{\gdef\copyingtext{#
#1}\enddocopying}%
5076 % We must preserve ^^M's in the input file; see \insertcopying below.
5077 \catcode`\^^M =
\active
5081 % What we do to finish off the copying text.
5083 \def\enddocopying{\endgroup\ignorespaces}
5085 % @insertcopying. Here we must play games with ^^M's. On the one hand,
5086 % we need them to delimit commands such as `@end quotation', so they
5087 % must be active. On the other hand, we certainly don't want every
5088 % end-of-line to be a \par, as would happen with the normal active
5089 % definition of ^^M. On the third hand, two ^^M's in a row should still
5092 % Our approach is to make ^^M insert a space and a penalty1 normally;
5093 % then it can also check if \lastpenalty=1. If it does, then manually
5096 % This messes up the normal definitions of @c[omment], so we redefine
5097 % it. Similarly for @ignore. (These commands are used in the gcc
5098 % manual for man page generation.)
5100 % Seems pretty fragile, most line-oriented commands will presumably
5101 % fail, but for the limited use of getting the copying text (which
5102 % should be quite simple) inserted, we can hope it's ok.
5104 {\catcode`\^^M=
\active %
5105 \gdef\insertcopying{\begingroup %
5106 \parindent =
0pt
% looks wrong on title page
5108 \ifnum \lastpenalty=
1 %
5115 % Fix @c[omment] for catcode 13 ^^M's.
5116 \def\c#
#1^^M
{\ignorespaces}%
5119 % Don't bother jumping through all the hoops that \doignore does, it
5120 % would be very hard since the catcodes are already set.
5121 \long\def\ignore#
#1\end ignore
{\ignorespaces}%
5130 \newskip\defbodyindent \defbodyindent=
.4in
5131 \newskip\defargsindent \defargsindent=
50pt
5132 \newskip\deflastargmargin \deflastargmargin=
18pt
5134 % Start the processing of @deffn:
5136 \ifnum\lastpenalty<
10000
5139 % If there are two @def commands in a row, we'll have a \nobreak,
5140 % which is there to keep the function description together with its
5141 % header. But if there's nothing but headers, we need to allow a
5142 % break somewhere. Check for penalty 10002 (inserted by
5143 % \defargscommonending) instead of 10000, since the sectioning
5144 % commands insert a \penalty10000, and we don't want to allow a break
5145 % between a section heading and a defun.
5146 \ifnum\lastpenalty=
10002 \penalty2000 \fi
5148 % Similarly, after a section heading, do not allow a break.
5149 % But do insert the glue.
5150 \medskip % preceded by discardable penalty, so not a breakpoint
5154 \advance\leftskip by
\defbodyindent
5155 \exdentamount=
\defbodyindent
5159 % First, check whether we are in the right environment:
5162 % As above, allow line break if we have multiple x headers in a row.
5163 % It's not a great place, though.
5164 \ifnum\lastpenalty=
10002 \penalty3000 \fi
5166 % And now, it's time to reuse the body of the original defun:
5167 \expandafter\gobbledefun#1%
5169 \def\gobbledefun#1\startdefun{}
5171 % \printdefunline \deffnheader{text}
5173 \def\printdefunline#1#2{%
5175 % call \deffnheader:
5178 \interlinepenalty =
10000
5179 \advance\rightskip by
0pt plus
1fil
5181 \nobreak\vskip -
\parskip
5182 \penalty 10002 % signal to \startdefun and \dodefunx
5183 % Some of the @defun-type tags do not enable magic parentheses,
5184 % rendering the following check redundant. But we don't optimize.
5189 \def\Edefun{\endgraf\medbreak}
5191 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
5192 % the only thing remainnig is to define \deffnheader.
5195 \expandafter\let\csname E
#1\endcsname =
\Edefun
5196 \edef\temp{\noexpand\domakedefun
5197 \makecsname{#1}\makecsname{#1x
}\makecsname{#1header
}}%
5201 % \domakedefun \deffn \deffnx \deffnheader
5203 % Define \deffn and \deffnx, without parameters.
5204 % \deffnheader has to be defined explicitly.
5206 \def\domakedefun#1#2#3{%
5209 \parseargusing\activeparens{\printdefunline#3}%
5211 \def#2{\dodefunx#1}%
5215 %%% Untyped functions:
5217 % @deffn category name args
5218 \makedefun{deffn
}{\deffngeneral{}}
5220 % @deffn category class name args
5221 \makedefun{defop
}#1 {\defopon{#1\
\putwordon}}
5223 % \defopon {category on}class name args
5224 \def\defopon#1#2 {\deffngeneral{\putwordon\
\code{#2}}{#1\
\code{#2}} }
5226 % \deffngeneral {subind}category name args
5228 \def\deffngeneral#1#2 #3 #4\endheader{%
5229 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
5230 \dosubind{fn
}{\code{#3}}{#1}%
5231 \defname{#2}{}{#3}{(
}\magicamp\defunargs{#4\unskip}{)
}%
5234 %%% Typed functions:
5236 % @deftypefn category type name args
5237 \makedefun{deftypefn
}{\deftypefngeneral{}}
5239 % @deftypeop category class type name args
5240 \makedefun{deftypeop
}#1 {\deftypeopon{#1\
\putwordon}}
5242 % \deftypeopon {category on}class type name args
5243 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\
\code{#2}}{#1\
\code{#2}} }
5245 % \deftypefngeneral {subind}category type name args
5247 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
5248 \dosubind{fn
}{\code{#4}}{#1}%
5249 \defname{#2}{#3}{#4}{(
}\defunargs{#5\unskip}{)
}%
5252 %%% Typed variables:
5254 % @deftypevr category type var args
5255 \makedefun{deftypevr
}{\deftypecvgeneral{}}
5257 % @deftypecv category class type var args
5258 \makedefun{deftypecv
}#1 {\deftypecvof{#1\
\putwordof}}
5260 % \deftypecvof {category of}class type var args
5261 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\
\code{#2}}{#1\
\code{#2}} }
5263 % \deftypecvgeneral {subind}category type var args
5265 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
5266 \dosubind{vr
}{\code{#4}}{#1}%
5267 \defname{#2}{#3}{#4}{}\defunargs{#5\unskip}{}%
5270 %%% Untyped variables:
5272 % @defvr category var args
5273 \makedefun{defvr
}#1 {\deftypevrheader{#1} {} }
5275 % @defcv category class var args
5276 \makedefun{defcv
}#1 {\defcvof{#1\
\putwordof}}
5278 % \defcvof {category of}class var args
5279 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
5282 % @deftp category name args
5283 \makedefun{deftp
}#1 #2 #3\endheader{%
5284 \doind{tp
}{\code{#2}}%
5285 \defname{#1}{}{#2}{(
}\defunargs{#3\unskip}{)
}%
5288 % Remaining @defun-like shortcuts:
5289 \makedefun{defun
}{\deffnheader{\putwordDeffunc} }
5290 \makedefun{defmac
}{\deffnheader{\putwordDefmac} }
5291 \makedefun{defspec
}{\deffnheader{\putwordDefspec} }
5292 \makedefun{deftypefun
}{\deftypefnheader{\putwordDeffunc} }
5293 \makedefun{defvar
}{\defvrheader{\putwordDefvar} }
5294 \makedefun{defopt
}{\defvrheader{\putwordDefopt} }
5295 \makedefun{deftypevar
}{\deftypevrheader{\putwordDefvar} }
5296 \makedefun{defmethod
}{\defopon\putwordMethodon}
5297 \makedefun{deftypemethod
}{\deftypeopon\putwordMethodon}
5298 \makedefun{defivar
}{\defcvof\putwordInstanceVariableof}
5299 \makedefun{deftypeivar
}{\deftypecvof\putwordInstanceVariableof}
5301 % \defname, which formats the name of the @def (not the args).
5302 % #1 is the category, such as "Function".
5303 % #2 is the return type, if any.
5304 % #3 is the function name.
5307 % We are followed by (but not passed) the arguments, if any.
5309 \def\defname#1#2#3#4{%
5310 % Get the values of \leftskip and \rightskip as they were outside the @def...
5311 \advance\leftskip by -
\defbodyindent
5313 % How we'll format the type name. Putting it in brackets helps
5314 % distinguish it from the body text that may end up on the next line
5317 \setbox0=
\hbox{\kern\deflastargmargin \ifx\temp\empty\else \rm\temp\fi}
5319 % Figure out line sizes for the paragraph shape.
5320 % The first line needs space for \box0; but if \rightskip is nonzero,
5321 % we need only space for the part of \box0 which exceeds it:
5322 \dimen0=
\hsize \advance\dimen0 by -
\wd0 \advance\dimen0 by
\rightskip
5323 % The continuations:
5324 \dimen2=
\hsize \advance\dimen2 by -
\defargsindent
5325 % (plain.tex says that \dimen1 should be used only as global.)
5326 \parshape 2 0in
\dimen0 \defargsindent \dimen2
5328 % Put the type name to the right margin.
5331 \hfil\box0 \kern-
\hsize
5332 % \hsize has to be shortened this way:
5334 % Intentionally do not respect \rightskip, since we need the space.
5337 % Allow all lines to be underfull without complaint:
5338 \tolerance=
10000 \hbadness=
10000
5339 \exdentamount=
\defbodyindent
5341 % defun fonts. We use typewriter by default (used to be bold) because:
5342 % . we're printing identifiers, they should be in tt in principle.
5343 % . in languages with many accents, such as Czech or French, it's
5344 % common to leave accents off identifiers. The result looks ok in
5345 % tt, but exceedingly strange in rm.
5346 % . we don't want -- and --- to be treated as ligatures.
5347 % . this still does not fix the ?` and !` ligatures, but so far no
5348 % one has made identifiers using them :).
5350 \def\temp{#2}% return value type
5351 \ifx\temp\empty\else \tclose{\temp} \fi
5352 #4#3% output function name
5354 {\rm\enskip}% hskip 0.5 em of \tenrm
5357 % arguments will be output next, if any.
5360 % Print arguments in slanted roman (not ttsl), inconsistently with using
5361 % tt for the name. This is because literal text is sometimes needed in
5362 % the argument list (groff manual), and ttsl and tt are not very
5363 % distinguishable. Prevent hyphenation at `-' chars.
5365 \def\defunargs#1#2{%
5366 % use sl by default (not ttsl),
5368 \df \sl \hyphenchar\font=
0
5370 % On the other hand, if an argument has two dashes (for instance), we
5371 % want a way to get ttsl. Let's try @var for that.
5372 % \let\var=\ttslanted
5374 \sl\hyphenchar\font=
45{\tt#2}
5377 % We want ()&[] to print specially on the defun line.
5380 \catcode`\(=
\active \catcode`\)=
\active
5381 \catcode`\
[=
\active \catcode`\
]=
\active
5385 % Make control sequences which act like normal parenthesis chars.
5386 \let\lparen = (
\let\rparen = )
5388 % Be sure that we always have a definition for `(', etc. For example,
5389 % if the fn name has parens in it, \boldbrax will not be in effect yet,
5390 % so TeX would otherwise complain about undefined control sequence.
5393 \global\let(=
\lparen \global\let)=
\rparen
5394 \global\let[=
\lbrack \global\let]=
\rbrack
5397 \gdef\boldbrax{\let(=
\opnr\let)=
\clnr\let[=
\lbrb\let]=
\rbrb}
5398 \gdef\magicamp{\let&=
\amprm}
5401 \newcount\parencount
5403 % If we encounter &foo, then turn on ()-hacking afterwards
5405 \def\amprm#1 {\ampseentrue{\bf\&
#1 }}
5409 % At the first level, print parens in roman,
5410 % otherwise use the default font.
5411 \ifnum \parencount=
1 \rm \fi
5413 % The \sf parens (in \boldbrax) actually are a little bolder than
5414 % the contained text. This is especially needed for [ and ] .
5418 \def\infirstlevel#1{%
5425 \def\bfafterword#1 {#1 \bf}
5428 \global\advance\parencount by
1
5430 \infirstlevel \bfafterword
5435 \global\advance\parencount by -
1
5438 \newcount\brackcount
5440 \global\advance\brackcount by
1
5445 \global\advance\brackcount by -
1
5448 \def\checkparencounts{%
5449 \ifnum\parencount=
0 \else \badparencount \fi
5450 \ifnum\brackcount=
0 \else \badbrackcount \fi
5452 \def\badparencount{%
5453 \errmessage{Unbalanced parentheses in @def
}%
5454 \global\parencount=
0
5456 \def\badbrackcount{%
5457 \errmessage{Unbalanced square braces in @def
}%
5458 \global\brackcount=
0
5465 % To do this right we need a feature of e-TeX, \scantokens,
5466 % which we arrange to emulate with a temporary file in ordinary TeX.
5467 \ifx\eTeXversion\undefined
5468 \newwrite\macscribble
5470 \toks0=
{#1\endinput}%
5471 \immediate\openout\macscribble=
\jobname.tmp
5472 \immediate\write\macscribble{\the\toks0}%
5473 \immediate\closeout\macscribble
5481 \let\xeatspaces\eatspaces
5482 % Undo catcode changes of \startcontents and \doprintindex
5483 \catcode`\@=
0 \catcode`\\=
\other \escapechar=`\@
5487 % Append \endinput to make sure that TeX does not see the ending newline.
5489 % I've verified that it is necessary both for e-TeX and for ordinary TeX
5491 \scantokens{#1\endinput}%
5495 \newcount\paramno % Count of parameters
5496 \newtoks\macname % Macro name
5497 \newif\ifrecursive % Is it recursive?
5498 \def\macrolist{} % List of all defined macros in the form
5499 % \do\macro1\do\macro2...
5502 % This does \let #1 = #2, except with \csnames.
5504 \expandafter\expandafter
5506 \expandafter\expandafter
5508 \csname#2\endcsname}
5510 % Trim leading and trailing spaces off a string.
5511 % Concepts from aro-bend problem 15 (see CTAN).
5513 \gdef\eatspaces #1{\expandafter\trim@
\expandafter{#1 }}
5514 \gdef\trim@
#1{\trim@@ @
#1 @
#1 @ @@
}
5515 \gdef\trim@@
#1@
#2@
#3@@
{\trim@@@
\empty #2 @
}
5517 \unbrace{\gdef\trim@@@
#1 } #2@
{#1}
5520 % Trim a single trailing ^^M off a string.
5521 {\catcode`\^^M=
\other \catcode`
\Q=
3%
5522 \gdef\eatcr #1{\eatcra #1Q^^MQ
}%
5523 \gdef\eatcra#1^^MQ
{\eatcrb#1Q
}%
5524 \gdef\eatcrb#1Q
#2Q
{#1}%
5527 % Macro bodies are absorbed as an argument in a context where
5528 % all characters are catcode 10, 11 or 12, except \ which is active
5529 % (as in normal texinfo). It is necessary to change the definition of \.
5531 % It's necessary to have hard CRs when the macro is executed. This is
5532 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
5533 % body, and then making it the \newlinechar in \scanmacro.
5535 \def\macrobodyctxt{%
5546 \catcode`\^^M=
\other
5560 % \mbodybackslash is the definition of \ in @macro bodies.
5561 % It maps \foo\ => \csname macarg.foo\endcsname => #N
5562 % where N is the macro parameter number.
5563 % We define \csname macarg.\endcsname to be \realbackslash, so
5564 % \\ in macro replacement text gets you a backslash.
5566 {\catcode`@=
0 @catcode`@\=@active
5567 @gdef@usembodybackslash
{@let\=@mbodybackslash
}
5568 @gdef@mbodybackslash
#1\
{@csname macarg.
#1@endcsname
}
5570 \expandafter\def\csname macarg.
\endcsname{\realbackslash}
5572 \def\macro{\recursivefalse\parsearg\macroxxx}
5573 \def\rmacro{\recursivetrue\parsearg\macroxxx}
5576 \getargs{#1}% now \macname is the macname and \argl the arglist
5577 \ifx\argl\empty % no arguments
5580 \expandafter\parsemargdef \argl;
%
5582 \if1\csname ismacro.
\the\macname\endcsname
5583 \message{Warning: redefining
\the\macname}%
5585 \expandafter\ifx\csname \the\macname\endcsname \relax
5586 \else \errmessage{Macro name
\the\macname\space already defined
}\fi
5587 \global\cslet{macsave.
\the\macname}{\the\macname}%
5588 \global\expandafter\let\csname ismacro.
\the\macname\endcsname=
1%
5589 % Add the macroname to \macrolist
5590 \toks0 =
\expandafter{\macrolist\do}%
5591 \xdef\macrolist{\the\toks0
5592 \expandafter\noexpand\csname\the\macname\endcsname}%
5594 \begingroup \macrobodyctxt
5595 \ifrecursive \expandafter\parsermacbody
5596 \else \expandafter\parsemacbody
5599 \parseargdef\unmacro{%
5600 \if1\csname ismacro.
#1\endcsname
5601 \global\cslet{#1}{macsave.
#1}%
5602 \global\expandafter\let \csname ismacro.
#1\endcsname=
0%
5603 % Remove the macro name from \macrolist:
5605 \expandafter\let\csname#1\endcsname \relax
5607 \xdef\macrolist{\macrolist}%
5610 \errmessage{Macro
#1 not defined
}%
5614 % Called by \do from \dounmacro on each macro. The idea is to omit any
5615 % macro definitions that have been changed to \relax.
5621 \noexpand\do \noexpand #1%
5625 % This makes use of the obscure feature that if the last token of a
5626 % <parameter list> is #, then the preceding argument is delimited by
5627 % an opening brace, and that opening brace is not consumed.
5628 \def\getargs#1{\getargsxxx#1{}}
5629 \def\getargsxxx#1#
{\getmacname #1 \relax\getmacargs}
5630 \def\getmacname #1 #2\relax{\macname=
{#1}}
5631 \def\getmacargs#1{\def\argl{#1}}
5633 % Parse the optional {params} list. Set up \paramno and \paramlist
5634 % so \defmacro knows what to do. Define \macarg.blah for each blah
5635 % in the params list, to be ##N where N is the position in that list.
5636 % That gets used by \mbodybackslash (above).
5638 % We need to get `macro parameter char #' into several definitions.
5639 % The technique used is stolen from LaTeX: let \hash be something
5640 % unexpandable, insert that wherever you need a #, and then redefine
5641 % it to # just before using the token list produced.
5643 % The same technique is used to protect \eatspaces till just before
5644 % the macro is used.
5646 \def\parsemargdef#1;
{\paramno=
0\def\paramlist{}%
5647 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,
}
5648 \def\parsemargdefxxx#1,
{%
5649 \if#1;
\let\next=
\relax
5650 \else \let\next=
\parsemargdefxxx
5651 \advance\paramno by
1%
5652 \expandafter\edef\csname macarg.
\eatspaces{#1}\endcsname
5653 {\xeatspaces{\hash\the\paramno}}%
5654 \edef\paramlist{\paramlist\hash\the\paramno,
}%
5657 % These two commands read recursive and nonrecursive macro bodies.
5658 % (They're different since rec and nonrec macros end differently.)
5660 \long\def\parsemacbody#1@end macro
%
5661 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5662 \long\def\parsermacbody#1@end rmacro
%
5663 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
5665 % This defines the macro itself. There are six cases: recursive and
5666 % nonrecursive macros of zero, one, and many arguments.
5667 % Much magic with \expandafter here.
5668 % \xdef is used so that macro definitions will survive the file
5669 % they're defined in; @include reads the file inside a group.
5671 \let\hash=##
% convert placeholders to macro parameter chars
5675 \expandafter\xdef\csname\the\macname\endcsname{%
5676 \noexpand\scanmacro{\temp}}%
5678 \expandafter\xdef\csname\the\macname\endcsname{%
5679 \bgroup\noexpand\macroargctxt
5680 \noexpand\braceorline
5681 \expandafter\noexpand\csname\the\macname xxx
\endcsname}%
5682 \expandafter\xdef\csname\the\macname xxx
\endcsname#
#1{%
5683 \egroup\noexpand\scanmacro{\temp}}%
5685 \expandafter\xdef\csname\the\macname\endcsname{%
5686 \bgroup\noexpand\macroargctxt
5687 \noexpand\csname\the\macname xx
\endcsname}%
5688 \expandafter\xdef\csname\the\macname xx
\endcsname#
#1{%
5689 \expandafter\noexpand\csname\the\macname xxx
\endcsname #
#1,
}%
5690 \expandafter\expandafter
5692 \expandafter\expandafter
5693 \csname\the\macname xxx
\endcsname
5694 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
5699 \expandafter\xdef\csname\the\macname\endcsname{%
5700 \noexpand\norecurse{\the\macname}%
5701 \noexpand\scanmacro{\temp}\egroup}%
5703 \expandafter\xdef\csname\the\macname\endcsname{%
5704 \bgroup\noexpand\macroargctxt
5705 \noexpand\braceorline
5706 \expandafter\noexpand\csname\the\macname xxx
\endcsname}%
5707 \expandafter\xdef\csname\the\macname xxx
\endcsname#
#1{%
5709 \noexpand\norecurse{\the\macname}%
5710 \noexpand\scanmacro{\temp}\egroup}%
5712 \expandafter\xdef\csname\the\macname\endcsname{%
5713 \bgroup\noexpand\macroargctxt
5714 \expandafter\noexpand\csname\the\macname xx
\endcsname}%
5715 \expandafter\xdef\csname\the\macname xx
\endcsname#
#1{%
5716 \expandafter\noexpand\csname\the\macname xxx
\endcsname #
#1,
}%
5717 \expandafter\expandafter
5719 \expandafter\expandafter
5720 \csname\the\macname xxx
\endcsname
5723 \noexpand\norecurse{\the\macname}%
5724 \noexpand\scanmacro{\temp}\egroup}%
5728 \def\norecurse#1{\bgroup\cslet{#1}{macsave.
#1}}
5730 % \braceorline decides whether the next nonwhitespace character is a
5731 % {. If so it reads up to the closing }, if not, it reads the whole
5732 % line. Whatever was read is then fed to the next control sequence
5733 % as an argument (by \parsebrace or \parsearg)
5734 \def\braceorline#1{\let\next=
#1\futurelet\nchar\braceorlinexxx}
5735 \def\braceorlinexxx{%
5736 \ifx\nchar\bgroup\else
5737 \expandafter\parsearg
5740 % We mant to disable all macros during \shipout so that they are not
5741 % expanded by \write.
5742 \def\turnoffmacros{\begingroup \def\do#
#1{\let\noexpand#
#1=
\relax}%
5743 \edef\next{\macrolist}\expandafter\endgroup\next}
5747 % We need some trickery to remove the optional spaces around the equal
5748 % sign. Just make them active and then expand them all to nothing.
5749 \def\alias{\parseargusing\obeyspaces\aliasxxx}
5750 \def\aliasxxx #1{\aliasyyy#1\relax}
5751 \def\aliasyyy #1=
#2\relax{%
5753 \expandafter\let\obeyedspace=
\empty
5754 \xdef\next{\global\let\makecsname{#1}=
\makecsname{#2}}%
5760 \message{cross references,
}
5764 \newif\ifhavexrefs % True if xref values are known.
5765 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
5767 % @inforef is relatively simple.
5768 \def\inforef #1{\inforefzzz #1,,,,**
}
5769 \def\inforefzzz #1,
#2,
#3,
#4**
{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
5770 node
\samp{\ignorespaces#1{}}}
5772 % @node's only job in TeX is to define \lastnode, which is used in
5773 % cross-references. The @node line might or might not have commas, and
5774 % might or might not have spaces before the first comma, like:
5775 % @node foo , bar , ...
5776 % We don't want such trailing spaces in the node name.
5778 \parseargdef\node{\checkenv{}\donode #1 ,
\finishnodeparse}
5780 % also remove a trailing comma, in case of something like this:
5781 % @node Help-Cross, , , Cross-refs
5782 \def\donode#1 ,
#2\finishnodeparse{\dodonode #1,
\finishnodeparse}
5783 \def\dodonode#1,
#2\finishnodeparse{\gdef\lastnode{#1}}
5786 \let\lastnode=
\empty
5788 % Write a cross-reference definition for the current node. #1 is the
5789 % type (Ynumbered, Yappendix, Ynothing).
5792 \ifx\lastnode\empty\else
5793 \setref{\lastnode}{#1}%
5794 \global\let\lastnode=
\empty
5798 % @anchor{NAME} -- define xref target at arbitrary point.
5800 \newcount\savesfregister
5802 \def\savesf{\relax \ifhmode \savesfregister=
\spacefactor \fi}
5803 \def\restoresf{\relax \ifhmode \spacefactor=
\savesfregister \fi}
5804 \def\anchor#1{\savesf \setref{#1}{Ynothing
}\restoresf \ignorespaces}
5806 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
5807 % anchor), which consists of three parts:
5808 % 1) NAME-title - the current sectioning name taken from \thissection,
5809 % or the anchor name.
5810 % 2) NAME-snt - section number and type, passed as the SNT arg, or
5811 % empty for anchors.
5812 % 3) NAME-pg - the page number.
5814 % This is called from \donoderef, \anchor, and \dofloat. In the case of
5815 % floats, there is an additional part, which is not written here:
5816 % 4) NAME-lof - the text as it should appear in a @listoffloats.
5822 \atdummies % preserve commands, but don't expand them
5825 \edef\writexrdef#
#1#
#2{%
5826 \write\auxfile{@xrdef
{#1-
% #1 of \setref, expanded by the \edef
5827 #
#1}{#
#2}}% these are parameters of \writexrdef
5829 \toks0 =
\expandafter{\thissection}%
5830 \immediate \writexrdef{title
}{\the\toks0 }%
5831 \immediate \writexrdef{snt
}{\csname #2\endcsname}% \Ynumbered etc.
5832 \writexrdef{pg
}{\folio}% will be written later, during \shipout
5837 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
5838 % the node name, #2 the name of the Info cross-reference, #3 the printed
5839 % node name, #4 the name of the Info file, #5 the name of the printed
5840 % manual. All but the node name can be omitted.
5842 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,
]}
5843 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,
]}
5844 \def\ref#1{\xrefX[#1,,,,,,,
]}
5845 \def\xrefX[#1,
#2,
#3,
#4,
#5,
#6]{\begingroup
5847 \def\printedmanual{\ignorespaces #5}%
5848 \def\printedrefname{\ignorespaces #3}%
5849 \setbox1=
\hbox{\printedmanual\unskip}%
5850 \setbox0=
\hbox{\printedrefname\unskip}%
5852 % No printed node name was explicitly given.
5853 \expandafter\ifx\csname SETxref-automatic-section-title
\endcsname\relax
5854 % Use the node name inside the square brackets.
5855 \def\printedrefname{\ignorespaces #1}%
5857 % Use the actual chapter/section title appear inside
5858 % the square brackets. Use the real section title if we have it.
5860 % It is in another manual, so we don't have it.
5861 \def\printedrefname{\ignorespaces #1}%
5864 % We know the real title if we have the xref values.
5865 \def\printedrefname{\refx{#1-title
}{}}%
5867 % Otherwise just copy the Info node name.
5868 \def\printedrefname{\ignorespaces #1}%
5874 % Make link in pdf output.
5878 {\turnoffactive \otherbackslash
5879 \ifnum\filenamelength>
0
5880 \startlink attr
{/Border
[0 0 0]}%
5881 goto file
{\the\filename.pdf
} name
{#1}%
5883 \startlink attr
{/Border
[0 0 0]}%
5884 goto name
{\pdfmkpgn{#1}}%
5890 % Float references are printed completely differently: "Figure 1.2"
5891 % instead of "[somenode], p.3". We distinguish them by the
5892 % LABEL-title being set to a magic string.
5894 % Have to otherify everything special to allow the \csname to
5895 % include an _ in the xref name, etc.
5899 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
5900 \csname XR
#1-title
\endcsname
5902 \iffloat\Xthisreftitle
5903 % If the user specified the print name (third arg) to the ref,
5904 % print it instead of our usual "Figure 1.2".
5911 % if the user also gave the printed manual name (fifth arg), append
5914 \space \putwordin{} \cite{\printedmanual}%
5917 % node/anchor (non-float) references.
5919 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
5920 % insert empty discretionaries after hyphens, which means that it will
5921 % not find a line break at a hyphen in a node names. Since some manuals
5922 % are best written with fairly long node names, containing hyphens, this
5923 % is a loss. Therefore, we give the text of the node name again, so it
5924 % is as if TeX is seeing it for the first time.
5926 \putwordsection{} ``
\printedrefname''
\putwordin{} \cite{\printedmanual}%
5928 % _ (for example) has to be the character _ for the purposes of the
5929 % control sequence corresponding to the node, but it has to expand
5930 % into the usual \leavevmode...\vrule stuff for purposes of
5931 % printing. So we \turnoffactive for the \refx-snt, back on for the
5932 % printing, back off for the \refx-pg.
5933 {\turnoffactive \otherbackslash
5934 % Only output a following space if the -snt ref is nonempty; for
5935 % @unnumbered and @anchor, it won't be.
5936 \setbox2 =
\hbox{\ignorespaces \refx{#1-snt
}{}}%
5937 \ifdim \wd2 >
0pt
\refx{#1-snt
}\space\fi
5939 % output the `[mynode]' via a macro so it can be overridden.
5940 \xrefprintnodename\printedrefname
5942 % But we always want a comma and a space:
5945 % output the `page 3'.
5946 \turnoffactive \otherbackslash \putwordpage\tie\refx{#1-pg
}{}%
5952 % This macro is called from \xrefX for the `[nodename]' part of xref
5953 % output. It's a separate macro only so it can be changed more easily,
5954 % since square brackets don't work well in some documents. Particularly
5955 % one that Bob is working on :).
5957 \def\xrefprintnodename#1{[#1]}
5959 % Things referred to by \setref.
5965 \putwordChapter@tie
\the\chapno
5966 \else \ifnum\subsecno=
0
5967 \putwordSection@tie
\the\chapno.
\the\secno
5968 \else \ifnum\subsubsecno=
0
5969 \putwordSection@tie
\the\chapno.
\the\secno.
\the\subsecno
5971 \putwordSection@tie
\the\chapno.
\the\secno.
\the\subsecno.
\the\subsubsecno
5976 \putwordAppendix@tie @char
\the\appendixno{}%
5977 \else \ifnum\subsecno=
0
5978 \putwordSection@tie @char
\the\appendixno.
\the\secno
5979 \else \ifnum\subsubsecno=
0
5980 \putwordSection@tie @char
\the\appendixno.
\the\secno.
\the\subsecno
5983 @char
\the\appendixno.
\the\secno.
\the\subsecno.
\the\subsubsecno
5987 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
5988 % If its value is nonempty, SUFFIX is output afterward.
5994 \expandafter\global\expandafter\let\expandafter\thisrefX
5995 \csname XR
#1\endcsname
5998 % If not defined, say something at least.
5999 \angleleft un\-de\-fined
\angleright
6002 \message{\linenumber Undefined cross reference `
#1'.
}%
6005 \global\warnedxrefstrue
6006 \message{Cross reference values unknown; you must run TeX again.
}%
6011 % It's defined, so just use it.
6014 #2% Output the suffix in any case.
6017 % This is the macro invoked by entries in the aux file. Usually it's
6018 % just a \def (we prepend XR to the control sequence name to avoid
6019 % collisions). But if this is a float type, we have more work to do.
6022 \expandafter\gdef\csname XR
#1\endcsname{#2}% remember this xref value.
6024 % Was that xref control sequence that we just defined for a float?
6025 \expandafter\iffloat\csname XR
#1\endcsname
6026 % it was a float, and we have the (safe) float type in \iffloattype.
6027 \expandafter\let\expandafter\floatlist
6028 \csname floatlist
\iffloattype\endcsname
6030 % Is this the first time we've seen this float type?
6031 \expandafter\ifx\floatlist\relax
6032 \toks0 =
{\do}% yes, so just \do
6034 % had it before, so preserve previous elements in list.
6035 \toks0 =
\expandafter{\floatlist\do}%
6038 % Remember this xref in the control sequence \floatlistFLOATTYPE,
6039 % for later use in \listoffloats.
6040 \expandafter\xdef\csname floatlist
\iffloattype\endcsname{\the\toks0{#1}}%
6044 % Read the last existing aux file, if any. No error if none exists.
6047 \openin 1 \jobname.aux
6050 \global\havexrefstrue
6055 \def\readauxfile{\begingroup
6056 \catcode`\^^@=
\other
6057 \catcode`\^^A=
\other
6058 \catcode`\^^B=
\other
6059 \catcode`\^^C=
\other
6060 \catcode`\^^D=
\other
6061 \catcode`\^^E=
\other
6062 \catcode`\^^F=
\other
6063 \catcode`\^^G=
\other
6064 \catcode`\^^H=
\other
6065 \catcode`\^^K=
\other
6066 \catcode`\^^L=
\other
6067 \catcode`\^^N=
\other
6068 \catcode`\^^P=
\other
6069 \catcode`\^^Q=
\other
6070 \catcode`\^^R=
\other
6071 \catcode`\^^S=
\other
6072 \catcode`\^^T=
\other
6073 \catcode`\^^U=
\other
6074 \catcode`\^^V=
\other
6075 \catcode`\^^W=
\other
6076 \catcode`\^^X=
\other
6077 \catcode`\^^Z=
\other
6078 \catcode`\^^
[=
\other
6079 \catcode`\^^\=
\other
6080 \catcode`\^^
]=
\other
6081 \catcode`\^^^=
\other
6082 \catcode`\^^_=
\other
6083 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
6084 % in xref tags, i.e., node names. But since ^^e4 notation isn't
6085 % supported in the main text, it doesn't seem desirable. Furthermore,
6086 % that is not enough: for node names that actually contain a ^
6087 % character, we would end up writing a line like this: 'xrdef {'hat
6088 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
6089 % argument, and \hat is not an expandable control sequence. It could
6090 % all be worked out, but why? Either we support ^^ or we don't.
6092 % The other change necessary for this was to define \auxhat:
6093 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
6094 % and then to call \auxhat in \setq.
6098 % Special characters. Should be turned off anyway, but...
6111 \catcode`+=
\other % avoid \+ for paranoia even though we've turned it off
6113 % This is to support \ in node names and titles, since the \
6114 % characters end up in a \csname. It's easier than
6115 % leaving it active and making its active definition an actual \
6116 % character. What I don't understand is why it works in the *value*
6117 % of the xrdef. Seems like it should be a catcode12 \, and that
6118 % should not typeset properly. But it works, so I'm moving on for
6119 % now. --karl, 15jan04.
6122 % Make the characters 128-255 be printing characters.
6126 \catcode\count 1=
\other
6127 \advance\count 1 by
1
6128 \ifnum \count 1<
256 \loop \fi
6132 % @ is our escape character in .aux files, and we need braces.
6141 \message{insertions,
}
6142 % including footnotes.
6144 \newcount \footnoteno
6146 % The trailing space in the following definition for supereject is
6147 % vital for proper filling; pages come out unaligned when you do a
6148 % pagealignmacro call if that space before the closing brace is
6149 % removed. (Generally, numeric constants should always be followed by a
6150 % space to prevent strange expansion errors.)
6151 \def\supereject{\par\penalty -
20000\footnoteno =
0 }
6153 % @footnotestyle is meaningful for info output only.
6154 \let\footnotestyle=
\comment
6158 % Auto-number footnotes. Otherwise like plain.
6160 \let\indent=
\ptexindent
6161 \let\noindent=
\ptexnoindent
6162 \global\advance\footnoteno by \@ne
6163 \edef\thisfootno{$^
{\the\footnoteno}$
}%
6165 % In case the footnote comes at the end of a sentence, preserve the
6166 % extra spacing after we do the footnote number.
6168 \ifhmode\edef\@sf
{\spacefactor\the\spacefactor}\ptexslash\fi
6170 % Remove inadvertent blank space before typesetting the footnote number.
6176 % Don't bother with the trickery in plain.tex to not require the
6177 % footnote text as a parameter. Our footnotes don't need to be so general.
6179 % Oh yes, they do; otherwise, @ifset (and anything else that uses
6180 % \parseargline) fails inside footnotes because the tokens are fixed when
6181 % the footnote is read. --karl, 16nov96.
6184 \insert\footins\bgroup
6185 % We want to typeset this text as a normal paragraph, even if the
6186 % footnote reference occurs in (for example) a display environment.
6187 % So reset some parameters.
6189 \interlinepenalty\interfootnotelinepenalty
6190 \splittopskip\ht\strutbox % top baseline for broken footnotes
6191 \splitmaxdepth\dp\strutbox
6192 \floatingpenalty\@MM
6197 \parindent\defaultparindent
6201 % Because we use hanging indentation in footnotes, a @noindent appears
6202 % to exdent this text, so make it be a no-op. makeinfo does not use
6203 % hanging indentation so @noindent can still be needed within footnote
6204 % text after an @example or the like (not that this is good style).
6205 \let\noindent =
\relax
6207 % Hang the footnote text off the number. Use \everypar in case the
6208 % footnote extends for more than one paragraph.
6209 \everypar =
{\hang}%
6210 \textindent{\thisfootno}%
6212 % Don't crash into the line above the footnote text. Since this
6213 % expands into a box, it must come within the paragraph, lest it
6214 % provide a place where TeX can split the footnote.
6216 \futurelet\next\fo@t
6218 }%end \catcode `\@=11
6220 % In case a @footnote appears in a vbox, save the footnote text and create
6221 % the real \insert just after the vbox finished. Otherwise, the insertion
6223 % Similarily, if a @footnote appears inside an alignment, save the footnote
6224 % text to a box and make the \insert when a row of the table is finished.
6225 % And the same can be done for other insert classes. --kasal, 16nov03.
6227 % Replace the \insert primitive by a cheating macro.
6228 % Deeper inside, just make sure that the saved insertions are not spilled
6231 \def\startsavinginserts{%
6232 \ifx \insert\ptexinsert
6233 \let\insert\saveinsert
6235 \let\checkinserts\relax
6239 % This \insert replacement works for both \insert\footins{foo} and
6240 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
6243 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
6244 \afterassignment\next
6245 % swallow the left brace
6248 \def\makeSAVEname#1{\makecsname{SAVE
\expandafter\gobble\string#1}}
6249 \def\savetobox#1{\global\setbox#1 =
\vbox\bgroup \unvbox#1}
6251 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
6253 \def\placesaveins#1{%
6254 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
6258 % eat @SAVE -- beware, all of them have catcode \other:
6260 \def\dospecials{\do S
\do A
\do V
\do E
} \uncatcodespecials % ;-)
6261 \gdef\gobblesave @SAVE
{}
6265 \def\newsaveins #1{%
6266 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
6269 \def\newsaveinsX #1{%
6270 \csname newbox
\endcsname #1%
6271 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
6276 \let\checkinserts\empty
6281 % @image. We use the macros from epsf.tex to support this.
6282 % If epsf.tex is not installed and @image is used, we complain.
6284 % Check for and read epsf.tex up front. If we read it only at @image
6285 % time, we might be inside a group, and then its definitions would get
6286 % undone and the next image would fail.
6287 \openin 1 = epsf.tex
6289 % Do not bother showing banner with epsf.tex v2.7k (available in
6290 % doc/epsf.tex and on ctan).
6291 \def\epsfannounce{\toks0 =
}%
6296 % We will only complain once about lack of epsf.tex.
6297 \newif\ifwarnednoepsf
6298 \newhelp\noepsfhelp{epsf.tex must be installed for images to
6299 work. It is also included in the Texinfo distribution, or you can get
6300 it from ftp://tug.org/tex/epsf.tex.
}
6303 \ifx\epsfbox\undefined
6304 \ifwarnednoepsf \else
6305 \errhelp =
\noepsfhelp
6306 \errmessage{epsf.tex not found, images will be ignored
}%
6307 \global\warnednoepsftrue
6310 \imagexxx #1,,,,,
\finish
6314 % Arguments to @image:
6315 % #1 is (mandatory) image filename; we tack on .eps extension.
6316 % #2 is (optional) width, #3 is (optional) height.
6317 % #4 is (ignored optional) html alt text.
6318 % #5 is (ignored optional) extension.
6319 % #6 is just the usual extra ignored arg for parsing this stuff.
6321 \def\imagexxx#1,
#2,
#3,
#4,
#5,
#6\finish{\begingroup
6322 \catcode`\^^M =
5 % in case we're inside an example
6323 \normalturnoffactive % allow _ et al. in names
6324 % If the image is by itself, center it.
6328 % Usually we'll have text after the image which will insert
6329 % \parskip glue, so insert it here too to equalize the space
6331 \nobreak\vskip\parskip
6338 \dopdfimage{#1}{#2}{#3}%
6340 % \epsfbox itself resets \epsf?size at each figure.
6341 \setbox0 =
\hbox{\ignorespaces #2}\ifdim\wd0 >
0pt
\epsfxsize=
#2\relax \fi
6342 \setbox0 =
\hbox{\ignorespaces #3}\ifdim\wd0 >
0pt
\epsfysize=
#3\relax \fi
6346 \ifimagevmode \hss \egroup \bigbreak \fi % space after the image
6350 % @float FLOATTYPE,LOC ... @end float for displayed figures, tables, etc.
6351 % We don't actually implement floating yet, we just plop the float "here".
6352 % But it seemed the best name for the future.
6354 \envparseargdef\float{\dofloat #1,,,
\finish}
6356 % #1 is the optional FLOATTYPE, the text label for this float, typically
6357 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
6358 % this float will not be numbered and cannot be referred to.
6360 % #2 is the optional xref label. Also must be present for the float to
6363 % #3 is the optional positioning argument; for now, it is ignored. It
6364 % will somehow specify the positions allowed to float to (here, top, bottom).
6366 % We keep a separate counter for each FLOATTYPE, which we reset at each
6367 % chapter-level command.
6368 \let\resetallfloatnos=
\empty
6370 \def\dofloat#1,
#2,
#3,
#4\finish{%
6371 \let\thiscaption=
\empty
6372 \let\thisshortcaption=
\empty
6374 % don't lose footnotes inside @float.
6377 % We can't be used inside a paragraph.
6382 \def\floatlabel{#2}%
6383 \def\floatloc{#3}% we do nothing with this yet.
6385 \ifx\floattype\empty
6386 \let\safefloattype=
\empty
6389 % the floattype might have accents or other special characters,
6390 % but we need to use it in a control sequence name.
6393 \xdef\safefloattype{\floattype}%
6397 % If label is given but no type, we handle that as the empty type.
6398 \ifx\floatlabel\empty \else
6399 % We want each FLOATTYPE to be numbered separately (Figure 1,
6400 % Table 1, Figure 2, ...). (And if no label, no number.)
6402 \expandafter\getfloatno\csname\safefloattype floatno
\endcsname
6403 \global\advance\floatno by
1
6406 % This magic value for \thissection is output by \setref as the
6407 % XREFLABEL-title value. \xrefX uses it to distinguish float
6408 % labels (which have a completely different output format) from
6409 % node and anchor labels. And \xrdef uses it to construct the
6412 \edef\thissection{\floatmagic=
\safefloattype}%
6413 \setref{\floatlabel}{Yfloat
}%
6417 % start with \parskip glue, I guess.
6420 % Don't suppress indentation if a float happens to start a section.
6421 \restorefirstparagraphindent
6424 % we have these possibilities:
6425 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
6426 % @float Foo,lbl & no caption: Foo 1.1
6427 % @float Foo & @caption{Cap}: Foo: Cap
6428 % @float Foo & no caption: Foo
6429 % @float ,lbl & Caption{Cap}: 1.1: Cap
6430 % @float ,lbl & no caption: 1.1
6431 % @float & @caption{Cap}: Cap
6432 % @float & no caption:
6435 \let\floatident =
\empty
6437 % In all cases, if we have a float type, it comes first.
6438 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
6440 % If we have an xref label, the number comes next.
6441 \ifx\floatlabel\empty \else
6442 \ifx\floattype\empty \else % if also had float type, need tie first.
6443 \appendtomacro\floatident{\tie}%
6446 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
6449 % Start the printed caption with what we've constructed in
6450 % \floatident, but keep it separate; we need \floatident again.
6451 \let\captionline =
\floatident
6453 \ifx\thiscaption\empty \else
6454 \ifx\floatident\empty \else
6455 \appendtomacro\captionline{:
}% had ident, so need a colon between
6459 \appendtomacro\captionline\thiscaption
6462 % If we have anything to print, print it, with space before.
6463 % Eventually this needs to become an \insert.
6464 \ifx\captionline\empty \else
6469 % If have an xref label, write the list of floats info. Do this
6470 % after the caption, to avoid chance of it being a breakpoint.
6471 \ifx\floatlabel\empty \else
6472 % Write the text that goes in the lof to the aux file as
6473 % \floatlabel-lof. Besides \floatident, we include the short
6474 % caption if specified, else the full caption if specified, else nothing.
6476 \atdummies \turnoffactive \otherbackslash
6477 \immediate\write\auxfile{@xrdef
{\floatlabel-lof
}{%
6479 \ifx\thisshortcaption\empty
6480 \ifx\thiscaption\empty \else :
\thiscaption \fi
6488 % Space below caption, if we printed anything.
6489 \ifx\printedsomething\empty \else \vskip\parskip \fi
6490 \egroup % end of \vtop
6494 % Append the tokens #2 to the definition of macro #1, not expanding either.
6496 \newtoks\appendtomacroAtoks
6497 \newtoks\appendtomacroBtoks
6498 \def\appendtomacro#1#2{%
6499 \appendtomacroAtoks =
\expandafter{#1}%
6500 \appendtomacroBtoks =
{#2}%
6501 \edef#1{\the\appendtomacroAtoks \the\appendtomacroBtoks}%
6504 % @caption, @shortcaption are easy.
6506 \long\def\caption#1{\checkenv\float \def\thiscaption{#1}}
6507 \def\shortcaption#1{\checkenv\float \def\thisshortcaption{#1}}
6509 % The parameter is the control sequence identifying the counter we are
6510 % going to use. Create it if it doesn't exist and assign it to \floatno.
6513 % Haven't seen this figure type before.
6514 \csname newcount
\endcsname #1%
6516 % Remember to reset this floatno at the next chap.
6517 \expandafter\gdef\expandafter\resetallfloatnos
6518 \expandafter{\resetallfloatnos #1=
0 }%
6523 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
6524 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
6525 % first read the @float command.
6527 \def\Yfloat{\floattype@tie
\chaplevelprefix\the\floatno}%
6529 % Magic string used for the XREFLABEL-title value, so \xrefX can
6530 % distinguish floats from other xref types.
6531 \def\floatmagic{!!float!!
}
6533 % #1 is the control sequence we are passed; we expand into a conditional
6534 % which is true if #1 represents a float ref. That is, the magic
6535 % \thissection value which we \setref above.
6537 \def\iffloat#1{\expandafter\doiffloat#1==
\finish}
6539 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
6540 % (safe) float type for this float. We set \iffloattype to #2.
6542 \def\doiffloat#1=
#2=
#3\finish{%
6544 \def\iffloattype{#2}%
6545 \ifx\temp\floatmagic
6548 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
6550 \parseargdef\listoffloats{%
6551 \def\floattype{#1}% floattype
6553 % the floattype might have accents or other special characters,
6554 % but we need to use it in a control sequence name.
6557 \xdef\safefloattype{\floattype}%
6560 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
6561 \expandafter\ifx\csname floatlist
\safefloattype\endcsname \relax
6563 % if the user said @listoffloats foo but never @float foo.
6564 \message{\linenumber No `
\safefloattype' floats to list.
}%
6568 \leftskip=
\tocindent % indent these entries like a toc
6569 \let\do=
\listoffloatsdo
6570 \csname floatlist
\safefloattype\endcsname
6575 % This is called on each entry in a list of floats. We're passed the
6576 % xref label, in the form LABEL-title, which is how we save it in the
6577 % aux file. We strip off the -title and look up \XRLABEL-lof, which
6578 % has the text we're supposed to typeset here.
6580 % Figures without xref labels will not be included in the list (since
6581 % they won't appear in the aux file).
6583 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
6584 \def\listoffloatsdoentry#1-title
\finish{{%
6585 % Can't fully expand XR#1-lof because it can contain anything. Just
6586 % pass the control sequence. On the other hand, XR#1-pg is just the
6587 % page number, and we want to fully expand that so we can get a link
6589 \toksA =
\expandafter{\csname XR
#1-lof
\endcsname}%
6591 % use the same \entry macro we use to generate the TOC and index.
6592 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR
#1-pg
\endcsname}}%
6596 \message{localization,
}
6599 % @documentlanguage is usually given very early, just after
6600 % @setfilename. If done too late, it may not override everything
6601 % properly. Single argument is the language abbreviation.
6602 % It would be nice if we could set up a hyphenation file here.
6604 \parseargdef\documentlanguage{%
6605 \tex % read txi-??.tex file in plain TeX.
6606 % Read the file if it exists.
6607 \openin 1 txi-
#1.tex
6609 \errhelp =
\nolanghelp
6610 \errmessage{Cannot read language file txi-
#1.tex
}%
6617 \newhelp\nolanghelp{The given language definition file cannot be found or
6618 is empty. Maybe you need to install it? In the current directory
6619 should work if nowhere else does.
}
6622 % @documentencoding should change something in TeX eventually, most
6623 % likely, but for now just recognize it.
6624 \let\documentencoding =
\comment
6627 % Page size parameters.
6629 \newdimen\defaultparindent \defaultparindent =
15pt
6631 \chapheadingskip =
15pt plus
4pt minus
2pt
6632 \secheadingskip =
12pt plus
3pt minus
2pt
6633 \subsecheadingskip =
9pt plus
2pt minus
2pt
6635 % Prevent underfull vbox error messages.
6638 % Don't be so finicky about underfull hboxes, either.
6641 % Following George Bush, just get rid of widows and orphans.
6645 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
6646 % using an old version of TeX, don't do anything. We want the amount of
6647 % stretch added to depend on the line length, hence the dependence on
6648 % \hsize. We call this whenever the paper size is set.
6650 \def\setemergencystretch{%
6651 \ifx\emergencystretch\thisisundefined
6652 % Allow us to assign to \emergencystretch anyway.
6653 \def\emergencystretch{\dimen0}%
6655 \emergencystretch =
.15\hsize
6659 % Parameters in order: 1) textheight; 2) textwidth; 3) voffset;
6660 % 4) hoffset; 5) binding offset; 6) topskip; 7) physical page height; 8)
6661 % physical page width.
6663 % We also call \setleading{\textleading}, so the caller should define
6664 % \textleading. The caller should also set \parskip.
6666 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
6669 \splittopskip =
\topskip
6672 \advance\vsize by
\topskip
6673 \outervsize =
\vsize
6674 \advance\outervsize by
2\topandbottommargin
6675 \pageheight =
\vsize
6678 \outerhsize =
\hsize
6679 \advance\outerhsize by
0.5in
6682 \normaloffset =
#4\relax
6683 \bindingoffset =
#5\relax
6686 \pdfpageheight #7\relax
6687 \pdfpagewidth #8\relax
6690 \setleading{\textleading}
6692 \parindent =
\defaultparindent
6693 \setemergencystretch
6696 % @letterpaper (the default).
6697 \def\letterpaper{{\globaldefs =
1
6698 \parskip =
3pt plus
2pt minus
1pt
6699 \textleading =
13.2pt
6701 % If page is nothing but text, make it come out even.
6702 \internalpagesizes{46\baselineskip}{6in
}%
6704 {\bindingoffset}{36pt
}%
6708 % Use @smallbook to reset parameters for 7x9.5 (or so) format.
6709 \def\smallbook{{\globaldefs =
1
6710 \parskip =
2pt plus
1pt
6713 \internalpagesizes{7.5in
}{5in
}%
6715 {\bindingoffset}{16pt
}%
6718 \lispnarrowing =
0.3in
6721 \contentsrightmargin =
0pt
6722 \defbodyindent =
.5cm
6725 % Use @afourpaper to print on European A4 paper.
6726 \def\afourpaper{{\globaldefs =
1
6727 \parskip =
3pt plus
2pt minus
1pt
6728 \textleading =
13.2pt
6730 % Double-side printing via postscript on Laserjet 4050
6731 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
6732 % To change the settings for a different printer or situation, adjust
6733 % \normaloffset until the front-side and back-side texts align. Then
6734 % do the same for \bindingoffset. You can set these for testing in
6735 % your texinfo source file like this:
6737 % \global\normaloffset = -6mm
6738 % \global\bindingoffset = 10mm
6740 \internalpagesizes{51\baselineskip}{160mm
}
6741 {\voffset}{\hoffset}%
6742 {\bindingoffset}{44pt
}%
6747 \contentsrightmargin =
0pt
6748 \defbodyindent =
5mm
6751 % Use @afivepaper to print on European A5 paper.
6752 % From romildo@urano.iceb.ufop.br, 2 July 2000.
6753 % He also recommends making @example and @lisp be small.
6754 \def\afivepaper{{\globaldefs =
1
6755 \parskip =
2pt plus
1pt minus
0.1pt
6756 \textleading =
12.5pt
6758 \internalpagesizes{160mm
}{120mm
}%
6759 {\voffset}{\hoffset}%
6760 {\bindingoffset}{8pt
}%
6763 \lispnarrowing =
0.2in
6766 \contentsrightmargin =
0pt
6767 \defbodyindent =
2mm
6771 % A specific text layout, 24x15cm overall, intended for A4 paper.
6772 \def\afourlatex{{\globaldefs =
1
6774 \internalpagesizes{237mm
}{150mm
}%
6776 {\bindingoffset}{7mm
}%
6779 % Must explicitly reset to 0 because we call \afourpaper.
6783 % Use @afourwide to print on A4 paper in landscape format.
6784 \def\afourwide{{\globaldefs =
1
6786 \internalpagesizes{241mm
}{165mm
}%
6787 {\voffset}{-
2.95mm
}%
6788 {\bindingoffset}{7mm
}%
6793 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
6794 % Perhaps we should allow setting the margins, \topskip, \parskip,
6795 % and/or leading, also. Or perhaps we should compute them somehow.
6797 \parseargdef\pagesizes{\pagesizesyyy #1,,
\finish}
6798 \def\pagesizesyyy#1,
#2,
#3\finish{{%
6799 \setbox0 =
\hbox{\ignorespaces #2}\ifdim\wd0 >
0pt
\hsize=
#2\relax \fi
6802 \parskip =
3pt plus
2pt minus
1pt
6803 \setleading{\textleading}%
6806 \advance\dimen0 by
\voffset
6809 \advance\dimen2 by
\normaloffset
6811 \internalpagesizes{#1}{\hsize}%
6812 {\voffset}{\normaloffset}%
6813 {\bindingoffset}{44pt
}%
6817 % Set default to letter.
6822 \message{and turning on texinfo input format.
}
6824 % Define macros to output various characters with catcode for normal text.
6834 \def\normaldoublequote{"
}
6837 \def\normalunderscore{_
}
6838 \def\normalverticalbar{|
}
6840 \def\normalgreater{>
}
6842 \def\normaldollar{$
}%$ font-lock fix
6844 % This macro is used to make a character print one way in \tt
6845 % (where it can probably be output as-is), and another way in other fonts,
6846 % where something hairier probably needs to be done.
6848 % #1 is what to print if we are indeed using \tt; #2 is what to print
6849 % otherwise. Since all the Computer Modern typewriter fonts have zero
6850 % interword stretch (and shrink), and it is reasonable to expect all
6851 % typewriter fonts to have this, we can check that font parameter.
6853 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=
0pt
#1\else #2\fi}
6855 % Same as above, but check for italic font. Actually this also catches
6856 % non-italic slanted fonts since it is impossible to distinguish them from
6857 % italic fonts. But since this is only used by $ and it uses \sl anyway
6858 % this is not a problem.
6859 \def\ifusingit#1#2{\ifdim \fontdimen1\font>
0pt
#1\else #2\fi}
6861 % Turn off all special characters except @
6862 % (and those which the user can use as if they were ordinary).
6863 % Most of these we simply print from the \tt font, but for some, we can
6864 % use math or other variants that look better in normal text.
6867 \def\activedoublequote{{\tt\char34}}
6868 \let"=
\activedoublequote
6870 \def~
{{\tt\char126}}
6876 \def_{\ifusingtt\normalunderscore\_}
6877 % Subroutine for the previous macro.
6878 \def\_{\leavevmode \kern.07em
\vbox{\hrule width
.3em height
.1ex
}\kern .07em
}
6881 \def|
{{\tt\char124}}
6889 \def+
{{\tt \char 43}}
6891 \def$
{\ifusingit{{\sl\$
}}\normaldollar}%$ font-lock fix
6893 % If a .fmt file is being used, characters that might appear in a file
6894 % name cannot be active until we have parsed the command line.
6895 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
6896 % \otherifyactive is called near the end of this file.
6897 \def\otherifyactive{\catcode`+=
\other \catcode`
\_=
\other}
6901 % \backslashcurfont outputs one backslash character in current font,
6903 \global\chardef\backslashcurfont=`\\
6904 \global\let\rawbackslashxx=
\backslashcurfont % let existing .??s files work
6906 % \rawbackslash defines an active \ to do \backslashcurfont.
6907 % \otherbackslash defines an active \ to be a literal `\' character with
6909 {\catcode`\\=
\active
6910 @gdef@rawbackslash
{@let\=@backslashcurfont
}
6911 @gdef@otherbackslash
{@let\=@realbackslash
}
6914 % \realbackslash is an actual character `\' with catcode other.
6915 {\catcode`\\=
\other @gdef@realbackslash
{\
}}
6917 % \normalbackslash outputs one backslash in fixed width font.
6918 \def\normalbackslash{{\tt\backslashcurfont}}
6922 % Used sometimes to turn off (effectively) the active characters
6923 % even after parsing them.
6924 @def@turnoffactive
{%
6925 @let"=@normaldoublequote
6926 @let\=@realbackslash
6929 @let_=@normalunderscore
6930 @let|=@normalverticalbar
6932 @let>=@normalgreater
6934 @let$=@normaldollar
%$ font-lock fix
6938 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
6939 % the literal character `\'. (Thus, \ is not expandable when this is in
6942 @def@normalturnoffactive
{@turnoffactive @let\=@normalbackslash
}
6944 % Make _ and + \other characters, temporarily.
6945 % This is canceled by @fixbackslash.
6948 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
6949 % That is what \eatinput is for; after that, the `\' should revert to printing
6952 @gdef@eatinput input texinfo
{@fixbackslash
}
6953 @global@let\ = @eatinput
6955 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
6956 % the first `\{ in the file would cause an error. This macro tries to fix
6957 % that, assuming it is called before the first `\' could plausibly occur.
6958 % Also back turn on active characters that might appear in the input
6959 % file name, in case not using a pre-dumped format.
6961 @gdef@fixbackslash
{%
6962 @ifx\@eatinput @let\ = @normalbackslash @fi
6967 % Say @foo, not \foo, in error messages.
6970 % These look ok in all fonts, so just make them not special.
6971 @catcode`@& = @other
6972 @catcode`@# = @other
6973 @catcode`@
% = @other
6977 @c eval: (add-hook 'write-file-hooks 'time-stamp)
6978 @c page-delimiter: "^\\\
\message"
6979 @c time-stamp-start: "def\\\
\texinfoversion{"
6980 @c time-stamp-format: "
%:y-%02m-%02d.%02H"
6981 @c time-stamp-end: "
}"
6987 arch-tag: e1b36e32-c96e-4135-a41a-
0b2efa2ea115