1 % texinfo.tex -- TeX macros to handle Texinfo files.
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname
\endcsname\relax\input plain
\fi
6 \def\texinfoversion{2013-
09-
11.11}
8 % Copyright 1985-1986, 1988, 1990-2014 Free Software Foundation, Inc.
10 % This texinfo.tex file is free software: you can redistribute it and/or
11 % modify it under the terms of the GNU General Public License as
12 % published by the Free Software Foundation, either version 3 of the
13 % License, or (at your option) any later version.
15 % This texinfo.tex file is distributed in the hope that it will be
16 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
17 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 % General Public License for more details.
20 % You should have received a copy of the GNU General Public License
21 % along with this program. If not, see <http://www.gnu.org/licenses/>.
23 % As a special exception, when this file is read by TeX when processing
24 % a Texinfo source document, you may use the result without
25 % restriction. This Exception is an additional permission under section 7
26 % of the GNU General Public License, version 3 ("GPLv3").
28 % Please try the latest version of texinfo.tex before submitting bug
29 % reports; you can get the latest version from:
30 % http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
31 % http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
32 % http://www.gnu.org/software/texinfo/ (the Texinfo home page)
33 % The texinfo.tex in any given distribution could well be out
34 % of date, so if that's what you're using, please check.
36 % Send bug reports to bug-texinfo@gnu.org. Please include including a
37 % complete document in each bug report with which we can reproduce the
38 % problem. Patches are, of course, greatly appreciated.
40 % To process a Texinfo manual with TeX, it's most reliable to use the
41 % texi2dvi shell script that comes with the distribution. For a simple
42 % manual foo.texi, however, you can get away with this:
47 % dvips foo.dvi -o # or whatever; this makes foo.ps.
48 % The extra TeX runs get the cross-reference information correct.
49 % Sometimes one run after texindex suffices, and sometimes you need more
50 % than two; texi2dvi does it as many times as necessary.
52 % It is possible to adapt texinfo.tex for other languages, to some
53 % extent. You can get the existing language-specific files from the
54 % full Texinfo distribution.
56 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
59 \message{Loading texinfo
[version
\texinfoversion]:
}
61 % If in a .fmt file, print the version number
62 % and turn on active characters that we couldn't do earlier because
63 % they might have appeared in the input file name.
64 \everyjob{\message{[Texinfo version
\texinfoversion]}%
65 \catcode`+=
\active \catcode`
\_=
\active}
69 % We never want plain's \outer definition of \+ in Texinfo.
70 % For @tex, we can use \tabalign.
73 % Save some plain tex macros whose names we will redefine.
75 \let\ptexbullet=
\bullet
83 \let\ptexfootnote=
\footnote
87 \let\ptexindent=
\indent
88 \let\ptexinsert=
\insert
91 \let\ptexnewwrite\newwrite
92 \let\ptexnoindent=
\noindent
94 \let\ptexraggedright=
\raggedright
100 {\catcode`\'=
\active \global\let\ptexquoteright'
}% active in plain's math mode
102 % If this character appears in an error message or help string, it
103 % starts a new line in the output.
106 % Use TeX 3.0's \inputlineno to get the line number, for better error
107 % messages, but if we're using an old version of TeX, don't do anything.
109 \ifx\inputlineno\thisisundefined
110 \let\linenumber =
\empty % Pre-3.0.
112 \def\linenumber{l.
\the\inputlineno:
\space}
115 % Set up fixed words for English if not already set.
116 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix
}\fi
117 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter
}\fi
118 \ifx\putworderror\undefined \gdef\putworderror{error
}\fi
119 \ifx\putwordfile\undefined \gdef\putwordfile{file
}\fi
120 \ifx\putwordin\undefined \gdef\putwordin{in
}\fi
121 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)
}\fi
122 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)
}\fi
123 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info
}\fi
124 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of
}\fi
125 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on
}\fi
126 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title
}\fi
127 \ifx\putwordof\undefined \gdef\putwordof{of
}\fi
128 \ifx\putwordon\undefined \gdef\putwordon{on
}\fi
129 \ifx\putwordpage\undefined \gdef\putwordpage{page
}\fi
130 \ifx\putwordsection\undefined \gdef\putwordsection{section
}\fi
131 \ifx\putwordSection\undefined \gdef\putwordSection{Section
}\fi
132 \ifx\putwordsee\undefined \gdef\putwordsee{see
}\fi
133 \ifx\putwordSee\undefined \gdef\putwordSee{See
}\fi
134 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents
}\fi
135 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents
}\fi
137 \ifx\putwordMJan\undefined \gdef\putwordMJan{January
}\fi
138 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February
}\fi
139 \ifx\putwordMMar\undefined \gdef\putwordMMar{March
}\fi
140 \ifx\putwordMApr\undefined \gdef\putwordMApr{April
}\fi
141 \ifx\putwordMMay\undefined \gdef\putwordMMay{May
}\fi
142 \ifx\putwordMJun\undefined \gdef\putwordMJun{June
}\fi
143 \ifx\putwordMJul\undefined \gdef\putwordMJul{July
}\fi
144 \ifx\putwordMAug\undefined \gdef\putwordMAug{August
}\fi
145 \ifx\putwordMSep\undefined \gdef\putwordMSep{September
}\fi
146 \ifx\putwordMOct\undefined \gdef\putwordMOct{October
}\fi
147 \ifx\putwordMNov\undefined \gdef\putwordMNov{November
}\fi
148 \ifx\putwordMDec\undefined \gdef\putwordMDec{December
}\fi
150 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro
}\fi
151 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form
}\fi
152 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable
}\fi
153 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option
}\fi
154 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function
}\fi
156 % Since the category of space is not known, we have to be careful.
157 \chardef\spacecat =
10
158 \def\spaceisspace{\catcode`\ =
\spacecat}
160 % sometimes characters are active, so we need control sequences.
161 \chardef\ampChar = `\&
162 \chardef\colonChar = `\:
163 \chardef\commaChar = `\,
164 \chardef\dashChar = `\-
165 \chardef\dotChar = `\.
166 \chardef\exclamChar= `\!
167 \chardef\hashChar = `\#
168 \chardef\lquoteChar= `\`
169 \chardef\questChar = `\?
170 \chardef\rquoteChar= `\'
171 \chardef\semiChar = `\;
172 \chardef\slashChar = `\/
173 \chardef\underChar = `
\_
179 % The following is used inside several \edef's.
180 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
184 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
185 ap-pen-dix bit-map bit-maps
186 data-base data-bases eshell fall-ing half-way long-est man-u-script
187 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
188 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
190 stand-alone strong-est time-stamp time-stamps which-ever white-space
191 wide-spread wrap-around
194 % Margin to add to right of even pages, to left of odd pages.
195 \newdimen\bindingoffset
196 \newdimen\normaloffset
197 \newdimen\pagewidth \newdimen\pageheight
199 % For a final copy, take out the rectangles
200 % that mark overfull boxes (in case you have decided
201 % that the text looks ok even though it passes the margin).
203 \def\finalout{\overfullrule=
0pt
}
205 % Sometimes it is convenient to have everything in the transcript file
206 % and nothing on the terminal. We don't just call \tracingall here,
207 % since that produces some useless output on the terminal. We also make
208 % some effort to order the tracing commands to reduce output in the log
209 % file; cf. trace.sty in LaTeX.
211 \def\gloggingall{\begingroup \globaldefs =
1 \loggingall \endgroup}%
215 \tracinglostchars2 % 2 gives us more in etex
220 \showboxbreadth\maxdimen \showboxdepth\maxdimen
221 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
228 \tracingcommands3 % 3 gives us more in etex
232 % @errormsg{MSG}. Do the index-like expansions on MSG, but if things
233 % aren't perfect, it's not the end of the world, being an error message,
236 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
237 \def\doerrormsg#1{\errmessage{#1}}
239 % add check for \lastpenalty to plain's definitions. If the last thing
240 % we did was a \nobreak, we don't want to insert more space.
242 \def\smallbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\smallskipamount
243 \removelastskip\penalty-
50\smallskip\fi\fi}
244 \def\medbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\medskipamount
245 \removelastskip\penalty-
100\medskip\fi\fi}
246 \def\bigbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\bigskipamount
247 \removelastskip\penalty-
200\bigskip\fi\fi}
249 % Do @cropmarks to get crop marks.
252 \let\cropmarks =
\cropmarkstrue
254 % Dimensions to add cropmarks at corners.
255 % Added by P. A. MacKay, 12 Nov. 1986
257 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
258 \newdimen\cornerlong \cornerlong=
1pc
259 \newdimen\cornerthick \cornerthick=
.3pt
260 \newdimen\topandbottommargin \topandbottommargin=
.75in
262 % Output a mark which sets \thischapter, \thissection and \thiscolor.
263 % We dump everything together because we only have one kind of mark.
264 % This works because we only use \botmark / \topmark, not \firstmark.
266 % A mark contains a subexpression of the \ifcase ... \fi construct.
267 % \get*marks macros below extract the needed part using \ifcase.
269 % Another complication is to let the user choose whether \thischapter
270 % (\thissection) refers to the chapter (section) in effect at the top
271 % of a page, or that at the bottom of a page. The solution is
272 % described on page 260 of The TeXbook. It involves outputting two
273 % marks for the sectioning macros, one before the section break, and
274 % one after. I won't pretend I can describe this better than DEK...
276 \toks0=
\expandafter{\lastchapterdefs}%
277 \toks2=
\expandafter{\lastsectiondefs}%
278 \toks4=
\expandafter{\prevchapterdefs}%
279 \toks6=
\expandafter{\prevsectiondefs}%
280 \toks8=
\expandafter{\lastcolordefs}%
282 \the\toks0 \the\toks2 % 0: top marks (\last...)
283 \noexpand\or \the\toks4 \the\toks6 % 1: bottom marks (default, \prev...)
284 \noexpand\else \the\toks8 % 2: color marks
287 % \topmark doesn't work for the very first chapter (after the title
288 % page or the contents), so we use \firstmark there -- this gets us
289 % the mark with the chapter defs, unless the user sneaks in, e.g.,
290 % @setcolor (or @url, or @link, etc.) between @contents and the very
292 \def\gettopheadingmarks{%
294 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
296 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
297 \def\getcolormarks{\ifcase2\topmark\fi}
299 % Avoid "undefined control sequence" errors.
300 \def\lastchapterdefs{}
301 \def\lastsectiondefs{}
302 \def\prevchapterdefs{}
303 \def\prevsectiondefs{}
306 % Main output routine.
308 \output =
{\onepageout{\pagecontents\PAGE}}
313 % \onepageout takes a vbox as an argument. Note that \pagecontents
314 % does insertions, but you have to call it yourself.
316 \ifcropmarks \hoffset=
0pt
\else \hoffset=
\normaloffset \fi
318 \ifodd\pageno \advance\hoffset by
\bindingoffset
319 \else \advance\hoffset by -
\bindingoffset\fi
321 % Do this outside of the \shipout so @code etc. will be expanded in
322 % the headline as they should be, not taken literally (outputting ''code).
323 \def\commmonheadfootline{\let\hsize=
\pagewidth \texinfochars}
325 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
326 \global\setbox\headlinebox =
\vbox{\commmonheadfootline \makeheadline}%
328 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
329 \global\setbox\footlinebox =
\vbox{\commmonheadfootline \makefootline}%
332 % Have to do this stuff outside the \shipout because we want it to
333 % take effect in \write's, yet the group defined by the \vbox ends
334 % before the \shipout runs.
336 \indexdummies % don't expand commands in the output.
337 \normalturnoffactive % \ in index entries must not stay \, e.g., if
338 % the page break happens to be in the middle of an example.
339 % We don't want .vr (or whatever) entries like this:
340 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
341 % "\acronym" won't work when it's read back in;
343 % {\code {{\tt \backslashcurfont }acronym}
345 % Do this early so pdf references go to the beginning of the page.
346 \ifpdfmakepagedest \pdfdest name
{\the\pageno} xyz
\fi
348 \ifcropmarks \vbox to
\outervsize\bgroup
350 \vskip-
\topandbottommargin
352 \line{\ewtop\hfil\ewtop}%
355 \vbox{\moveleft\cornerthick\nstop}%
357 \vbox{\moveright\cornerthick\nstop}%
360 \vskip\topandbottommargin
362 \hfil % center the page within the outer (page) hsize.
363 \ifodd\pageno\hskip\bindingoffset\fi
369 \ifdim\ht\footlinebox >
0pt
370 % Only leave this space if the footline is nonempty.
371 % (We lessened \vsize for it in \oddfootingyyy.)
372 % The \baselineskip=24pt in plain's \makefootline has no effect.
378 \egroup % end of \vbox\bgroup
379 \hfil\egroup % end of (centering) \line\bgroup
380 \vskip\topandbottommargin plus1fill minus1fill
381 \boxmaxdepth =
\cornerthick
384 \vbox{\moveleft\cornerthick\nsbot}%
386 \vbox{\moveright\cornerthick\nsbot}%
389 \line{\ewbot\hfil\ewbot}%
391 \egroup % \vbox from first cropmarks clause
393 }% end of \shipout\vbox
394 }% end of group with \indexdummies
396 \ifnum\outputpenalty>-
20000 \else\dosupereject\fi
399 \newinsert\margin \dimen\margin=
\maxdimen
401 \def\pagebody#1{\vbox to
\pageheight{\boxmaxdepth=
\maxdepth #1}}
403 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
404 % marginal hacks, juha@viisa.uucp (Juha Takala)
405 \ifvoid\margin\else % marginal info is present
406 \rlap{\kern\hsize\vbox to
\z@
{\kern1pt\box\margin \vss}}\fi
407 \dimen@=
\dp#1\relax \unvbox#1\relax
408 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
409 \ifr@ggedbottom
\kern-
\dimen@
\vfil \fi}
412 % Here are the rules for the cropmarks. Note that they are
413 % offset so that the space between them is truly \outerhsize or \outervsize
414 % (P. A. MacKay, 12 November, 1986)
416 \def\ewtop{\vrule height
\cornerthick depth0pt width
\cornerlong}
418 {\hrule height
\cornerthick depth
\cornerlong width
\cornerthick}}
419 \def\ewbot{\vrule height0pt depth
\cornerthick width
\cornerlong}
421 {\hrule height
\cornerlong depth
\cornerthick width
\cornerthick}}
423 % Parse an argument, then pass it to #1. The argument is the rest of
424 % the input line (except we remove a trailing comment). #1 should be a
425 % macro which expects an ordinary undelimited TeX argument.
427 \def\parsearg{\parseargusing{}}
428 \def\parseargusing#1#2{%
434 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
438 \gdef\parseargline#1^^M
{%
439 \endgroup % End of the group started in \parsearg.
440 \argremovecomment #1\comment\ArgTerm%
444 % First remove any @comment, then any @c comment.
445 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
446 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M
\ArgTerm}
448 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
450 % \argremovec might leave us with trailing space, e.g.,
451 % @end itemize @c foo
452 % This space token undergoes the same procedure and is eventually removed
453 % by \finishparsearg.
455 \def\argcheckspaces#1\^^M
{\argcheckspacesX#1\^^M \^^M
}
456 \def\argcheckspacesX#1 \^^M
{\argcheckspacesY#1\^^M
}
457 \def\argcheckspacesY#1\^^M
#2\^^M
#3\ArgTerm{%
460 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
461 \let\temp\finishparsearg
463 \let\temp\argcheckspaces
465 % Put the space token in:
469 % If a _delimited_ argument is enclosed in braces, they get stripped; so
470 % to get _exactly_ the rest of the line, we had to prevent such situation.
471 % We prepended an \empty token at the very beginning and we expand it now,
472 % just before passing the control to \argtorun.
473 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
474 % either the null string, or it ends with \^^M---thus there is no danger
475 % that a pair of braces would be stripped.
477 % But first, we have to remove the trailing space token.
479 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
481 % \parseargdef\foo{...}
482 % is roughly equivalent to
483 % \def\foo{\parsearg\Xfoo}
486 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
487 % favourite TeX trick. --kasal, 16nov03
490 \expandafter \doparseargdef \csname\string#1\endcsname #1%
492 \def\doparseargdef#1#2{%
497 % Several utility definitions with active space:
502 % Make each space character in the input produce a normal interword
503 % space in the output. Don't allow a line break at this space, as this
504 % is used only in environments like @example, where each line of input
505 % should produce a line of output anyway.
507 \gdef\sepspaces{\obeyspaces\let =
\tie}
509 % If an index command is used in an @example environment, any spaces
510 % therein should become regular spaces in the raw index file, not the
511 % expansion of \tie (\leavevmode \penalty \@M \ ).
512 \gdef\unsepspaces{\let =
\space}
516 \def\flushcr{\ifx\par\lisppar \def\next#
#1{}\else \let\next=
\relax \fi \next}
518 % Define the framework for environments in texinfo.tex. It's used like this:
523 % It's the responsibility of \envdef to insert \begingroup before the
524 % actual body; @end closes the group after calling \Efoo. \envdef also
525 % defines \thisenv, so the current environment is known; @end checks
526 % whether the environment name matches. The \checkenv macro can also be
527 % used to check whether the current environment is the one expected.
529 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
530 % are not treated as environments; they don't open a group. (The
531 % implementation of @end takes care not to call \endgroup in this
535 % At run-time, environments start with this:
536 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
540 % ... but they get defined via ``\envdef\foo{...}'':
541 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
542 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
544 % Check whether we're in the right environment:
553 % Environment mismatch, #1 expected:
556 \errmessage{This command can appear only
\inenvironment\temp,
557 not
\inenvironment\thisenv}%
559 \def\inenvironment#1{%
561 outside of any environment
%
563 in environment
\expandafter\string#1%
567 % @end foo executes the definition of \Efoo.
568 % But first, it executes a specialized version of \checkenv
571 \if 1\csname iscond.
#1\endcsname
573 % The general wording of \badenverr may not be ideal.
574 \expandafter\checkenv\csname#1\endcsname
575 \csname E
#1\endcsname
580 \newhelp\EMsimple{Press RETURN to continue.
}
583 % Be sure we're in horizontal mode when doing a tie, since we make space
584 % equivalent to this in @example-like environments. Otherwise, a space
585 % at the beginning of a line will start with \penalty -- and
586 % since \penalty is valid in vertical mode, we'd end up putting the
587 % penalty on the vertical list instead of in the new paragraph.
589 % Avoid using \@M directly, because that causes trouble
590 % if the definition is written into an index file.
591 \global\let\tiepenalty = \@M
592 \gdef\tie{\leavevmode\penalty\tiepenalty\
}
595 % @: forces normal size whitespace following.
596 \def\:
{\spacefactor=
1000 }
598 % @* forces a line break.
599 \def\*
{\unskip\hfil\break\hbox{}\ignorespaces}
601 % @/ allows a line break.
604 % @. is an end-of-sentence period.
605 \def\.
{.
\spacefactor=
\endofsentencespacefactor\space}
607 % @! is an end-of-sentence bang.
608 \def\!
{!
\spacefactor=
\endofsentencespacefactor\space}
610 % @? is an end-of-sentence query.
611 \def\?
{?
\spacefactor=
\endofsentencespacefactor\space}
613 % @frenchspacing on|off says whether to put extra space after punctuation.
618 \parseargdef\frenchspacing{%
620 \ifx\temp\onword \plainfrenchspacing
621 \else\ifx\temp\offword \plainnonfrenchspacing
624 \errmessage{Unknown @frenchspacing option `
\temp', must be on|off
}%
628 % @w prevents a word break. Without the \leavevmode, @w at the
629 % beginning of a paragraph, when TeX is still in vertical mode, would
630 % produce a whole line of output instead of starting the paragraph.
631 \def\w#1{\leavevmode\hbox{#1}}
633 % @group ... @end group forces ... to be all on one page, by enclosing
634 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
635 % to keep its height that of a normal line. According to the rules for
636 % \topskip (p.114 of the TeXbook), the glue inserted is
637 % max (\topskip - \ht (first item), 0). If that height is large,
638 % therefore, no glue is inserted, and the space between the headline and
639 % the text is small, which looks bad.
641 % Another complication is that the group might be very large. This can
642 % cause the glue on the previous page to be unduly stretched, because it
643 % does not have much material. In this case, it's better to add an
644 % explicit \vfill so that the extra space is at the bottom. The
645 % threshold for doing this is if the group is more than \vfilllimit
646 % percent of a page (\vfilllimit can be changed inside of @tex).
652 \ifnum\catcode`\^^M=
\active \else
653 \errhelp =
\groupinvalidhelp
654 \errmessage{@group invalid in context where filling is enabled
}%
658 \setbox\groupbox =
\vtop\bgroup
659 % Do @comment since we are called inside an environment such as
660 % @example, where each end-of-line in the input causes an
661 % end-of-line in the output. We don't want the end-of-line after
662 % the `@group' to put extra space in the output. Since @group
663 % should appear on a line by itself (according to the Texinfo
664 % manual), we don't worry about eating any user text.
668 % The \vtop produces a box with normal height and large depth; thus, TeX puts
669 % \baselineskip glue before it, and (when the next line of text is done)
670 % \lineskip glue after it. Thus, space below is not quite equal to space
671 % above. But it's pretty close.
673 % To get correct interline space between the last line of the group
674 % and the first line afterwards, we have to propagate \prevdepth.
675 \endgraf % Not \par, as it may have been set to \lisppar.
676 \global\dimen1 =
\prevdepth
677 \egroup % End the \vtop.
678 % \dimen0 is the vertical size of the group's box.
679 \dimen0 =
\ht\groupbox \advance\dimen0 by
\dp\groupbox
680 % \dimen2 is how much space is left on the page (more or less).
681 \dimen2 =
\pageheight \advance\dimen2 by -
\pagetotal
682 % if the group doesn't fit on the current page, and it's a big big
683 % group, force a page break.
684 \ifdim \dimen0 >
\dimen2
685 \ifdim \pagetotal <
\vfilllimit\pageheight
694 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
695 % message, so this ends up printing `@group can only ...'.
697 \newhelp\groupinvalidhelp{%
698 group can only be used in environments such as @example,^^J
%
699 where each line of input produces a line of output.
}
701 % @need space-in-mils
702 % forces a page break if there is not space-in-mils remaining.
704 \newdimen\mil \mil=
0.001in
707 % Ensure vertical mode, so we don't make a big box in the middle of a
711 % If the @need value is less than one line space, it's useless.
713 \dimen2 =
\ht\strutbox
714 \advance\dimen2 by
\dp\strutbox
715 \ifdim\dimen0 >
\dimen2
717 % Do a \strut just to make the height of this box be normal, so the
718 % normal leading is inserted relative to the preceding line.
719 % And a page break here is fine.
720 \vtop to
#1\mil{\strut\vfil}%
722 % TeX does not even consider page breaks if a penalty added to the
723 % main vertical list is 10000 or more. But in order to see if the
724 % empty box we just added fits on the page, we must make it consider
725 % page breaks. On the other hand, we don't want to actually break the
726 % page after the empty box. So we use a penalty of 9999.
728 % There is an extremely small chance that TeX will actually break the
729 % page at this \penalty, if there are no other feasible breakpoints in
730 % sight. (If the user is using lots of big @group commands, which
731 % almost-but-not-quite fill up a page, TeX will have a hard time doing
732 % good page breaking, for example.) However, I could not construct an
733 % example where a page broke at this \penalty; if it happens in a real
734 % document, then we can reconsider our strategy.
737 % Back up by the size of the box, whether we did a page break or not.
740 % Do not allow a page break right after this kern.
745 % @br forces paragraph break (and is undocumented).
749 % @page forces the start of a new page.
751 \def\page{\par\vfill\supereject}
754 % outputs text on separate line in roman font, starting at standard page margin
756 % This records the amount of indent in the innermost environment.
757 % That's how much \exdent should take out.
758 \newskip\exdentamount
760 % This defn is used inside fill environments such as @defun.
761 \parseargdef\exdent{\hfil\break\hbox{\kern -
\exdentamount{\rm#1}}\hfil\break}
763 % This defn is used inside nofill environments such as @example.
764 \parseargdef\nofillexdent{{\advance \leftskip by -
\exdentamount
765 \leftline{\hskip\leftskip{\rm#1}}}}
767 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
768 % paragraph. For more general purposes, use the \margin insertion
769 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
771 \newskip\inmarginspacing \inmarginspacing=
1cm
772 \def\strutdepth{\dp\strutbox}
774 \def\doinmargin#1#2{\strut\vadjust{%
777 \vtop to
\strutdepth{%
778 \baselineskip=
\strutdepth
780 % if you have multiple lines of stuff to put here, you'll need to
781 % make the vbox yourself of the appropriate size.
783 \llap{\ignorespaces #2\hskip\inmarginspacing}%
785 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
790 \def\inleftmargin{\doinmargin l
}
791 \def\inrightmargin{\doinmargin r
}
793 % @inmargin{TEXT [, RIGHT-TEXT]}
794 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
795 % else use TEXT for both).
797 \def\inmargin#1{\parseinmargin #1,,
\finish}
798 \def\parseinmargin#1,
#2,
#3\finish{% not perfect, but better than nothing.
799 \setbox0 =
\hbox{\ignorespaces #2}%
801 \def\lefttext{#1}% have both texts
804 \def\lefttext{#1}% have only one text
809 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
811 \def\temp{\inleftmargin\lefttext}%
816 % @| inserts a changebar to the left of the current line. It should
817 % surround any changed text. This approach does *not* work if the
818 % change spans more than two lines of output. To handle that, we would
819 % have adopt a much more difficult approach (putting marks into the main
820 % vertical list for the beginning and end of each change). This command
821 % is not documented, not supported, and doesn't work.
824 % \vadjust can only be used in horizontal mode.
827 % Append this vertical mode material after the current line in the output.
829 % We want to insert a rule with the height and depth of the current
830 % leading; that is exactly what \strutbox is supposed to record.
833 % \vadjust-items are inserted at the left edge of the type. So
834 % the \llap here moves out into the left-hand margin.
837 % For a thicker or thinner bar, change the `1pt'.
838 \vrule height
\baselineskip width1pt
840 % This is the space between the bar and the text.
846 % @include FILE -- \input text of FILE.
848 \def\include{\parseargusing\filenamecatcodes\includezzz}
853 \makevalueexpandable % we want to expand any @value in FILE.
854 \turnoffactive % and allow special characters in the expansion
855 \indexnofonts % Allow `@@' and other weird things in file names.
856 \wlog{texinfo.tex: doing @include of
#1^^J
}%
857 \edef\temp{\noexpand\input #1 }%
859 % This trickery is to read FILE outside of a group, in case it makes
865 \def\filenamecatcodes{%
879 \def\pushthisfilestack{%
880 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
882 \def\pushthisfilestackX{%
883 \expandafter\pushthisfilestackY\thisfile\StackTerm
885 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
886 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
889 \def\popthisfilestack{\errthisfilestackempty}
890 \def\errthisfilestackempty{\errmessage{Internal error:
891 the stack of filenames is empty.
}}
896 % outputs that line, centered.
898 \parseargdef\center{%
900 \let\centersub\centerH
902 \let\centersub\centerV
904 \centersub{\hfil \ignorespaces#1\unskip \hfil}%
905 \let\centersub\relax % don't let the definition persist, just in case
909 \advance\hsize by -
\leftskip
910 \advance\hsize by -
\rightskip
915 \newcount\centerpenalty
917 % The idea here is the same as in \startdefun, \cartouche, etc.: if
918 % @center is the first thing after a section heading, we need to wipe
919 % out the negative parskip inserted by \sectionheading, but still
920 % prevent a page break here.
921 \centerpenalty =
\lastpenalty
922 \ifnum\centerpenalty>
10000 \vskip\parskip \fi
923 \ifnum\centerpenalty>
9999 \penalty\centerpenalty \fi
924 \line{\kern\leftskip #1\kern\rightskip}%
927 % @sp n outputs n lines of vertical space
929 \parseargdef\sp{\vskip #1\baselineskip}
931 % @comment ...line which is ignored...
932 % @c is the same as @comment
933 % @ignore ... @end ignore is another way to write a comment
935 \def\comment{\begingroup \catcode`\^^M=
\other%
936 \catcode`\@=
\other \catcode`\
{=
\other \catcode`\
}=
\other%
938 {\catcode`\^^M=
\other \gdef\commentxxx#1^^M
{\endgroup}}
942 % @paragraphindent NCHARS
943 % We'll use ems for NCHARS, close enough.
944 % NCHARS can also be the word `asis' or `none'.
945 % We cannot feasibly implement @paragraphindent asis, though.
947 \def\asisword{asis
} % no translation, these are keywords
950 \parseargdef\paragraphindent{%
955 \defaultparindent =
0pt
957 \defaultparindent =
#1em
960 \parindent =
\defaultparindent
963 % @exampleindent NCHARS
964 % We'll use ems for NCHARS like @paragraphindent.
965 % It seems @exampleindent asis isn't necessary, but
966 % I preserve it to make it similar to @paragraphindent.
967 \parseargdef\exampleindent{%
974 \lispnarrowing =
#1em
979 % @firstparagraphindent WORD
980 % If WORD is `none', then suppress indentation of the first paragraph
981 % after a section heading. If WORD is `insert', then do indent at such
984 % The paragraph indentation is suppressed or not by calling
985 % \suppressfirstparagraphindent, which the sectioning commands do.
986 % We switch the definition of this back and forth according to WORD.
987 % By default, we suppress indentation.
989 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
990 \def\insertword{insert
}
992 \parseargdef\firstparagraphindent{%
995 \let\suppressfirstparagraphindent =
\dosuppressfirstparagraphindent
996 \else\ifx\temp\insertword
997 \let\suppressfirstparagraphindent =
\relax
1000 \errmessage{Unknown @firstparagraphindent option `
\temp'
}%
1004 % Here is how we actually suppress indentation. Redefine \everypar to
1005 % \kern backwards by \parindent, and then reset itself to empty.
1007 % We also make \indent itself not actually do anything until the next
1010 \gdef\dosuppressfirstparagraphindent{%
1012 \restorefirstparagraphindent
1016 \restorefirstparagraphindent
1019 \global\everypar =
{%
1021 \restorefirstparagraphindent
1025 \gdef\restorefirstparagraphindent{%
1026 \global \let \indent =
\ptexindent
1027 \global \let \noindent =
\ptexnoindent
1028 \global \everypar =
{}%
1032 % @refill is a no-op.
1035 % If working on a large document in chapters, it is convenient to
1036 % be able to disable indexing, cross-referencing, and contents, for test runs.
1037 % This is done with @novalidate (before @setfilename).
1039 \newif\iflinks \linkstrue % by default we want the aux files.
1040 \let\novalidate =
\linksfalse
1042 % @setfilename is done at the beginning of every texinfo file.
1043 % So open here the files we need to have open while reading the input.
1044 % This makes it possible to make a .fmt file for texinfo.
1046 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1049 % Open the new aux file. TeX will close it automatically at exit.
1050 \immediate\openout\auxfile=
\jobname.aux
1051 \fi % \openindices needs to do some work in any case.
1053 \let\setfilename=
\comment % Ignore extra @setfilename cmds.
1055 % If texinfo.cnf is present on the system, read it.
1056 % Useful for site-wide @afourpaper, etc.
1057 \openin 1 texinfo.cnf
1058 \ifeof 1 \else \input texinfo.cnf
\fi
1061 \comment % Ignore the actual filename.
1064 % Called from \setfilename.
1076 \outer\def\bye{\pagealignmacro\tracingstats=
1\ptexend}
1080 % adobe `portable' document format
1084 \newcount\filenamelength
1093 \newif\ifpdfmakepagedest
1095 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1096 % can be set). So we test for \relax and 0 as well as being undefined.
1097 \ifx\pdfoutput\thisisundefined
1099 \ifx\pdfoutput\relax
1108 % PDF uses PostScript string constants for the names of xref targets,
1109 % for display in the outlines, and in other places. Thus, we have to
1110 % double any backslashes. Otherwise, a name like "\node" will be
1111 % interpreted as a newline (\n), followed by o, d, e. Not good.
1113 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1114 % related messages. The final outcome is that it is up to the TeX user
1115 % to double the backslashes and otherwise make the string valid, so
1116 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1117 % do this reliably, so we use it.
1119 % #1 is a control sequence in which to do the replacements,
1121 \def\txiescapepdf#1{%
1122 \ifx\pdfescapestring\thisisundefined
1123 % No primitive available; should we give a warning or log?
1124 % Many times it won't matter.
1126 % The expandable \pdfescapestring primitive escapes parentheses,
1127 % backslashes, and other special chars.
1128 \xdef#1{\pdfescapestring{#1}}%
1132 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1133 with PDF output, and none of those formats could be found. (.eps cannot
1134 be supported due to the design of the PDF format; use regular TeX (DVI
1139 % Color manipulation macros based on pdfcolor.tex,
1140 % except using rgb instead of cmyk; the latter is said to render as a
1141 % very dark gray on-screen and a very dark halftone in print, instead
1143 \def\rgbDarkRed{0.50 0.09 0.12}
1144 \def\rgbBlack{0 0 0}
1146 % k sets the color for filling (usual text, etc.);
1147 % K sets the color for stroking (thin rules, e.g., normal _'s).
1148 \def\pdfsetcolor#1{\pdfliteral{#1 rg
#1 RG
}}
1150 % Set color, and create a mark which defines \thiscolor accordingly,
1151 % so that \makeheadline knows which color to restore.
1153 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1158 \def\maincolor{\rgbBlack}
1159 \pdfsetcolor{\maincolor}
1160 \edef\thiscolor{\maincolor}
1161 \def\lastcolordefs{}
1165 \line{\pdfsetcolor{\maincolor}\the\footline}%
1173 % Extract \thiscolor definition from the marks.
1175 % Typeset the headline with \maincolor, then restore the color.
1176 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1184 \pdfcatalog{/PageMode /UseOutlines
}
1186 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1187 \def\dopdfimage#1#2#3{%
1188 \def\pdfimagewidth{#2}\setbox0 =
\hbox{\ignorespaces #2}%
1189 \def\pdfimageheight{#3}\setbox2 =
\hbox{\ignorespaces #3}%
1191 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1192 % others). Let's try in that order, PDF first since if
1193 % someone has a scalable image, presumably better to use that than a
1195 \let\pdfimgext=
\empty
1197 \openin 1 #1.pdf
\ifeof 1
1198 \openin 1 #1.PDF
\ifeof 1
1199 \openin 1 #1.png
\ifeof 1
1200 \openin 1 #1.jpg
\ifeof 1
1201 \openin 1 #1.jpeg
\ifeof 1
1202 \openin 1 #1.JPG
\ifeof 1
1203 \errhelp =
\nopdfimagehelp
1204 \errmessage{Could not find image file
#1 for pdf
}%
1205 \else \gdef\pdfimgext{JPG
}%
1207 \else \gdef\pdfimgext{jpeg
}%
1209 \else \gdef\pdfimgext{jpg
}%
1211 \else \gdef\pdfimgext{png
}%
1213 \else \gdef\pdfimgext{PDF
}%
1215 \else \gdef\pdfimgext{pdf
}%
1220 % without \immediate, ancient pdftex seg faults when the same image is
1221 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1222 \ifnum\pdftexversion <
14
1225 \immediate\pdfximage
1227 \ifdim \wd0 >
0pt width
\pdfimagewidth \fi
1228 \ifdim \wd2 >
0pt height
\pdfimageheight \fi
1229 \ifnum\pdftexversion<
13
1234 \ifnum\pdftexversion <
14 \else
1235 \pdfrefximage \pdflastximage
1239 % We have to set dummies so commands such as @code, and characters
1240 % such as \, aren't expanded when present in a section title.
1243 \makevalueexpandable
1244 \def\pdfdestname{#1}%
1245 \txiescapepdf\pdfdestname
1246 \safewhatsit{\pdfdest name
{\pdfdestname} xyz
}%
1249 % used to mark target names; must be expandable.
1252 % by default, use a color that is dark enough to print on paper as
1253 % nearly black, but still distinguishable for online viewing.
1254 \def\urlcolor{\rgbDarkRed}
1255 \def\linkcolor{\rgbDarkRed}
1256 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1258 % Adding outlines to PDF; macros for calculating structure of outlines
1259 % come from Petr Olsak
1260 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1261 \else \csname#1\endcsname \fi}
1262 \def\advancenumber#1{\tempnum=
\expnumber{#1}\relax
1263 \advance\tempnum by
1
1264 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1266 % #1 is the section text, which is what will be displayed in the
1267 % outline by the pdf viewer. #2 is the pdf expression for the number
1268 % of subentries (or empty, for subsubsections). #3 is the node text,
1269 % which might be empty if this toc entry had no corresponding node.
1270 % #4 is the page number
1272 \def\dopdfoutline#1#2#3#4{%
1273 % Generate a link to the node text if that exists; else, use the
1274 % page number. We could generate a destination for the section
1275 % text in the case where a section has no node, but it doesn't
1276 % seem worth the trouble, since most documents are normally structured.
1277 \edef\pdfoutlinedest{#3}%
1278 \ifx\pdfoutlinedest\empty
1279 \def\pdfoutlinedest{#4}%
1281 \txiescapepdf\pdfoutlinedest
1284 % Also escape PDF chars in the display string.
1285 \edef\pdfoutlinetext{#1}%
1286 \txiescapepdf\pdfoutlinetext
1288 \pdfoutline goto name
{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1291 \def\pdfmakeoutlines{%
1293 % Read toc silently, to get counts of subentries for \pdfoutline.
1294 \def\partentry#
#1#
#2#
#3#
#4{}% ignore parts in the outlines
1295 \def\numchapentry#
#1#
#2#
#3#
#4{%
1296 \def\thischapnum{#
#2}%
1298 \def\thissubsecnum{0}%
1300 \def\numsecentry#
#1#
#2#
#3#
#4{%
1301 \advancenumber{chap
\thischapnum}%
1302 \def\thissecnum{#
#2}%
1303 \def\thissubsecnum{0}%
1305 \def\numsubsecentry#
#1#
#2#
#3#
#4{%
1306 \advancenumber{sec
\thissecnum}%
1307 \def\thissubsecnum{#
#2}%
1309 \def\numsubsubsecentry#
#1#
#2#
#3#
#4{%
1310 \advancenumber{subsec
\thissubsecnum}%
1312 \def\thischapnum{0}%
1314 \def\thissubsecnum{0}%
1316 % use \def rather than \let here because we redefine \chapentry et
1317 % al. a second time, below.
1318 \def\appentry{\numchapentry}%
1319 \def\appsecentry{\numsecentry}%
1320 \def\appsubsecentry{\numsubsecentry}%
1321 \def\appsubsubsecentry{\numsubsubsecentry}%
1322 \def\unnchapentry{\numchapentry}%
1323 \def\unnsecentry{\numsecentry}%
1324 \def\unnsubsecentry{\numsubsecentry}%
1325 \def\unnsubsubsecentry{\numsubsubsecentry}%
1328 % Read toc second time, this time actually producing the outlines.
1329 % The `-' means take the \expnumber as the absolute number of
1330 % subentries, which we calculated on our first read of the .toc above.
1332 % We use the node names as the destinations.
1333 \def\numchapentry#
#1#
#2#
#3#
#4{%
1334 \dopdfoutline{#
#1}{count-
\expnumber{chap#
#2}}{#
#3}{#
#4}}%
1335 \def\numsecentry#
#1#
#2#
#3#
#4{%
1336 \dopdfoutline{#
#1}{count-
\expnumber{sec#
#2}}{#
#3}{#
#4}}%
1337 \def\numsubsecentry#
#1#
#2#
#3#
#4{%
1338 \dopdfoutline{#
#1}{count-
\expnumber{subsec#
#2}}{#
#3}{#
#4}}%
1339 \def\numsubsubsecentry#
#1#
#2#
#3#
#4{% count is always zero
1340 \dopdfoutline{#
#1}{}{#
#3}{#
#4}}%
1342 % PDF outlines are displayed using system fonts, instead of
1343 % document fonts. Therefore we cannot use special characters,
1344 % since the encoding is unknown. For example, the eogonek from
1345 % Latin 2 (0xea) gets translated to a | character. Info from
1346 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1348 % TODO this right, we have to translate 8-bit characters to
1349 % their "best" equivalent, based on the @documentencoding. Too
1350 % much work for too little return. Just use the ASCII equivalents
1351 % we use for the index sort strings.
1355 % We can have normal brace characters in the PDF outlines, unlike
1356 % Texinfo index files. So set that up.
1357 \def\
{{\lbracecharliteral}%
1358 \def\
}{\rbracecharliteral}%
1359 \catcode`\\=
\active \otherbackslash
1360 \input \tocreadfilename
1363 {\catcode`
[=
1 \catcode`
]=
2
1364 \catcode`
{=
\other \catcode`
}=
\other
1365 \gdef\lbracecharliteral[{]%
1366 \gdef\rbracecharliteral[}]%
1369 \def\skipspaces#1{\def\PP{#1}\def\D{|
}%
1370 \ifx\PP\D\let\nextsp\relax
1371 \else\let\nextsp\skipspaces
1372 \addtokens{\filename}{\PP}%
1373 \advance\filenamelength by
1
1376 \def\getfilename#1{%
1378 % If we don't expand the argument now, \skipspaces will get
1379 % snagged on things like "@value{foo}".
1381 \expandafter\skipspaces\temp|
\relax
1383 \ifnum\pdftexversion <
14
1384 \let \startlink \pdfannotlink
1386 \let \startlink \pdfstartlink
1388 % make a live url in pdf output.
1391 % it seems we really need yet another set of dummies; have not
1392 % tried to figure out what each command should do in the context
1393 % of @url. for now, just make @/ a no-op, that's the only one
1394 % people have actually reported a problem with.
1396 \normalturnoffactive
1399 \makevalueexpandable
1400 % do we want to go so far as to use \indexnofonts instead of just
1401 % special-casing \var here?
1404 \leavevmode\setcolor{\urlcolor}%
1405 \startlink attr
{/Border
[0 0 0]}%
1406 user
{/Subtype /Link /A << /S /URI /URI (
#1) >>
}%
1408 \def\pdfgettoks#1.
{\setbox\boxA=
\hbox{\toksA=
{#1.
}\toksB=
{}\maketoks}}
1409 \def\addtokens#1#2{\edef\addtoks{\noexpand#1=
{\the#1#2}}\addtoks}
1410 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=
1\let\next=
\maketoks}
1411 \def\poptoks#1#2|ENDTOKS|
{\let\first=
#1\toksD=
{#1}\toksA=
{#2}}
1413 \expandafter\poptoks\the\toksA|ENDTOKS|
\relax
1415 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1416 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1417 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1419 \ifnum0=
\countA\else\makelink\fi
1420 \ifx\first.
\let\next=
\done\else
1422 \addtokens{\toksB}{\the\toksD}
1423 \ifx\first,
\addtokens{\toksB}{\space}\fi
1425 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1427 \def\makelink{\addtokens{\toksB}%
1428 {\noexpand\pdflink{\the\toksC}}\toksC=
{}\global\countA=
0}
1430 \startlink attr
{/Border
[0 0 0]} goto name
{\pdfmkpgn{#1}}
1431 \setcolor{\linkcolor}#1\endlink}
1432 \def\done{\edef\st{\global\noexpand\toksA=
{\the\toksB}}\st}
1435 \let\pdfmkdest =
\gobble
1436 \let\pdfurl =
\gobble
1437 \let\endlink =
\relax
1438 \let\setcolor =
\gobble
1439 \let\pdfsetcolor =
\gobble
1440 \let\pdfmakeoutlines =
\relax
1441 \fi % \ifx\pdfoutput
1446 % Change the current font style to #1, remembering it in \curfontstyle.
1447 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1448 % italics, not bold italics.
1450 \def\setfontstyle#1{%
1451 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1452 \csname ten
#1\endcsname % change the current font
1455 % Select #1 fonts with the current style.
1457 \def\selectfonts#1{\csname #1fonts
\endcsname \csname\curfontstyle\endcsname}
1459 \def\rm{\fam=
0 \setfontstyle{rm
}}
1460 \def\it{\fam=
\itfam \setfontstyle{it
}}
1461 \def\sl{\fam=
\slfam \setfontstyle{sl
}}
1462 \def\bf{\fam=
\bffam \setfontstyle{bf
}}\def\bfstylename{bf
}
1463 \def\tt{\fam=
\ttfam \setfontstyle{tt
}}
1465 % Unfortunately, we have to override this for titles and the like, since
1466 % in those cases "rm" is bold. Sigh.
1467 \def\rmisbold{\rm\def\curfontstyle{bf
}}
1469 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1470 % So we set up a \sf.
1472 \def\sf{\fam=
\sffam \setfontstyle{sf
}}
1473 \let\li =
\sf % Sometimes we call it \li, not \sf.
1475 % We don't need math for this font style.
1476 \def\ttsl{\setfontstyle{ttsl
}}
1479 % Set the baselineskip to #1, and the lineskip and strut size
1480 % correspondingly. There is no deep meaning behind these magic numbers
1481 % used as factors; they just match (closely enough) what Knuth defined.
1483 \def\lineskipfactor{.08333}
1484 \def\strutheightpercent{.70833}
1485 \def\strutdepthpercent {.29167}
1487 % can get a sort of poor man's double spacing by redefining this.
1488 \def\baselinefactor{1}
1490 \newdimen\textleading
1493 \normalbaselineskip =
\baselinefactor\dimen0
1494 \normallineskip =
\lineskipfactor\normalbaselineskip
1496 \setbox\strutbox =
\hbox{%
1497 \vrule width0pt height
\strutheightpercent\baselineskip
1498 depth
\strutdepthpercent \baselineskip
1502 % PDF CMaps. See also LaTeX's t1.cmap.
1504 % do nothing with this by default.
1505 \expandafter\let\csname cmapOT1
\endcsname\gobble
1506 \expandafter\let\csname cmapOT1IT
\endcsname\gobble
1507 \expandafter\let\csname cmapOT1TT
\endcsname\gobble
1509 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1510 % (\pdffontattr was introduced many years ago, but people still run
1511 % older pdftex's; it's easy to conditionalize, so we do.)
1512 \ifpdf \ifx\pdffontattr\thisisundefined \else
1514 \catcode`\^^M=
\active \def^^M
{^^J
}% Output line endings as the ^^J char.
1515 \catcode`\%=
12 \immediate\pdfobj stream
{%!PS-Adobe-3.0 Resource-CMap
1516 %%DocumentNeededResources: ProcSet (CIDInit)
1517 %%IncludeResource: ProcSet (CIDInit)
1518 %%BeginResource: CMap (TeX-OT1-0)
1519 %%Title: (TeX-OT1-0 TeX OT1 0)
1522 /CIDInit /ProcSet findresource begin
1530 /CMapName /TeX-OT1-
0 def
1532 1 begincodespacerange
1588 CMapName currentdict /CMap defineresource pop
1594 \expandafter\edef\csname cmapOT1
\endcsname#1{%
1595 \pdffontattr#1{/ToUnicode
\the\pdflastobj\space 0 R
}%
1600 \catcode`\^^M=
\active \def^^M
{^^J
}% Output line endings as the ^^J char.
1601 \catcode`\%=
12 \immediate\pdfobj stream
{%!PS-Adobe-3.0 Resource-CMap
1602 %%DocumentNeededResources: ProcSet (CIDInit)
1603 %%IncludeResource: ProcSet (CIDInit)
1604 %%BeginResource: CMap (TeX-OT1IT-0)
1605 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1608 /CIDInit /ProcSet findresource begin
1616 /CMapName /TeX-OT1IT-
0 def
1618 1 begincodespacerange
1676 CMapName currentdict /CMap defineresource pop
1682 \expandafter\edef\csname cmapOT1IT
\endcsname#1{%
1683 \pdffontattr#1{/ToUnicode
\the\pdflastobj\space 0 R
}%
1688 \catcode`\^^M=
\active \def^^M
{^^J
}% Output line endings as the ^^J char.
1689 \catcode`\%=
12 \immediate\pdfobj stream
{%!PS-Adobe-3.0 Resource-CMap
1690 %%DocumentNeededResources: ProcSet (CIDInit)
1691 %%IncludeResource: ProcSet (CIDInit)
1692 %%BeginResource: CMap (TeX-OT1TT-0)
1693 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1696 /CIDInit /ProcSet findresource begin
1704 /CMapName /TeX-OT1TT-
0 def
1706 1 begincodespacerange
1751 CMapName currentdict /CMap defineresource pop
1757 \expandafter\edef\csname cmapOT1TT
\endcsname#1{%
1758 \pdffontattr#1{/ToUnicode
\the\pdflastobj\space 0 R
}%
1763 % Set the font macro #1 to the font named \fontprefix#2.
1764 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1765 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
1773 \def\setfont#1#2#3#4#5{%
1774 \font#1=
\fontprefix#2#3 scaled
#4
1775 \csname cmap
#5\endcsname#1%
1777 % This is what gets called when #5 of \setfont is empty.
1782 % Use cm as the default font prefix.
1783 % To specify the font prefix, you must define \fontprefix
1784 % before you read in texinfo.tex.
1785 \ifx\fontprefix\thisisundefined
1788 % Support font families that don't use the same naming scheme as CM.
1790 \def\rmbshape{bx
} % where the normal face is bold
1795 \def\ttslshape{sltt
}
1805 % Definitions for a main text size of 11pt. (The default in Texinfo.)
1807 \def\definetextfontsizexi{%
1808 % Text fonts (11.2pt, magstep1).
1809 \def\textnominalsize{11pt
}
1810 \edef\mainmagstep{\magstephalf}
1811 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1
}
1812 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT
}
1813 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1
}
1814 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT
}
1815 \setfont\textsl\slshape{10}{\mainmagstep}{OT1
}
1816 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1
}
1817 \setfont\textsc\scshape{10}{\mainmagstep}{OT1
}
1818 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT
}
1819 \font\texti=cmmi10 scaled
\mainmagstep
1820 \font\textsy=cmsy10 scaled
\mainmagstep
1821 \def\textecsize{1095}
1823 % A few fonts for @defun names and args.
1824 \setfont\defbf\bfshape{10}{\magstep1}{OT1
}
1825 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT
}
1826 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT
}
1827 \def\df{\let\tentt=
\deftt \let\tenbf =
\defbf \let\tenttsl=
\defttsl \bf}
1829 % Fonts for indices, footnotes, small examples (9pt).
1830 \def\smallnominalsize{9pt
}
1831 \setfont\smallrm\rmshape{9}{1000}{OT1
}
1832 \setfont\smalltt\ttshape{9}{1000}{OT1TT
}
1833 \setfont\smallbf\bfshape{10}{900}{OT1
}
1834 \setfont\smallit\itshape{9}{1000}{OT1IT
}
1835 \setfont\smallsl\slshape{9}{1000}{OT1
}
1836 \setfont\smallsf\sfshape{9}{1000}{OT1
}
1837 \setfont\smallsc\scshape{10}{900}{OT1
}
1838 \setfont\smallttsl\ttslshape{10}{900}{OT1TT
}
1841 \def\smallecsize{0900}
1843 % Fonts for small examples (8pt).
1844 \def\smallernominalsize{8pt
}
1845 \setfont\smallerrm\rmshape{8}{1000}{OT1
}
1846 \setfont\smallertt\ttshape{8}{1000}{OT1TT
}
1847 \setfont\smallerbf\bfshape{10}{800}{OT1
}
1848 \setfont\smallerit\itshape{8}{1000}{OT1IT
}
1849 \setfont\smallersl\slshape{8}{1000}{OT1
}
1850 \setfont\smallersf\sfshape{8}{1000}{OT1
}
1851 \setfont\smallersc\scshape{10}{800}{OT1
}
1852 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT
}
1853 \font\smalleri=cmmi8
1854 \font\smallersy=cmsy8
1855 \def\smallerecsize{0800}
1857 % Fonts for title page (20.4pt):
1858 \def\titlenominalsize{20pt
}
1859 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1
}
1860 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT
}
1861 \setfont\titlesl\slbshape{10}{\magstep4}{OT1
}
1862 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT
}
1863 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT
}
1864 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1
}
1865 \let\titlebf=
\titlerm
1866 \setfont\titlesc\scbshape{10}{\magstep4}{OT1
}
1867 \font\titlei=cmmi12 scaled
\magstep3
1868 \font\titlesy=cmsy10 scaled
\magstep4
1869 \def\titleecsize{2074}
1871 % Chapter (and unnumbered) fonts (17.28pt).
1872 \def\chapnominalsize{17pt
}
1873 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1
}
1874 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT
}
1875 \setfont\chapsl\slbshape{10}{\magstep3}{OT1
}
1876 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT
}
1877 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT
}
1878 \setfont\chapsf\sfbshape{17}{1000}{OT1
}
1880 \setfont\chapsc\scbshape{10}{\magstep3}{OT1
}
1881 \font\chapi=cmmi12 scaled
\magstep2
1882 \font\chapsy=cmsy10 scaled
\magstep3
1883 \def\chapecsize{1728}
1885 % Section fonts (14.4pt).
1886 \def\secnominalsize{14pt
}
1887 \setfont\secrm\rmbshape{12}{\magstep1}{OT1
}
1888 \setfont\secit\itbshape{10}{\magstep2}{OT1IT
}
1889 \setfont\secsl\slbshape{10}{\magstep2}{OT1
}
1890 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT
}
1891 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT
}
1892 \setfont\secsf\sfbshape{12}{\magstep1}{OT1
}
1894 \setfont\secsc\scbshape{10}{\magstep2}{OT1
}
1895 \font\seci=cmmi12 scaled
\magstep1
1896 \font\secsy=cmsy10 scaled
\magstep2
1897 \def\sececsize{1440}
1899 % Subsection fonts (13.15pt).
1900 \def\ssecnominalsize{13pt
}
1901 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1
}
1902 \setfont\ssecit\itbshape{10}{1315}{OT1IT
}
1903 \setfont\ssecsl\slbshape{10}{1315}{OT1
}
1904 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT
}
1905 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT
}
1906 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1
}
1908 \setfont\ssecsc\scbshape{10}{1315}{OT1
}
1909 \font\sseci=cmmi12 scaled
\magstephalf
1910 \font\ssecsy=cmsy10 scaled
1315
1911 \def\ssececsize{1200}
1913 % Reduced fonts for @acro in text (10pt).
1914 \def\reducednominalsize{10pt
}
1915 \setfont\reducedrm\rmshape{10}{1000}{OT1
}
1916 \setfont\reducedtt\ttshape{10}{1000}{OT1TT
}
1917 \setfont\reducedbf\bfshape{10}{1000}{OT1
}
1918 \setfont\reducedit\itshape{10}{1000}{OT1IT
}
1919 \setfont\reducedsl\slshape{10}{1000}{OT1
}
1920 \setfont\reducedsf\sfshape{10}{1000}{OT1
}
1921 \setfont\reducedsc\scshape{10}{1000}{OT1
}
1922 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT
}
1923 \font\reducedi=cmmi10
1924 \font\reducedsy=cmsy10
1925 \def\reducedecsize{1000}
1927 \textleading =
13.2pt
% line spacing for 11pt CM
1928 \textfonts % reset the current fonts
1930 } % end of 11pt text font size definitions, \definetextfontsizexi
1933 % Definitions to make the main text be 10pt Computer Modern, with
1934 % section, chapter, etc., sizes following suit. This is for the GNU
1935 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1936 % future. Used with @smallbook, which sets the leading to 12pt.
1938 \def\definetextfontsizex{%
1939 % Text fonts (10pt).
1940 \def\textnominalsize{10pt
}
1941 \edef\mainmagstep{1000}
1942 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1
}
1943 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT
}
1944 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1
}
1945 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT
}
1946 \setfont\textsl\slshape{10}{\mainmagstep}{OT1
}
1947 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1
}
1948 \setfont\textsc\scshape{10}{\mainmagstep}{OT1
}
1949 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT
}
1950 \font\texti=cmmi10 scaled
\mainmagstep
1951 \font\textsy=cmsy10 scaled
\mainmagstep
1952 \def\textecsize{1000}
1954 % A few fonts for @defun names and args.
1955 \setfont\defbf\bfshape{10}{\magstephalf}{OT1
}
1956 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT
}
1957 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT
}
1958 \def\df{\let\tentt=
\deftt \let\tenbf =
\defbf \let\tenttsl=
\defttsl \bf}
1960 % Fonts for indices, footnotes, small examples (9pt).
1961 \def\smallnominalsize{9pt
}
1962 \setfont\smallrm\rmshape{9}{1000}{OT1
}
1963 \setfont\smalltt\ttshape{9}{1000}{OT1TT
}
1964 \setfont\smallbf\bfshape{10}{900}{OT1
}
1965 \setfont\smallit\itshape{9}{1000}{OT1IT
}
1966 \setfont\smallsl\slshape{9}{1000}{OT1
}
1967 \setfont\smallsf\sfshape{9}{1000}{OT1
}
1968 \setfont\smallsc\scshape{10}{900}{OT1
}
1969 \setfont\smallttsl\ttslshape{10}{900}{OT1TT
}
1972 \def\smallecsize{0900}
1974 % Fonts for small examples (8pt).
1975 \def\smallernominalsize{8pt
}
1976 \setfont\smallerrm\rmshape{8}{1000}{OT1
}
1977 \setfont\smallertt\ttshape{8}{1000}{OT1TT
}
1978 \setfont\smallerbf\bfshape{10}{800}{OT1
}
1979 \setfont\smallerit\itshape{8}{1000}{OT1IT
}
1980 \setfont\smallersl\slshape{8}{1000}{OT1
}
1981 \setfont\smallersf\sfshape{8}{1000}{OT1
}
1982 \setfont\smallersc\scshape{10}{800}{OT1
}
1983 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT
}
1984 \font\smalleri=cmmi8
1985 \font\smallersy=cmsy8
1986 \def\smallerecsize{0800}
1988 % Fonts for title page (20.4pt):
1989 \def\titlenominalsize{20pt
}
1990 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1
}
1991 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT
}
1992 \setfont\titlesl\slbshape{10}{\magstep4}{OT1
}
1993 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT
}
1994 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT
}
1995 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1
}
1996 \let\titlebf=
\titlerm
1997 \setfont\titlesc\scbshape{10}{\magstep4}{OT1
}
1998 \font\titlei=cmmi12 scaled
\magstep3
1999 \font\titlesy=cmsy10 scaled
\magstep4
2000 \def\titleecsize{2074}
2002 % Chapter fonts (14.4pt).
2003 \def\chapnominalsize{14pt
}
2004 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1
}
2005 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT
}
2006 \setfont\chapsl\slbshape{10}{\magstep2}{OT1
}
2007 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT
}
2008 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT
}
2009 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1
}
2011 \setfont\chapsc\scbshape{10}{\magstep2}{OT1
}
2012 \font\chapi=cmmi12 scaled
\magstep1
2013 \font\chapsy=cmsy10 scaled
\magstep2
2014 \def\chapecsize{1440}
2016 % Section fonts (12pt).
2017 \def\secnominalsize{12pt
}
2018 \setfont\secrm\rmbshape{12}{1000}{OT1
}
2019 \setfont\secit\itbshape{10}{\magstep1}{OT1IT
}
2020 \setfont\secsl\slbshape{10}{\magstep1}{OT1
}
2021 \setfont\sectt\ttbshape{12}{1000}{OT1TT
}
2022 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT
}
2023 \setfont\secsf\sfbshape{12}{1000}{OT1
}
2025 \setfont\secsc\scbshape{10}{\magstep1}{OT1
}
2027 \font\secsy=cmsy10 scaled
\magstep1
2028 \def\sececsize{1200}
2030 % Subsection fonts (10pt).
2031 \def\ssecnominalsize{10pt
}
2032 \setfont\ssecrm\rmbshape{10}{1000}{OT1
}
2033 \setfont\ssecit\itbshape{10}{1000}{OT1IT
}
2034 \setfont\ssecsl\slbshape{10}{1000}{OT1
}
2035 \setfont\ssectt\ttbshape{10}{1000}{OT1TT
}
2036 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT
}
2037 \setfont\ssecsf\sfbshape{10}{1000}{OT1
}
2039 \setfont\ssecsc\scbshape{10}{1000}{OT1
}
2042 \def\ssececsize{1000}
2044 % Reduced fonts for @acro in text (9pt).
2045 \def\reducednominalsize{9pt
}
2046 \setfont\reducedrm\rmshape{9}{1000}{OT1
}
2047 \setfont\reducedtt\ttshape{9}{1000}{OT1TT
}
2048 \setfont\reducedbf\bfshape{10}{900}{OT1
}
2049 \setfont\reducedit\itshape{9}{1000}{OT1IT
}
2050 \setfont\reducedsl\slshape{9}{1000}{OT1
}
2051 \setfont\reducedsf\sfshape{9}{1000}{OT1
}
2052 \setfont\reducedsc\scshape{10}{900}{OT1
}
2053 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT
}
2054 \font\reducedi=cmmi9
2055 \font\reducedsy=cmsy9
2056 \def\reducedecsize{0900}
2058 \divide\parskip by
2 % reduce space between paragraphs
2059 \textleading =
12pt
% line spacing for 10pt CM
2060 \textfonts % reset the current fonts
2062 } % end of 10pt text font size definitions, \definetextfontsizex
2065 % We provide the user-level command
2067 % (or 11) to redefine the text font size. pt is assumed.
2073 \parseargdef\fonttextsize{%
2074 \def\textsizearg{#1}%
2075 %\wlog{doing @fonttextsize \textsizearg}%
2077 % Set \globaldefs so that documents can use this inside @tex, since
2078 % makeinfo 4.8 does not support it, but we need it nonetheless.
2080 \begingroup \globaldefs=
1
2081 \ifx\textsizearg\xword \definetextfontsizex
2082 \else \ifx\textsizearg\xiword \definetextfontsizexi
2085 \errmessage{@fonttextsize only supports `
10' or `
11', not `
\textsizearg'
}
2091 % In order for the font changes to affect most math symbols and letters,
2092 % we have to define the \textfont of the standard families. Since
2093 % texinfo doesn't allow for producing subscripts and superscripts except
2094 % in the main text, we don't bother to reset \scriptfont and
2095 % \scriptscriptfont (which would also require loading a lot more fonts).
2097 \def\resetmathfonts{%
2098 \textfont0=
\tenrm \textfont1=
\teni \textfont2=
\tensy
2099 \textfont\itfam=
\tenit \textfont\slfam=
\tensl \textfont\bffam=
\tenbf
2100 \textfont\ttfam=
\tentt \textfont\sffam=
\tensf
2103 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2104 % of just \STYLE. We do this because \STYLE needs to also set the
2105 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2106 % \tenSTYLE to set the current font.
2108 % Each font-changing command also sets the names \lsize (one size lower)
2109 % and \lllsize (three sizes lower). These relative commands are used in
2110 % the LaTeX logo and acronyms.
2112 % This all needs generalizing, badly.
2115 \let\tenrm=
\textrm \let\tenit=
\textit \let\tensl=
\textsl
2116 \let\tenbf=
\textbf \let\tentt=
\texttt \let\smallcaps=
\textsc
2117 \let\tensf=
\textsf \let\teni=
\texti \let\tensy=
\textsy
2118 \let\tenttsl=
\textttsl
2119 \def\curfontsize{text
}%
2120 \def\lsize{reduced
}\def\lllsize{smaller
}%
2121 \resetmathfonts \setleading{\textleading}}
2123 \let\tenrm=
\titlerm \let\tenit=
\titleit \let\tensl=
\titlesl
2124 \let\tenbf=
\titlebf \let\tentt=
\titlett \let\smallcaps=
\titlesc
2125 \let\tensf=
\titlesf \let\teni=
\titlei \let\tensy=
\titlesy
2126 \let\tenttsl=
\titlettsl
2127 \def\curfontsize{title
}%
2128 \def\lsize{chap
}\def\lllsize{subsec
}%
2129 \resetmathfonts \setleading{27pt
}}
2130 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2132 \let\tenrm=
\chaprm \let\tenit=
\chapit \let\tensl=
\chapsl
2133 \let\tenbf=
\chapbf \let\tentt=
\chaptt \let\smallcaps=
\chapsc
2134 \let\tensf=
\chapsf \let\teni=
\chapi \let\tensy=
\chapsy
2135 \let\tenttsl=
\chapttsl
2136 \def\curfontsize{chap
}%
2137 \def\lsize{sec
}\def\lllsize{text
}%
2138 \resetmathfonts \setleading{19pt
}}
2140 \let\tenrm=
\secrm \let\tenit=
\secit \let\tensl=
\secsl
2141 \let\tenbf=
\secbf \let\tentt=
\sectt \let\smallcaps=
\secsc
2142 \let\tensf=
\secsf \let\teni=
\seci \let\tensy=
\secsy
2143 \let\tenttsl=
\secttsl
2144 \def\curfontsize{sec
}%
2145 \def\lsize{subsec
}\def\lllsize{reduced
}%
2146 \resetmathfonts \setleading{16pt
}}
2148 \let\tenrm=
\ssecrm \let\tenit=
\ssecit \let\tensl=
\ssecsl
2149 \let\tenbf=
\ssecbf \let\tentt=
\ssectt \let\smallcaps=
\ssecsc
2150 \let\tensf=
\ssecsf \let\teni=
\sseci \let\tensy=
\ssecsy
2151 \let\tenttsl=
\ssecttsl
2152 \def\curfontsize{ssec
}%
2153 \def\lsize{text
}\def\lllsize{small
}%
2154 \resetmathfonts \setleading{15pt
}}
2155 \let\subsubsecfonts =
\subsecfonts
2157 \let\tenrm=
\reducedrm \let\tenit=
\reducedit \let\tensl=
\reducedsl
2158 \let\tenbf=
\reducedbf \let\tentt=
\reducedtt \let\reducedcaps=
\reducedsc
2159 \let\tensf=
\reducedsf \let\teni=
\reducedi \let\tensy=
\reducedsy
2160 \let\tenttsl=
\reducedttsl
2161 \def\curfontsize{reduced
}%
2162 \def\lsize{small
}\def\lllsize{smaller
}%
2163 \resetmathfonts \setleading{10.5pt
}}
2165 \let\tenrm=
\smallrm \let\tenit=
\smallit \let\tensl=
\smallsl
2166 \let\tenbf=
\smallbf \let\tentt=
\smalltt \let\smallcaps=
\smallsc
2167 \let\tensf=
\smallsf \let\teni=
\smalli \let\tensy=
\smallsy
2168 \let\tenttsl=
\smallttsl
2169 \def\curfontsize{small
}%
2170 \def\lsize{smaller
}\def\lllsize{smaller
}%
2171 \resetmathfonts \setleading{10.5pt
}}
2173 \let\tenrm=
\smallerrm \let\tenit=
\smallerit \let\tensl=
\smallersl
2174 \let\tenbf=
\smallerbf \let\tentt=
\smallertt \let\smallcaps=
\smallersc
2175 \let\tensf=
\smallersf \let\teni=
\smalleri \let\tensy=
\smallersy
2176 \let\tenttsl=
\smallerttsl
2177 \def\curfontsize{smaller
}%
2178 \def\lsize{smaller
}\def\lllsize{smaller
}%
2179 \resetmathfonts \setleading{9.5pt
}}
2181 % Fonts for short table of contents.
2182 \setfont\shortcontrm\rmshape{12}{1000}{OT1
}
2183 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1
} % no cmb12
2184 \setfont\shortcontsl\slshape{12}{1000}{OT1
}
2185 \setfont\shortconttt\ttshape{12}{1000}{OT1TT
}
2187 % Define these just so they can be easily changed for other fonts.
2188 \def\angleleft{$
\langle$
}
2189 \def\angleright{$
\rangle$
}
2191 % Set the fonts to use with the @small... environments.
2192 \let\smallexamplefonts =
\smallfonts
2194 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2195 % can fit this many characters:
2196 % 8.5x11=86 smallbook=72 a4=90 a5=69
2197 % If we use \scriptfonts (8pt), then we can fit this many characters:
2198 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2199 % For me, subjectively, the few extra characters that fit aren't worth
2200 % the additional smallness of 8pt. So I'm making the default 9pt.
2202 % By the way, for comparison, here's what fits with @example (10pt):
2203 % 8.5x11=71 smallbook=60 a4=75 a5=58
2206 % Set up the default fonts, so we can use them for creating boxes.
2208 \definetextfontsizexi
2213 % Check if we are currently using a typewriter font. Since all the
2214 % Computer Modern typewriter fonts have zero interword stretch (and
2215 % shrink), and it is reasonable to expect all typewriter fonts to have
2216 % this property, we can check that font parameter.
2218 \def\ifmonospace{\ifdim\fontdimen3\font=
0pt
}
2220 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2221 % define and register \INITMACRO to be called on markup style changes.
2222 % \INITMACRO can check \currentmarkupstyle for the innermost
2223 % style and the set of \ifmarkupSTYLE switches for all styles
2224 % currently in effect.
2228 %\newif\ifmarkupfile % @file == @samp.
2229 %\newif\ifmarkupoption % @option == @samp.
2232 %\newif\ifmarkupenv % @env == @code.
2233 %\newif\ifmarkupcommand % @command == @code.
2234 \newif\ifmarkuptex % @tex (and part of @math, for now).
2235 \newif\ifmarkupexample
2237 \newif\ifmarkupverbatim
2239 \let\currentmarkupstyle\empty
2241 \def\setupmarkupstyle#1{%
2242 \csname markup
#1true
\endcsname
2243 \def\currentmarkupstyle{#1}%
2247 \let\markupstylesetup\empty
2249 \def\defmarkupstylesetup#1{%
2250 \expandafter\def\expandafter\markupstylesetup
2251 \expandafter{\markupstylesetup #1}%
2255 % Markup style setup for left and right quotes.
2256 \defmarkupstylesetup\markupsetuplq{%
2257 \expandafter\let\expandafter \temp
2258 \csname markupsetuplq
\currentmarkupstyle\endcsname
2259 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2262 \defmarkupstylesetup\markupsetuprq{%
2263 \expandafter\let\expandafter \temp
2264 \csname markupsetuprq
\currentmarkupstyle\endcsname
2265 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2272 \gdef\markupsetuplqdefault{\let`
\lq}
2273 \gdef\markupsetuprqdefault{\let'
\rq}
2275 \gdef\markupsetcodequoteleft{\let`
\codequoteleft}
2276 \gdef\markupsetcodequoteright{\let'
\codequoteright}
2279 \let\markupsetuplqcode \markupsetcodequoteleft
2280 \let\markupsetuprqcode \markupsetcodequoteright
2282 \let\markupsetuplqexample \markupsetcodequoteleft
2283 \let\markupsetuprqexample \markupsetcodequoteright
2285 \let\markupsetuplqkbd \markupsetcodequoteleft
2286 \let\markupsetuprqkbd \markupsetcodequoteright
2288 \let\markupsetuplqsamp \markupsetcodequoteleft
2289 \let\markupsetuprqsamp \markupsetcodequoteright
2291 \let\markupsetuplqverb \markupsetcodequoteleft
2292 \let\markupsetuprqverb \markupsetcodequoteright
2294 \let\markupsetuplqverbatim \markupsetcodequoteleft
2295 \let\markupsetuprqverbatim \markupsetcodequoteright
2297 % Allow an option to not use regular directed right quote/apostrophe
2298 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2299 % The undirected quote is ugly, so don't make it the default, but it
2300 % works for pasting with more pdf viewers (at least evince), the
2301 % lilypond developers report. xpdf does work with the regular 0x27.
2303 \def\codequoteright{%
2304 \expandafter\ifx\csname SETtxicodequoteundirected
\endcsname\relax
2305 \expandafter\ifx\csname SETcodequoteundirected
\endcsname\relax
2311 % and a similar option for the left quote char vs. a grave accent.
2312 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2313 % the code environments to do likewise.
2315 \def\codequoteleft{%
2316 \expandafter\ifx\csname SETtxicodequotebacktick
\endcsname\relax
2317 \expandafter\ifx\csname SETcodequotebacktick
\endcsname\relax
2318 % [Knuth] pp. 380,381,391
2319 % \relax disables Spanish ligatures ?` and !` of \tt font.
2325 % Commands to set the quote options.
2327 \parseargdef\codequoteundirected{%
2330 \expandafter\let\csname SETtxicodequoteundirected
\endcsname
2332 \else\ifx\temp\offword
2333 \expandafter\let\csname SETtxicodequoteundirected
\endcsname
2336 \errhelp =
\EMsimple
2337 \errmessage{Unknown @codequoteundirected value `
\temp', must be on|off
}%
2341 \parseargdef\codequotebacktick{%
2344 \expandafter\let\csname SETtxicodequotebacktick
\endcsname
2346 \else\ifx\temp\offword
2347 \expandafter\let\csname SETtxicodequotebacktick
\endcsname
2350 \errhelp =
\EMsimple
2351 \errmessage{Unknown @codequotebacktick value `
\temp', must be on|off
}%
2355 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2356 \def\noligaturesquoteleft{\relax\lq}
2358 % Count depth in font-changes, for error checks
2359 \newcount\fontdepth \fontdepth=
0
2363 % #1 is the font command (\sl or \it), #2 is the text to slant.
2364 % If we are in a monospaced environment, however, 1) always use \ttsl,
2365 % and 2) do not add an italic correction.
2366 \def\dosmartslant#1#2{%
2368 {{\ttsl #2}\let\next=
\relax}%
2369 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2372 \def\smartslanted{\dosmartslant\sl}
2373 \def\smartitalic{\dosmartslant\it}
2375 % Output an italic correction unless \next (presumed to be the following
2376 % character) is such as not to need one.
2377 \def\smartitaliccorrection{%
2382 \else\ifx\next\comma%
2388 % Unconditional use \ttsl, and no ic. @var is set to this for defuns.
2389 \def\ttslanted#1{{\ttsl #1}}
2391 % @cite is like \smartslanted except unconditionally use \sl. We never want
2392 % ttsl for book titles, do we?
2393 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2397 \let\saveaftersmartic =
\aftersmartic
2398 \def\aftersmartic{\null\let\aftersmartic=
\saveaftersmartic}%
2403 \let\slanted=
\smartslanted
2404 \let\dfn=
\smartslanted
2405 \let\emph=
\smartitalic
2407 % Explicit font changes: @r, @sc, undocumented @ii.
2408 \def\r#1{{\rm #1}} % roman font
2409 \def\sc#1{{\smallcaps#1}} % smallcaps font
2410 \def\ii#1{{\it #1}} % italic font
2412 % @b, explicit bold. Also @strong.
2416 % @sansserif, explicit sans.
2417 \def\sansserif#1{{\sf #1}}
2419 % We can't just use \exhyphenpenalty, because that only has effect at
2420 % the end of a paragraph. Restore normal hyphenation at the end of the
2421 % group within which \nohyphenation is presumably called.
2423 \def\nohyphenation{\hyphenchar\font = -
1 \aftergroup\restorehyphenation}
2424 \def\restorehyphenation{\hyphenchar\font = `-
}
2426 % Set sfcode to normal for the chars that usually have another value.
2427 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2428 % sometimes \x has an active definition that messes things up.
2431 \def\plainfrenchspacing{%
2432 \sfcode\dotChar =\@m
\sfcode\questChar=\@m
\sfcode\exclamChar=\@m
2433 \sfcode\colonChar=\@m
\sfcode\semiChar =\@m
\sfcode\commaChar =\@m
2434 \def\endofsentencespacefactor{1000}% for @. and friends
2436 \def\plainnonfrenchspacing{%
2437 \sfcode`\
.3000\sfcode`\?
3000\sfcode`\!
3000
2438 \sfcode`\:
2000\sfcode`\;
1500\sfcode`\,
1250
2439 \def\endofsentencespacefactor{3000}% for @. and friends
2442 \def\endofsentencespacefactor{3000}% default
2444 % @t, explicit typewriter.
2446 {\tt \rawbackslash \plainfrenchspacing #1}%
2451 \def\samp#1{{\setupmarkupstyle{samp
}\lq\tclose{#1}\rq\null}}
2453 % @indicateurl is \samp, that is, with quotes.
2454 \let\indicateurl=
\samp
2456 % @code (and similar) prints in typewriter, but with spaces the same
2457 % size as normal in the surrounding text, without hyphenation, etc.
2458 % This is a subroutine for that.
2461 % Change normal interword space to be same as for the current font.
2462 \spaceskip =
\fontdimen2\font
2464 % Switch to typewriter.
2467 % But `\ ' produces the large typewriter interword space.
2468 \def\
{{\spaceskip =
0pt
{} }}%
2470 % Turn off hyphenation.
2477 \null % reset spacefactor to 1000
2480 % We *must* turn on hyphenation at `-' and `_' in @code.
2481 % (But see \codedashfinish below.)
2482 % Otherwise, it is too hard to avoid overfull hboxes
2483 % in the Emacs manual, the Library manual, etc.
2485 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2486 % both hyphenation at - and hyphenation within words.
2487 % We must therefore turn them both off (\tclose does that)
2488 % and arrange explicitly to hyphenate at a dash. -- rms.
2490 \catcode`\-=
\active \catcode`
\_=
\active
2491 \catcode`\'=
\active \catcode`\`=
\active
2492 \global\let'=
\rq \global\let`=
\lq % default definitions
2494 \global\def\code{\begingroup
2495 \setupmarkupstyle{code
}%
2496 % The following should really be moved into \setupmarkupstyle handlers.
2497 \catcode\dashChar=
\active \catcode\underChar=
\active
2505 % Given -foo (with a single dash), we do not want to allow a break
2507 \global\let\codedashprev=
\codedash
2512 \gdef\codedash{\futurelet\next\codedashfinish}
2513 \gdef\codedashfinish{%
2514 \normaldash % always output the dash character itself.
2516 % Now, output a discretionary to allow a line break, unless
2517 % (a) the next character is a -, or
2518 % (b) the preceding character is a -.
2519 % E.g., given --posix, we do not want to allow a break after either -.
2520 % Given --foo-bar, we do want to allow a break between the - and the b.
2521 \ifx\next\codedash \else
2522 \ifx\codedashprev\codedash
2523 \else \discretionary{}{}{}\fi
2525 % we need the space after the = for the case when \next itself is a
2526 % space token; it would get swallowed otherwise. As in @code{- a}.
2527 \global\let\codedashprev=
\next
2532 \def\codex #1{\tclose{#1}\endgroup}
2535 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2536 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2537 % will therefore expand the active definition of _, which is us
2538 % (inside @code that is), therefore an endless loop.
2540 \mathchar"
075F
% class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2541 \else\normalunderscore \fi
2542 \discretionary{}{}{}}%
2546 % An additional complication: the above will allow breaks after, e.g.,
2547 % each of the four underscores in __typeof__. This is bad.
2548 % @allowcodebreaks provides a document-level way to turn breaking at -
2551 \newif\ifallowcodebreaks \allowcodebreakstrue
2553 \def\keywordtrue{true
}
2554 \def\keywordfalse{false
}
2556 \parseargdef\allowcodebreaks{%
2558 \ifx\txiarg\keywordtrue
2559 \allowcodebreakstrue
2560 \else\ifx\txiarg\keywordfalse
2561 \allowcodebreaksfalse
2563 \errhelp =
\EMsimple
2564 \errmessage{Unknown @allowcodebreaks option `
\txiarg', must be true|false
}%
2568 % For @command, @env, @file, @option quotes seem unnecessary,
2569 % so use \code rather than \samp.
2575 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2576 % second argument specifying the text to display and an optional third
2577 % arg as text to display instead of (rather than in addition to) the url
2578 % itself. First (mandatory) arg is the url.
2579 % (This \urefnobreak definition isn't used now, leaving it for a while
2581 \def\urefnobreak#1{\dourefnobreak #1,,,
\finish}
2582 \def\dourefnobreak#1,
#2,
#3,
#4\finish{\begingroup
2585 \setbox0 =
\hbox{\ignorespaces #3}%
2587 \unhbox0 % third arg given, show only that
2589 \setbox0 =
\hbox{\ignorespaces #2}%
2592 \unhbox0 % PDF: 2nd arg given, show only it
2594 \unhbox0\ (
\code{#1})
% DVI: 2nd arg given, show both it and url
2597 \code{#1}% only url given, so show it
2603 % This \urefbreak definition is the active one.
2604 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2605 \let\uref=
\urefbreak
2606 \def\dourefbreak#1{\urefbreakfinish #1,,,
\finish}
2607 \def\urefbreakfinish#1,
#2,
#3,
#4\finish{% doesn't work in @example
2610 \setbox0 =
\hbox{\ignorespaces #3}%
2612 \unhbox0 % third arg given, show only that
2614 \setbox0 =
\hbox{\ignorespaces #2}%
2617 \unhbox0 % PDF: 2nd arg given, show only it
2619 \unhbox0\ (
\urefcode{#1})
% DVI: 2nd arg given, show both it and url
2622 \urefcode{#1}% only url given, so show it
2628 % Allow line breaks around only a few characters (only).
2630 \catcode\ampChar=
\active \catcode\dotChar=
\active
2631 \catcode\hashChar=
\active \catcode\questChar=
\active
2632 \catcode\slashChar=
\active
2637 \global\def\urefcode{\begingroup
2638 \setupmarkupstyle{code
}%
2648 % By default, they are just regular characters.
2649 \global\def&
{\normalamp}
2650 \global\def.
{\normaldot}
2651 \global\def#
{\normalhash}
2652 \global\def?
{\normalquest}
2653 \global\def/
{\normalslash}
2656 % we put a little stretch before and after the breakable chars, to help
2657 % line breaking of long url's. The unequal skips make look better in
2658 % cmtt at least, especially for dots.
2659 \def\urefprestretch{\urefprebreak \hskip0pt plus
.13em
}
2660 \def\urefpoststretch{\urefpostbreak \hskip0pt plus
.1em
}
2662 \def\urefcodeamp{\urefprestretch \&
\urefpoststretch}
2663 \def\urefcodedot{\urefprestretch .
\urefpoststretch}
2664 \def\urefcodehash{\urefprestretch \#
\urefpoststretch}
2665 \def\urefcodequest{\urefprestretch ?
\urefpoststretch}
2666 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2669 \global\def\urefcodeslashfinish{%
2670 \urefprestretch \slashChar
2671 % Allow line break only after the final / in a sequence of
2672 % slashes, to avoid line break between the slashes in http://.
2673 \ifx\next/
\else \urefpoststretch \fi
2677 % One more complication: by default we'll break after the special
2678 % characters, but some people like to break before the special chars, so
2679 % allow that. Also allow no breaking at all, for manual control.
2681 \parseargdef\urefbreakstyle{%
2683 \ifx\txiarg\wordnone
2684 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2685 \else\ifx\txiarg\wordbefore
2686 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2687 \else\ifx\txiarg\wordafter
2688 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2690 \errhelp =
\EMsimple
2691 \errmessage{Unknown @urefbreakstyle setting `
\txiarg'
}%
2694 \def\wordafter{after
}
2695 \def\wordbefore{before
}
2698 \urefbreakstyle after
2700 % @url synonym for @uref, since that's how everyone uses it.
2704 % rms does not like angle brackets --karl, 17may97.
2705 % So now @email is just like @uref, unless we are pdf.
2707 %\def\email#1{\angleleft{\tt #1}\angleright}
2709 \def\email#1{\doemail#1,,
\finish}
2710 \def\doemail#1,
#2,
#3\finish{\begingroup
2713 \setbox0 =
\hbox{\ignorespaces #2}%
2714 \ifdim\wd0>
0pt
\unhbox0\else\code{#1}\fi
2721 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2722 % `example' (@kbd uses ttsl only inside of @example and friends),
2723 % or `code' (@kbd uses normal tty font always).
2724 \parseargdef\kbdinputstyle{%
2726 \ifx\txiarg\worddistinct
2727 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2728 \else\ifx\txiarg\wordexample
2729 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2730 \else\ifx\txiarg\wordcode
2731 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2733 \errhelp =
\EMsimple
2734 \errmessage{Unknown @kbdinputstyle setting `
\txiarg'
}%
2737 \def\worddistinct{distinct
}
2738 \def\wordexample{example
}
2741 % Default is `distinct'.
2742 \kbdinputstyle distinct
2744 % @kbd is like @code, except that if the argument is just one @key command,
2745 % then @kbd has no effect.
2746 \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??
\par}}
2749 \def\kbdsub#1#2#3\par{%
2750 \def\one{#1}\def\three{#3}\def\threex{??
}%
2751 \ifx\one\xkey\ifx\threex\three \key{#2}%
2752 \else{\tclose{\kbdfont\setupmarkupstyle{kbd
}\look}}\fi
2753 \else{\tclose{\kbdfont\setupmarkupstyle{kbd
}\look}}\fi
2756 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2757 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2759 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2760 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2761 % \vbox{\hrule\kern-0.4pt
2762 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2763 % \kern-0.4pt\hrule}%
2764 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2766 % definition of @key with no lozenge. If the current font is already
2767 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2768 % if it isn't monospace, then use \tt.
2770 \def\key#1{{\setupmarkupstyle{key
}%
2772 \ifmonospace\else\tt\fi
2775 % @clicksequence{File @click{} Open ...}
2776 \def\clicksequence#1{\begingroup #1\endgroup}
2778 % @clickstyle @arrow (by default)
2779 \parseargdef\clickstyle{\def\click{#1}}
2782 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2783 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2785 \def\dmn#1{\thinspace #1}
2787 % @l was never documented to mean ``switch to the Lisp font'',
2788 % and it is not used as such in any manual I can find. We need it for
2789 % Polish suppressed-l. --karl, 22sep96.
2790 %\def\l#1{{\li #1}\null}
2792 % @acronym for "FBI", "NATO", and the like.
2793 % We print this one point size smaller, since it's intended for
2796 \def\acronym#1{\doacronym #1,,
\finish}
2797 \def\doacronym#1,
#2,
#3\finish{%
2798 {\selectfonts\lsize #1}%
2800 \ifx\temp\empty \else
2801 \space (
{\unsepspaces \ignorespaces \temp \unskip})
%
2803 \null % reset \spacefactor=1000
2806 % @abbr for "Comput. J." and the like.
2807 % No font change, but don't do end-of-sentence spacing.
2809 \def\abbr#1{\doabbr #1,,
\finish}
2810 \def\doabbr#1,
#2,
#3\finish{%
2811 {\plainfrenchspacing #1}%
2813 \ifx\temp\empty \else
2814 \space (
{\unsepspaces \ignorespaces \temp \unskip})
%
2816 \null % reset \spacefactor=1000
2819 % @asis just yields its argument. Used with @table, for example.
2823 % @math outputs its argument in math mode.
2825 % One complication: _ usually means subscripts, but it could also mean
2826 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2827 % _ active, and distinguish by seeing if the current family is \slfam,
2828 % which is what @var uses.
2830 \catcode`
\_ =
\active
2831 \gdef\mathunderscore{%
2833 \def_{\ifnum\fam=
\slfam \_\else\sb\fi}%
2836 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2837 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2838 % particular reason), but this is not advertised and we don't care.
2840 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2841 \def\mathbackslash{\ifnum\fam=
\ttfam \mathchar"
075C
\else\backslash \fi}
2846 \let\\ =
\mathbackslash
2848 % make the texinfo accent commands work in math mode
2860 \def\finishmath#1{#1$
\endgroup} % Close the group opened by \tex.
2862 % Some active characters (such as <) are spaced differently in math.
2863 % We have to reset their definitions in case the @math was an argument
2864 % to a command which sets the catcodes (such as @item or @section).
2867 \catcode`^ =
\active
2868 \catcode`< =
\active
2869 \catcode`> =
\active
2870 \catcode`+ =
\active
2871 \catcode`' =
\active
2877 \let' =
\ptexquoteright
2881 % ctrl is no longer a Texinfo command, but leave this definition for fun.
2882 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2884 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
2885 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
2886 % except specified as a normal braced arg, so no newlines to worry about.
2888 \def\outfmtnametex{tex
}
2890 \long\def\inlinefmt#1{\doinlinefmt #1,
\finish}
2891 \long\def\doinlinefmt#1,
#2,
\finish{%
2892 \def\inlinefmtname{#1}%
2893 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
2896 % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
2897 % FMTNAME is tex, else ELSE-TEXT.
2898 \long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,
\finish}
2899 \long\def\doinlinefmtifelse#1,
#2,
#3,
#4,
\finish{%
2900 \def\inlinefmtname{#1}%
2901 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
2904 % For raw, must switch into @tex before parsing the argument, to avoid
2905 % setting catcodes prematurely. Doing it this way means that, for
2906 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
2907 % ignored. But this isn't important because if people want a literal
2908 % *right* brace they would have to use a command anyway, so they may as
2909 % well use a command to get a left brace too. We could re-use the
2910 % delimiter character idea from \verb, but it seems like overkill.
2912 \long\def\inlineraw{\tex \doinlineraw}
2913 \long\def\doinlineraw#1{\doinlinerawtwo #1,
\finish}
2914 \def\doinlinerawtwo#1,
#2,
\finish{%
2915 \def\inlinerawname{#1}%
2916 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
2917 \endgroup % close group opened by \tex.
2920 % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
2922 \long\def\inlineifset#1{\doinlineifset #1,
\finish}
2923 \long\def\doinlineifset#1,
#2,
\finish{%
2924 \def\inlinevarname{#1}%
2925 \expandafter\ifx\csname SET
\inlinevarname\endcsname\relax
2926 \else\ignorespaces#2\fi
2929 % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
2931 \long\def\inlineifclear#1{\doinlineifclear #1,
\finish}
2932 \long\def\doinlineifclear#1,
#2,
\finish{%
2933 \def\inlinevarname{#1}%
2934 \expandafter\ifx\csname SET
\inlinevarname\endcsname\relax \ignorespaces#2\fi
2941 % @@ prints an @, as does @atchar{}.
2945 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
2946 % Unless we're in typewriter, use \ecfont because the CM text fonts do
2947 % not have braces, and we don't want to switch into math.
2948 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2949 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2950 \let\
{=
\mylbrace \let\lbracechar=\
{
2951 \let\
}=
\myrbrace \let\rbracechar=\
}
2953 % Definitions to produce \{ and \} commands for indices,
2954 % and @{ and @} for the aux/toc files.
2955 \catcode`\
{ =
\other \catcode`\
} =
\other
2956 \catcode`\
[ =
1 \catcode`\
] =
2
2957 \catcode`\! =
0 \catcode`\\ =
\other
2958 !gdef!lbracecmd
[\
{]%
2959 !gdef!rbracecmd
[\
}]%
2960 !gdef!lbraceatcmd
[@
{]%
2961 !gdef!rbraceatcmd
[@
}]%
2964 % @comma{} to avoid , parsing problems.
2967 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2968 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2970 \let\dotaccent =
\ptexdot
2971 \def\ringaccent#1{{\accent23 #1}}
2972 \let\tieaccent =
\ptext
2973 \let\ubaraccent =
\ptexb
2974 \let\udotaccent =
\d
2976 % Other special characters: @questiondown @exclamdown @ordf @ordm
2977 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2978 \def\questiondown{?`
}
2980 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a
}}}
2981 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o
}}}
2983 % Dotless i and dotless j, used for accents.
2988 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2989 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2990 \else \errmessage{@dotless can be used only with i or j
}%
2994 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2995 % period following counts as ending a sentence. (Idea found in latex.)
2997 \edef\TeX{\TeX \spacefactor=
1000 }
2999 % @LaTeX{} logo. Not quite the same results as the definition in
3000 % latex.ltx, since we use a different font for the raised A; it's most
3001 % convenient for us to use an explicitly smaller font, rather than using
3002 % the \scriptstyle font (since we don't reset \scriptstyle and
3003 % \scriptscriptstyle).
3008 \vbox to
\ht0{\hbox{%
3009 \ifx\textnominalsize\xwordpt
3010 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
3011 % Revert to plain's \scriptsize, which is 7pt.
3012 \count255=
\the\fam $
\fam\count255 \scriptstyle A$
%
3014 % For 11pt, we can use our lllsize.
3015 \selectfonts\lllsize A
%
3024 % Some math mode symbols.
3025 \def\bullet{$
\ptexbullet$
}
3026 \def\geq{\ifmmode \ge\else $
\ge$
\fi}
3027 \def\leq{\ifmmode \le\else $
\le$
\fi}
3028 \def\minus{\ifmmode -
\else $-$
\fi}
3030 % @dots{} outputs an ellipsis using the current font.
3031 % We do .5em per period so that it has the same spacing in the cm
3032 % typewriter fonts as three actual period characters; on the other hand,
3033 % in other typewriter fonts three periods are wider than 1.5em. So do
3034 % whichever is larger.
3038 \setbox0=
\hbox{...
}% get width of three periods
3045 \hskip 0pt plus
.25fil
3046 .
\hskip 0pt plus1fil
3047 .
\hskip 0pt plus1fil
3048 .
\hskip 0pt plus
.5fil
3052 % @enddots{} is an end-of-sentence ellipsis.
3056 \spacefactor=
\endofsentencespacefactor
3059 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3061 % Since these characters are used in examples, they should be an even number of
3062 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3065 \def\arrow{\leavevmode\raise.05ex
\hbox to
1em
{\hfil$
\rightarrow$
\hfil}}
3066 \def\result{\leavevmode\raise.05ex
\hbox to
1em
{\hfil$
\Rightarrow$
\hfil}}
3067 \def\expansion{\leavevmode\hbox to
1em
{\hfil$
\mapsto$
\hfil}}
3068 \def\print{\leavevmode\lower.1ex
\hbox to
1em
{\hfil$
\dashv$
\hfil}}
3069 \def\equiv{\leavevmode\hbox to
1em
{\hfil$
\ptexequiv$
\hfil}}
3071 % The @error{} command.
3072 % Adapted from the TeXbook's \boxit.
3076 {\tentt \global\dimen0 =
3em
}% Width of the box.
3077 \dimen2 =
.55pt
% Thickness of rules
3078 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3079 \setbox0 =
\hbox{\kern-
.75pt
\reducedsf \putworderror\kern-
1.5pt
}
3081 \setbox\errorbox=
\hbox to
\dimen0{\hfil
3082 \hsize =
\dimen0 \advance\hsize by -
5.8pt
% Space to left+right.
3083 \advance\hsize by -
2\dimen2 % Rules.
3085 \hrule height
\dimen2
3086 \hbox{\vrule width
\dimen2 \kern3pt % Space to left of text.
3087 \vtop{\kern2.4pt
\box0 \kern2.4pt
}% Space above/below.
3088 \kern3pt\vrule width
\dimen2}% Space to right.
3089 \hrule height
\dimen2}
3092 \def\error{\leavevmode\lower.7ex
\copy\errorbox}
3094 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3096 \def\pounds{{\it\$
}}
3098 % @euro{} comes from a separate font, depending on the current style.
3099 % We use the free feym* fonts from the eurosym package by Henrik
3100 % Theiling, which support regular, slanted, bold and bold slanted (and
3101 % "outlined" (blackboard board, sort of) versions, which we don't need).
3102 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3104 % Although only regular is the truly official Euro symbol, we ignore
3105 % that. The Euro is designed to be slightly taller than the regular
3111 % feybo - bold slanted
3113 % There is no good (free) typewriter version, to my knowledge.
3114 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3117 % Also doesn't work in math. Do we need to do math with euro symbols?
3121 \def\euro{{\eurofont e
}}
3123 % We set the font at each command, rather than predefining it in
3124 % \textfonts and the other font-switching commands, so that
3125 % installations which never need the symbol don't have to have the
3128 % There is only one designed size (nominal 10pt), so we always scale
3129 % that to the current nominal size.
3131 % By the way, simply using "at 1em" works for cmr10 and the like, but
3132 % does not work for cmbx10 and other extended/shrunken fonts.
3134 \def\eurosize{\csname\curfontsize nominalsize
\endcsname}%
3136 \ifx\curfontstyle\bfstylename
3138 \font\thiseurofont =
\ifusingit{feybo10
}{feybr10
} at
\eurosize
3141 \font\thiseurofont =
\ifusingit{feymo10
}{feymr10
} at
\eurosize
3146 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3147 % sometimes we redefine the original macro, and the alias should reflect
3150 % Use LaTeX names for the Icelandic letters.
3151 \def\DH{{\ecfont \char"D0
}} % Eth
3152 \def\dh{{\ecfont \char"F0
}} % eth
3153 \def\TH{{\ecfont \char"DE
}} % Thorn
3154 \def\th{{\ecfont \char"FE
}} % thorn
3156 \def\guillemetleft{{\ecfont \char"
13}}
3157 \def\guillemotleft{\guillemetleft}
3158 \def\guillemetright{{\ecfont \char"
14}}
3159 \def\guillemotright{\guillemetright}
3160 \def\guilsinglleft{{\ecfont \char"
0E
}}
3161 \def\guilsinglright{{\ecfont \char"
0F
}}
3162 \def\quotedblbase{{\ecfont \char"
12}}
3163 \def\quotesinglbase{{\ecfont \char"
0D
}}
3165 % This positioning is not perfect (see the ogonek LaTeX package), but
3166 % we have the precomposed glyphs for the most common cases. We put the
3167 % tests to use those glyphs in the single \ogonek macro so we have fewer
3168 % dummy definitions to worry about for index entries, etc.
3170 % ogonek is also used with other letters in Lithuanian (IOU), but using
3171 % the precomposed glyphs for those is not so easy since they aren't in
3175 \ifx\temp\macrocharA\Aogonek
3176 \else\ifx\temp\macrochara\aogonek
3177 \else\ifx\temp\macrocharE\Eogonek
3178 \else\ifx\temp\macrochare\eogonek
3180 \ecfont \setbox0=
\hbox{#1}%
3181 \ifdim\ht0=
1ex
\accent"
0C
#1%
3182 \else\ooalign{\unhbox0\crcr\hidewidth\char"
0C
\hidewidth}%
3187 \def\Aogonek{{\ecfont \char"
81}}\def\macrocharA{A
}
3188 \def\aogonek{{\ecfont \char"A1
}}\def\macrochara{a
}
3189 \def\Eogonek{{\ecfont \char"
86}}\def\macrocharE{E
}
3190 \def\eogonek{{\ecfont \char"A6
}}\def\macrochare{e
}
3192 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
3194 % We can't distinguish serif/sans and italic/slanted, but this
3195 % is used for crude hacks anyway (like adding French and German
3196 % quotes to documents typeset with CM, where we lose kerning), so
3197 % hopefully nobody will notice/care.
3198 \edef\ecsize{\csname\curfontsize ecsize
\endcsname}%
3199 \edef\nominalsize{\csname\curfontsize nominalsize
\endcsname}%
3202 \font\thisecfont = ectt
\ecsize \space at
\nominalsize
3204 \ifx\curfontstyle\bfstylename
3206 \font\thisecfont = ecb
\ifusingit{i
}{x
}\ecsize \space at
\nominalsize
3209 \font\thisecfont = ec
\ifusingit{ti
}{rm
}\ecsize \space at
\nominalsize
3215 % @registeredsymbol - R in a circle. The font for the R should really
3216 % be smaller yet, but lllsize is the best we can do for now.
3217 % Adapted from the plain.tex definition of \copyright.
3219 \def\registeredsymbol{%
3220 $^
{{\ooalign{\hfil\raise.07ex
\hbox{\selectfonts\lllsize R
}%
3225 % @textdegree - the normal degrees sign.
3227 \def\textdegree{$^
\circ$
}
3229 % Laurent Siebenmann reports \Orb undefined with:
3230 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3231 % so we'll define it if necessary.
3233 \ifx\Orb\thisisundefined
3234 \def\Orb{\mathhexbox20D}
3238 \chardef\quotedblleft="
5C
3239 \chardef\quotedblright=`\"
3240 \chardef\quoteleft=`\`
3241 \chardef\quoteright=`\'
3244 \message{page headings,
}
3246 \newskip\titlepagetopglue \titlepagetopglue =
1.5in
3247 \newskip\titlepagebottomglue \titlepagebottomglue =
2pc
3249 % First the title page. Must do @settitle before @titlepage.
3251 \newif\iffinishedtitlepage
3253 % Do an implicit @contents or @shortcontents after @end titlepage if the
3254 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3256 \newif\ifsetcontentsaftertitlepage
3257 \let\setcontentsaftertitlepage =
\setcontentsaftertitlepagetrue
3258 \newif\ifsetshortcontentsaftertitlepage
3259 \let\setshortcontentsaftertitlepage =
\setshortcontentsaftertitlepagetrue
3261 \parseargdef\shorttitlepage{%
3262 \begingroup \hbox{}\vskip 1.5in
\chaprm \centerline{#1}%
3263 \endgroup\page\hbox{}\page}
3266 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3268 \parindent=
0pt
\textfonts
3269 % Leave some space at the very top of the page.
3270 \vglue\titlepagetopglue
3271 % No rule at page bottom unless we print one at the top with @title.
3272 \finishedtitlepagetrue
3274 % Most title ``pages'' are actually two pages long, with space
3275 % at the top of the second. We don't want the ragged left on the second.
3276 \let\oldpage =
\page
3278 \iffinishedtitlepage\else
3281 \let\page =
\oldpage
3288 \iffinishedtitlepage\else
3291 % It is important to do the page break before ending the group,
3292 % because the headline and footline are only empty inside the group.
3293 % If we use the new definition of \page, we always get a blank page
3294 % after the title page, which we certainly don't want.
3298 % Need this before the \...aftertitlepage checks so that if they are
3299 % in effect the toc pages will come out with page numbers.
3302 % If they want short, they certainly want long too.
3303 \ifsetshortcontentsaftertitlepage
3306 \global\let\shortcontents =
\relax
3307 \global\let\contents =
\relax
3310 \ifsetcontentsaftertitlepage
3312 \global\let\contents =
\relax
3313 \global\let\shortcontents =
\relax
3317 \def\finishtitlepage{%
3318 \vskip4pt \hrule height
2pt width
\hsize
3319 \vskip\titlepagebottomglue
3320 \finishedtitlepagetrue
3323 % Settings used for typesetting titles: no hyphenation, no indentation,
3324 % don't worry much about spacing, ragged right. This should be used
3325 % inside a \vbox, and fonts need to be set appropriately first. Because
3326 % it is always used for titles, nothing else, we call \rmisbold. \par
3327 % should be specified before the end of the \vbox, since a vbox is a group.
3329 \def\raggedtitlesettings{%
3331 \hyphenpenalty=
10000
3337 % Macros to be used within @titlepage:
3339 \let\subtitlerm=
\tenrm
3340 \def\subtitlefont{\subtitlerm \normalbaselineskip =
13pt
\normalbaselines}
3342 \parseargdef\title{%
3344 \vbox{\titlefonts \raggedtitlesettings #1\par}%
3345 % print a rule at the page bottom also.
3346 \finishedtitlepagefalse
3347 \vskip4pt \hrule height
4pt width
\hsize \vskip4pt
3350 \parseargdef\subtitle{%
3352 {\subtitlefont \rightline{#1}}%
3355 % @author should come last, but may come many times.
3356 % It can also be used inside @quotation.
3358 \parseargdef\author{%
3359 \def\temp{\quotation}%
3361 \def\quotationauthor{#1}% printed in \Equotation.
3364 \ifseenauthor\else \vskip 0pt plus
1filll
\seenauthortrue \fi
3365 {\secfonts\rmisbold \leftline{#1}}%
3370 % Set up page headings and footings.
3372 \let\thispage=
\folio
3374 \newtoks\evenheadline % headline on even pages
3375 \newtoks\oddheadline % headline on odd pages
3376 \newtoks\evenfootline % footline on even pages
3377 \newtoks\oddfootline % footline on odd pages
3379 % Now make TeX use those variables
3380 \headline=
{{\textfonts\rm \ifodd\pageno \the\oddheadline
3381 \else \the\evenheadline \fi}}
3382 \footline=
{{\textfonts\rm \ifodd\pageno \the\oddfootline
3383 \else \the\evenfootline \fi}\HEADINGShook}
3384 \let\HEADINGShook=
\relax
3386 % Commands to set those variables.
3387 % For example, this is what @headings on does
3388 % @evenheading @thistitle|@thispage|@thischapter
3389 % @oddheading @thischapter|@thispage|@thistitle
3390 % @evenfooting @thisfile||
3391 % @oddfooting ||@thisfile
3394 \def\evenheading{\parsearg\evenheadingxxx}
3395 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|
\finish}
3396 \def\evenheadingyyy #1\|
#2\|
#3\|
#4\finish{%
3397 \global\evenheadline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3399 \def\oddheading{\parsearg\oddheadingxxx}
3400 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|
\finish}
3401 \def\oddheadingyyy #1\|
#2\|
#3\|
#4\finish{%
3402 \global\oddheadline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3404 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3406 \def\evenfooting{\parsearg\evenfootingxxx}
3407 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|
\finish}
3408 \def\evenfootingyyy #1\|
#2\|
#3\|
#4\finish{%
3409 \global\evenfootline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3411 \def\oddfooting{\parsearg\oddfootingxxx}
3412 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|
\finish}
3413 \def\oddfootingyyy #1\|
#2\|
#3\|
#4\finish{%
3414 \global\oddfootline =
{\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3416 % Leave some space for the footline. Hopefully ok to assume
3417 % @evenfooting will not be used by itself.
3418 \global\advance\pageheight by -
12pt
3419 \global\advance\vsize by -
12pt
3422 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3424 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3425 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3427 % The same set of arguments for:
3432 % @everyheadingmarks
3433 % @everyfootingmarks
3435 \def\evenheadingmarks{\headingmarks{even
}{heading
}}
3436 \def\oddheadingmarks{\headingmarks{odd
}{heading
}}
3437 \def\evenfootingmarks{\headingmarks{even
}{footing
}}
3438 \def\oddfootingmarks{\headingmarks{odd
}{footing
}}
3439 \def\everyheadingmarks#1 {\headingmarks{even
}{heading
}{#1}
3440 \headingmarks{odd
}{heading
}{#1} }
3441 \def\everyfootingmarks#1 {\headingmarks{even
}{footing
}{#1}
3442 \headingmarks{odd
}{footing
}{#1} }
3443 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3444 \def\headingmarks#1#2#3 {%
3445 \expandafter\let\expandafter\temp \csname get
#3headingmarks
\endcsname
3446 \global\expandafter\let\csname get
#1#2marks
\endcsname \temp
3449 \everyheadingmarks bottom
3450 \everyfootingmarks bottom
3452 % @headings double turns headings on for double-sided printing.
3453 % @headings single turns headings on for single-sided printing.
3454 % @headings off turns them off.
3455 % @headings on same as @headings double, retained for compatibility.
3456 % @headings after turns on double-sided headings after this page.
3457 % @headings doubleafter turns on double-sided headings after this page.
3458 % @headings singleafter turns on single-sided headings after this page.
3459 % By default, they are off at the start of a document,
3460 % and turned `on' after @end titlepage.
3462 \def\headings #1 {\csname HEADINGS
#1\endcsname}
3464 \def\headingsoff{% non-global headings elimination
3465 \evenheadline=
{\hfil}\evenfootline=
{\hfil}%
3466 \oddheadline=
{\hfil}\oddfootline=
{\hfil}%
3469 \def\HEADINGSoff{{\globaldefs=
1 \headingsoff}} % global setting
3470 \HEADINGSoff % it's the default
3472 % When we turn headings on, set the page number to 1.
3473 % For double-sided printing, put current file name in lower left corner,
3474 % chapter name on inside top of right hand pages, document
3475 % title on inside top of left hand pages, and page numbers on outside top
3476 % edge of all pages.
3477 \def\HEADINGSdouble{%
3479 \global\evenfootline=
{\hfil}
3480 \global\oddfootline=
{\hfil}
3481 \global\evenheadline=
{\line{\folio\hfil\thistitle}}
3482 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
3483 \global\let\contentsalignmacro =
\chapoddpage
3485 \let\contentsalignmacro =
\chappager
3487 % For single-sided printing, chapter title goes across top left of page,
3488 % page number on top right.
3489 \def\HEADINGSsingle{%
3491 \global\evenfootline=
{\hfil}
3492 \global\oddfootline=
{\hfil}
3493 \global\evenheadline=
{\line{\thischapter\hfil\folio}}
3494 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
3495 \global\let\contentsalignmacro =
\chappager
3497 \def\HEADINGSon{\HEADINGSdouble}
3499 \def\HEADINGSafter{\let\HEADINGShook=
\HEADINGSdoublex}
3500 \let\HEADINGSdoubleafter=
\HEADINGSafter
3501 \def\HEADINGSdoublex{%
3502 \global\evenfootline=
{\hfil}
3503 \global\oddfootline=
{\hfil}
3504 \global\evenheadline=
{\line{\folio\hfil\thistitle}}
3505 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
3506 \global\let\contentsalignmacro =
\chapoddpage
3509 \def\HEADINGSsingleafter{\let\HEADINGShook=
\HEADINGSsinglex}
3510 \def\HEADINGSsinglex{%
3511 \global\evenfootline=
{\hfil}
3512 \global\oddfootline=
{\hfil}
3513 \global\evenheadline=
{\line{\thischapter\hfil\folio}}
3514 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
3515 \global\let\contentsalignmacro =
\chappager
3518 % Subroutines used in generating headings
3519 % This produces Day Month Year style of output.
3520 % Only define if not already defined, in case a txi-??.tex file has set
3521 % up a different format (e.g., txi-cs.tex does this).
3522 \ifx\today\thisisundefined
3526 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3527 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3528 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3533 % @settitle line... specifies the title of the document, for headings.
3534 % It generates no output of its own.
3535 \def\thistitle{\putwordNoTitle}
3536 \def\settitle{\parsearg{\gdef\thistitle}}
3540 % Tables -- @table, @ftable, @vtable, @item(x).
3542 % default indentation of table text
3543 \newdimen\tableindent \tableindent=
.8in
3544 % default indentation of @itemize and @enumerate text
3545 \newdimen\itemindent \itemindent=
.3in
3546 % margin between end of table item and start of table text.
3547 \newdimen\itemmargin \itemmargin=
.1in
3549 % used internally for \itemindent minus \itemmargin
3552 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3554 % They also define \itemindex
3555 % to index the item name in whatever manner is desired (perhaps none).
3557 \newif\ifitemxneedsnegativevskip
3559 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-
\parskip\nobreak\fi}
3561 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3562 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3564 \def\itemzzz #1{\begingroup %
3565 \advance\hsize by -
\rightskip
3566 \advance\hsize by -
\tableindent
3567 \setbox0=
\hbox{\itemindicate{#1}}%
3569 \nobreak % This prevents a break before @itemx.
3571 % If the item text does not fit in the space we have, put it on a line
3572 % by itself, and do not allow a page break either before or after that
3573 % line. We do not start a paragraph here because then if the next
3574 % command is, e.g., @kindex, the whatsit would get put into the
3575 % horizontal list on a line by itself, resulting in extra blank space.
3576 \ifdim \wd0>
\itemmax
3578 % Make this a paragraph so we get the \parskip glue and wrapping,
3579 % but leave it ragged-right.
3581 \advance\leftskip by-
\tableindent
3582 \advance\hsize by
\tableindent
3583 \advance\rightskip by0pt plus1fil
\relax
3584 \leavevmode\unhbox0\par
3587 % We're going to be starting a paragraph, but we don't want the
3588 % \parskip glue -- logically it's part of the @item we just started.
3589 \nobreak \vskip-
\parskip
3591 % Stop a page break at the \parskip glue coming up. However, if
3592 % what follows is an environment such as @example, there will be no
3593 % \parskip glue; then the negative vskip we just inserted would
3594 % cause the example and the item to crash together. So we use this
3595 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3596 % \parskip glue after all. Section titles are handled this way also.
3600 \itemxneedsnegativevskipfalse
3602 % The item text fits into the space. Start a paragraph, so that the
3603 % following text (if any) will end up on the same line.
3605 % Do this with kerns and \unhbox so that if there is a footnote in
3606 % the item text, it can migrate to the main vertical list and
3607 % eventually be printed.
3608 \nobreak\kern-
\tableindent
3609 \dimen0 =
\itemmax \advance\dimen0 by
\itemmargin \advance\dimen0 by -
\wd0
3611 \nobreak\kern\dimen0
3613 \itemxneedsnegativevskiptrue
3617 \def\item{\errmessage{@item while not in a list environment
}}
3618 \def\itemx{\errmessage{@itemx while not in a list environment
}}
3620 % @table, @ftable, @vtable.
3622 \let\itemindex\gobble
3626 \def\itemindex #
#1{\doind {fn
}{\code{#
#1}}}%
3627 \tablecheck{ftable
}%
3630 \def\itemindex #
#1{\doind {vr
}{\code{#
#1}}}%
3631 \tablecheck{vtable
}%
3634 \ifnum \the\catcode`\^^M=
\active
3636 \errmessage{This command won't work in this context; perhaps the problem is
3637 that we are
\inenvironment\thisenv}%
3638 \def\next{\doignore{#1}}%
3645 \def\itemindicate{#1}%
3650 \makevalueexpandable
3651 \edef\temp{\noexpand\tablez #1\space\space\space}%
3655 \def\tablez #1 #2 #3 #4\endtablez{%
3657 \ifnum 0#1>
0 \advance \leftskip by
#1\mil \fi
3658 \ifnum 0#2>
0 \tableindent=
#2\mil \fi
3659 \ifnum 0#3>
0 \advance \rightskip by
#3\mil \fi
3660 \itemmax=
\tableindent
3661 \advance \itemmax by -
\itemmargin
3662 \advance \leftskip by
\tableindent
3663 \exdentamount=
\tableindent
3665 \parskip =
\smallskipamount
3666 \ifdim \parskip=
0pt
\parskip=
2pt
\fi
3667 \let\item =
\internalBitem
3668 \let\itemx =
\internalBitemx
3670 \def\Etable{\endgraf\afterenvbreak}
3673 \let\Eitemize\Etable
3674 \let\Eenumerate\Etable
3676 % This is the counter used by @enumerate, which is really @itemize
3680 \envdef\itemize{\parsearg\doitemize}
3684 \itemmax=
\itemindent
3685 \advance\itemmax by -
\itemmargin
3686 \advance\leftskip by
\itemindent
3687 \exdentamount=
\itemindent
3689 \parskip=
\smallskipamount
3690 \ifdim\parskip=
0pt
\parskip=
2pt
\fi
3692 % Try typesetting the item mark that if the document erroneously says
3693 % something like @itemize @samp (intending @table), there's an error
3694 % right away at the @itemize. It's not the best error message in the
3695 % world, but it's better than leaving it to the @item. This means if
3696 % the user wants an empty mark, they have to say @w{} not just @w.
3697 \def\itemcontents{#1}%
3698 \setbox0 =
\hbox{\itemcontents}%
3700 % @itemize with no arg is equivalent to @itemize @bullet.
3701 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3703 \let\item=
\itemizeitem
3706 % Definition of @item while inside @itemize and @enumerate.
3709 \advance\itemno by
1 % for enumerations
3710 {\let\par=
\endgraf \smallbreak}% reasonable place to break
3712 % If the document has an @itemize directly after a section title, a
3713 % \nobreak will be last on the list, and \sectionheading will have
3714 % done a \vskip-\parskip. In that case, we don't want to zero
3715 % parskip, or the item text will crash with the heading. On the
3716 % other hand, when there is normal text preceding the item (as there
3717 % usually is), we do want to zero parskip, or there would be too much
3718 % space. In that case, we won't have a \nobreak before. At least
3719 % that's the theory.
3720 \ifnum\lastpenalty<
10000 \parskip=
0in
\fi
3722 \hbox to
0pt
{\hss \itemcontents \kern\itemmargin}%
3724 \vadjust{\penalty 1200}}% not good to break after first line of item.
3728 % \splitoff TOKENS\endmark defines \first to be the first token in
3729 % TOKENS, and \rest to be the remainder.
3731 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3733 % Allow an optional argument of an uppercase letter, lowercase letter,
3734 % or number, to specify the first label in the enumerated list. No
3735 % argument is the same as `1'.
3737 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3738 \def\enumeratey #1 #2\endenumeratey{%
3739 % If we were given no argument, pretend we were given `1'.
3741 \ifx\thearg\empty \def\thearg{1}\fi
3743 % Detect if the argument is a single token. If so, it might be a
3744 % letter. Otherwise, the only valid thing it can be is a number.
3745 % (We will always have one token, because of the test we just made.
3746 % This is a good thing, since \splitoff doesn't work given nothing at
3747 % all -- the first parameter is undelimited.)
3748 \expandafter\splitoff\thearg\endmark
3750 % Only one token in the argument. It could still be anything.
3751 % A ``lowercase letter'' is one whose \lccode is nonzero.
3752 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3753 % not equal to itself.
3754 % Otherwise, we assume it's a number.
3756 % We need the \relax at the end of the \ifnum lines to stop TeX from
3757 % continuing to look for a <number>.
3759 \ifnum\lccode\expandafter`
\thearg=
0\relax
3760 \numericenumerate % a number (we hope)
3763 \ifnum\lccode\expandafter`
\thearg=
\expandafter`
\thearg\relax
3764 \lowercaseenumerate % lowercase letter
3766 \uppercaseenumerate % uppercase letter
3770 % Multiple tokens in the argument. We hope it's a number.
3775 % An @enumerate whose labels are integers. The starting integer is
3778 \def\numericenumerate{%
3780 \startenumeration{\the\itemno}%
3783 % The starting (lowercase) letter is in \thearg.
3784 \def\lowercaseenumerate{%
3785 \itemno =
\expandafter`
\thearg
3787 % Be sure we're not beyond the end of the alphabet.
3789 \errmessage{No more lowercase letters in @enumerate; get a bigger
3796 % The starting (uppercase) letter is in \thearg.
3797 \def\uppercaseenumerate{%
3798 \itemno =
\expandafter`
\thearg
3800 % Be sure we're not beyond the end of the alphabet.
3802 \errmessage{No more uppercase letters in @enumerate; get a bigger
3809 % Call \doitemize, adding a period to the first argument and supplying the
3810 % common last two arguments. Also subtract one from the initial value in
3811 % \itemno, since @item increments \itemno.
3813 \def\startenumeration#1{%
3814 \advance\itemno by -
1
3815 \doitemize{#1.
}\flushcr
3818 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3821 \def\alphaenumerate{\enumerate{a
}}
3822 \def\capsenumerate{\enumerate{A
}}
3823 \def\Ealphaenumerate{\Eenumerate}
3824 \def\Ecapsenumerate{\Eenumerate}
3827 % @multitable macros
3828 % Amy Hendrickson, 8/18/94, 3/6/96
3830 % @multitable ... @end multitable will make as many columns as desired.
3831 % Contents of each column will wrap at width given in preamble. Width
3832 % can be specified either with sample text given in a template line,
3833 % or in percent of \hsize, the current width of text on page.
3835 % Table can continue over pages but will only break between lines.
3839 % Either define widths of columns in terms of percent of \hsize:
3840 % @multitable @columnfractions .25 .3 .45
3843 % Numbers following @columnfractions are the percent of the total
3844 % current hsize to be used for each column. You may use as many
3845 % columns as desired.
3848 % Or use a template:
3849 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3851 % using the widest term desired in each column.
3853 % Each new table line starts with @item, each subsequent new column
3854 % starts with @tab. Empty columns may be produced by supplying @tab's
3855 % with nothing between them for as many times as empty columns are needed,
3856 % ie, @tab@tab@tab will produce two empty columns.
3858 % @item, @tab do not need to be on their own lines, but it will not hurt
3861 % Sample multitable:
3863 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3864 % @item first col stuff @tab second col stuff @tab third col
3871 % @item first col stuff @tab second col stuff
3872 % @tab Many paragraphs of text may be used in any column.
3874 % They will wrap at the width determined by the template.
3875 % @item@tab@tab This will be in third column.
3878 % Default dimensions may be reset by user.
3879 % @multitableparskip is vertical space between paragraphs in table.
3880 % @multitableparindent is paragraph indent in table.
3881 % @multitablecolmargin is horizontal space to be left between columns.
3882 % @multitablelinespace is space to leave between table items, baseline
3884 % 0pt means it depends on current normal line spacing.
3886 \newskip\multitableparskip
3887 \newskip\multitableparindent
3888 \newdimen\multitablecolspace
3889 \newskip\multitablelinespace
3890 \multitableparskip=
0pt
3891 \multitableparindent=
6pt
3892 \multitablecolspace=
12pt
3893 \multitablelinespace=
0pt
3895 % Macros used to set up halign preamble:
3897 \let\endsetuptable\relax
3898 \def\xendsetuptable{\endsetuptable}
3899 \let\columnfractions\relax
3900 \def\xcolumnfractions{\columnfractions}
3903 % #1 is the @columnfraction, usually a decimal number like .5, but might
3904 % be just 1. We just use it, whatever it is.
3906 \def\pickupwholefraction#1 {%
3907 \global\advance\colcount by
1
3908 \expandafter\xdef\csname col
\the\colcount\endcsname{#1\hsize}%
3915 \ifx\firstarg\xendsetuptable
3918 \ifx\firstarg\xcolumnfractions
3919 \global\setpercenttrue
3922 \let\go\pickupwholefraction
3924 \global\advance\colcount by
1
3925 \setbox0=
\hbox{#1\unskip\space}% Add a normal word space as a
3926 % separator; typically that is always in the input, anyway.
3927 \expandafter\xdef\csname col
\the\colcount\endcsname{\the\wd0}%
3930 \ifx\go\pickupwholefraction
3931 % Put the argument back for the \pickupwholefraction call, so
3932 % we'll always have a period there to be parsed.
3933 \def\go{\pickupwholefraction#1}%
3935 \let\go =
\setuptable
3941 % multitable-only commands.
3943 % @headitem starts a heading row, which we typeset in bold.
3944 % Assignments have to be global since we are inside the implicit group
3945 % of an alignment entry. \everycr resets \everytab so we don't have to
3946 % undo it ourselves.
3947 \def\headitemfont{\b}% for people to use in the template row; not changeable
3949 \checkenv\multitable
3951 \global\everytab=
{\bf}% can't use \headitemfont since the parsing differs
3952 \the\everytab % for the first item
3955 % A \tab used to include \hskip1sp. But then the space in a template
3956 % line is not enough. That is bad. So let's go back to just `&' until
3957 % we again encounter the problem the 1sp was intended to solve.
3958 % --karl, nathan@acm.org, 20apr99.
3959 \def\tab{\checkenv\multitable &
\the\everytab}%
3961 % @multitable ... @end multitable definitions:
3963 \newtoks\everytab % insert after every tab.
3965 \envdef\multitable{%
3969 % @item within a multitable starts a normal row.
3970 % We use \def instead of \let so that if one of the multitable entries
3971 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3972 % \endtemplate) expanding \doitemize.
3977 \setmultitablespacing
3978 \parskip=
\multitableparskip
3979 \parindent=
\multitableparindent
3985 \global\everytab=
{}%
3986 \global\colcount=
0 % Reset the column counter.
3987 % Check for saved footnotes, etc.
3989 % Keeps underfull box messages off when table breaks over pages.
3991 % Maybe so, but it also creates really weird page breaks when the
3992 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3993 % problem manifests itself, so it can be fixed for real --karl.
3997 \parsearg\domultitable
3999 \def\domultitable#1{%
4000 % To parse everything between @multitable and @item:
4001 \setuptable#1 \endsetuptable
4003 % This preamble sets up a generic column definition, which will
4004 % be used as many times as user calls for columns.
4005 % \vtop will set a single line and will also let text wrap and
4006 % continue for many paragraphs if desired.
4008 \global\advance\colcount by
1
4011 % Use the current \colcount to find the correct column width:
4012 \hsize=
\expandafter\csname col
\the\colcount\endcsname
4014 % In order to keep entries from bumping into each other
4015 % we will add a \leftskip of \multitablecolspace to all columns after
4018 % If a template has been used, we will add \multitablecolspace
4019 % to the width of each template entry.
4021 % If the user has set preamble in terms of percent of \hsize we will
4022 % use that dimension as the width of the column, and the \leftskip
4023 % will keep entries from bumping into each other. Table will start at
4024 % left margin and final column will justify at right margin.
4026 % Make sure we don't inherit \rightskip from the outer environment.
4029 % The first column will be indented with the surrounding text.
4030 \advance\hsize by
\leftskip
4033 % If user has not set preamble in terms of percent of \hsize
4034 % we will advance \hsize by \multitablecolspace.
4035 \advance\hsize by
\multitablecolspace
4037 % In either case we will make \leftskip=\multitablecolspace:
4038 \leftskip=
\multitablecolspace
4040 % Ignoring space at the beginning and end avoids an occasional spurious
4041 % blank line, when TeX decides to break the line at the space before the
4042 % box from the multistrut, so the strut ends up on a line by itself.
4044 % @multitable @columnfractions .11 .89
4046 % @tab Legal holiday which is valid in major parts of the whole country.
4047 % Is automatically provided with highlighting sequences respectively
4048 % marking characters.
4049 \noindent\ignorespaces##
\unskip\multistrut
4054 \egroup % end the \halign
4055 \global\setpercentfalse
4058 \def\setmultitablespacing{%
4059 \def\multistrut{\strut}% just use the standard line spacing
4061 % Compute \multitablelinespace (if not defined by user) for use in
4062 % \multitableparskip calculation. We used define \multistrut based on
4063 % this, but (ironically) that caused the spacing to be off.
4064 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
4065 \ifdim\multitablelinespace=
0pt
4066 \setbox0=
\vbox{X
}\global\multitablelinespace=
\the\baselineskip
4067 \global\advance\multitablelinespace by-
\ht0
4069 % Test to see if parskip is larger than space between lines of
4070 % table. If not, do nothing.
4071 % If so, set to same dimension as multitablelinespace.
4072 \ifdim\multitableparskip>
\multitablelinespace
4073 \global\multitableparskip=
\multitablelinespace
4074 \global\advance\multitableparskip-
7pt
% to keep parskip somewhat smaller
4075 % than skip between lines in the table.
4077 \ifdim\multitableparskip=
0pt
4078 \global\multitableparskip=
\multitablelinespace
4079 \global\advance\multitableparskip-
7pt
% to keep parskip somewhat smaller
4080 % than skip between lines in the table.
4084 \message{conditionals,
}
4086 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4087 % @ifnotxml always succeed. They currently do nothing; we don't
4088 % attempt to check whether the conditionals are properly nested. But we
4089 % have to remember that they are conditionals, so that @end doesn't
4090 % attempt to close an environment group.
4093 \expandafter\let\csname #1\endcsname =
\relax
4094 \expandafter\let\csname iscond.
#1\endcsname =
1
4097 \makecond{ifnotdocbook
}
4098 \makecond{ifnothtml
}
4099 \makecond{ifnotinfo
}
4100 \makecond{ifnotplaintext
}
4103 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4105 \def\direntry{\doignore{direntry
}}
4106 \def\documentdescription{\doignore{documentdescription
}}
4107 \def\docbook{\doignore{docbook
}}
4108 \def\html{\doignore{html
}}
4109 \def\ifdocbook{\doignore{ifdocbook
}}
4110 \def\ifhtml{\doignore{ifhtml
}}
4111 \def\ifinfo{\doignore{ifinfo
}}
4112 \def\ifnottex{\doignore{ifnottex
}}
4113 \def\ifplaintext{\doignore{ifplaintext
}}
4114 \def\ifxml{\doignore{ifxml
}}
4115 \def\ignore{\doignore{ignore
}}
4116 \def\menu{\doignore{menu
}}
4117 \def\xml{\doignore{xml
}}
4119 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4121 % A count to remember the depth of nesting.
4122 \newcount\doignorecount
4124 \def\doignore#1{\begingroup
4125 % Scan in ``verbatim'' mode:
4127 \catcode`\@ =
\other
4128 \catcode`\
{ =
\other
4129 \catcode`\
} =
\other
4131 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4134 % Count number of #1's that we've seen.
4137 % Swallow text until we reach the matching `@end #1'.
4141 { \catcode`_=
11 % We want to use \_STOP_ which cannot appear in texinfo source.
4144 \gdef\dodoignore#1{%
4145 % #1 contains the command name as a string, e.g., `ifinfo'.
4147 % Define a command to find the next `@end #1'.
4148 \long\def\doignoretext#
#1^^M@end
#1{%
4149 \doignoretextyyy#
#1^^M@
#1\_STOP_}%
4151 % And this command to find another #1 command, at the beginning of a
4152 % line. (Otherwise, we would consider a line `@c @ifset', for
4153 % example, to count as an @ifset for nesting.)
4154 \long\def\doignoretextyyy#
#1^^M@
#1#
#2\_STOP_{\doignoreyyy{#
#2}\_STOP_}%
4156 % And now expand that command.
4161 \def\doignoreyyy#1{%
4163 \ifx\temp\empty % Nothing found.
4164 \let\next\doignoretextzzz
4165 \else % Found a nested condition, ...
4166 \advance\doignorecount by
1
4167 \let\next\doignoretextyyy % ..., look for another.
4168 % If we're here, #1 ends with ^^M\ifinfo (for example).
4170 \next #1% the token \_STOP_ is present just after this macro.
4173 % We have to swallow the remaining "\_STOP_".
4175 \def\doignoretextzzz#1{%
4176 \ifnum\doignorecount =
0 % We have just found the outermost @end.
4177 \let\next\enddoignore
4178 \else % Still inside a nested condition.
4179 \advance\doignorecount by -
1
4180 \let\next\doignoretext % Look for the next @end.
4185 % Finish off ignored text.
4187 % Ignore anything after the last `@end #1'; this matters in verbatim
4188 % environments, where otherwise the newline after an ignored conditional
4189 % would result in a blank line in the output.
4190 \gdef\enddoignore#1^^M
{\endgroup\ignorespaces}%
4194 % @set VAR sets the variable VAR to an empty value.
4195 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4197 % Since we want to separate VAR from REST-OF-LINE (which might be
4198 % empty), we can't just use \parsearg; we have to insert a space of our
4199 % own to delimit the rest of the line, and then take it out again if we
4201 % We rely on the fact that \parsearg sets \catcode`\ =10.
4203 \parseargdef\set{\setyyy#1 \endsetyyy}
4204 \def\setyyy#1 #2\endsetyyy{%
4206 \makevalueexpandable
4208 \edef\next{\gdef\makecsname{SET
#1}}%
4216 % Remove the trailing space \setxxx inserted.
4217 \def\setzzz#1 \endsetzzz{\next{#1}}
4219 % @clear VAR clears (i.e., unsets) the variable VAR.
4221 \parseargdef\clear{%
4223 \makevalueexpandable
4224 \global\expandafter\let\csname SET
#1\endcsname=
\relax
4228 % @value{foo} gets the text saved in variable foo.
4229 \def\value{\begingroup\makevalueexpandable\valuexxx}
4230 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4232 \catcode`\-=
\active \catcode`
\_=
\active
4234 \gdef\makevalueexpandable{%
4235 \let\value =
\expandablevalue
4236 % We don't want these characters active, ...
4237 \catcode`\-=
\other \catcode`
\_=
\other
4238 % ..., but we might end up with active ones in the argument if
4239 % we're called from @code, as @code{@value{foo-bar_}}, though.
4240 % So \let them to their normal equivalents.
4241 \let-
\normaldash \let_\normalunderscore
4245 % We have this subroutine so that we can handle at least some @value's
4246 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4247 % The command has to be fully expandable (if the variable is set), since
4248 % the result winds up in the index file. This means that if the
4249 % variable's value contains other Texinfo commands, it's almost certain
4250 % it will fail (although perhaps we could fix that with sufficient work
4251 % to do a one-level expansion on the result, instead of complete).
4253 % Unfortunately, this has the consequence that when _ is in the *value*
4254 % of an @set, it does not print properly in the roman fonts (get the cmr
4255 % dot accent at position 126 instead). No fix comes to mind, and it's
4256 % been this way since 2003 or earlier, so just ignore it.
4258 \def\expandablevalue#1{%
4259 \expandafter\ifx\csname SET
#1\endcsname\relax
4260 {[No value for ``
#1''
]}%
4261 \message{Variable `
#1', used in @value, is not set.
}%
4263 \csname SET
#1\endcsname
4267 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4270 % To get the special treatment we need for `@end ifset,' we call
4271 % \makecond and then redefine.
4274 \def\ifset{\parsearg{\doifset{\let\next=
\ifsetfail}}}
4277 \makevalueexpandable
4279 \expandafter\ifx\csname SET
#2\endcsname\relax
4280 #1% If not set, redefine \next.
4285 \def\ifsetfail{\doignore{ifset
}}
4287 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4288 % defined with @set, or has been undefined with @clear.
4290 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4291 % above code: if the variable is not set, do nothing, if it is set,
4292 % then redefine \next to \ifclearfail.
4295 \def\ifclear{\parsearg{\doifset{\else \let\next=
\ifclearfail}}}
4296 \def\ifclearfail{\doignore{ifclear
}}
4298 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4299 % without the @) is in fact defined. We can only feasibly check at the
4300 % TeX level, so something like `mathcode' is going to considered
4301 % defined even though it is not a Texinfo command.
4303 \makecond{ifcommanddefined
}
4304 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=
\ifcmddefinedfail}}}
4306 \def\doifcmddefined#1#2{{%
4307 \makevalueexpandable
4309 \expandafter\ifx\csname #2\endcsname\relax
4310 #1% If not defined, \let\next as above.
4315 \def\ifcmddefinedfail{\doignore{ifcommanddefined
}}
4317 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4318 \makecond{ifcommandnotdefined
}
4319 \def\ifcommandnotdefined{%
4320 \parsearg{\doifcmddefined{\else \let\next=
\ifcmdnotdefinedfail}}}
4321 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined
}}
4323 % Set the `txicommandconditionals' variable, so documents have a way to
4324 % test if the @ifcommand...defined conditionals are available.
4325 \set txicommandconditionals
4327 % @dircategory CATEGORY -- specify a category of the dir file
4328 % which this file should belong to. Ignore this in TeX.
4329 \let\dircategory=
\comment
4331 % @defininfoenclose.
4332 \let\definfoenclose=
\comment
4336 % Index generation facilities
4338 % Define \newwrite to be identical to plain tex's \newwrite
4339 % except not \outer, so it can be used within macros and \if's.
4340 \edef\newwrite{\makecsname{ptexnewwrite
}}
4342 % \newindex {foo} defines an index named foo.
4343 % It automatically defines \fooindex such that
4344 % \fooindex ...rest of line... puts an entry in the index foo.
4345 % It also defines \fooindfile to be the number of the output channel for
4346 % the file that accumulates this index. The file's extension is foo.
4347 % The name of an index should be no more than 2 characters long
4348 % for the sake of vms.
4352 \expandafter\newwrite \csname#1indfile
\endcsname
4353 \openout \csname#1indfile
\endcsname \jobname.
#1 % Open the file
4355 \expandafter\xdef\csname#1index
\endcsname{% % Define @#1index
4356 \noexpand\doindex{#1}}
4359 % @defindex foo == \newindex{foo}
4361 \def\defindex{\parsearg\newindex}
4363 % Define @defcodeindex, like @defindex except put all entries in @code.
4365 \def\defcodeindex{\parsearg\newcodeindex}
4367 \def\newcodeindex#1{%
4369 \expandafter\newwrite \csname#1indfile
\endcsname
4370 \openout \csname#1indfile
\endcsname \jobname.
#1
4372 \expandafter\xdef\csname#1index
\endcsname{%
4373 \noexpand\docodeindex{#1}}%
4377 % @synindex foo bar makes index foo feed into index bar.
4378 % Do this instead of @defindex foo if you don't want it as a separate index.
4380 % @syncodeindex foo bar similar, but put all entries made for index foo
4383 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4384 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4386 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4387 % #3 the target index (bar).
4388 \def\dosynindex#1#2#3{%
4389 % Only do \closeout if we haven't already done it, else we'll end up
4390 % closing the target index.
4391 \expandafter \ifx\csname donesynindex
#2\endcsname \relax
4392 % The \closeout helps reduce unnecessary open files; the limit on the
4393 % Acorn RISC OS is a mere 16 files.
4394 \expandafter\closeout\csname#2indfile
\endcsname
4395 \expandafter\let\csname donesynindex
#2\endcsname =
1
4397 % redefine \fooindfile:
4398 \expandafter\let\expandafter\temp\expandafter=
\csname#3indfile
\endcsname
4399 \expandafter\let\csname#2indfile
\endcsname=
\temp
4400 % redefine \fooindex:
4401 \expandafter\xdef\csname#2index
\endcsname{\noexpand#1{#3}}%
4404 % Define \doindex, the driver for all \fooindex macros.
4405 % Argument #1 is generated by the calling \fooindex macro,
4406 % and it is "foo", the name of the index.
4408 % \doindex just uses \parsearg; it calls \doind for the actual work.
4409 % This is because \doind is more useful to call from other macros.
4411 % There is also \dosubind {index}{topic}{subtopic}
4412 % which makes an entry in a two-level index such as the operation index.
4414 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4415 \def\singleindexer #1{\doind{\indexname}{#1}}
4417 % like the previous two, but they put @code around the argument.
4418 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4419 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4421 % Take care of Texinfo commands that can appear in an index entry.
4422 % Since there are some commands we want to expand, and others we don't,
4423 % we have to laboriously prevent expansion for those that we don't.
4426 \escapechar = `\\
% use backslash in output files.
4427 \def\@
{@
}% change to @@ when we switch to @ as escape char in index files.
4428 \def\
{\realbackslash\space }%
4430 % Need these unexpandable (because we define \tt as a dummy)
4431 % definitions when @{ or @} appear in index entry text. Also, more
4432 % complicated, when \tex is in effect and \{ is a \delimiter again.
4433 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4434 % braces and backslashes are used only as delimiters. Perhaps we
4435 % should define @lbrace and @rbrace commands a la @comma.
4436 \def\
{{{\tt\char123}}%
4437 \def\
}{{\tt\char125}}%
4439 % I don't entirely understand this, but when an index entry is
4440 % generated from a macro call, the \endinput which \scanmacro inserts
4441 % causes processing to be prematurely terminated. This is,
4442 % apparently, because \indexsorttmp is fully expanded, and \endinput
4443 % is an expandable command. The redefinition below makes \endinput
4444 % disappear altogether for that purpose -- although logging shows that
4445 % processing continues to some further point. On the other hand, it
4446 % seems \endinput does not hurt in the printed index arg, since that
4447 % is still getting written without apparent harm.
4449 % Sample source (mac-idx3.tex, reported by Graham Percival to
4450 % help-texinfo, 22may06):
4451 % @macro funindex {WORD}
4455 % @funindex commtest
4457 % The above is not enough to reproduce the bug, but it gives the flavor.
4459 % Sample whatsit resulting:
4460 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4463 \let\endinput =
\empty
4465 % Do the redefinitions.
4469 % For the aux and toc files, @ is the escape character. So we want to
4470 % redefine everything using @ as the escape character (instead of
4471 % \realbackslash, still used for index files). When everything uses @,
4472 % this will be simpler.
4477 \let\
{ =
\lbraceatcmd
4478 \let\
} =
\rbraceatcmd
4480 % Do the redefinitions.
4485 % Called from \indexdummies and \atdummies.
4487 \def\commondummies{%
4489 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4490 % preventing its expansion. This is used only for control words,
4491 % not control letters, because the \space would be incorrect for
4492 % control characters, but is needed to separate the control word
4493 % from whatever follows.
4495 % For control letters, we have \definedummyletter, which omits the
4498 % These can be used both for control words that take an argument and
4499 % those that do not. If it is followed by {arg} in the input, then
4500 % that will dutifully get written to the index (or wherever).
4502 \def\definedummyword #
#1{\def#
#1{\string#
#1\space}}%
4503 \def\definedummyletter#
#1{\def#
#1{\string#
#1}}%
4504 \let\definedummyaccent\definedummyletter
4506 \commondummiesnofonts
4508 \definedummyletter\_%
4509 \definedummyletter\-
%
4511 % Non-English letters.
4522 \definedummyword\exclamdown
4526 \definedummyword\ordf
4527 \definedummyword\ordm
4528 \definedummyword\questiondown
4532 % Although these internal commands shouldn't show up, sometimes they do.
4534 \definedummyword\gtr
4535 \definedummyword\hat
4536 \definedummyword\less
4539 \definedummyword\tclose
4542 \definedummyword\LaTeX
4543 \definedummyword\TeX
4545 % Assorted special characters.
4546 \definedummyword\arrow
4547 \definedummyword\bullet
4548 \definedummyword\comma
4549 \definedummyword\copyright
4550 \definedummyword\registeredsymbol
4551 \definedummyword\dots
4552 \definedummyword\enddots
4553 \definedummyword\entrybreak
4554 \definedummyword\equiv
4555 \definedummyword\error
4556 \definedummyword\euro
4557 \definedummyword\expansion
4558 \definedummyword\geq
4559 \definedummyword\guillemetleft
4560 \definedummyword\guillemetright
4561 \definedummyword\guilsinglleft
4562 \definedummyword\guilsinglright
4563 \definedummyword\lbracechar
4564 \definedummyword\leq
4565 \definedummyword\minus
4566 \definedummyword\ogonek
4567 \definedummyword\pounds
4568 \definedummyword\point
4569 \definedummyword\print
4570 \definedummyword\quotedblbase
4571 \definedummyword\quotedblleft
4572 \definedummyword\quotedblright
4573 \definedummyword\quoteleft
4574 \definedummyword\quoteright
4575 \definedummyword\quotesinglbase
4576 \definedummyword\rbracechar
4577 \definedummyword\result
4578 \definedummyword\textdegree
4580 % We want to disable all macros so that they are not expanded by \write.
4583 \normalturnoffactive
4585 % Handle some cases of @value -- where it does not contain any
4586 % (non-fully-expandable) commands.
4587 \makevalueexpandable
4590 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4592 \def\commondummiesnofonts{%
4593 % Control letters and accents.
4594 \definedummyletter\!
%
4595 \definedummyaccent\"
%
4596 \definedummyaccent\'
%
4597 \definedummyletter\*
%
4598 \definedummyaccent\,
%
4599 \definedummyletter\.
%
4600 \definedummyletter\/
%
4601 \definedummyletter\:
%
4602 \definedummyaccent\=
%
4603 \definedummyletter\?
%
4604 \definedummyaccent\^
%
4605 \definedummyaccent\`
%
4606 \definedummyaccent\~
%
4610 \definedummyword\dotaccent
4611 \definedummyword\ogonek
4612 \definedummyword\ringaccent
4613 \definedummyword\tieaccent
4614 \definedummyword\ubaraccent
4615 \definedummyword\udotaccent
4616 \definedummyword\dotless
4618 % Texinfo font commands.
4622 \definedummyword\sansserif
4624 \definedummyword\slanted
4627 % Commands that take arguments.
4628 \definedummyword\abbr
4629 \definedummyword\acronym
4630 \definedummyword\anchor
4631 \definedummyword\cite
4632 \definedummyword\code
4633 \definedummyword\command
4634 \definedummyword\dfn
4635 \definedummyword\dmn
4636 \definedummyword\email
4637 \definedummyword\emph
4638 \definedummyword\env
4639 \definedummyword\file
4640 \definedummyword\image
4641 \definedummyword\indicateurl
4642 \definedummyword\inforef
4643 \definedummyword\kbd
4644 \definedummyword\key
4645 \definedummyword\math
4646 \definedummyword\option
4647 \definedummyword\pxref
4648 \definedummyword\ref
4649 \definedummyword\samp
4650 \definedummyword\strong
4651 \definedummyword\tie
4652 \definedummyword\uref
4653 \definedummyword\url
4654 \definedummyword\var
4655 \definedummyword\verb
4657 \definedummyword\xref
4660 % \indexnofonts is used when outputting the strings to sort the index
4661 % by, and when constructing control sequence names. It eliminates all
4662 % control sequences and just writes whatever the best ASCII sort string
4663 % would be for a given command (usually its argument).
4666 % Accent commands should become @asis.
4667 \def\definedummyaccent#
#1{\let#
#1\asis}%
4668 % We can just ignore other control letters.
4669 \def\definedummyletter#
#1{\let#
#1\empty}%
4670 % All control words become @asis by default; overrides below.
4671 \let\definedummyword\definedummyaccent
4673 \commondummiesnofonts
4675 % Don't no-op \tt, since it isn't a user-level command
4676 % and is used in the definitions of the active chars like <, >, |, etc.
4677 % Likewise with the other plain tex font commands.
4682 \def\_{\normalunderscore}%
4683 \def\-
{}% @- shouldn't affect sorting
4685 % Unfortunately, texindex is not prepared to handle braces in the
4686 % content at all. So for index sorting, we map @{ and @} to strings
4687 % starting with |, since that ASCII character is between ASCII { and }.
4689 \def\lbracechar{|a
}%
4692 \def\rbracechar{|b
}%
4694 % Non-English letters.
4711 \def\questiondown{?
}%
4718 % Assorted special characters.
4719 % (The following {} will end up in the sort string, but that's ok.)
4721 \def\bullet{bullet
}%
4723 \def\copyright{copyright
}%
4729 \def\expansion{==>
}%
4731 \def\guillemetleft{<<
}%
4732 \def\guillemetright{>>
}%
4733 \def\guilsinglleft{<
}%
4734 \def\guilsinglright{>
}%
4738 \def\pounds{pounds
}%
4740 \def\quotedblbase{"
}%
4741 \def\quotedblleft{"
}%
4742 \def\quotedblright{"
}%
4745 \def\quotesinglbase{,
}%
4746 \def\registeredsymbol{R
}%
4750 \expandafter\ifx\csname SETtxiindexlquoteignore
\endcsname\relax
4751 \else \indexlquoteignore \fi
4753 % We need to get rid of all macros, leaving only the arguments (if present).
4754 % Of course this is not nearly correct, but it is the best we can do for now.
4755 % makeinfo does not expand macros in the argument to @deffn, which ends up
4756 % writing an index entry, and texindex isn't prepared for an index sort entry
4757 % that starts with \.
4759 % Since macro invocations are followed by braces, we can just redefine them
4760 % to take a single TeX argument. The case of a macro invocation that
4761 % goes to end-of-line is not handled.
4766 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4767 % ignore left quotes in the sort term.
4768 {\catcode`\`=
\active
4769 \gdef\indexlquoteignore{\let`=
\empty}}
4771 \let\indexbackslash=
0 %overridden during \printindex.
4772 \let\SETmarginindex=
\relax % put index entries in margin (undocumented)?
4774 % Most index entries go through here, but \dosubind is the general case.
4775 % #1 is the index name, #2 is the entry text.
4776 \def\doind#1#2{\dosubind{#1}{#2}{}}
4778 % Workhorse for all \fooindexes.
4779 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4780 % empty if called from \doind, as we usually are (the main exception
4781 % is with most defuns, which call us directly).
4783 \def\dosubind#1#2#3{%
4786 % Store the main index entry text (including the third arg).
4788 % If third arg is present, precede it with a space.
4790 \ifx\thirdarg\empty \else
4791 \toks0 =
\expandafter{\the\toks0 \space #3}%
4794 \edef\writeto{\csname#1indfile
\endcsname}%
4796 \safewhatsit\dosubindwrite
4801 % Write the entry in \toks0 to the index file:
4803 \def\dosubindwrite{%
4804 % Put the index entry in the margin if desired.
4805 \ifx\SETmarginindex\relax\else
4806 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt
\the\toks0}}%
4809 % Remember, we are within a group.
4810 \indexdummies % Must do this here, since \bf, etc expand at this stage
4811 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4812 % so it will be output as is; and it will print as backslash.
4814 % Process the index entry with all font commands turned off, to
4815 % get the string to sort by.
4817 \edef\temp{\the\toks0}% need full expansion
4818 \xdef\indexsorttmp{\temp}%
4821 % Set up the complete index entry, with both the sort key and
4822 % the original text, including any font commands. We write
4823 % three arguments to \entry to the .?? file (four in the
4824 % subentry case), texindex reduces to two when writing the .??s
4828 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4833 % Take care of unwanted page breaks/skips around a whatsit:
4835 % If a skip is the last thing on the list now, preserve it
4836 % by backing up by \lastskip, doing the \write, then inserting
4837 % the skip again. Otherwise, the whatsit generated by the
4838 % \write or \pdfdest will make \lastskip zero. The result is that
4839 % sequences like this:
4843 % will have extra space inserted, because the \medbreak in the
4844 % start of the @defun won't see the skip inserted by the @end of
4845 % the previous defun.
4847 % But don't do any of this if we're not in vertical mode. We
4848 % don't want to do a \vskip and prematurely end a paragraph.
4850 % Avoid page breaks due to these extra skips, too.
4852 % But wait, there is a catch there:
4853 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4854 % sufficient for this purpose, as it ignores stretch and shrink parts
4855 % of the skip. The only way seems to be to check the textual
4856 % representation of the skip.
4858 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4859 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4861 \edef\zeroskipmacro{\expandafter\the\csname z@skip
\endcsname}
4863 \newskip\whatsitskip
4864 \newcount\whatsitpenalty
4868 \def\safewhatsit#1{\ifhmode
4871 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4872 \whatsitskip =
\lastskip
4873 \edef\lastskipmacro{\the\lastskip}%
4874 \whatsitpenalty =
\lastpenalty
4876 % If \lastskip is nonzero, that means the last item was a
4877 % skip. And since a skip is discardable, that means this
4878 % -\whatsitskip glue we're inserting is preceded by a
4879 % non-discardable item, therefore it is not a potential
4880 % breakpoint, therefore no \nobreak needed.
4881 \ifx\lastskipmacro\zeroskipmacro
4888 \ifx\lastskipmacro\zeroskipmacro
4889 % If \lastskip was zero, perhaps the last item was a penalty, and
4890 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4891 % to re-insert the same penalty (values >10000 are used for various
4892 % signals); since we just inserted a non-discardable item, any
4893 % following glue (such as a \parskip) would be a breakpoint. For example:
4894 % @deffn deffn-whatever
4895 % @vindex index-whatever
4897 % would allow a break between the index-whatever whatsit
4898 % and the "Description." paragraph.
4899 \ifnum\whatsitpenalty>
9999 \penalty\whatsitpenalty \fi
4901 % On the other hand, if we had a nonzero \lastskip,
4902 % this make-up glue would be preceded by a non-discardable item
4903 % (the whatsit from the \write), so we must insert a \nobreak.
4904 \nobreak\vskip\whatsitskip
4908 % The index entry written in the file actually looks like
4909 % \entry {sortstring}{page}{topic}
4911 % \entry {sortstring}{page}{topic}{subtopic}
4912 % The texindex program reads in these files and writes files
4913 % containing these kinds of lines:
4915 % before the first topic whose initial is c
4916 % \entry {topic}{pagelist}
4917 % for a topic that is used without subtopics
4919 % for the beginning of a topic that is used with subtopics
4920 % \secondary {subtopic}{pagelist}
4921 % for each subtopic.
4923 % Define the user-accessible indexing commands
4924 % @findex, @vindex, @kindex, @cindex.
4926 \def\findex {\fnindex}
4927 \def\kindex {\kyindex}
4928 \def\cindex {\cpindex}
4929 \def\vindex {\vrindex}
4930 \def\tindex {\tpindex}
4931 \def\pindex {\pgindex}
4933 \def\cindexsub {\begingroup\obeylines\cindexsub}
4935 \gdef\cindexsub "
#1"
#2^^M
{\endgroup %
4936 \dosubind{cp
}{#2}{#1}}}
4938 % Define the macros used in formatting output of the sorted index material.
4940 % @printindex causes a particular index (the ??s file) to get printed.
4941 % It does not print any chapter heading (usually an @unnumbered).
4943 \parseargdef\printindex{\begingroup
4944 \dobreak \chapheadingskip{10000}%
4949 \everypar =
{}% don't want the \kern\-parindent from indentation suppression.
4951 % See if the index file exists and is nonempty.
4952 % Change catcode of @ here so that if the index file contains
4954 % as its first line, TeX doesn't complain about mismatched braces
4955 % (because it thinks @} is a control sequence).
4957 \openin 1 \jobname.
#1s
4959 % \enddoublecolumns gets confused if there is no text in the index,
4960 % and it loses the chapter title and the aux file entries for the
4961 % index. The easiest way to prevent this problem is to make sure
4962 % there is some text.
4963 \putwordIndexNonexistent
4966 % If the index file exists but is empty, then \openin leaves \ifeof
4967 % false. We have to make TeX try to read something from the file, so
4968 % it can discover if there is anything in it.
4971 \putwordIndexIsEmpty
4973 % Index files are almost Texinfo source, but we use \ as the escape
4974 % character. It would be better to use @, but that's too big a change
4975 % to make right now.
4976 \def\indexbackslash{\backslashcurfont}%
4987 % These macros are used by the sorted index file itself.
4988 % Change them to control the appearance of the index.
4991 % Some minor font changes for the special characters.
4992 \let\tentt=
\sectt \let\tt=
\sectt \let\sf=
\sectt
4994 % Remove any glue we may have, we'll be inserting our own.
4997 % We like breaks before the index initials, so insert a bonus.
4999 \vskip 0pt plus
3\baselineskip
5001 \vskip 0pt plus -
3\baselineskip
5003 % Typeset the initial. Making this add up to a whole number of
5004 % baselineskips increases the chance of the dots lining up from column
5005 % to column. It still won't often be perfect, because of the stretch
5006 % we need before each entry, but it's better.
5008 % No shrink because it confuses \balancecolumns.
5009 \vskip 1.67\baselineskip plus
.5\baselineskip
5010 \leftline{\secbf #1}%
5011 % Do our best not to break after the initial.
5013 \vskip .33\baselineskip plus
.1\baselineskip
5016 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
5017 % then page number (#2) flushed to the right margin. It is used for index
5018 % and table of contents entries. The paragraph is indented by \leftskip.
5020 % A straightforward implementation would start like this:
5021 % \def\entry#1#2{...
5022 % But this freezes the catcodes in the argument, and can cause problems to
5023 % @code, which sets - active. This problem was fixed by a kludge---
5024 % ``-'' was active throughout whole index, but this isn't really right.
5025 % The right solution is to prevent \entry from swallowing the whole text.
5030 % Start a new paragraph if necessary, so our assignments below can't
5031 % affect previous text.
5034 % Do not fill out the last line with white space.
5037 % No extra space above this paragraph.
5040 % Do not prefer a separate line ending with a hyphen to fewer lines.
5041 \finalhyphendemerits =
0
5043 % \hangindent is only relevant when the entry text and page number
5044 % don't both fit on one line. In that case, bob suggests starting the
5045 % dots pretty far over on the line. Unfortunately, a large
5046 % indentation looks wrong when the entry text itself is broken across
5047 % lines. So we use a small indentation and put up with long leaders.
5049 % \hangafter is reset to 1 (which is the value we want) at the start
5050 % of each paragraph, so we need not do anything with that.
5053 % When the entry text needs to be broken, just fill out the first line
5055 \rightskip =
0pt plus1fil
5057 % A bit of stretch before each entry for the benefit of balancing
5061 % When reading the text of entry, convert explicit line breaks
5062 % from @* into spaces. The user might give these in long section
5063 % titles, for instance.
5064 \def\*
{\unskip\space\ignorespaces}%
5065 \def\entrybreak{\hfil\break}%
5067 % Swallow the left brace of the text (first parameter):
5068 \afterassignment\doentry
5071 \def\entrybreak{\unskip\space\ignorespaces}%
5073 \bgroup % Instead of the swallowed brace.
5075 \aftergroup\finishentry
5076 % And now comes the text of the entry.
5078 \def\finishentry#1{%
5079 % #1 is the page number.
5081 % The following is kludged to not output a line of dots in the index if
5082 % there are no page numbers. The next person who breaks this will be
5083 % cursed by a Unix daemon.
5084 \setbox\boxA =
\hbox{#1}%
5085 \ifdim\wd\boxA =
0pt
5089 % If we must, put the page number on a line of its own, and fill out
5090 % this line with blank space. (The \hfil is overwhelmed with the
5091 % fill leaders glue in \indexdotfill if the page number does fit.)
5093 \null\nobreak\indexdotfill % Have leaders before the page number.
5095 % The `\ ' here is removed by the implicit \unskip that TeX does as
5096 % part of (the primitive) \par. Without it, a spurious underfull
5109 % Like plain.tex's \dotfill, except uses up at least 1 em.
5110 \def\indexdotfill{\cleaders
5111 \hbox{$
\mathsurround=
0pt
\mkern1.5mu.
\mkern1.5mu$
}\hskip 1em plus
1fill
}
5113 \def\primary #1{\line{#1\hfil}}
5115 \newskip\secondaryindent \secondaryindent=
0.5cm
5116 \def\secondary#1#2{{%
5121 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5123 \pdfgettoks#2.\
\the\toksA % The page number ends the paragraph.
5130 % Define two-column mode, which we use to typeset indexes.
5131 % Adapted from the TeXbook, page 416, which is to say,
5132 % the manmac.tex format used to print the TeXbook itself.
5136 \newdimen\doublecolumnhsize
5138 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5139 % Grab any single-column material above us.
5142 % Here is a possibility not foreseen in manmac: if we accumulate a
5143 % whole lot of material, we might end up calling this \output
5144 % routine twice in a row (see the doublecol-lose test, which is
5145 % essentially a couple of indexes with @setchapternewpage off). In
5146 % that case we just ship out what is in \partialpage with the normal
5147 % output routine. Generally, \partialpage will be empty when this
5148 % runs and this will be a no-op. See the indexspread.tex test case.
5149 \ifvoid\partialpage \else
5150 \onepageout{\pagecontents\partialpage}%
5153 \global\setbox\partialpage =
\vbox{%
5154 % Unvbox the main output page.
5156 \kern-
\topskip \kern\baselineskip
5159 \eject % run that output routine to set \partialpage
5161 % Use the double-column output routine for subsequent pages.
5162 \output =
{\doublecolumnout}%
5164 % Change the page size parameters. We could do this once outside this
5165 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5166 % format, but then we repeat the same computation. Repeating a couple
5167 % of assignments once per index is clearly meaningless for the
5168 % execution time, so we may as well do it in one place.
5170 % First we halve the line length, less a little for the gutter between
5171 % the columns. We compute the gutter based on the line length, so it
5172 % changes automatically with the paper format. The magic constant
5173 % below is chosen so that the gutter has the same value (well, +-<1pt)
5174 % as it did when we hard-coded it.
5176 % We put the result in a separate register, \doublecolumhsize, so we
5177 % can restore it in \pagesofar, after \hsize itself has (potentially)
5180 \doublecolumnhsize =
\hsize
5181 \advance\doublecolumnhsize by -
.04154\hsize
5182 \divide\doublecolumnhsize by
2
5183 \hsize =
\doublecolumnhsize
5185 % Double the \vsize as well. (We don't need a separate register here,
5186 % since nobody clobbers \vsize.)
5190 % The double-column output routine for all double-column pages except
5193 \def\doublecolumnout{%
5194 \splittopskip=
\topskip \splitmaxdepth=
\maxdepth
5195 % Get the available space for the double columns -- the normal
5196 % (undoubled) page height minus any material left over from the
5200 \advance\dimen@ by -
\ht\partialpage
5202 % box0 will be the left-hand column, box2 the right.
5203 \setbox0=
\vsplit255 to
\dimen@
\setbox2=
\vsplit255 to
\dimen@
5204 \onepageout\pagesofar
5206 \penalty\outputpenalty
5209 % Re-output the contents of the output page -- any previous material,
5210 % followed by the two boxes we just split, in box0 and box2.
5214 \hsize =
\doublecolumnhsize
5215 \wd0=
\hsize \wd2=
\hsize
5216 \hbox to
\pagewidth{\box0\hfil\box2}%
5219 % All done with double columns.
5220 \def\enddoublecolumns{%
5221 % The following penalty ensures that the page builder is exercised
5222 % _before_ we change the output routine. This is necessary in the
5223 % following situation:
5225 % The last section of the index consists only of a single entry.
5226 % Before this section, \pagetotal is less than \pagegoal, so no
5227 % break occurs before the last section starts. However, the last
5228 % section, consisting of \initial and the single \entry, does not
5229 % fit on the page and has to be broken off. Without the following
5230 % penalty the page builder will not be exercised until \eject
5231 % below, and by that time we'll already have changed the output
5232 % routine to the \balancecolumns version, so the next-to-last
5233 % double-column page will be processed with \balancecolumns, which
5234 % is wrong: The two columns will go to the main vertical list, with
5235 % the broken-off section in the recent contributions. As soon as
5236 % the output routine finishes, TeX starts reconsidering the page
5237 % break. The two columns and the broken-off section both fit on the
5238 % page, because the two columns now take up only half of the page
5239 % goal. When TeX sees \eject from below which follows the final
5240 % section, it invokes the new output routine that we've set after
5241 % \balancecolumns below; \onepageout will try to fit the two columns
5242 % and the final section into the vbox of \pageheight (see
5243 % \pagebody), causing an overfull box.
5245 % Note that glue won't work here, because glue does not exercise the
5246 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5250 % Split the last of the double-column material. Leave it on the
5251 % current page, no automatic page break.
5254 % If we end up splitting too much material for the current page,
5255 % though, there will be another page break right after this \output
5256 % invocation ends. Having called \balancecolumns once, we do not
5257 % want to call it again. Therefore, reset \output to its normal
5258 % definition right away. (We hope \balancecolumns will never be
5259 % called on to balance too much material, but if it is, this makes
5260 % the output somewhat more palatable.)
5261 \global\output =
{\onepageout{\pagecontents\PAGE}}%
5264 \endgroup % started in \begindoublecolumns
5266 % \pagegoal was set to the doubled \vsize above, since we restarted
5267 % the current page. We're now back to normal single-column
5268 % typesetting, so reset \pagegoal to the normal \vsize (after the
5269 % \endgroup where \vsize got restored).
5273 % Called at the end of the double column material.
5274 \def\balancecolumns{%
5275 \setbox0 =
\vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5277 \advance\dimen@ by
\topskip
5278 \advance\dimen@ by-
\baselineskip
5279 \divide\dimen@ by
2 % target to split to
5280 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5281 \splittopskip =
\topskip
5282 % Loop until we get a decent breakpoint.
5286 \global\setbox3 =
\copy0
5287 \global\setbox1 =
\vsplit3 to
\dimen@
5289 \global\advance\dimen@ by
1pt
5292 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5293 \setbox0=
\vbox to
\dimen@
{\unvbox1}%
5294 \setbox2=
\vbox to
\dimen@
{\unvbox3}%
5298 \catcode`\@ =
\other
5301 \message{sectioning,
}
5302 % Chapters, sections, etc.
5304 % Let's start with @part.
5305 \outer\parseargdef\part{\partzzz{#1}}
5309 \vskip.3\vsize % move it down on the page a bit
5311 \noindent \titlefonts\rmisbold #1\par % the text
5312 \let\lastnode=
\empty % no node to associate with
5313 \writetocentry{part
}{#1}{}% but put it in the toc
5314 \headingsoff % no headline or footline on the part page
5319 % \unnumberedno is an oxymoron. But we count the unnumbered
5320 % sections so that we can refer to them unambiguously in the pdf
5321 % outlines by their "section number". We avoid collisions with chapter
5322 % numbers by starting them at 10000. (If a document ever has 10000
5323 % chapters, we're in trouble anyway, I'm sure.)
5324 \newcount\unnumberedno \unnumberedno =
10000
5326 \newcount\secno \secno=
0
5327 \newcount\subsecno \subsecno=
0
5328 \newcount\subsubsecno \subsubsecno=
0
5330 % This counter is funny since it counts through charcodes of letters A, B, ...
5331 \newcount\appendixno \appendixno = `\@
5333 % \def\appendixletter{\char\the\appendixno}
5334 % We do the following ugly conditional instead of the above simple
5335 % construct for the sake of pdftex, which needs the actual
5336 % letter in the expansion, not just typeset.
5338 \def\appendixletter{%
5339 \ifnum\appendixno=`A A
%
5340 \else\ifnum\appendixno=`B B
%
5341 \else\ifnum\appendixno=`C C
%
5342 \else\ifnum\appendixno=`D D
%
5343 \else\ifnum\appendixno=`E E
%
5344 \else\ifnum\appendixno=`F F
%
5345 \else\ifnum\appendixno=`G G
%
5346 \else\ifnum\appendixno=`H H
%
5347 \else\ifnum\appendixno=`I I
%
5348 \else\ifnum\appendixno=`J J
%
5349 \else\ifnum\appendixno=`K K
%
5350 \else\ifnum\appendixno=`L L
%
5351 \else\ifnum\appendixno=`M M
%
5352 \else\ifnum\appendixno=`N N
%
5353 \else\ifnum\appendixno=`O O
%
5354 \else\ifnum\appendixno=`P P
%
5355 \else\ifnum\appendixno=`Q Q
%
5356 \else\ifnum\appendixno=`R R
%
5357 \else\ifnum\appendixno=`S S
%
5358 \else\ifnum\appendixno=`T T
%
5359 \else\ifnum\appendixno=`U U
%
5360 \else\ifnum\appendixno=`V V
%
5361 \else\ifnum\appendixno=`W W
%
5362 \else\ifnum\appendixno=`X X
%
5363 \else\ifnum\appendixno=`Y Y
%
5364 \else\ifnum\appendixno=`Z Z
%
5365 % The \the is necessary, despite appearances, because \appendixletter is
5366 % expanded while writing the .toc file. \char\appendixno is not
5367 % expandable, thus it is written literally, thus all appendixes come out
5368 % with the same letter (or @) in the toc without it.
5369 \else\char\the\appendixno
5370 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5371 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5373 % Each @chapter defines these (using marks) as the number+name, number
5374 % and name of the chapter. Page headings and footings can use
5375 % these. @section does likewise.
5377 \def\thischapternum{}
5378 \def\thischaptername{}
5380 \def\thissectionnum{}
5381 \def\thissectionname{}
5383 \newcount\absseclevel % used to calculate proper heading level
5384 \newcount\secbase\secbase=
0 % @raisesections/@lowersections modify this count
5386 % @raisesections: treat @section as chapter, @subsection as section, etc.
5387 \def\raisesections{\global\advance\secbase by -
1}
5388 \let\up=
\raisesections % original BFox name
5390 % @lowersections: treat @chapter as section, @section as subsection, etc.
5391 \def\lowersections{\global\advance\secbase by
1}
5392 \let\down=
\lowersections % original BFox name
5394 % we only have subsub.
5395 \chardef\maxseclevel =
3
5397 % A numbered section within an unnumbered changes to unnumbered too.
5398 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5399 \chardef\unnlevel =
\maxseclevel
5401 % Trace whether the current chapter is an appendix or not:
5402 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5403 \def\chapheadtype{N
}
5405 % Choose a heading macro
5406 % #1 is heading type
5407 % #2 is heading level
5408 % #3 is text for heading
5409 \def\genhead#1#2#3{%
5410 % Compute the abs. sec. level:
5412 \advance\absseclevel by
\secbase
5413 % Make sure \absseclevel doesn't fall outside the range:
5414 \ifnum \absseclevel <
0
5417 \ifnum \absseclevel >
3
5424 \ifnum \absseclevel <
\unnlevel
5425 \chardef\unnlevel =
\absseclevel
5428 % Check for appendix sections:
5429 \ifnum \absseclevel =
0
5430 \edef\chapheadtype{\headtype}%
5432 \if \headtype A
\if \chapheadtype N
%
5433 \errmessage{@appendix... within a non-appendix chapter
}%
5436 % Check for numbered within unnumbered:
5437 \ifnum \absseclevel >
\unnlevel
5440 \chardef\unnlevel =
3
5443 % Now print the heading:
5447 \or \unnumberedseczzz{#3}%
5448 \or \unnumberedsubseczzz{#3}%
5449 \or \unnumberedsubsubseczzz{#3}%
5455 \or \appendixsectionzzz{#3}%
5456 \or \appendixsubseczzz{#3}%
5457 \or \appendixsubsubseczzz{#3}%
5463 \or \numberedsubseczzz{#3}%
5464 \or \numberedsubsubseczzz{#3}%
5468 \suppressfirstparagraphindent
5472 \def\numhead{\genhead N
}
5473 \def\apphead{\genhead A
}
5474 \def\unnmhead{\genhead U
}
5476 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5477 % all lower-level sectioning counters to zero.
5479 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5480 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5481 \let\chaplevelprefix =
\empty
5483 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5485 % section resetting is \global in case the chapter is in a group, such
5486 % as an @include file.
5487 \global\secno=
0 \global\subsecno=
0 \global\subsubsecno=
0
5488 \global\advance\chapno by
1
5491 \gdef\chaplevelprefix{\the\chapno.
}%
5494 % \putwordChapter can contain complex things in translations.
5495 \toks0=
\expandafter{\putwordChapter}%
5496 \message{\the\toks0 \space \the\chapno}%
5498 % Write the actual heading.
5499 \chapmacro{#1}{Ynumbered
}{\the\chapno}%
5501 % So @section and the like are numbered underneath this chapter.
5502 \global\let\section =
\numberedsec
5503 \global\let\subsection =
\numberedsubsec
5504 \global\let\subsubsection =
\numberedsubsubsec
5507 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5509 \def\appendixzzz#1{%
5510 \global\secno=
0 \global\subsecno=
0 \global\subsubsecno=
0
5511 \global\advance\appendixno by
1
5512 \gdef\chaplevelprefix{\appendixletter.
}%
5515 % \putwordAppendix can contain complex things in translations.
5516 \toks0=
\expandafter{\putwordAppendix}%
5517 \message{\the\toks0 \space \appendixletter}%
5519 \chapmacro{#1}{Yappendix
}{\appendixletter}%
5521 \global\let\section =
\appendixsec
5522 \global\let\subsection =
\appendixsubsec
5523 \global\let\subsubsection =
\appendixsubsubsec
5526 % normally unnmhead0 calls unnumberedzzz:
5527 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5528 \def\unnumberedzzz#1{%
5529 \global\secno=
0 \global\subsecno=
0 \global\subsubsecno=
0
5530 \global\advance\unnumberedno by
1
5532 % Since an unnumbered has no number, no prefix for figures.
5533 \global\let\chaplevelprefix =
\empty
5536 % This used to be simply \message{#1}, but TeX fully expands the
5537 % argument to \message. Therefore, if #1 contained @-commands, TeX
5538 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5539 % expanded @cite (which turns out to cause errors because \cite is meant
5540 % to be executed, not expanded).
5542 % Anyway, we don't want the fully-expanded definition of @cite to appear
5543 % as a result of the \message, we just want `@cite' itself. We use
5544 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5545 % simply yielding the contents of <toks register>. (We also do this for
5548 \message{(
\the\toks0)
}%
5550 \chapmacro{#1}{Ynothing
}{\the\unnumberedno}%
5552 \global\let\section =
\unnumberedsec
5553 \global\let\subsection =
\unnumberedsubsec
5554 \global\let\subsubsection =
\unnumberedsubsubsec
5557 % @centerchap is like @unnumbered, but the heading is centered.
5558 \outer\parseargdef\centerchap{%
5559 % Well, we could do the following in a group, but that would break
5560 % an assumption that \chapmacro is called at the outermost level.
5561 % Thus we are safer this way: --kasal, 24feb04
5562 \let\centerparametersmaybe =
\centerparameters
5564 \let\centerparametersmaybe =
\relax
5567 % @top is like @unnumbered.
5572 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5574 \global\subsecno=
0 \global\subsubsecno=
0 \global\advance\secno by
1
5575 \sectionheading{#1}{sec
}{Ynumbered
}{\the\chapno.
\the\secno}%
5578 % normally calls appendixsectionzzz:
5579 \outer\parseargdef\appendixsection{\apphead1{#1}}
5580 \def\appendixsectionzzz#1{%
5581 \global\subsecno=
0 \global\subsubsecno=
0 \global\advance\secno by
1
5582 \sectionheading{#1}{sec
}{Yappendix
}{\appendixletter.
\the\secno}%
5584 \let\appendixsec\appendixsection
5586 % normally calls unnumberedseczzz:
5587 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5588 \def\unnumberedseczzz#1{%
5589 \global\subsecno=
0 \global\subsubsecno=
0 \global\advance\secno by
1
5590 \sectionheading{#1}{sec
}{Ynothing
}{\the\unnumberedno.
\the\secno}%
5595 % normally calls numberedsubseczzz:
5596 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5597 \def\numberedsubseczzz#1{%
5598 \global\subsubsecno=
0 \global\advance\subsecno by
1
5599 \sectionheading{#1}{subsec
}{Ynumbered
}{\the\chapno.
\the\secno.
\the\subsecno}%
5602 % normally calls appendixsubseczzz:
5603 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5604 \def\appendixsubseczzz#1{%
5605 \global\subsubsecno=
0 \global\advance\subsecno by
1
5606 \sectionheading{#1}{subsec
}{Yappendix
}%
5607 {\appendixletter.
\the\secno.
\the\subsecno}%
5610 % normally calls unnumberedsubseczzz:
5611 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5612 \def\unnumberedsubseczzz#1{%
5613 \global\subsubsecno=
0 \global\advance\subsecno by
1
5614 \sectionheading{#1}{subsec
}{Ynothing
}%
5615 {\the\unnumberedno.
\the\secno.
\the\subsecno}%
5620 % normally numberedsubsubseczzz:
5621 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5622 \def\numberedsubsubseczzz#1{%
5623 \global\advance\subsubsecno by
1
5624 \sectionheading{#1}{subsubsec
}{Ynumbered
}%
5625 {\the\chapno.
\the\secno.
\the\subsecno.
\the\subsubsecno}%
5628 % normally appendixsubsubseczzz:
5629 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5630 \def\appendixsubsubseczzz#1{%
5631 \global\advance\subsubsecno by
1
5632 \sectionheading{#1}{subsubsec
}{Yappendix
}%
5633 {\appendixletter.
\the\secno.
\the\subsecno.
\the\subsubsecno}%
5636 % normally unnumberedsubsubseczzz:
5637 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5638 \def\unnumberedsubsubseczzz#1{%
5639 \global\advance\subsubsecno by
1
5640 \sectionheading{#1}{subsubsec
}{Ynothing
}%
5641 {\the\unnumberedno.
\the\secno.
\the\subsecno.
\the\subsubsecno}%
5644 % These macros control what the section commands do, according
5645 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5646 % Define them by default for a numbered chapter.
5647 \let\section =
\numberedsec
5648 \let\subsection =
\numberedsubsec
5649 \let\subsubsection =
\numberedsubsubsec
5651 % Define @majorheading, @heading and @subheading
5654 {\advance\chapheadingskip by
10pt
\chapbreak }%
5655 \parsearg\chapheadingzzz
5658 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5659 \def\chapheadingzzz#1{%
5660 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5661 \nobreak\bigskip \nobreak
5662 \suppressfirstparagraphindent
5665 % @heading, @subheading, @subsubheading.
5666 \parseargdef\heading{\sectionheading{#1}{sec
}{Yomitfromtoc
}{}
5667 \suppressfirstparagraphindent}
5668 \parseargdef\subheading{\sectionheading{#1}{subsec
}{Yomitfromtoc
}{}
5669 \suppressfirstparagraphindent}
5670 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec
}{Yomitfromtoc
}{}
5671 \suppressfirstparagraphindent}
5673 % These macros generate a chapter, section, etc. heading only
5674 % (including whitespace, linebreaking, etc. around it),
5675 % given all the information in convenient, parsed form.
5677 % Args are the skip and penalty (usually negative)
5678 \def\dobreak#1#2{\par\ifdim\lastskip<
#1\removelastskip\penalty#2\vskip#1\fi}
5680 % Parameter controlling skip before chapter headings (if needed)
5681 \newskip\chapheadingskip
5683 % Define plain chapter starts, and page on/off switching for it.
5684 \def\chapbreak{\dobreak \chapheadingskip {-
4000}}
5685 \def\chappager{\par\vfill\supereject}
5686 % Because \domark is called before \chapoddpage, the filler page will
5687 % get the headings for the next chapter, which is wrong. But we don't
5688 % care -- we just disable all headings on the filler page.
5700 \def\setchapternewpage #1 {\csname CHAPPAG
#1\endcsname}
5703 \global\let\contentsalignmacro =
\chappager
5704 \global\let\pchapsepmacro=
\chapbreak
5705 \global\let\pagealignmacro=
\chappager}
5708 \global\let\contentsalignmacro =
\chappager
5709 \global\let\pchapsepmacro=
\chappager
5710 \global\let\pagealignmacro=
\chappager
5711 \global\def\HEADINGSon{\HEADINGSsingle}}
5714 \global\let\contentsalignmacro =
\chapoddpage
5715 \global\let\pchapsepmacro=
\chapoddpage
5716 \global\let\pagealignmacro=
\chapoddpage
5717 \global\def\HEADINGSon{\HEADINGSdouble}}
5723 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5724 % Yappendix, Yomitfromtoc), #3 the chapter number.
5726 % To test against our argument.
5727 \def\Ynothingkeyword{Ynothing
}
5728 \def\Yomitfromtockeyword{Yomitfromtoc
}
5729 \def\Yappendixkeyword{Yappendix
}
5731 \def\chapmacro#1#2#3{%
5732 % Insert the first mark before the heading break (see notes for \domark).
5733 \let\prevchapterdefs=
\lastchapterdefs
5734 \let\prevsectiondefs=
\lastsectiondefs
5735 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5736 \gdef\thissection{}}%
5739 \ifx\temptype\Ynothingkeyword
5740 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5741 \gdef\thischapter{\thischaptername}}%
5742 \else\ifx\temptype\Yomitfromtockeyword
5743 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5744 \gdef\thischapter{}}%
5745 \else\ifx\temptype\Yappendixkeyword
5747 \xdef\lastchapterdefs{%
5748 \gdef\noexpand\thischaptername{\the\toks0}%
5749 \gdef\noexpand\thischapternum{\appendixletter}%
5750 % \noexpand\putwordAppendix avoids expanding indigestible
5751 % commands in some of the translations.
5752 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5753 \noexpand\thischapternum:
5754 \noexpand\thischaptername}%
5758 \xdef\lastchapterdefs{%
5759 \gdef\noexpand\thischaptername{\the\toks0}%
5760 \gdef\noexpand\thischapternum{\the\chapno}%
5761 % \noexpand\putwordChapter avoids expanding indigestible
5762 % commands in some of the translations.
5763 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5764 \noexpand\thischapternum:
5765 \noexpand\thischaptername}%
5769 % Output the mark. Pass it through \safewhatsit, to take care of
5770 % the preceding space.
5773 % Insert the chapter heading break.
5776 % Now the second mark, after the heading break. No break points
5777 % between here and the heading.
5778 \let\prevchapterdefs=
\lastchapterdefs
5779 \let\prevsectiondefs=
\lastsectiondefs
5783 \chapfonts \rmisbold
5785 % Have to define \lastsection before calling \donoderef, because the
5786 % xref code eventually uses it. On the other hand, it has to be called
5787 % after \pchapsepmacro, or the headline will change too soon.
5788 \gdef\lastsection{#1}%
5790 % Only insert the separating space if we have a chapter/appendix
5791 % number, and don't print the unnumbered ``number''.
5792 \ifx\temptype\Ynothingkeyword
5794 \def\toctype{unnchap
}%
5795 \else\ifx\temptype\Yomitfromtockeyword
5796 \setbox0 =
\hbox{}% contents like unnumbered, but no toc entry
5798 \else\ifx\temptype\Yappendixkeyword
5799 \setbox0 =
\hbox{\putwordAppendix{} #3\enspace}%
5802 \setbox0 =
\hbox{#3\enspace}%
5803 \def\toctype{numchap
}%
5806 % Write the toc entry for this chapter. Must come before the
5807 % \donoderef, because we include the current node name in the toc
5808 % entry, and \donoderef resets it to empty.
5809 \writetocentry{\toctype}{#1}{#3}%
5811 % For pdftex, we have to write out the node definition (aka, make
5812 % the pdfdest) after any page break, but before the actual text has
5813 % been typeset. If the destination for the pdf outline is after the
5814 % text, then jumping from the outline may wind up with the text not
5815 % being visible, for instance under high magnification.
5818 % Typeset the actual heading.
5819 \nobreak % Avoid page breaks at the interline glue.
5820 \vbox{\raggedtitlesettings \hangindent=
\wd0 \centerparametersmaybe
5823 \nobreak\bigskip % no page break after a chapter title
5827 % @centerchap -- centered and unnumbered.
5828 \let\centerparametersmaybe =
\relax
5829 \def\centerparameters{%
5830 \advance\rightskip by
3\rightskip
5831 \leftskip =
\rightskip
5836 % I don't think this chapter style is supported any more, so I'm not
5837 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5839 \def\setchapterstyle #1 {\csname CHAPF
#1\endcsname}
5841 \def\unnchfopen #1{%
5843 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5844 \nobreak\bigskip\nobreak
5846 \def\chfopen #1#2{\chapoddpage {\chapfonts
5847 \vbox to
3in
{\vfil \hbox to
\hsize{\hfil #2} \hbox to
\hsize{\hfil #1} \vfil}}%
5850 \def\centerchfopen #1{%
5852 \vbox{\chapfonts \raggedtitlesettings \hfill #1\hfill}%
5853 \nobreak\bigskip \nobreak
5856 \global\let\chapmacro=
\chfopen
5857 \global\let\centerchapmacro=
\centerchfopen}
5860 % Section titles. These macros combine the section number parts and
5861 % call the generic \sectionheading to do the printing.
5863 \newskip\secheadingskip
5864 \def\secheadingbreak{\dobreak \secheadingskip{-
1000}}
5866 % Subsection titles.
5867 \newskip\subsecheadingskip
5868 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-
500}}
5870 % Subsubsection titles.
5871 \def\subsubsecheadingskip{\subsecheadingskip}
5872 \def\subsubsecheadingbreak{\subsecheadingbreak}
5875 % Print any size, any type, section title.
5877 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5878 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5881 \def\seckeyword{sec
}
5883 \def\sectionheading#1#2#3#4{%
5885 \checkenv{}% should not be in an environment.
5887 % Switch to the right set of fonts.
5888 \csname #2fonts
\endcsname \rmisbold
5890 \def\sectionlevel{#2}%
5893 % Insert first mark before the heading break (see notes for \domark).
5894 \let\prevsectiondefs=
\lastsectiondefs
5895 \ifx\temptype\Ynothingkeyword
5896 \ifx\sectionlevel\seckeyword
5897 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5898 \gdef\thissection{\thissectionname}}%
5900 \else\ifx\temptype\Yomitfromtockeyword
5901 % Don't redefine \thissection.
5902 \else\ifx\temptype\Yappendixkeyword
5903 \ifx\sectionlevel\seckeyword
5905 \xdef\lastsectiondefs{%
5906 \gdef\noexpand\thissectionname{\the\toks0}%
5907 \gdef\noexpand\thissectionnum{#4}%
5908 % \noexpand\putwordSection avoids expanding indigestible
5909 % commands in some of the translations.
5910 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5911 \noexpand\thissectionnum:
5912 \noexpand\thissectionname}%
5916 \ifx\sectionlevel\seckeyword
5918 \xdef\lastsectiondefs{%
5919 \gdef\noexpand\thissectionname{\the\toks0}%
5920 \gdef\noexpand\thissectionnum{#4}%
5921 % \noexpand\putwordSection avoids expanding indigestible
5922 % commands in some of the translations.
5923 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5924 \noexpand\thissectionnum:
5925 \noexpand\thissectionname}%
5930 % Go into vertical mode. Usually we'll already be there, but we
5931 % don't want the following whatsit to end up in a preceding paragraph
5932 % if the document didn't happen to have a blank line.
5935 % Output the mark. Pass it through \safewhatsit, to take care of
5936 % the preceding space.
5939 % Insert space above the heading.
5940 \csname #2headingbreak
\endcsname
5942 % Now the second mark, after the heading break. No break points
5943 % between here and the heading.
5944 \global\let\prevsectiondefs=
\lastsectiondefs
5947 % Only insert the space after the number if we have a section number.
5948 \ifx\temptype\Ynothingkeyword
5951 \gdef\lastsection{#1}%
5952 \else\ifx\temptype\Yomitfromtockeyword
5953 % for @headings -- no section number, don't include in toc,
5954 % and don't redefine \lastsection.
5957 \let\sectionlevel=
\empty
5958 \else\ifx\temptype\Yappendixkeyword
5959 \setbox0 =
\hbox{#4\enspace}%
5961 \gdef\lastsection{#1}%
5963 \setbox0 =
\hbox{#4\enspace}%
5965 \gdef\lastsection{#1}%
5968 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5969 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5971 % Write the node reference (= pdf destination for pdftex).
5972 % Again, see comments in \chapmacro.
5975 % Interline glue will be inserted when the vbox is completed.
5976 % That glue will be a valid breakpoint for the page, since it'll be
5977 % preceded by a whatsit (usually from the \donoderef, or from the
5978 % \writetocentry if there was no node). We don't want to allow that
5979 % break, since then the whatsits could end up on page n while the
5980 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5983 % Output the actual section heading.
5984 \vbox{\hyphenpenalty=
10000 \tolerance=
5000 \parindent=
0pt
\ptexraggedright
5985 \hangindent=
\wd0 % zero if no section number
5988 % Add extra space after the heading -- half of whatever came above it.
5989 % Don't allow stretch, though.
5990 \kern .5 \csname #2headingskip
\endcsname
5992 % Do not let the kern be a potential breakpoint, as it would be if it
5993 % was followed by glue.
5996 % We'll almost certainly start a paragraph next, so don't let that
5997 % glue accumulate. (Not a breakpoint because it's preceded by a
5998 % discardable item.) However, when a paragraph is not started next
5999 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
6000 % or the negative glue will cause weirdly wrong output, typically
6001 % obscuring the section heading with something else.
6004 % This is so the last item on the main vertical list is a known
6005 % \penalty > 10000, so \startdefun, etc., can recognize the situation
6006 % and do the needful.
6012 % Table of contents.
6015 % Write an entry to the toc file, opening it if necessary.
6016 % Called from @chapter, etc.
6018 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
6019 % We append the current node name (if any) and page number as additional
6020 % arguments for the \{chap,sec,...}entry macros which will eventually
6021 % read this. The node name is used in the pdf outlines as the
6022 % destination to jump to.
6024 % We open the .toc file for writing here instead of at @setfilename (or
6025 % any other fixed time) so that @contents can be anywhere in the document.
6026 % But if #1 is `omit', then we don't do anything. This is used for the
6027 % table of contents chapter openings themselves.
6029 \newif\iftocfileopened
6030 \def\omitkeyword{omit
}%
6032 \def\writetocentry#1#2#3{%
6033 \edef\writetoctype{#1}%
6034 \ifx\writetoctype\omitkeyword \else
6035 \iftocfileopened\else
6036 \immediate\openout\tocfile =
\jobname.toc
6037 \global\tocfileopenedtrue
6043 \write\tocfile{@
#1entry
{#2}{#3}{\lastnode}{\noexpand\folio}}}%
6049 % Tell \shipout to create a pdf destination on each page, if we're
6050 % writing pdf. These are used in the table of contents. We can't
6051 % just write one on every page because the title pages are numbered
6052 % 1 and 2 (the page numbers aren't printed), and so are the first
6053 % two pages of the document. Thus, we'd have two destinations named
6054 % `1', and two named `2'.
6055 \ifpdf \global\pdfmakepagedesttrue \fi
6059 % These characters do not print properly in the Computer Modern roman
6060 % fonts, so we must take special care. This is more or less redundant
6061 % with the Texinfo input format setup at the end of this file.
6063 \def\activecatcodes{%
6076 % Read the toc file, which is essentially Texinfo input.
6080 \input \tocreadfilename
6083 \newskip\contentsrightmargin \contentsrightmargin=
1in
6084 \newcount\savepageno
6085 \newcount\lastnegativepageno \lastnegativepageno = -
1
6087 % Prepare to read what we've written to \tocfile.
6089 \def\startcontents#1{%
6090 % If @setchapternewpage on, and @headings double, the contents should
6091 % start on an odd page, unlike chapters. Thus, we maintain
6092 % \contentsalignmacro in parallel with \pagealignmacro.
6093 % From: Torbjorn Granlund <tege@matematik.su.se>
6095 \immediate\closeout\tocfile
6097 % Don't need to put `Contents' or `Short Contents' in the headline.
6098 % It is abundantly clear what they are.
6099 \chapmacro{#1}{Yomitfromtoc
}{}%
6101 \savepageno =
\pageno
6102 \begingroup % Set up to handle contents files properly.
6103 \raggedbottom % Worry more about breakpoints than the bottom.
6104 \advance\hsize by -
\contentsrightmargin % Don't use the full line length.
6106 % Roman numerals for page numbers.
6107 \ifnum \pageno>
0 \global\pageno =
\lastnegativepageno \fi
6110 % redefined for the two-volume lispref. We always output on
6111 % \jobname.toc even if this is redefined.
6113 \def\tocreadfilename{\jobname.toc
}
6115 % Normal (long) toc.
6118 \startcontents{\putwordTOC}%
6119 \openin 1 \tocreadfilename\space
6124 \contentsalignmacro % in case @setchapternewpage odd is in effect
6130 \lastnegativepageno =
\pageno
6131 \global\pageno =
\savepageno
6134 % And just the chapters.
6135 \def\summarycontents{%
6136 \startcontents{\putwordShortTOC}%
6138 \let\partentry =
\shortpartentry
6139 \let\numchapentry =
\shortchapentry
6140 \let\appentry =
\shortchapentry
6141 \let\unnchapentry =
\shortunnchapentry
6142 % We want a true roman here for the page numbers.
6144 \let\rm=
\shortcontrm \let\bf=
\shortcontbf
6145 \let\sl=
\shortcontsl \let\tt=
\shortconttt
6147 \hyphenpenalty =
10000
6148 \advance\baselineskip by
1pt
% Open it up a little.
6149 \def\numsecentry#
#1#
#2#
#3#
#4{}
6150 \let\appsecentry =
\numsecentry
6151 \let\unnsecentry =
\numsecentry
6152 \let\numsubsecentry =
\numsecentry
6153 \let\appsubsecentry =
\numsecentry
6154 \let\unnsubsecentry =
\numsecentry
6155 \let\numsubsubsecentry =
\numsecentry
6156 \let\appsubsubsecentry =
\numsecentry
6157 \let\unnsubsubsecentry =
\numsecentry
6158 \openin 1 \tocreadfilename\space
6164 \contentsalignmacro % in case @setchapternewpage odd is in effect
6166 \lastnegativepageno =
\pageno
6167 \global\pageno =
\savepageno
6169 \let\shortcontents =
\summarycontents
6171 % Typeset the label for a chapter or appendix for the short contents.
6172 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6174 \def\shortchaplabel#1{%
6175 % This space should be enough, since a single number is .5em, and the
6176 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6177 % But use \hss just in case.
6178 % (This space doesn't include the extra space that gets added after
6179 % the label; that gets put in by \shortchapentry above.)
6181 % We'd like to right-justify chapter numbers, but that looks strange
6182 % with appendix letters. And right-justifying numbers and
6183 % left-justifying letters looks strange when there is less than 10
6184 % chapters. Have to read the whole toc once to know how many chapters
6185 % there are before deciding ...
6186 \hbox to
1em
{#1\hss}%
6189 % These macros generate individual entries in the table of contents.
6190 % The first argument is the chapter or section name.
6191 % The last argument is the page number.
6192 % The arguments in between are the chapter number, section number, ...
6194 % Parts, in the main contents. Replace the part number, which doesn't
6195 % exist, with an empty box. Let's hope all the numbers have the same width.
6196 % Also ignore the page number, which is conventionally not printed.
6197 \def\numeralbox{\setbox0=
\hbox{8}\hbox to
\wd0{\hfil}}
6198 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6200 % Parts, in the short toc.
6201 \def\shortpartentry#1#2#3#4{%
6203 \vskip.5\baselineskip plus
.15\baselineskip minus
.1\baselineskip
6204 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6207 % Chapters, in the main contents.
6208 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6210 % Chapters, in the short toc.
6211 % See comments in \dochapentry re vbox and related settings.
6212 \def\shortchapentry#1#2#3#4{%
6213 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6216 % Appendices, in the main contents.
6217 % Need the word Appendix, and a fixed-size box.
6219 \def\appendixbox#1{%
6220 % We use M since it's probably the widest letter.
6221 \setbox0 =
\hbox{\putwordAppendix{} M
}%
6222 \hbox to
\wd0{\putwordAppendix{} #1\hss}}
6224 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6226 % Unnumbered chapters.
6227 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6228 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6231 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6232 \let\appsecentry=
\numsecentry
6233 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6236 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6237 \let\appsubsecentry=
\numsubsecentry
6238 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6240 % And subsubsections.
6241 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6242 \let\appsubsubsecentry=
\numsubsubsecentry
6243 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6245 % This parameter controls the indentation of the various levels.
6246 % Same as \defaultparindent.
6247 \newdimen\tocindent \tocindent =
15pt
6249 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6252 % If the toc has to be broken over pages, we want it to be at chapters
6253 % if at all possible; hence the \penalty.
6254 \def\dochapentry#1#2{%
6255 \penalty-
300 \vskip1\baselineskip plus
.33\baselineskip minus
.25\baselineskip
6258 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6260 \nobreak\vskip .25\baselineskip plus
.1\baselineskip
6263 \def\dosecentry#1#2{\begingroup
6264 \secentryfonts \leftskip=
\tocindent
6265 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6268 \def\dosubsecentry#1#2{\begingroup
6269 \subsecentryfonts \leftskip=
2\tocindent
6270 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6273 \def\dosubsubsecentry#1#2{\begingroup
6274 \subsubsecentryfonts \leftskip=
3\tocindent
6275 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6278 % We use the same \entry macro as for the index entries.
6279 \let\tocentry =
\entry
6281 % Space between chapter (or whatever) number and the title.
6282 \def\labelspace{\hskip1em \relax}
6284 \def\dopageno#1{{\rm #1}}
6285 \def\doshortpageno#1{{\rm #1}}
6287 \def\chapentryfonts{\secfonts \rm}
6288 \def\secentryfonts{\textfonts}
6289 \def\subsecentryfonts{\textfonts}
6290 \def\subsubsecentryfonts{\textfonts}
6293 \message{environments,
}
6294 % @foo ... @end foo.
6296 % @tex ... @end tex escapes into raw TeX temporarily.
6297 % One exception: @ is still an escape character, so that @end tex works.
6298 % But \@ or @@ will get a plain @ character.
6301 \setupmarkupstyle{tex
}%
6302 \catcode `\\=
0 \catcode `\
{=
1 \catcode `\
}=
2
6303 \catcode `\$=
3 \catcode `\&=
4 \catcode `\#=
6
6304 \catcode `\^=
7 \catcode `
\_=
8 \catcode `\~=
\active \let~=
\tie
6315 % ' is active in math mode (mathcode"8000). So reset it, and all our
6316 % other math active characters (just in case), to plain's definitions.
6320 \let\bullet=
\ptexbullet
6325 \let\equiv=
\ptexequiv
6328 \let\indent=
\ptexindent
6329 \let\noindent=
\ptexnoindent
6336 \expandafter \let\csname top
\endcsname=
\ptextop % we've made it outer
6337 \let\frenchspacing=
\plainfrenchspacing
6339 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6340 \def\enddots{\relax\ifmmode\endldots\else$
\mathsurround=
0pt
\endldots\,$
\fi}%
6343 % There is no need to define \Etex.
6345 % Define @lisp ... @end lisp.
6346 % @lisp environment forms a group so it can rebind things,
6347 % including the definition of @end lisp (which normally is erroneous).
6349 % Amount to narrow the margins by for @lisp.
6350 \newskip\lispnarrowing \lispnarrowing=
0.4in
6352 % This is the definition that ^^M gets inside @lisp, @example, and other
6353 % such environments. \null is better than a space, since it doesn't
6355 \def\lisppar{\null\endgraf}
6357 % This space is always present above and below environments.
6358 \newskip\envskipamount \envskipamount =
0pt
6360 % Make spacing and below environment symmetrical. We use \parskip here
6361 % to help in doing that, since in @example-like environments \parskip
6362 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6363 % start of the next paragraph will insert \parskip.
6365 \def\aboveenvbreak{{%
6366 % =10000 instead of <10000 because of a special case in \itemzzz and
6367 % \sectionheading, q.v.
6368 \ifnum \lastpenalty=
10000 \else
6369 \advance\envskipamount by
\parskip
6371 \ifdim\lastskip<
\envskipamount
6373 % it's not a good place to break if the last penalty was \nobreak
6375 \ifnum\lastpenalty<
10000 \penalty-
50 \fi
6376 \vskip\envskipamount
6381 \let\afterenvbreak =
\aboveenvbreak
6383 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6384 % also clear it, so that its embedded environments do the narrowing again.
6385 \let\nonarrowing=
\relax
6387 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6388 % environment contents.
6389 \font\circle=lcircle10
6391 \newdimen\cartouter\newdimen\cartinner
6392 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6393 \circthick=
\fontdimen8\circle
6395 \def\ctl{{\circle\char'
013\hskip -
6pt
}}% 6pt from pl file: 1/2charwidth
6396 \def\ctr{{\hskip 6pt
\circle\char'
010}}
6397 \def\cbl{{\circle\char'
012\hskip -
6pt
}}
6398 \def\cbr{{\hskip 6pt
\circle\char'
011}}
6399 \def\carttop{\hbox to
\cartouter{\hskip\lskip
6400 \ctl\leaders\hrule height
\circthick\hfil\ctr
6402 \def\cartbot{\hbox to
\cartouter{\hskip\lskip
6403 \cbl\leaders\hrule height
\circthick\hfil\cbr
6406 \newskip\lskip\newskip\rskip
6409 \ifhmode\par\fi % can't be in the midst of a paragraph.
6411 \lskip=
\leftskip \rskip=
\rightskip
6412 \leftskip=
0pt
\rightskip=
0pt
% we want these *outside*.
6413 \cartinner=
\hsize \advance\cartinner by-
\lskip
6414 \advance\cartinner by-
\rskip
6416 \advance\cartouter by
18.4pt
% allow for 3pt kerns on either
6417 % side, and for 6pt waste from
6418 % each corner char, and rule thickness
6419 \normbskip=
\baselineskip \normpskip=
\parskip \normlskip=
\lineskip
6420 % Flag to tell @lisp, etc., not to narrow margin.
6421 \let\nonarrowing = t
%
6423 % If this cartouche directly follows a sectioning command, we need the
6424 % \parskip glue (backspaced over by default) or the cartouche can
6425 % collide with the section heading.
6426 \ifnum\lastpenalty>
10000 \vskip\parskip \penalty\lastpenalty \fi
6429 \baselineskip=
0pt
\parskip=
0pt
\lineskip=
0pt
6437 \baselineskip=
\normbskip
6438 \lineskip=
\normlskip
6441 \comment % For explanation, see the end of def\group.
6456 % This macro is called at the beginning of all the @example variants,
6458 \newdimen\nonfillparindent
6461 \ifdim\hfuzz <
12pt
\hfuzz =
12pt
\fi % Don't be fussy
6462 \sepspaces % Make spaces be word-separators rather than space tokens.
6463 \let\par =
\lisppar % don't ignore blank lines
6464 \obeylines % each line of input is a line of output
6466 % Turn off paragraph indentation but redefine \indent to emulate
6467 % the normal \indent.
6468 \nonfillparindent=
\parindent
6470 \let\indent\nonfillindent
6472 \emergencystretch =
0pt
% don't try to avoid overfull boxes
6473 \ifx\nonarrowing\relax
6474 \advance \leftskip by
\lispnarrowing
6475 \exdentamount=
\lispnarrowing
6477 \let\nonarrowing =
\relax
6479 \let\exdent=
\nofillexdent
6484 % We want to swallow spaces (but not other tokens) after the fake
6485 % @indent in our nonfill-environments, where spaces are normally
6486 % active and set to @tie, resulting in them not being ignored after
6488 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6489 \gdef\nonfillindentcheck{%
6491 \expandafter\nonfillindentgobble%
6493 \leavevmode\nonfillindentbox%
6497 \def\nonfillindentgobble#1{\nonfillindent}
6498 \def\nonfillindentbox{\hbox to
\nonfillparindent{\hss}}
6500 % If you want all examples etc. small: @set dispenvsize small.
6501 % If you want even small examples the full size: @set dispenvsize nosmall.
6502 % This affects the following displayed environments:
6503 % @example, @display, @format, @lisp
6505 \def\smallword{small
}
6506 \def\nosmallword{nosmall
}
6507 \let\SETdispenvsize\relax
6508 \def\setnormaldispenv{%
6509 \ifx\SETdispenvsize\smallword
6510 % end paragraph for sake of leading, in case document has no blank
6511 % line. This is redundant with what happens in \aboveenvbreak, but
6512 % we need to do it before changing the fonts, and it's inconvenient
6513 % to change the fonts afterward.
6514 \ifnum \lastpenalty=
10000 \else \endgraf \fi
6515 \smallexamplefonts \rm
6518 \def\setsmalldispenv{%
6519 \ifx\SETdispenvsize\nosmallword
6521 \ifnum \lastpenalty=
10000 \else \endgraf \fi
6522 \smallexamplefonts \rm
6526 % We often define two environments, @foo and @smallfoo.
6527 % Let's do it in one command. #1 is the env name, #2 the definition.
6528 \def\makedispenvdef#1#2{%
6529 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6530 \expandafter\envdef\csname small
#1\endcsname {\setsmalldispenv #2}%
6531 \expandafter\let\csname E
#1\endcsname \afterenvbreak
6532 \expandafter\let\csname Esmall
#1\endcsname \afterenvbreak
6535 % Define two environment synonyms (#1 and #2) for an environment.
6536 \def\maketwodispenvdef#1#2#3{%
6537 \makedispenvdef{#1}{#3}%
6538 \makedispenvdef{#2}{#3}%
6541 % @lisp: indented, narrowed, typewriter font;
6542 % @example: same as @lisp.
6544 % @smallexample and @smalllisp: use smaller fonts.
6545 % Originally contributed by Pavel@xerox.
6547 \maketwodispenvdef{lisp
}{example
}{%
6549 \tt\setupmarkupstyle{example
}%
6550 \let\kbdfont =
\kbdexamplefont % Allow @kbd to do something special.
6551 \gobble % eat return
6553 % @display/@smalldisplay: same as @lisp except keep current font.
6555 \makedispenvdef{display
}{%
6560 % @format/@smallformat: same as @display except don't narrow margins.
6562 \makedispenvdef{format
}{%
6563 \let\nonarrowing = t
%
6568 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6570 \let\nonarrowing = t
%
6574 \let\Eflushleft =
\afterenvbreak
6578 \envdef\flushright{%
6579 \let\nonarrowing = t
%
6581 \advance\leftskip by
0pt plus
1fill
\relax
6584 \let\Eflushright =
\afterenvbreak
6587 % @raggedright does more-or-less normal line breaking but no right
6588 % justification. From plain.tex.
6589 \envdef\raggedright{%
6590 \rightskip0pt plus2em
\spaceskip.3333em
\xspaceskip.5em
\relax
6592 \let\Eraggedright\par
6594 \envdef\raggedleft{%
6595 \parindent=
0pt
\leftskip0pt plus2em
6596 \spaceskip.3333em
\xspaceskip.5em
\parfillskip=
0pt
6597 \hbadness=
10000 % Last line will usually be underfull, so turn off
6598 % badness reporting.
6600 \let\Eraggedleft\par
6602 \envdef\raggedcenter{%
6603 \parindent=
0pt
\rightskip0pt plus1em
\leftskip0pt plus1em
6604 \spaceskip.3333em
\xspaceskip.5em
\parfillskip=
0pt
6605 \hbadness=
10000 % Last line will usually be underfull, so turn off
6606 % badness reporting.
6608 \let\Eraggedcenter\par
6611 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6612 % and narrows the margins. We keep \parskip nonzero in general, since
6613 % we're doing normal filling. So, when using \aboveenvbreak and
6614 % \afterenvbreak, temporarily make \parskip 0.
6616 \makedispenvdef{quotation
}{\quotationstart}
6618 \def\quotationstart{%
6619 \indentedblockstart % same as \indentedblock, but increase right margin too.
6620 \ifx\nonarrowing\relax
6621 \advance\rightskip by
\lispnarrowing
6623 \parsearg\quotationlabel
6626 % We have retained a nonzero parskip for the environment, since we're
6627 % doing normal filling.
6631 \ifx\quotationauthor\thisisundefined\else
6633 \leftline{\kern 2\leftskip \sl ---
\quotationauthor}%
6635 {\parskip=
0pt
\afterenvbreak}%
6637 \def\Esmallquotation{\Equotation}
6639 % If we're given an argument, typeset it in bold with a colon after.
6640 \def\quotationlabel#1{%
6642 \ifx\temp\empty \else
6647 % @indentedblock is like @quotation, but indents only on the left and
6648 % has no optional argument.
6650 \makedispenvdef{indentedblock
}{\indentedblockstart}
6652 \def\indentedblockstart{%
6653 {\parskip=
0pt
\aboveenvbreak}% because \aboveenvbreak inserts \parskip
6656 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6657 \ifx\nonarrowing\relax
6658 \advance\leftskip by
\lispnarrowing
6659 \exdentamount =
\lispnarrowing
6661 \let\nonarrowing =
\relax
6665 % Keep a nonzero parskip for the environment, since we're doing normal filling.
6667 \def\Eindentedblock{%
6669 {\parskip=
0pt
\afterenvbreak}%
6671 \def\Esmallindentedblock{\Eindentedblock}
6674 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6675 % If we want to allow any <char> as delimiter,
6676 % we need the curly braces so that makeinfo sees the @verb command, eg:
6677 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6679 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6681 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6682 % active too. Otherwise, they get lost as the first character on a
6685 \do\
\do\\
\do\
{\do\
}\do\$
\do\&
%
6686 \do\#
\do\^
\do\^^K
\do\_\do\^^A
\do\%
\do\~
%
6687 \do\<
\do\>
\do\|
\do\@
\do+
\do\"
%
6688 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6689 % @set txicodequotebacktick will not have effect on @verb and
6690 % @verbatim, and ?` and !` ligatures won't get disabled.
6695 \def\uncatcodespecials{%
6696 \def\do#
#1{\catcode`#
#1=
\other}\dospecials}
6698 % Setup for the @verb command.
6700 % Eight spaces for a tab
6702 \catcode`\^^I=
\active
6703 \gdef\tabeightspaces{\catcode`\^^I=
\active\def^^I
{\ \ \ \ \ \ \ \
}}
6707 \tt % easiest (and conventionally used) font for verbatim
6708 \def\par{\leavevmode\endgraf}%
6709 \setupmarkupstyle{verb
}%
6711 % Respect line breaks,
6712 % print special symbols as themselves, and
6713 % make each space count
6714 % must do in this order:
6715 \obeylines \uncatcodespecials \sepspaces
6718 % Setup for the @verbatim environment
6720 % Real tab expansion.
6721 \newdimen\tabw \setbox0=
\hbox{\tt\space} \tabw=
8\wd0 % tab amount
6723 % We typeset each line of the verbatim in an \hbox, so we can handle
6724 % tabs. The \global is in case the verbatim line starts with an accent,
6725 % or some other command that starts with a begin-group. Otherwise, the
6726 % entire \verbbox would disappear at the corresponding end-group, before
6727 % it is typeset. Meanwhile, we can't have nested verbatim commands
6728 % (can we?), so the \global won't be overwriting itself.
6730 \def\starttabbox{\global\setbox\verbbox=
\hbox\bgroup}
6733 \catcode`\^^I=
\active
6735 \catcode`\^^I=
\active
6736 \def^^I
{\leavevmode\egroup
6737 \dimen\verbbox=
\wd\verbbox % the width so far, or since the previous tab
6738 \divide\dimen\verbbox by
\tabw
6739 \multiply\dimen\verbbox by
\tabw % compute previous multiple of \tabw
6740 \advance\dimen\verbbox by
\tabw % advance to next multiple of \tabw
6741 \wd\verbbox=
\dimen\verbbox \box\verbbox \starttabbox
6746 % start the verbatim environment.
6747 \def\setupverbatim{%
6748 \let\nonarrowing = t
%
6750 \tt % easiest (and conventionally used) font for verbatim
6751 % The \leavevmode here is for blank lines. Otherwise, we would
6752 % never \starttabox and the \egroup would end verbatim mode.
6753 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6755 \setupmarkupstyle{verbatim
}%
6756 % Respect line breaks,
6757 % print special symbols as themselves, and
6758 % make each space count.
6759 % Must do in this order:
6760 \obeylines \uncatcodespecials \sepspaces
6761 \everypar{\starttabbox}%
6764 % Do the @verb magic: verbatim text is quoted by unique
6765 % delimiter characters. Before first delimiter expect a
6766 % right brace, after last delimiter expect closing brace:
6768 % \def\doverb'{'<char>#1<char>'}'{#1}
6770 % [Knuth] p. 382; only eat outer {}
6772 \catcode`
[=
1\catcode`
]=
2\catcode`\
{=
\other\catcode`\
}=
\other
6773 \gdef\doverb{#1[\def\next#
#1#1}[#
#1\endgroup]\next]
6776 \def\verb{\begingroup\setupverb\doverb}
6779 % Do the @verbatim magic: define the macro \doverbatim so that
6780 % the (first) argument ends when '@end verbatim' is reached, ie:
6782 % \def\doverbatim#1@end verbatim{#1}
6784 % For Texinfo it's a lot easier than for LaTeX,
6785 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6786 % we need not redefine '\', '{' and '}'.
6788 % Inspired by LaTeX's verbatim command set [latex.ltx]
6793 % ignore everything up to the first ^^M, that's the newline at the end
6794 % of the @verbatim input line itself. Otherwise we get an extra blank
6795 % line in the output.
6796 \xdef\doverbatim#1^^M
#2@end verbatim
{#2\noexpand\end\gobble verbatim
}%
6797 % We really want {...\end verbatim} in the body of the macro, but
6798 % without the active space; thus we have to use \xdef and \gobble.
6802 \setupverbatim\doverbatim
6804 \let\Everbatim =
\afterenvbreak
6807 % @verbatiminclude FILE - insert text of file in verbatim environment.
6809 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6811 \def\doverbatiminclude#1{%
6813 \makevalueexpandable
6815 \indexnofonts % Allow `@@' and other weird things in file names.
6816 \wlog{texinfo.tex: doing @verbatiminclude of
#1^^J
}%
6822 % @copying ... @end copying.
6823 % Save the text away for @insertcopying later.
6825 % We save the uninterpreted tokens, rather than creating a box.
6826 % Saving the text in a box would be much easier, but then all the
6827 % typesetting commands (@smallbook, font changes, etc.) have to be done
6828 % beforehand -- and a) we want @copying to be done first in the source
6829 % file; b) letting users define the frontmatter in as flexible order as
6830 % possible is very desirable.
6832 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6833 \def\docopying#1@end copying
{\endgroup\def\copyingtext{#1}}
6835 \def\insertcopying{%
6837 \parindent =
0pt
% paragraph indentation looks wrong on title page
6838 \scanexp\copyingtext
6846 \newskip\defbodyindent \defbodyindent=
.4in
6847 \newskip\defargsindent \defargsindent=
50pt
6848 \newskip\deflastargmargin \deflastargmargin=
18pt
6849 \newcount\defunpenalty
6851 % Start the processing of @deffn:
6853 \ifnum\lastpenalty<
10000
6855 \defunpenalty=
10003 % Will keep this @deffn together with the
6856 % following @def command, see below.
6858 % If there are two @def commands in a row, we'll have a \nobreak,
6859 % which is there to keep the function description together with its
6860 % header. But if there's nothing but headers, we need to allow a
6861 % break somewhere. Check specifically for penalty 10002, inserted
6862 % by \printdefunline, instead of 10000, since the sectioning
6863 % commands also insert a nobreak penalty, and we don't want to allow
6864 % a break between a section heading and a defun.
6866 % As a further refinement, we avoid "club" headers by signalling
6867 % with penalty of 10003 after the very first @deffn in the
6868 % sequence (see above), and penalty of 10002 after any following
6870 \ifnum\lastpenalty=
10002 \penalty2000 \else \defunpenalty=
10002 \fi
6872 % Similarly, after a section heading, do not allow a break.
6873 % But do insert the glue.
6874 \medskip % preceded by discardable penalty, so not a breakpoint
6878 \advance\leftskip by
\defbodyindent
6879 \exdentamount=
\defbodyindent
6883 % First, check whether we are in the right environment:
6886 % As above, allow line break if we have multiple x headers in a row.
6887 % It's not a great place, though.
6888 \ifnum\lastpenalty=
10002 \penalty3000 \else \defunpenalty=
10002 \fi
6890 % And now, it's time to reuse the body of the original defun:
6891 \expandafter\gobbledefun#1%
6893 \def\gobbledefun#1\startdefun{}
6895 % \printdefunline \deffnheader{text}
6897 \def\printdefunline#1#2{%
6899 % call \deffnheader:
6902 \interlinepenalty =
10000
6903 \advance\rightskip by
0pt plus
1fil
\relax
6905 \nobreak\vskip -
\parskip
6906 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6907 % Some of the @defun-type tags do not enable magic parentheses,
6908 % rendering the following check redundant. But we don't optimize.
6913 \def\Edefun{\endgraf\medbreak}
6915 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6916 % the only thing remaining is to define \deffnheader.
6919 \expandafter\let\csname E
#1\endcsname =
\Edefun
6920 \edef\temp{\noexpand\domakedefun
6921 \makecsname{#1}\makecsname{#1x
}\makecsname{#1header
}}%
6925 % \domakedefun \deffn \deffnx \deffnheader
6927 % Define \deffn and \deffnx, without parameters.
6928 % \deffnheader has to be defined explicitly.
6930 \def\domakedefun#1#2#3{%
6933 \doingtypefnfalse % distinguish typed functions from all else
6934 \parseargusing\activeparens{\printdefunline#3}%
6936 \def#2{\dodefunx#1}%
6940 \newif\ifdoingtypefn % doing typed function?
6941 \newif\ifrettypeownline % typeset return type on its own line?
6943 % @deftypefnnewline on|off says whether the return type of typed functions
6944 % are printed on their own line. This affects @deftypefn, @deftypefun,
6945 % @deftypeop, and @deftypemethod.
6947 \parseargdef\deftypefnnewline{%
6950 \expandafter\let\csname SETtxideftypefnnl
\endcsname
6952 \else\ifx\temp\offword
6953 \expandafter\let\csname SETtxideftypefnnl
\endcsname
6956 \errhelp =
\EMsimple
6957 \errmessage{Unknown @txideftypefnnl value `
\temp',
6962 % Untyped functions:
6964 % @deffn category name args
6965 \makedefun{deffn
}{\deffngeneral{}}
6967 % @deffn category class name args
6968 \makedefun{defop
}#1 {\defopon{#1\
\putwordon}}
6970 % \defopon {category on}class name args
6971 \def\defopon#1#2 {\deffngeneral{\putwordon\
\code{#2}}{#1\
\code{#2}} }
6973 % \deffngeneral {subind}category name args
6975 \def\deffngeneral#1#2 #3 #4\endheader{%
6976 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6977 \dosubind{fn
}{\code{#3}}{#1}%
6978 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6983 % @deftypefn category type name args
6984 \makedefun{deftypefn
}{\deftypefngeneral{}}
6986 % @deftypeop category class type name args
6987 \makedefun{deftypeop
}#1 {\deftypeopon{#1\
\putwordon}}
6989 % \deftypeopon {category on}class type name args
6990 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\
\code{#2}}{#1\
\code{#2}} }
6992 % \deftypefngeneral {subind}category type name args
6994 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6995 \dosubind{fn
}{\code{#4}}{#1}%
6997 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7002 % @deftypevr category type var args
7003 \makedefun{deftypevr
}{\deftypecvgeneral{}}
7005 % @deftypecv category class type var args
7006 \makedefun{deftypecv
}#1 {\deftypecvof{#1\
\putwordof}}
7008 % \deftypecvof {category of}class type var args
7009 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\
\code{#2}}{#1\
\code{#2}} }
7011 % \deftypecvgeneral {subind}category type var args
7013 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
7014 \dosubind{vr
}{\code{#4}}{#1}%
7015 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7018 % Untyped variables:
7020 % @defvr category var args
7021 \makedefun{defvr
}#1 {\deftypevrheader{#1} {} }
7023 % @defcv category class var args
7024 \makedefun{defcv
}#1 {\defcvof{#1\
\putwordof}}
7026 % \defcvof {category of}class var args
7027 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
7031 % @deftp category name args
7032 \makedefun{deftp
}#1 #2 #3\endheader{%
7033 \doind{tp
}{\code{#2}}%
7034 \defname{#1}{}{#2}\defunargs{#3\unskip}%
7037 % Remaining @defun-like shortcuts:
7038 \makedefun{defun
}{\deffnheader{\putwordDeffunc} }
7039 \makedefun{defmac
}{\deffnheader{\putwordDefmac} }
7040 \makedefun{defspec
}{\deffnheader{\putwordDefspec} }
7041 \makedefun{deftypefun
}{\deftypefnheader{\putwordDeffunc} }
7042 \makedefun{defvar
}{\defvrheader{\putwordDefvar} }
7043 \makedefun{defopt
}{\defvrheader{\putwordDefopt} }
7044 \makedefun{deftypevar
}{\deftypevrheader{\putwordDefvar} }
7045 \makedefun{defmethod
}{\defopon\putwordMethodon}
7046 \makedefun{deftypemethod
}{\deftypeopon\putwordMethodon}
7047 \makedefun{defivar
}{\defcvof\putwordInstanceVariableof}
7048 \makedefun{deftypeivar
}{\deftypecvof\putwordInstanceVariableof}
7050 % \defname, which formats the name of the @def (not the args).
7051 % #1 is the category, such as "Function".
7052 % #2 is the return type, if any.
7053 % #3 is the function name.
7055 % We are followed by (but not passed) the arguments, if any.
7057 \def\defname#1#2#3{%
7059 % Get the values of \leftskip and \rightskip as they were outside the @def...
7060 \advance\leftskip by -
\defbodyindent
7062 % Determine if we are typesetting the return type of a typed function
7063 % on a line by itself.
7064 \rettypeownlinefalse
7065 \ifdoingtypefn % doing a typed function specifically?
7066 % then check user option for putting return type on its own line:
7067 \expandafter\ifx\csname SETtxideftypefnnl
\endcsname\relax \else
7072 % How we'll format the category name. Putting it in brackets helps
7073 % distinguish it from the body text that may end up on the next line
7076 \setbox0=
\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7078 % Figure out line sizes for the paragraph shape. We'll always have at
7082 % The first line needs space for \box0; but if \rightskip is nonzero,
7083 % we need only space for the part of \box0 which exceeds it:
7084 \dimen0=
\hsize \advance\dimen0 by -
\wd0 \advance\dimen0 by
\rightskip
7086 % If doing a return type on its own line, we'll have another line.
7088 \advance\tempnum by
1
7089 \def\maybeshapeline{0in
\hsize}%
7091 \def\maybeshapeline{}%
7094 % The continuations:
7095 \dimen2=
\hsize \advance\dimen2 by -
\defargsindent
7097 % The final paragraph shape:
7098 \parshape \tempnum 0in
\dimen0 \maybeshapeline \defargsindent \dimen2
7100 % Put the category name at the right margin.
7103 \hfil\box0 \kern-
\hsize
7104 % \hsize has to be shortened this way:
7106 % Intentionally do not respect \rightskip, since we need the space.
7109 % Allow all lines to be underfull without complaint:
7110 \tolerance=
10000 \hbadness=
10000
7111 \exdentamount=
\defbodyindent
7113 % defun fonts. We use typewriter by default (used to be bold) because:
7114 % . we're printing identifiers, they should be in tt in principle.
7115 % . in languages with many accents, such as Czech or French, it's
7116 % common to leave accents off identifiers. The result looks ok in
7117 % tt, but exceedingly strange in rm.
7118 % . we don't want -- and --- to be treated as ligatures.
7119 % . this still does not fix the ?` and !` ligatures, but so far no
7120 % one has made identifiers using them :).
7122 \def\temp{#2}% text of the return type
7123 \ifx\temp\empty\else
7124 \tclose{\temp}% typeset the return type
7126 % put return type on its own line; prohibit line break following:
7127 \hfil\vadjust{\nobreak}\break
7129 \space % type on same line, so just followed by a space
7131 \fi % no return type
7132 #3% output function name
7134 {\rm\enskip}% hskip 0.5 em of \tenrm
7137 % arguments will be output next, if any.
7140 % Print arguments in slanted roman (not ttsl), inconsistently with using
7141 % tt for the name. This is because literal text is sometimes needed in
7142 % the argument list (groff manual), and ttsl and tt are not very
7143 % distinguishable. Prevent hyphenation at `-' chars.
7146 % use sl by default (not ttsl),
7148 \df \sl \hyphenchar\font=
0
7150 % On the other hand, if an argument has two dashes (for instance), we
7151 % want a way to get ttsl. We used to recommend @var for that, so
7152 % leave the code in, but it's strange for @var to lead to typewriter.
7153 % Nowadays we recommend @code, since the difference between a ttsl hyphen
7154 % and a tt hyphen is pretty tiny. @code also disables ?` !`.
7155 \def\var#
#1{{\setupmarkupstyle{var
}\ttslanted{#
#1}}}%
7157 \sl\hyphenchar\font=
45
7160 % We want ()&[] to print specially on the defun line.
7163 \catcode`\(=
\active \catcode`\)=
\active
7164 \catcode`\
[=
\active \catcode`\
]=
\active
7168 % Make control sequences which act like normal parenthesis chars.
7169 \let\lparen = (
\let\rparen = )
7171 % Be sure that we always have a definition for `(', etc. For example,
7172 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7173 % so TeX would otherwise complain about undefined control sequence.
7176 \global\let(=
\lparen \global\let)=
\rparen
7177 \global\let[=
\lbrack \global\let]=
\rbrack
7180 \gdef\boldbrax{\let(=
\opnr\let)=
\clnr\let[=
\lbrb\let]=
\rbrb}
7181 \gdef\magicamp{\let&=
\amprm}
7184 \newcount\parencount
7186 % If we encounter &foo, then turn on ()-hacking afterwards
7188 \def\amprm#1 {\ampseentrue{\bf\&
#1 }}
7192 % At the first level, print parens in roman,
7193 % otherwise use the default font.
7194 \ifnum \parencount=
1 \rm \fi
7196 % The \sf parens (in \boldbrax) actually are a little bolder than
7197 % the contained text. This is especially needed for [ and ] .
7201 \def\infirstlevel#1{%
7208 \def\bfafterword#1 {#1 \bf}
7211 \global\advance\parencount by
1
7213 \infirstlevel \bfafterword
7218 \global\advance\parencount by -
1
7221 \newcount\brackcount
7223 \global\advance\brackcount by
1
7228 \global\advance\brackcount by -
1
7231 \def\checkparencounts{%
7232 \ifnum\parencount=
0 \else \badparencount \fi
7233 \ifnum\brackcount=
0 \else \badbrackcount \fi
7235 % these should not use \errmessage; the glibc manual, at least, actually
7236 % has such constructs (when documenting function pointers).
7237 \def\badparencount{%
7238 \message{Warning: unbalanced parentheses in @def...
}%
7239 \global\parencount=
0
7241 \def\badbrackcount{%
7242 \message{Warning: unbalanced square brackets in @def...
}%
7243 \global\brackcount=
0
7250 % To do this right we need a feature of e-TeX, \scantokens,
7251 % which we arrange to emulate with a temporary file in ordinary TeX.
7252 \ifx\eTeXversion\thisisundefined
7253 \newwrite\macscribble
7256 \immediate\openout\macscribble=
\jobname.tmp
7257 \immediate\write\macscribble{\the\toks0}%
7258 \immediate\closeout\macscribble
7263 \def\scanmacro#1{\begingroup
7265 \let\xeatspaces\eatspaces
7267 % Undo catcode changes of \startcontents and \doprintindex
7268 % When called from @insertcopying or (short)caption, we need active
7269 % backslash to get it printed correctly. Previously, we had
7270 % \catcode`\\=\other instead. We'll see whether a problem appears
7271 % with macro expansion. --kasal, 19aug04
7272 \catcode`\@=
0 \catcode`\\=
\active \escapechar=`\@
7274 % ... and for \example:
7277 % The \empty here causes a following catcode 5 newline to be eaten as
7278 % part of reading whitespace after a control sequence. It does not
7279 % eat a catcode 13 newline. There's no good way to handle the two
7280 % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
7281 % would then have different behavior). See the Macro Details node in
7282 % the manual for the workaround we recommend for macros and
7283 % line-oriented commands.
7285 \scantokens{#1\empty}%
7289 \edef\temp{\noexpand\scanmacro{#1}}%
7293 \newcount\paramno % Count of parameters
7294 \newtoks\macname % Macro name
7295 \newif\ifrecursive % Is it recursive?
7297 % List of all defined macros in the form
7298 % \definedummyword\macro1\definedummyword\macro2...
7299 % Currently is also contains all @aliases; the list can be split
7300 % if there is a need.
7303 % Add the macro to \macrolist
7304 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7305 \def\addtomacrolistxxx#1{%
7306 \toks0 =
\expandafter{\macrolist\definedummyword#1}%
7307 \xdef\macrolist{\the\toks0}%
7311 % This does \let #1 = #2, with \csnames; that is,
7312 % \let \csname#1\endcsname = \csname#2\endcsname
7313 % (except of course we have to play expansion games).
7317 \csname#1\expandafter\endcsname
7321 % Trim leading and trailing spaces off a string.
7322 % Concepts from aro-bend problem 15 (see CTAN).
7324 \gdef\eatspaces #1{\expandafter\trim@
\expandafter{#1 }}
7325 \gdef\trim@
#1{\trim@@ @
#1 @
#1 @ @@
}
7326 \gdef\trim@@
#1@
#2@
#3@@
{\trim@@@
\empty #2 @
}
7328 \unbrace{\gdef\trim@@@
#1 } #2@
{#1}
7331 % Trim a single trailing ^^M off a string.
7332 {\catcode`\^^M=
\other \catcode`
\Q=
3%
7333 \gdef\eatcr #1{\eatcra #1Q^^MQ
}%
7334 \gdef\eatcra#1^^MQ
{\eatcrb#1Q
}%
7335 \gdef\eatcrb#1Q
#2Q
{#1}%
7338 % Macro bodies are absorbed as an argument in a context where
7339 % all characters are catcode 10, 11 or 12, except \ which is active
7340 % (as in normal texinfo). It is necessary to change the definition of \
7341 % to recognize macro arguments; this is the job of \mbodybackslash.
7343 % Non-ASCII encodings make 8-bit characters active, so un-activate
7344 % them to avoid their expansion. Must do this non-globally, to
7345 % confine the change to the current group.
7347 % It's necessary to have hard CRs when the macro is executed. This is
7348 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7349 % body, and then making it the \newlinechar in \scanmacro.
7351 \def\scanctxt{% used as subroutine
7361 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7364 \def\scanargctxt{% used for copying and captions, not macros.
7367 \catcode`\^^M=
\other
7370 \def\macrobodyctxt{% used for @macro definitions
7374 \catcode`\^^M=
\other
7378 \def\macroargctxt{% used when scanning invocations
7382 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
7383 % for the single characters \ { }. Thus, we end up with the "commands"
7384 % that would be written @\ @{ @} in a Texinfo document.
7386 % We already have @{ and @}. For @\, we define it here, and only for
7387 % this purpose, to produce a typewriter backslash (so, the @\ that we
7388 % define for @math can't be used with @macro calls):
7390 \def\\
{\normalbackslash}%
7392 % We would like to do this for \, too, since that is what makeinfo does.
7393 % But it is not possible, because Texinfo already has a command @, for a
7394 % cedilla accent. Documents must use @comma{} instead.
7396 % \anythingelse will almost certainly be an error of some kind.
7399 % \mbodybackslash is the definition of \ in @macro bodies.
7400 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7401 % where N is the macro parameter number.
7402 % We define \csname macarg.\endcsname to be \realbackslash, so
7403 % \\ in macro replacement text gets you a backslash.
7405 {\catcode`@=
0 @catcode`@\=@active
7406 @gdef@usembodybackslash
{@let\=@mbodybackslash
}
7407 @gdef@mbodybackslash
#1\
{@csname macarg.
#1@endcsname
}
7409 \expandafter\def\csname macarg.
\endcsname{\realbackslash}
7411 \def\margbackslash#1{\char`\
#1 }
7413 \def\macro{\recursivefalse\parsearg\macroxxx}
7414 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7417 \getargs{#1}% now \macname is the macname and \argl the arglist
7418 \ifx\argl\empty % no arguments
7421 \expandafter\parsemargdef \argl;
%
7422 \if\paramno>
256\relax
7423 \ifx\eTeXversion\thisisundefined
7424 \errhelp =
\EMsimple
7425 \errmessage{You need eTeX to compile a file with macros with more than
256 arguments
}
7429 \if1\csname ismacro.
\the\macname\endcsname
7430 \message{Warning: redefining
\the\macname}%
7432 \expandafter\ifx\csname \the\macname\endcsname \relax
7433 \else \errmessage{Macro name
\the\macname\space already defined
}\fi
7434 \global\cslet{macsave.
\the\macname}{\the\macname}%
7435 \global\expandafter\let\csname ismacro.
\the\macname\endcsname=
1%
7436 \addtomacrolist{\the\macname}%
7438 \begingroup \macrobodyctxt
7439 \ifrecursive \expandafter\parsermacbody
7440 \else \expandafter\parsemacbody
7443 \parseargdef\unmacro{%
7444 \if1\csname ismacro.
#1\endcsname
7445 \global\cslet{#1}{macsave.
#1}%
7446 \global\expandafter\let \csname ismacro.
#1\endcsname=
0%
7447 % Remove the macro name from \macrolist:
7449 \expandafter\let\csname#1\endcsname \relax
7450 \let\definedummyword\unmacrodo
7451 \xdef\macrolist{\macrolist}%
7454 \errmessage{Macro
#1 not defined
}%
7458 % Called by \do from \dounmacro on each macro. The idea is to omit any
7459 % macro definitions that have been changed to \relax.
7465 \noexpand\definedummyword \noexpand#1%
7469 % This makes use of the obscure feature that if the last token of a
7470 % <parameter list> is #, then the preceding argument is delimited by
7471 % an opening brace, and that opening brace is not consumed.
7472 \def\getargs#1{\getargsxxx#1{}}
7473 \def\getargsxxx#1#
{\getmacname #1 \relax\getmacargs}
7474 \def\getmacname#1 #2\relax{\macname=
{#1}}
7475 \def\getmacargs#1{\def\argl{#1}}
7477 % For macro processing make @ a letter so that we can make Texinfo private macro names.
7478 \edef\texiatcatcode{\the\catcode`\@
}
7479 \catcode `@=
11\relax
7481 % Parse the optional {params} list. Set up \paramno and \paramlist
7482 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
7483 % in the params list to some hook where the argument si to be expanded. If
7484 % there are less than 10 arguments that hook is to be replaced by ##N where N
7485 % is the position in that list, that is to say the macro arguments are to be
7486 % defined `a la TeX in the macro body.
7488 % That gets used by \mbodybackslash (above).
7490 % We need to get `macro parameter char #' into several definitions.
7491 % The technique used is stolen from LaTeX: let \hash be something
7492 % unexpandable, insert that wherever you need a #, and then redefine
7493 % it to # just before using the token list produced.
7495 % The same technique is used to protect \eatspaces till just before
7496 % the macro is used.
7498 % If there are 10 or more arguments, a different technique is used, where the
7499 % hook remains in the body, and when macro is to be expanded the body is
7500 % processed again to replace the arguments.
7502 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7503 % argument N value and then \edef the body (nothing else will expand because of
7504 % the catcode regime underwhich the body was input).
7506 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7507 % arguments, you need that no macro has more than 256 arguments, otherwise an
7508 % error is produced.
7509 \def\parsemargdef#1;
{%
7510 \paramno=
0\def\paramlist{}%
7512 \let\xeatspaces\relax
7513 \parsemargdefxxx#1,;,
%
7514 % In case that there are 10 or more arguments we parse again the arguments
7515 % list to set new definitions for the \macarg.BLAH macros corresponding to
7516 % each BLAH argument. It was anyhow needed to parse already once this list
7517 % in order to count the arguments, and as macros with at most 9 arguments
7518 % are by far more frequent than macro with 10 or more arguments, defining
7519 % twice the \macarg.BLAH macros does not cost too much processing power.
7520 \ifnum\paramno<
10\relax\else
7522 \parsemmanyargdef@@
#1,;,
% 10 or more arguments
7525 \def\parsemargdefxxx#1,
{%
7526 \if#1;
\let\next=
\relax
7527 \else \let\next=
\parsemargdefxxx
7528 \advance\paramno by
1
7529 \expandafter\edef\csname macarg.
\eatspaces{#1}\endcsname
7530 {\xeatspaces{\hash\the\paramno}}%
7531 \edef\paramlist{\paramlist\hash\the\paramno,
}%
7534 \def\parsemmanyargdef@@
#1,
{%
7535 \if#1;
\let\next=
\relax
7537 \let\next=
\parsemmanyargdef@@
7538 \edef\tempb{\eatspaces{#1}}%
7539 \expandafter\def\expandafter\tempa
7540 \expandafter{\csname macarg.
\tempb\endcsname}%
7541 % Note that we need some extra \noexpand\noexpand, this is because we
7542 % don't want \the to be expanded in the \parsermacbody as it uses an
7544 \expandafter\edef\tempa
7545 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7546 \advance\paramno by
1\relax
7549 % These two commands read recursive and nonrecursive macro bodies.
7550 % (They're different since rec and nonrec macros end differently.)
7553 \catcode `\@
\texiatcatcode
7554 \long\def\parsemacbody#1@end macro
%
7555 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7556 \long\def\parsermacbody#1@end rmacro
%
7557 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7558 \catcode `\@=
11\relax
7563 \long\def\nillm@
{\nil@
}%
7565 % This macro is expanded during the Texinfo macro expansion, not during its
7566 % definition. It gets all the arguments values and assigns them to macros
7569 % #1 is the macro name
7570 % #2 is the list of argument names
7571 % #3 is the list of argument values
7572 \def\getargvals@
#1#2#3{%
7573 \def\macargdeflist@
{}%
7574 \def\saveparamlist@
{#2}% Need to keep a copy for parameter expansion.
7575 \def\paramlist{#2,
\nil@
}%
7579 \def\argvaluelist{#3,
\nil@
}%
7590 \ifx\paramlist\nilm@
7591 % Some sanity check needed here that \argvaluelist is also empty.
7592 \ifx\argvaluelist\nillm@
7594 \errhelp =
\EMsimple
7595 \errmessage{Too many arguments in macro `
\macroname'!
}%
7597 \let\next\macargexpandinbody@
7599 \ifx\argvaluelist\nillm@
7600 % No more arguments values passed to macro. Set remaining named-arg
7602 \let\next\setemptyargvalues@
7604 % pop current arg name into \@tempb
7605 \def\@tempa#
#1{\pop@
{\@tempb
}{\paramlist}#
#1\endargs@
}%
7606 \expandafter\@tempa
\expandafter{\paramlist}%
7607 % pop current argument value into \@tempc
7608 \def\@tempa#
#1{\longpop@
{\@tempc
}{\argvaluelist}#
#1\endargs@
}%
7609 \expandafter\@tempa
\expandafter{\argvaluelist}%
7610 % Here \@tempb is the current arg name and \@tempc is the current arg value.
7611 % First place the new argument macro definition into \@tempd
7612 \expandafter\macname\expandafter{\@tempc
}%
7613 \expandafter\let\csname macarg.\@tempb
\endcsname\relax
7614 \expandafter\def\expandafter\@tempe
\expandafter{%
7615 \csname macarg.\@tempb
\endcsname}%
7616 \edef\@tempd
{\long\def\@tempe
{\the\macname}}%
7617 \push@\@tempd
\macargdeflist@
7618 \let\next\getargvals@@
7625 \expandafter\expandafter\expandafter\def
7626 \expandafter\expandafter\expandafter#2%
7627 \expandafter\expandafter\expandafter{%
7631 % Replace arguments by their values in the macro body, and place the result
7633 \def\macvalstoargs@
{%
7634 % To do this we use the property that token registers that are \the'ed
7635 % within an \edef expand only once. So we are going to place all argument
7636 % values into respective token registers.
7638 % First we save the token context, and initialize argument numbering.
7641 % Then, for each argument number #N, we place the corresponding argument
7642 % value into a new token list register \toks#N
7643 \expandafter\putargsintokens@
\saveparamlist@,;,
%
7644 % Then, we expand the body so that argument are replaced by their
7645 % values. The trick for values not to be expanded themselves is that they
7646 % are within tokens and that tokens expand only once in an \edef .
7647 \edef\@tempc
{\csname mac.
\macroname .body
\endcsname}%
7648 % Now we restore the token stack pointer to free the token list registers
7649 % which we have used, but we make sure that expanded body is saved after
7653 \expandafter\def\expandafter\@tempa
\expandafter{\@tempc
}%
7656 \def\macargexpandinbody@
{%
7657 %% Define the named-macro outside of this group and then close this group.
7661 % First the replace in body the macro arguments by their values, the result
7664 % Then we point at the \norecurse or \gobble (for recursive) macro value
7666 \expandafter\let\expandafter\@tempb
\csname mac.
\macroname .recurse
\endcsname
7667 % Depending on whether it is recursive or not, we need some tailing
7674 % And now we do the real job:
7675 \edef\@tempd
{\noexpand\@tempb
{\macroname}\noexpand\scanmacro{\@tempa
}\@tempc
}%
7679 \def\putargsintokens@
#1,
{%
7680 \if#1;
\let\next\relax
7682 \let\next\putargsintokens@
7683 % First we allocate the new token list register, and give it a temporary
7685 \toksdef\@tempb
\the\paramno
7686 % Then we place the argument value into that token list register.
7687 \expandafter\let\expandafter\@tempa
\csname macarg.
#1\endcsname
7688 \expandafter\@tempb
\expandafter{\@tempa
}%
7689 \advance\paramno by
1\relax
7694 % Save the token stack pointer into macro #1
7695 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi
}}
7696 % Restore the token stack pointer from number in macro #1
7697 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi
#1\relax}
7698 % newtoks that can be used non \outer .
7699 \def\texinonouternewtoks{\alloc@
5\toks \toksdef \@cclvi
}
7701 % Tailing missing arguments are set to empty
7702 \def\setemptyargvalues@
{%
7703 \ifx\paramlist\nilm@
7704 \let\next\macargexpandinbody@
7706 \expandafter\setemptyargvaluesparser@
\paramlist\endargs@
7707 \let\next\setemptyargvalues@
7712 \def\setemptyargvaluesparser@
#1,
#2\endargs@
{%
7713 \expandafter\def\expandafter\@tempa
\expandafter{%
7714 \expandafter\def\csname macarg.
#1\endcsname{}}%
7715 \push@\@tempa
\macargdeflist@
7719 % #1 is the element target macro
7720 % #2 is the list macro
7721 % #3,#4\endargs@ is the list value
7722 \def\pop@
#1#2#3,
#4\endargs@
{%
7726 \long\def\longpop@
#1#2#3,
#4\endargs@
{%
7731 % This defines a Texinfo @macro. There are eight cases: recursive and
7732 % nonrecursive macros of zero, one, up to nine, and many arguments.
7733 % Much magic with \expandafter here.
7734 % \xdef is used so that macro definitions will survive the file
7735 % they're defined in; @include reads the file inside a group.
7738 \let\hash=##
% convert placeholders to macro parameter chars
7742 \expandafter\xdef\csname\the\macname\endcsname{%
7743 \noexpand\scanmacro{\temp}}%
7745 \expandafter\xdef\csname\the\macname\endcsname{%
7746 \bgroup\noexpand\macroargctxt
7747 \noexpand\braceorline
7748 \expandafter\noexpand\csname\the\macname xxx
\endcsname}%
7749 \expandafter\xdef\csname\the\macname xxx
\endcsname#
#1{%
7750 \egroup\noexpand\scanmacro{\temp}}%
7752 \ifnum\paramno<
10\relax % at most 9
7753 \expandafter\xdef\csname\the\macname\endcsname{%
7754 \bgroup\noexpand\macroargctxt
7755 \noexpand\csname\the\macname xx
\endcsname}%
7756 \expandafter\xdef\csname\the\macname xx
\endcsname#
#1{%
7757 \expandafter\noexpand\csname\the\macname xxx
\endcsname #
#1,
}%
7758 \expandafter\expandafter
7760 \expandafter\expandafter
7761 \csname\the\macname xxx
\endcsname
7762 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7764 \expandafter\xdef\csname\the\macname\endcsname{%
7765 \noexpand\getargvals@
{\the\macname}{\argl}%
7767 \global\expandafter\let\csname mac.
\the\macname .body
\endcsname\temp
7768 \global\expandafter\let\csname mac.
\the\macname .recurse
\endcsname\gobble
7774 \expandafter\xdef\csname\the\macname\endcsname{%
7775 \noexpand\norecurse{\the\macname}%
7776 \noexpand\scanmacro{\temp}\egroup}%
7778 \expandafter\xdef\csname\the\macname\endcsname{%
7779 \bgroup\noexpand\macroargctxt
7780 \noexpand\braceorline
7781 \expandafter\noexpand\csname\the\macname xxx
\endcsname}%
7782 \expandafter\xdef\csname\the\macname xxx
\endcsname#
#1{%
7784 \noexpand\norecurse{\the\macname}%
7785 \noexpand\scanmacro{\temp}\egroup}%
7787 \ifnum\paramno<
10\relax
7788 \expandafter\xdef\csname\the\macname\endcsname{%
7789 \bgroup\noexpand\macroargctxt
7790 \expandafter\noexpand\csname\the\macname xx
\endcsname}%
7791 \expandafter\xdef\csname\the\macname xx
\endcsname#
#1{%
7792 \expandafter\noexpand\csname\the\macname xxx
\endcsname #
#1,
}%
7793 \expandafter\expandafter
7795 \expandafter\expandafter
7796 \csname\the\macname xxx
\endcsname
7799 \noexpand\norecurse{\the\macname}%
7800 \noexpand\scanmacro{\temp}\egroup}%
7802 \expandafter\xdef\csname\the\macname\endcsname{%
7803 \noexpand\getargvals@
{\the\macname}{\argl}%
7805 \global\expandafter\let\csname mac.
\the\macname .body
\endcsname\temp
7806 \global\expandafter\let\csname mac.
\the\macname .recurse
\endcsname\norecurse
7811 \catcode `\@
\texiatcatcode\relax
7813 \def\norecurse#1{\bgroup\cslet{#1}{macsave.
#1}}
7815 % \braceorline decides whether the next nonwhitespace character is a
7816 % {. If so it reads up to the closing }, if not, it reads the whole
7817 % line. Whatever was read is then fed to the next control sequence
7818 % as an argument (by \parsebrace or \parsearg).
7820 \def\braceorline#1{\let\macnamexxx=
#1\futurelet\nchar\braceorlinexxx}
7821 \def\braceorlinexxx{%
7822 \ifx\nchar\bgroup\else
7823 \expandafter\parsearg
7828 % We need some trickery to remove the optional spaces around the equal
7829 % sign. Make them active and then expand them all to nothing.
7831 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7832 \def\aliasxxx #1{\aliasyyy#1\relax}
7833 \def\aliasyyy #1=
#2\relax{%
7835 \expandafter\let\obeyedspace=
\empty
7836 \addtomacrolist{#1}%
7837 \xdef\next{\global\let\makecsname{#1}=
\makecsname{#2}}%
7843 \message{cross references,
}
7846 \newif\ifhavexrefs % True if xref values are known.
7847 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7849 % @inforef is relatively simple.
7850 \def\inforef #1{\inforefzzz #1,,,,**
}
7851 \def\inforefzzz #1,
#2,
#3,
#4**
{%
7852 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7853 node
\samp{\ignorespaces#1{}}}
7855 % @node's only job in TeX is to define \lastnode, which is used in
7856 % cross-references. The @node line might or might not have commas, and
7857 % might or might not have spaces before the first comma, like:
7858 % @node foo , bar , ...
7859 % We don't want such trailing spaces in the node name.
7861 \parseargdef\node{\checkenv{}\donode #1 ,
\finishnodeparse}
7863 % also remove a trailing comma, in case of something like this:
7864 % @node Help-Cross, , , Cross-refs
7865 \def\donode#1 ,
#2\finishnodeparse{\dodonode #1,
\finishnodeparse}
7866 \def\dodonode#1,
#2\finishnodeparse{\gdef\lastnode{#1}}
7869 \let\lastnode=
\empty
7871 % Write a cross-reference definition for the current node. #1 is the
7872 % type (Ynumbered, Yappendix, Ynothing).
7875 \ifx\lastnode\empty\else
7876 \setref{\lastnode}{#1}%
7877 \global\let\lastnode=
\empty
7881 % @anchor{NAME} -- define xref target at arbitrary point.
7883 \newcount\savesfregister
7885 \def\savesf{\relax \ifhmode \savesfregister=
\spacefactor \fi}
7886 \def\restoresf{\relax \ifhmode \spacefactor=
\savesfregister \fi}
7887 \def\anchor#1{\savesf \setref{#1}{Ynothing
}\restoresf \ignorespaces}
7889 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7890 % anchor), which consists of three parts:
7891 % 1) NAME-title - the current sectioning name taken from \lastsection,
7892 % or the anchor name.
7893 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7894 % empty for anchors.
7895 % 3) NAME-pg - the page number.
7897 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7898 % floats, there is an additional part, which is not written here:
7899 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7905 \atdummies % preserve commands, but don't expand them
7906 \edef\writexrdef#
#1#
#2{%
7907 \write\auxfile{@xrdef
{#1-
% #1 of \setref, expanded by the \edef
7908 #
#1}{#
#2}}% these are parameters of \writexrdef
7910 \toks0 =
\expandafter{\lastsection}%
7911 \immediate \writexrdef{title
}{\the\toks0 }%
7912 \immediate \writexrdef{snt
}{\csname #2\endcsname}% \Ynumbered etc.
7913 \safewhatsit{\writexrdef{pg
}{\folio}}% will be written later, at \shipout
7918 % @xrefautosectiontitle on|off says whether @section(ing) names are used
7919 % automatically in xrefs, if the third arg is not explicitly specified.
7920 % This was provided as a "secret" @set xref-automatic-section-title
7921 % variable, now it's official.
7923 \parseargdef\xrefautomaticsectiontitle{%
7926 \expandafter\let\csname SETxref-automatic-section-title
\endcsname
7928 \else\ifx\temp\offword
7929 \expandafter\let\csname SETxref-automatic-section-title
\endcsname
7932 \errhelp =
\EMsimple
7933 \errmessage{Unknown @xrefautomaticsectiontitle value `
\temp',
7939 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7940 % the node name, #2 the name of the Info cross-reference, #3 the printed
7941 % node name, #4 the name of the Info file, #5 the name of the printed
7942 % manual. All but the node name can be omitted.
7944 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,
]}
7945 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,
]}
7946 \def\ref#1{\xrefX[#1,,,,,,,
]}
7949 \newbox\printedrefnamebox
7950 \newbox\infofilenamebox
7951 \newbox\printedmanualbox
7953 \def\xrefX[#1,
#2,
#3,
#4,
#5,
#6]{\begingroup
7956 % Get args without leading/trailing spaces.
7957 \def\printedrefname{\ignorespaces #3}%
7958 \setbox\printedrefnamebox =
\hbox{\printedrefname\unskip}%
7960 \def\infofilename{\ignorespaces #4}%
7961 \setbox\infofilenamebox =
\hbox{\infofilename\unskip}%
7963 \def\printedmanual{\ignorespaces #5}%
7964 \setbox\printedmanualbox =
\hbox{\printedmanual\unskip}%
7966 % If the printed reference name (arg #3) was not explicitly given in
7967 % the @xref, figure out what we want to use.
7968 \ifdim \wd\printedrefnamebox =
0pt
7969 % No printed node name was explicitly given.
7970 \expandafter\ifx\csname SETxref-automatic-section-title
\endcsname \relax
7971 % Not auto section-title: use node name inside the square brackets.
7972 \def\printedrefname{\ignorespaces #1}%
7974 % Auto section-title: use chapter/section title inside
7975 % the square brackets if we have it.
7976 \ifdim \wd\printedmanualbox >
0pt
7977 % It is in another manual, so we don't have it; use node name.
7978 \def\printedrefname{\ignorespaces #1}%
7981 % We (should) know the real title if we have the xref values.
7982 \def\printedrefname{\refx{#1-title
}{}}%
7984 % Otherwise just copy the Info node name.
7985 \def\printedrefname{\ignorespaces #1}%
7991 % Make link in pdf output.
7995 \makevalueexpandable
7996 % This expands tokens, so do it after making catcode changes, so _
7997 % etc. don't get their TeX definitions. This ignores all spaces in
7998 % #4, including (wrongly) those in the middle of the filename.
8001 % This (wrongly) does not take account of leading or trailing
8002 % spaces in #1, which should be ignored.
8003 \edef\pdfxrefdest{#1}%
8004 \ifx\pdfxrefdest\empty
8005 \def\pdfxrefdest{Top
}% no empty targets
8007 \txiescapepdf\pdfxrefdest % escape PDF special chars
8011 \startlink attr
{/Border
[0 0 0]}%
8012 \ifnum\filenamelength>
0
8013 goto file
{\the\filename.pdf
} name
{\pdfxrefdest}%
8015 goto name
{\pdfmkpgn{\pdfxrefdest}}%
8018 \setcolor{\linkcolor}%
8021 % Float references are printed completely differently: "Figure 1.2"
8022 % instead of "[somenode], p.3". We distinguish them by the
8023 % LABEL-title being set to a magic string.
8025 % Have to otherify everything special to allow the \csname to
8026 % include an _ in the xref name, etc.
8029 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
8030 \csname XR
#1-title
\endcsname
8032 \iffloat\Xthisreftitle
8033 % If the user specified the print name (third arg) to the ref,
8034 % print it instead of our usual "Figure 1.2".
8035 \ifdim\wd\printedrefnamebox =
0pt
8041 % If the user also gave the printed manual name (fifth arg), append
8043 \ifdim \wd\printedmanualbox >
0pt
8044 \space \putwordin{} \cite{\printedmanual}%
8047 % node/anchor (non-float) references.
8049 % If we use \unhbox to print the node names, TeX does not insert
8050 % empty discretionaries after hyphens, which means that it will not
8051 % find a line break at a hyphen in a node names. Since some manuals
8052 % are best written with fairly long node names, containing hyphens,
8053 % this is a loss. Therefore, we give the text of the node name
8054 % again, so it is as if TeX is seeing it for the first time.
8056 \ifdim \wd\printedmanualbox >
0pt
8057 % Cross-manual reference with a printed manual name.
8059 \crossmanualxref{\cite{\printedmanual\unskip}}%
8061 \else\ifdim \wd\infofilenamebox >
0pt
8062 % Cross-manual reference with only an info filename (arg 4), no
8063 % printed manual name (arg 5). This is essentially the same as
8064 % the case above; we output the filename, since we have nothing else.
8066 \crossmanualxref{\code{\infofilename\unskip}}%
8069 % Reference within this manual.
8071 % _ (for example) has to be the character _ for the purposes of the
8072 % control sequence corresponding to the node, but it has to expand
8073 % into the usual \leavevmode...\vrule stuff for purposes of
8074 % printing. So we \turnoffactive for the \refx-snt, back on for the
8075 % printing, back off for the \refx-pg.
8077 % Only output a following space if the -snt ref is nonempty; for
8078 % @unnumbered and @anchor, it won't be.
8079 \setbox2 =
\hbox{\ignorespaces \refx{#1-snt
}{}}%
8080 \ifdim \wd2 >
0pt
\refx{#1-snt
}\space\fi
8082 % output the `[mynode]' via the macro below so it can be overridden.
8083 \xrefprintnodename\printedrefname
8085 % But we always want a comma and a space:
8088 % output the `page 3'.
8089 \turnoffactive \putwordpage\tie\refx{#1-pg
}{}%
8095 % Output a cross-manual xref to #1. Used just above (twice).
8097 % Only include the text "Section ``foo'' in" if the foo is neither
8098 % missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply
8099 % "see The Foo Manual", the idea being to refer to the whole manual.
8101 % But, this being TeX, we can't easily compare our node name against the
8102 % string "Top" while ignoring the possible spaces before and after in
8103 % the input. By adding the arbitrary 7sp below, we make it much less
8104 % likely that a real node name would have the same width as "Top" (e.g.,
8105 % in a monospaced font). Hopefully it will never happen in practice.
8107 % For the same basic reason, we retypeset the "Top" at every
8108 % reference, since the current font is indeterminate.
8110 \def\crossmanualxref#1{%
8111 \setbox\toprefbox =
\hbox{Top
\kern7sp}%
8112 \setbox2 =
\hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8113 \ifdim \wd2 >
7sp
% nonempty?
8114 \ifdim \wd2 =
\wd\toprefbox \else % same as Top?
8115 \putwordSection{} ``
\printedrefname''
\putwordin{}\space
8121 % This macro is called from \xrefX for the `[nodename]' part of xref
8122 % output. It's a separate macro only so it can be changed more easily,
8123 % since square brackets don't work well in some documents. Particularly
8124 % one that Bob is working on :).
8126 \def\xrefprintnodename#1{[#1]}
8128 % Things referred to by \setref.
8134 \putwordChapter@tie
\the\chapno
8135 \else \ifnum\subsecno=
0
8136 \putwordSection@tie
\the\chapno.
\the\secno
8137 \else \ifnum\subsubsecno=
0
8138 \putwordSection@tie
\the\chapno.
\the\secno.
\the\subsecno
8140 \putwordSection@tie
\the\chapno.
\the\secno.
\the\subsecno.
\the\subsubsecno
8145 \putwordAppendix@tie @char
\the\appendixno{}%
8146 \else \ifnum\subsecno=
0
8147 \putwordSection@tie @char
\the\appendixno.
\the\secno
8148 \else \ifnum\subsubsecno=
0
8149 \putwordSection@tie @char
\the\appendixno.
\the\secno.
\the\subsecno
8152 @char
\the\appendixno.
\the\secno.
\the\subsecno.
\the\subsubsecno
8156 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
8157 % If its value is nonempty, SUFFIX is output afterward.
8163 \expandafter\global\expandafter\let\expandafter\thisrefX
8164 \csname XR
#1\endcsname
8167 % If not defined, say something at least.
8168 \angleleft un\-de\-fined
\angleright
8171 {\toks0 =
{#1}% avoid expansion of possibly-complex value
8172 \message{\linenumber Undefined cross reference `
\the\toks0'.
}}%
8175 \global\warnedxrefstrue
8176 \message{Cross reference values unknown; you must run TeX again.
}%
8181 % It's defined, so just use it.
8184 #2% Output the suffix in any case.
8187 % This is the macro invoked by entries in the aux file. Usually it's
8188 % just a \def (we prepend XR to the control sequence name to avoid
8189 % collisions). But if this is a float type, we have more work to do.
8192 {% The node name might contain 8-bit characters, which in our current
8193 % implementation are changed to commands like @'e. Don't let these
8194 % mess up the control sequence name.
8197 \xdef\safexrefname{#1}%
8200 \expandafter\gdef\csname XR
\safexrefname\endcsname{#2}% remember this xref
8202 % Was that xref control sequence that we just defined for a float?
8203 \expandafter\iffloat\csname XR
\safexrefname\endcsname
8204 % it was a float, and we have the (safe) float type in \iffloattype.
8205 \expandafter\let\expandafter\floatlist
8206 \csname floatlist
\iffloattype\endcsname
8208 % Is this the first time we've seen this float type?
8209 \expandafter\ifx\floatlist\relax
8210 \toks0 =
{\do}% yes, so just \do
8212 % had it before, so preserve previous elements in list.
8213 \toks0 =
\expandafter{\floatlist\do}%
8216 % Remember this xref in the control sequence \floatlistFLOATTYPE,
8217 % for later use in \listoffloats.
8218 \expandafter\xdef\csname floatlist
\iffloattype\endcsname{\the\toks0
8223 % Read the last existing aux file, if any. No error if none exists.
8226 \openin 1 \jobname.aux
8229 \global\havexrefstrue
8234 \def\setupdatafile{%
8235 \catcode`\^^@=
\other
8236 \catcode`\^^A=
\other
8237 \catcode`\^^B=
\other
8238 \catcode`\^^C=
\other
8239 \catcode`\^^D=
\other
8240 \catcode`\^^E=
\other
8241 \catcode`\^^F=
\other
8242 \catcode`\^^G=
\other
8243 \catcode`\^^H=
\other
8244 \catcode`\^^K=
\other
8245 \catcode`\^^L=
\other
8246 \catcode`\^^N=
\other
8247 \catcode`\^^P=
\other
8248 \catcode`\^^Q=
\other
8249 \catcode`\^^R=
\other
8250 \catcode`\^^S=
\other
8251 \catcode`\^^T=
\other
8252 \catcode`\^^U=
\other
8253 \catcode`\^^V=
\other
8254 \catcode`\^^W=
\other
8255 \catcode`\^^X=
\other
8256 \catcode`\^^Z=
\other
8257 \catcode`\^^
[=
\other
8258 \catcode`\^^\=
\other
8259 \catcode`\^^
]=
\other
8260 \catcode`\^^^=
\other
8261 \catcode`\^^_=
\other
8262 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8263 % in xref tags, i.e., node names. But since ^^e4 notation isn't
8264 % supported in the main text, it doesn't seem desirable. Furthermore,
8265 % that is not enough: for node names that actually contain a ^
8266 % character, we would end up writing a line like this: 'xrdef {'hat
8267 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8268 % argument, and \hat is not an expandable control sequence. It could
8269 % all be worked out, but why? Either we support ^^ or we don't.
8271 % The other change necessary for this was to define \auxhat:
8272 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8273 % and then to call \auxhat in \setq.
8277 % Special characters. Should be turned off anyway, but...
8290 \catcode`+=
\other % avoid \+ for paranoia even though we've turned it off
8292 % This is to support \ in node names and titles, since the \
8293 % characters end up in a \csname. It's easier than
8294 % leaving it active and making its active definition an actual \
8295 % character. What I don't understand is why it works in the *value*
8296 % of the xrdef. Seems like it should be a catcode12 \, and that
8297 % should not typeset properly. But it works, so I'm moving on for
8298 % now. --karl, 15jan04.
8301 % Make the characters 128-255 be printing characters.
8305 \catcode\count1=
\other
8306 \advance\count1 by
1
8307 \ifnum \count1<
256 \loop \fi
8311 % @ is our escape character in .aux files, and we need braces.
8317 \def\readdatafile#1{%
8324 \message{insertions,
}
8325 % including footnotes.
8327 \newcount \footnoteno
8329 % The trailing space in the following definition for supereject is
8330 % vital for proper filling; pages come out unaligned when you do a
8331 % pagealignmacro call if that space before the closing brace is
8332 % removed. (Generally, numeric constants should always be followed by a
8333 % space to prevent strange expansion errors.)
8334 \def\supereject{\par\penalty -
20000\footnoteno =
0 }
8336 % @footnotestyle is meaningful for Info output only.
8337 \let\footnotestyle=
\comment
8341 % Auto-number footnotes. Otherwise like plain.
8343 \let\indent=
\ptexindent
8344 \let\noindent=
\ptexnoindent
8345 \global\advance\footnoteno by \@ne
8346 \edef\thisfootno{$^
{\the\footnoteno}$
}%
8348 % In case the footnote comes at the end of a sentence, preserve the
8349 % extra spacing after we do the footnote number.
8351 \ifhmode\edef\@sf
{\spacefactor\the\spacefactor}\ptexslash\fi
8353 % Remove inadvertent blank space before typesetting the footnote number.
8359 % Don't bother with the trickery in plain.tex to not require the
8360 % footnote text as a parameter. Our footnotes don't need to be so general.
8362 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8363 % \parseargline) fails inside footnotes because the tokens are fixed when
8364 % the footnote is read. --karl, 16nov96.
8367 \insert\footins\bgroup
8368 % We want to typeset this text as a normal paragraph, even if the
8369 % footnote reference occurs in (for example) a display environment.
8370 % So reset some parameters.
8372 \interlinepenalty\interfootnotelinepenalty
8373 \splittopskip\ht\strutbox % top baseline for broken footnotes
8374 \splitmaxdepth\dp\strutbox
8375 \floatingpenalty\@MM
8380 \parindent\defaultparindent
8384 % Because we use hanging indentation in footnotes, a @noindent appears
8385 % to exdent this text, so make it be a no-op. makeinfo does not use
8386 % hanging indentation so @noindent can still be needed within footnote
8387 % text after an @example or the like (not that this is good style).
8388 \let\noindent =
\relax
8390 % Hang the footnote text off the number. Use \everypar in case the
8391 % footnote extends for more than one paragraph.
8392 \everypar =
{\hang}%
8393 \textindent{\thisfootno}%
8395 % Don't crash into the line above the footnote text. Since this
8396 % expands into a box, it must come within the paragraph, lest it
8397 % provide a place where TeX can split the footnote.
8400 % Invoke rest of plain TeX footnote routine.
8401 \futurelet\next\fo@t
8403 }%end \catcode `\@=11
8405 % In case a @footnote appears in a vbox, save the footnote text and create
8406 % the real \insert just after the vbox finished. Otherwise, the insertion
8408 % Similarly, if a @footnote appears inside an alignment, save the footnote
8409 % text to a box and make the \insert when a row of the table is finished.
8410 % And the same can be done for other insert classes. --kasal, 16nov03.
8412 % Replace the \insert primitive by a cheating macro.
8413 % Deeper inside, just make sure that the saved insertions are not spilled
8416 \def\startsavinginserts{%
8417 \ifx \insert\ptexinsert
8418 \let\insert\saveinsert
8420 \let\checkinserts\relax
8424 % This \insert replacement works for both \insert\footins{foo} and
8425 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8428 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8429 \afterassignment\next
8430 % swallow the left brace
8433 \def\makeSAVEname#1{\makecsname{SAVE
\expandafter\gobble\string#1}}
8434 \def\savetobox#1{\global\setbox#1 =
\vbox\bgroup \unvbox#1}
8436 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8438 \def\placesaveins#1{%
8439 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8443 % eat @SAVE -- beware, all of them have catcode \other:
8445 \def\dospecials{\do S
\do A
\do V
\do E
} \uncatcodespecials % ;-)
8446 \gdef\gobblesave @SAVE
{}
8450 \def\newsaveins #1{%
8451 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8454 \def\newsaveinsX #1{%
8455 \csname newbox
\endcsname #1%
8456 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8461 \let\checkinserts\empty
8466 % @image. We use the macros from epsf.tex to support this.
8467 % If epsf.tex is not installed and @image is used, we complain.
8469 % Check for and read epsf.tex up front. If we read it only at @image
8470 % time, we might be inside a group, and then its definitions would get
8471 % undone and the next image would fail.
8472 \openin 1 = epsf.tex
8474 % Do not bother showing banner with epsf.tex v2.7k (available in
8475 % doc/epsf.tex and on ctan).
8476 \def\epsfannounce{\toks0 =
}%
8481 % We will only complain once about lack of epsf.tex.
8482 \newif\ifwarnednoepsf
8483 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8484 work. It is also included in the Texinfo distribution, or you can get
8485 it from ftp://tug.org/tex/epsf.tex.
}
8488 \ifx\epsfbox\thisisundefined
8489 \ifwarnednoepsf \else
8490 \errhelp =
\noepsfhelp
8491 \errmessage{epsf.tex not found, images will be ignored
}%
8492 \global\warnednoepsftrue
8495 \imagexxx #1,,,,,
\finish
8499 % Arguments to @image:
8500 % #1 is (mandatory) image filename; we tack on .eps extension.
8501 % #2 is (optional) width, #3 is (optional) height.
8502 % #4 is (ignored optional) html alt text.
8503 % #5 is (ignored optional) extension.
8504 % #6 is just the usual extra ignored arg for parsing stuff.
8506 \def\imagexxx#1,
#2,
#3,
#4,
#5,
#6\finish{\begingroup
8507 \catcode`\^^M =
5 % in case we're inside an example
8508 \normalturnoffactive % allow _ et al. in names
8509 % If the image is by itself, center it.
8512 \else \ifx\centersub\centerV
8513 % for @center @image, we need a vbox so we can have our vertical space
8515 \vbox\bgroup % vbox has better behavior than vtop herev
8520 % Usually we'll have text after the image which will insert
8521 % \parskip glue, so insert it here too to equalize the space
8523 \nobreak\vskip\parskip
8527 % Leave vertical mode so that indentation from an enclosing
8528 % environment such as @quotation is respected.
8529 % However, if we're at the top level, we don't want the
8530 % normal paragraph indentation.
8531 % On the other hand, if we are in the case of @center @image, we don't
8532 % want to start a paragraph, which will create a hsize-width box and
8533 % eradicate the centering.
8534 \ifx\centersub\centerV\else \noindent \fi
8538 \dopdfimage{#1}{#2}{#3}%
8540 % \epsfbox itself resets \epsf?size at each figure.
8541 \setbox0 =
\hbox{\ignorespaces #2}\ifdim\wd0 >
0pt
\epsfxsize=
#2\relax \fi
8542 \setbox0 =
\hbox{\ignorespaces #3}\ifdim\wd0 >
0pt
\epsfysize=
#3\relax \fi
8547 \medskip % space after a standalone image
8549 \ifx\centersub\centerV \egroup \fi
8553 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8554 % etc. We don't actually implement floating yet, we always include the
8555 % float "here". But it seemed the best name for the future.
8557 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,
\finish}
8559 % There may be a space before second and/or third parameter; delete it.
8560 \def\eatcommaspace#1,
{#1,
}
8562 % #1 is the optional FLOATTYPE, the text label for this float, typically
8563 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
8564 % this float will not be numbered and cannot be referred to.
8566 % #2 is the optional xref label. Also must be present for the float to
8569 % #3 is the optional positioning argument; for now, it is ignored. It
8570 % will somehow specify the positions allowed to float to (here, top, bottom).
8572 % We keep a separate counter for each FLOATTYPE, which we reset at each
8573 % chapter-level command.
8574 \let\resetallfloatnos=
\empty
8576 \def\dofloat#1,
#2,
#3,
#4\finish{%
8577 \let\thiscaption=
\empty
8578 \let\thisshortcaption=
\empty
8580 % don't lose footnotes inside @float.
8582 % BEWARE: when the floats start float, we have to issue warning whenever an
8583 % insert appears inside a float which could possibly float. --kasal, 26may04
8587 % We can't be used inside a paragraph.
8592 \def\floatlabel{#2}%
8593 \def\floatloc{#3}% we do nothing with this yet.
8595 \ifx\floattype\empty
8596 \let\safefloattype=
\empty
8599 % the floattype might have accents or other special characters,
8600 % but we need to use it in a control sequence name.
8603 \xdef\safefloattype{\floattype}%
8607 % If label is given but no type, we handle that as the empty type.
8608 \ifx\floatlabel\empty \else
8609 % We want each FLOATTYPE to be numbered separately (Figure 1,
8610 % Table 1, Figure 2, ...). (And if no label, no number.)
8612 \expandafter\getfloatno\csname\safefloattype floatno
\endcsname
8613 \global\advance\floatno by
1
8616 % This magic value for \lastsection is output by \setref as the
8617 % XREFLABEL-title value. \xrefX uses it to distinguish float
8618 % labels (which have a completely different output format) from
8619 % node and anchor labels. And \xrdef uses it to construct the
8622 \edef\lastsection{\floatmagic=
\safefloattype}%
8623 \setref{\floatlabel}{Yfloat
}%
8627 % start with \parskip glue, I guess.
8630 % Don't suppress indentation if a float happens to start a section.
8631 \restorefirstparagraphindent
8634 % we have these possibilities:
8635 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8636 % @float Foo,lbl & no caption: Foo 1.1
8637 % @float Foo & @caption{Cap}: Foo: Cap
8638 % @float Foo & no caption: Foo
8639 % @float ,lbl & Caption{Cap}: 1.1: Cap
8640 % @float ,lbl & no caption: 1.1
8641 % @float & @caption{Cap}: Cap
8642 % @float & no caption:
8645 \let\floatident =
\empty
8647 % In all cases, if we have a float type, it comes first.
8648 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8650 % If we have an xref label, the number comes next.
8651 \ifx\floatlabel\empty \else
8652 \ifx\floattype\empty \else % if also had float type, need tie first.
8653 \appendtomacro\floatident{\tie}%
8656 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8659 % Start the printed caption with what we've constructed in
8660 % \floatident, but keep it separate; we need \floatident again.
8661 \let\captionline =
\floatident
8663 \ifx\thiscaption\empty \else
8664 \ifx\floatident\empty \else
8665 \appendtomacro\captionline{:
}% had ident, so need a colon between
8669 \appendtomacro\captionline{\scanexp\thiscaption}%
8672 % If we have anything to print, print it, with space before.
8673 % Eventually this needs to become an \insert.
8674 \ifx\captionline\empty \else
8678 % Space below caption.
8682 % If have an xref label, write the list of floats info. Do this
8683 % after the caption, to avoid chance of it being a breakpoint.
8684 \ifx\floatlabel\empty \else
8685 % Write the text that goes in the lof to the aux file as
8686 % \floatlabel-lof. Besides \floatident, we include the short
8687 % caption if specified, else the full caption if specified, else nothing.
8691 % since we read the caption text in the macro world, where ^^M
8692 % is turned into a normal character, we have to scan it back, so
8693 % we don't write the literal three characters "^^M" into the aux file.
8695 \xdef\noexpand\gtemp{%
8696 \ifx\thisshortcaption\empty
8703 \immediate\write\auxfile{@xrdef
{\floatlabel-lof
}{\floatident
8704 \ifx\gtemp\empty \else :
\gtemp \fi}}%
8707 \egroup % end of \vtop
8709 % place the captured inserts
8711 % BEWARE: when the floats start floating, we have to issue warning
8712 % whenever an insert appears inside a float which could possibly
8713 % float. --kasal, 26may04
8718 % Append the tokens #2 to the definition of macro #1, not expanding either.
8720 \def\appendtomacro#1#2{%
8721 \expandafter\def\expandafter#1\expandafter{#1#2}%
8724 % @caption, @shortcaption
8726 \def\caption{\docaption\thiscaption}
8727 \def\shortcaption{\docaption\thisshortcaption}
8728 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8729 \def\defcaption#1#2{\egroup \def#1{#2}}
8731 % The parameter is the control sequence identifying the counter we are
8732 % going to use. Create it if it doesn't exist and assign it to \floatno.
8735 % Haven't seen this figure type before.
8736 \csname newcount
\endcsname #1%
8738 % Remember to reset this floatno at the next chap.
8739 \expandafter\gdef\expandafter\resetallfloatnos
8740 \expandafter{\resetallfloatnos #1=
0 }%
8745 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8746 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8747 % first read the @float command.
8749 \def\Yfloat{\floattype@tie
\chaplevelprefix\the\floatno}%
8751 % Magic string used for the XREFLABEL-title value, so \xrefX can
8752 % distinguish floats from other xref types.
8753 \def\floatmagic{!!float!!
}
8755 % #1 is the control sequence we are passed; we expand into a conditional
8756 % which is true if #1 represents a float ref. That is, the magic
8757 % \lastsection value which we \setref above.
8759 \def\iffloat#1{\expandafter\doiffloat#1==
\finish}
8761 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8762 % (safe) float type for this float. We set \iffloattype to #2.
8764 \def\doiffloat#1=
#2=
#3\finish{%
8766 \def\iffloattype{#2}%
8767 \ifx\temp\floatmagic
8770 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8772 \parseargdef\listoffloats{%
8773 \def\floattype{#1}% floattype
8775 % the floattype might have accents or other special characters,
8776 % but we need to use it in a control sequence name.
8779 \xdef\safefloattype{\floattype}%
8782 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8783 \expandafter\ifx\csname floatlist
\safefloattype\endcsname \relax
8785 % if the user said @listoffloats foo but never @float foo.
8786 \message{\linenumber No `
\safefloattype' floats to list.
}%
8790 \leftskip=
\tocindent % indent these entries like a toc
8791 \let\do=
\listoffloatsdo
8792 \csname floatlist
\safefloattype\endcsname
8797 % This is called on each entry in a list of floats. We're passed the
8798 % xref label, in the form LABEL-title, which is how we save it in the
8799 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8800 % has the text we're supposed to typeset here.
8802 % Figures without xref labels will not be included in the list (since
8803 % they won't appear in the aux file).
8805 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8806 \def\listoffloatsdoentry#1-title
\finish{{%
8807 % Can't fully expand XR#1-lof because it can contain anything. Just
8808 % pass the control sequence. On the other hand, XR#1-pg is just the
8809 % page number, and we want to fully expand that so we can get a link
8811 \toksA =
\expandafter{\csname XR
#1-lof
\endcsname}%
8813 % use the same \entry macro we use to generate the TOC and index.
8814 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR
#1-pg
\endcsname}}%
8819 \message{localization,
}
8821 % For single-language documents, @documentlanguage is usually given very
8822 % early, just after @documentencoding. Single argument is the language
8823 % (de) or locale (de_DE) abbreviation.
8826 \catcode`
\_ =
\active
8828 \parseargdef\documentlanguage{\begingroup
8829 \let_=
\normalunderscore % normal _ character for filenames
8830 \tex % read txi-??.tex file in plain TeX.
8831 % Read the file by the name they passed if it exists.
8832 \openin 1 txi-
#1.tex
8834 \documentlanguagetrywithoutunderscore{#1_
\finish}%
8836 \globaldefs =
1 % everything in the txi-LL files needs to persist
8840 \endgroup % end raw TeX
8843 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8846 \gdef\documentlanguagetrywithoutunderscore#1_
#2\finish{%
8847 \openin 1 txi-
#1.tex
8849 \errhelp =
\nolanghelp
8850 \errmessage{Cannot read language file txi-
#1.tex
}%
8852 \globaldefs =
1 % everything in the txi-LL files needs to persist
8857 }% end of special _ catcode
8859 \newhelp\nolanghelp{The given language definition file cannot be found or
8860 is empty. Maybe you need to install it? Putting it in the current
8861 directory should work if nowhere else does.
}
8863 % This macro is called from txi-??.tex files; the first argument is the
8864 % \language name to set (without the "\lang@" prefix), the second and
8865 % third args are \{left,right}hyphenmin.
8867 % The language names to pass are determined when the format is built.
8868 % See the etex.log file created at that time, e.g.,
8869 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8871 % With TeX Live 2008, etex now includes hyphenation patterns for all
8872 % available languages. This means we can support hyphenation in
8873 % Texinfo, at least to some extent. (This still doesn't solve the
8874 % accented characters problem.)
8877 \def\txisetlanguage#1#2#3{%
8878 % do not set the language if the name is undefined in the current TeX.
8879 \expandafter\ifx\csname lang@
#1\endcsname \relax
8880 \message{no patterns for
#1}%
8882 \global\language =
\csname lang@
#1\endcsname
8884 % but there is no harm in adjusting the hyphenmin values regardless.
8885 \global\lefthyphenmin =
#2\relax
8886 \global\righthyphenmin =
#3\relax
8889 % Helpers for encodings.
8890 % Set the catcode of characters 128 through 255 to the specified number.
8892 \def\setnonasciicharscatcode#1{%
8894 \loop\ifnum\count255<
256
8895 \global\catcode\count255=
#1\relax
8896 \advance\count255 by
1
8900 \def\setnonasciicharscatcodenonglobal#1{%
8902 \loop\ifnum\count255<
256
8903 \catcode\count255=
#1\relax
8904 \advance\count255 by
1
8908 % @documentencoding sets the definition of non-ASCII characters
8909 % according to the specified encoding.
8911 \parseargdef\documentencoding{%
8912 % Encoding being declared for the document.
8913 \def\declaredencoding{\csname #1.enc
\endcsname}%
8915 % Supported encodings: names converted to tokens in order to be able
8916 % to compare them with \ifx.
8917 \def\ascii{\csname US-ASCII.enc
\endcsname}%
8918 \def\latnine{\csname ISO-
8859-
15.enc
\endcsname}%
8919 \def\latone{\csname ISO-
8859-
1.enc
\endcsname}%
8920 \def\lattwo{\csname ISO-
8859-
2.enc
\endcsname}%
8921 \def\utfeight{\csname UTF-
8.enc
\endcsname}%
8923 \ifx \declaredencoding \ascii
8926 \else \ifx \declaredencoding \lattwo
8927 \setnonasciicharscatcode\active
8930 \else \ifx \declaredencoding \latone
8931 \setnonasciicharscatcode\active
8934 \else \ifx \declaredencoding \latnine
8935 \setnonasciicharscatcode\active
8938 \else \ifx \declaredencoding \utfeight
8939 \setnonasciicharscatcode\active
8943 \message{Unknown
document encoding
#1, ignoring.
}%
8952 % A message to be logged when using a character that isn't available
8953 % the default font encoding (OT1).
8955 \def\missingcharmsg#1{\message{Character missing in OT1 encoding:
#1.
}}
8957 % Take account of \c (plain) vs. \, (Texinfo) difference.
8958 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,
{#1}\fi}
8960 % First, make active non-ASCII characters in order for them to be
8961 % correctly categorized when TeX reads the replacement text of
8962 % macros containing the character definitions.
8963 \setnonasciicharscatcode\active
8965 % Latin1 (ISO-8859-1) character definitions.
8966 \def\latonechardefs{%
8968 \gdef^^a1
{\exclamdown}
8969 \gdef^^a2
{\missingcharmsg{CENT SIGN
}}
8970 \gdef^^a3
{{\pounds}}
8971 \gdef^^a4
{\missingcharmsg{CURRENCY SIGN
}}
8972 \gdef^^a5
{\missingcharmsg{YEN SIGN
}}
8973 \gdef^^a6
{\missingcharmsg{BROKEN BAR
}}
8976 \gdef^^a9
{\copyright}
8978 \gdef^^ab
{\guillemetleft}
8981 \gdef^^ae
{\registeredsymbol}
8984 \gdef^^b0
{\textdegree}
8993 \gdef^^b8
{\cedilla\
}
8997 \gdef^^bb
{\guillemetright}
8998 \gdef^^bc
{$
1\over4$
}
8999 \gdef^^bd
{$
1\over2$
}
9000 \gdef^^be
{$
3\over4$
}
9001 \gdef^^bf
{\questiondown}
9008 \gdef^^c5
{\ringaccent A
}
9010 \gdef^^c7
{\cedilla C
}
9042 \gdef^^e5
{\ringaccent a
}
9044 \gdef^^e7
{\cedilla c
}
9049 \gdef^^ec
{\`
{\dotless i
}}
9050 \gdef^^ed
{\'
{\dotless i
}}
9051 \gdef^^ee
{\^
{\dotless i
}}
9052 \gdef^^ef
{\"
{\dotless i
}}
9072 % Latin9 (ISO-8859-15) encoding character definitions.
9073 \def\latninechardefs{%
9074 % Encoding is almost identical to Latin1.
9087 % Latin2 (ISO-8859-2) character definitions.
9088 \def\lattwochardefs{%
9090 \gdef^^a1
{\ogonek{A
}}
9093 \gdef^^a4
{\missingcharmsg{CURRENCY SIGN
}}
9099 \gdef^^aa
{\cedilla S
}
9104 \gdef^^af
{\dotaccent Z
}
9106 \gdef^^b0
{\textdegree}
9107 \gdef^^b1
{\ogonek{a
}}
9108 \gdef^^b2
{\ogonek{ }}
9114 \gdef^^b8
{\cedilla\
}
9116 \gdef^^ba
{\cedilla s
}
9121 \gdef^^bf
{\dotaccent z
}
9130 \gdef^^c7
{\cedilla C
}
9133 \gdef^^ca
{\ogonek{E
}}
9149 \gdef^^d9
{\ringaccent U
}
9154 \gdef^^de
{\cedilla T
}
9164 \gdef^^e7
{\cedilla c
}
9167 \gdef^^ea
{\ogonek{e
}}
9170 \gdef^^ed
{\'
{\dotless{i
}}}
9171 \gdef^^ee
{\^
{\dotless{i
}}}
9183 \gdef^^f9
{\ringaccent u
}
9188 \gdef^^fe
{\cedilla t
}
9189 \gdef^^ff
{\dotaccent{}}
9192 % UTF-8 character definitions.
9194 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
9195 % changes for Texinfo conventions. It is included here under the GPL by
9196 % permission from Frank Mittelbach and the LaTeX team.
9202 \gdef\UTFviiiTwoOctets#1#2{\expandafter
9203 \UTFviiiDefined\csname u8:
#1\string #2\endcsname}
9205 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
9206 \UTFviiiDefined\csname u8:
#1\string #2\string #3\endcsname}
9208 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
9209 \UTFviiiDefined\csname u8:
#1\string #2\string #3\string #4\endcsname}
9211 \gdef\UTFviiiDefined#1{%
9213 \message{\linenumber Unicode char
\string #1 not defined for Texinfo
}%
9224 \global\catcode\countUTFx\active
9225 \uccode`\~
\countUTFx
9226 \uppercase\expandafter{\UTFviiiTmp}%
9227 \advance\countUTFx by
1
9228 \ifnum\countUTFx <
\countUTFy
9229 \expandafter\UTFviiiLoop
9235 \xdef~
{\noexpand\UTFviiiTwoOctets\string~
}}
9241 \xdef~
{\noexpand\UTFviiiThreeOctets\string~
}}
9247 \xdef~
{\noexpand\UTFviiiFourOctets\string~
}}
9260 \gdef\DeclareUnicodeCharacter#1#2{%
9261 \countUTFz = "
#1\relax
9262 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9265 \def\UTFviiiTwoOctets#
#1#
#2{%
9266 \csname u8:#
#1\string #
#2\endcsname}%
9267 \def\UTFviiiThreeOctets#
#1#
#2#
#3{%
9268 \csname u8:#
#1\string #
#2\string #
#3\endcsname}%
9269 \def\UTFviiiFourOctets#
#1#
#2#
#3#
#4{%
9270 \csname u8:#
#1\string #
#2\string #
#3\string #
#4\endcsname}%
9271 \expandafter\expandafter\expandafter\expandafter
9272 \expandafter\expandafter\expandafter
9273 \gdef\UTFviiiTmp{#2}%
9276 \gdef\parseXMLCharref{%
9277 \ifnum\countUTFz < "A0
\relax
9278 \errhelp =
\EMsimple
9279 \errmessage{Cannot define Unicode char value <
00A0
}%
9280 \else\ifnum\countUTFz < "
800\relax
9282 \parseUTFviiiB C
\UTFviiiTwoOctets.,
%
9283 \else\ifnum\countUTFz < "
10000\relax
9286 \parseUTFviiiB E
\UTFviiiThreeOctets.
{,;
}%
9291 \parseUTFviiiB F
\UTFviiiFourOctets.
{!,;
}%
9295 \gdef\parseUTFviiiA#1{%
9296 \countUTFx =
\countUTFz
9297 \divide\countUTFz by
64
9298 \countUTFy =
\countUTFz
9299 \multiply\countUTFz by
64
9300 \advance\countUTFx by -
\countUTFz
9301 \advance\countUTFx by
128
9302 \uccode `
#1\countUTFx
9303 \countUTFz =
\countUTFy}
9305 \gdef\parseUTFviiiB#1#2#3#4{%
9306 \advance\countUTFz by "
#10\relax
9307 \uccode `
#3\countUTFz
9308 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9311 \def\utfeightchardefs{%
9312 \DeclareUnicodeCharacter{00A0
}{\tie}
9313 \DeclareUnicodeCharacter{00A1
}{\exclamdown}
9314 \DeclareUnicodeCharacter{00A3
}{\pounds}
9315 \DeclareUnicodeCharacter{00A8
}{\"
{ }}
9316 \DeclareUnicodeCharacter{00A9
}{\copyright}
9317 \DeclareUnicodeCharacter{00AA
}{\ordf}
9318 \DeclareUnicodeCharacter{00AB
}{\guillemetleft}
9319 \DeclareUnicodeCharacter{00AD
}{\-
}
9320 \DeclareUnicodeCharacter{00AE
}{\registeredsymbol}
9321 \DeclareUnicodeCharacter{00AF
}{\=
{ }}
9323 \DeclareUnicodeCharacter{00B0
}{\ringaccent{ }}
9324 \DeclareUnicodeCharacter{00B4
}{\'
{ }}
9325 \DeclareUnicodeCharacter{00B8
}{\cedilla{ }}
9326 \DeclareUnicodeCharacter{00BA
}{\ordm}
9327 \DeclareUnicodeCharacter{00BB
}{\guillemetright}
9328 \DeclareUnicodeCharacter{00BF
}{\questiondown}
9330 \DeclareUnicodeCharacter{00C0
}{\`A
}
9331 \DeclareUnicodeCharacter{00C1
}{\'A
}
9332 \DeclareUnicodeCharacter{00C2
}{\^A
}
9333 \DeclareUnicodeCharacter{00C3
}{\~A
}
9334 \DeclareUnicodeCharacter{00C4
}{\"A
}
9335 \DeclareUnicodeCharacter{00C5
}{\AA}
9336 \DeclareUnicodeCharacter{00C6
}{\AE}
9337 \DeclareUnicodeCharacter{00C7
}{\cedilla{C
}}
9338 \DeclareUnicodeCharacter{00C8
}{\`E
}
9339 \DeclareUnicodeCharacter{00C9
}{\'E
}
9340 \DeclareUnicodeCharacter{00CA
}{\^E
}
9341 \DeclareUnicodeCharacter{00CB
}{\"E
}
9342 \DeclareUnicodeCharacter{00CC
}{\`I
}
9343 \DeclareUnicodeCharacter{00CD
}{\'I
}
9344 \DeclareUnicodeCharacter{00CE
}{\^I
}
9345 \DeclareUnicodeCharacter{00CF
}{\"I
}
9347 \DeclareUnicodeCharacter{00D0
}{\DH}
9348 \DeclareUnicodeCharacter{00D1
}{\~N
}
9349 \DeclareUnicodeCharacter{00D2
}{\`O
}
9350 \DeclareUnicodeCharacter{00D3
}{\'O
}
9351 \DeclareUnicodeCharacter{00D4
}{\^O
}
9352 \DeclareUnicodeCharacter{00D5
}{\~O
}
9353 \DeclareUnicodeCharacter{00D6
}{\"O
}
9354 \DeclareUnicodeCharacter{00D8
}{\O}
9355 \DeclareUnicodeCharacter{00D9
}{\`U
}
9356 \DeclareUnicodeCharacter{00DA
}{\'U
}
9357 \DeclareUnicodeCharacter{00DB
}{\^U
}
9358 \DeclareUnicodeCharacter{00DC
}{\"U
}
9359 \DeclareUnicodeCharacter{00DD
}{\'Y
}
9360 \DeclareUnicodeCharacter{00DE
}{\TH}
9361 \DeclareUnicodeCharacter{00DF
}{\ss}
9363 \DeclareUnicodeCharacter{00E0
}{\`a
}
9364 \DeclareUnicodeCharacter{00E1
}{\'a
}
9365 \DeclareUnicodeCharacter{00E2
}{\^a
}
9366 \DeclareUnicodeCharacter{00E3
}{\~a
}
9367 \DeclareUnicodeCharacter{00E4
}{\"a
}
9368 \DeclareUnicodeCharacter{00E5
}{\aa}
9369 \DeclareUnicodeCharacter{00E6
}{\ae}
9370 \DeclareUnicodeCharacter{00E7
}{\cedilla{c
}}
9371 \DeclareUnicodeCharacter{00E8
}{\`e
}
9372 \DeclareUnicodeCharacter{00E9
}{\'e
}
9373 \DeclareUnicodeCharacter{00EA
}{\^e
}
9374 \DeclareUnicodeCharacter{00EB
}{\"e
}
9375 \DeclareUnicodeCharacter{00EC
}{\`
{\dotless{i
}}}
9376 \DeclareUnicodeCharacter{00ED
}{\'
{\dotless{i
}}}
9377 \DeclareUnicodeCharacter{00EE
}{\^
{\dotless{i
}}}
9378 \DeclareUnicodeCharacter{00EF
}{\"
{\dotless{i
}}}
9380 \DeclareUnicodeCharacter{00F0
}{\dh}
9381 \DeclareUnicodeCharacter{00F1
}{\~n
}
9382 \DeclareUnicodeCharacter{00F2
}{\`o
}
9383 \DeclareUnicodeCharacter{00F3
}{\'o
}
9384 \DeclareUnicodeCharacter{00F4
}{\^o
}
9385 \DeclareUnicodeCharacter{00F5
}{\~o
}
9386 \DeclareUnicodeCharacter{00F6
}{\"o
}
9387 \DeclareUnicodeCharacter{00F8
}{\o}
9388 \DeclareUnicodeCharacter{00F9
}{\`u
}
9389 \DeclareUnicodeCharacter{00FA
}{\'u
}
9390 \DeclareUnicodeCharacter{00FB
}{\^u
}
9391 \DeclareUnicodeCharacter{00FC
}{\"u
}
9392 \DeclareUnicodeCharacter{00FD
}{\'y
}
9393 \DeclareUnicodeCharacter{00FE
}{\th}
9394 \DeclareUnicodeCharacter{00FF
}{\"y
}
9396 \DeclareUnicodeCharacter{0100}{\=A
}
9397 \DeclareUnicodeCharacter{0101}{\=a
}
9398 \DeclareUnicodeCharacter{0102}{\u{A
}}
9399 \DeclareUnicodeCharacter{0103}{\u{a
}}
9400 \DeclareUnicodeCharacter{0104}{\ogonek{A
}}
9401 \DeclareUnicodeCharacter{0105}{\ogonek{a
}}
9402 \DeclareUnicodeCharacter{0106}{\'C
}
9403 \DeclareUnicodeCharacter{0107}{\'c
}
9404 \DeclareUnicodeCharacter{0108}{\^C
}
9405 \DeclareUnicodeCharacter{0109}{\^c
}
9406 \DeclareUnicodeCharacter{0118}{\ogonek{E
}}
9407 \DeclareUnicodeCharacter{0119}{\ogonek{e
}}
9408 \DeclareUnicodeCharacter{010A
}{\dotaccent{C
}}
9409 \DeclareUnicodeCharacter{010B
}{\dotaccent{c
}}
9410 \DeclareUnicodeCharacter{010C
}{\v{C
}}
9411 \DeclareUnicodeCharacter{010D
}{\v{c
}}
9412 \DeclareUnicodeCharacter{010E
}{\v{D
}}
9414 \DeclareUnicodeCharacter{0112}{\=E
}
9415 \DeclareUnicodeCharacter{0113}{\=e
}
9416 \DeclareUnicodeCharacter{0114}{\u{E
}}
9417 \DeclareUnicodeCharacter{0115}{\u{e
}}
9418 \DeclareUnicodeCharacter{0116}{\dotaccent{E
}}
9419 \DeclareUnicodeCharacter{0117}{\dotaccent{e
}}
9420 \DeclareUnicodeCharacter{011A
}{\v{E
}}
9421 \DeclareUnicodeCharacter{011B
}{\v{e
}}
9422 \DeclareUnicodeCharacter{011C
}{\^G
}
9423 \DeclareUnicodeCharacter{011D
}{\^g
}
9424 \DeclareUnicodeCharacter{011E
}{\u{G
}}
9425 \DeclareUnicodeCharacter{011F
}{\u{g
}}
9427 \DeclareUnicodeCharacter{0120}{\dotaccent{G
}}
9428 \DeclareUnicodeCharacter{0121}{\dotaccent{g
}}
9429 \DeclareUnicodeCharacter{0124}{\^H
}
9430 \DeclareUnicodeCharacter{0125}{\^h
}
9431 \DeclareUnicodeCharacter{0128}{\~I
}
9432 \DeclareUnicodeCharacter{0129}{\~
{\dotless{i
}}}
9433 \DeclareUnicodeCharacter{012A
}{\=I
}
9434 \DeclareUnicodeCharacter{012B
}{\=
{\dotless{i
}}}
9435 \DeclareUnicodeCharacter{012C
}{\u{I
}}
9436 \DeclareUnicodeCharacter{012D
}{\u{\dotless{i
}}}
9438 \DeclareUnicodeCharacter{0130}{\dotaccent{I
}}
9439 \DeclareUnicodeCharacter{0131}{\dotless{i
}}
9440 \DeclareUnicodeCharacter{0132}{IJ
}
9441 \DeclareUnicodeCharacter{0133}{ij
}
9442 \DeclareUnicodeCharacter{0134}{\^J
}
9443 \DeclareUnicodeCharacter{0135}{\^
{\dotless{j
}}}
9444 \DeclareUnicodeCharacter{0139}{\'L
}
9445 \DeclareUnicodeCharacter{013A
}{\'l
}
9447 \DeclareUnicodeCharacter{0141}{\L}
9448 \DeclareUnicodeCharacter{0142}{\l}
9449 \DeclareUnicodeCharacter{0143}{\'N
}
9450 \DeclareUnicodeCharacter{0144}{\'n
}
9451 \DeclareUnicodeCharacter{0147}{\v{N
}}
9452 \DeclareUnicodeCharacter{0148}{\v{n
}}
9453 \DeclareUnicodeCharacter{014C
}{\=O
}
9454 \DeclareUnicodeCharacter{014D
}{\=o
}
9455 \DeclareUnicodeCharacter{014E
}{\u{O
}}
9456 \DeclareUnicodeCharacter{014F
}{\u{o
}}
9458 \DeclareUnicodeCharacter{0150}{\H{O
}}
9459 \DeclareUnicodeCharacter{0151}{\H{o
}}
9460 \DeclareUnicodeCharacter{0152}{\OE}
9461 \DeclareUnicodeCharacter{0153}{\oe}
9462 \DeclareUnicodeCharacter{0154}{\'R
}
9463 \DeclareUnicodeCharacter{0155}{\'r
}
9464 \DeclareUnicodeCharacter{0158}{\v{R
}}
9465 \DeclareUnicodeCharacter{0159}{\v{r
}}
9466 \DeclareUnicodeCharacter{015A
}{\'S
}
9467 \DeclareUnicodeCharacter{015B
}{\'s
}
9468 \DeclareUnicodeCharacter{015C
}{\^S
}
9469 \DeclareUnicodeCharacter{015D
}{\^s
}
9470 \DeclareUnicodeCharacter{015E
}{\cedilla{S
}}
9471 \DeclareUnicodeCharacter{015F
}{\cedilla{s
}}
9473 \DeclareUnicodeCharacter{0160}{\v{S
}}
9474 \DeclareUnicodeCharacter{0161}{\v{s
}}
9475 \DeclareUnicodeCharacter{0162}{\cedilla{t
}}
9476 \DeclareUnicodeCharacter{0163}{\cedilla{T
}}
9477 \DeclareUnicodeCharacter{0164}{\v{T
}}
9479 \DeclareUnicodeCharacter{0168}{\~U
}
9480 \DeclareUnicodeCharacter{0169}{\~u
}
9481 \DeclareUnicodeCharacter{016A
}{\=U
}
9482 \DeclareUnicodeCharacter{016B
}{\=u
}
9483 \DeclareUnicodeCharacter{016C
}{\u{U
}}
9484 \DeclareUnicodeCharacter{016D
}{\u{u
}}
9485 \DeclareUnicodeCharacter{016E
}{\ringaccent{U
}}
9486 \DeclareUnicodeCharacter{016F
}{\ringaccent{u
}}
9488 \DeclareUnicodeCharacter{0170}{\H{U
}}
9489 \DeclareUnicodeCharacter{0171}{\H{u
}}
9490 \DeclareUnicodeCharacter{0174}{\^W
}
9491 \DeclareUnicodeCharacter{0175}{\^w
}
9492 \DeclareUnicodeCharacter{0176}{\^Y
}
9493 \DeclareUnicodeCharacter{0177}{\^y
}
9494 \DeclareUnicodeCharacter{0178}{\"Y
}
9495 \DeclareUnicodeCharacter{0179}{\'Z
}
9496 \DeclareUnicodeCharacter{017A
}{\'z
}
9497 \DeclareUnicodeCharacter{017B
}{\dotaccent{Z
}}
9498 \DeclareUnicodeCharacter{017C
}{\dotaccent{z
}}
9499 \DeclareUnicodeCharacter{017D
}{\v{Z
}}
9500 \DeclareUnicodeCharacter{017E
}{\v{z
}}
9502 \DeclareUnicodeCharacter{01C4
}{D
\v{Z
}}
9503 \DeclareUnicodeCharacter{01C5
}{D
\v{z
}}
9504 \DeclareUnicodeCharacter{01C6
}{d
\v{z
}}
9505 \DeclareUnicodeCharacter{01C7
}{LJ
}
9506 \DeclareUnicodeCharacter{01C8
}{Lj
}
9507 \DeclareUnicodeCharacter{01C9
}{lj
}
9508 \DeclareUnicodeCharacter{01CA
}{NJ
}
9509 \DeclareUnicodeCharacter{01CB
}{Nj
}
9510 \DeclareUnicodeCharacter{01CC
}{nj
}
9511 \DeclareUnicodeCharacter{01CD
}{\v{A
}}
9512 \DeclareUnicodeCharacter{01CE
}{\v{a
}}
9513 \DeclareUnicodeCharacter{01CF
}{\v{I
}}
9515 \DeclareUnicodeCharacter{01D0
}{\v{\dotless{i
}}}
9516 \DeclareUnicodeCharacter{01D1
}{\v{O
}}
9517 \DeclareUnicodeCharacter{01D2
}{\v{o
}}
9518 \DeclareUnicodeCharacter{01D3
}{\v{U
}}
9519 \DeclareUnicodeCharacter{01D4
}{\v{u
}}
9521 \DeclareUnicodeCharacter{01E2
}{\=
{\AE}}
9522 \DeclareUnicodeCharacter{01E3
}{\=
{\ae}}
9523 \DeclareUnicodeCharacter{01E6
}{\v{G
}}
9524 \DeclareUnicodeCharacter{01E7
}{\v{g
}}
9525 \DeclareUnicodeCharacter{01E8
}{\v{K
}}
9526 \DeclareUnicodeCharacter{01E9
}{\v{k
}}
9528 \DeclareUnicodeCharacter{01F0
}{\v{\dotless{j
}}}
9529 \DeclareUnicodeCharacter{01F1
}{DZ
}
9530 \DeclareUnicodeCharacter{01F2
}{Dz
}
9531 \DeclareUnicodeCharacter{01F3
}{dz
}
9532 \DeclareUnicodeCharacter{01F4
}{\'G
}
9533 \DeclareUnicodeCharacter{01F5
}{\'g
}
9534 \DeclareUnicodeCharacter{01F8
}{\`N
}
9535 \DeclareUnicodeCharacter{01F9
}{\`n
}
9536 \DeclareUnicodeCharacter{01FC
}{\'
{\AE}}
9537 \DeclareUnicodeCharacter{01FD
}{\'
{\ae}}
9538 \DeclareUnicodeCharacter{01FE
}{\'
{\O}}
9539 \DeclareUnicodeCharacter{01FF
}{\'
{\o}}
9541 \DeclareUnicodeCharacter{021E
}{\v{H
}}
9542 \DeclareUnicodeCharacter{021F
}{\v{h
}}
9544 \DeclareUnicodeCharacter{0226}{\dotaccent{A
}}
9545 \DeclareUnicodeCharacter{0227}{\dotaccent{a
}}
9546 \DeclareUnicodeCharacter{0228}{\cedilla{E
}}
9547 \DeclareUnicodeCharacter{0229}{\cedilla{e
}}
9548 \DeclareUnicodeCharacter{022E
}{\dotaccent{O
}}
9549 \DeclareUnicodeCharacter{022F
}{\dotaccent{o
}}
9551 \DeclareUnicodeCharacter{0232}{\=Y
}
9552 \DeclareUnicodeCharacter{0233}{\=y
}
9553 \DeclareUnicodeCharacter{0237}{\dotless{j
}}
9555 \DeclareUnicodeCharacter{02DB
}{\ogonek{ }}
9557 \DeclareUnicodeCharacter{1E02
}{\dotaccent{B
}}
9558 \DeclareUnicodeCharacter{1E03
}{\dotaccent{b
}}
9559 \DeclareUnicodeCharacter{1E04
}{\udotaccent{B
}}
9560 \DeclareUnicodeCharacter{1E05
}{\udotaccent{b
}}
9561 \DeclareUnicodeCharacter{1E06
}{\ubaraccent{B
}}
9562 \DeclareUnicodeCharacter{1E07
}{\ubaraccent{b
}}
9563 \DeclareUnicodeCharacter{1E0A
}{\dotaccent{D
}}
9564 \DeclareUnicodeCharacter{1E0B
}{\dotaccent{d
}}
9565 \DeclareUnicodeCharacter{1E0C
}{\udotaccent{D
}}
9566 \DeclareUnicodeCharacter{1E0D
}{\udotaccent{d
}}
9567 \DeclareUnicodeCharacter{1E0E
}{\ubaraccent{D
}}
9568 \DeclareUnicodeCharacter{1E0F
}{\ubaraccent{d
}}
9570 \DeclareUnicodeCharacter{1E1E
}{\dotaccent{F
}}
9571 \DeclareUnicodeCharacter{1E1F
}{\dotaccent{f
}}
9573 \DeclareUnicodeCharacter{1E20
}{\=G
}
9574 \DeclareUnicodeCharacter{1E21
}{\=g
}
9575 \DeclareUnicodeCharacter{1E22
}{\dotaccent{H
}}
9576 \DeclareUnicodeCharacter{1E23
}{\dotaccent{h
}}
9577 \DeclareUnicodeCharacter{1E24
}{\udotaccent{H
}}
9578 \DeclareUnicodeCharacter{1E25
}{\udotaccent{h
}}
9579 \DeclareUnicodeCharacter{1E26
}{\"H
}
9580 \DeclareUnicodeCharacter{1E27
}{\"h
}
9582 \DeclareUnicodeCharacter{1E30
}{\'K
}
9583 \DeclareUnicodeCharacter{1E31
}{\'k
}
9584 \DeclareUnicodeCharacter{1E32
}{\udotaccent{K
}}
9585 \DeclareUnicodeCharacter{1E33
}{\udotaccent{k
}}
9586 \DeclareUnicodeCharacter{1E34
}{\ubaraccent{K
}}
9587 \DeclareUnicodeCharacter{1E35
}{\ubaraccent{k
}}
9588 \DeclareUnicodeCharacter{1E36
}{\udotaccent{L
}}
9589 \DeclareUnicodeCharacter{1E37
}{\udotaccent{l
}}
9590 \DeclareUnicodeCharacter{1E3A
}{\ubaraccent{L
}}
9591 \DeclareUnicodeCharacter{1E3B
}{\ubaraccent{l
}}
9592 \DeclareUnicodeCharacter{1E3E
}{\'M
}
9593 \DeclareUnicodeCharacter{1E3F
}{\'m
}
9595 \DeclareUnicodeCharacter{1E40
}{\dotaccent{M
}}
9596 \DeclareUnicodeCharacter{1E41
}{\dotaccent{m
}}
9597 \DeclareUnicodeCharacter{1E42
}{\udotaccent{M
}}
9598 \DeclareUnicodeCharacter{1E43
}{\udotaccent{m
}}
9599 \DeclareUnicodeCharacter{1E44
}{\dotaccent{N
}}
9600 \DeclareUnicodeCharacter{1E45
}{\dotaccent{n
}}
9601 \DeclareUnicodeCharacter{1E46
}{\udotaccent{N
}}
9602 \DeclareUnicodeCharacter{1E47
}{\udotaccent{n
}}
9603 \DeclareUnicodeCharacter{1E48
}{\ubaraccent{N
}}
9604 \DeclareUnicodeCharacter{1E49
}{\ubaraccent{n
}}
9606 \DeclareUnicodeCharacter{1E54
}{\'P
}
9607 \DeclareUnicodeCharacter{1E55
}{\'p
}
9608 \DeclareUnicodeCharacter{1E56
}{\dotaccent{P
}}
9609 \DeclareUnicodeCharacter{1E57
}{\dotaccent{p
}}
9610 \DeclareUnicodeCharacter{1E58
}{\dotaccent{R
}}
9611 \DeclareUnicodeCharacter{1E59
}{\dotaccent{r
}}
9612 \DeclareUnicodeCharacter{1E5A
}{\udotaccent{R
}}
9613 \DeclareUnicodeCharacter{1E5B
}{\udotaccent{r
}}
9614 \DeclareUnicodeCharacter{1E5E
}{\ubaraccent{R
}}
9615 \DeclareUnicodeCharacter{1E5F
}{\ubaraccent{r
}}
9617 \DeclareUnicodeCharacter{1E60
}{\dotaccent{S
}}
9618 \DeclareUnicodeCharacter{1E61
}{\dotaccent{s
}}
9619 \DeclareUnicodeCharacter{1E62
}{\udotaccent{S
}}
9620 \DeclareUnicodeCharacter{1E63
}{\udotaccent{s
}}
9621 \DeclareUnicodeCharacter{1E6A
}{\dotaccent{T
}}
9622 \DeclareUnicodeCharacter{1E6B
}{\dotaccent{t
}}
9623 \DeclareUnicodeCharacter{1E6C
}{\udotaccent{T
}}
9624 \DeclareUnicodeCharacter{1E6D
}{\udotaccent{t
}}
9625 \DeclareUnicodeCharacter{1E6E
}{\ubaraccent{T
}}
9626 \DeclareUnicodeCharacter{1E6F
}{\ubaraccent{t
}}
9628 \DeclareUnicodeCharacter{1E7C
}{\~V
}
9629 \DeclareUnicodeCharacter{1E7D
}{\~v
}
9630 \DeclareUnicodeCharacter{1E7E
}{\udotaccent{V
}}
9631 \DeclareUnicodeCharacter{1E7F
}{\udotaccent{v
}}
9633 \DeclareUnicodeCharacter{1E80
}{\`W
}
9634 \DeclareUnicodeCharacter{1E81
}{\`w
}
9635 \DeclareUnicodeCharacter{1E82
}{\'W
}
9636 \DeclareUnicodeCharacter{1E83
}{\'w
}
9637 \DeclareUnicodeCharacter{1E84
}{\"W
}
9638 \DeclareUnicodeCharacter{1E85
}{\"w
}
9639 \DeclareUnicodeCharacter{1E86
}{\dotaccent{W
}}
9640 \DeclareUnicodeCharacter{1E87
}{\dotaccent{w
}}
9641 \DeclareUnicodeCharacter{1E88
}{\udotaccent{W
}}
9642 \DeclareUnicodeCharacter{1E89
}{\udotaccent{w
}}
9643 \DeclareUnicodeCharacter{1E8A
}{\dotaccent{X
}}
9644 \DeclareUnicodeCharacter{1E8B
}{\dotaccent{x
}}
9645 \DeclareUnicodeCharacter{1E8C
}{\"X
}
9646 \DeclareUnicodeCharacter{1E8D
}{\"x
}
9647 \DeclareUnicodeCharacter{1E8E
}{\dotaccent{Y
}}
9648 \DeclareUnicodeCharacter{1E8F
}{\dotaccent{y
}}
9650 \DeclareUnicodeCharacter{1E90
}{\^Z
}
9651 \DeclareUnicodeCharacter{1E91
}{\^z
}
9652 \DeclareUnicodeCharacter{1E92
}{\udotaccent{Z
}}
9653 \DeclareUnicodeCharacter{1E93
}{\udotaccent{z
}}
9654 \DeclareUnicodeCharacter{1E94
}{\ubaraccent{Z
}}
9655 \DeclareUnicodeCharacter{1E95
}{\ubaraccent{z
}}
9656 \DeclareUnicodeCharacter{1E96
}{\ubaraccent{h
}}
9657 \DeclareUnicodeCharacter{1E97
}{\"t
}
9658 \DeclareUnicodeCharacter{1E98
}{\ringaccent{w
}}
9659 \DeclareUnicodeCharacter{1E99
}{\ringaccent{y
}}
9661 \DeclareUnicodeCharacter{1EA0
}{\udotaccent{A
}}
9662 \DeclareUnicodeCharacter{1EA1
}{\udotaccent{a
}}
9664 \DeclareUnicodeCharacter{1EB8
}{\udotaccent{E
}}
9665 \DeclareUnicodeCharacter{1EB9
}{\udotaccent{e
}}
9666 \DeclareUnicodeCharacter{1EBC
}{\~E
}
9667 \DeclareUnicodeCharacter{1EBD
}{\~e
}
9669 \DeclareUnicodeCharacter{1ECA
}{\udotaccent{I
}}
9670 \DeclareUnicodeCharacter{1ECB
}{\udotaccent{i
}}
9671 \DeclareUnicodeCharacter{1ECC
}{\udotaccent{O
}}
9672 \DeclareUnicodeCharacter{1ECD
}{\udotaccent{o
}}
9674 \DeclareUnicodeCharacter{1EE4
}{\udotaccent{U
}}
9675 \DeclareUnicodeCharacter{1EE5
}{\udotaccent{u
}}
9677 \DeclareUnicodeCharacter{1EF2
}{\`Y
}
9678 \DeclareUnicodeCharacter{1EF3
}{\`y
}
9679 \DeclareUnicodeCharacter{1EF4
}{\udotaccent{Y
}}
9681 \DeclareUnicodeCharacter{1EF8
}{\~Y
}
9682 \DeclareUnicodeCharacter{1EF9
}{\~y
}
9684 \DeclareUnicodeCharacter{2013}{--
}
9685 \DeclareUnicodeCharacter{2014}{---
}
9686 \DeclareUnicodeCharacter{2018}{\quoteleft}
9687 \DeclareUnicodeCharacter{2019}{\quoteright}
9688 \DeclareUnicodeCharacter{201A
}{\quotesinglbase}
9689 \DeclareUnicodeCharacter{201C
}{\quotedblleft}
9690 \DeclareUnicodeCharacter{201D
}{\quotedblright}
9691 \DeclareUnicodeCharacter{201E
}{\quotedblbase}
9692 \DeclareUnicodeCharacter{2022}{\bullet}
9693 \DeclareUnicodeCharacter{2026}{\dots}
9694 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9695 \DeclareUnicodeCharacter{203A
}{\guilsinglright}
9696 \DeclareUnicodeCharacter{20AC
}{\euro}
9698 \DeclareUnicodeCharacter{2192}{\expansion}
9699 \DeclareUnicodeCharacter{21D2
}{\result}
9701 \DeclareUnicodeCharacter{2212}{\minus}
9702 \DeclareUnicodeCharacter{2217}{\point}
9703 \DeclareUnicodeCharacter{2261}{\equiv}
9704 }% end of \utfeightchardefs
9707 % US-ASCII character definitions.
9708 \def\asciichardefs{% nothing need be done
9712 % Make non-ASCII characters printable again for compatibility with
9713 % existing Texinfo documents that may use them, even without declaring a
9714 % document encoding.
9716 \setnonasciicharscatcode \other
9719 \message{formatting,
}
9721 \newdimen\defaultparindent \defaultparindent =
15pt
9723 \chapheadingskip =
15pt plus
4pt minus
2pt
9724 \secheadingskip =
12pt plus
3pt minus
2pt
9725 \subsecheadingskip =
9pt plus
2pt minus
2pt
9727 % Prevent underfull vbox error messages.
9730 % Don't be very finicky about underfull hboxes, either.
9733 % Following George Bush, get rid of widows and orphans.
9737 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9738 % using an old version of TeX, don't do anything. We want the amount of
9739 % stretch added to depend on the line length, hence the dependence on
9740 % \hsize. We call this whenever the paper size is set.
9742 \def\setemergencystretch{%
9743 \ifx\emergencystretch\thisisundefined
9744 % Allow us to assign to \emergencystretch anyway.
9745 \def\emergencystretch{\dimen0}%
9747 \emergencystretch =
.15\hsize
9751 % Parameters in order: 1) textheight; 2) textwidth;
9752 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9753 % 7) physical page height; 8) physical page width.
9755 % We also call \setleading{\textleading}, so the caller should define
9756 % \textleading. The caller should also set \parskip.
9758 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9761 \splittopskip =
\topskip
9764 \advance\vsize by
\topskip
9765 \outervsize =
\vsize
9766 \advance\outervsize by
2\topandbottommargin
9767 \pageheight =
\vsize
9770 \outerhsize =
\hsize
9771 \advance\outerhsize by
0.5in
9774 \normaloffset =
#4\relax
9775 \bindingoffset =
#5\relax
9778 \pdfpageheight #7\relax
9779 \pdfpagewidth #8\relax
9780 % if we don't reset these, they will remain at "1 true in" of
9781 % whatever layout pdftex was dumped with.
9782 \pdfhorigin =
1 true in
9783 \pdfvorigin =
1 true in
9786 \setleading{\textleading}
9788 \parindent =
\defaultparindent
9789 \setemergencystretch
9792 % @letterpaper (the default).
9793 \def\letterpaper{{\globaldefs =
1
9794 \parskip =
3pt plus
2pt minus
1pt
9795 \textleading =
13.2pt
9797 % If page is nothing but text, make it come out even.
9798 \internalpagesizes{607.2pt
}{6in
}% that's 46 lines
9800 {\bindingoffset}{36pt
}%
9804 % Use @smallbook to reset parameters for 7x9.25 trim size.
9805 \def\smallbook{{\globaldefs =
1
9806 \parskip =
2pt plus
1pt
9809 \internalpagesizes{7.5in
}{5in
}%
9811 {\bindingoffset}{16pt
}%
9814 \lispnarrowing =
0.3in
9817 \contentsrightmargin =
0pt
9818 \defbodyindent =
.5cm
9821 % Use @smallerbook to reset parameters for 6x9 trim size.
9822 % (Just testing, parameters still in flux.)
9823 \def\smallerbook{{\globaldefs =
1
9824 \parskip =
1.5pt plus
1pt
9827 \internalpagesizes{7.4in
}{4.8in
}%
9832 \lispnarrowing =
0.25in
9835 \contentsrightmargin =
0pt
9836 \defbodyindent =
.4cm
9839 % Use @afourpaper to print on European A4 paper.
9840 \def\afourpaper{{\globaldefs =
1
9841 \parskip =
3pt plus
2pt minus
1pt
9842 \textleading =
13.2pt
9844 % Double-side printing via postscript on Laserjet 4050
9845 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9846 % To change the settings for a different printer or situation, adjust
9847 % \normaloffset until the front-side and back-side texts align. Then
9848 % do the same for \bindingoffset. You can set these for testing in
9849 % your texinfo source file like this:
9851 % \global\normaloffset = -6mm
9852 % \global\bindingoffset = 10mm
9854 \internalpagesizes{673.2pt
}{160mm
}% that's 51 lines
9855 {\voffset}{\hoffset}%
9856 {\bindingoffset}{44pt
}%
9861 \contentsrightmargin =
0pt
9862 \defbodyindent =
5mm
9865 % Use @afivepaper to print on European A5 paper.
9866 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9867 % He also recommends making @example and @lisp be small.
9868 \def\afivepaper{{\globaldefs =
1
9869 \parskip =
2pt plus
1pt minus
0.1pt
9870 \textleading =
12.5pt
9872 \internalpagesizes{160mm
}{120mm
}%
9873 {\voffset}{\hoffset}%
9874 {\bindingoffset}{8pt
}%
9877 \lispnarrowing =
0.2in
9880 \contentsrightmargin =
0pt
9881 \defbodyindent =
2mm
9885 % A specific text layout, 24x15cm overall, intended for A4 paper.
9886 \def\afourlatex{{\globaldefs =
1
9888 \internalpagesizes{237mm
}{150mm
}%
9890 {\bindingoffset}{7mm
}%
9893 % Must explicitly reset to 0 because we call \afourpaper.
9897 % Use @afourwide to print on A4 paper in landscape format.
9898 \def\afourwide{{\globaldefs =
1
9900 \internalpagesizes{241mm
}{165mm
}%
9901 {\voffset}{-
2.95mm
}%
9902 {\bindingoffset}{7mm
}%
9907 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9908 % Perhaps we should allow setting the margins, \topskip, \parskip,
9909 % and/or leading, also. Or perhaps we should compute them somehow.
9911 \parseargdef\pagesizes{\pagesizesyyy #1,,
\finish}
9912 \def\pagesizesyyy#1,
#2,
#3\finish{{%
9913 \setbox0 =
\hbox{\ignorespaces #2}\ifdim\wd0 >
0pt
\hsize=
#2\relax \fi
9916 \parskip =
3pt plus
2pt minus
1pt
9917 \setleading{\textleading}%
9920 \advance\dimen0 by
\voffset
9923 \advance\dimen2 by
\normaloffset
9925 \internalpagesizes{#1}{\hsize}%
9926 {\voffset}{\normaloffset}%
9927 {\bindingoffset}{44pt
}%
9931 % Set default to letter.
9936 \message{and turning on texinfo input format.
}
9938 \def^^L
{\par} % remove \outer, so ^L can appear in an @comment
9940 % DEL is a comment character, in case @c does not suffice.
9943 % Define macros to output various characters with catcode for normal text.
9944 \catcode`\"=
\other \def\normaldoublequote{"
}
9945 \catcode`\$=
\other \def\normaldollar{$
}%$ font-lock fix
9946 \catcode`\+=
\other \def\normalplus{+
}
9947 \catcode`\<=
\other \def\normalless{<
}
9948 \catcode`\>=
\other \def\normalgreater{>
}
9949 \catcode`\^=
\other \def\normalcaret{^
}
9950 \catcode`
\_=
\other \def\normalunderscore{_
}
9951 \catcode`\|=
\other \def\normalverticalbar{|
}
9952 \catcode`\~=
\other \def\normaltilde{~
}
9954 % This macro is used to make a character print one way in \tt
9955 % (where it can probably be output as-is), and another way in other fonts,
9956 % where something hairier probably needs to be done.
9958 % #1 is what to print if we are indeed using \tt; #2 is what to print
9959 % otherwise. Since all the Computer Modern typewriter fonts have zero
9960 % interword stretch (and shrink), and it is reasonable to expect all
9961 % typewriter fonts to have this, we can check that font parameter.
9963 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=
0pt
#1\else #2\fi}
9965 % Same as above, but check for italic font. Actually this also catches
9966 % non-italic slanted fonts since it is impossible to distinguish them from
9967 % italic fonts. But since this is only used by $ and it uses \sl anyway
9968 % this is not a problem.
9969 \def\ifusingit#1#2{\ifdim \fontdimen1\font>
0pt
#1\else #2\fi}
9971 % Turn off all special characters except @
9972 % (and those which the user can use as if they were ordinary).
9973 % Most of these we simply print from the \tt font, but for some, we can
9974 % use math or other variants that look better in normal text.
9977 \def\activedoublequote{{\tt\char34}}
9978 \let"=
\activedoublequote
9979 \catcode`\~=
\active \def\activetilde{{\tt\char126}} \let~ =
\activetilde
9981 \catcode`\^=
\active \def\activehat{{\tt \hat}} \let^ =
\activehat
9984 \def_{\ifusingtt\normalunderscore\_}
9986 % Subroutine for the previous macro.
9987 \def\_{\leavevmode \kern.07em
\vbox{\hrule width
.3em height
.1ex
}\kern .07em
}
9990 \def|
{{\tt\char124}}
9993 \catcode`\<=
\active \def\activeless{{\tt \less}}\let< =
\activeless
9995 \catcode`\>=
\active \def\activegtr{{\tt \gtr}}\let> =
\activegtr
9996 \catcode`\+=
\active \def+
{{\tt \char 43}}
9997 \catcode`\$=
\active \def$
{\ifusingit{{\sl\$
}}\normaldollar}%$ font-lock fix
9999 % used for headline/footline in the output routine, in case the page
10000 % breaks in the middle of an @tex block.
10001 \def\texinfochars{%
10002 \let< =
\activeless
10004 \let~ =
\activetilde
10006 \markupsetuplqdefault \markupsetuprqdefault
10008 \let\i =
\smartitalic
10009 % in principle, all other definitions in \tex have to be undone too.
10012 % If a .fmt file is being used, characters that might appear in a file
10013 % name cannot be active until we have parsed the command line.
10014 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
10015 % \otherifyactive is called near the end of this file.
10016 \def\otherifyactive{\catcode`+=
\other \catcode`
\_=
\other}
10018 % Used sometimes to turn off (effectively) the active characters even after
10020 \def\turnoffactive{%
10021 \normalturnoffactive
10027 % \backslashcurfont outputs one backslash character in current font,
10029 \global\chardef\backslashcurfont=`\\
10030 \global\let\rawbackslashxx=
\backslashcurfont % let existing .??s files work
10032 % \realbackslash is an actual character `\' with catcode other, and
10033 % \doublebackslash is two of them (for the pdf outlines).
10034 {\catcode`\\=
\other @gdef@realbackslash
{\
} @gdef@doublebackslash
{\\
}}
10036 % In texinfo, backslash is an active character; it prints the backslash
10037 % in fixed width font.
10038 \catcode`\\=
\active % @ for escape char from now on.
10040 % The story here is that in math mode, the \char of \backslashcurfont
10041 % ends up printing the roman \ from the math symbol font (because \char
10042 % in math mode uses the \mathcode, and plain.tex sets
10043 % \mathcode`\\="026E). It seems better for @backslashchar{} to always
10044 % print a typewriter backslash, hence we use an explicit \mathchar,
10045 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
10046 % ignored family value; char position "5C). We can't use " for the
10047 % usual hex value because it has already been made active.
10048 @def@normalbackslash
{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi
}}
10049 @let@backslashchar = @normalbackslash
% @backslashchar{} is for user documents.
10051 % On startup, @fixbackslash assigns:
10052 % @let \ = @normalbackslash
10053 % \rawbackslash defines an active \ to do \backslashcurfont.
10054 % \otherbackslash defines an active \ to be a literal `\' character with
10055 % catcode other. We switch back and forth between these.
10056 @gdef@rawbackslash
{@let\=@backslashcurfont
}
10057 @gdef@otherbackslash
{@let\=@realbackslash
}
10059 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
10060 % the literal character `\'. Also revert - to its normal character, in
10061 % case the active - from code has slipped in.
10063 {@catcode`- = @active
10064 @gdef@normalturnoffactive
{%
10066 @let"=@normaldoublequote
10067 @let$=@normaldollar
%$ font-lock fix
10070 @let>=@normalgreater
10071 @let\=@normalbackslash
10073 @let_=@normalunderscore
10074 @let|=@normalverticalbar
10076 @markupsetuplqdefault
10077 @markupsetuprqdefault
10082 % Make _ and + \other characters, temporarily.
10083 % This is canceled by @fixbackslash.
10086 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
10087 % That is what \eatinput is for; after that, the `\' should revert to printing
10090 @gdef@eatinput input texinfo
{@fixbackslash
}
10091 @global@let\ = @eatinput
10093 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
10094 % the first `\' in the file would cause an error. This macro tries to fix
10095 % that, assuming it is called before the first `\' could plausibly occur.
10096 % Also turn back on active characters that might appear in the input
10097 % file name, in case not using a pre-dumped format.
10099 @gdef@fixbackslash
{%
10100 @ifx\@eatinput @let\ = @normalbackslash @fi
10102 @catcode`@_=@active
10105 % Say @foo, not \foo, in error messages.
10108 % These (along with & and #) are made active for url-breaking, so need
10109 % active definitions as the normal characters.
10111 @def@normalquest
{?
}
10112 @def@normalslash
{/
}
10114 % These look ok in all fonts, so just make them not special.
10115 % @hashchar{} gets its own user-level command, because of #line.
10116 @catcode`@& = @other @def@normalamp
{&
}
10117 @catcode`@# = @other @def@normalhash
{#
}
10118 @catcode`@
% = @other @def@normalpercent{%}
10120 @let @hashchar = @normalhash
10122 @c Finally, make ` and ' active, so that txicodequoteundirected and
10123 @c txicodequotebacktick work right in, e.g., @w
{@code
{`foo'
}}. If we
10124 @c don't make ` and ' active, @code will not get them as active chars.
10125 @c Do this last of all since we use ` in the previous @catcode assignments.
10126 @catcode`@'=@active
10127 @catcode`@`=@active
10128 @markupsetuplqdefault
10129 @markupsetuprqdefault
10131 @c Local variables:
10132 @c eval: (add-hook 'write-file-hooks 'time-stamp)
10133 @c page-delimiter: "^\\\
\message"
10134 @c time-stamp-start: "def\\\
\texinfoversion{"
10135 @c time-stamp-format: "
%:y-%02m-%02d.%02H"
10136 @c time-stamp-end: "
}"
10142 arch-tag: e1b36e32-c96e-4135-a41a-
0b2efa2ea115