1 % texinfo.tex -- TeX macros to handle Texinfo files.
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname
\endcsname\relax\input plain
\fi
6 \def\texinfoversion{2012-
09-
12.16}
8 % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007, 2008, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
12 % This texinfo.tex file is free software: you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation, either version 3 of the
15 % License, or (at your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this program. If not, see <http://www.gnu.org/licenses/>.
25 % As a special exception, when this file is read by TeX when processing
26 % a Texinfo source document, you may use the result without
27 % restriction. (This has been our intent since Texinfo was invented.)
29 % Please try the latest version of texinfo.tex before submitting bug
30 % reports; you can get the latest version from:
31 % http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
32 % http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
33 % http://www.gnu.org/software/texinfo/ (the Texinfo home page)
34 % The texinfo.tex in any given distribution could well be out
35 % of date, so if that's what you're using, please check.
37 % Send bug reports to bug-texinfo@gnu.org. Please include including a
38 % complete document in each bug report with which we can reproduce the
39 % problem. Patches are, of course, greatly appreciated.
41 % To process a Texinfo manual with TeX, it's most reliable to use the
42 % texi2dvi shell script that comes with the distribution. For a simple
43 % manual foo.texi, however, you can get away with this:
48 % dvips foo.dvi -o # or whatever; this makes foo.ps.
49 % The extra TeX runs get the cross-reference information correct.
50 % Sometimes one run after texindex suffices, and sometimes you need more
51 % than two; texi2dvi does it as many times as necessary.
53 % It is possible to adapt texinfo.tex for other languages, to some
54 % extent. You can get the existing language-specific files from the
55 % full Texinfo distribution.
57 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60 \message{Loading texinfo
[version
\texinfoversion]:
}
62 % If in a .fmt file, print the version number
63 % and turn on active characters that we couldn't do earlier because
64 % they might have appeared in the input file name.
65 \everyjob{\message{[Texinfo version
\texinfoversion]}%
66 \catcode`+=
\active \catcode`
\_=
\active}
70 % We never want plain's \outer definition of \+ in Texinfo.
71 % For @tex, we can use \tabalign.
74 % Save some plain tex macros whose names we will redefine.
76 \let\ptexbullet=
\bullet
84 \let\ptexfootnote=
\footnote
88 \let\ptexindent=
\indent
89 \let\ptexinsert=
\insert
92 \let\ptexnewwrite\newwrite
93 \let\ptexnoindent=
\noindent
95 \let\ptexraggedright=
\raggedright
101 {\catcode`\'=
\active \global\let\ptexquoteright'
}% active in plain's math mode
103 % If this character appears in an error message or help string, it
104 % starts a new line in the output.
107 % Use TeX 3.0's \inputlineno to get the line number, for better error
108 % messages, but if we're using an old version of TeX, don't do anything.
110 \ifx\inputlineno\thisisundefined
111 \let\linenumber =
\empty % Pre-3.0.
113 \def\linenumber{l.
\the\inputlineno:
\space}
116 % Set up fixed words for English if not already set.
117 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix
}\fi
118 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter
}\fi
119 \ifx\putworderror\undefined \gdef\putworderror{error
}\fi
120 \ifx\putwordfile\undefined \gdef\putwordfile{file
}\fi
121 \ifx\putwordin\undefined \gdef\putwordin{in
}\fi
122 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)
}\fi
123 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)
}\fi
124 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info
}\fi
125 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of
}\fi
126 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on
}\fi
127 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title
}\fi
128 \ifx\putwordof\undefined \gdef\putwordof{of
}\fi
129 \ifx\putwordon\undefined \gdef\putwordon{on
}\fi
130 \ifx\putwordpage\undefined \gdef\putwordpage{page
}\fi
131 \ifx\putwordsection\undefined \gdef\putwordsection{section
}\fi
132 \ifx\putwordSection\undefined \gdef\putwordSection{Section
}\fi
133 \ifx\putwordsee\undefined \gdef\putwordsee{see
}\fi
134 \ifx\putwordSee\undefined \gdef\putwordSee{See
}\fi
135 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents
}\fi
136 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents
}\fi
138 \ifx\putwordMJan\undefined \gdef\putwordMJan{January
}\fi
139 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February
}\fi
140 \ifx\putwordMMar\undefined \gdef\putwordMMar{March
}\fi
141 \ifx\putwordMApr\undefined \gdef\putwordMApr{April
}\fi
142 \ifx\putwordMMay\undefined \gdef\putwordMMay{May
}\fi
143 \ifx\putwordMJun\undefined \gdef\putwordMJun{June
}\fi
144 \ifx\putwordMJul\undefined \gdef\putwordMJul{July
}\fi
145 \ifx\putwordMAug\undefined \gdef\putwordMAug{August
}\fi
146 \ifx\putwordMSep\undefined \gdef\putwordMSep{September
}\fi
147 \ifx\putwordMOct\undefined \gdef\putwordMOct{October
}\fi
148 \ifx\putwordMNov\undefined \gdef\putwordMNov{November
}\fi
149 \ifx\putwordMDec\undefined \gdef\putwordMDec{December
}\fi
151 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro
}\fi
152 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form
}\fi
153 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable
}\fi
154 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option
}\fi
155 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function
}\fi
157 % Since the category of space is not known, we have to be careful.
158 \chardef\spacecat =
10
159 \def\spaceisspace{\catcode`\ =
\spacecat}
161 % sometimes characters are active, so we need control sequences.
162 \chardef\ampChar = `\&
163 \chardef\colonChar = `\:
164 \chardef\commaChar = `\,
165 \chardef\dashChar = `\-
166 \chardef\dotChar = `\.
167 \chardef\exclamChar= `\!
168 \chardef\hashChar = `\#
169 \chardef\lquoteChar= `\`
170 \chardef\questChar = `\?
171 \chardef\rquoteChar= `\'
172 \chardef\semiChar = `\;
173 \chardef\slashChar = `\/
174 \chardef\underChar = `
\_
180 % The following is used inside several \edef's.
181 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
185 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
186 ap-pen-dix bit-map bit-maps
187 data-base data-bases eshell fall-ing half-way long-est man-u-script
188 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
189 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
191 stand-alone strong-est time-stamp time-stamps which-ever white-space
192 wide-spread wrap-around
195 % Margin to add to right of even pages, to left of odd pages.
196 \newdimen\bindingoffset
197 \newdimen\normaloffset
198 \newdimen\pagewidth \newdimen\pageheight
200 % For a final copy, take out the rectangles
201 % that mark overfull boxes (in case you have decided
202 % that the text looks ok even though it passes the margin).
204 \def\finalout{\overfullrule=
0pt
}
206 % Sometimes it is convenient to have everything in the transcript file
207 % and nothing on the terminal. We don't just call \tracingall here,
208 % since that produces some useless output on the terminal. We also make
209 % some effort to order the tracing commands to reduce output in the log
210 % file; cf. trace.sty in LaTeX.
212 \def\gloggingall{\begingroup \globaldefs =
1 \loggingall \endgroup}%
216 \tracinglostchars2 % 2 gives us more in etex
221 \showboxbreadth\maxdimen \showboxdepth\maxdimen
222 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
229 \tracingcommands3 % 3 gives us more in etex
233 % @errormsg{MSG}. Do the index-like expansions on MSG, but if things
234 % aren't perfect, it's not the end of the world, being an error message,
237 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
238 \def\doerrormsg#1{\errmessage{#1}}
240 % add check for \lastpenalty to plain's definitions. If the last thing
241 % we did was a \nobreak, we don't want to insert more space.
243 \def\smallbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\smallskipamount
244 \removelastskip\penalty-
50\smallskip\fi\fi}
245 \def\medbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\medskipamount
246 \removelastskip\penalty-
100\medskip\fi\fi}
247 \def\bigbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\bigskipamount
248 \removelastskip\penalty-
200\bigskip\fi\fi}
250 % Do @cropmarks to get crop marks.
253 \let\cropmarks =
\cropmarkstrue
255 % Dimensions to add cropmarks at corners.
256 % Added by P. A. MacKay, 12 Nov. 1986
258 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
259 \newdimen\cornerlong \cornerlong=
1pc
260 \newdimen\cornerthick \cornerthick=
.3pt
261 \newdimen\topandbottommargin \topandbottommargin=
.75in
263 % Output a mark which sets \thischapter, \thissection and \thiscolor.
264 % We dump everything together because we only have one kind of mark.
265 % This works because we only use \botmark / \topmark, not \firstmark.
267 % A mark contains a subexpression of the \ifcase ... \fi construct.
268 % \get*marks macros below extract the needed part using \ifcase.
270 % Another complication is to let the user choose whether \thischapter
271 % (\thissection) refers to the chapter (section) in effect at the top
272 % of a page, or that at the bottom of a page. The solution is
273 % described on page 260 of The TeXbook. It involves outputting two
274 % marks for the sectioning macros, one before the section break, and
275 % one after. I won't pretend I can describe this better than DEK...
277 \toks0=
\expandafter{\lastchapterdefs}%
278 \toks2=
\expandafter{\lastsectiondefs}%
279 \toks4=
\expandafter{\prevchapterdefs}%
280 \toks6=
\expandafter{\prevsectiondefs}%
281 \toks8=
\expandafter{\lastcolordefs}%
283 \the\toks0 \the\toks2
284 \noexpand\or \the\toks4 \the\toks6
285 \noexpand\else \the\toks8
288 % \topmark doesn't work for the very first chapter (after the title
289 % page or the contents), so we use \firstmark there -- this gets us
290 % the mark with the chapter defs, unless the user sneaks in, e.g.,
291 % @setcolor (or @url, or @link, etc.) between @contents and the very
293 \def\gettopheadingmarks{%
295 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
297 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
298 \def\getcolormarks{\ifcase2\topmark\fi}
300 % Avoid "undefined control sequence" errors.
301 \def\lastchapterdefs{}
302 \def\lastsectiondefs{}
303 \def\prevchapterdefs{}
304 \def\prevsectiondefs{}
307 % Main output routine.
309 \output =
{\onepageout{\pagecontents\PAGE}}
314 % \onepageout takes a vbox as an argument. Note that \pagecontents
315 % does insertions, but you have to call it yourself.
317 \ifcropmarks \hoffset=
0pt
\else \hoffset=
\normaloffset \fi
319 \ifodd\pageno \advance\hoffset by
\bindingoffset
320 \else \advance\hoffset by -
\bindingoffset\fi
322 % Do this outside of the \shipout so @code etc. will be expanded in
323 % the headline as they should be, not taken literally (outputting ''code).
324 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
325 \setbox\headlinebox =
\vbox{\let\hsize=
\pagewidth \makeheadline}%
326 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
327 \setbox\footlinebox =
\vbox{\let\hsize=
\pagewidth \makefootline}%
330 % Have to do this stuff outside the \shipout because we want it to
331 % take effect in \write's, yet the group defined by the \vbox ends
332 % before the \shipout runs.
334 \indexdummies % don't expand commands in the output.
335 \normalturnoffactive % \ in index entries must not stay \, e.g., if
336 % the page break happens to be in the middle of an example.
337 % We don't want .vr (or whatever) entries like this:
338 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
339 % "\acronym" won't work when it's read back in;
341 % {\code {{\tt \backslashcurfont }acronym}
343 % Do this early so pdf references go to the beginning of the page.
344 \ifpdfmakepagedest \pdfdest name
{\the\pageno} xyz
\fi
346 \ifcropmarks \vbox to
\outervsize\bgroup
348 \vskip-
\topandbottommargin
350 \line{\ewtop\hfil\ewtop}%
353 \vbox{\moveleft\cornerthick\nstop}%
355 \vbox{\moveright\cornerthick\nstop}%
358 \vskip\topandbottommargin
360 \hfil % center the page within the outer (page) hsize.
361 \ifodd\pageno\hskip\bindingoffset\fi
367 \ifdim\ht\footlinebox >
0pt
368 % Only leave this space if the footline is nonempty.
369 % (We lessened \vsize for it in \oddfootingyyy.)
370 % The \baselineskip=24pt in plain's \makefootline has no effect.
376 \egroup % end of \vbox\bgroup
377 \hfil\egroup % end of (centering) \line\bgroup
378 \vskip\topandbottommargin plus1fill minus1fill
379 \boxmaxdepth =
\cornerthick
382 \vbox{\moveleft\cornerthick\nsbot}%
384 \vbox{\moveright\cornerthick\nsbot}%
387 \line{\ewbot\hfil\ewbot}%
389 \egroup % \vbox from first cropmarks clause
391 }% end of \shipout\vbox
392 }% end of group with \indexdummies
394 \ifnum\outputpenalty>-
20000 \else\dosupereject\fi
397 \newinsert\margin \dimen\margin=
\maxdimen
399 \def\pagebody#1{\vbox to
\pageheight{\boxmaxdepth=
\maxdepth #1}}
401 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
402 % marginal hacks, juha@viisa.uucp (Juha Takala)
403 \ifvoid\margin\else % marginal info is present
404 \rlap{\kern\hsize\vbox to
\z@
{\kern1pt\box\margin \vss}}\fi
405 \dimen@=
\dp#1\relax \unvbox#1\relax
406 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
407 \ifr@ggedbottom
\kern-
\dimen@
\vfil \fi}
410 % Here are the rules for the cropmarks. Note that they are
411 % offset so that the space between them is truly \outerhsize or \outervsize
412 % (P. A. MacKay, 12 November, 1986)
414 \def\ewtop{\vrule height
\cornerthick depth0pt width
\cornerlong}
416 {\hrule height
\cornerthick depth
\cornerlong width
\cornerthick}}
417 \def\ewbot{\vrule height0pt depth
\cornerthick width
\cornerlong}
419 {\hrule height
\cornerlong depth
\cornerthick width
\cornerthick}}
421 % Parse an argument, then pass it to #1. The argument is the rest of
422 % the input line (except we remove a trailing comment). #1 should be a
423 % macro which expects an ordinary undelimited TeX argument.
425 \def\parsearg{\parseargusing{}}
426 \def\parseargusing#1#2{%
432 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
436 \gdef\parseargline#1^^M
{%
437 \endgroup % End of the group started in \parsearg.
438 \argremovecomment #1\comment\ArgTerm%
442 % First remove any @comment, then any @c comment.
443 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
444 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M
\ArgTerm}
446 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
448 % \argremovec might leave us with trailing space, e.g.,
449 % @end itemize @c foo
450 % This space token undergoes the same procedure and is eventually removed
451 % by \finishparsearg.
453 \def\argcheckspaces#1\^^M
{\argcheckspacesX#1\^^M \^^M
}
454 \def\argcheckspacesX#1 \^^M
{\argcheckspacesY#1\^^M
}
455 \def\argcheckspacesY#1\^^M
#2\^^M
#3\ArgTerm{%
458 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
459 \let\temp\finishparsearg
461 \let\temp\argcheckspaces
463 % Put the space token in:
467 % If a _delimited_ argument is enclosed in braces, they get stripped; so
468 % to get _exactly_ the rest of the line, we had to prevent such situation.
469 % We prepended an \empty token at the very beginning and we expand it now,
470 % just before passing the control to \argtorun.
471 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
472 % either the null string, or it ends with \^^M---thus there is no danger
473 % that a pair of braces would be stripped.
475 % But first, we have to remove the trailing space token.
477 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
479 % \parseargdef\foo{...}
480 % is roughly equivalent to
481 % \def\foo{\parsearg\Xfoo}
484 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
485 % favourite TeX trick. --kasal, 16nov03
488 \expandafter \doparseargdef \csname\string#1\endcsname #1%
490 \def\doparseargdef#1#2{%
495 % Several utility definitions with active space:
500 % Make each space character in the input produce a normal interword
501 % space in the output. Don't allow a line break at this space, as this
502 % is used only in environments like @example, where each line of input
503 % should produce a line of output anyway.
505 \gdef\sepspaces{\obeyspaces\let =
\tie}
507 % If an index command is used in an @example environment, any spaces
508 % therein should become regular spaces in the raw index file, not the
509 % expansion of \tie (\leavevmode \penalty \@M \ ).
510 \gdef\unsepspaces{\let =
\space}
514 \def\flushcr{\ifx\par\lisppar \def\next#
#1{}\else \let\next=
\relax \fi \next}
516 % Define the framework for environments in texinfo.tex. It's used like this:
521 % It's the responsibility of \envdef to insert \begingroup before the
522 % actual body; @end closes the group after calling \Efoo. \envdef also
523 % defines \thisenv, so the current environment is known; @end checks
524 % whether the environment name matches. The \checkenv macro can also be
525 % used to check whether the current environment is the one expected.
527 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
528 % are not treated as environments; they don't open a group. (The
529 % implementation of @end takes care not to call \endgroup in this
533 % At run-time, environments start with this:
534 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
538 % ... but they get defined via ``\envdef\foo{...}'':
539 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
540 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
542 % Check whether we're in the right environment:
551 % Environment mismatch, #1 expected:
554 \errmessage{This command can appear only
\inenvironment\temp,
555 not
\inenvironment\thisenv}%
557 \def\inenvironment#1{%
559 outside of any environment
%
561 in environment
\expandafter\string#1%
565 % @end foo executes the definition of \Efoo.
566 % But first, it executes a specialized version of \checkenv
569 \if 1\csname iscond.
#1\endcsname
571 % The general wording of \badenverr may not be ideal.
572 \expandafter\checkenv\csname#1\endcsname
573 \csname E
#1\endcsname
578 \newhelp\EMsimple{Press RETURN to continue.
}
581 % Be sure we're in horizontal mode when doing a tie, since we make space
582 % equivalent to this in @example-like environments. Otherwise, a space
583 % at the beginning of a line will start with \penalty -- and
584 % since \penalty is valid in vertical mode, we'd end up putting the
585 % penalty on the vertical list instead of in the new paragraph.
587 % Avoid using \@M directly, because that causes trouble
588 % if the definition is written into an index file.
589 \global\let\tiepenalty = \@M
590 \gdef\tie{\leavevmode\penalty\tiepenalty\
}
593 % @: forces normal size whitespace following.
594 \def\:
{\spacefactor=
1000 }
596 % @* forces a line break.
597 \def\*
{\unskip\hfil\break\hbox{}\ignorespaces}
599 % @/ allows a line break.
602 % @. is an end-of-sentence period.
603 \def\.
{.
\spacefactor=
\endofsentencespacefactor\space}
605 % @! is an end-of-sentence bang.
606 \def\!
{!
\spacefactor=
\endofsentencespacefactor\space}
608 % @? is an end-of-sentence query.
609 \def\?
{?
\spacefactor=
\endofsentencespacefactor\space}
611 % @frenchspacing on|off says whether to put extra space after punctuation.
616 \parseargdef\frenchspacing{%
618 \ifx\temp\onword \plainfrenchspacing
619 \else\ifx\temp\offword \plainnonfrenchspacing
622 \errmessage{Unknown @frenchspacing option `
\temp', must be on|off
}%
626 % @w prevents a word break. Without the \leavevmode, @w at the
627 % beginning of a paragraph, when TeX is still in vertical mode, would
628 % produce a whole line of output instead of starting the paragraph.
629 \def\w#1{\leavevmode\hbox{#1}}
631 % @group ... @end group forces ... to be all on one page, by enclosing
632 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
633 % to keep its height that of a normal line. According to the rules for
634 % \topskip (p.114 of the TeXbook), the glue inserted is
635 % max (\topskip - \ht (first item), 0). If that height is large,
636 % therefore, no glue is inserted, and the space between the headline and
637 % the text is small, which looks bad.
639 % Another complication is that the group might be very large. This can
640 % cause the glue on the previous page to be unduly stretched, because it
641 % does not have much material. In this case, it's better to add an
642 % explicit \vfill so that the extra space is at the bottom. The
643 % threshold for doing this is if the group is more than \vfilllimit
644 % percent of a page (\vfilllimit can be changed inside of @tex).
650 \ifnum\catcode`\^^M=
\active \else
651 \errhelp =
\groupinvalidhelp
652 \errmessage{@group invalid in context where filling is enabled
}%
656 \setbox\groupbox =
\vtop\bgroup
657 % Do @comment since we are called inside an environment such as
658 % @example, where each end-of-line in the input causes an
659 % end-of-line in the output. We don't want the end-of-line after
660 % the `@group' to put extra space in the output. Since @group
661 % should appear on a line by itself (according to the Texinfo
662 % manual), we don't worry about eating any user text.
666 % The \vtop produces a box with normal height and large depth; thus, TeX puts
667 % \baselineskip glue before it, and (when the next line of text is done)
668 % \lineskip glue after it. Thus, space below is not quite equal to space
669 % above. But it's pretty close.
671 % To get correct interline space between the last line of the group
672 % and the first line afterwards, we have to propagate \prevdepth.
673 \endgraf % Not \par, as it may have been set to \lisppar.
674 \global\dimen1 =
\prevdepth
675 \egroup % End the \vtop.
676 % \dimen0 is the vertical size of the group's box.
677 \dimen0 =
\ht\groupbox \advance\dimen0 by
\dp\groupbox
678 % \dimen2 is how much space is left on the page (more or less).
679 \dimen2 =
\pageheight \advance\dimen2 by -
\pagetotal
680 % if the group doesn't fit on the current page, and it's a big big
681 % group, force a page break.
682 \ifdim \dimen0 >
\dimen2
683 \ifdim \pagetotal <
\vfilllimit\pageheight
692 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
693 % message, so this ends up printing `@group can only ...'.
695 \newhelp\groupinvalidhelp{%
696 group can only be used in environments such as @example,^^J
%
697 where each line of input produces a line of output.
}
699 % @need space-in-mils
700 % forces a page break if there is not space-in-mils remaining.
702 \newdimen\mil \mil=
0.001in
705 % Ensure vertical mode, so we don't make a big box in the middle of a
709 % If the @need value is less than one line space, it's useless.
711 \dimen2 =
\ht\strutbox
712 \advance\dimen2 by
\dp\strutbox
713 \ifdim\dimen0 >
\dimen2
715 % Do a \strut just to make the height of this box be normal, so the
716 % normal leading is inserted relative to the preceding line.
717 % And a page break here is fine.
718 \vtop to
#1\mil{\strut\vfil}%
720 % TeX does not even consider page breaks if a penalty added to the
721 % main vertical list is 10000 or more. But in order to see if the
722 % empty box we just added fits on the page, we must make it consider
723 % page breaks. On the other hand, we don't want to actually break the
724 % page after the empty box. So we use a penalty of 9999.
726 % There is an extremely small chance that TeX will actually break the
727 % page at this \penalty, if there are no other feasible breakpoints in
728 % sight. (If the user is using lots of big @group commands, which
729 % almost-but-not-quite fill up a page, TeX will have a hard time doing
730 % good page breaking, for example.) However, I could not construct an
731 % example where a page broke at this \penalty; if it happens in a real
732 % document, then we can reconsider our strategy.
735 % Back up by the size of the box, whether we did a page break or not.
738 % Do not allow a page break right after this kern.
743 % @br forces paragraph break (and is undocumented).
747 % @page forces the start of a new page.
749 \def\page{\par\vfill\supereject}
752 % outputs text on separate line in roman font, starting at standard page margin
754 % This records the amount of indent in the innermost environment.
755 % That's how much \exdent should take out.
756 \newskip\exdentamount
758 % This defn is used inside fill environments such as @defun.
759 \parseargdef\exdent{\hfil\break\hbox{\kern -
\exdentamount{\rm#1}}\hfil\break}
761 % This defn is used inside nofill environments such as @example.
762 \parseargdef\nofillexdent{{\advance \leftskip by -
\exdentamount
763 \leftline{\hskip\leftskip{\rm#1}}}}
765 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
766 % paragraph. For more general purposes, use the \margin insertion
767 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
769 \newskip\inmarginspacing \inmarginspacing=
1cm
770 \def\strutdepth{\dp\strutbox}
772 \def\doinmargin#1#2{\strut\vadjust{%
775 \vtop to
\strutdepth{%
776 \baselineskip=
\strutdepth
778 % if you have multiple lines of stuff to put here, you'll need to
779 % make the vbox yourself of the appropriate size.
781 \llap{\ignorespaces #2\hskip\inmarginspacing}%
783 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
788 \def\inleftmargin{\doinmargin l
}
789 \def\inrightmargin{\doinmargin r
}
791 % @inmargin{TEXT [, RIGHT-TEXT]}
792 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
793 % else use TEXT for both).
795 \def\inmargin#1{\parseinmargin #1,,
\finish}
796 \def\parseinmargin#1,
#2,
#3\finish{% not perfect, but better than nothing.
797 \setbox0 =
\hbox{\ignorespaces #2}%
799 \def\lefttext{#1}% have both texts
802 \def\lefttext{#1}% have only one text
807 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
809 \def\temp{\inleftmargin\lefttext}%
814 % @| inserts a changebar to the left of the current line. It should
815 % surround any changed text. This approach does *not* work if the
816 % change spans more than two lines of output. To handle that, we would
817 % have adopt a much more difficult approach (putting marks into the main
818 % vertical list for the beginning and end of each change). This command
819 % is not documented, not supported, and doesn't work.
822 % \vadjust can only be used in horizontal mode.
825 % Append this vertical mode material after the current line in the output.
827 % We want to insert a rule with the height and depth of the current
828 % leading; that is exactly what \strutbox is supposed to record.
831 % \vadjust-items are inserted at the left edge of the type. So
832 % the \llap here moves out into the left-hand margin.
835 % For a thicker or thinner bar, change the `1pt'.
836 \vrule height
\baselineskip width1pt
838 % This is the space between the bar and the text.
844 % @include FILE -- \input text of FILE.
846 \def\include{\parseargusing\filenamecatcodes\includezzz}
851 \makevalueexpandable % we want to expand any @value in FILE.
852 \turnoffactive % and allow special characters in the expansion
853 \indexnofonts % Allow `@@' and other weird things in file names.
854 \wlog{texinfo.tex: doing @include of
#1^^J
}%
855 \edef\temp{\noexpand\input #1 }%
857 % This trickery is to read FILE outside of a group, in case it makes
863 \def\filenamecatcodes{%
877 \def\pushthisfilestack{%
878 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
880 \def\pushthisfilestackX{%
881 \expandafter\pushthisfilestackY\thisfile\StackTerm
883 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
884 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
887 \def\popthisfilestack{\errthisfilestackempty}
888 \def\errthisfilestackempty{\errmessage{Internal error:
889 the stack of filenames is empty.
}}
894 % outputs that line, centered.
896 \parseargdef\center{%
898 \let\centersub\centerH
900 \let\centersub\centerV
902 \centersub{\hfil \ignorespaces#1\unskip \hfil}%
903 \let\centersub\relax % don't let the definition persist, just in case
907 \advance\hsize by -
\leftskip
908 \advance\hsize by -
\rightskip
913 \newcount\centerpenalty
915 % The idea here is the same as in \startdefun, \cartouche, etc.: if
916 % @center is the first thing after a section heading, we need to wipe
917 % out the negative parskip inserted by \sectionheading, but still
918 % prevent a page break here.
919 \centerpenalty =
\lastpenalty
920 \ifnum\centerpenalty>
10000 \vskip\parskip \fi
921 \ifnum\centerpenalty>
9999 \penalty\centerpenalty \fi
922 \line{\kern\leftskip #1\kern\rightskip}%
925 % @sp n outputs n lines of vertical space
927 \parseargdef\sp{\vskip #1\baselineskip}
929 % @comment ...line which is ignored...
930 % @c is the same as @comment
931 % @ignore ... @end ignore is another way to write a comment
933 \def\comment{\begingroup \catcode`\^^M=
\other%
934 \catcode`\@=
\other \catcode`\
{=
\other \catcode`\
}=
\other%
936 {\catcode`\^^M=
\other \gdef\commentxxx#1^^M
{\endgroup}}
940 % @paragraphindent NCHARS
941 % We'll use ems for NCHARS, close enough.
942 % NCHARS can also be the word `asis' or `none'.
943 % We cannot feasibly implement @paragraphindent asis, though.
945 \def\asisword{asis
} % no translation, these are keywords
948 \parseargdef\paragraphindent{%
953 \defaultparindent =
0pt
955 \defaultparindent =
#1em
958 \parindent =
\defaultparindent
961 % @exampleindent NCHARS
962 % We'll use ems for NCHARS like @paragraphindent.
963 % It seems @exampleindent asis isn't necessary, but
964 % I preserve it to make it similar to @paragraphindent.
965 \parseargdef\exampleindent{%
972 \lispnarrowing =
#1em
977 % @firstparagraphindent WORD
978 % If WORD is `none', then suppress indentation of the first paragraph
979 % after a section heading. If WORD is `insert', then do indent at such
982 % The paragraph indentation is suppressed or not by calling
983 % \suppressfirstparagraphindent, which the sectioning commands do.
984 % We switch the definition of this back and forth according to WORD.
985 % By default, we suppress indentation.
987 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
988 \def\insertword{insert
}
990 \parseargdef\firstparagraphindent{%
993 \let\suppressfirstparagraphindent =
\dosuppressfirstparagraphindent
994 \else\ifx\temp\insertword
995 \let\suppressfirstparagraphindent =
\relax
998 \errmessage{Unknown @firstparagraphindent option `
\temp'
}%
1002 % Here is how we actually suppress indentation. Redefine \everypar to
1003 % \kern backwards by \parindent, and then reset itself to empty.
1005 % We also make \indent itself not actually do anything until the next
1008 \gdef\dosuppressfirstparagraphindent{%
1010 \restorefirstparagraphindent
1014 \restorefirstparagraphindent
1017 \global\everypar =
{%
1019 \restorefirstparagraphindent
1023 \gdef\restorefirstparagraphindent{%
1024 \global \let \indent =
\ptexindent
1025 \global \let \noindent =
\ptexnoindent
1026 \global \everypar =
{}%
1030 % @refill is a no-op.
1033 % If working on a large document in chapters, it is convenient to
1034 % be able to disable indexing, cross-referencing, and contents, for test runs.
1035 % This is done with @novalidate (before @setfilename).
1037 \newif\iflinks \linkstrue % by default we want the aux files.
1038 \let\novalidate =
\linksfalse
1040 % @setfilename is done at the beginning of every texinfo file.
1041 % So open here the files we need to have open while reading the input.
1042 % This makes it possible to make a .fmt file for texinfo.
1044 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1047 % Open the new aux file. TeX will close it automatically at exit.
1048 \immediate\openout\auxfile=
\jobname.aux
1049 \fi % \openindices needs to do some work in any case.
1051 \let\setfilename=
\comment % Ignore extra @setfilename cmds.
1053 % If texinfo.cnf is present on the system, read it.
1054 % Useful for site-wide @afourpaper, etc.
1055 \openin 1 texinfo.cnf
1056 \ifeof 1 \else \input texinfo.cnf
\fi
1059 \comment % Ignore the actual filename.
1062 % Called from \setfilename.
1074 \outer\def\bye{\pagealignmacro\tracingstats=
1\ptexend}
1078 % adobe `portable' document format
1082 \newcount\filenamelength
1091 \newif\ifpdfmakepagedest
1093 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1094 % can be set). So we test for \relax and 0 as well as being undefined.
1095 \ifx\pdfoutput\thisisundefined
1097 \ifx\pdfoutput\relax
1106 % PDF uses PostScript string constants for the names of xref targets,
1107 % for display in the outlines, and in other places. Thus, we have to
1108 % double any backslashes. Otherwise, a name like "\node" will be
1109 % interpreted as a newline (\n), followed by o, d, e. Not good.
1111 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1112 % related messages. The final outcome is that it is up to the TeX user
1113 % to double the backslashes and otherwise make the string valid, so
1114 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1115 % do this reliably, so we use it.
1117 % #1 is a control sequence in which to do the replacements,
1119 \def\txiescapepdf#1{%
1120 \ifx\pdfescapestring\thisisundefined
1121 % No primitive available; should we give a warning or log?
1122 % Many times it won't matter.
1124 % The expandable \pdfescapestring primitive escapes parentheses,
1125 % backslashes, and other special chars.
1126 \xdef#1{\pdfescapestring{#1}}%
1130 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1131 with PDF output, and none of those formats could be found. (.eps cannot
1132 be supported due to the design of the PDF format; use regular TeX (DVI
1137 % Color manipulation macros based on pdfcolor.tex,
1138 % except using rgb instead of cmyk; the latter is said to render as a
1139 % very dark gray on-screen and a very dark halftone in print, instead
1141 \def\rgbDarkRed{0.50 0.09 0.12}
1142 \def\rgbBlack{0 0 0}
1144 % k sets the color for filling (usual text, etc.);
1145 % K sets the color for stroking (thin rules, e.g., normal _'s).
1146 \def\pdfsetcolor#1{\pdfliteral{#1 rg
#1 RG
}}
1148 % Set color, and create a mark which defines \thiscolor accordingly,
1149 % so that \makeheadline knows which color to restore.
1151 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1156 \def\maincolor{\rgbBlack}
1157 \pdfsetcolor{\maincolor}
1158 \edef\thiscolor{\maincolor}
1159 \def\lastcolordefs{}
1163 \line{\pdfsetcolor{\maincolor}\the\footline}%
1171 % Extract \thiscolor definition from the marks.
1173 % Typeset the headline with \maincolor, then restore the color.
1174 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1182 \pdfcatalog{/PageMode /UseOutlines
}
1184 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1185 \def\dopdfimage#1#2#3{%
1186 \def\pdfimagewidth{#2}\setbox0 =
\hbox{\ignorespaces #2}%
1187 \def\pdfimageheight{#3}\setbox2 =
\hbox{\ignorespaces #3}%
1189 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1190 % others). Let's try in that order, PDF first since if
1191 % someone has a scalable image, presumably better to use that than a
1193 \let\pdfimgext=
\empty
1195 \openin 1 #1.pdf
\ifeof 1
1196 \openin 1 #1.PDF
\ifeof 1
1197 \openin 1 #1.png
\ifeof 1
1198 \openin 1 #1.jpg
\ifeof 1
1199 \openin 1 #1.jpeg
\ifeof 1
1200 \openin 1 #1.JPG
\ifeof 1
1201 \errhelp =
\nopdfimagehelp
1202 \errmessage{Could not find image file
#1 for pdf
}%
1203 \else \gdef\pdfimgext{JPG
}%
1205 \else \gdef\pdfimgext{jpeg
}%
1207 \else \gdef\pdfimgext{jpg
}%
1209 \else \gdef\pdfimgext{png
}%
1211 \else \gdef\pdfimgext{PDF
}%
1213 \else \gdef\pdfimgext{pdf
}%
1218 % without \immediate, ancient pdftex seg faults when the same image is
1219 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1220 \ifnum\pdftexversion <
14
1223 \immediate\pdfximage
1225 \ifdim \wd0 >
0pt width
\pdfimagewidth \fi
1226 \ifdim \wd2 >
0pt height
\pdfimageheight \fi
1227 \ifnum\pdftexversion<
13
1232 \ifnum\pdftexversion <
14 \else
1233 \pdfrefximage \pdflastximage
1237 % We have to set dummies so commands such as @code, and characters
1238 % such as \, aren't expanded when present in a section title.
1241 \makevalueexpandable
1242 \def\pdfdestname{#1}%
1243 \txiescapepdf\pdfdestname
1244 \safewhatsit{\pdfdest name
{\pdfdestname} xyz
}%
1247 % used to mark target names; must be expandable.
1250 % by default, use a color that is dark enough to print on paper as
1251 % nearly black, but still distinguishable for online viewing.
1252 \def\urlcolor{\rgbDarkRed}
1253 \def\linkcolor{\rgbDarkRed}
1254 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1256 % Adding outlines to PDF; macros for calculating structure of outlines
1257 % come from Petr Olsak
1258 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1259 \else \csname#1\endcsname \fi}
1260 \def\advancenumber#1{\tempnum=
\expnumber{#1}\relax
1261 \advance\tempnum by
1
1262 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1264 % #1 is the section text, which is what will be displayed in the
1265 % outline by the pdf viewer. #2 is the pdf expression for the number
1266 % of subentries (or empty, for subsubsections). #3 is the node text,
1267 % which might be empty if this toc entry had no corresponding node.
1268 % #4 is the page number
1270 \def\dopdfoutline#1#2#3#4{%
1271 % Generate a link to the node text if that exists; else, use the
1272 % page number. We could generate a destination for the section
1273 % text in the case where a section has no node, but it doesn't
1274 % seem worth the trouble, since most documents are normally structured.
1275 \edef\pdfoutlinedest{#3}%
1276 \ifx\pdfoutlinedest\empty
1277 \def\pdfoutlinedest{#4}%
1279 \txiescapepdf\pdfoutlinedest
1282 % Also escape PDF chars in the display string.
1283 \edef\pdfoutlinetext{#1}%
1284 \txiescapepdf\pdfoutlinetext
1286 \pdfoutline goto name
{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1289 \def\pdfmakeoutlines{%
1291 % Read toc silently, to get counts of subentries for \pdfoutline.
1292 \def\partentry#
#1#
#2#
#3#
#4{}% ignore parts in the outlines
1293 \def\numchapentry#
#1#
#2#
#3#
#4{%
1294 \def\thischapnum{#
#2}%
1296 \def\thissubsecnum{0}%
1298 \def\numsecentry#
#1#
#2#
#3#
#4{%
1299 \advancenumber{chap
\thischapnum}%
1300 \def\thissecnum{#
#2}%
1301 \def\thissubsecnum{0}%
1303 \def\numsubsecentry#
#1#
#2#
#3#
#4{%
1304 \advancenumber{sec
\thissecnum}%
1305 \def\thissubsecnum{#
#2}%
1307 \def\numsubsubsecentry#
#1#
#2#
#3#
#4{%
1308 \advancenumber{subsec
\thissubsecnum}%
1310 \def\thischapnum{0}%
1312 \def\thissubsecnum{0}%
1314 % use \def rather than \let here because we redefine \chapentry et
1315 % al. a second time, below.
1316 \def\appentry{\numchapentry}%
1317 \def\appsecentry{\numsecentry}%
1318 \def\appsubsecentry{\numsubsecentry}%
1319 \def\appsubsubsecentry{\numsubsubsecentry}%
1320 \def\unnchapentry{\numchapentry}%
1321 \def\unnsecentry{\numsecentry}%
1322 \def\unnsubsecentry{\numsubsecentry}%
1323 \def\unnsubsubsecentry{\numsubsubsecentry}%
1326 % Read toc second time, this time actually producing the outlines.
1327 % The `-' means take the \expnumber as the absolute number of
1328 % subentries, which we calculated on our first read of the .toc above.
1330 % We use the node names as the destinations.
1331 \def\numchapentry#
#1#
#2#
#3#
#4{%
1332 \dopdfoutline{#
#1}{count-
\expnumber{chap#
#2}}{#
#3}{#
#4}}%
1333 \def\numsecentry#
#1#
#2#
#3#
#4{%
1334 \dopdfoutline{#
#1}{count-
\expnumber{sec#
#2}}{#
#3}{#
#4}}%
1335 \def\numsubsecentry#
#1#
#2#
#3#
#4{%
1336 \dopdfoutline{#
#1}{count-
\expnumber{subsec#
#2}}{#
#3}{#
#4}}%
1337 \def\numsubsubsecentry#
#1#
#2#
#3#
#4{% count is always zero
1338 \dopdfoutline{#
#1}{}{#
#3}{#
#4}}%
1340 % PDF outlines are displayed using system fonts, instead of
1341 % document fonts. Therefore we cannot use special characters,
1342 % since the encoding is unknown. For example, the eogonek from
1343 % Latin 2 (0xea) gets translated to a | character. Info from
1344 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1346 % TODO this right, we have to translate 8-bit characters to
1347 % their "best" equivalent, based on the @documentencoding. Too
1348 % much work for too little return. Just use the ASCII equivalents
1349 % we use for the index sort strings.
1353 % We can have normal brace characters in the PDF outlines, unlike
1354 % Texinfo index files. So set that up.
1355 \def\
{{\lbracecharliteral}%
1356 \def\
}{\rbracecharliteral}%
1357 \catcode`\\=
\active \otherbackslash
1358 \input \tocreadfilename
1361 {\catcode`
[=
1 \catcode`
]=
2
1362 \catcode`
{=
\other \catcode`
}=
\other
1363 \gdef\lbracecharliteral[{]%
1364 \gdef\rbracecharliteral[}]%
1367 \def\skipspaces#1{\def\PP{#1}\def\D{|
}%
1368 \ifx\PP\D\let\nextsp\relax
1369 \else\let\nextsp\skipspaces
1370 \addtokens{\filename}{\PP}%
1371 \advance\filenamelength by
1
1374 \def\getfilename#1{%
1376 % If we don't expand the argument now, \skipspaces will get
1377 % snagged on things like "@value{foo}".
1379 \expandafter\skipspaces\temp|
\relax
1381 \ifnum\pdftexversion <
14
1382 \let \startlink \pdfannotlink
1384 \let \startlink \pdfstartlink
1386 % make a live url in pdf output.
1389 % it seems we really need yet another set of dummies; have not
1390 % tried to figure out what each command should do in the context
1391 % of @url. for now, just make @/ a no-op, that's the only one
1392 % people have actually reported a problem with.
1394 \normalturnoffactive
1397 \makevalueexpandable
1398 % do we want to go so far as to use \indexnofonts instead of just
1399 % special-casing \var here?
1402 \leavevmode\setcolor{\urlcolor}%
1403 \startlink attr
{/Border
[0 0 0]}%
1404 user
{/Subtype /Link /A << /S /URI /URI (
#1) >>
}%
1406 \def\pdfgettoks#1.
{\setbox\boxA=
\hbox{\toksA=
{#1.
}\toksB=
{}\maketoks}}
1407 \def\addtokens#1#2{\edef\addtoks{\noexpand#1=
{\the#1#2}}\addtoks}
1408 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=
1\let\next=
\maketoks}
1409 \def\poptoks#1#2|ENDTOKS|
{\let\first=
#1\toksD=
{#1}\toksA=
{#2}}
1411 \expandafter\poptoks\the\toksA|ENDTOKS|
\relax
1413 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1414 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1415 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1417 \ifnum0=
\countA\else\makelink\fi
1418 \ifx\first.
\let\next=
\done\else
1420 \addtokens{\toksB}{\the\toksD}
1421 \ifx\first,
\addtokens{\toksB}{\space}\fi
1423 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1425 \def\makelink{\addtokens{\toksB}%
1426 {\noexpand\pdflink{\the\toksC}}\toksC=
{}\global\countA=
0}
1428 \startlink attr
{/Border
[0 0 0]} goto name
{\pdfmkpgn{#1}}
1429 \setcolor{\linkcolor}#1\endlink}
1430 \def\done{\edef\st{\global\noexpand\toksA=
{\the\toksB}}\st}
1433 \let\pdfmkdest =
\gobble
1434 \let\pdfurl =
\gobble
1435 \let\endlink =
\relax
1436 \let\setcolor =
\gobble
1437 \let\pdfsetcolor =
\gobble
1438 \let\pdfmakeoutlines =
\relax
1439 \fi % \ifx\pdfoutput
1444 % Change the current font style to #1, remembering it in \curfontstyle.
1445 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1446 % italics, not bold italics.
1448 \def\setfontstyle#1{%
1449 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1450 \csname ten
#1\endcsname % change the current font
1453 % Select #1 fonts with the current style.
1455 \def\selectfonts#1{\csname #1fonts
\endcsname \csname\curfontstyle\endcsname}
1457 \def\rm{\fam=
0 \setfontstyle{rm
}}
1458 \def\it{\fam=
\itfam \setfontstyle{it
}}
1459 \def\sl{\fam=
\slfam \setfontstyle{sl
}}
1460 \def\bf{\fam=
\bffam \setfontstyle{bf
}}\def\bfstylename{bf
}
1461 \def\tt{\fam=
\ttfam \setfontstyle{tt
}}
1463 % Unfortunately, we have to override this for titles and the like, since
1464 % in those cases "rm" is bold. Sigh.
1465 \def\rmisbold{\rm\def\curfontstyle{bf
}}
1467 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1468 % So we set up a \sf.
1470 \def\sf{\fam=
\sffam \setfontstyle{sf
}}
1471 \let\li =
\sf % Sometimes we call it \li, not \sf.
1473 % We don't need math for this font style.
1474 \def\ttsl{\setfontstyle{ttsl
}}
1477 % Set the baselineskip to #1, and the lineskip and strut size
1478 % correspondingly. There is no deep meaning behind these magic numbers
1479 % used as factors; they just match (closely enough) what Knuth defined.
1481 \def\lineskipfactor{.08333}
1482 \def\strutheightpercent{.70833}
1483 \def\strutdepthpercent {.29167}
1485 % can get a sort of poor man's double spacing by redefining this.
1486 \def\baselinefactor{1}
1488 \newdimen\textleading
1491 \normalbaselineskip =
\baselinefactor\dimen0
1492 \normallineskip =
\lineskipfactor\normalbaselineskip
1494 \setbox\strutbox =
\hbox{%
1495 \vrule width0pt height
\strutheightpercent\baselineskip
1496 depth
\strutdepthpercent \baselineskip
1500 % PDF CMaps. See also LaTeX's t1.cmap.
1502 % do nothing with this by default.
1503 \expandafter\let\csname cmapOT1
\endcsname\gobble
1504 \expandafter\let\csname cmapOT1IT
\endcsname\gobble
1505 \expandafter\let\csname cmapOT1TT
\endcsname\gobble
1507 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1508 % (\pdffontattr was introduced many years ago, but people still run
1509 % older pdftex's; it's easy to conditionalize, so we do.)
1510 \ifpdf \ifx\pdffontattr\thisisundefined \else
1512 \catcode`\^^M=
\active \def^^M
{^^J
}% Output line endings as the ^^J char.
1513 \catcode`\%=
12 \immediate\pdfobj stream
{%!PS-Adobe-3.0 Resource-CMap
1514 %%DocumentNeededResources: ProcSet (CIDInit)
1515 %%IncludeResource: ProcSet (CIDInit)
1516 %%BeginResource: CMap (TeX-OT1-0)
1517 %%Title: (TeX-OT1-0 TeX OT1 0)
1520 /CIDInit /ProcSet findresource begin
1528 /CMapName /TeX-OT1-
0 def
1530 1 begincodespacerange
1586 CMapName currentdict /CMap defineresource pop
1592 \expandafter\edef\csname cmapOT1
\endcsname#1{%
1593 \pdffontattr#1{/ToUnicode
\the\pdflastobj\space 0 R
}%
1598 \catcode`\^^M=
\active \def^^M
{^^J
}% Output line endings as the ^^J char.
1599 \catcode`\%=
12 \immediate\pdfobj stream
{%!PS-Adobe-3.0 Resource-CMap
1600 %%DocumentNeededResources: ProcSet (CIDInit)
1601 %%IncludeResource: ProcSet (CIDInit)
1602 %%BeginResource: CMap (TeX-OT1IT-0)
1603 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1606 /CIDInit /ProcSet findresource begin
1614 /CMapName /TeX-OT1IT-
0 def
1616 1 begincodespacerange
1674 CMapName currentdict /CMap defineresource pop
1680 \expandafter\edef\csname cmapOT1IT
\endcsname#1{%
1681 \pdffontattr#1{/ToUnicode
\the\pdflastobj\space 0 R
}%
1686 \catcode`\^^M=
\active \def^^M
{^^J
}% Output line endings as the ^^J char.
1687 \catcode`\%=
12 \immediate\pdfobj stream
{%!PS-Adobe-3.0 Resource-CMap
1688 %%DocumentNeededResources: ProcSet (CIDInit)
1689 %%IncludeResource: ProcSet (CIDInit)
1690 %%BeginResource: CMap (TeX-OT1TT-0)
1691 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1694 /CIDInit /ProcSet findresource begin
1702 /CMapName /TeX-OT1TT-
0 def
1704 1 begincodespacerange
1749 CMapName currentdict /CMap defineresource pop
1755 \expandafter\edef\csname cmapOT1TT
\endcsname#1{%
1756 \pdffontattr#1{/ToUnicode
\the\pdflastobj\space 0 R
}%
1761 % Set the font macro #1 to the font named \fontprefix#2.
1762 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1763 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
1771 \def\setfont#1#2#3#4#5{%
1772 \font#1=
\fontprefix#2#3 scaled
#4
1773 \csname cmap
#5\endcsname#1%
1775 % This is what gets called when #5 of \setfont is empty.
1780 % Use cm as the default font prefix.
1781 % To specify the font prefix, you must define \fontprefix
1782 % before you read in texinfo.tex.
1783 \ifx\fontprefix\thisisundefined
1786 % Support font families that don't use the same naming scheme as CM.
1788 \def\rmbshape{bx
} % where the normal face is bold
1793 \def\ttslshape{sltt
}
1803 % Definitions for a main text size of 11pt. (The default in Texinfo.)
1805 \def\definetextfontsizexi{%
1806 % Text fonts (11.2pt, magstep1).
1807 \def\textnominalsize{11pt
}
1808 \edef\mainmagstep{\magstephalf}
1809 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1
}
1810 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT
}
1811 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1
}
1812 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT
}
1813 \setfont\textsl\slshape{10}{\mainmagstep}{OT1
}
1814 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1
}
1815 \setfont\textsc\scshape{10}{\mainmagstep}{OT1
}
1816 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT
}
1817 \font\texti=cmmi10 scaled
\mainmagstep
1818 \font\textsy=cmsy10 scaled
\mainmagstep
1819 \def\textecsize{1095}
1821 % A few fonts for @defun names and args.
1822 \setfont\defbf\bfshape{10}{\magstep1}{OT1
}
1823 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT
}
1824 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT
}
1825 \def\df{\let\tentt=
\deftt \let\tenbf =
\defbf \let\tenttsl=
\defttsl \bf}
1827 % Fonts for indices, footnotes, small examples (9pt).
1828 \def\smallnominalsize{9pt
}
1829 \setfont\smallrm\rmshape{9}{1000}{OT1
}
1830 \setfont\smalltt\ttshape{9}{1000}{OT1TT
}
1831 \setfont\smallbf\bfshape{10}{900}{OT1
}
1832 \setfont\smallit\itshape{9}{1000}{OT1IT
}
1833 \setfont\smallsl\slshape{9}{1000}{OT1
}
1834 \setfont\smallsf\sfshape{9}{1000}{OT1
}
1835 \setfont\smallsc\scshape{10}{900}{OT1
}
1836 \setfont\smallttsl\ttslshape{10}{900}{OT1TT
}
1839 \def\smallecsize{0900}
1841 % Fonts for small examples (8pt).
1842 \def\smallernominalsize{8pt
}
1843 \setfont\smallerrm\rmshape{8}{1000}{OT1
}
1844 \setfont\smallertt\ttshape{8}{1000}{OT1TT
}
1845 \setfont\smallerbf\bfshape{10}{800}{OT1
}
1846 \setfont\smallerit\itshape{8}{1000}{OT1IT
}
1847 \setfont\smallersl\slshape{8}{1000}{OT1
}
1848 \setfont\smallersf\sfshape{8}{1000}{OT1
}
1849 \setfont\smallersc\scshape{10}{800}{OT1
}
1850 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT
}
1851 \font\smalleri=cmmi8
1852 \font\smallersy=cmsy8
1853 \def\smallerecsize{0800}
1855 % Fonts for title page (20.4pt):
1856 \def\titlenominalsize{20pt
}
1857 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1
}
1858 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT
}
1859 \setfont\titlesl\slbshape{10}{\magstep4}{OT1
}
1860 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT
}
1861 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT
}
1862 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1
}
1863 \let\titlebf=
\titlerm
1864 \setfont\titlesc\scbshape{10}{\magstep4}{OT1
}
1865 \font\titlei=cmmi12 scaled
\magstep3
1866 \font\titlesy=cmsy10 scaled
\magstep4
1867 \def\titleecsize{2074}
1869 % Chapter (and unnumbered) fonts (17.28pt).
1870 \def\chapnominalsize{17pt
}
1871 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1
}
1872 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT
}
1873 \setfont\chapsl\slbshape{10}{\magstep3}{OT1
}
1874 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT
}
1875 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT
}
1876 \setfont\chapsf\sfbshape{17}{1000}{OT1
}
1878 \setfont\chapsc\scbshape{10}{\magstep3}{OT1
}
1879 \font\chapi=cmmi12 scaled
\magstep2
1880 \font\chapsy=cmsy10 scaled
\magstep3
1881 \def\chapecsize{1728}
1883 % Section fonts (14.4pt).
1884 \def\secnominalsize{14pt
}
1885 \setfont\secrm\rmbshape{12}{\magstep1}{OT1
}
1886 \setfont\secit\itbshape{10}{\magstep2}{OT1IT
}
1887 \setfont\secsl\slbshape{10}{\magstep2}{OT1
}
1888 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT
}
1889 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT
}
1890 \setfont\secsf\sfbshape{12}{\magstep1}{OT1
}
1892 \setfont\secsc\scbshape{10}{\magstep2}{OT1
}
1893 \font\seci=cmmi12 scaled
\magstep1
1894 \font\secsy=cmsy10 scaled
\magstep2
1895 \def\sececsize{1440}
1897 % Subsection fonts (13.15pt).
1898 \def\ssecnominalsize{13pt
}
1899 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1
}
1900 \setfont\ssecit\itbshape{10}{1315}{OT1IT
}
1901 \setfont\ssecsl\slbshape{10}{1315}{OT1
}
1902 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT
}
1903 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT
}
1904 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1
}
1906 \setfont\ssecsc\scbshape{10}{1315}{OT1
}
1907 \font\sseci=cmmi12 scaled
\magstephalf
1908 \font\ssecsy=cmsy10 scaled
1315
1909 \def\ssececsize{1200}
1911 % Reduced fonts for @acro in text (10pt).
1912 \def\reducednominalsize{10pt
}
1913 \setfont\reducedrm\rmshape{10}{1000}{OT1
}
1914 \setfont\reducedtt\ttshape{10}{1000}{OT1TT
}
1915 \setfont\reducedbf\bfshape{10}{1000}{OT1
}
1916 \setfont\reducedit\itshape{10}{1000}{OT1IT
}
1917 \setfont\reducedsl\slshape{10}{1000}{OT1
}
1918 \setfont\reducedsf\sfshape{10}{1000}{OT1
}
1919 \setfont\reducedsc\scshape{10}{1000}{OT1
}
1920 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT
}
1921 \font\reducedi=cmmi10
1922 \font\reducedsy=cmsy10
1923 \def\reducedecsize{1000}
1925 \textleading =
13.2pt
% line spacing for 11pt CM
1926 \textfonts % reset the current fonts
1928 } % end of 11pt text font size definitions, \definetextfontsizexi
1931 % Definitions to make the main text be 10pt Computer Modern, with
1932 % section, chapter, etc., sizes following suit. This is for the GNU
1933 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1934 % future. Used with @smallbook, which sets the leading to 12pt.
1936 \def\definetextfontsizex{%
1937 % Text fonts (10pt).
1938 \def\textnominalsize{10pt
}
1939 \edef\mainmagstep{1000}
1940 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1
}
1941 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT
}
1942 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1
}
1943 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT
}
1944 \setfont\textsl\slshape{10}{\mainmagstep}{OT1
}
1945 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1
}
1946 \setfont\textsc\scshape{10}{\mainmagstep}{OT1
}
1947 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT
}
1948 \font\texti=cmmi10 scaled
\mainmagstep
1949 \font\textsy=cmsy10 scaled
\mainmagstep
1950 \def\textecsize{1000}
1952 % A few fonts for @defun names and args.
1953 \setfont\defbf\bfshape{10}{\magstephalf}{OT1
}
1954 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT
}
1955 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT
}
1956 \def\df{\let\tentt=
\deftt \let\tenbf =
\defbf \let\tenttsl=
\defttsl \bf}
1958 % Fonts for indices, footnotes, small examples (9pt).
1959 \def\smallnominalsize{9pt
}
1960 \setfont\smallrm\rmshape{9}{1000}{OT1
}
1961 \setfont\smalltt\ttshape{9}{1000}{OT1TT
}
1962 \setfont\smallbf\bfshape{10}{900}{OT1
}
1963 \setfont\smallit\itshape{9}{1000}{OT1IT
}
1964 \setfont\smallsl\slshape{9}{1000}{OT1
}
1965 \setfont\smallsf\sfshape{9}{1000}{OT1
}
1966 \setfont\smallsc\scshape{10}{900}{OT1
}
1967 \setfont\smallttsl\ttslshape{10}{900}{OT1TT
}
1970 \def\smallecsize{0900}
1972 % Fonts for small examples (8pt).
1973 \def\smallernominalsize{8pt
}
1974 \setfont\smallerrm\rmshape{8}{1000}{OT1
}
1975 \setfont\smallertt\ttshape{8}{1000}{OT1TT
}
1976 \setfont\smallerbf\bfshape{10}{800}{OT1
}
1977 \setfont\smallerit\itshape{8}{1000}{OT1IT
}
1978 \setfont\smallersl\slshape{8}{1000}{OT1
}
1979 \setfont\smallersf\sfshape{8}{1000}{OT1
}
1980 \setfont\smallersc\scshape{10}{800}{OT1
}
1981 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT
}
1982 \font\smalleri=cmmi8
1983 \font\smallersy=cmsy8
1984 \def\smallerecsize{0800}
1986 % Fonts for title page (20.4pt):
1987 \def\titlenominalsize{20pt
}
1988 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1
}
1989 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT
}
1990 \setfont\titlesl\slbshape{10}{\magstep4}{OT1
}
1991 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT
}
1992 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT
}
1993 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1
}
1994 \let\titlebf=
\titlerm
1995 \setfont\titlesc\scbshape{10}{\magstep4}{OT1
}
1996 \font\titlei=cmmi12 scaled
\magstep3
1997 \font\titlesy=cmsy10 scaled
\magstep4
1998 \def\titleecsize{2074}
2000 % Chapter fonts (14.4pt).
2001 \def\chapnominalsize{14pt
}
2002 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1
}
2003 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT
}
2004 \setfont\chapsl\slbshape{10}{\magstep2}{OT1
}
2005 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT
}
2006 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT
}
2007 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1
}
2009 \setfont\chapsc\scbshape{10}{\magstep2}{OT1
}
2010 \font\chapi=cmmi12 scaled
\magstep1
2011 \font\chapsy=cmsy10 scaled
\magstep2
2012 \def\chapecsize{1440}
2014 % Section fonts (12pt).
2015 \def\secnominalsize{12pt
}
2016 \setfont\secrm\rmbshape{12}{1000}{OT1
}
2017 \setfont\secit\itbshape{10}{\magstep1}{OT1IT
}
2018 \setfont\secsl\slbshape{10}{\magstep1}{OT1
}
2019 \setfont\sectt\ttbshape{12}{1000}{OT1TT
}
2020 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT
}
2021 \setfont\secsf\sfbshape{12}{1000}{OT1
}
2023 \setfont\secsc\scbshape{10}{\magstep1}{OT1
}
2025 \font\secsy=cmsy10 scaled
\magstep1
2026 \def\sececsize{1200}
2028 % Subsection fonts (10pt).
2029 \def\ssecnominalsize{10pt
}
2030 \setfont\ssecrm\rmbshape{10}{1000}{OT1
}
2031 \setfont\ssecit\itbshape{10}{1000}{OT1IT
}
2032 \setfont\ssecsl\slbshape{10}{1000}{OT1
}
2033 \setfont\ssectt\ttbshape{10}{1000}{OT1TT
}
2034 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT
}
2035 \setfont\ssecsf\sfbshape{10}{1000}{OT1
}
2037 \setfont\ssecsc\scbshape{10}{1000}{OT1
}
2040 \def\ssececsize{1000}
2042 % Reduced fonts for @acro in text (9pt).
2043 \def\reducednominalsize{9pt
}
2044 \setfont\reducedrm\rmshape{9}{1000}{OT1
}
2045 \setfont\reducedtt\ttshape{9}{1000}{OT1TT
}
2046 \setfont\reducedbf\bfshape{10}{900}{OT1
}
2047 \setfont\reducedit\itshape{9}{1000}{OT1IT
}
2048 \setfont\reducedsl\slshape{9}{1000}{OT1
}
2049 \setfont\reducedsf\sfshape{9}{1000}{OT1
}
2050 \setfont\reducedsc\scshape{10}{900}{OT1
}
2051 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT
}
2052 \font\reducedi=cmmi9
2053 \font\reducedsy=cmsy9
2054 \def\reducedecsize{0900}
2056 \divide\parskip by
2 % reduce space between paragraphs
2057 \textleading =
12pt
% line spacing for 10pt CM
2058 \textfonts % reset the current fonts
2060 } % end of 10pt text font size definitions, \definetextfontsizex
2063 % We provide the user-level command
2065 % (or 11) to redefine the text font size. pt is assumed.
2071 \parseargdef\fonttextsize{%
2072 \def\textsizearg{#1}%
2073 %\wlog{doing @fonttextsize \textsizearg}%
2075 % Set \globaldefs so that documents can use this inside @tex, since
2076 % makeinfo 4.8 does not support it, but we need it nonetheless.
2078 \begingroup \globaldefs=
1
2079 \ifx\textsizearg\xword \definetextfontsizex
2080 \else \ifx\textsizearg\xiword \definetextfontsizexi
2083 \errmessage{@fonttextsize only supports `
10' or `
11', not `
\textsizearg'
}
2089 % In order for the font changes to affect most math symbols and letters,
2090 % we have to define the \textfont of the standard families. Since
2091 % texinfo doesn't allow for producing subscripts and superscripts except
2092 % in the main text, we don't bother to reset \scriptfont and
2093 % \scriptscriptfont (which would also require loading a lot more fonts).
2095 \def\resetmathfonts{%
2096 \textfont0=
\tenrm \textfont1=
\teni \textfont2=
\tensy
2097 \textfont\itfam=
\tenit \textfont\slfam=
\tensl \textfont\bffam=
\tenbf
2098 \textfont\ttfam=
\tentt \textfont\sffam=
\tensf
2101 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2102 % of just \STYLE. We do this because \STYLE needs to also set the
2103 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2104 % \tenSTYLE to set the current font.
2106 % Each font-changing command also sets the names \lsize (one size lower)
2107 % and \lllsize (three sizes lower). These relative commands are used in
2108 % the LaTeX logo and acronyms.
2110 % This all needs generalizing, badly.
2113 \let\tenrm=
\textrm \let\tenit=
\textit \let\tensl=
\textsl
2114 \let\tenbf=
\textbf \let\tentt=
\texttt \let\smallcaps=
\textsc
2115 \let\tensf=
\textsf \let\teni=
\texti \let\tensy=
\textsy
2116 \let\tenttsl=
\textttsl
2117 \def\curfontsize{text
}%
2118 \def\lsize{reduced
}\def\lllsize{smaller
}%
2119 \resetmathfonts \setleading{\textleading}}
2121 \let\tenrm=
\titlerm \let\tenit=
\titleit \let\tensl=
\titlesl
2122 \let\tenbf=
\titlebf \let\tentt=
\titlett \let\smallcaps=
\titlesc
2123 \let\tensf=
\titlesf \let\teni=
\titlei \let\tensy=
\titlesy
2124 \let\tenttsl=
\titlettsl
2125 \def\curfontsize{title
}%
2126 \def\lsize{chap
}\def\lllsize{subsec
}%
2127 \resetmathfonts \setleading{27pt
}}
2128 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2130 \let\tenrm=
\chaprm \let\tenit=
\chapit \let\tensl=
\chapsl
2131 \let\tenbf=
\chapbf \let\tentt=
\chaptt \let\smallcaps=
\chapsc
2132 \let\tensf=
\chapsf \let\teni=
\chapi \let\tensy=
\chapsy
2133 \let\tenttsl=
\chapttsl
2134 \def\curfontsize{chap
}%
2135 \def\lsize{sec
}\def\lllsize{text
}%
2136 \resetmathfonts \setleading{19pt
}}
2138 \let\tenrm=
\secrm \let\tenit=
\secit \let\tensl=
\secsl
2139 \let\tenbf=
\secbf \let\tentt=
\sectt \let\smallcaps=
\secsc
2140 \let\tensf=
\secsf \let\teni=
\seci \let\tensy=
\secsy
2141 \let\tenttsl=
\secttsl
2142 \def\curfontsize{sec
}%
2143 \def\lsize{subsec
}\def\lllsize{reduced
}%
2144 \resetmathfonts \setleading{16pt
}}
2146 \let\tenrm=
\ssecrm \let\tenit=
\ssecit \let\tensl=
\ssecsl
2147 \let\tenbf=
\ssecbf \let\tentt=
\ssectt \let\smallcaps=
\ssecsc
2148 \let\tensf=
\ssecsf \let\teni=
\sseci \let\tensy=
\ssecsy
2149 \let\tenttsl=
\ssecttsl
2150 \def\curfontsize{ssec
}%
2151 \def\lsize{text
}\def\lllsize{small
}%
2152 \resetmathfonts \setleading{15pt
}}
2153 \let\subsubsecfonts =
\subsecfonts
2155 \let\tenrm=
\reducedrm \let\tenit=
\reducedit \let\tensl=
\reducedsl
2156 \let\tenbf=
\reducedbf \let\tentt=
\reducedtt \let\reducedcaps=
\reducedsc
2157 \let\tensf=
\reducedsf \let\teni=
\reducedi \let\tensy=
\reducedsy
2158 \let\tenttsl=
\reducedttsl
2159 \def\curfontsize{reduced
}%
2160 \def\lsize{small
}\def\lllsize{smaller
}%
2161 \resetmathfonts \setleading{10.5pt
}}
2163 \let\tenrm=
\smallrm \let\tenit=
\smallit \let\tensl=
\smallsl
2164 \let\tenbf=
\smallbf \let\tentt=
\smalltt \let\smallcaps=
\smallsc
2165 \let\tensf=
\smallsf \let\teni=
\smalli \let\tensy=
\smallsy
2166 \let\tenttsl=
\smallttsl
2167 \def\curfontsize{small
}%
2168 \def\lsize{smaller
}\def\lllsize{smaller
}%
2169 \resetmathfonts \setleading{10.5pt
}}
2171 \let\tenrm=
\smallerrm \let\tenit=
\smallerit \let\tensl=
\smallersl
2172 \let\tenbf=
\smallerbf \let\tentt=
\smallertt \let\smallcaps=
\smallersc
2173 \let\tensf=
\smallersf \let\teni=
\smalleri \let\tensy=
\smallersy
2174 \let\tenttsl=
\smallerttsl
2175 \def\curfontsize{smaller
}%
2176 \def\lsize{smaller
}\def\lllsize{smaller
}%
2177 \resetmathfonts \setleading{9.5pt
}}
2179 % Fonts for short table of contents.
2180 \setfont\shortcontrm\rmshape{12}{1000}{OT1
}
2181 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1
} % no cmb12
2182 \setfont\shortcontsl\slshape{12}{1000}{OT1
}
2183 \setfont\shortconttt\ttshape{12}{1000}{OT1TT
}
2185 % Define these just so they can be easily changed for other fonts.
2186 \def\angleleft{$
\langle$
}
2187 \def\angleright{$
\rangle$
}
2189 % Set the fonts to use with the @small... environments.
2190 \let\smallexamplefonts =
\smallfonts
2192 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2193 % can fit this many characters:
2194 % 8.5x11=86 smallbook=72 a4=90 a5=69
2195 % If we use \scriptfonts (8pt), then we can fit this many characters:
2196 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2197 % For me, subjectively, the few extra characters that fit aren't worth
2198 % the additional smallness of 8pt. So I'm making the default 9pt.
2200 % By the way, for comparison, here's what fits with @example (10pt):
2201 % 8.5x11=71 smallbook=60 a4=75 a5=58
2204 % Set up the default fonts, so we can use them for creating boxes.
2206 \definetextfontsizexi
2211 % Check if we are currently using a typewriter font. Since all the
2212 % Computer Modern typewriter fonts have zero interword stretch (and
2213 % shrink), and it is reasonable to expect all typewriter fonts to have
2214 % this property, we can check that font parameter.
2216 \def\ifmonospace{\ifdim\fontdimen3\font=
0pt
}
2218 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2219 % define and register \INITMACRO to be called on markup style changes.
2220 % \INITMACRO can check \currentmarkupstyle for the innermost
2221 % style and the set of \ifmarkupSTYLE switches for all styles
2222 % currently in effect.
2226 %\newif\ifmarkupfile % @file == @samp.
2227 %\newif\ifmarkupoption % @option == @samp.
2230 %\newif\ifmarkupenv % @env == @code.
2231 %\newif\ifmarkupcommand % @command == @code.
2232 \newif\ifmarkuptex % @tex (and part of @math, for now).
2233 \newif\ifmarkupexample
2235 \newif\ifmarkupverbatim
2237 \let\currentmarkupstyle\empty
2239 \def\setupmarkupstyle#1{%
2240 \csname markup
#1true
\endcsname
2241 \def\currentmarkupstyle{#1}%
2245 \let\markupstylesetup\empty
2247 \def\defmarkupstylesetup#1{%
2248 \expandafter\def\expandafter\markupstylesetup
2249 \expandafter{\markupstylesetup #1}%
2253 % Markup style setup for left and right quotes.
2254 \defmarkupstylesetup\markupsetuplq{%
2255 \expandafter\let\expandafter \temp
2256 \csname markupsetuplq
\currentmarkupstyle\endcsname
2257 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2260 \defmarkupstylesetup\markupsetuprq{%
2261 \expandafter\let\expandafter \temp
2262 \csname markupsetuprq
\currentmarkupstyle\endcsname
2263 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2270 \gdef\markupsetuplqdefault{\let`
\lq}
2271 \gdef\markupsetuprqdefault{\let'
\rq}
2273 \gdef\markupsetcodequoteleft{\let`
\codequoteleft}
2274 \gdef\markupsetcodequoteright{\let'
\codequoteright}
2277 \let\markupsetuplqcode \markupsetcodequoteleft
2278 \let\markupsetuprqcode \markupsetcodequoteright
2280 \let\markupsetuplqexample \markupsetcodequoteleft
2281 \let\markupsetuprqexample \markupsetcodequoteright
2283 \let\markupsetuplqkbd \markupsetcodequoteleft
2284 \let\markupsetuprqkbd \markupsetcodequoteright
2286 \let\markupsetuplqsamp \markupsetcodequoteleft
2287 \let\markupsetuprqsamp \markupsetcodequoteright
2289 \let\markupsetuplqverb \markupsetcodequoteleft
2290 \let\markupsetuprqverb \markupsetcodequoteright
2292 \let\markupsetuplqverbatim \markupsetcodequoteleft
2293 \let\markupsetuprqverbatim \markupsetcodequoteright
2295 % Allow an option to not use regular directed right quote/apostrophe
2296 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2297 % The undirected quote is ugly, so don't make it the default, but it
2298 % works for pasting with more pdf viewers (at least evince), the
2299 % lilypond developers report. xpdf does work with the regular 0x27.
2301 \def\codequoteright{%
2302 \expandafter\ifx\csname SETtxicodequoteundirected
\endcsname\relax
2303 \expandafter\ifx\csname SETcodequoteundirected
\endcsname\relax
2309 % and a similar option for the left quote char vs. a grave accent.
2310 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2311 % the code environments to do likewise.
2313 \def\codequoteleft{%
2314 \expandafter\ifx\csname SETtxicodequotebacktick
\endcsname\relax
2315 \expandafter\ifx\csname SETcodequotebacktick
\endcsname\relax
2316 % [Knuth] pp. 380,381,391
2317 % \relax disables Spanish ligatures ?` and !` of \tt font.
2323 % Commands to set the quote options.
2325 \parseargdef\codequoteundirected{%
2328 \expandafter\let\csname SETtxicodequoteundirected
\endcsname
2330 \else\ifx\temp\offword
2331 \expandafter\let\csname SETtxicodequoteundirected
\endcsname
2334 \errhelp =
\EMsimple
2335 \errmessage{Unknown @codequoteundirected value `
\temp', must be on|off
}%
2339 \parseargdef\codequotebacktick{%
2342 \expandafter\let\csname SETtxicodequotebacktick
\endcsname
2344 \else\ifx\temp\offword
2345 \expandafter\let\csname SETtxicodequotebacktick
\endcsname
2348 \errhelp =
\EMsimple
2349 \errmessage{Unknown @codequotebacktick value `
\temp', must be on|off
}%
2353 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2354 \def\noligaturesquoteleft{\relax\lq}
2356 % Count depth in font-changes, for error checks
2357 \newcount\fontdepth \fontdepth=
0
2361 % #1 is the font command (\sl or \it), #2 is the text to slant.
2362 % If we are in a monospaced environment, however, 1) always use \ttsl,
2363 % and 2) do not add an italic correction.
2364 \def\dosmartslant#1#2{%
2366 {{\ttsl #2}\let\next=
\relax}%
2367 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2370 \def\smartslanted{\dosmartslant\sl}
2371 \def\smartitalic{\dosmartslant\it}
2373 % Output an italic correction unless \next (presumed to be the following
2374 % character) is such as not to need one.
2375 \def\smartitaliccorrection{%
2384 % Unconditional use \ttsl, and no ic. @var is set to this for defuns.
2385 \def\ttslanted#1{{\ttsl #1}}
2387 % @cite is like \smartslanted except unconditionally use \sl. We never want
2388 % ttsl for book titles, do we?
2389 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2393 \let\saveaftersmartic =
\aftersmartic
2394 \def\aftersmartic{\null\let\aftersmartic=
\saveaftersmartic}%
2399 \let\slanted=
\smartslanted
2400 \let\dfn=
\smartslanted
2401 \let\emph=
\smartitalic
2403 % Explicit font changes: @r, @sc, undocumented @ii.
2404 \def\r#1{{\rm #1}} % roman font
2405 \def\sc#1{{\smallcaps#1}} % smallcaps font
2406 \def\ii#1{{\it #1}} % italic font
2408 % @b, explicit bold. Also @strong.
2412 % @sansserif, explicit sans.
2413 \def\sansserif#1{{\sf #1}}
2415 % We can't just use \exhyphenpenalty, because that only has effect at
2416 % the end of a paragraph. Restore normal hyphenation at the end of the
2417 % group within which \nohyphenation is presumably called.
2419 \def\nohyphenation{\hyphenchar\font = -
1 \aftergroup\restorehyphenation}
2420 \def\restorehyphenation{\hyphenchar\font = `-
}
2422 % Set sfcode to normal for the chars that usually have another value.
2423 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2424 % sometimes \x has an active definition that messes things up.
2427 \def\plainfrenchspacing{%
2428 \sfcode\dotChar =\@m
\sfcode\questChar=\@m
\sfcode\exclamChar=\@m
2429 \sfcode\colonChar=\@m
\sfcode\semiChar =\@m
\sfcode\commaChar =\@m
2430 \def\endofsentencespacefactor{1000}% for @. and friends
2432 \def\plainnonfrenchspacing{%
2433 \sfcode`\
.3000\sfcode`\?
3000\sfcode`\!
3000
2434 \sfcode`\:
2000\sfcode`\;
1500\sfcode`\,
1250
2435 \def\endofsentencespacefactor{3000}% for @. and friends
2438 \def\endofsentencespacefactor{3000}% default
2440 % @t, explicit typewriter.
2442 {\tt \rawbackslash \plainfrenchspacing #1}%
2447 \def\samp#1{{\setupmarkupstyle{samp
}\lq\tclose{#1}\rq\null}}
2449 % @indicateurl is \samp, that is, with quotes.
2450 \let\indicateurl=
\samp
2452 % @code (and similar) prints in typewriter, but with spaces the same
2453 % size as normal in the surrounding text, without hyphenation, etc.
2454 % This is a subroutine for that.
2457 % Change normal interword space to be same as for the current font.
2458 \spaceskip =
\fontdimen2\font
2460 % Switch to typewriter.
2463 % But `\ ' produces the large typewriter interword space.
2464 \def\
{{\spaceskip =
0pt
{} }}%
2466 % Turn off hyphenation.
2473 \null % reset spacefactor to 1000
2476 % We *must* turn on hyphenation at `-' and `_' in @code.
2477 % Otherwise, it is too hard to avoid overfull hboxes
2478 % in the Emacs manual, the Library manual, etc.
2480 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2481 % both hyphenation at - and hyphenation within words.
2482 % We must therefore turn them both off (\tclose does that)
2483 % and arrange explicitly to hyphenate at a dash.
2486 \catcode`\-=
\active \catcode`
\_=
\active
2487 \catcode`\'=
\active \catcode`\`=
\active
2488 \global\let'=
\rq \global\let`=
\lq % default definitions
2490 \global\def\code{\begingroup
2491 \setupmarkupstyle{code
}%
2492 % The following should really be moved into \setupmarkupstyle handlers.
2493 \catcode\dashChar=
\active \catcode\underChar=
\active
2505 \def\codex #1{\tclose{#1}\endgroup}
2508 \def\codedash{-
\discretionary{}{}{}}
2510 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2511 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2512 % will therefore expand the active definition of _, which is us
2513 % (inside @code that is), therefore an endless loop.
2515 \mathchar"
075F
% class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2516 \else\normalunderscore \fi
2517 \discretionary{}{}{}}%
2521 % An additional complication: the above will allow breaks after, e.g.,
2522 % each of the four underscores in __typeof__. This is undesirable in
2523 % some manuals, especially if they don't have long identifiers in
2524 % general. @allowcodebreaks provides a way to control this.
2526 \newif\ifallowcodebreaks \allowcodebreakstrue
2528 \def\keywordtrue{true
}
2529 \def\keywordfalse{false
}
2531 \parseargdef\allowcodebreaks{%
2533 \ifx\txiarg\keywordtrue
2534 \allowcodebreakstrue
2535 \else\ifx\txiarg\keywordfalse
2536 \allowcodebreaksfalse
2538 \errhelp =
\EMsimple
2539 \errmessage{Unknown @allowcodebreaks option `
\txiarg', must be true|false
}%
2543 % For @command, @env, @file, @option quotes seem unnecessary,
2544 % so use \code rather than \samp.
2550 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2551 % second argument specifying the text to display and an optional third
2552 % arg as text to display instead of (rather than in addition to) the url
2553 % itself. First (mandatory) arg is the url.
2554 % (This \urefnobreak definition isn't used now, leaving it for a while
2556 \def\urefnobreak#1{\dourefnobreak #1,,,
\finish}
2557 \def\dourefnobreak#1,
#2,
#3,
#4\finish{\begingroup
2560 \setbox0 =
\hbox{\ignorespaces #3}%
2562 \unhbox0 % third arg given, show only that
2564 \setbox0 =
\hbox{\ignorespaces #2}%
2567 \unhbox0 % PDF: 2nd arg given, show only it
2569 \unhbox0\ (
\code{#1})
% DVI: 2nd arg given, show both it and url
2572 \code{#1}% only url given, so show it
2578 % This \urefbreak definition is the active one.
2579 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2580 \let\uref=
\urefbreak
2581 \def\dourefbreak#1{\urefbreakfinish #1,,,
\finish}
2582 \def\urefbreakfinish#1,
#2,
#3,
#4\finish{% doesn't work in @example
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\ (
\urefcode{#1})
% DVI: 2nd arg given, show both it and url
2597 \urefcode{#1}% only url given, so show it
2603 % Allow line breaks around only a few characters (only).
2605 \catcode\ampChar=
\active \catcode\dotChar=
\active
2606 \catcode\hashChar=
\active \catcode\questChar=
\active
2607 \catcode\slashChar=
\active
2612 \global\def\urefcode{\begingroup
2613 \setupmarkupstyle{code
}%
2623 % By default, they are just regular characters.
2624 \global\def&
{\normalamp}
2625 \global\def.
{\normaldot}
2626 \global\def#
{\normalhash}
2627 \global\def?
{\normalquest}
2628 \global\def/
{\normalslash}
2631 % we put a little stretch before and after the breakable chars, to help
2632 % line breaking of long url's. The unequal skips make look better in
2633 % cmtt at least, especially for dots.
2634 \def\urefprestretch{\urefprebreak \hskip0pt plus
.13em
}
2635 \def\urefpoststretch{\urefpostbreak \hskip0pt plus
.1em
}
2637 \def\urefcodeamp{\urefprestretch \&
\urefpoststretch}
2638 \def\urefcodedot{\urefprestretch .
\urefpoststretch}
2639 \def\urefcodehash{\urefprestretch \#
\urefpoststretch}
2640 \def\urefcodequest{\urefprestretch ?
\urefpoststretch}
2641 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2644 \global\def\urefcodeslashfinish{%
2645 \urefprestretch \slashChar
2646 % Allow line break only after the final / in a sequence of
2647 % slashes, to avoid line break between the slashes in http://.
2648 \ifx\next/
\else \urefpoststretch \fi
2652 % One more complication: by default we'll break after the special
2653 % characters, but some people like to break before the special chars, so
2654 % allow that. Also allow no breaking at all, for manual control.
2656 \parseargdef\urefbreakstyle{%
2658 \ifx\txiarg\wordnone
2659 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2660 \else\ifx\txiarg\wordbefore
2661 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2662 \else\ifx\txiarg\wordafter
2663 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2665 \errhelp =
\EMsimple
2666 \errmessage{Unknown @urefbreakstyle setting `
\txiarg'
}%
2669 \def\wordafter{after
}
2670 \def\wordbefore{before
}
2673 \urefbreakstyle after
2675 % @url synonym for @uref, since that's how everyone uses it.
2679 % rms does not like angle brackets --karl, 17may97.
2680 % So now @email is just like @uref, unless we are pdf.
2682 %\def\email#1{\angleleft{\tt #1}\angleright}
2684 \def\email#1{\doemail#1,,
\finish}
2685 \def\doemail#1,
#2,
#3\finish{\begingroup
2688 \setbox0 =
\hbox{\ignorespaces #2}%
2689 \ifdim\wd0>
0pt
\unhbox0\else\code{#1}\fi
2696 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2697 % `example' (@kbd uses ttsl only inside of @example and friends),
2698 % or `code' (@kbd uses normal tty font always).
2699 \parseargdef\kbdinputstyle{%
2701 \ifx\txiarg\worddistinct
2702 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2703 \else\ifx\txiarg\wordexample
2704 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2705 \else\ifx\txiarg\wordcode
2706 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2708 \errhelp =
\EMsimple
2709 \errmessage{Unknown @kbdinputstyle setting `
\txiarg'
}%
2712 \def\worddistinct{distinct
}
2713 \def\wordexample{example
}
2716 % Default is `distinct'.
2717 \kbdinputstyle distinct
2719 % @kbd is like @code, except that if the argument is just one @key command,
2720 % then @kbd has no effect.
2721 \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??
\par}}
2724 \def\kbdsub#1#2#3\par{%
2725 \def\one{#1}\def\three{#3}\def\threex{??
}%
2726 \ifx\one\xkey\ifx\threex\three \key{#2}%
2727 \else{\tclose{\kbdfont\setupmarkupstyle{kbd
}\look}}\fi
2728 \else{\tclose{\kbdfont\setupmarkupstyle{kbd
}\look}}\fi
2731 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2732 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2734 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2735 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2736 % \vbox{\hrule\kern-0.4pt
2737 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2738 % \kern-0.4pt\hrule}%
2739 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2741 % definition of @key with no lozenge. If the current font is already
2742 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2743 % if it isn't monospace, then use \tt.
2745 \def\key#1{{\setupmarkupstyle{key
}%
2747 \ifmonospace\else\tt\fi
2750 % @clicksequence{File @click{} Open ...}
2751 \def\clicksequence#1{\begingroup #1\endgroup}
2753 % @clickstyle @arrow (by default)
2754 \parseargdef\clickstyle{\def\click{#1}}
2757 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2758 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2760 \def\dmn#1{\thinspace #1}
2762 % @l was never documented to mean ``switch to the Lisp font'',
2763 % and it is not used as such in any manual I can find. We need it for
2764 % Polish suppressed-l. --karl, 22sep96.
2765 %\def\l#1{{\li #1}\null}
2767 % @acronym for "FBI", "NATO", and the like.
2768 % We print this one point size smaller, since it's intended for
2771 \def\acronym#1{\doacronym #1,,
\finish}
2772 \def\doacronym#1,
#2,
#3\finish{%
2773 {\selectfonts\lsize #1}%
2775 \ifx\temp\empty \else
2776 \space (
{\unsepspaces \ignorespaces \temp \unskip})
%
2778 \null % reset \spacefactor=1000
2781 % @abbr for "Comput. J." and the like.
2782 % No font change, but don't do end-of-sentence spacing.
2784 \def\abbr#1{\doabbr #1,,
\finish}
2785 \def\doabbr#1,
#2,
#3\finish{%
2786 {\plainfrenchspacing #1}%
2788 \ifx\temp\empty \else
2789 \space (
{\unsepspaces \ignorespaces \temp \unskip})
%
2791 \null % reset \spacefactor=1000
2794 % @asis just yields its argument. Used with @table, for example.
2798 % @math outputs its argument in math mode.
2800 % One complication: _ usually means subscripts, but it could also mean
2801 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2802 % _ active, and distinguish by seeing if the current family is \slfam,
2803 % which is what @var uses.
2805 \catcode`
\_ =
\active
2806 \gdef\mathunderscore{%
2808 \def_{\ifnum\fam=
\slfam \_\else\sb\fi}%
2811 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2812 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2813 % particular reason), but this is not advertised and we don't care.
2815 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2816 \def\mathbackslash{\ifnum\fam=
\ttfam \mathchar"
075C
\else\backslash \fi}
2821 \let\\ =
\mathbackslash
2823 % make the texinfo accent commands work in math mode
2835 \def\finishmath#1{#1$
\endgroup} % Close the group opened by \tex.
2837 % Some active characters (such as <) are spaced differently in math.
2838 % We have to reset their definitions in case the @math was an argument
2839 % to a command which sets the catcodes (such as @item or @section).
2842 \catcode`^ =
\active
2843 \catcode`< =
\active
2844 \catcode`> =
\active
2845 \catcode`+ =
\active
2846 \catcode`' =
\active
2852 \let' =
\ptexquoteright
2856 % ctrl is no longer a Texinfo command, but leave this definition for fun.
2857 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2859 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
2860 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
2861 % except specified as a normal braced arg, so no newlines to worry about.
2863 \def\outfmtnametex{tex
}
2865 \long\def\inlinefmt#1{\doinlinefmt #1,
\finish}
2866 \long\def\doinlinefmt#1,
#2,
\finish{%
2867 \def\inlinefmtname{#1}%
2868 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
2870 % For raw, must switch into @tex before parsing the argument, to avoid
2871 % setting catcodes prematurely. Doing it this way means that, for
2872 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
2873 % ignored. But this isn't important because if people want a literal
2874 % *right* brace they would have to use a command anyway, so they may as
2875 % well use a command to get a left brace too. We could re-use the
2876 % delimiter character idea from \verb, but it seems like overkill.
2878 \long\def\inlineraw{\tex \doinlineraw}
2879 \long\def\doinlineraw#1{\doinlinerawtwo #1,
\finish}
2880 \def\doinlinerawtwo#1,
#2,
\finish{%
2881 \def\inlinerawname{#1}%
2882 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
2883 \endgroup % close group opened by \tex.
2890 % @@ prints an @, as does @atchar{}.
2894 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
2895 % Unless we're in typewriter, use \ecfont because the CM text fonts do
2896 % not have braces, and we don't want to switch into math.
2897 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2898 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2899 \let\
{=
\mylbrace \let\lbracechar=\
{
2900 \let\
}=
\myrbrace \let\rbracechar=\
}
2902 % Definitions to produce \{ and \} commands for indices,
2903 % and @{ and @} for the aux/toc files.
2904 \catcode`\
{ =
\other \catcode`\
} =
\other
2905 \catcode`\
[ =
1 \catcode`\
] =
2
2906 \catcode`\! =
0 \catcode`\\ =
\other
2907 !gdef!lbracecmd
[\
{]%
2908 !gdef!rbracecmd
[\
}]%
2909 !gdef!lbraceatcmd
[@
{]%
2910 !gdef!rbraceatcmd
[@
}]%
2913 % @comma{} to avoid , parsing problems.
2916 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2917 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2919 \let\dotaccent =
\ptexdot
2920 \def\ringaccent#1{{\accent23 #1}}
2921 \let\tieaccent =
\ptext
2922 \let\ubaraccent =
\ptexb
2923 \let\udotaccent =
\d
2925 % Other special characters: @questiondown @exclamdown @ordf @ordm
2926 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2927 \def\questiondown{?`
}
2929 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a
}}}
2930 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o
}}}
2932 % Dotless i and dotless j, used for accents.
2937 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2938 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2939 \else \errmessage{@dotless can be used only with i or j
}%
2943 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2944 % period following counts as ending a sentence. (Idea found in latex.)
2946 \edef\TeX{\TeX \spacefactor=
1000 }
2948 % @LaTeX{} logo. Not quite the same results as the definition in
2949 % latex.ltx, since we use a different font for the raised A; it's most
2950 % convenient for us to use an explicitly smaller font, rather than using
2951 % the \scriptstyle font (since we don't reset \scriptstyle and
2952 % \scriptscriptstyle).
2957 \vbox to
\ht0{\hbox{%
2958 \ifx\textnominalsize\xwordpt
2959 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
2960 % Revert to plain's \scriptsize, which is 7pt.
2961 \count255=
\the\fam $
\fam\count255 \scriptstyle A$
%
2963 % For 11pt, we can use our lllsize.
2964 \selectfonts\lllsize A
%
2973 % Some math mode symbols.
2974 \def\bullet{$
\ptexbullet$
}
2975 \def\geq{\ifmmode \ge\else $
\ge$
\fi}
2976 \def\leq{\ifmmode \le\else $
\le$
\fi}
2977 \def\minus{\ifmmode -
\else $-$
\fi}
2979 % @dots{} outputs an ellipsis using the current font.
2980 % We do .5em per period so that it has the same spacing in the cm
2981 % typewriter fonts as three actual period characters; on the other hand,
2982 % in other typewriter fonts three periods are wider than 1.5em. So do
2983 % whichever is larger.
2987 \setbox0=
\hbox{...
}% get width of three periods
2994 \hskip 0pt plus
.25fil
2995 .
\hskip 0pt plus1fil
2996 .
\hskip 0pt plus1fil
2997 .
\hskip 0pt plus
.5fil
3001 % @enddots{} is an end-of-sentence ellipsis.
3005 \spacefactor=
\endofsentencespacefactor
3008 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3010 % Since these characters are used in examples, they should be an even number of
3011 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3014 \def\arrow{\leavevmode\raise.05ex
\hbox to
1em
{\hfil$
\rightarrow$
\hfil}}
3015 \def\result{\leavevmode\raise.05ex
\hbox to
1em
{\hfil$
\Rightarrow$
\hfil}}
3016 \def\expansion{\leavevmode\hbox to
1em
{\hfil$
\mapsto$
\hfil}}
3017 \def\print{\leavevmode\lower.1ex
\hbox to
1em
{\hfil$
\dashv$
\hfil}}
3018 \def\equiv{\leavevmode\hbox to
1em
{\hfil$
\ptexequiv$
\hfil}}
3020 % The @error{} command.
3021 % Adapted from the TeXbook's \boxit.
3025 {\tentt \global\dimen0 =
3em
}% Width of the box.
3026 \dimen2 =
.55pt
% Thickness of rules
3027 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3028 \setbox0 =
\hbox{\kern-
.75pt
\reducedsf \putworderror\kern-
1.5pt
}
3030 \setbox\errorbox=
\hbox to
\dimen0{\hfil
3031 \hsize =
\dimen0 \advance\hsize by -
5.8pt
% Space to left+right.
3032 \advance\hsize by -
2\dimen2 % Rules.
3034 \hrule height
\dimen2
3035 \hbox{\vrule width
\dimen2 \kern3pt % Space to left of text.
3036 \vtop{\kern2.4pt
\box0 \kern2.4pt
}% Space above/below.
3037 \kern3pt\vrule width
\dimen2}% Space to right.
3038 \hrule height
\dimen2}
3041 \def\error{\leavevmode\lower.7ex
\copy\errorbox}
3043 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3045 \def\pounds{{\it\$
}}
3047 % @euro{} comes from a separate font, depending on the current style.
3048 % We use the free feym* fonts from the eurosym package by Henrik
3049 % Theiling, which support regular, slanted, bold and bold slanted (and
3050 % "outlined" (blackboard board, sort of) versions, which we don't need).
3051 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3053 % Although only regular is the truly official Euro symbol, we ignore
3054 % that. The Euro is designed to be slightly taller than the regular
3060 % feybo - bold slanted
3062 % There is no good (free) typewriter version, to my knowledge.
3063 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3066 % Also doesn't work in math. Do we need to do math with euro symbols?
3070 \def\euro{{\eurofont e
}}
3072 % We set the font at each command, rather than predefining it in
3073 % \textfonts and the other font-switching commands, so that
3074 % installations which never need the symbol don't have to have the
3077 % There is only one designed size (nominal 10pt), so we always scale
3078 % that to the current nominal size.
3080 % By the way, simply using "at 1em" works for cmr10 and the like, but
3081 % does not work for cmbx10 and other extended/shrunken fonts.
3083 \def\eurosize{\csname\curfontsize nominalsize
\endcsname}%
3085 \ifx\curfontstyle\bfstylename
3087 \font\thiseurofont =
\ifusingit{feybo10
}{feybr10
} at
\eurosize
3090 \font\thiseurofont =
\ifusingit{feymo10
}{feymr10
} at
\eurosize
3095 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3096 % sometimes we redefine the original macro, and the alias should reflect
3099 % Use LaTeX names for the Icelandic letters.
3100 \def\DH{{\ecfont \char"D0
}} % Eth
3101 \def\dh{{\ecfont \char"F0
}} % eth
3102 \def\TH{{\ecfont \char"DE
}} % Thorn
3103 \def\th{{\ecfont \char"FE
}} % thorn
3105 \def\guillemetleft{{\ecfont \char"
13}}
3106 \def\guillemotleft{\guillemetleft}
3107 \def\guillemetright{{\ecfont \char"
14}}
3108 \def\guillemotright{\guillemetright}
3109 \def\guilsinglleft{{\ecfont \char"
0E
}}
3110 \def\guilsinglright{{\ecfont \char"
0F
}}
3111 \def\quotedblbase{{\ecfont \char"
12}}
3112 \def\quotesinglbase{{\ecfont \char"
0D
}}
3114 % This positioning is not perfect (see the ogonek LaTeX package), but
3115 % we have the precomposed glyphs for the most common cases. We put the
3116 % tests to use those glyphs in the single \ogonek macro so we have fewer
3117 % dummy definitions to worry about for index entries, etc.
3119 % ogonek is also used with other letters in Lithuanian (IOU), but using
3120 % the precomposed glyphs for those is not so easy since they aren't in
3124 \ifx\temp\macrocharA\Aogonek
3125 \else\ifx\temp\macrochara\aogonek
3126 \else\ifx\temp\macrocharE\Eogonek
3127 \else\ifx\temp\macrochare\eogonek
3129 \ecfont \setbox0=
\hbox{#1}%
3130 \ifdim\ht0=
1ex
\accent"
0C
#1%
3131 \else\ooalign{\unhbox0\crcr\hidewidth\char"
0C
\hidewidth}%
3136 \def\Aogonek{{\ecfont \char"
81}}\def\macrocharA{A
}
3137 \def\aogonek{{\ecfont \char"A1
}}\def\macrochara{a
}
3138 \def\Eogonek{{\ecfont \char"
86}}\def\macrocharE{E
}
3139 \def\eogonek{{\ecfont \char"A6
}}\def\macrochare{e
}
3141 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
3143 % We can't distinguish serif/sans and italic/slanted, but this
3144 % is used for crude hacks anyway (like adding French and German
3145 % quotes to documents typeset with CM, where we lose kerning), so
3146 % hopefully nobody will notice/care.
3147 \edef\ecsize{\csname\curfontsize ecsize
\endcsname}%
3148 \edef\nominalsize{\csname\curfontsize nominalsize
\endcsname}%
3151 \font\thisecfont = ectt
\ecsize \space at
\nominalsize
3153 \ifx\curfontstyle\bfstylename
3155 \font\thisecfont = ecb
\ifusingit{i
}{x
}\ecsize \space at
\nominalsize
3158 \font\thisecfont = ec
\ifusingit{ti
}{rm
}\ecsize \space at
\nominalsize
3164 % @registeredsymbol - R in a circle. The font for the R should really
3165 % be smaller yet, but lllsize is the best we can do for now.
3166 % Adapted from the plain.tex definition of \copyright.
3168 \def\registeredsymbol{%
3169 $^
{{\ooalign{\hfil\raise.07ex
\hbox{\selectfonts\lllsize R
}%
3174 % @textdegree - the normal degrees sign.
3176 \def\textdegree{$^
\circ$
}
3178 % Laurent Siebenmann reports \Orb undefined with:
3179 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3180 % so we'll define it if necessary.
3182 \ifx\Orb\thisisundefined
3183 \def\Orb{\mathhexbox20D}
3187 \chardef\quotedblleft="
5C
3188 \chardef\quotedblright=`\"
3189 \chardef\quoteleft=`\`
3190 \chardef\quoteright=`\'
3193 \message{page headings,
}
3195 \newskip\titlepagetopglue \titlepagetopglue =
1.5in
3196 \newskip\titlepagebottomglue \titlepagebottomglue =
2pc
3198 % First the title page. Must do @settitle before @titlepage.
3200 \newif\iffinishedtitlepage
3202 % Do an implicit @contents or @shortcontents after @end titlepage if the
3203 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3205 \newif\ifsetcontentsaftertitlepage
3206 \let\setcontentsaftertitlepage =
\setcontentsaftertitlepagetrue
3207 \newif\ifsetshortcontentsaftertitlepage
3208 \let\setshortcontentsaftertitlepage =
\setshortcontentsaftertitlepagetrue
3210 \parseargdef\shorttitlepage{%
3211 \begingroup \hbox{}\vskip 1.5in
\chaprm \centerline{#1}%
3212 \endgroup\page\hbox{}\page}
3215 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3217 \parindent=
0pt
\textfonts
3218 % Leave some space at the very top of the page.
3219 \vglue\titlepagetopglue
3220 % No rule at page bottom unless we print one at the top with @title.
3221 \finishedtitlepagetrue
3223 % Most title ``pages'' are actually two pages long, with space
3224 % at the top of the second. We don't want the ragged left on the second.
3225 \let\oldpage =
\page
3227 \iffinishedtitlepage\else
3230 \let\page =
\oldpage
3237 \iffinishedtitlepage\else
3240 % It is important to do the page break before ending the group,
3241 % because the headline and footline are only empty inside the group.
3242 % If we use the new definition of \page, we always get a blank page
3243 % after the title page, which we certainly don't want.
3247 % Need this before the \...aftertitlepage checks so that if they are
3248 % in effect the toc pages will come out with page numbers.
3251 % If they want short, they certainly want long too.
3252 \ifsetshortcontentsaftertitlepage
3255 \global\let\shortcontents =
\relax
3256 \global\let\contents =
\relax
3259 \ifsetcontentsaftertitlepage
3261 \global\let\contents =
\relax
3262 \global\let\shortcontents =
\relax
3266 \def\finishtitlepage{%
3267 \vskip4pt \hrule height
2pt width
\hsize
3268 \vskip\titlepagebottomglue
3269 \finishedtitlepagetrue
3272 % Settings used for typesetting titles: no hyphenation, no indentation,
3273 % don't worry much about spacing, ragged right. This should be used
3274 % inside a \vbox, and fonts need to be set appropriately first. Because
3275 % it is always used for titles, nothing else, we call \rmisbold. \par
3276 % should be specified before the end of the \vbox, since a vbox is a group.
3278 \def\raggedtitlesettings{%
3280 \hyphenpenalty=
10000
3286 % Macros to be used within @titlepage:
3288 \let\subtitlerm=
\tenrm
3289 \def\subtitlefont{\subtitlerm \normalbaselineskip =
13pt
\normalbaselines}
3291 \parseargdef\title{%
3293 \vbox{\titlefonts \raggedtitlesettings #1\par}%
3294 % print a rule at the page bottom also.
3295 \finishedtitlepagefalse
3296 \vskip4pt \hrule height
4pt width
\hsize \vskip4pt
3299 \parseargdef\subtitle{%
3301 {\subtitlefont \rightline{#1}}%
3304 % @author should come last, but may come many times.
3305 % It can also be used inside @quotation.
3307 \parseargdef\author{%
3308 \def\temp{\quotation}%
3310 \def\quotationauthor{#1}% printed in \Equotation.
3313 \ifseenauthor\else \vskip 0pt plus
1filll
\seenauthortrue \fi
3314 {\secfonts\rmisbold \leftline{#1}}%
3319 % Set up page headings and footings.
3321 \let\thispage=
\folio
3323 \newtoks\evenheadline % headline on even pages
3324 \newtoks\oddheadline % headline on odd pages
3325 \newtoks\evenfootline % footline on even pages
3326 \newtoks\oddfootline % footline on odd pages
3328 % Now make TeX use those variables
3329 \headline=
{{\textfonts\rm \ifodd\pageno \the\oddheadline
3330 \else \the\evenheadline \fi}}
3331 \footline=
{{\textfonts\rm \ifodd\pageno \the\oddfootline
3332 \else \the\evenfootline \fi}\HEADINGShook}
3333 \let\HEADINGShook=
\relax
3335 % Commands to set those variables.
3336 % For example, this is what @headings on does
3337 % @evenheading @thistitle|@thispage|@thischapter
3338 % @oddheading @thischapter|@thispage|@thistitle
3339 % @evenfooting @thisfile||
3340 % @oddfooting ||@thisfile
3343 \def\evenheading{\parsearg\evenheadingxxx}
3344 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|
\finish}
3345 \def\evenheadingyyy #1\|
#2\|
#3\|
#4\finish{%
3346 \global\evenheadline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3348 \def\oddheading{\parsearg\oddheadingxxx}
3349 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|
\finish}
3350 \def\oddheadingyyy #1\|
#2\|
#3\|
#4\finish{%
3351 \global\oddheadline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3353 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3355 \def\evenfooting{\parsearg\evenfootingxxx}
3356 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|
\finish}
3357 \def\evenfootingyyy #1\|
#2\|
#3\|
#4\finish{%
3358 \global\evenfootline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3360 \def\oddfooting{\parsearg\oddfootingxxx}
3361 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|
\finish}
3362 \def\oddfootingyyy #1\|
#2\|
#3\|
#4\finish{%
3363 \global\oddfootline =
{\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3365 % Leave some space for the footline. Hopefully ok to assume
3366 % @evenfooting will not be used by itself.
3367 \global\advance\pageheight by -
12pt
3368 \global\advance\vsize by -
12pt
3371 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3373 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3374 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3376 % The same set of arguments for:
3381 % @everyheadingmarks
3382 % @everyfootingmarks
3384 \def\evenheadingmarks{\headingmarks{even
}{heading
}}
3385 \def\oddheadingmarks{\headingmarks{odd
}{heading
}}
3386 \def\evenfootingmarks{\headingmarks{even
}{footing
}}
3387 \def\oddfootingmarks{\headingmarks{odd
}{footing
}}
3388 \def\everyheadingmarks#1 {\headingmarks{even
}{heading
}{#1}
3389 \headingmarks{odd
}{heading
}{#1} }
3390 \def\everyfootingmarks#1 {\headingmarks{even
}{footing
}{#1}
3391 \headingmarks{odd
}{footing
}{#1} }
3392 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3393 \def\headingmarks#1#2#3 {%
3394 \expandafter\let\expandafter\temp \csname get
#3headingmarks
\endcsname
3395 \global\expandafter\let\csname get
#1#2marks
\endcsname \temp
3398 \everyheadingmarks bottom
3399 \everyfootingmarks bottom
3401 % @headings double turns headings on for double-sided printing.
3402 % @headings single turns headings on for single-sided printing.
3403 % @headings off turns them off.
3404 % @headings on same as @headings double, retained for compatibility.
3405 % @headings after turns on double-sided headings after this page.
3406 % @headings doubleafter turns on double-sided headings after this page.
3407 % @headings singleafter turns on single-sided headings after this page.
3408 % By default, they are off at the start of a document,
3409 % and turned `on' after @end titlepage.
3411 \def\headings #1 {\csname HEADINGS
#1\endcsname}
3413 \def\headingsoff{% non-global headings elimination
3414 \evenheadline=
{\hfil}\evenfootline=
{\hfil}%
3415 \oddheadline=
{\hfil}\oddfootline=
{\hfil}%
3418 \def\HEADINGSoff{{\globaldefs=
1 \headingsoff}} % global setting
3419 \HEADINGSoff % it's the default
3421 % When we turn headings on, set the page number to 1.
3422 % For double-sided printing, put current file name in lower left corner,
3423 % chapter name on inside top of right hand pages, document
3424 % title on inside top of left hand pages, and page numbers on outside top
3425 % edge of all pages.
3426 \def\HEADINGSdouble{%
3428 \global\evenfootline=
{\hfil}
3429 \global\oddfootline=
{\hfil}
3430 \global\evenheadline=
{\line{\folio\hfil\thistitle}}
3431 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
3432 \global\let\contentsalignmacro =
\chapoddpage
3434 \let\contentsalignmacro =
\chappager
3436 % For single-sided printing, chapter title goes across top left of page,
3437 % page number on top right.
3438 \def\HEADINGSsingle{%
3440 \global\evenfootline=
{\hfil}
3441 \global\oddfootline=
{\hfil}
3442 \global\evenheadline=
{\line{\thischapter\hfil\folio}}
3443 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
3444 \global\let\contentsalignmacro =
\chappager
3446 \def\HEADINGSon{\HEADINGSdouble}
3448 \def\HEADINGSafter{\let\HEADINGShook=
\HEADINGSdoublex}
3449 \let\HEADINGSdoubleafter=
\HEADINGSafter
3450 \def\HEADINGSdoublex{%
3451 \global\evenfootline=
{\hfil}
3452 \global\oddfootline=
{\hfil}
3453 \global\evenheadline=
{\line{\folio\hfil\thistitle}}
3454 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
3455 \global\let\contentsalignmacro =
\chapoddpage
3458 \def\HEADINGSsingleafter{\let\HEADINGShook=
\HEADINGSsinglex}
3459 \def\HEADINGSsinglex{%
3460 \global\evenfootline=
{\hfil}
3461 \global\oddfootline=
{\hfil}
3462 \global\evenheadline=
{\line{\thischapter\hfil\folio}}
3463 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
3464 \global\let\contentsalignmacro =
\chappager
3467 % Subroutines used in generating headings
3468 % This produces Day Month Year style of output.
3469 % Only define if not already defined, in case a txi-??.tex file has set
3470 % up a different format (e.g., txi-cs.tex does this).
3471 \ifx\today\thisisundefined
3475 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3476 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3477 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3482 % @settitle line... specifies the title of the document, for headings.
3483 % It generates no output of its own.
3484 \def\thistitle{\putwordNoTitle}
3485 \def\settitle{\parsearg{\gdef\thistitle}}
3489 % Tables -- @table, @ftable, @vtable, @item(x).
3491 % default indentation of table text
3492 \newdimen\tableindent \tableindent=
.8in
3493 % default indentation of @itemize and @enumerate text
3494 \newdimen\itemindent \itemindent=
.3in
3495 % margin between end of table item and start of table text.
3496 \newdimen\itemmargin \itemmargin=
.1in
3498 % used internally for \itemindent minus \itemmargin
3501 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3503 % They also define \itemindex
3504 % to index the item name in whatever manner is desired (perhaps none).
3506 \newif\ifitemxneedsnegativevskip
3508 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-
\parskip\nobreak\fi}
3510 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3511 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3513 \def\itemzzz #1{\begingroup %
3514 \advance\hsize by -
\rightskip
3515 \advance\hsize by -
\tableindent
3516 \setbox0=
\hbox{\itemindicate{#1}}%
3518 \nobreak % This prevents a break before @itemx.
3520 % If the item text does not fit in the space we have, put it on a line
3521 % by itself, and do not allow a page break either before or after that
3522 % line. We do not start a paragraph here because then if the next
3523 % command is, e.g., @kindex, the whatsit would get put into the
3524 % horizontal list on a line by itself, resulting in extra blank space.
3525 \ifdim \wd0>
\itemmax
3527 % Make this a paragraph so we get the \parskip glue and wrapping,
3528 % but leave it ragged-right.
3530 \advance\leftskip by-
\tableindent
3531 \advance\hsize by
\tableindent
3532 \advance\rightskip by0pt plus1fil
\relax
3533 \leavevmode\unhbox0\par
3536 % We're going to be starting a paragraph, but we don't want the
3537 % \parskip glue -- logically it's part of the @item we just started.
3538 \nobreak \vskip-
\parskip
3540 % Stop a page break at the \parskip glue coming up. However, if
3541 % what follows is an environment such as @example, there will be no
3542 % \parskip glue; then the negative vskip we just inserted would
3543 % cause the example and the item to crash together. So we use this
3544 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3545 % \parskip glue after all. Section titles are handled this way also.
3549 \itemxneedsnegativevskipfalse
3551 % The item text fits into the space. Start a paragraph, so that the
3552 % following text (if any) will end up on the same line.
3554 % Do this with kerns and \unhbox so that if there is a footnote in
3555 % the item text, it can migrate to the main vertical list and
3556 % eventually be printed.
3557 \nobreak\kern-
\tableindent
3558 \dimen0 =
\itemmax \advance\dimen0 by
\itemmargin \advance\dimen0 by -
\wd0
3560 \nobreak\kern\dimen0
3562 \itemxneedsnegativevskiptrue
3566 \def\item{\errmessage{@item while not in a list environment
}}
3567 \def\itemx{\errmessage{@itemx while not in a list environment
}}
3569 % @table, @ftable, @vtable.
3571 \let\itemindex\gobble
3575 \def\itemindex #
#1{\doind {fn
}{\code{#
#1}}}%
3576 \tablecheck{ftable
}%
3579 \def\itemindex #
#1{\doind {vr
}{\code{#
#1}}}%
3580 \tablecheck{vtable
}%
3583 \ifnum \the\catcode`\^^M=
\active
3585 \errmessage{This command won't work in this context; perhaps the problem is
3586 that we are
\inenvironment\thisenv}%
3587 \def\next{\doignore{#1}}%
3594 \def\itemindicate{#1}%
3599 \makevalueexpandable
3600 \edef\temp{\noexpand\tablez #1\space\space\space}%
3604 \def\tablez #1 #2 #3 #4\endtablez{%
3606 \ifnum 0#1>
0 \advance \leftskip by
#1\mil \fi
3607 \ifnum 0#2>
0 \tableindent=
#2\mil \fi
3608 \ifnum 0#3>
0 \advance \rightskip by
#3\mil \fi
3609 \itemmax=
\tableindent
3610 \advance \itemmax by -
\itemmargin
3611 \advance \leftskip by
\tableindent
3612 \exdentamount=
\tableindent
3614 \parskip =
\smallskipamount
3615 \ifdim \parskip=
0pt
\parskip=
2pt
\fi
3616 \let\item =
\internalBitem
3617 \let\itemx =
\internalBitemx
3619 \def\Etable{\endgraf\afterenvbreak}
3622 \let\Eitemize\Etable
3623 \let\Eenumerate\Etable
3625 % This is the counter used by @enumerate, which is really @itemize
3629 \envdef\itemize{\parsearg\doitemize}
3633 \itemmax=
\itemindent
3634 \advance\itemmax by -
\itemmargin
3635 \advance\leftskip by
\itemindent
3636 \exdentamount=
\itemindent
3638 \parskip=
\smallskipamount
3639 \ifdim\parskip=
0pt
\parskip=
2pt
\fi
3641 % Try typesetting the item mark that if the document erroneously says
3642 % something like @itemize @samp (intending @table), there's an error
3643 % right away at the @itemize. It's not the best error message in the
3644 % world, but it's better than leaving it to the @item. This means if
3645 % the user wants an empty mark, they have to say @w{} not just @w.
3646 \def\itemcontents{#1}%
3647 \setbox0 =
\hbox{\itemcontents}%
3649 % @itemize with no arg is equivalent to @itemize @bullet.
3650 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3652 \let\item=
\itemizeitem
3655 % Definition of @item while inside @itemize and @enumerate.
3658 \advance\itemno by
1 % for enumerations
3659 {\let\par=
\endgraf \smallbreak}% reasonable place to break
3661 % If the document has an @itemize directly after a section title, a
3662 % \nobreak will be last on the list, and \sectionheading will have
3663 % done a \vskip-\parskip. In that case, we don't want to zero
3664 % parskip, or the item text will crash with the heading. On the
3665 % other hand, when there is normal text preceding the item (as there
3666 % usually is), we do want to zero parskip, or there would be too much
3667 % space. In that case, we won't have a \nobreak before. At least
3668 % that's the theory.
3669 \ifnum\lastpenalty<
10000 \parskip=
0in
\fi
3671 \hbox to
0pt
{\hss \itemcontents \kern\itemmargin}%
3673 \vadjust{\penalty 1200}}% not good to break after first line of item.
3677 % \splitoff TOKENS\endmark defines \first to be the first token in
3678 % TOKENS, and \rest to be the remainder.
3680 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3682 % Allow an optional argument of an uppercase letter, lowercase letter,
3683 % or number, to specify the first label in the enumerated list. No
3684 % argument is the same as `1'.
3686 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3687 \def\enumeratey #1 #2\endenumeratey{%
3688 % If we were given no argument, pretend we were given `1'.
3690 \ifx\thearg\empty \def\thearg{1}\fi
3692 % Detect if the argument is a single token. If so, it might be a
3693 % letter. Otherwise, the only valid thing it can be is a number.
3694 % (We will always have one token, because of the test we just made.
3695 % This is a good thing, since \splitoff doesn't work given nothing at
3696 % all -- the first parameter is undelimited.)
3697 \expandafter\splitoff\thearg\endmark
3699 % Only one token in the argument. It could still be anything.
3700 % A ``lowercase letter'' is one whose \lccode is nonzero.
3701 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3702 % not equal to itself.
3703 % Otherwise, we assume it's a number.
3705 % We need the \relax at the end of the \ifnum lines to stop TeX from
3706 % continuing to look for a <number>.
3708 \ifnum\lccode\expandafter`
\thearg=
0\relax
3709 \numericenumerate % a number (we hope)
3712 \ifnum\lccode\expandafter`
\thearg=
\expandafter`
\thearg\relax
3713 \lowercaseenumerate % lowercase letter
3715 \uppercaseenumerate % uppercase letter
3719 % Multiple tokens in the argument. We hope it's a number.
3724 % An @enumerate whose labels are integers. The starting integer is
3727 \def\numericenumerate{%
3729 \startenumeration{\the\itemno}%
3732 % The starting (lowercase) letter is in \thearg.
3733 \def\lowercaseenumerate{%
3734 \itemno =
\expandafter`
\thearg
3736 % Be sure we're not beyond the end of the alphabet.
3738 \errmessage{No more lowercase letters in @enumerate; get a bigger
3745 % The starting (uppercase) letter is in \thearg.
3746 \def\uppercaseenumerate{%
3747 \itemno =
\expandafter`
\thearg
3749 % Be sure we're not beyond the end of the alphabet.
3751 \errmessage{No more uppercase letters in @enumerate; get a bigger
3758 % Call \doitemize, adding a period to the first argument and supplying the
3759 % common last two arguments. Also subtract one from the initial value in
3760 % \itemno, since @item increments \itemno.
3762 \def\startenumeration#1{%
3763 \advance\itemno by -
1
3764 \doitemize{#1.
}\flushcr
3767 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3770 \def\alphaenumerate{\enumerate{a
}}
3771 \def\capsenumerate{\enumerate{A
}}
3772 \def\Ealphaenumerate{\Eenumerate}
3773 \def\Ecapsenumerate{\Eenumerate}
3776 % @multitable macros
3777 % Amy Hendrickson, 8/18/94, 3/6/96
3779 % @multitable ... @end multitable will make as many columns as desired.
3780 % Contents of each column will wrap at width given in preamble. Width
3781 % can be specified either with sample text given in a template line,
3782 % or in percent of \hsize, the current width of text on page.
3784 % Table can continue over pages but will only break between lines.
3788 % Either define widths of columns in terms of percent of \hsize:
3789 % @multitable @columnfractions .25 .3 .45
3792 % Numbers following @columnfractions are the percent of the total
3793 % current hsize to be used for each column. You may use as many
3794 % columns as desired.
3797 % Or use a template:
3798 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3800 % using the widest term desired in each column.
3802 % Each new table line starts with @item, each subsequent new column
3803 % starts with @tab. Empty columns may be produced by supplying @tab's
3804 % with nothing between them for as many times as empty columns are needed,
3805 % ie, @tab@tab@tab will produce two empty columns.
3807 % @item, @tab do not need to be on their own lines, but it will not hurt
3810 % Sample multitable:
3812 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3813 % @item first col stuff @tab second col stuff @tab third col
3820 % @item first col stuff @tab second col stuff
3821 % @tab Many paragraphs of text may be used in any column.
3823 % They will wrap at the width determined by the template.
3824 % @item@tab@tab This will be in third column.
3827 % Default dimensions may be reset by user.
3828 % @multitableparskip is vertical space between paragraphs in table.
3829 % @multitableparindent is paragraph indent in table.
3830 % @multitablecolmargin is horizontal space to be left between columns.
3831 % @multitablelinespace is space to leave between table items, baseline
3833 % 0pt means it depends on current normal line spacing.
3835 \newskip\multitableparskip
3836 \newskip\multitableparindent
3837 \newdimen\multitablecolspace
3838 \newskip\multitablelinespace
3839 \multitableparskip=
0pt
3840 \multitableparindent=
6pt
3841 \multitablecolspace=
12pt
3842 \multitablelinespace=
0pt
3844 % Macros used to set up halign preamble:
3846 \let\endsetuptable\relax
3847 \def\xendsetuptable{\endsetuptable}
3848 \let\columnfractions\relax
3849 \def\xcolumnfractions{\columnfractions}
3852 % #1 is the @columnfraction, usually a decimal number like .5, but might
3853 % be just 1. We just use it, whatever it is.
3855 \def\pickupwholefraction#1 {%
3856 \global\advance\colcount by
1
3857 \expandafter\xdef\csname col
\the\colcount\endcsname{#1\hsize}%
3864 \ifx\firstarg\xendsetuptable
3867 \ifx\firstarg\xcolumnfractions
3868 \global\setpercenttrue
3871 \let\go\pickupwholefraction
3873 \global\advance\colcount by
1
3874 \setbox0=
\hbox{#1\unskip\space}% Add a normal word space as a
3875 % separator; typically that is always in the input, anyway.
3876 \expandafter\xdef\csname col
\the\colcount\endcsname{\the\wd0}%
3879 \ifx\go\pickupwholefraction
3880 % Put the argument back for the \pickupwholefraction call, so
3881 % we'll always have a period there to be parsed.
3882 \def\go{\pickupwholefraction#1}%
3884 \let\go =
\setuptable
3890 % multitable-only commands.
3892 % @headitem starts a heading row, which we typeset in bold.
3893 % Assignments have to be global since we are inside the implicit group
3894 % of an alignment entry. \everycr resets \everytab so we don't have to
3895 % undo it ourselves.
3896 \def\headitemfont{\b}% for people to use in the template row; not changeable
3898 \checkenv\multitable
3900 \global\everytab=
{\bf}% can't use \headitemfont since the parsing differs
3901 \the\everytab % for the first item
3904 % A \tab used to include \hskip1sp. But then the space in a template
3905 % line is not enough. That is bad. So let's go back to just `&' until
3906 % we again encounter the problem the 1sp was intended to solve.
3907 % --karl, nathan@acm.org, 20apr99.
3908 \def\tab{\checkenv\multitable &
\the\everytab}%
3910 % @multitable ... @end multitable definitions:
3912 \newtoks\everytab % insert after every tab.
3914 \envdef\multitable{%
3918 % @item within a multitable starts a normal row.
3919 % We use \def instead of \let so that if one of the multitable entries
3920 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3921 % \endtemplate) expanding \doitemize.
3926 \setmultitablespacing
3927 \parskip=
\multitableparskip
3928 \parindent=
\multitableparindent
3934 \global\everytab=
{}%
3935 \global\colcount=
0 % Reset the column counter.
3936 % Check for saved footnotes, etc.
3938 % Keeps underfull box messages off when table breaks over pages.
3940 % Maybe so, but it also creates really weird page breaks when the
3941 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3942 % problem manifests itself, so it can be fixed for real --karl.
3946 \parsearg\domultitable
3948 \def\domultitable#1{%
3949 % To parse everything between @multitable and @item:
3950 \setuptable#1 \endsetuptable
3952 % This preamble sets up a generic column definition, which will
3953 % be used as many times as user calls for columns.
3954 % \vtop will set a single line and will also let text wrap and
3955 % continue for many paragraphs if desired.
3957 \global\advance\colcount by
1
3960 % Use the current \colcount to find the correct column width:
3961 \hsize=
\expandafter\csname col
\the\colcount\endcsname
3963 % In order to keep entries from bumping into each other
3964 % we will add a \leftskip of \multitablecolspace to all columns after
3967 % If a template has been used, we will add \multitablecolspace
3968 % to the width of each template entry.
3970 % If the user has set preamble in terms of percent of \hsize we will
3971 % use that dimension as the width of the column, and the \leftskip
3972 % will keep entries from bumping into each other. Table will start at
3973 % left margin and final column will justify at right margin.
3975 % Make sure we don't inherit \rightskip from the outer environment.
3978 % The first column will be indented with the surrounding text.
3979 \advance\hsize by
\leftskip
3982 % If user has not set preamble in terms of percent of \hsize
3983 % we will advance \hsize by \multitablecolspace.
3984 \advance\hsize by
\multitablecolspace
3986 % In either case we will make \leftskip=\multitablecolspace:
3987 \leftskip=
\multitablecolspace
3989 % Ignoring space at the beginning and end avoids an occasional spurious
3990 % blank line, when TeX decides to break the line at the space before the
3991 % box from the multistrut, so the strut ends up on a line by itself.
3993 % @multitable @columnfractions .11 .89
3995 % @tab Legal holiday which is valid in major parts of the whole country.
3996 % Is automatically provided with highlighting sequences respectively
3997 % marking characters.
3998 \noindent\ignorespaces##
\unskip\multistrut
4003 \egroup % end the \halign
4004 \global\setpercentfalse
4007 \def\setmultitablespacing{%
4008 \def\multistrut{\strut}% just use the standard line spacing
4010 % Compute \multitablelinespace (if not defined by user) for use in
4011 % \multitableparskip calculation. We used define \multistrut based on
4012 % this, but (ironically) that caused the spacing to be off.
4013 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
4014 \ifdim\multitablelinespace=
0pt
4015 \setbox0=
\vbox{X
}\global\multitablelinespace=
\the\baselineskip
4016 \global\advance\multitablelinespace by-
\ht0
4018 % Test to see if parskip is larger than space between lines of
4019 % table. If not, do nothing.
4020 % If so, set to same dimension as multitablelinespace.
4021 \ifdim\multitableparskip>
\multitablelinespace
4022 \global\multitableparskip=
\multitablelinespace
4023 \global\advance\multitableparskip-
7pt
% to keep parskip somewhat smaller
4024 % than skip between lines in the table.
4026 \ifdim\multitableparskip=
0pt
4027 \global\multitableparskip=
\multitablelinespace
4028 \global\advance\multitableparskip-
7pt
% to keep parskip somewhat smaller
4029 % than skip between lines in the table.
4033 \message{conditionals,
}
4035 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4036 % @ifnotxml always succeed. They currently do nothing; we don't
4037 % attempt to check whether the conditionals are properly nested. But we
4038 % have to remember that they are conditionals, so that @end doesn't
4039 % attempt to close an environment group.
4042 \expandafter\let\csname #1\endcsname =
\relax
4043 \expandafter\let\csname iscond.
#1\endcsname =
1
4046 \makecond{ifnotdocbook
}
4047 \makecond{ifnothtml
}
4048 \makecond{ifnotinfo
}
4049 \makecond{ifnotplaintext
}
4052 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4054 \def\direntry{\doignore{direntry
}}
4055 \def\documentdescription{\doignore{documentdescription
}}
4056 \def\docbook{\doignore{docbook
}}
4057 \def\html{\doignore{html
}}
4058 \def\ifdocbook{\doignore{ifdocbook
}}
4059 \def\ifhtml{\doignore{ifhtml
}}
4060 \def\ifinfo{\doignore{ifinfo
}}
4061 \def\ifnottex{\doignore{ifnottex
}}
4062 \def\ifplaintext{\doignore{ifplaintext
}}
4063 \def\ifxml{\doignore{ifxml
}}
4064 \def\ignore{\doignore{ignore
}}
4065 \def\menu{\doignore{menu
}}
4066 \def\xml{\doignore{xml
}}
4068 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4070 % A count to remember the depth of nesting.
4071 \newcount\doignorecount
4073 \def\doignore#1{\begingroup
4074 % Scan in ``verbatim'' mode:
4076 \catcode`\@ =
\other
4077 \catcode`\
{ =
\other
4078 \catcode`\
} =
\other
4080 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4083 % Count number of #1's that we've seen.
4086 % Swallow text until we reach the matching `@end #1'.
4090 { \catcode`_=
11 % We want to use \_STOP_ which cannot appear in texinfo source.
4093 \gdef\dodoignore#1{%
4094 % #1 contains the command name as a string, e.g., `ifinfo'.
4096 % Define a command to find the next `@end #1'.
4097 \long\def\doignoretext#
#1^^M@end
#1{%
4098 \doignoretextyyy#
#1^^M@
#1\_STOP_}%
4100 % And this command to find another #1 command, at the beginning of a
4101 % line. (Otherwise, we would consider a line `@c @ifset', for
4102 % example, to count as an @ifset for nesting.)
4103 \long\def\doignoretextyyy#
#1^^M@
#1#
#2\_STOP_{\doignoreyyy{#
#2}\_STOP_}%
4105 % And now expand that command.
4110 \def\doignoreyyy#1{%
4112 \ifx\temp\empty % Nothing found.
4113 \let\next\doignoretextzzz
4114 \else % Found a nested condition, ...
4115 \advance\doignorecount by
1
4116 \let\next\doignoretextyyy % ..., look for another.
4117 % If we're here, #1 ends with ^^M\ifinfo (for example).
4119 \next #1% the token \_STOP_ is present just after this macro.
4122 % We have to swallow the remaining "\_STOP_".
4124 \def\doignoretextzzz#1{%
4125 \ifnum\doignorecount =
0 % We have just found the outermost @end.
4126 \let\next\enddoignore
4127 \else % Still inside a nested condition.
4128 \advance\doignorecount by -
1
4129 \let\next\doignoretext % Look for the next @end.
4134 % Finish off ignored text.
4136 % Ignore anything after the last `@end #1'; this matters in verbatim
4137 % environments, where otherwise the newline after an ignored conditional
4138 % would result in a blank line in the output.
4139 \gdef\enddoignore#1^^M
{\endgroup\ignorespaces}%
4143 % @set VAR sets the variable VAR to an empty value.
4144 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4146 % Since we want to separate VAR from REST-OF-LINE (which might be
4147 % empty), we can't just use \parsearg; we have to insert a space of our
4148 % own to delimit the rest of the line, and then take it out again if we
4150 % We rely on the fact that \parsearg sets \catcode`\ =10.
4152 \parseargdef\set{\setyyy#1 \endsetyyy}
4153 \def\setyyy#1 #2\endsetyyy{%
4155 \makevalueexpandable
4157 \edef\next{\gdef\makecsname{SET
#1}}%
4165 % Remove the trailing space \setxxx inserted.
4166 \def\setzzz#1 \endsetzzz{\next{#1}}
4168 % @clear VAR clears (i.e., unsets) the variable VAR.
4170 \parseargdef\clear{%
4172 \makevalueexpandable
4173 \global\expandafter\let\csname SET
#1\endcsname=
\relax
4177 % @value{foo} gets the text saved in variable foo.
4178 \def\value{\begingroup\makevalueexpandable\valuexxx}
4179 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4181 \catcode`\- =
\active \catcode`
\_ =
\active
4183 \gdef\makevalueexpandable{%
4184 \let\value =
\expandablevalue
4185 % We don't want these characters active, ...
4186 \catcode`\-=
\other \catcode`
\_=
\other
4187 % ..., but we might end up with active ones in the argument if
4188 % we're called from @code, as @code{@value{foo-bar_}}, though.
4189 % So \let them to their normal equivalents.
4190 \let-
\realdash \let_\normalunderscore
4194 % We have this subroutine so that we can handle at least some @value's
4195 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4196 % The command has to be fully expandable (if the variable is set), since
4197 % the result winds up in the index file. This means that if the
4198 % variable's value contains other Texinfo commands, it's almost certain
4199 % it will fail (although perhaps we could fix that with sufficient work
4200 % to do a one-level expansion on the result, instead of complete).
4202 \def\expandablevalue#1{%
4203 \expandafter\ifx\csname SET
#1\endcsname\relax
4204 {[No value for ``
#1''
]}%
4205 \message{Variable `
#1', used in @value, is not set.
}%
4207 \csname SET
#1\endcsname
4211 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4214 % To get special treatment of `@end ifset,' call \makeond and the redefine.
4217 \def\ifset{\parsearg{\doifset{\let\next=
\ifsetfail}}}
4220 \makevalueexpandable
4222 \expandafter\ifx\csname SET
#2\endcsname\relax
4223 #1% If not set, redefine \next.
4228 \def\ifsetfail{\doignore{ifset
}}
4230 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4231 % defined with @set, or has been undefined with @clear.
4233 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4234 % above code: if the variable is not set, do nothing, if it is set,
4235 % then redefine \next to \ifclearfail.
4238 \def\ifclear{\parsearg{\doifset{\else \let\next=
\ifclearfail}}}
4239 \def\ifclearfail{\doignore{ifclear
}}
4241 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4242 % without the @) is in fact defined. We can only feasibly check at the
4243 % TeX level, so something like `mathcode' is going to considered
4244 % defined even though it is not a Texinfo command.
4246 \makecond{ifcommanddefined
}
4247 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=
\ifcmddefinedfail}}}
4249 \def\doifcmddefined#1#2{{%
4250 \makevalueexpandable
4252 \expandafter\ifx\csname #2\endcsname\relax
4253 #1% If not defined, \let\next as above.
4258 \def\ifcmddefinedfail{\doignore{ifcommanddefined
}}
4260 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4261 \makecond{ifcommandnotdefined
}
4262 \def\ifcommandnotdefined{%
4263 \parsearg{\doifcmddefined{\else \let\next=
\ifcmdnotdefinedfail}}}
4264 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined
}}
4266 % Set the `txicommandconditionals' variable, so documents have a way to
4267 % test if the @ifcommand...defined conditionals are available.
4268 \set txicommandconditionals
4270 % @dircategory CATEGORY -- specify a category of the dir file
4271 % which this file should belong to. Ignore this in TeX.
4272 \let\dircategory=
\comment
4274 % @defininfoenclose.
4275 \let\definfoenclose=
\comment
4279 % Index generation facilities
4281 % Define \newwrite to be identical to plain tex's \newwrite
4282 % except not \outer, so it can be used within macros and \if's.
4283 \edef\newwrite{\makecsname{ptexnewwrite
}}
4285 % \newindex {foo} defines an index named foo.
4286 % It automatically defines \fooindex such that
4287 % \fooindex ...rest of line... puts an entry in the index foo.
4288 % It also defines \fooindfile to be the number of the output channel for
4289 % the file that accumulates this index. The file's extension is foo.
4290 % The name of an index should be no more than 2 characters long
4291 % for the sake of vms.
4295 \expandafter\newwrite \csname#1indfile
\endcsname
4296 \openout \csname#1indfile
\endcsname \jobname.
#1 % Open the file
4298 \expandafter\xdef\csname#1index
\endcsname{% % Define @#1index
4299 \noexpand\doindex{#1}}
4302 % @defindex foo == \newindex{foo}
4304 \def\defindex{\parsearg\newindex}
4306 % Define @defcodeindex, like @defindex except put all entries in @code.
4308 \def\defcodeindex{\parsearg\newcodeindex}
4310 \def\newcodeindex#1{%
4312 \expandafter\newwrite \csname#1indfile
\endcsname
4313 \openout \csname#1indfile
\endcsname \jobname.
#1
4315 \expandafter\xdef\csname#1index
\endcsname{%
4316 \noexpand\docodeindex{#1}}%
4320 % @synindex foo bar makes index foo feed into index bar.
4321 % Do this instead of @defindex foo if you don't want it as a separate index.
4323 % @syncodeindex foo bar similar, but put all entries made for index foo
4326 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4327 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4329 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4330 % #3 the target index (bar).
4331 \def\dosynindex#1#2#3{%
4332 % Only do \closeout if we haven't already done it, else we'll end up
4333 % closing the target index.
4334 \expandafter \ifx\csname donesynindex
#2\endcsname \relax
4335 % The \closeout helps reduce unnecessary open files; the limit on the
4336 % Acorn RISC OS is a mere 16 files.
4337 \expandafter\closeout\csname#2indfile
\endcsname
4338 \expandafter\let\csname donesynindex
#2\endcsname =
1
4340 % redefine \fooindfile:
4341 \expandafter\let\expandafter\temp\expandafter=
\csname#3indfile
\endcsname
4342 \expandafter\let\csname#2indfile
\endcsname=
\temp
4343 % redefine \fooindex:
4344 \expandafter\xdef\csname#2index
\endcsname{\noexpand#1{#3}}%
4347 % Define \doindex, the driver for all \fooindex macros.
4348 % Argument #1 is generated by the calling \fooindex macro,
4349 % and it is "foo", the name of the index.
4351 % \doindex just uses \parsearg; it calls \doind for the actual work.
4352 % This is because \doind is more useful to call from other macros.
4354 % There is also \dosubind {index}{topic}{subtopic}
4355 % which makes an entry in a two-level index such as the operation index.
4357 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4358 \def\singleindexer #1{\doind{\indexname}{#1}}
4360 % like the previous two, but they put @code around the argument.
4361 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4362 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4364 % Take care of Texinfo commands that can appear in an index entry.
4365 % Since there are some commands we want to expand, and others we don't,
4366 % we have to laboriously prevent expansion for those that we don't.
4369 \escapechar = `\\
% use backslash in output files.
4370 \def\@
{@
}% change to @@ when we switch to @ as escape char in index files.
4371 \def\
{\realbackslash\space }%
4373 % Need these unexpandable (because we define \tt as a dummy)
4374 % definitions when @{ or @} appear in index entry text. Also, more
4375 % complicated, when \tex is in effect and \{ is a \delimiter again.
4376 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4377 % braces and backslashes are used only as delimiters. Perhaps we
4378 % should define @lbrace and @rbrace commands a la @comma.
4379 \def\
{{{\tt\char123}}%
4380 \def\
}{{\tt\char125}}%
4382 % I don't entirely understand this, but when an index entry is
4383 % generated from a macro call, the \endinput which \scanmacro inserts
4384 % causes processing to be prematurely terminated. This is,
4385 % apparently, because \indexsorttmp is fully expanded, and \endinput
4386 % is an expandable command. The redefinition below makes \endinput
4387 % disappear altogether for that purpose -- although logging shows that
4388 % processing continues to some further point. On the other hand, it
4389 % seems \endinput does not hurt in the printed index arg, since that
4390 % is still getting written without apparent harm.
4392 % Sample source (mac-idx3.tex, reported by Graham Percival to
4393 % help-texinfo, 22may06):
4394 % @macro funindex {WORD}
4398 % @funindex commtest
4400 % The above is not enough to reproduce the bug, but it gives the flavor.
4402 % Sample whatsit resulting:
4403 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4406 \let\endinput =
\empty
4408 % Do the redefinitions.
4412 % For the aux and toc files, @ is the escape character. So we want to
4413 % redefine everything using @ as the escape character (instead of
4414 % \realbackslash, still used for index files). When everything uses @,
4415 % this will be simpler.
4420 \let\
{ =
\lbraceatcmd
4421 \let\
} =
\rbraceatcmd
4423 % Do the redefinitions.
4428 % Called from \indexdummies and \atdummies.
4430 \def\commondummies{%
4432 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4433 % preventing its expansion. This is used only for control words,
4434 % not control letters, because the \space would be incorrect for
4435 % control characters, but is needed to separate the control word
4436 % from whatever follows.
4438 % For control letters, we have \definedummyletter, which omits the
4441 % These can be used both for control words that take an argument and
4442 % those that do not. If it is followed by {arg} in the input, then
4443 % that will dutifully get written to the index (or wherever).
4445 \def\definedummyword #
#1{\def#
#1{\string#
#1\space}}%
4446 \def\definedummyletter#
#1{\def#
#1{\string#
#1}}%
4447 \let\definedummyaccent\definedummyletter
4449 \commondummiesnofonts
4451 \definedummyletter\_%
4452 \definedummyletter\-
%
4454 % Non-English letters.
4465 \definedummyword\exclamdown
4469 \definedummyword\ordf
4470 \definedummyword\ordm
4471 \definedummyword\questiondown
4475 % Although these internal commands shouldn't show up, sometimes they do.
4477 \definedummyword\gtr
4478 \definedummyword\hat
4479 \definedummyword\less
4482 \definedummyword\tclose
4485 \definedummyword\LaTeX
4486 \definedummyword\TeX
4488 % Assorted special characters.
4489 \definedummyword\arrow
4490 \definedummyword\bullet
4491 \definedummyword\comma
4492 \definedummyword\copyright
4493 \definedummyword\registeredsymbol
4494 \definedummyword\dots
4495 \definedummyword\enddots
4496 \definedummyword\entrybreak
4497 \definedummyword\equiv
4498 \definedummyword\error
4499 \definedummyword\euro
4500 \definedummyword\expansion
4501 \definedummyword\geq
4502 \definedummyword\guillemetleft
4503 \definedummyword\guillemetright
4504 \definedummyword\guilsinglleft
4505 \definedummyword\guilsinglright
4506 \definedummyword\lbracechar
4507 \definedummyword\leq
4508 \definedummyword\minus
4509 \definedummyword\ogonek
4510 \definedummyword\pounds
4511 \definedummyword\point
4512 \definedummyword\print
4513 \definedummyword\quotedblbase
4514 \definedummyword\quotedblleft
4515 \definedummyword\quotedblright
4516 \definedummyword\quoteleft
4517 \definedummyword\quoteright
4518 \definedummyword\quotesinglbase
4519 \definedummyword\rbracechar
4520 \definedummyword\result
4521 \definedummyword\textdegree
4523 % We want to disable all macros so that they are not expanded by \write.
4526 \normalturnoffactive
4528 % Handle some cases of @value -- where it does not contain any
4529 % (non-fully-expandable) commands.
4530 \makevalueexpandable
4533 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4535 \def\commondummiesnofonts{%
4536 % Control letters and accents.
4537 \definedummyletter\!
%
4538 \definedummyaccent\"
%
4539 \definedummyaccent\'
%
4540 \definedummyletter\*
%
4541 \definedummyaccent\,
%
4542 \definedummyletter\.
%
4543 \definedummyletter\/
%
4544 \definedummyletter\:
%
4545 \definedummyaccent\=
%
4546 \definedummyletter\?
%
4547 \definedummyaccent\^
%
4548 \definedummyaccent\`
%
4549 \definedummyaccent\~
%
4553 \definedummyword\dotaccent
4554 \definedummyword\ogonek
4555 \definedummyword\ringaccent
4556 \definedummyword\tieaccent
4557 \definedummyword\ubaraccent
4558 \definedummyword\udotaccent
4559 \definedummyword\dotless
4561 % Texinfo font commands.
4565 \definedummyword\sansserif
4567 \definedummyword\slanted
4570 % Commands that take arguments.
4571 \definedummyword\abbr
4572 \definedummyword\acronym
4573 \definedummyword\anchor
4574 \definedummyword\cite
4575 \definedummyword\code
4576 \definedummyword\command
4577 \definedummyword\dfn
4578 \definedummyword\dmn
4579 \definedummyword\email
4580 \definedummyword\emph
4581 \definedummyword\env
4582 \definedummyword\file
4583 \definedummyword\image
4584 \definedummyword\indicateurl
4585 \definedummyword\inforef
4586 \definedummyword\kbd
4587 \definedummyword\key
4588 \definedummyword\math
4589 \definedummyword\option
4590 \definedummyword\pxref
4591 \definedummyword\ref
4592 \definedummyword\samp
4593 \definedummyword\strong
4594 \definedummyword\tie
4595 \definedummyword\uref
4596 \definedummyword\url
4597 \definedummyword\var
4598 \definedummyword\verb
4600 \definedummyword\xref
4603 % \indexnofonts is used when outputting the strings to sort the index
4604 % by, and when constructing control sequence names. It eliminates all
4605 % control sequences and just writes whatever the best ASCII sort string
4606 % would be for a given command (usually its argument).
4609 % Accent commands should become @asis.
4610 \def\definedummyaccent#
#1{\let#
#1\asis}%
4611 % We can just ignore other control letters.
4612 \def\definedummyletter#
#1{\let#
#1\empty}%
4613 % All control words become @asis by default; overrides below.
4614 \let\definedummyword\definedummyaccent
4616 \commondummiesnofonts
4618 % Don't no-op \tt, since it isn't a user-level command
4619 % and is used in the definitions of the active chars like <, >, |, etc.
4620 % Likewise with the other plain tex font commands.
4625 \def\_{\normalunderscore}%
4626 \def\-
{}% @- shouldn't affect sorting
4628 % Unfortunately, texindex is not prepared to handle braces in the
4629 % content at all. So for index sorting, we map @{ and @} to strings
4630 % starting with |, since that ASCII character is between ASCII { and }.
4632 \def\lbracechar{|a
}%
4635 \def\rbracechar{|b
}%
4637 % Non-English letters.
4654 \def\questiondown{?
}%
4661 % Assorted special characters.
4662 % (The following {} will end up in the sort string, but that's ok.)
4664 \def\bullet{bullet
}%
4666 \def\copyright{copyright
}%
4672 \def\expansion{==>
}%
4674 \def\guillemetleft{<<
}%
4675 \def\guillemetright{>>
}%
4676 \def\guilsinglleft{<
}%
4677 \def\guilsinglright{>
}%
4681 \def\pounds{pounds
}%
4683 \def\quotedblbase{"
}%
4684 \def\quotedblleft{"
}%
4685 \def\quotedblright{"
}%
4688 \def\quotesinglbase{,
}%
4689 \def\registeredsymbol{R
}%
4693 \expandafter\ifx\csname SETtxiindexlquoteignore
\endcsname\relax
4694 \else \indexlquoteignore \fi
4696 % We need to get rid of all macros, leaving only the arguments (if present).
4697 % Of course this is not nearly correct, but it is the best we can do for now.
4698 % makeinfo does not expand macros in the argument to @deffn, which ends up
4699 % writing an index entry, and texindex isn't prepared for an index sort entry
4700 % that starts with \.
4702 % Since macro invocations are followed by braces, we can just redefine them
4703 % to take a single TeX argument. The case of a macro invocation that
4704 % goes to end-of-line is not handled.
4709 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4710 % ignore left quotes in the sort term.
4711 {\catcode`\`=
\active
4712 \gdef\indexlquoteignore{\let`=
\empty}}
4714 \let\indexbackslash=
0 %overridden during \printindex.
4715 \let\SETmarginindex=
\relax % put index entries in margin (undocumented)?
4717 % Most index entries go through here, but \dosubind is the general case.
4718 % #1 is the index name, #2 is the entry text.
4719 \def\doind#1#2{\dosubind{#1}{#2}{}}
4721 % Workhorse for all \fooindexes.
4722 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4723 % empty if called from \doind, as we usually are (the main exception
4724 % is with most defuns, which call us directly).
4726 \def\dosubind#1#2#3{%
4729 % Store the main index entry text (including the third arg).
4731 % If third arg is present, precede it with a space.
4733 \ifx\thirdarg\empty \else
4734 \toks0 =
\expandafter{\the\toks0 \space #3}%
4737 \edef\writeto{\csname#1indfile
\endcsname}%
4739 \safewhatsit\dosubindwrite
4744 % Write the entry in \toks0 to the index file:
4746 \def\dosubindwrite{%
4747 % Put the index entry in the margin if desired.
4748 \ifx\SETmarginindex\relax\else
4749 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt
\the\toks0}}%
4752 % Remember, we are within a group.
4753 \indexdummies % Must do this here, since \bf, etc expand at this stage
4754 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4755 % so it will be output as is; and it will print as backslash.
4757 % Process the index entry with all font commands turned off, to
4758 % get the string to sort by.
4760 \edef\temp{\the\toks0}% need full expansion
4761 \xdef\indexsorttmp{\temp}%
4764 % Set up the complete index entry, with both the sort key and
4765 % the original text, including any font commands. We write
4766 % three arguments to \entry to the .?? file (four in the
4767 % subentry case), texindex reduces to two when writing the .??s
4771 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4776 % Take care of unwanted page breaks/skips around a whatsit:
4778 % If a skip is the last thing on the list now, preserve it
4779 % by backing up by \lastskip, doing the \write, then inserting
4780 % the skip again. Otherwise, the whatsit generated by the
4781 % \write or \pdfdest will make \lastskip zero. The result is that
4782 % sequences like this:
4786 % will have extra space inserted, because the \medbreak in the
4787 % start of the @defun won't see the skip inserted by the @end of
4788 % the previous defun.
4790 % But don't do any of this if we're not in vertical mode. We
4791 % don't want to do a \vskip and prematurely end a paragraph.
4793 % Avoid page breaks due to these extra skips, too.
4795 % But wait, there is a catch there:
4796 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4797 % sufficient for this purpose, as it ignores stretch and shrink parts
4798 % of the skip. The only way seems to be to check the textual
4799 % representation of the skip.
4801 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4802 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4804 \edef\zeroskipmacro{\expandafter\the\csname z@skip
\endcsname}
4806 \newskip\whatsitskip
4807 \newcount\whatsitpenalty
4811 \def\safewhatsit#1{\ifhmode
4814 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4815 \whatsitskip =
\lastskip
4816 \edef\lastskipmacro{\the\lastskip}%
4817 \whatsitpenalty =
\lastpenalty
4819 % If \lastskip is nonzero, that means the last item was a
4820 % skip. And since a skip is discardable, that means this
4821 % -\whatsitskip glue we're inserting is preceded by a
4822 % non-discardable item, therefore it is not a potential
4823 % breakpoint, therefore no \nobreak needed.
4824 \ifx\lastskipmacro\zeroskipmacro
4831 \ifx\lastskipmacro\zeroskipmacro
4832 % If \lastskip was zero, perhaps the last item was a penalty, and
4833 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4834 % to re-insert the same penalty (values >10000 are used for various
4835 % signals); since we just inserted a non-discardable item, any
4836 % following glue (such as a \parskip) would be a breakpoint. For example:
4837 % @deffn deffn-whatever
4838 % @vindex index-whatever
4840 % would allow a break between the index-whatever whatsit
4841 % and the "Description." paragraph.
4842 \ifnum\whatsitpenalty>
9999 \penalty\whatsitpenalty \fi
4844 % On the other hand, if we had a nonzero \lastskip,
4845 % this make-up glue would be preceded by a non-discardable item
4846 % (the whatsit from the \write), so we must insert a \nobreak.
4847 \nobreak\vskip\whatsitskip
4851 % The index entry written in the file actually looks like
4852 % \entry {sortstring}{page}{topic}
4854 % \entry {sortstring}{page}{topic}{subtopic}
4855 % The texindex program reads in these files and writes files
4856 % containing these kinds of lines:
4858 % before the first topic whose initial is c
4859 % \entry {topic}{pagelist}
4860 % for a topic that is used without subtopics
4862 % for the beginning of a topic that is used with subtopics
4863 % \secondary {subtopic}{pagelist}
4864 % for each subtopic.
4866 % Define the user-accessible indexing commands
4867 % @findex, @vindex, @kindex, @cindex.
4869 \def\findex {\fnindex}
4870 \def\kindex {\kyindex}
4871 \def\cindex {\cpindex}
4872 \def\vindex {\vrindex}
4873 \def\tindex {\tpindex}
4874 \def\pindex {\pgindex}
4876 \def\cindexsub {\begingroup\obeylines\cindexsub}
4878 \gdef\cindexsub "
#1"
#2^^M
{\endgroup %
4879 \dosubind{cp
}{#2}{#1}}}
4881 % Define the macros used in formatting output of the sorted index material.
4883 % @printindex causes a particular index (the ??s file) to get printed.
4884 % It does not print any chapter heading (usually an @unnumbered).
4886 \parseargdef\printindex{\begingroup
4887 \dobreak \chapheadingskip{10000}%
4892 \everypar =
{}% don't want the \kern\-parindent from indentation suppression.
4894 % See if the index file exists and is nonempty.
4895 % Change catcode of @ here so that if the index file contains
4897 % as its first line, TeX doesn't complain about mismatched braces
4898 % (because it thinks @} is a control sequence).
4900 \openin 1 \jobname.
#1s
4902 % \enddoublecolumns gets confused if there is no text in the index,
4903 % and it loses the chapter title and the aux file entries for the
4904 % index. The easiest way to prevent this problem is to make sure
4905 % there is some text.
4906 \putwordIndexNonexistent
4909 % If the index file exists but is empty, then \openin leaves \ifeof
4910 % false. We have to make TeX try to read something from the file, so
4911 % it can discover if there is anything in it.
4914 \putwordIndexIsEmpty
4916 % Index files are almost Texinfo source, but we use \ as the escape
4917 % character. It would be better to use @, but that's too big a change
4918 % to make right now.
4919 \def\indexbackslash{\backslashcurfont}%
4930 % These macros are used by the sorted index file itself.
4931 % Change them to control the appearance of the index.
4934 % Some minor font changes for the special characters.
4935 \let\tentt=
\sectt \let\tt=
\sectt \let\sf=
\sectt
4937 % Remove any glue we may have, we'll be inserting our own.
4940 % We like breaks before the index initials, so insert a bonus.
4942 \vskip 0pt plus
3\baselineskip
4944 \vskip 0pt plus -
3\baselineskip
4946 % Typeset the initial. Making this add up to a whole number of
4947 % baselineskips increases the chance of the dots lining up from column
4948 % to column. It still won't often be perfect, because of the stretch
4949 % we need before each entry, but it's better.
4951 % No shrink because it confuses \balancecolumns.
4952 \vskip 1.67\baselineskip plus
.5\baselineskip
4953 \leftline{\secbf #1}%
4954 % Do our best not to break after the initial.
4956 \vskip .33\baselineskip plus
.1\baselineskip
4959 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4960 % then page number (#2) flushed to the right margin. It is used for index
4961 % and table of contents entries. The paragraph is indented by \leftskip.
4963 % A straightforward implementation would start like this:
4964 % \def\entry#1#2{...
4965 % But this freezes the catcodes in the argument, and can cause problems to
4966 % @code, which sets - active. This problem was fixed by a kludge---
4967 % ``-'' was active throughout whole index, but this isn't really right.
4968 % The right solution is to prevent \entry from swallowing the whole text.
4973 % Start a new paragraph if necessary, so our assignments below can't
4974 % affect previous text.
4977 % Do not fill out the last line with white space.
4980 % No extra space above this paragraph.
4983 % Do not prefer a separate line ending with a hyphen to fewer lines.
4984 \finalhyphendemerits =
0
4986 % \hangindent is only relevant when the entry text and page number
4987 % don't both fit on one line. In that case, bob suggests starting the
4988 % dots pretty far over on the line. Unfortunately, a large
4989 % indentation looks wrong when the entry text itself is broken across
4990 % lines. So we use a small indentation and put up with long leaders.
4992 % \hangafter is reset to 1 (which is the value we want) at the start
4993 % of each paragraph, so we need not do anything with that.
4996 % When the entry text needs to be broken, just fill out the first line
4998 \rightskip =
0pt plus1fil
5000 % A bit of stretch before each entry for the benefit of balancing
5004 % When reading the text of entry, convert explicit line breaks
5005 % from @* into spaces. The user might give these in long section
5006 % titles, for instance.
5007 \def\*
{\unskip\space\ignorespaces}%
5008 \def\entrybreak{\hfil\break}%
5010 % Swallow the left brace of the text (first parameter):
5011 \afterassignment\doentry
5014 \def\entrybreak{\unskip\space\ignorespaces}%
5016 \bgroup % Instead of the swallowed brace.
5018 \aftergroup\finishentry
5019 % And now comes the text of the entry.
5021 \def\finishentry#1{%
5022 % #1 is the page number.
5024 % The following is kludged to not output a line of dots in the index if
5025 % there are no page numbers. The next person who breaks this will be
5026 % cursed by a Unix daemon.
5027 \setbox\boxA =
\hbox{#1}%
5028 \ifdim\wd\boxA =
0pt
5032 % If we must, put the page number on a line of its own, and fill out
5033 % this line with blank space. (The \hfil is overwhelmed with the
5034 % fill leaders glue in \indexdotfill if the page number does fit.)
5036 \null\nobreak\indexdotfill % Have leaders before the page number.
5038 % The `\ ' here is removed by the implicit \unskip that TeX does as
5039 % part of (the primitive) \par. Without it, a spurious underfull
5052 % Like plain.tex's \dotfill, except uses up at least 1 em.
5053 \def\indexdotfill{\cleaders
5054 \hbox{$
\mathsurround=
0pt
\mkern1.5mu.
\mkern1.5mu$
}\hskip 1em plus
1fill
}
5056 \def\primary #1{\line{#1\hfil}}
5058 \newskip\secondaryindent \secondaryindent=
0.5cm
5059 \def\secondary#1#2{{%
5064 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5066 \pdfgettoks#2.\
\the\toksA % The page number ends the paragraph.
5073 % Define two-column mode, which we use to typeset indexes.
5074 % Adapted from the TeXbook, page 416, which is to say,
5075 % the manmac.tex format used to print the TeXbook itself.
5079 \newdimen\doublecolumnhsize
5081 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5082 % Grab any single-column material above us.
5085 % Here is a possibility not foreseen in manmac: if we accumulate a
5086 % whole lot of material, we might end up calling this \output
5087 % routine twice in a row (see the doublecol-lose test, which is
5088 % essentially a couple of indexes with @setchapternewpage off). In
5089 % that case we just ship out what is in \partialpage with the normal
5090 % output routine. Generally, \partialpage will be empty when this
5091 % runs and this will be a no-op. See the indexspread.tex test case.
5092 \ifvoid\partialpage \else
5093 \onepageout{\pagecontents\partialpage}%
5096 \global\setbox\partialpage =
\vbox{%
5097 % Unvbox the main output page.
5099 \kern-
\topskip \kern\baselineskip
5102 \eject % run that output routine to set \partialpage
5104 % Use the double-column output routine for subsequent pages.
5105 \output =
{\doublecolumnout}%
5107 % Change the page size parameters. We could do this once outside this
5108 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5109 % format, but then we repeat the same computation. Repeating a couple
5110 % of assignments once per index is clearly meaningless for the
5111 % execution time, so we may as well do it in one place.
5113 % First we halve the line length, less a little for the gutter between
5114 % the columns. We compute the gutter based on the line length, so it
5115 % changes automatically with the paper format. The magic constant
5116 % below is chosen so that the gutter has the same value (well, +-<1pt)
5117 % as it did when we hard-coded it.
5119 % We put the result in a separate register, \doublecolumhsize, so we
5120 % can restore it in \pagesofar, after \hsize itself has (potentially)
5123 \doublecolumnhsize =
\hsize
5124 \advance\doublecolumnhsize by -
.04154\hsize
5125 \divide\doublecolumnhsize by
2
5126 \hsize =
\doublecolumnhsize
5128 % Double the \vsize as well. (We don't need a separate register here,
5129 % since nobody clobbers \vsize.)
5133 % The double-column output routine for all double-column pages except
5136 \def\doublecolumnout{%
5137 \splittopskip=
\topskip \splitmaxdepth=
\maxdepth
5138 % Get the available space for the double columns -- the normal
5139 % (undoubled) page height minus any material left over from the
5143 \advance\dimen@ by -
\ht\partialpage
5145 % box0 will be the left-hand column, box2 the right.
5146 \setbox0=
\vsplit255 to
\dimen@
\setbox2=
\vsplit255 to
\dimen@
5147 \onepageout\pagesofar
5149 \penalty\outputpenalty
5152 % Re-output the contents of the output page -- any previous material,
5153 % followed by the two boxes we just split, in box0 and box2.
5157 \hsize =
\doublecolumnhsize
5158 \wd0=
\hsize \wd2=
\hsize
5159 \hbox to
\pagewidth{\box0\hfil\box2}%
5162 % All done with double columns.
5163 \def\enddoublecolumns{%
5164 % The following penalty ensures that the page builder is exercised
5165 % _before_ we change the output routine. This is necessary in the
5166 % following situation:
5168 % The last section of the index consists only of a single entry.
5169 % Before this section, \pagetotal is less than \pagegoal, so no
5170 % break occurs before the last section starts. However, the last
5171 % section, consisting of \initial and the single \entry, does not
5172 % fit on the page and has to be broken off. Without the following
5173 % penalty the page builder will not be exercised until \eject
5174 % below, and by that time we'll already have changed the output
5175 % routine to the \balancecolumns version, so the next-to-last
5176 % double-column page will be processed with \balancecolumns, which
5177 % is wrong: The two columns will go to the main vertical list, with
5178 % the broken-off section in the recent contributions. As soon as
5179 % the output routine finishes, TeX starts reconsidering the page
5180 % break. The two columns and the broken-off section both fit on the
5181 % page, because the two columns now take up only half of the page
5182 % goal. When TeX sees \eject from below which follows the final
5183 % section, it invokes the new output routine that we've set after
5184 % \balancecolumns below; \onepageout will try to fit the two columns
5185 % and the final section into the vbox of \pageheight (see
5186 % \pagebody), causing an overfull box.
5188 % Note that glue won't work here, because glue does not exercise the
5189 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5193 % Split the last of the double-column material. Leave it on the
5194 % current page, no automatic page break.
5197 % If we end up splitting too much material for the current page,
5198 % though, there will be another page break right after this \output
5199 % invocation ends. Having called \balancecolumns once, we do not
5200 % want to call it again. Therefore, reset \output to its normal
5201 % definition right away. (We hope \balancecolumns will never be
5202 % called on to balance too much material, but if it is, this makes
5203 % the output somewhat more palatable.)
5204 \global\output =
{\onepageout{\pagecontents\PAGE}}%
5207 \endgroup % started in \begindoublecolumns
5209 % \pagegoal was set to the doubled \vsize above, since we restarted
5210 % the current page. We're now back to normal single-column
5211 % typesetting, so reset \pagegoal to the normal \vsize (after the
5212 % \endgroup where \vsize got restored).
5216 % Called at the end of the double column material.
5217 \def\balancecolumns{%
5218 \setbox0 =
\vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5220 \advance\dimen@ by
\topskip
5221 \advance\dimen@ by-
\baselineskip
5222 \divide\dimen@ by
2 % target to split to
5223 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5224 \splittopskip =
\topskip
5225 % Loop until we get a decent breakpoint.
5229 \global\setbox3 =
\copy0
5230 \global\setbox1 =
\vsplit3 to
\dimen@
5232 \global\advance\dimen@ by
1pt
5235 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5236 \setbox0=
\vbox to
\dimen@
{\unvbox1}%
5237 \setbox2=
\vbox to
\dimen@
{\unvbox3}%
5241 \catcode`\@ =
\other
5244 \message{sectioning,
}
5245 % Chapters, sections, etc.
5247 % Let's start with @part.
5248 \outer\parseargdef\part{\partzzz{#1}}
5252 \vskip.3\vsize % move it down on the page a bit
5254 \noindent \titlefonts\rmisbold #1\par % the text
5255 \let\lastnode=
\empty % no node to associate with
5256 \writetocentry{part
}{#1}{}% but put it in the toc
5257 \headingsoff % no headline or footline on the part page
5262 % \unnumberedno is an oxymoron. But we count the unnumbered
5263 % sections so that we can refer to them unambiguously in the pdf
5264 % outlines by their "section number". We avoid collisions with chapter
5265 % numbers by starting them at 10000. (If a document ever has 10000
5266 % chapters, we're in trouble anyway, I'm sure.)
5267 \newcount\unnumberedno \unnumberedno =
10000
5269 \newcount\secno \secno=
0
5270 \newcount\subsecno \subsecno=
0
5271 \newcount\subsubsecno \subsubsecno=
0
5273 % This counter is funny since it counts through charcodes of letters A, B, ...
5274 \newcount\appendixno \appendixno = `\@
5276 % \def\appendixletter{\char\the\appendixno}
5277 % We do the following ugly conditional instead of the above simple
5278 % construct for the sake of pdftex, which needs the actual
5279 % letter in the expansion, not just typeset.
5281 \def\appendixletter{%
5282 \ifnum\appendixno=`A A
%
5283 \else\ifnum\appendixno=`B B
%
5284 \else\ifnum\appendixno=`C C
%
5285 \else\ifnum\appendixno=`D D
%
5286 \else\ifnum\appendixno=`E E
%
5287 \else\ifnum\appendixno=`F F
%
5288 \else\ifnum\appendixno=`G G
%
5289 \else\ifnum\appendixno=`H H
%
5290 \else\ifnum\appendixno=`I I
%
5291 \else\ifnum\appendixno=`J J
%
5292 \else\ifnum\appendixno=`K K
%
5293 \else\ifnum\appendixno=`L L
%
5294 \else\ifnum\appendixno=`M M
%
5295 \else\ifnum\appendixno=`N N
%
5296 \else\ifnum\appendixno=`O O
%
5297 \else\ifnum\appendixno=`P P
%
5298 \else\ifnum\appendixno=`Q Q
%
5299 \else\ifnum\appendixno=`R R
%
5300 \else\ifnum\appendixno=`S S
%
5301 \else\ifnum\appendixno=`T T
%
5302 \else\ifnum\appendixno=`U U
%
5303 \else\ifnum\appendixno=`V V
%
5304 \else\ifnum\appendixno=`W W
%
5305 \else\ifnum\appendixno=`X X
%
5306 \else\ifnum\appendixno=`Y Y
%
5307 \else\ifnum\appendixno=`Z Z
%
5308 % The \the is necessary, despite appearances, because \appendixletter is
5309 % expanded while writing the .toc file. \char\appendixno is not
5310 % expandable, thus it is written literally, thus all appendixes come out
5311 % with the same letter (or @) in the toc without it.
5312 \else\char\the\appendixno
5313 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5314 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5316 % Each @chapter defines these (using marks) as the number+name, number
5317 % and name of the chapter. Page headings and footings can use
5318 % these. @section does likewise.
5320 \def\thischapternum{}
5321 \def\thischaptername{}
5323 \def\thissectionnum{}
5324 \def\thissectionname{}
5326 \newcount\absseclevel % used to calculate proper heading level
5327 \newcount\secbase\secbase=
0 % @raisesections/@lowersections modify this count
5329 % @raisesections: treat @section as chapter, @subsection as section, etc.
5330 \def\raisesections{\global\advance\secbase by -
1}
5331 \let\up=
\raisesections % original BFox name
5333 % @lowersections: treat @chapter as section, @section as subsection, etc.
5334 \def\lowersections{\global\advance\secbase by
1}
5335 \let\down=
\lowersections % original BFox name
5337 % we only have subsub.
5338 \chardef\maxseclevel =
3
5340 % A numbered section within an unnumbered changes to unnumbered too.
5341 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5342 \chardef\unnlevel =
\maxseclevel
5344 % Trace whether the current chapter is an appendix or not:
5345 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5346 \def\chapheadtype{N
}
5348 % Choose a heading macro
5349 % #1 is heading type
5350 % #2 is heading level
5351 % #3 is text for heading
5352 \def\genhead#1#2#3{%
5353 % Compute the abs. sec. level:
5355 \advance\absseclevel by
\secbase
5356 % Make sure \absseclevel doesn't fall outside the range:
5357 \ifnum \absseclevel <
0
5360 \ifnum \absseclevel >
3
5367 \ifnum \absseclevel <
\unnlevel
5368 \chardef\unnlevel =
\absseclevel
5371 % Check for appendix sections:
5372 \ifnum \absseclevel =
0
5373 \edef\chapheadtype{\headtype}%
5375 \if \headtype A
\if \chapheadtype N
%
5376 \errmessage{@appendix... within a non-appendix chapter
}%
5379 % Check for numbered within unnumbered:
5380 \ifnum \absseclevel >
\unnlevel
5383 \chardef\unnlevel =
3
5386 % Now print the heading:
5390 \or \unnumberedseczzz{#3}%
5391 \or \unnumberedsubseczzz{#3}%
5392 \or \unnumberedsubsubseczzz{#3}%
5398 \or \appendixsectionzzz{#3}%
5399 \or \appendixsubseczzz{#3}%
5400 \or \appendixsubsubseczzz{#3}%
5406 \or \numberedsubseczzz{#3}%
5407 \or \numberedsubsubseczzz{#3}%
5411 \suppressfirstparagraphindent
5415 \def\numhead{\genhead N
}
5416 \def\apphead{\genhead A
}
5417 \def\unnmhead{\genhead U
}
5419 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5420 % all lower-level sectioning counters to zero.
5422 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5423 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5424 \let\chaplevelprefix =
\empty
5426 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5428 % section resetting is \global in case the chapter is in a group, such
5429 % as an @include file.
5430 \global\secno=
0 \global\subsecno=
0 \global\subsubsecno=
0
5431 \global\advance\chapno by
1
5434 \gdef\chaplevelprefix{\the\chapno.
}%
5437 % \putwordChapter can contain complex things in translations.
5438 \toks0=
\expandafter{\putwordChapter}%
5439 \message{\the\toks0 \space \the\chapno}%
5441 % Write the actual heading.
5442 \chapmacro{#1}{Ynumbered
}{\the\chapno}%
5444 % So @section and the like are numbered underneath this chapter.
5445 \global\let\section =
\numberedsec
5446 \global\let\subsection =
\numberedsubsec
5447 \global\let\subsubsection =
\numberedsubsubsec
5450 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5452 \def\appendixzzz#1{%
5453 \global\secno=
0 \global\subsecno=
0 \global\subsubsecno=
0
5454 \global\advance\appendixno by
1
5455 \gdef\chaplevelprefix{\appendixletter.
}%
5458 % \putwordAppendix can contain complex things in translations.
5459 \toks0=
\expandafter{\putwordAppendix}%
5460 \message{\the\toks0 \space \appendixletter}%
5462 \chapmacro{#1}{Yappendix
}{\appendixletter}%
5464 \global\let\section =
\appendixsec
5465 \global\let\subsection =
\appendixsubsec
5466 \global\let\subsubsection =
\appendixsubsubsec
5469 % normally unnmhead0 calls unnumberedzzz:
5470 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5471 \def\unnumberedzzz#1{%
5472 \global\secno=
0 \global\subsecno=
0 \global\subsubsecno=
0
5473 \global\advance\unnumberedno by
1
5475 % Since an unnumbered has no number, no prefix for figures.
5476 \global\let\chaplevelprefix =
\empty
5479 % This used to be simply \message{#1}, but TeX fully expands the
5480 % argument to \message. Therefore, if #1 contained @-commands, TeX
5481 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5482 % expanded @cite (which turns out to cause errors because \cite is meant
5483 % to be executed, not expanded).
5485 % Anyway, we don't want the fully-expanded definition of @cite to appear
5486 % as a result of the \message, we just want `@cite' itself. We use
5487 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5488 % simply yielding the contents of <toks register>. (We also do this for
5491 \message{(
\the\toks0)
}%
5493 \chapmacro{#1}{Ynothing
}{\the\unnumberedno}%
5495 \global\let\section =
\unnumberedsec
5496 \global\let\subsection =
\unnumberedsubsec
5497 \global\let\subsubsection =
\unnumberedsubsubsec
5500 % @centerchap is like @unnumbered, but the heading is centered.
5501 \outer\parseargdef\centerchap{%
5502 % Well, we could do the following in a group, but that would break
5503 % an assumption that \chapmacro is called at the outermost level.
5504 % Thus we are safer this way: --kasal, 24feb04
5505 \let\centerparametersmaybe =
\centerparameters
5507 \let\centerparametersmaybe =
\relax
5510 % @top is like @unnumbered.
5515 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5517 \global\subsecno=
0 \global\subsubsecno=
0 \global\advance\secno by
1
5518 \sectionheading{#1}{sec
}{Ynumbered
}{\the\chapno.
\the\secno}%
5521 % normally calls appendixsectionzzz:
5522 \outer\parseargdef\appendixsection{\apphead1{#1}}
5523 \def\appendixsectionzzz#1{%
5524 \global\subsecno=
0 \global\subsubsecno=
0 \global\advance\secno by
1
5525 \sectionheading{#1}{sec
}{Yappendix
}{\appendixletter.
\the\secno}%
5527 \let\appendixsec\appendixsection
5529 % normally calls unnumberedseczzz:
5530 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5531 \def\unnumberedseczzz#1{%
5532 \global\subsecno=
0 \global\subsubsecno=
0 \global\advance\secno by
1
5533 \sectionheading{#1}{sec
}{Ynothing
}{\the\unnumberedno.
\the\secno}%
5538 % normally calls numberedsubseczzz:
5539 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5540 \def\numberedsubseczzz#1{%
5541 \global\subsubsecno=
0 \global\advance\subsecno by
1
5542 \sectionheading{#1}{subsec
}{Ynumbered
}{\the\chapno.
\the\secno.
\the\subsecno}%
5545 % normally calls appendixsubseczzz:
5546 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5547 \def\appendixsubseczzz#1{%
5548 \global\subsubsecno=
0 \global\advance\subsecno by
1
5549 \sectionheading{#1}{subsec
}{Yappendix
}%
5550 {\appendixletter.
\the\secno.
\the\subsecno}%
5553 % normally calls unnumberedsubseczzz:
5554 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5555 \def\unnumberedsubseczzz#1{%
5556 \global\subsubsecno=
0 \global\advance\subsecno by
1
5557 \sectionheading{#1}{subsec
}{Ynothing
}%
5558 {\the\unnumberedno.
\the\secno.
\the\subsecno}%
5563 % normally numberedsubsubseczzz:
5564 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5565 \def\numberedsubsubseczzz#1{%
5566 \global\advance\subsubsecno by
1
5567 \sectionheading{#1}{subsubsec
}{Ynumbered
}%
5568 {\the\chapno.
\the\secno.
\the\subsecno.
\the\subsubsecno}%
5571 % normally appendixsubsubseczzz:
5572 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5573 \def\appendixsubsubseczzz#1{%
5574 \global\advance\subsubsecno by
1
5575 \sectionheading{#1}{subsubsec
}{Yappendix
}%
5576 {\appendixletter.
\the\secno.
\the\subsecno.
\the\subsubsecno}%
5579 % normally unnumberedsubsubseczzz:
5580 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5581 \def\unnumberedsubsubseczzz#1{%
5582 \global\advance\subsubsecno by
1
5583 \sectionheading{#1}{subsubsec
}{Ynothing
}%
5584 {\the\unnumberedno.
\the\secno.
\the\subsecno.
\the\subsubsecno}%
5587 % These macros control what the section commands do, according
5588 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5589 % Define them by default for a numbered chapter.
5590 \let\section =
\numberedsec
5591 \let\subsection =
\numberedsubsec
5592 \let\subsubsection =
\numberedsubsubsec
5594 % Define @majorheading, @heading and @subheading
5597 {\advance\chapheadingskip by
10pt
\chapbreak }%
5598 \parsearg\chapheadingzzz
5601 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5602 \def\chapheadingzzz#1{%
5603 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5604 \nobreak\bigskip \nobreak
5605 \suppressfirstparagraphindent
5608 % @heading, @subheading, @subsubheading.
5609 \parseargdef\heading{\sectionheading{#1}{sec
}{Yomitfromtoc
}{}
5610 \suppressfirstparagraphindent}
5611 \parseargdef\subheading{\sectionheading{#1}{subsec
}{Yomitfromtoc
}{}
5612 \suppressfirstparagraphindent}
5613 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec
}{Yomitfromtoc
}{}
5614 \suppressfirstparagraphindent}
5616 % These macros generate a chapter, section, etc. heading only
5617 % (including whitespace, linebreaking, etc. around it),
5618 % given all the information in convenient, parsed form.
5620 % Args are the skip and penalty (usually negative)
5621 \def\dobreak#1#2{\par\ifdim\lastskip<
#1\removelastskip\penalty#2\vskip#1\fi}
5623 % Parameter controlling skip before chapter headings (if needed)
5624 \newskip\chapheadingskip
5626 % Define plain chapter starts, and page on/off switching for it.
5627 \def\chapbreak{\dobreak \chapheadingskip {-
4000}}
5628 \def\chappager{\par\vfill\supereject}
5629 % Because \domark is called before \chapoddpage, the filler page will
5630 % get the headings for the next chapter, which is wrong. But we don't
5631 % care -- we just disable all headings on the filler page.
5643 \def\setchapternewpage #1 {\csname CHAPPAG
#1\endcsname}
5646 \global\let\contentsalignmacro =
\chappager
5647 \global\let\pchapsepmacro=
\chapbreak
5648 \global\let\pagealignmacro=
\chappager}
5651 \global\let\contentsalignmacro =
\chappager
5652 \global\let\pchapsepmacro=
\chappager
5653 \global\let\pagealignmacro=
\chappager
5654 \global\def\HEADINGSon{\HEADINGSsingle}}
5657 \global\let\contentsalignmacro =
\chapoddpage
5658 \global\let\pchapsepmacro=
\chapoddpage
5659 \global\let\pagealignmacro=
\chapoddpage
5660 \global\def\HEADINGSon{\HEADINGSdouble}}
5666 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5667 % Yappendix, Yomitfromtoc), #3 the chapter number.
5669 % To test against our argument.
5670 \def\Ynothingkeyword{Ynothing
}
5671 \def\Yomitfromtockeyword{Yomitfromtoc
}
5672 \def\Yappendixkeyword{Yappendix
}
5674 \def\chapmacro#1#2#3{%
5675 % Insert the first mark before the heading break (see notes for \domark).
5676 \let\prevchapterdefs=
\lastchapterdefs
5677 \let\prevsectiondefs=
\lastsectiondefs
5678 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5679 \gdef\thissection{}}%
5682 \ifx\temptype\Ynothingkeyword
5683 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5684 \gdef\thischapter{\thischaptername}}%
5685 \else\ifx\temptype\Yomitfromtockeyword
5686 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5687 \gdef\thischapter{}}%
5688 \else\ifx\temptype\Yappendixkeyword
5690 \xdef\lastchapterdefs{%
5691 \gdef\noexpand\thischaptername{\the\toks0}%
5692 \gdef\noexpand\thischapternum{\appendixletter}%
5693 % \noexpand\putwordAppendix avoids expanding indigestible
5694 % commands in some of the translations.
5695 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5696 \noexpand\thischapternum:
5697 \noexpand\thischaptername}%
5701 \xdef\lastchapterdefs{%
5702 \gdef\noexpand\thischaptername{\the\toks0}%
5703 \gdef\noexpand\thischapternum{\the\chapno}%
5704 % \noexpand\putwordChapter avoids expanding indigestible
5705 % commands in some of the translations.
5706 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5707 \noexpand\thischapternum:
5708 \noexpand\thischaptername}%
5712 % Output the mark. Pass it through \safewhatsit, to take care of
5713 % the preceding space.
5716 % Insert the chapter heading break.
5719 % Now the second mark, after the heading break. No break points
5720 % between here and the heading.
5721 \let\prevchapterdefs=
\lastchapterdefs
5722 \let\prevsectiondefs=
\lastsectiondefs
5726 \chapfonts \rmisbold
5728 % Have to define \lastsection before calling \donoderef, because the
5729 % xref code eventually uses it. On the other hand, it has to be called
5730 % after \pchapsepmacro, or the headline will change too soon.
5731 \gdef\lastsection{#1}%
5733 % Only insert the separating space if we have a chapter/appendix
5734 % number, and don't print the unnumbered ``number''.
5735 \ifx\temptype\Ynothingkeyword
5737 \def\toctype{unnchap
}%
5738 \else\ifx\temptype\Yomitfromtockeyword
5739 \setbox0 =
\hbox{}% contents like unnumbered, but no toc entry
5741 \else\ifx\temptype\Yappendixkeyword
5742 \setbox0 =
\hbox{\putwordAppendix{} #3\enspace}%
5745 \setbox0 =
\hbox{#3\enspace}%
5746 \def\toctype{numchap
}%
5749 % Write the toc entry for this chapter. Must come before the
5750 % \donoderef, because we include the current node name in the toc
5751 % entry, and \donoderef resets it to empty.
5752 \writetocentry{\toctype}{#1}{#3}%
5754 % For pdftex, we have to write out the node definition (aka, make
5755 % the pdfdest) after any page break, but before the actual text has
5756 % been typeset. If the destination for the pdf outline is after the
5757 % text, then jumping from the outline may wind up with the text not
5758 % being visible, for instance under high magnification.
5761 % Typeset the actual heading.
5762 \nobreak % Avoid page breaks at the interline glue.
5763 \vbox{\raggedtitlesettings \hangindent=
\wd0 \centerparametersmaybe
5766 \nobreak\bigskip % no page break after a chapter title
5770 % @centerchap -- centered and unnumbered.
5771 \let\centerparametersmaybe =
\relax
5772 \def\centerparameters{%
5773 \advance\rightskip by
3\rightskip
5774 \leftskip =
\rightskip
5779 % I don't think this chapter style is supported any more, so I'm not
5780 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5782 \def\setchapterstyle #1 {\csname CHAPF
#1\endcsname}
5784 \def\unnchfopen #1{%
5786 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5787 \nobreak\bigskip\nobreak
5789 \def\chfopen #1#2{\chapoddpage {\chapfonts
5790 \vbox to
3in
{\vfil \hbox to
\hsize{\hfil #2} \hbox to
\hsize{\hfil #1} \vfil}}%
5793 \def\centerchfopen #1{%
5795 \vbox{\chapfonts \raggedtitlesettings \hfill #1\hfill}%
5796 \nobreak\bigskip \nobreak
5799 \global\let\chapmacro=
\chfopen
5800 \global\let\centerchapmacro=
\centerchfopen}
5803 % Section titles. These macros combine the section number parts and
5804 % call the generic \sectionheading to do the printing.
5806 \newskip\secheadingskip
5807 \def\secheadingbreak{\dobreak \secheadingskip{-
1000}}
5809 % Subsection titles.
5810 \newskip\subsecheadingskip
5811 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-
500}}
5813 % Subsubsection titles.
5814 \def\subsubsecheadingskip{\subsecheadingskip}
5815 \def\subsubsecheadingbreak{\subsecheadingbreak}
5818 % Print any size, any type, section title.
5820 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5821 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5824 \def\seckeyword{sec
}
5826 \def\sectionheading#1#2#3#4{%
5828 \checkenv{}% should not be in an environment.
5830 % Switch to the right set of fonts.
5831 \csname #2fonts
\endcsname \rmisbold
5833 \def\sectionlevel{#2}%
5836 % Insert first mark before the heading break (see notes for \domark).
5837 \let\prevsectiondefs=
\lastsectiondefs
5838 \ifx\temptype\Ynothingkeyword
5839 \ifx\sectionlevel\seckeyword
5840 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5841 \gdef\thissection{\thissectionname}}%
5843 \else\ifx\temptype\Yomitfromtockeyword
5844 % Don't redefine \thissection.
5845 \else\ifx\temptype\Yappendixkeyword
5846 \ifx\sectionlevel\seckeyword
5848 \xdef\lastsectiondefs{%
5849 \gdef\noexpand\thissectionname{\the\toks0}%
5850 \gdef\noexpand\thissectionnum{#4}%
5851 % \noexpand\putwordSection avoids expanding indigestible
5852 % commands in some of the translations.
5853 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5854 \noexpand\thissectionnum:
5855 \noexpand\thissectionname}%
5859 \ifx\sectionlevel\seckeyword
5861 \xdef\lastsectiondefs{%
5862 \gdef\noexpand\thissectionname{\the\toks0}%
5863 \gdef\noexpand\thissectionnum{#4}%
5864 % \noexpand\putwordSection avoids expanding indigestible
5865 % commands in some of the translations.
5866 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5867 \noexpand\thissectionnum:
5868 \noexpand\thissectionname}%
5873 % Go into vertical mode. Usually we'll already be there, but we
5874 % don't want the following whatsit to end up in a preceding paragraph
5875 % if the document didn't happen to have a blank line.
5878 % Output the mark. Pass it through \safewhatsit, to take care of
5879 % the preceding space.
5882 % Insert space above the heading.
5883 \csname #2headingbreak
\endcsname
5885 % Now the second mark, after the heading break. No break points
5886 % between here and the heading.
5887 \let\prevsectiondefs=
\lastsectiondefs
5890 % Only insert the space after the number if we have a section number.
5891 \ifx\temptype\Ynothingkeyword
5894 \gdef\lastsection{#1}%
5895 \else\ifx\temptype\Yomitfromtockeyword
5896 % for @headings -- no section number, don't include in toc,
5897 % and don't redefine \lastsection.
5900 \let\sectionlevel=
\empty
5901 \else\ifx\temptype\Yappendixkeyword
5902 \setbox0 =
\hbox{#4\enspace}%
5904 \gdef\lastsection{#1}%
5906 \setbox0 =
\hbox{#4\enspace}%
5908 \gdef\lastsection{#1}%
5911 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5912 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5914 % Write the node reference (= pdf destination for pdftex).
5915 % Again, see comments in \chapmacro.
5918 % Interline glue will be inserted when the vbox is completed.
5919 % That glue will be a valid breakpoint for the page, since it'll be
5920 % preceded by a whatsit (usually from the \donoderef, or from the
5921 % \writetocentry if there was no node). We don't want to allow that
5922 % break, since then the whatsits could end up on page n while the
5923 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5926 % Output the actual section heading.
5927 \vbox{\hyphenpenalty=
10000 \tolerance=
5000 \parindent=
0pt
\ptexraggedright
5928 \hangindent=
\wd0 % zero if no section number
5931 % Add extra space after the heading -- half of whatever came above it.
5932 % Don't allow stretch, though.
5933 \kern .5 \csname #2headingskip
\endcsname
5935 % Do not let the kern be a potential breakpoint, as it would be if it
5936 % was followed by glue.
5939 % We'll almost certainly start a paragraph next, so don't let that
5940 % glue accumulate. (Not a breakpoint because it's preceded by a
5941 % discardable item.) However, when a paragraph is not started next
5942 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
5943 % or the negative glue will cause weirdly wrong output, typically
5944 % obscuring the section heading with something else.
5947 % This is so the last item on the main vertical list is a known
5948 % \penalty > 10000, so \startdefun, etc., can recognize the situation
5949 % and do the needful.
5955 % Table of contents.
5958 % Write an entry to the toc file, opening it if necessary.
5959 % Called from @chapter, etc.
5961 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5962 % We append the current node name (if any) and page number as additional
5963 % arguments for the \{chap,sec,...}entry macros which will eventually
5964 % read this. The node name is used in the pdf outlines as the
5965 % destination to jump to.
5967 % We open the .toc file for writing here instead of at @setfilename (or
5968 % any other fixed time) so that @contents can be anywhere in the document.
5969 % But if #1 is `omit', then we don't do anything. This is used for the
5970 % table of contents chapter openings themselves.
5972 \newif\iftocfileopened
5973 \def\omitkeyword{omit
}%
5975 \def\writetocentry#1#2#3{%
5976 \edef\writetoctype{#1}%
5977 \ifx\writetoctype\omitkeyword \else
5978 \iftocfileopened\else
5979 \immediate\openout\tocfile =
\jobname.toc
5980 \global\tocfileopenedtrue
5986 \write\tocfile{@
#1entry
{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5992 % Tell \shipout to create a pdf destination on each page, if we're
5993 % writing pdf. These are used in the table of contents. We can't
5994 % just write one on every page because the title pages are numbered
5995 % 1 and 2 (the page numbers aren't printed), and so are the first
5996 % two pages of the document. Thus, we'd have two destinations named
5997 % `1', and two named `2'.
5998 \ifpdf \global\pdfmakepagedesttrue \fi
6002 % These characters do not print properly in the Computer Modern roman
6003 % fonts, so we must take special care. This is more or less redundant
6004 % with the Texinfo input format setup at the end of this file.
6006 \def\activecatcodes{%
6019 % Read the toc file, which is essentially Texinfo input.
6023 \input \tocreadfilename
6026 \newskip\contentsrightmargin \contentsrightmargin=
1in
6027 \newcount\savepageno
6028 \newcount\lastnegativepageno \lastnegativepageno = -
1
6030 % Prepare to read what we've written to \tocfile.
6032 \def\startcontents#1{%
6033 % If @setchapternewpage on, and @headings double, the contents should
6034 % start on an odd page, unlike chapters. Thus, we maintain
6035 % \contentsalignmacro in parallel with \pagealignmacro.
6036 % From: Torbjorn Granlund <tege@matematik.su.se>
6038 \immediate\closeout\tocfile
6040 % Don't need to put `Contents' or `Short Contents' in the headline.
6041 % It is abundantly clear what they are.
6042 \chapmacro{#1}{Yomitfromtoc
}{}%
6044 \savepageno =
\pageno
6045 \begingroup % Set up to handle contents files properly.
6046 \raggedbottom % Worry more about breakpoints than the bottom.
6047 \advance\hsize by -
\contentsrightmargin % Don't use the full line length.
6049 % Roman numerals for page numbers.
6050 \ifnum \pageno>
0 \global\pageno =
\lastnegativepageno \fi
6053 % redefined for the two-volume lispref. We always output on
6054 % \jobname.toc even if this is redefined.
6056 \def\tocreadfilename{\jobname.toc
}
6058 % Normal (long) toc.
6061 \startcontents{\putwordTOC}%
6062 \openin 1 \tocreadfilename\space
6067 \contentsalignmacro % in case @setchapternewpage odd is in effect
6073 \lastnegativepageno =
\pageno
6074 \global\pageno =
\savepageno
6077 % And just the chapters.
6078 \def\summarycontents{%
6079 \startcontents{\putwordShortTOC}%
6081 \let\partentry =
\shortpartentry
6082 \let\numchapentry =
\shortchapentry
6083 \let\appentry =
\shortchapentry
6084 \let\unnchapentry =
\shortunnchapentry
6085 % We want a true roman here for the page numbers.
6087 \let\rm=
\shortcontrm \let\bf=
\shortcontbf
6088 \let\sl=
\shortcontsl \let\tt=
\shortconttt
6090 \hyphenpenalty =
10000
6091 \advance\baselineskip by
1pt
% Open it up a little.
6092 \def\numsecentry#
#1#
#2#
#3#
#4{}
6093 \let\appsecentry =
\numsecentry
6094 \let\unnsecentry =
\numsecentry
6095 \let\numsubsecentry =
\numsecentry
6096 \let\appsubsecentry =
\numsecentry
6097 \let\unnsubsecentry =
\numsecentry
6098 \let\numsubsubsecentry =
\numsecentry
6099 \let\appsubsubsecentry =
\numsecentry
6100 \let\unnsubsubsecentry =
\numsecentry
6101 \openin 1 \tocreadfilename\space
6107 \contentsalignmacro % in case @setchapternewpage odd is in effect
6109 \lastnegativepageno =
\pageno
6110 \global\pageno =
\savepageno
6112 \let\shortcontents =
\summarycontents
6114 % Typeset the label for a chapter or appendix for the short contents.
6115 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6117 \def\shortchaplabel#1{%
6118 % This space should be enough, since a single number is .5em, and the
6119 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6120 % But use \hss just in case.
6121 % (This space doesn't include the extra space that gets added after
6122 % the label; that gets put in by \shortchapentry above.)
6124 % We'd like to right-justify chapter numbers, but that looks strange
6125 % with appendix letters. And right-justifying numbers and
6126 % left-justifying letters looks strange when there is less than 10
6127 % chapters. Have to read the whole toc once to know how many chapters
6128 % there are before deciding ...
6129 \hbox to
1em
{#1\hss}%
6132 % These macros generate individual entries in the table of contents.
6133 % The first argument is the chapter or section name.
6134 % The last argument is the page number.
6135 % The arguments in between are the chapter number, section number, ...
6137 % Parts, in the main contents. Replace the part number, which doesn't
6138 % exist, with an empty box. Let's hope all the numbers have the same width.
6139 % Also ignore the page number, which is conventionally not printed.
6140 \def\numeralbox{\setbox0=
\hbox{8}\hbox to
\wd0{\hfil}}
6141 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6143 % Parts, in the short toc.
6144 \def\shortpartentry#1#2#3#4{%
6146 \vskip.5\baselineskip plus
.15\baselineskip minus
.1\baselineskip
6147 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6150 % Chapters, in the main contents.
6151 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6153 % Chapters, in the short toc.
6154 % See comments in \dochapentry re vbox and related settings.
6155 \def\shortchapentry#1#2#3#4{%
6156 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6159 % Appendices, in the main contents.
6160 % Need the word Appendix, and a fixed-size box.
6162 \def\appendixbox#1{%
6163 % We use M since it's probably the widest letter.
6164 \setbox0 =
\hbox{\putwordAppendix{} M
}%
6165 \hbox to
\wd0{\putwordAppendix{} #1\hss}}
6167 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6169 % Unnumbered chapters.
6170 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6171 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6174 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6175 \let\appsecentry=
\numsecentry
6176 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6179 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6180 \let\appsubsecentry=
\numsubsecentry
6181 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6183 % And subsubsections.
6184 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6185 \let\appsubsubsecentry=
\numsubsubsecentry
6186 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6188 % This parameter controls the indentation of the various levels.
6189 % Same as \defaultparindent.
6190 \newdimen\tocindent \tocindent =
15pt
6192 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6195 % If the toc has to be broken over pages, we want it to be at chapters
6196 % if at all possible; hence the \penalty.
6197 \def\dochapentry#1#2{%
6198 \penalty-
300 \vskip1\baselineskip plus
.33\baselineskip minus
.25\baselineskip
6201 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6203 \nobreak\vskip .25\baselineskip plus
.1\baselineskip
6206 \def\dosecentry#1#2{\begingroup
6207 \secentryfonts \leftskip=
\tocindent
6208 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6211 \def\dosubsecentry#1#2{\begingroup
6212 \subsecentryfonts \leftskip=
2\tocindent
6213 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6216 \def\dosubsubsecentry#1#2{\begingroup
6217 \subsubsecentryfonts \leftskip=
3\tocindent
6218 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6221 % We use the same \entry macro as for the index entries.
6222 \let\tocentry =
\entry
6224 % Space between chapter (or whatever) number and the title.
6225 \def\labelspace{\hskip1em \relax}
6227 \def\dopageno#1{{\rm #1}}
6228 \def\doshortpageno#1{{\rm #1}}
6230 \def\chapentryfonts{\secfonts \rm}
6231 \def\secentryfonts{\textfonts}
6232 \def\subsecentryfonts{\textfonts}
6233 \def\subsubsecentryfonts{\textfonts}
6236 \message{environments,
}
6237 % @foo ... @end foo.
6239 % @tex ... @end tex escapes into raw TeX temporarily.
6240 % One exception: @ is still an escape character, so that @end tex works.
6241 % But \@ or @@ will get a plain @ character.
6244 \setupmarkupstyle{tex
}%
6245 \catcode `\\=
0 \catcode `\
{=
1 \catcode `\
}=
2
6246 \catcode `\$=
3 \catcode `\&=
4 \catcode `\#=
6
6247 \catcode `\^=
7 \catcode `
\_=
8 \catcode `\~=
\active \let~=
\tie
6258 % ' is active in math mode (mathcode"8000). So reset it, and all our
6259 % other math active characters (just in case), to plain's definitions.
6263 \let\bullet=
\ptexbullet
6268 \let\equiv=
\ptexequiv
6271 \let\indent=
\ptexindent
6272 \let\noindent=
\ptexnoindent
6279 \expandafter \let\csname top
\endcsname=
\ptextop % outer
6280 \let\frenchspacing=
\plainfrenchspacing
6282 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6283 \def\enddots{\relax\ifmmode\endldots\else$
\mathsurround=
0pt
\endldots\,$
\fi}%
6286 % There is no need to define \Etex.
6288 % Define @lisp ... @end lisp.
6289 % @lisp environment forms a group so it can rebind things,
6290 % including the definition of @end lisp (which normally is erroneous).
6292 % Amount to narrow the margins by for @lisp.
6293 \newskip\lispnarrowing \lispnarrowing=
0.4in
6295 % This is the definition that ^^M gets inside @lisp, @example, and other
6296 % such environments. \null is better than a space, since it doesn't
6298 \def\lisppar{\null\endgraf}
6300 % This space is always present above and below environments.
6301 \newskip\envskipamount \envskipamount =
0pt
6303 % Make spacing and below environment symmetrical. We use \parskip here
6304 % to help in doing that, since in @example-like environments \parskip
6305 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6306 % start of the next paragraph will insert \parskip.
6308 \def\aboveenvbreak{{%
6309 % =10000 instead of <10000 because of a special case in \itemzzz and
6310 % \sectionheading, q.v.
6311 \ifnum \lastpenalty=
10000 \else
6312 \advance\envskipamount by
\parskip
6314 \ifdim\lastskip<
\envskipamount
6316 % it's not a good place to break if the last penalty was \nobreak
6318 \ifnum\lastpenalty<
10000 \penalty-
50 \fi
6319 \vskip\envskipamount
6324 \let\afterenvbreak =
\aboveenvbreak
6326 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6327 % also clear it, so that its embedded environments do the narrowing again.
6328 \let\nonarrowing=
\relax
6330 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6331 % environment contents.
6332 \font\circle=lcircle10
6334 \newdimen\cartouter\newdimen\cartinner
6335 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6336 \circthick=
\fontdimen8\circle
6338 \def\ctl{{\circle\char'
013\hskip -
6pt
}}% 6pt from pl file: 1/2charwidth
6339 \def\ctr{{\hskip 6pt
\circle\char'
010}}
6340 \def\cbl{{\circle\char'
012\hskip -
6pt
}}
6341 \def\cbr{{\hskip 6pt
\circle\char'
011}}
6342 \def\carttop{\hbox to
\cartouter{\hskip\lskip
6343 \ctl\leaders\hrule height
\circthick\hfil\ctr
6345 \def\cartbot{\hbox to
\cartouter{\hskip\lskip
6346 \cbl\leaders\hrule height
\circthick\hfil\cbr
6349 \newskip\lskip\newskip\rskip
6352 \ifhmode\par\fi % can't be in the midst of a paragraph.
6354 \lskip=
\leftskip \rskip=
\rightskip
6355 \leftskip=
0pt
\rightskip=
0pt
% we want these *outside*.
6356 \cartinner=
\hsize \advance\cartinner by-
\lskip
6357 \advance\cartinner by-
\rskip
6359 \advance\cartouter by
18.4pt
% allow for 3pt kerns on either
6360 % side, and for 6pt waste from
6361 % each corner char, and rule thickness
6362 \normbskip=
\baselineskip \normpskip=
\parskip \normlskip=
\lineskip
6363 % Flag to tell @lisp, etc., not to narrow margin.
6364 \let\nonarrowing = t
%
6366 % If this cartouche directly follows a sectioning command, we need the
6367 % \parskip glue (backspaced over by default) or the cartouche can
6368 % collide with the section heading.
6369 \ifnum\lastpenalty>
10000 \vskip\parskip \penalty\lastpenalty \fi
6372 \baselineskip=
0pt
\parskip=
0pt
\lineskip=
0pt
6380 \baselineskip=
\normbskip
6381 \lineskip=
\normlskip
6384 \comment % For explanation, see the end of def\group.
6399 % This macro is called at the beginning of all the @example variants,
6401 \newdimen\nonfillparindent
6404 \hfuzz =
12pt
% Don't be fussy
6405 \sepspaces % Make spaces be word-separators rather than space tokens.
6406 \let\par =
\lisppar % don't ignore blank lines
6407 \obeylines % each line of input is a line of output
6409 % Turn off paragraph indentation but redefine \indent to emulate
6410 % the normal \indent.
6411 \nonfillparindent=
\parindent
6413 \let\indent\nonfillindent
6415 \emergencystretch =
0pt
% don't try to avoid overfull boxes
6416 \ifx\nonarrowing\relax
6417 \advance \leftskip by
\lispnarrowing
6418 \exdentamount=
\lispnarrowing
6420 \let\nonarrowing =
\relax
6422 \let\exdent=
\nofillexdent
6427 % We want to swallow spaces (but not other tokens) after the fake
6428 % @indent in our nonfill-environments, where spaces are normally
6429 % active and set to @tie, resulting in them not being ignored after
6431 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6432 \gdef\nonfillindentcheck{%
6434 \expandafter\nonfillindentgobble%
6436 \leavevmode\nonfillindentbox%
6440 \def\nonfillindentgobble#1{\nonfillindent}
6441 \def\nonfillindentbox{\hbox to
\nonfillparindent{\hss}}
6443 % If you want all examples etc. small: @set dispenvsize small.
6444 % If you want even small examples the full size: @set dispenvsize nosmall.
6445 % This affects the following displayed environments:
6446 % @example, @display, @format, @lisp
6448 \def\smallword{small
}
6449 \def\nosmallword{nosmall
}
6450 \let\SETdispenvsize\relax
6451 \def\setnormaldispenv{%
6452 \ifx\SETdispenvsize\smallword
6453 % end paragraph for sake of leading, in case document has no blank
6454 % line. This is redundant with what happens in \aboveenvbreak, but
6455 % we need to do it before changing the fonts, and it's inconvenient
6456 % to change the fonts afterward.
6457 \ifnum \lastpenalty=
10000 \else \endgraf \fi
6458 \smallexamplefonts \rm
6461 \def\setsmalldispenv{%
6462 \ifx\SETdispenvsize\nosmallword
6464 \ifnum \lastpenalty=
10000 \else \endgraf \fi
6465 \smallexamplefonts \rm
6469 % We often define two environments, @foo and @smallfoo.
6470 % Let's do it in one command. #1 is the env name, #2 the definition.
6471 \def\makedispenvdef#1#2{%
6472 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6473 \expandafter\envdef\csname small
#1\endcsname {\setsmalldispenv #2}%
6474 \expandafter\let\csname E
#1\endcsname \afterenvbreak
6475 \expandafter\let\csname Esmall
#1\endcsname \afterenvbreak
6478 % Define two environment synonyms (#1 and #2) for an environment.
6479 \def\maketwodispenvdef#1#2#3{%
6480 \makedispenvdef{#1}{#3}%
6481 \makedispenvdef{#2}{#3}%
6484 % @lisp: indented, narrowed, typewriter font;
6485 % @example: same as @lisp.
6487 % @smallexample and @smalllisp: use smaller fonts.
6488 % Originally contributed by Pavel@xerox.
6490 \maketwodispenvdef{lisp
}{example
}{%
6492 \tt\setupmarkupstyle{example
}%
6493 \let\kbdfont =
\kbdexamplefont % Allow @kbd to do something special.
6494 \gobble % eat return
6496 % @display/@smalldisplay: same as @lisp except keep current font.
6498 \makedispenvdef{display
}{%
6503 % @format/@smallformat: same as @display except don't narrow margins.
6505 \makedispenvdef{format
}{%
6506 \let\nonarrowing = t
%
6511 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6513 \let\nonarrowing = t
%
6517 \let\Eflushleft =
\afterenvbreak
6521 \envdef\flushright{%
6522 \let\nonarrowing = t
%
6524 \advance\leftskip by
0pt plus
1fill
\relax
6527 \let\Eflushright =
\afterenvbreak
6530 % @raggedright does more-or-less normal line breaking but no right
6531 % justification. From plain.tex.
6532 \envdef\raggedright{%
6533 \rightskip0pt plus2em
\spaceskip.3333em
\xspaceskip.5em
\relax
6535 \let\Eraggedright\par
6537 \envdef\raggedleft{%
6538 \parindent=
0pt
\leftskip0pt plus2em
6539 \spaceskip.3333em
\xspaceskip.5em
\parfillskip=
0pt
6540 \hbadness=
10000 % Last line will usually be underfull, so turn off
6541 % badness reporting.
6543 \let\Eraggedleft\par
6545 \envdef\raggedcenter{%
6546 \parindent=
0pt
\rightskip0pt plus1em
\leftskip0pt plus1em
6547 \spaceskip.3333em
\xspaceskip.5em
\parfillskip=
0pt
6548 \hbadness=
10000 % Last line will usually be underfull, so turn off
6549 % badness reporting.
6551 \let\Eraggedcenter\par
6554 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6555 % and narrows the margins. We keep \parskip nonzero in general, since
6556 % we're doing normal filling. So, when using \aboveenvbreak and
6557 % \afterenvbreak, temporarily make \parskip 0.
6559 \makedispenvdef{quotation
}{\quotationstart}
6561 \def\quotationstart{%
6562 {\parskip=
0pt
\aboveenvbreak}% because \aboveenvbreak inserts \parskip
6565 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6566 \ifx\nonarrowing\relax
6567 \advance\leftskip by
\lispnarrowing
6568 \advance\rightskip by
\lispnarrowing
6569 \exdentamount =
\lispnarrowing
6571 \let\nonarrowing =
\relax
6573 \parsearg\quotationlabel
6576 % We have retained a nonzero parskip for the environment, since we're
6577 % doing normal filling.
6581 \ifx\quotationauthor\thisisundefined\else
6583 \leftline{\kern 2\leftskip \sl ---
\quotationauthor}%
6585 {\parskip=
0pt
\afterenvbreak}%
6587 \def\Esmallquotation{\Equotation}
6589 % If we're given an argument, typeset it in bold with a colon after.
6590 \def\quotationlabel#1{%
6592 \ifx\temp\empty \else
6598 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6599 % If we want to allow any <char> as delimiter,
6600 % we need the curly braces so that makeinfo sees the @verb command, eg:
6601 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6603 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6605 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6606 % active too. Otherwise, they get lost as the first character on a
6609 \do\
\do\\
\do\
{\do\
}\do\$
\do\&
%
6610 \do\#
\do\^
\do\^^K
\do\_\do\^^A
\do\%
\do\~
%
6611 \do\<
\do\>
\do\|
\do\@
\do+
\do\"
%
6612 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6613 % @set txicodequotebacktick will not have effect on @verb and
6614 % @verbatim, and ?` and !` ligatures won't get disabled.
6619 \def\uncatcodespecials{%
6620 \def\do#
#1{\catcode`#
#1=
\other}\dospecials}
6622 % Setup for the @verb command.
6624 % Eight spaces for a tab
6626 \catcode`\^^I=
\active
6627 \gdef\tabeightspaces{\catcode`\^^I=
\active\def^^I
{\ \ \ \ \ \ \ \
}}
6631 \tt % easiest (and conventionally used) font for verbatim
6632 \def\par{\leavevmode\endgraf}%
6633 \setupmarkupstyle{verb
}%
6635 % Respect line breaks,
6636 % print special symbols as themselves, and
6637 % make each space count
6638 % must do in this order:
6639 \obeylines \uncatcodespecials \sepspaces
6642 % Setup for the @verbatim environment
6644 % Real tab expansion.
6645 \newdimen\tabw \setbox0=
\hbox{\tt\space} \tabw=
8\wd0 % tab amount
6647 % We typeset each line of the verbatim in an \hbox, so we can handle
6648 % tabs. The \global is in case the verbatim line starts with an accent,
6649 % or some other command that starts with a begin-group. Otherwise, the
6650 % entire \verbbox would disappear at the corresponding end-group, before
6651 % it is typeset. Meanwhile, we can't have nested verbatim commands
6652 % (can we?), so the \global won't be overwriting itself.
6654 \def\starttabbox{\global\setbox\verbbox=
\hbox\bgroup}
6657 \catcode`\^^I=
\active
6659 \catcode`\^^I=
\active
6660 \def^^I
{\leavevmode\egroup
6661 \dimen\verbbox=
\wd\verbbox % the width so far, or since the previous tab
6662 \divide\dimen\verbbox by
\tabw
6663 \multiply\dimen\verbbox by
\tabw % compute previous multiple of \tabw
6664 \advance\dimen\verbbox by
\tabw % advance to next multiple of \tabw
6665 \wd\verbbox=
\dimen\verbbox \box\verbbox \starttabbox
6670 % start the verbatim environment.
6671 \def\setupverbatim{%
6672 \let\nonarrowing = t
%
6674 \tt % easiest (and conventionally used) font for verbatim
6675 % The \leavevmode here is for blank lines. Otherwise, we would
6676 % never \starttabox and the \egroup would end verbatim mode.
6677 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6679 \setupmarkupstyle{verbatim
}%
6680 % Respect line breaks,
6681 % print special symbols as themselves, and
6682 % make each space count.
6683 % Must do in this order:
6684 \obeylines \uncatcodespecials \sepspaces
6685 \everypar{\starttabbox}%
6688 % Do the @verb magic: verbatim text is quoted by unique
6689 % delimiter characters. Before first delimiter expect a
6690 % right brace, after last delimiter expect closing brace:
6692 % \def\doverb'{'<char>#1<char>'}'{#1}
6694 % [Knuth] p. 382; only eat outer {}
6696 \catcode`
[=
1\catcode`
]=
2\catcode`\
{=
\other\catcode`\
}=
\other
6697 \gdef\doverb{#1[\def\next#
#1#1}[#
#1\endgroup]\next]
6700 \def\verb{\begingroup\setupverb\doverb}
6703 % Do the @verbatim magic: define the macro \doverbatim so that
6704 % the (first) argument ends when '@end verbatim' is reached, ie:
6706 % \def\doverbatim#1@end verbatim{#1}
6708 % For Texinfo it's a lot easier than for LaTeX,
6709 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6710 % we need not redefine '\', '{' and '}'.
6712 % Inspired by LaTeX's verbatim command set [latex.ltx]
6717 % ignore everything up to the first ^^M, that's the newline at the end
6718 % of the @verbatim input line itself. Otherwise we get an extra blank
6719 % line in the output.
6720 \xdef\doverbatim#1^^M
#2@end verbatim
{#2\noexpand\end\gobble verbatim
}%
6721 % We really want {...\end verbatim} in the body of the macro, but
6722 % without the active space; thus we have to use \xdef and \gobble.
6726 \setupverbatim\doverbatim
6728 \let\Everbatim =
\afterenvbreak
6731 % @verbatiminclude FILE - insert text of file in verbatim environment.
6733 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6735 \def\doverbatiminclude#1{%
6737 \makevalueexpandable
6739 \indexnofonts % Allow `@@' and other weird things in file names.
6740 \wlog{texinfo.tex: doing @verbatiminclude of
#1^^J
}%
6746 % @copying ... @end copying.
6747 % Save the text away for @insertcopying later.
6749 % We save the uninterpreted tokens, rather than creating a box.
6750 % Saving the text in a box would be much easier, but then all the
6751 % typesetting commands (@smallbook, font changes, etc.) have to be done
6752 % beforehand -- and a) we want @copying to be done first in the source
6753 % file; b) letting users define the frontmatter in as flexible order as
6754 % possible is very desirable.
6756 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6757 \def\docopying#1@end copying
{\endgroup\def\copyingtext{#1}}
6759 \def\insertcopying{%
6761 \parindent =
0pt
% paragraph indentation looks wrong on title page
6762 \scanexp\copyingtext
6770 \newskip\defbodyindent \defbodyindent=
.4in
6771 \newskip\defargsindent \defargsindent=
50pt
6772 \newskip\deflastargmargin \deflastargmargin=
18pt
6773 \newcount\defunpenalty
6775 % Start the processing of @deffn:
6777 \ifnum\lastpenalty<
10000
6779 \defunpenalty=
10003 % Will keep this @deffn together with the
6780 % following @def command, see below.
6782 % If there are two @def commands in a row, we'll have a \nobreak,
6783 % which is there to keep the function description together with its
6784 % header. But if there's nothing but headers, we need to allow a
6785 % break somewhere. Check specifically for penalty 10002, inserted
6786 % by \printdefunline, instead of 10000, since the sectioning
6787 % commands also insert a nobreak penalty, and we don't want to allow
6788 % a break between a section heading and a defun.
6790 % As a further refinement, we avoid "club" headers by signalling
6791 % with penalty of 10003 after the very first @deffn in the
6792 % sequence (see above), and penalty of 10002 after any following
6794 \ifnum\lastpenalty=
10002 \penalty2000 \else \defunpenalty=
10002 \fi
6796 % Similarly, after a section heading, do not allow a break.
6797 % But do insert the glue.
6798 \medskip % preceded by discardable penalty, so not a breakpoint
6802 \advance\leftskip by
\defbodyindent
6803 \exdentamount=
\defbodyindent
6807 % First, check whether we are in the right environment:
6810 % As above, allow line break if we have multiple x headers in a row.
6811 % It's not a great place, though.
6812 \ifnum\lastpenalty=
10002 \penalty3000 \else \defunpenalty=
10002 \fi
6814 % And now, it's time to reuse the body of the original defun:
6815 \expandafter\gobbledefun#1%
6817 \def\gobbledefun#1\startdefun{}
6819 % \printdefunline \deffnheader{text}
6821 \def\printdefunline#1#2{%
6823 % call \deffnheader:
6826 \interlinepenalty =
10000
6827 \advance\rightskip by
0pt plus
1fil
\relax
6829 \nobreak\vskip -
\parskip
6830 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6831 % Some of the @defun-type tags do not enable magic parentheses,
6832 % rendering the following check redundant. But we don't optimize.
6837 \def\Edefun{\endgraf\medbreak}
6839 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6840 % the only thing remaining is to define \deffnheader.
6843 \expandafter\let\csname E
#1\endcsname =
\Edefun
6844 \edef\temp{\noexpand\domakedefun
6845 \makecsname{#1}\makecsname{#1x
}\makecsname{#1header
}}%
6849 % \domakedefun \deffn \deffnx \deffnheader
6851 % Define \deffn and \deffnx, without parameters.
6852 % \deffnheader has to be defined explicitly.
6854 \def\domakedefun#1#2#3{%
6857 \doingtypefnfalse % distinguish typed functions from all else
6858 \parseargusing\activeparens{\printdefunline#3}%
6860 \def#2{\dodefunx#1}%
6864 \newif\ifdoingtypefn % doing typed function?
6865 \newif\ifrettypeownline % typeset return type on its own line?
6867 % @deftypefnnewline on|off says whether the return type of typed functions
6868 % are printed on their own line. This affects @deftypefn, @deftypefun,
6869 % @deftypeop, and @deftypemethod.
6871 \parseargdef\deftypefnnewline{%
6874 \expandafter\let\csname SETtxideftypefnnl
\endcsname
6876 \else\ifx\temp\offword
6877 \expandafter\let\csname SETtxideftypefnnl
\endcsname
6880 \errhelp =
\EMsimple
6881 \errmessage{Unknown @txideftypefnnl value `
\temp',
6886 % Untyped functions:
6888 % @deffn category name args
6889 \makedefun{deffn
}{\deffngeneral{}}
6891 % @deffn category class name args
6892 \makedefun{defop
}#1 {\defopon{#1\
\putwordon}}
6894 % \defopon {category on}class name args
6895 \def\defopon#1#2 {\deffngeneral{\putwordon\
\code{#2}}{#1\
\code{#2}} }
6897 % \deffngeneral {subind}category name args
6899 \def\deffngeneral#1#2 #3 #4\endheader{%
6900 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6901 \dosubind{fn
}{\code{#3}}{#1}%
6902 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6907 % @deftypefn category type name args
6908 \makedefun{deftypefn
}{\deftypefngeneral{}}
6910 % @deftypeop category class type name args
6911 \makedefun{deftypeop
}#1 {\deftypeopon{#1\
\putwordon}}
6913 % \deftypeopon {category on}class type name args
6914 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\
\code{#2}}{#1\
\code{#2}} }
6916 % \deftypefngeneral {subind}category type name args
6918 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6919 \dosubind{fn
}{\code{#4}}{#1}%
6921 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6926 % @deftypevr category type var args
6927 \makedefun{deftypevr
}{\deftypecvgeneral{}}
6929 % @deftypecv category class type var args
6930 \makedefun{deftypecv
}#1 {\deftypecvof{#1\
\putwordof}}
6932 % \deftypecvof {category of}class type var args
6933 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\
\code{#2}}{#1\
\code{#2}} }
6935 % \deftypecvgeneral {subind}category type var args
6937 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6938 \dosubind{vr
}{\code{#4}}{#1}%
6939 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6942 % Untyped variables:
6944 % @defvr category var args
6945 \makedefun{defvr
}#1 {\deftypevrheader{#1} {} }
6947 % @defcv category class var args
6948 \makedefun{defcv
}#1 {\defcvof{#1\
\putwordof}}
6950 % \defcvof {category of}class var args
6951 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6955 % @deftp category name args
6956 \makedefun{deftp
}#1 #2 #3\endheader{%
6957 \doind{tp
}{\code{#2}}%
6958 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6961 % Remaining @defun-like shortcuts:
6962 \makedefun{defun
}{\deffnheader{\putwordDeffunc} }
6963 \makedefun{defmac
}{\deffnheader{\putwordDefmac} }
6964 \makedefun{defspec
}{\deffnheader{\putwordDefspec} }
6965 \makedefun{deftypefun
}{\deftypefnheader{\putwordDeffunc} }
6966 \makedefun{defvar
}{\defvrheader{\putwordDefvar} }
6967 \makedefun{defopt
}{\defvrheader{\putwordDefopt} }
6968 \makedefun{deftypevar
}{\deftypevrheader{\putwordDefvar} }
6969 \makedefun{defmethod
}{\defopon\putwordMethodon}
6970 \makedefun{deftypemethod
}{\deftypeopon\putwordMethodon}
6971 \makedefun{defivar
}{\defcvof\putwordInstanceVariableof}
6972 \makedefun{deftypeivar
}{\deftypecvof\putwordInstanceVariableof}
6974 % \defname, which formats the name of the @def (not the args).
6975 % #1 is the category, such as "Function".
6976 % #2 is the return type, if any.
6977 % #3 is the function name.
6979 % We are followed by (but not passed) the arguments, if any.
6981 \def\defname#1#2#3{%
6983 % Get the values of \leftskip and \rightskip as they were outside the @def...
6984 \advance\leftskip by -
\defbodyindent
6986 % Determine if we are typesetting the return type of a typed function
6987 % on a line by itself.
6988 \rettypeownlinefalse
6989 \ifdoingtypefn % doing a typed function specifically?
6990 % then check user option for putting return type on its own line:
6991 \expandafter\ifx\csname SETtxideftypefnnl
\endcsname\relax \else
6996 % How we'll format the category name. Putting it in brackets helps
6997 % distinguish it from the body text that may end up on the next line
7000 \setbox0=
\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7002 % Figure out line sizes for the paragraph shape. We'll always have at
7006 % The first line needs space for \box0; but if \rightskip is nonzero,
7007 % we need only space for the part of \box0 which exceeds it:
7008 \dimen0=
\hsize \advance\dimen0 by -
\wd0 \advance\dimen0 by
\rightskip
7010 % If doing a return type on its own line, we'll have another line.
7012 \advance\tempnum by
1
7013 \def\maybeshapeline{0in
\hsize}%
7015 \def\maybeshapeline{}%
7018 % The continuations:
7019 \dimen2=
\hsize \advance\dimen2 by -
\defargsindent
7021 % The final paragraph shape:
7022 \parshape \tempnum 0in
\dimen0 \maybeshapeline \defargsindent \dimen2
7024 % Put the category name at the right margin.
7027 \hfil\box0 \kern-
\hsize
7028 % \hsize has to be shortened this way:
7030 % Intentionally do not respect \rightskip, since we need the space.
7033 % Allow all lines to be underfull without complaint:
7034 \tolerance=
10000 \hbadness=
10000
7035 \exdentamount=
\defbodyindent
7037 % defun fonts. We use typewriter by default (used to be bold) because:
7038 % . we're printing identifiers, they should be in tt in principle.
7039 % . in languages with many accents, such as Czech or French, it's
7040 % common to leave accents off identifiers. The result looks ok in
7041 % tt, but exceedingly strange in rm.
7042 % . we don't want -- and --- to be treated as ligatures.
7043 % . this still does not fix the ?` and !` ligatures, but so far no
7044 % one has made identifiers using them :).
7046 \def\temp{#2}% text of the return type
7047 \ifx\temp\empty\else
7048 \tclose{\temp}% typeset the return type
7050 % put return type on its own line; prohibit line break following:
7051 \hfil\vadjust{\nobreak}\break
7053 \space % type on same line, so just followed by a space
7055 \fi % no return type
7056 #3% output function name
7058 {\rm\enskip}% hskip 0.5 em of \tenrm
7061 % arguments will be output next, if any.
7064 % Print arguments in slanted roman (not ttsl), inconsistently with using
7065 % tt for the name. This is because literal text is sometimes needed in
7066 % the argument list (groff manual), and ttsl and tt are not very
7067 % distinguishable. Prevent hyphenation at `-' chars.
7070 % use sl by default (not ttsl),
7072 \df \sl \hyphenchar\font=
0
7074 % On the other hand, if an argument has two dashes (for instance), we
7075 % want a way to get ttsl. We used to recommend @var for that, so
7076 % leave the code in, but it's strange for @var to lead to typewriter.
7077 % Nowadays we recommend @code, since the difference between a ttsl hyphen
7078 % and a tt hyphen is pretty tiny. @code also disables ?` !`.
7079 \def\var#
#1{{\setupmarkupstyle{var
}\ttslanted{#
#1}}}%
7081 \sl\hyphenchar\font=
45
7084 % We want ()&[] to print specially on the defun line.
7087 \catcode`\(=
\active \catcode`\)=
\active
7088 \catcode`\
[=
\active \catcode`\
]=
\active
7092 % Make control sequences which act like normal parenthesis chars.
7093 \let\lparen = (
\let\rparen = )
7095 % Be sure that we always have a definition for `(', etc. For example,
7096 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7097 % so TeX would otherwise complain about undefined control sequence.
7100 \global\let(=
\lparen \global\let)=
\rparen
7101 \global\let[=
\lbrack \global\let]=
\rbrack
7104 \gdef\boldbrax{\let(=
\opnr\let)=
\clnr\let[=
\lbrb\let]=
\rbrb}
7105 \gdef\magicamp{\let&=
\amprm}
7108 \newcount\parencount
7110 % If we encounter &foo, then turn on ()-hacking afterwards
7112 \def\amprm#1 {\ampseentrue{\bf\&
#1 }}
7116 % At the first level, print parens in roman,
7117 % otherwise use the default font.
7118 \ifnum \parencount=
1 \rm \fi
7120 % The \sf parens (in \boldbrax) actually are a little bolder than
7121 % the contained text. This is especially needed for [ and ] .
7125 \def\infirstlevel#1{%
7132 \def\bfafterword#1 {#1 \bf}
7135 \global\advance\parencount by
1
7137 \infirstlevel \bfafterword
7142 \global\advance\parencount by -
1
7145 \newcount\brackcount
7147 \global\advance\brackcount by
1
7152 \global\advance\brackcount by -
1
7155 \def\checkparencounts{%
7156 \ifnum\parencount=
0 \else \badparencount \fi
7157 \ifnum\brackcount=
0 \else \badbrackcount \fi
7159 % these should not use \errmessage; the glibc manual, at least, actually
7160 % has such constructs (when documenting function pointers).
7161 \def\badparencount{%
7162 \message{Warning: unbalanced parentheses in @def...
}%
7163 \global\parencount=
0
7165 \def\badbrackcount{%
7166 \message{Warning: unbalanced square brackets in @def...
}%
7167 \global\brackcount=
0
7174 % To do this right we need a feature of e-TeX, \scantokens,
7175 % which we arrange to emulate with a temporary file in ordinary TeX.
7176 \ifx\eTeXversion\thisisundefined
7177 \newwrite\macscribble
7180 \immediate\openout\macscribble=
\jobname.tmp
7181 \immediate\write\macscribble{\the\toks0}%
7182 \immediate\closeout\macscribble
7187 \def\scanmacro#1{\begingroup
7189 \let\xeatspaces\eatspaces
7191 % Undo catcode changes of \startcontents and \doprintindex
7192 % When called from @insertcopying or (short)caption, we need active
7193 % backslash to get it printed correctly. Previously, we had
7194 % \catcode`\\=\other instead. We'll see whether a problem appears
7195 % with macro expansion. --kasal, 19aug04
7196 \catcode`\@=
0 \catcode`\\=
\active \escapechar=`\@
7198 % ... and for \example:
7201 % The \empty here causes a following catcode 5 newline to be eaten as
7202 % part of reading whitespace after a control sequence. It does not
7203 % eat a catcode 13 newline. There's no good way to handle the two
7204 % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
7205 % would then have different behavior). See the Macro Details node in
7206 % the manual for the workaround we recommend for macros and
7207 % line-oriented commands.
7209 \scantokens{#1\empty}%
7213 \edef\temp{\noexpand\scanmacro{#1}}%
7217 \newcount\paramno % Count of parameters
7218 \newtoks\macname % Macro name
7219 \newif\ifrecursive % Is it recursive?
7221 % List of all defined macros in the form
7222 % \definedummyword\macro1\definedummyword\macro2...
7223 % Currently is also contains all @aliases; the list can be split
7224 % if there is a need.
7227 % Add the macro to \macrolist
7228 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7229 \def\addtomacrolistxxx#1{%
7230 \toks0 =
\expandafter{\macrolist\definedummyword#1}%
7231 \xdef\macrolist{\the\toks0}%
7235 % This does \let #1 = #2, with \csnames; that is,
7236 % \let \csname#1\endcsname = \csname#2\endcsname
7237 % (except of course we have to play expansion games).
7241 \csname#1\expandafter\endcsname
7245 % Trim leading and trailing spaces off a string.
7246 % Concepts from aro-bend problem 15 (see CTAN).
7248 \gdef\eatspaces #1{\expandafter\trim@
\expandafter{#1 }}
7249 \gdef\trim@
#1{\trim@@ @
#1 @
#1 @ @@
}
7250 \gdef\trim@@
#1@
#2@
#3@@
{\trim@@@
\empty #2 @
}
7252 \unbrace{\gdef\trim@@@
#1 } #2@
{#1}
7255 % Trim a single trailing ^^M off a string.
7256 {\catcode`\^^M=
\other \catcode`
\Q=
3%
7257 \gdef\eatcr #1{\eatcra #1Q^^MQ
}%
7258 \gdef\eatcra#1^^MQ
{\eatcrb#1Q
}%
7259 \gdef\eatcrb#1Q
#2Q
{#1}%
7262 % Macro bodies are absorbed as an argument in a context where
7263 % all characters are catcode 10, 11 or 12, except \ which is active
7264 % (as in normal texinfo). It is necessary to change the definition of \
7265 % to recognize macro arguments; this is the job of \mbodybackslash.
7267 % Non-ASCII encodings make 8-bit characters active, so un-activate
7268 % them to avoid their expansion. Must do this non-globally, to
7269 % confine the change to the current group.
7271 % It's necessary to have hard CRs when the macro is executed. This is
7272 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7273 % body, and then making it the \newlinechar in \scanmacro.
7275 \def\scanctxt{% used as subroutine
7285 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7288 \def\scanargctxt{% used for copying and captions, not macros.
7291 \catcode`\^^M=
\other
7294 \def\macrobodyctxt{% used for @macro definitions
7298 \catcode`\^^M=
\other
7302 \def\macroargctxt{% used when scanning invocations
7306 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
7307 % for the single characters \ { }. Thus, we end up with the "commands"
7308 % that would be written @\ @{ @} in a Texinfo document.
7310 % We already have @{ and @}. For @\, we define it here, and only for
7311 % this purpose, to produce a typewriter backslash (so, the @\ that we
7312 % define for @math can't be used with @macro calls):
7314 \def\\
{\normalbackslash}%
7316 % We would like to do this for \, too, since that is what makeinfo does.
7317 % But it is not possible, because Texinfo already has a command @, for a
7318 % cedilla accent. Documents must use @comma{} instead.
7320 % \anythingelse will almost certainly be an error of some kind.
7323 % \mbodybackslash is the definition of \ in @macro bodies.
7324 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7325 % where N is the macro parameter number.
7326 % We define \csname macarg.\endcsname to be \realbackslash, so
7327 % \\ in macro replacement text gets you a backslash.
7329 {\catcode`@=
0 @catcode`@\=@active
7330 @gdef@usembodybackslash
{@let\=@mbodybackslash
}
7331 @gdef@mbodybackslash
#1\
{@csname macarg.
#1@endcsname
}
7333 \expandafter\def\csname macarg.
\endcsname{\realbackslash}
7335 \def\margbackslash#1{\char`\
#1 }
7337 \def\macro{\recursivefalse\parsearg\macroxxx}
7338 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7341 \getargs{#1}% now \macname is the macname and \argl the arglist
7342 \ifx\argl\empty % no arguments
7345 \expandafter\parsemargdef \argl;
%
7346 \if\paramno>
256\relax
7347 \ifx\eTeXversion\thisisundefined
7348 \errhelp =
\EMsimple
7349 \errmessage{You need eTeX to compile a file with macros with more than
256 arguments
}
7353 \if1\csname ismacro.
\the\macname\endcsname
7354 \message{Warning: redefining
\the\macname}%
7356 \expandafter\ifx\csname \the\macname\endcsname \relax
7357 \else \errmessage{Macro name
\the\macname\space already defined
}\fi
7358 \global\cslet{macsave.
\the\macname}{\the\macname}%
7359 \global\expandafter\let\csname ismacro.
\the\macname\endcsname=
1%
7360 \addtomacrolist{\the\macname}%
7362 \begingroup \macrobodyctxt
7363 \ifrecursive \expandafter\parsermacbody
7364 \else \expandafter\parsemacbody
7367 \parseargdef\unmacro{%
7368 \if1\csname ismacro.
#1\endcsname
7369 \global\cslet{#1}{macsave.
#1}%
7370 \global\expandafter\let \csname ismacro.
#1\endcsname=
0%
7371 % Remove the macro name from \macrolist:
7373 \expandafter\let\csname#1\endcsname \relax
7374 \let\definedummyword\unmacrodo
7375 \xdef\macrolist{\macrolist}%
7378 \errmessage{Macro
#1 not defined
}%
7382 % Called by \do from \dounmacro on each macro. The idea is to omit any
7383 % macro definitions that have been changed to \relax.
7389 \noexpand\definedummyword \noexpand#1%
7393 % This makes use of the obscure feature that if the last token of a
7394 % <parameter list> is #, then the preceding argument is delimited by
7395 % an opening brace, and that opening brace is not consumed.
7396 \def\getargs#1{\getargsxxx#1{}}
7397 \def\getargsxxx#1#
{\getmacname #1 \relax\getmacargs}
7398 \def\getmacname#1 #2\relax{\macname=
{#1}}
7399 \def\getmacargs#1{\def\argl{#1}}
7401 % For macro processing make @ a letter so that we can make Texinfo private macro names.
7402 \edef\texiatcatcode{\the\catcode`\@
}
7403 \catcode `@=
11\relax
7405 % Parse the optional {params} list. Set up \paramno and \paramlist
7406 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
7407 % in the params list to some hook where the argument si to be expanded. If
7408 % there are less than 10 arguments that hook is to be replaced by ##N where N
7409 % is the position in that list, that is to say the macro arguments are to be
7410 % defined `a la TeX in the macro body.
7412 % That gets used by \mbodybackslash (above).
7414 % We need to get `macro parameter char #' into several definitions.
7415 % The technique used is stolen from LaTeX: let \hash be something
7416 % unexpandable, insert that wherever you need a #, and then redefine
7417 % it to # just before using the token list produced.
7419 % The same technique is used to protect \eatspaces till just before
7420 % the macro is used.
7422 % If there are 10 or more arguments, a different technique is used, where the
7423 % hook remains in the body, and when macro is to be expanded the body is
7424 % processed again to replace the arguments.
7426 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7427 % argument N value and then \edef the body (nothing else will expand because of
7428 % the catcode regime underwhich the body was input).
7430 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7431 % arguments, you need that no macro has more than 256 arguments, otherwise an
7432 % error is produced.
7433 \def\parsemargdef#1;
{%
7434 \paramno=
0\def\paramlist{}%
7436 \let\xeatspaces\relax
7437 \parsemargdefxxx#1,;,
%
7438 % In case that there are 10 or more arguments we parse again the arguments
7439 % list to set new definitions for the \macarg.BLAH macros corresponding to
7440 % each BLAH argument. It was anyhow needed to parse already once this list
7441 % in order to count the arguments, and as macros with at most 9 arguments
7442 % are by far more frequent than macro with 10 or more arguments, defining
7443 % twice the \macarg.BLAH macros does not cost too much processing power.
7444 \ifnum\paramno<
10\relax\else
7446 \parsemmanyargdef@@
#1,;,
% 10 or more arguments
7449 \def\parsemargdefxxx#1,
{%
7450 \if#1;
\let\next=
\relax
7451 \else \let\next=
\parsemargdefxxx
7452 \advance\paramno by
1
7453 \expandafter\edef\csname macarg.
\eatspaces{#1}\endcsname
7454 {\xeatspaces{\hash\the\paramno}}%
7455 \edef\paramlist{\paramlist\hash\the\paramno,
}%
7458 \def\parsemmanyargdef@@
#1,
{%
7459 \if#1;
\let\next=
\relax
7461 \let\next=
\parsemmanyargdef@@
7462 \edef\tempb{\eatspaces{#1}}%
7463 \expandafter\def\expandafter\tempa
7464 \expandafter{\csname macarg.
\tempb\endcsname}%
7465 % Note that we need some extra \noexpand\noexpand, this is because we
7466 % don't want \the to be expanded in the \parsermacbody as it uses an
7468 \expandafter\edef\tempa
7469 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7470 \advance\paramno by
1\relax
7473 % These two commands read recursive and nonrecursive macro bodies.
7474 % (They're different since rec and nonrec macros end differently.)
7477 \catcode `\@
\texiatcatcode
7478 \long\def\parsemacbody#1@end macro
%
7479 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7480 \long\def\parsermacbody#1@end rmacro
%
7481 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7482 \catcode `\@=
11\relax
7487 \long\def\nillm@
{\nil@
}%
7489 % This macro is expanded during the Texinfo macro expansion, not during its
7490 % definition. It gets all the arguments values and assigns them to macros
7493 % #1 is the macro name
7494 % #2 is the list of argument names
7495 % #3 is the list of argument values
7496 \def\getargvals@
#1#2#3{%
7497 \def\macargdeflist@
{}%
7498 \def\saveparamlist@
{#2}% Need to keep a copy for parameter expansion.
7499 \def\paramlist{#2,
\nil@
}%
7503 \def\argvaluelist{#3,
\nil@
}%
7514 \ifx\paramlist\nilm@
7515 % Some sanity check needed here that \argvaluelist is also empty.
7516 \ifx\argvaluelist\nillm@
7518 \errhelp =
\EMsimple
7519 \errmessage{Too many arguments in macro `
\macroname'!
}%
7521 \let\next\macargexpandinbody@
7523 \ifx\argvaluelist\nillm@
7524 % No more arguments values passed to macro. Set remaining named-arg
7526 \let\next\setemptyargvalues@
7528 % pop current arg name into \@tempb
7529 \def\@tempa#
#1{\pop@
{\@tempb
}{\paramlist}#
#1\endargs@
}%
7530 \expandafter\@tempa
\expandafter{\paramlist}%
7531 % pop current argument value into \@tempc
7532 \def\@tempa#
#1{\longpop@
{\@tempc
}{\argvaluelist}#
#1\endargs@
}%
7533 \expandafter\@tempa
\expandafter{\argvaluelist}%
7534 % Here \@tempb is the current arg name and \@tempc is the current arg value.
7535 % First place the new argument macro definition into \@tempd
7536 \expandafter\macname\expandafter{\@tempc
}%
7537 \expandafter\let\csname macarg.\@tempb
\endcsname\relax
7538 \expandafter\def\expandafter\@tempe
\expandafter{%
7539 \csname macarg.\@tempb
\endcsname}%
7540 \edef\@tempd
{\long\def\@tempe
{\the\macname}}%
7541 \push@\@tempd
\macargdeflist@
7542 \let\next\getargvals@@
7549 \expandafter\expandafter\expandafter\def
7550 \expandafter\expandafter\expandafter#2%
7551 \expandafter\expandafter\expandafter{%
7555 % Replace arguments by their values in the macro body, and place the result
7557 \def\macvalstoargs@
{%
7558 % To do this we use the property that token registers that are \the'ed
7559 % within an \edef expand only once. So we are going to place all argument
7560 % values into respective token registers.
7562 % First we save the token context, and initialize argument numbering.
7565 % Then, for each argument number #N, we place the corresponding argument
7566 % value into a new token list register \toks#N
7567 \expandafter\putargsintokens@
\saveparamlist@,;,
%
7568 % Then, we expand the body so that argument are replaced by their
7569 % values. The trick for values not to be expanded themselves is that they
7570 % are within tokens and that tokens expand only once in an \edef .
7571 \edef\@tempc
{\csname mac.
\macroname .body
\endcsname}%
7572 % Now we restore the token stack pointer to free the token list registers
7573 % which we have used, but we make sure that expanded body is saved after
7577 \expandafter\def\expandafter\@tempa
\expandafter{\@tempc
}%
7580 \def\macargexpandinbody@
{%
7581 %% Define the named-macro outside of this group and then close this group.
7585 % First the replace in body the macro arguments by their values, the result
7588 % Then we point at the \norecurse or \gobble (for recursive) macro value
7590 \expandafter\let\expandafter\@tempb
\csname mac.
\macroname .recurse
\endcsname
7591 % Depending on whether it is recursive or not, we need some tailing
7598 % And now we do the real job:
7599 \edef\@tempd
{\noexpand\@tempb
{\macroname}\noexpand\scanmacro{\@tempa
}\@tempc
}%
7603 \def\putargsintokens@
#1,
{%
7604 \if#1;
\let\next\relax
7606 \let\next\putargsintokens@
7607 % First we allocate the new token list register, and give it a temporary
7609 \toksdef\@tempb
\the\paramno
7610 % Then we place the argument value into that token list register.
7611 \expandafter\let\expandafter\@tempa
\csname macarg.
#1\endcsname
7612 \expandafter\@tempb
\expandafter{\@tempa
}%
7613 \advance\paramno by
1\relax
7618 % Save the token stack pointer into macro #1
7619 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi
}}
7620 % Restore the token stack pointer from number in macro #1
7621 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi
#1\relax}
7622 % newtoks that can be used non \outer .
7623 \def\texinonouternewtoks{\alloc@
5\toks \toksdef \@cclvi
}
7625 % Tailing missing arguments are set to empty
7626 \def\setemptyargvalues@
{%
7627 \ifx\paramlist\nilm@
7628 \let\next\macargexpandinbody@
7630 \expandafter\setemptyargvaluesparser@
\paramlist\endargs@
7631 \let\next\setemptyargvalues@
7636 \def\setemptyargvaluesparser@
#1,
#2\endargs@
{%
7637 \expandafter\def\expandafter\@tempa
\expandafter{%
7638 \expandafter\def\csname macarg.
#1\endcsname{}}%
7639 \push@\@tempa
\macargdeflist@
7643 % #1 is the element target macro
7644 % #2 is the list macro
7645 % #3,#4\endargs@ is the list value
7646 \def\pop@
#1#2#3,
#4\endargs@
{%
7650 \long\def\longpop@
#1#2#3,
#4\endargs@
{%
7655 % This defines a Texinfo @macro. There are eight cases: recursive and
7656 % nonrecursive macros of zero, one, up to nine, and many arguments.
7657 % Much magic with \expandafter here.
7658 % \xdef is used so that macro definitions will survive the file
7659 % they're defined in; @include reads the file inside a group.
7662 \let\hash=##
% convert placeholders to macro parameter chars
7666 \expandafter\xdef\csname\the\macname\endcsname{%
7667 \noexpand\scanmacro{\temp}}%
7669 \expandafter\xdef\csname\the\macname\endcsname{%
7670 \bgroup\noexpand\macroargctxt
7671 \noexpand\braceorline
7672 \expandafter\noexpand\csname\the\macname xxx
\endcsname}%
7673 \expandafter\xdef\csname\the\macname xxx
\endcsname#
#1{%
7674 \egroup\noexpand\scanmacro{\temp}}%
7676 \ifnum\paramno<
10\relax % at most 9
7677 \expandafter\xdef\csname\the\macname\endcsname{%
7678 \bgroup\noexpand\macroargctxt
7679 \noexpand\csname\the\macname xx
\endcsname}%
7680 \expandafter\xdef\csname\the\macname xx
\endcsname#
#1{%
7681 \expandafter\noexpand\csname\the\macname xxx
\endcsname #
#1,
}%
7682 \expandafter\expandafter
7684 \expandafter\expandafter
7685 \csname\the\macname xxx
\endcsname
7686 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7688 \expandafter\xdef\csname\the\macname\endcsname{%
7689 \noexpand\getargvals@
{\the\macname}{\argl}%
7691 \global\expandafter\let\csname mac.
\the\macname .body
\endcsname\temp
7692 \global\expandafter\let\csname mac.
\the\macname .recurse
\endcsname\gobble
7698 \expandafter\xdef\csname\the\macname\endcsname{%
7699 \noexpand\norecurse{\the\macname}%
7700 \noexpand\scanmacro{\temp}\egroup}%
7702 \expandafter\xdef\csname\the\macname\endcsname{%
7703 \bgroup\noexpand\macroargctxt
7704 \noexpand\braceorline
7705 \expandafter\noexpand\csname\the\macname xxx
\endcsname}%
7706 \expandafter\xdef\csname\the\macname xxx
\endcsname#
#1{%
7708 \noexpand\norecurse{\the\macname}%
7709 \noexpand\scanmacro{\temp}\egroup}%
7711 \ifnum\paramno<
10\relax
7712 \expandafter\xdef\csname\the\macname\endcsname{%
7713 \bgroup\noexpand\macroargctxt
7714 \expandafter\noexpand\csname\the\macname xx
\endcsname}%
7715 \expandafter\xdef\csname\the\macname xx
\endcsname#
#1{%
7716 \expandafter\noexpand\csname\the\macname xxx
\endcsname #
#1,
}%
7717 \expandafter\expandafter
7719 \expandafter\expandafter
7720 \csname\the\macname xxx
\endcsname
7723 \noexpand\norecurse{\the\macname}%
7724 \noexpand\scanmacro{\temp}\egroup}%
7726 \expandafter\xdef\csname\the\macname\endcsname{%
7727 \noexpand\getargvals@
{\the\macname}{\argl}%
7729 \global\expandafter\let\csname mac.
\the\macname .body
\endcsname\temp
7730 \global\expandafter\let\csname mac.
\the\macname .recurse
\endcsname\norecurse
7735 \catcode `\@
\texiatcatcode\relax
7737 \def\norecurse#1{\bgroup\cslet{#1}{macsave.
#1}}
7739 % \braceorline decides whether the next nonwhitespace character is a
7740 % {. If so it reads up to the closing }, if not, it reads the whole
7741 % line. Whatever was read is then fed to the next control sequence
7742 % as an argument (by \parsebrace or \parsearg).
7744 \def\braceorline#1{\let\macnamexxx=
#1\futurelet\nchar\braceorlinexxx}
7745 \def\braceorlinexxx{%
7746 \ifx\nchar\bgroup\else
7747 \expandafter\parsearg
7752 % We need some trickery to remove the optional spaces around the equal
7753 % sign. Make them active and then expand them all to nothing.
7755 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7756 \def\aliasxxx #1{\aliasyyy#1\relax}
7757 \def\aliasyyy #1=
#2\relax{%
7759 \expandafter\let\obeyedspace=
\empty
7760 \addtomacrolist{#1}%
7761 \xdef\next{\global\let\makecsname{#1}=
\makecsname{#2}}%
7767 \message{cross references,
}
7770 \newif\ifhavexrefs % True if xref values are known.
7771 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7773 % @inforef is relatively simple.
7774 \def\inforef #1{\inforefzzz #1,,,,**
}
7775 \def\inforefzzz #1,
#2,
#3,
#4**
{%
7776 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7777 node
\samp{\ignorespaces#1{}}}
7779 % @node's only job in TeX is to define \lastnode, which is used in
7780 % cross-references. The @node line might or might not have commas, and
7781 % might or might not have spaces before the first comma, like:
7782 % @node foo , bar , ...
7783 % We don't want such trailing spaces in the node name.
7785 \parseargdef\node{\checkenv{}\donode #1 ,
\finishnodeparse}
7787 % also remove a trailing comma, in case of something like this:
7788 % @node Help-Cross, , , Cross-refs
7789 \def\donode#1 ,
#2\finishnodeparse{\dodonode #1,
\finishnodeparse}
7790 \def\dodonode#1,
#2\finishnodeparse{\gdef\lastnode{#1}}
7793 \let\lastnode=
\empty
7795 % Write a cross-reference definition for the current node. #1 is the
7796 % type (Ynumbered, Yappendix, Ynothing).
7799 \ifx\lastnode\empty\else
7800 \setref{\lastnode}{#1}%
7801 \global\let\lastnode=
\empty
7805 % @anchor{NAME} -- define xref target at arbitrary point.
7807 \newcount\savesfregister
7809 \def\savesf{\relax \ifhmode \savesfregister=
\spacefactor \fi}
7810 \def\restoresf{\relax \ifhmode \spacefactor=
\savesfregister \fi}
7811 \def\anchor#1{\savesf \setref{#1}{Ynothing
}\restoresf \ignorespaces}
7813 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7814 % anchor), which consists of three parts:
7815 % 1) NAME-title - the current sectioning name taken from \lastsection,
7816 % or the anchor name.
7817 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7818 % empty for anchors.
7819 % 3) NAME-pg - the page number.
7821 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7822 % floats, there is an additional part, which is not written here:
7823 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7829 \atdummies % preserve commands, but don't expand them
7830 \edef\writexrdef#
#1#
#2{%
7831 \write\auxfile{@xrdef
{#1-
% #1 of \setref, expanded by the \edef
7832 #
#1}{#
#2}}% these are parameters of \writexrdef
7834 \toks0 =
\expandafter{\lastsection}%
7835 \immediate \writexrdef{title
}{\the\toks0 }%
7836 \immediate \writexrdef{snt
}{\csname #2\endcsname}% \Ynumbered etc.
7837 \safewhatsit{\writexrdef{pg
}{\folio}}% will be written later, at \shipout
7842 % @xrefautosectiontitle on|off says whether @section(ing) names are used
7843 % automatically in xrefs, if the third arg is not explicitly specified.
7844 % This was provided as a "secret" @set xref-automatic-section-title
7845 % variable, now it's official.
7847 \parseargdef\xrefautomaticsectiontitle{%
7850 \expandafter\let\csname SETxref-automatic-section-title
\endcsname
7852 \else\ifx\temp\offword
7853 \expandafter\let\csname SETxref-automatic-section-title
\endcsname
7856 \errhelp =
\EMsimple
7857 \errmessage{Unknown @xrefautomaticsectiontitle value `
\temp',
7863 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7864 % the node name, #2 the name of the Info cross-reference, #3 the printed
7865 % node name, #4 the name of the Info file, #5 the name of the printed
7866 % manual. All but the node name can be omitted.
7868 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,
]}
7869 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,
]}
7870 \def\ref#1{\xrefX[#1,,,,,,,
]}
7873 \newbox\printedrefnamebox
7874 \newbox\infofilenamebox
7875 \newbox\printedmanualbox
7877 \def\xrefX[#1,
#2,
#3,
#4,
#5,
#6]{\begingroup
7880 % Get args without leading/trailing spaces.
7881 \def\printedrefname{\ignorespaces #3}%
7882 \setbox\printedrefnamebox =
\hbox{\printedrefname\unskip}%
7884 \def\infofilename{\ignorespaces #4}%
7885 \setbox\infofilenamebox =
\hbox{\infofilename\unskip}%
7887 \def\printedmanual{\ignorespaces #5}%
7888 \setbox\printedmanualbox =
\hbox{\printedmanual\unskip}%
7890 % If the printed reference name (arg #3) was not explicitly given in
7891 % the @xref, figure out what we want to use.
7892 \ifdim \wd\printedrefnamebox =
0pt
7893 % No printed node name was explicitly given.
7894 \expandafter\ifx\csname SETxref-automatic-section-title
\endcsname \relax
7895 % Not auto section-title: use node name inside the square brackets.
7896 \def\printedrefname{\ignorespaces #1}%
7898 % Auto section-title: use chapter/section title inside
7899 % the square brackets if we have it.
7900 \ifdim \wd\printedmanualbox >
0pt
7901 % It is in another manual, so we don't have it; use node name.
7902 \def\printedrefname{\ignorespaces #1}%
7905 % We (should) know the real title if we have the xref values.
7906 \def\printedrefname{\refx{#1-title
}{}}%
7908 % Otherwise just copy the Info node name.
7909 \def\printedrefname{\ignorespaces #1}%
7915 % Make link in pdf output.
7919 \makevalueexpandable
7920 % This expands tokens, so do it after making catcode changes, so _
7921 % etc. don't get their TeX definitions. This ignores all spaces in
7922 % #4, including (wrongly) those in the middle of the filename.
7925 % This (wrongly) does not take account of leading or trailing
7926 % spaces in #1, which should be ignored.
7927 \edef\pdfxrefdest{#1}%
7928 \ifx\pdfxrefdest\empty
7929 \def\pdfxrefdest{Top
}% no empty targets
7931 \txiescapepdf\pdfxrefdest % escape PDF special chars
7935 \startlink attr
{/Border
[0 0 0]}%
7936 \ifnum\filenamelength>
0
7937 goto file
{\the\filename.pdf
} name
{\pdfxrefdest}%
7939 goto name
{\pdfmkpgn{\pdfxrefdest}}%
7942 \setcolor{\linkcolor}%
7945 % Float references are printed completely differently: "Figure 1.2"
7946 % instead of "[somenode], p.3". We distinguish them by the
7947 % LABEL-title being set to a magic string.
7949 % Have to otherify everything special to allow the \csname to
7950 % include an _ in the xref name, etc.
7953 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7954 \csname XR
#1-title
\endcsname
7956 \iffloat\Xthisreftitle
7957 % If the user specified the print name (third arg) to the ref,
7958 % print it instead of our usual "Figure 1.2".
7959 \ifdim\wd\printedrefnamebox =
0pt
7965 % If the user also gave the printed manual name (fifth arg), append
7967 \ifdim \wd\printedmanualbox >
0pt
7968 \space \putwordin{} \cite{\printedmanual}%
7971 % node/anchor (non-float) references.
7973 % If we use \unhbox to print the node names, TeX does not insert
7974 % empty discretionaries after hyphens, which means that it will not
7975 % find a line break at a hyphen in a node names. Since some manuals
7976 % are best written with fairly long node names, containing hyphens,
7977 % this is a loss. Therefore, we give the text of the node name
7978 % again, so it is as if TeX is seeing it for the first time.
7980 \ifdim \wd\printedmanualbox >
0pt
7981 % Cross-manual reference with a printed manual name.
7983 \crossmanualxref{\cite{\printedmanual\unskip}}%
7985 \else\ifdim \wd\infofilenamebox >
0pt
7986 % Cross-manual reference with only an info filename (arg 4), no
7987 % printed manual name (arg 5). This is essentially the same as
7988 % the case above; we output the filename, since we have nothing else.
7990 \crossmanualxref{\code{\infofilename\unskip}}%
7993 % Reference within this manual.
7995 % _ (for example) has to be the character _ for the purposes of the
7996 % control sequence corresponding to the node, but it has to expand
7997 % into the usual \leavevmode...\vrule stuff for purposes of
7998 % printing. So we \turnoffactive for the \refx-snt, back on for the
7999 % printing, back off for the \refx-pg.
8001 % Only output a following space if the -snt ref is nonempty; for
8002 % @unnumbered and @anchor, it won't be.
8003 \setbox2 =
\hbox{\ignorespaces \refx{#1-snt
}{}}%
8004 \ifdim \wd2 >
0pt
\refx{#1-snt
}\space\fi
8006 % output the `[mynode]' via the macro below so it can be overridden.
8007 \xrefprintnodename\printedrefname
8009 % But we always want a comma and a space:
8012 % output the `page 3'.
8013 \turnoffactive \putwordpage\tie\refx{#1-pg
}{}%
8019 % Output a cross-manual xref to #1. Used just above (twice).
8021 % Only include the text "Section ``foo'' in" if the foo is neither
8022 % missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply
8023 % "see The Foo Manual", the idea being to refer to the whole manual.
8025 % But, this being TeX, we can't easily compare our node name against the
8026 % string "Top" while ignoring the possible spaces before and after in
8027 % the input. By adding the arbitrary 7sp below, we make it much less
8028 % likely that a real node name would have the same width as "Top" (e.g.,
8029 % in a monospaced font). Hopefully it will never happen in practice.
8031 % For the same basic reason, we retypeset the "Top" at every
8032 % reference, since the current font is indeterminate.
8034 \def\crossmanualxref#1{%
8035 \setbox\toprefbox =
\hbox{Top
\kern7sp}%
8036 \setbox2 =
\hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8037 \ifdim \wd2 >
7sp
% nonempty?
8038 \ifdim \wd2 =
\wd\toprefbox \else % same as Top?
8039 \putwordSection{} ``
\printedrefname''
\putwordin{}\space
8045 % This macro is called from \xrefX for the `[nodename]' part of xref
8046 % output. It's a separate macro only so it can be changed more easily,
8047 % since square brackets don't work well in some documents. Particularly
8048 % one that Bob is working on :).
8050 \def\xrefprintnodename#1{[#1]}
8052 % Things referred to by \setref.
8058 \putwordChapter@tie
\the\chapno
8059 \else \ifnum\subsecno=
0
8060 \putwordSection@tie
\the\chapno.
\the\secno
8061 \else \ifnum\subsubsecno=
0
8062 \putwordSection@tie
\the\chapno.
\the\secno.
\the\subsecno
8064 \putwordSection@tie
\the\chapno.
\the\secno.
\the\subsecno.
\the\subsubsecno
8069 \putwordAppendix@tie @char
\the\appendixno{}%
8070 \else \ifnum\subsecno=
0
8071 \putwordSection@tie @char
\the\appendixno.
\the\secno
8072 \else \ifnum\subsubsecno=
0
8073 \putwordSection@tie @char
\the\appendixno.
\the\secno.
\the\subsecno
8076 @char
\the\appendixno.
\the\secno.
\the\subsecno.
\the\subsubsecno
8080 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
8081 % If its value is nonempty, SUFFIX is output afterward.
8087 \expandafter\global\expandafter\let\expandafter\thisrefX
8088 \csname XR
#1\endcsname
8091 % If not defined, say something at least.
8092 \angleleft un\-de\-fined
\angleright
8095 {\toks0 =
{#1}% avoid expansion of possibly-complex value
8096 \message{\linenumber Undefined cross reference `
\the\toks0'.
}}%
8099 \global\warnedxrefstrue
8100 \message{Cross reference values unknown; you must run TeX again.
}%
8105 % It's defined, so just use it.
8108 #2% Output the suffix in any case.
8111 % This is the macro invoked by entries in the aux file. Usually it's
8112 % just a \def (we prepend XR to the control sequence name to avoid
8113 % collisions). But if this is a float type, we have more work to do.
8116 {% The node name might contain 8-bit characters, which in our current
8117 % implementation are changed to commands like @'e. Don't let these
8118 % mess up the control sequence name.
8121 \xdef\safexrefname{#1}%
8124 \expandafter\gdef\csname XR
\safexrefname\endcsname{#2}% remember this xref
8126 % Was that xref control sequence that we just defined for a float?
8127 \expandafter\iffloat\csname XR
\safexrefname\endcsname
8128 % it was a float, and we have the (safe) float type in \iffloattype.
8129 \expandafter\let\expandafter\floatlist
8130 \csname floatlist
\iffloattype\endcsname
8132 % Is this the first time we've seen this float type?
8133 \expandafter\ifx\floatlist\relax
8134 \toks0 =
{\do}% yes, so just \do
8136 % had it before, so preserve previous elements in list.
8137 \toks0 =
\expandafter{\floatlist\do}%
8140 % Remember this xref in the control sequence \floatlistFLOATTYPE,
8141 % for later use in \listoffloats.
8142 \expandafter\xdef\csname floatlist
\iffloattype\endcsname{\the\toks0
8147 % Read the last existing aux file, if any. No error if none exists.
8150 \openin 1 \jobname.aux
8153 \global\havexrefstrue
8158 \def\setupdatafile{%
8159 \catcode`\^^@=
\other
8160 \catcode`\^^A=
\other
8161 \catcode`\^^B=
\other
8162 \catcode`\^^C=
\other
8163 \catcode`\^^D=
\other
8164 \catcode`\^^E=
\other
8165 \catcode`\^^F=
\other
8166 \catcode`\^^G=
\other
8167 \catcode`\^^H=
\other
8168 \catcode`\^^K=
\other
8169 \catcode`\^^L=
\other
8170 \catcode`\^^N=
\other
8171 \catcode`\^^P=
\other
8172 \catcode`\^^Q=
\other
8173 \catcode`\^^R=
\other
8174 \catcode`\^^S=
\other
8175 \catcode`\^^T=
\other
8176 \catcode`\^^U=
\other
8177 \catcode`\^^V=
\other
8178 \catcode`\^^W=
\other
8179 \catcode`\^^X=
\other
8180 \catcode`\^^Z=
\other
8181 \catcode`\^^
[=
\other
8182 \catcode`\^^\=
\other
8183 \catcode`\^^
]=
\other
8184 \catcode`\^^^=
\other
8185 \catcode`\^^_=
\other
8186 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8187 % in xref tags, i.e., node names. But since ^^e4 notation isn't
8188 % supported in the main text, it doesn't seem desirable. Furthermore,
8189 % that is not enough: for node names that actually contain a ^
8190 % character, we would end up writing a line like this: 'xrdef {'hat
8191 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8192 % argument, and \hat is not an expandable control sequence. It could
8193 % all be worked out, but why? Either we support ^^ or we don't.
8195 % The other change necessary for this was to define \auxhat:
8196 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8197 % and then to call \auxhat in \setq.
8201 % Special characters. Should be turned off anyway, but...
8214 \catcode`+=
\other % avoid \+ for paranoia even though we've turned it off
8216 % This is to support \ in node names and titles, since the \
8217 % characters end up in a \csname. It's easier than
8218 % leaving it active and making its active definition an actual \
8219 % character. What I don't understand is why it works in the *value*
8220 % of the xrdef. Seems like it should be a catcode12 \, and that
8221 % should not typeset properly. But it works, so I'm moving on for
8222 % now. --karl, 15jan04.
8225 % Make the characters 128-255 be printing characters.
8229 \catcode\count1=
\other
8230 \advance\count1 by
1
8231 \ifnum \count1<
256 \loop \fi
8235 % @ is our escape character in .aux files, and we need braces.
8241 \def\readdatafile#1{%
8248 \message{insertions,
}
8249 % including footnotes.
8251 \newcount \footnoteno
8253 % The trailing space in the following definition for supereject is
8254 % vital for proper filling; pages come out unaligned when you do a
8255 % pagealignmacro call if that space before the closing brace is
8256 % removed. (Generally, numeric constants should always be followed by a
8257 % space to prevent strange expansion errors.)
8258 \def\supereject{\par\penalty -
20000\footnoteno =
0 }
8260 % @footnotestyle is meaningful for Info output only.
8261 \let\footnotestyle=
\comment
8265 % Auto-number footnotes. Otherwise like plain.
8267 \let\indent=
\ptexindent
8268 \let\noindent=
\ptexnoindent
8269 \global\advance\footnoteno by \@ne
8270 \edef\thisfootno{$^
{\the\footnoteno}$
}%
8272 % In case the footnote comes at the end of a sentence, preserve the
8273 % extra spacing after we do the footnote number.
8275 \ifhmode\edef\@sf
{\spacefactor\the\spacefactor}\ptexslash\fi
8277 % Remove inadvertent blank space before typesetting the footnote number.
8283 % Don't bother with the trickery in plain.tex to not require the
8284 % footnote text as a parameter. Our footnotes don't need to be so general.
8286 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8287 % \parseargline) fails inside footnotes because the tokens are fixed when
8288 % the footnote is read. --karl, 16nov96.
8291 \insert\footins\bgroup
8292 % We want to typeset this text as a normal paragraph, even if the
8293 % footnote reference occurs in (for example) a display environment.
8294 % So reset some parameters.
8296 \interlinepenalty\interfootnotelinepenalty
8297 \splittopskip\ht\strutbox % top baseline for broken footnotes
8298 \splitmaxdepth\dp\strutbox
8299 \floatingpenalty\@MM
8304 \parindent\defaultparindent
8308 % Because we use hanging indentation in footnotes, a @noindent appears
8309 % to exdent this text, so make it be a no-op. makeinfo does not use
8310 % hanging indentation so @noindent can still be needed within footnote
8311 % text after an @example or the like (not that this is good style).
8312 \let\noindent =
\relax
8314 % Hang the footnote text off the number. Use \everypar in case the
8315 % footnote extends for more than one paragraph.
8316 \everypar =
{\hang}%
8317 \textindent{\thisfootno}%
8319 % Don't crash into the line above the footnote text. Since this
8320 % expands into a box, it must come within the paragraph, lest it
8321 % provide a place where TeX can split the footnote.
8324 % Invoke rest of plain TeX footnote routine.
8325 \futurelet\next\fo@t
8327 }%end \catcode `\@=11
8329 % In case a @footnote appears in a vbox, save the footnote text and create
8330 % the real \insert just after the vbox finished. Otherwise, the insertion
8332 % Similarly, if a @footnote appears inside an alignment, save the footnote
8333 % text to a box and make the \insert when a row of the table is finished.
8334 % And the same can be done for other insert classes. --kasal, 16nov03.
8336 % Replace the \insert primitive by a cheating macro.
8337 % Deeper inside, just make sure that the saved insertions are not spilled
8340 \def\startsavinginserts{%
8341 \ifx \insert\ptexinsert
8342 \let\insert\saveinsert
8344 \let\checkinserts\relax
8348 % This \insert replacement works for both \insert\footins{foo} and
8349 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8352 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8353 \afterassignment\next
8354 % swallow the left brace
8357 \def\makeSAVEname#1{\makecsname{SAVE
\expandafter\gobble\string#1}}
8358 \def\savetobox#1{\global\setbox#1 =
\vbox\bgroup \unvbox#1}
8360 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8362 \def\placesaveins#1{%
8363 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8367 % eat @SAVE -- beware, all of them have catcode \other:
8369 \def\dospecials{\do S
\do A
\do V
\do E
} \uncatcodespecials % ;-)
8370 \gdef\gobblesave @SAVE
{}
8374 \def\newsaveins #1{%
8375 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8378 \def\newsaveinsX #1{%
8379 \csname newbox
\endcsname #1%
8380 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8385 \let\checkinserts\empty
8390 % @image. We use the macros from epsf.tex to support this.
8391 % If epsf.tex is not installed and @image is used, we complain.
8393 % Check for and read epsf.tex up front. If we read it only at @image
8394 % time, we might be inside a group, and then its definitions would get
8395 % undone and the next image would fail.
8396 \openin 1 = epsf.tex
8398 % Do not bother showing banner with epsf.tex v2.7k (available in
8399 % doc/epsf.tex and on ctan).
8400 \def\epsfannounce{\toks0 =
}%
8405 % We will only complain once about lack of epsf.tex.
8406 \newif\ifwarnednoepsf
8407 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8408 work. It is also included in the Texinfo distribution, or you can get
8409 it from ftp://tug.org/tex/epsf.tex.
}
8412 \ifx\epsfbox\thisisundefined
8413 \ifwarnednoepsf \else
8414 \errhelp =
\noepsfhelp
8415 \errmessage{epsf.tex not found, images will be ignored
}%
8416 \global\warnednoepsftrue
8419 \imagexxx #1,,,,,
\finish
8423 % Arguments to @image:
8424 % #1 is (mandatory) image filename; we tack on .eps extension.
8425 % #2 is (optional) width, #3 is (optional) height.
8426 % #4 is (ignored optional) html alt text.
8427 % #5 is (ignored optional) extension.
8428 % #6 is just the usual extra ignored arg for parsing stuff.
8430 \def\imagexxx#1,
#2,
#3,
#4,
#5,
#6\finish{\begingroup
8431 \catcode`\^^M =
5 % in case we're inside an example
8432 \normalturnoffactive % allow _ et al. in names
8433 % If the image is by itself, center it.
8436 \else \ifx\centersub\centerV
8437 % for @center @image, we need a vbox so we can have our vertical space
8439 \vbox\bgroup % vbox has better behavior than vtop herev
8444 % Usually we'll have text after the image which will insert
8445 % \parskip glue, so insert it here too to equalize the space
8447 \nobreak\vskip\parskip
8451 % Leave vertical mode so that indentation from an enclosing
8452 % environment such as @quotation is respected.
8453 % However, if we're at the top level, we don't want the
8454 % normal paragraph indentation.
8455 % On the other hand, if we are in the case of @center @image, we don't
8456 % want to start a paragraph, which will create a hsize-width box and
8457 % eradicate the centering.
8458 \ifx\centersub\centerV\else \noindent \fi
8462 \dopdfimage{#1}{#2}{#3}%
8464 % \epsfbox itself resets \epsf?size at each figure.
8465 \setbox0 =
\hbox{\ignorespaces #2}\ifdim\wd0 >
0pt
\epsfxsize=
#2\relax \fi
8466 \setbox0 =
\hbox{\ignorespaces #3}\ifdim\wd0 >
0pt
\epsfysize=
#3\relax \fi
8471 \medskip % space after a standalone image
8473 \ifx\centersub\centerV \egroup \fi
8477 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8478 % etc. We don't actually implement floating yet, we always include the
8479 % float "here". But it seemed the best name for the future.
8481 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,
\finish}
8483 % There may be a space before second and/or third parameter; delete it.
8484 \def\eatcommaspace#1,
{#1,
}
8486 % #1 is the optional FLOATTYPE, the text label for this float, typically
8487 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
8488 % this float will not be numbered and cannot be referred to.
8490 % #2 is the optional xref label. Also must be present for the float to
8493 % #3 is the optional positioning argument; for now, it is ignored. It
8494 % will somehow specify the positions allowed to float to (here, top, bottom).
8496 % We keep a separate counter for each FLOATTYPE, which we reset at each
8497 % chapter-level command.
8498 \let\resetallfloatnos=
\empty
8500 \def\dofloat#1,
#2,
#3,
#4\finish{%
8501 \let\thiscaption=
\empty
8502 \let\thisshortcaption=
\empty
8504 % don't lose footnotes inside @float.
8506 % BEWARE: when the floats start float, we have to issue warning whenever an
8507 % insert appears inside a float which could possibly float. --kasal, 26may04
8511 % We can't be used inside a paragraph.
8516 \def\floatlabel{#2}%
8517 \def\floatloc{#3}% we do nothing with this yet.
8519 \ifx\floattype\empty
8520 \let\safefloattype=
\empty
8523 % the floattype might have accents or other special characters,
8524 % but we need to use it in a control sequence name.
8527 \xdef\safefloattype{\floattype}%
8531 % If label is given but no type, we handle that as the empty type.
8532 \ifx\floatlabel\empty \else
8533 % We want each FLOATTYPE to be numbered separately (Figure 1,
8534 % Table 1, Figure 2, ...). (And if no label, no number.)
8536 \expandafter\getfloatno\csname\safefloattype floatno
\endcsname
8537 \global\advance\floatno by
1
8540 % This magic value for \lastsection is output by \setref as the
8541 % XREFLABEL-title value. \xrefX uses it to distinguish float
8542 % labels (which have a completely different output format) from
8543 % node and anchor labels. And \xrdef uses it to construct the
8546 \edef\lastsection{\floatmagic=
\safefloattype}%
8547 \setref{\floatlabel}{Yfloat
}%
8551 % start with \parskip glue, I guess.
8554 % Don't suppress indentation if a float happens to start a section.
8555 \restorefirstparagraphindent
8558 % we have these possibilities:
8559 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8560 % @float Foo,lbl & no caption: Foo 1.1
8561 % @float Foo & @caption{Cap}: Foo: Cap
8562 % @float Foo & no caption: Foo
8563 % @float ,lbl & Caption{Cap}: 1.1: Cap
8564 % @float ,lbl & no caption: 1.1
8565 % @float & @caption{Cap}: Cap
8566 % @float & no caption:
8569 \let\floatident =
\empty
8571 % In all cases, if we have a float type, it comes first.
8572 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8574 % If we have an xref label, the number comes next.
8575 \ifx\floatlabel\empty \else
8576 \ifx\floattype\empty \else % if also had float type, need tie first.
8577 \appendtomacro\floatident{\tie}%
8580 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8583 % Start the printed caption with what we've constructed in
8584 % \floatident, but keep it separate; we need \floatident again.
8585 \let\captionline =
\floatident
8587 \ifx\thiscaption\empty \else
8588 \ifx\floatident\empty \else
8589 \appendtomacro\captionline{:
}% had ident, so need a colon between
8593 \appendtomacro\captionline{\scanexp\thiscaption}%
8596 % If we have anything to print, print it, with space before.
8597 % Eventually this needs to become an \insert.
8598 \ifx\captionline\empty \else
8602 % Space below caption.
8606 % If have an xref label, write the list of floats info. Do this
8607 % after the caption, to avoid chance of it being a breakpoint.
8608 \ifx\floatlabel\empty \else
8609 % Write the text that goes in the lof to the aux file as
8610 % \floatlabel-lof. Besides \floatident, we include the short
8611 % caption if specified, else the full caption if specified, else nothing.
8615 % since we read the caption text in the macro world, where ^^M
8616 % is turned into a normal character, we have to scan it back, so
8617 % we don't write the literal three characters "^^M" into the aux file.
8619 \xdef\noexpand\gtemp{%
8620 \ifx\thisshortcaption\empty
8627 \immediate\write\auxfile{@xrdef
{\floatlabel-lof
}{\floatident
8628 \ifx\gtemp\empty \else :
\gtemp \fi}}%
8631 \egroup % end of \vtop
8633 % place the captured inserts
8635 % BEWARE: when the floats start floating, we have to issue warning
8636 % whenever an insert appears inside a float which could possibly
8637 % float. --kasal, 26may04
8642 % Append the tokens #2 to the definition of macro #1, not expanding either.
8644 \def\appendtomacro#1#2{%
8645 \expandafter\def\expandafter#1\expandafter{#1#2}%
8648 % @caption, @shortcaption
8650 \def\caption{\docaption\thiscaption}
8651 \def\shortcaption{\docaption\thisshortcaption}
8652 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8653 \def\defcaption#1#2{\egroup \def#1{#2}}
8655 % The parameter is the control sequence identifying the counter we are
8656 % going to use. Create it if it doesn't exist and assign it to \floatno.
8659 % Haven't seen this figure type before.
8660 \csname newcount
\endcsname #1%
8662 % Remember to reset this floatno at the next chap.
8663 \expandafter\gdef\expandafter\resetallfloatnos
8664 \expandafter{\resetallfloatnos #1=
0 }%
8669 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8670 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8671 % first read the @float command.
8673 \def\Yfloat{\floattype@tie
\chaplevelprefix\the\floatno}%
8675 % Magic string used for the XREFLABEL-title value, so \xrefX can
8676 % distinguish floats from other xref types.
8677 \def\floatmagic{!!float!!
}
8679 % #1 is the control sequence we are passed; we expand into a conditional
8680 % which is true if #1 represents a float ref. That is, the magic
8681 % \lastsection value which we \setref above.
8683 \def\iffloat#1{\expandafter\doiffloat#1==
\finish}
8685 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8686 % (safe) float type for this float. We set \iffloattype to #2.
8688 \def\doiffloat#1=
#2=
#3\finish{%
8690 \def\iffloattype{#2}%
8691 \ifx\temp\floatmagic
8694 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8696 \parseargdef\listoffloats{%
8697 \def\floattype{#1}% floattype
8699 % the floattype might have accents or other special characters,
8700 % but we need to use it in a control sequence name.
8703 \xdef\safefloattype{\floattype}%
8706 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8707 \expandafter\ifx\csname floatlist
\safefloattype\endcsname \relax
8709 % if the user said @listoffloats foo but never @float foo.
8710 \message{\linenumber No `
\safefloattype' floats to list.
}%
8714 \leftskip=
\tocindent % indent these entries like a toc
8715 \let\do=
\listoffloatsdo
8716 \csname floatlist
\safefloattype\endcsname
8721 % This is called on each entry in a list of floats. We're passed the
8722 % xref label, in the form LABEL-title, which is how we save it in the
8723 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8724 % has the text we're supposed to typeset here.
8726 % Figures without xref labels will not be included in the list (since
8727 % they won't appear in the aux file).
8729 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8730 \def\listoffloatsdoentry#1-title
\finish{{%
8731 % Can't fully expand XR#1-lof because it can contain anything. Just
8732 % pass the control sequence. On the other hand, XR#1-pg is just the
8733 % page number, and we want to fully expand that so we can get a link
8735 \toksA =
\expandafter{\csname XR
#1-lof
\endcsname}%
8737 % use the same \entry macro we use to generate the TOC and index.
8738 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR
#1-pg
\endcsname}}%
8743 \message{localization,
}
8745 % For single-language documents, @documentlanguage is usually given very
8746 % early, just after @documentencoding. Single argument is the language
8747 % (de) or locale (de_DE) abbreviation.
8750 \catcode`
\_ =
\active
8752 \parseargdef\documentlanguage{\begingroup
8753 \let_=
\normalunderscore % normal _ character for filenames
8754 \tex % read txi-??.tex file in plain TeX.
8755 % Read the file by the name they passed if it exists.
8756 \openin 1 txi-
#1.tex
8758 \documentlanguagetrywithoutunderscore{#1_
\finish}%
8760 \globaldefs =
1 % everything in the txi-LL files needs to persist
8764 \endgroup % end raw TeX
8767 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8770 \gdef\documentlanguagetrywithoutunderscore#1_
#2\finish{%
8771 \openin 1 txi-
#1.tex
8773 \errhelp =
\nolanghelp
8774 \errmessage{Cannot read language file txi-
#1.tex
}%
8776 \globaldefs =
1 % everything in the txi-LL files needs to persist
8781 }% end of special _ catcode
8783 \newhelp\nolanghelp{The given language definition file cannot be found or
8784 is empty. Maybe you need to install it? Putting it in the current
8785 directory should work if nowhere else does.
}
8787 % This macro is called from txi-??.tex files; the first argument is the
8788 % \language name to set (without the "\lang@" prefix), the second and
8789 % third args are \{left,right}hyphenmin.
8791 % The language names to pass are determined when the format is built.
8792 % See the etex.log file created at that time, e.g.,
8793 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8795 % With TeX Live 2008, etex now includes hyphenation patterns for all
8796 % available languages. This means we can support hyphenation in
8797 % Texinfo, at least to some extent. (This still doesn't solve the
8798 % accented characters problem.)
8801 \def\txisetlanguage#1#2#3{%
8802 % do not set the language if the name is undefined in the current TeX.
8803 \expandafter\ifx\csname lang@
#1\endcsname \relax
8804 \message{no patterns for
#1}%
8806 \global\language =
\csname lang@
#1\endcsname
8808 % but there is no harm in adjusting the hyphenmin values regardless.
8809 \global\lefthyphenmin =
#2\relax
8810 \global\righthyphenmin =
#3\relax
8813 % Helpers for encodings.
8814 % Set the catcode of characters 128 through 255 to the specified number.
8816 \def\setnonasciicharscatcode#1{%
8818 \loop\ifnum\count255<
256
8819 \global\catcode\count255=
#1\relax
8820 \advance\count255 by
1
8824 \def\setnonasciicharscatcodenonglobal#1{%
8826 \loop\ifnum\count255<
256
8827 \catcode\count255=
#1\relax
8828 \advance\count255 by
1
8832 % @documentencoding sets the definition of non-ASCII characters
8833 % according to the specified encoding.
8835 \parseargdef\documentencoding{%
8836 % Encoding being declared for the document.
8837 \def\declaredencoding{\csname #1.enc
\endcsname}%
8839 % Supported encodings: names converted to tokens in order to be able
8840 % to compare them with \ifx.
8841 \def\ascii{\csname US-ASCII.enc
\endcsname}%
8842 \def\latnine{\csname ISO-
8859-
15.enc
\endcsname}%
8843 \def\latone{\csname ISO-
8859-
1.enc
\endcsname}%
8844 \def\lattwo{\csname ISO-
8859-
2.enc
\endcsname}%
8845 \def\utfeight{\csname UTF-
8.enc
\endcsname}%
8847 \ifx \declaredencoding \ascii
8850 \else \ifx \declaredencoding \lattwo
8851 \setnonasciicharscatcode\active
8854 \else \ifx \declaredencoding \latone
8855 \setnonasciicharscatcode\active
8858 \else \ifx \declaredencoding \latnine
8859 \setnonasciicharscatcode\active
8862 \else \ifx \declaredencoding \utfeight
8863 \setnonasciicharscatcode\active
8867 \message{Unknown
document encoding
#1, ignoring.
}%
8876 % A message to be logged when using a character that isn't available
8877 % the default font encoding (OT1).
8879 \def\missingcharmsg#1{\message{Character missing in OT1 encoding:
#1.
}}
8881 % Take account of \c (plain) vs. \, (Texinfo) difference.
8882 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,
{#1}\fi}
8884 % First, make active non-ASCII characters in order for them to be
8885 % correctly categorized when TeX reads the replacement text of
8886 % macros containing the character definitions.
8887 \setnonasciicharscatcode\active
8889 % Latin1 (ISO-8859-1) character definitions.
8890 \def\latonechardefs{%
8892 \gdef^^a1
{\exclamdown}
8893 \gdef^^a2
{\missingcharmsg{CENT SIGN
}}
8894 \gdef^^a3
{{\pounds}}
8895 \gdef^^a4
{\missingcharmsg{CURRENCY SIGN
}}
8896 \gdef^^a5
{\missingcharmsg{YEN SIGN
}}
8897 \gdef^^a6
{\missingcharmsg{BROKEN BAR
}}
8900 \gdef^^a9
{\copyright}
8902 \gdef^^ab
{\guillemetleft}
8905 \gdef^^ae
{\registeredsymbol}
8908 \gdef^^b0
{\textdegree}
8917 \gdef^^b8
{\cedilla\
}
8921 \gdef^^bb
{\guillemetright}
8922 \gdef^^bc
{$
1\over4$
}
8923 \gdef^^bd
{$
1\over2$
}
8924 \gdef^^be
{$
3\over4$
}
8925 \gdef^^bf
{\questiondown}
8932 \gdef^^c5
{\ringaccent A
}
8934 \gdef^^c7
{\cedilla C
}
8966 \gdef^^e5
{\ringaccent a
}
8968 \gdef^^e7
{\cedilla c
}
8973 \gdef^^ec
{\`
{\dotless i
}}
8974 \gdef^^ed
{\'
{\dotless i
}}
8975 \gdef^^ee
{\^
{\dotless i
}}
8976 \gdef^^ef
{\"
{\dotless i
}}
8996 % Latin9 (ISO-8859-15) encoding character definitions.
8997 \def\latninechardefs{%
8998 % Encoding is almost identical to Latin1.
9011 % Latin2 (ISO-8859-2) character definitions.
9012 \def\lattwochardefs{%
9014 \gdef^^a1
{\ogonek{A
}}
9017 \gdef^^a4
{\missingcharmsg{CURRENCY SIGN
}}
9023 \gdef^^aa
{\cedilla S
}
9028 \gdef^^af
{\dotaccent Z
}
9030 \gdef^^b0
{\textdegree}
9031 \gdef^^b1
{\ogonek{a
}}
9032 \gdef^^b2
{\ogonek{ }}
9038 \gdef^^b8
{\cedilla\
}
9040 \gdef^^ba
{\cedilla s
}
9045 \gdef^^bf
{\dotaccent z
}
9054 \gdef^^c7
{\cedilla C
}
9057 \gdef^^ca
{\ogonek{E
}}
9073 \gdef^^d9
{\ringaccent U
}
9078 \gdef^^de
{\cedilla T
}
9088 \gdef^^e7
{\cedilla c
}
9091 \gdef^^ea
{\ogonek{e
}}
9094 \gdef^^ed
{\'
{\dotless{i
}}}
9095 \gdef^^ee
{\^
{\dotless{i
}}}
9107 \gdef^^f9
{\ringaccent u
}
9112 \gdef^^fe
{\cedilla t
}
9113 \gdef^^ff
{\dotaccent{}}
9116 % UTF-8 character definitions.
9118 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
9119 % changes for Texinfo conventions. It is included here under the GPL by
9120 % permission from Frank Mittelbach and the LaTeX team.
9126 \gdef\UTFviiiTwoOctets#1#2{\expandafter
9127 \UTFviiiDefined\csname u8:
#1\string #2\endcsname}
9129 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
9130 \UTFviiiDefined\csname u8:
#1\string #2\string #3\endcsname}
9132 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
9133 \UTFviiiDefined\csname u8:
#1\string #2\string #3\string #4\endcsname}
9135 \gdef\UTFviiiDefined#1{%
9137 \message{\linenumber Unicode char
\string #1 not defined for Texinfo
}%
9148 \global\catcode\countUTFx\active
9149 \uccode`\~
\countUTFx
9150 \uppercase\expandafter{\UTFviiiTmp}%
9151 \advance\countUTFx by
1
9152 \ifnum\countUTFx <
\countUTFy
9153 \expandafter\UTFviiiLoop
9159 \xdef~
{\noexpand\UTFviiiTwoOctets\string~
}}
9165 \xdef~
{\noexpand\UTFviiiThreeOctets\string~
}}
9171 \xdef~
{\noexpand\UTFviiiFourOctets\string~
}}
9184 \gdef\DeclareUnicodeCharacter#1#2{%
9185 \countUTFz = "
#1\relax
9186 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9189 \def\UTFviiiTwoOctets#
#1#
#2{%
9190 \csname u8:#
#1\string #
#2\endcsname}%
9191 \def\UTFviiiThreeOctets#
#1#
#2#
#3{%
9192 \csname u8:#
#1\string #
#2\string #
#3\endcsname}%
9193 \def\UTFviiiFourOctets#
#1#
#2#
#3#
#4{%
9194 \csname u8:#
#1\string #
#2\string #
#3\string #
#4\endcsname}%
9195 \expandafter\expandafter\expandafter\expandafter
9196 \expandafter\expandafter\expandafter
9197 \gdef\UTFviiiTmp{#2}%
9200 \gdef\parseXMLCharref{%
9201 \ifnum\countUTFz < "A0
\relax
9202 \errhelp =
\EMsimple
9203 \errmessage{Cannot define Unicode char value <
00A0
}%
9204 \else\ifnum\countUTFz < "
800\relax
9206 \parseUTFviiiB C
\UTFviiiTwoOctets.,
%
9207 \else\ifnum\countUTFz < "
10000\relax
9210 \parseUTFviiiB E
\UTFviiiThreeOctets.
{,;
}%
9215 \parseUTFviiiB F
\UTFviiiFourOctets.
{!,;
}%
9219 \gdef\parseUTFviiiA#1{%
9220 \countUTFx =
\countUTFz
9221 \divide\countUTFz by
64
9222 \countUTFy =
\countUTFz
9223 \multiply\countUTFz by
64
9224 \advance\countUTFx by -
\countUTFz
9225 \advance\countUTFx by
128
9226 \uccode `
#1\countUTFx
9227 \countUTFz =
\countUTFy}
9229 \gdef\parseUTFviiiB#1#2#3#4{%
9230 \advance\countUTFz by "
#10\relax
9231 \uccode `
#3\countUTFz
9232 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9235 \def\utfeightchardefs{%
9236 \DeclareUnicodeCharacter{00A0
}{\tie}
9237 \DeclareUnicodeCharacter{00A1
}{\exclamdown}
9238 \DeclareUnicodeCharacter{00A3
}{\pounds}
9239 \DeclareUnicodeCharacter{00A8
}{\"
{ }}
9240 \DeclareUnicodeCharacter{00A9
}{\copyright}
9241 \DeclareUnicodeCharacter{00AA
}{\ordf}
9242 \DeclareUnicodeCharacter{00AB
}{\guillemetleft}
9243 \DeclareUnicodeCharacter{00AD
}{\-
}
9244 \DeclareUnicodeCharacter{00AE
}{\registeredsymbol}
9245 \DeclareUnicodeCharacter{00AF
}{\=
{ }}
9247 \DeclareUnicodeCharacter{00B0
}{\ringaccent{ }}
9248 \DeclareUnicodeCharacter{00B4
}{\'
{ }}
9249 \DeclareUnicodeCharacter{00B8
}{\cedilla{ }}
9250 \DeclareUnicodeCharacter{00BA
}{\ordm}
9251 \DeclareUnicodeCharacter{00BB
}{\guillemetright}
9252 \DeclareUnicodeCharacter{00BF
}{\questiondown}
9254 \DeclareUnicodeCharacter{00C0
}{\`A
}
9255 \DeclareUnicodeCharacter{00C1
}{\'A
}
9256 \DeclareUnicodeCharacter{00C2
}{\^A
}
9257 \DeclareUnicodeCharacter{00C3
}{\~A
}
9258 \DeclareUnicodeCharacter{00C4
}{\"A
}
9259 \DeclareUnicodeCharacter{00C5
}{\AA}
9260 \DeclareUnicodeCharacter{00C6
}{\AE}
9261 \DeclareUnicodeCharacter{00C7
}{\cedilla{C
}}
9262 \DeclareUnicodeCharacter{00C8
}{\`E
}
9263 \DeclareUnicodeCharacter{00C9
}{\'E
}
9264 \DeclareUnicodeCharacter{00CA
}{\^E
}
9265 \DeclareUnicodeCharacter{00CB
}{\"E
}
9266 \DeclareUnicodeCharacter{00CC
}{\`I
}
9267 \DeclareUnicodeCharacter{00CD
}{\'I
}
9268 \DeclareUnicodeCharacter{00CE
}{\^I
}
9269 \DeclareUnicodeCharacter{00CF
}{\"I
}
9271 \DeclareUnicodeCharacter{00D0
}{\DH}
9272 \DeclareUnicodeCharacter{00D1
}{\~N
}
9273 \DeclareUnicodeCharacter{00D2
}{\`O
}
9274 \DeclareUnicodeCharacter{00D3
}{\'O
}
9275 \DeclareUnicodeCharacter{00D4
}{\^O
}
9276 \DeclareUnicodeCharacter{00D5
}{\~O
}
9277 \DeclareUnicodeCharacter{00D6
}{\"O
}
9278 \DeclareUnicodeCharacter{00D8
}{\O}
9279 \DeclareUnicodeCharacter{00D9
}{\`U
}
9280 \DeclareUnicodeCharacter{00DA
}{\'U
}
9281 \DeclareUnicodeCharacter{00DB
}{\^U
}
9282 \DeclareUnicodeCharacter{00DC
}{\"U
}
9283 \DeclareUnicodeCharacter{00DD
}{\'Y
}
9284 \DeclareUnicodeCharacter{00DE
}{\TH}
9285 \DeclareUnicodeCharacter{00DF
}{\ss}
9287 \DeclareUnicodeCharacter{00E0
}{\`a
}
9288 \DeclareUnicodeCharacter{00E1
}{\'a
}
9289 \DeclareUnicodeCharacter{00E2
}{\^a
}
9290 \DeclareUnicodeCharacter{00E3
}{\~a
}
9291 \DeclareUnicodeCharacter{00E4
}{\"a
}
9292 \DeclareUnicodeCharacter{00E5
}{\aa}
9293 \DeclareUnicodeCharacter{00E6
}{\ae}
9294 \DeclareUnicodeCharacter{00E7
}{\cedilla{c
}}
9295 \DeclareUnicodeCharacter{00E8
}{\`e
}
9296 \DeclareUnicodeCharacter{00E9
}{\'e
}
9297 \DeclareUnicodeCharacter{00EA
}{\^e
}
9298 \DeclareUnicodeCharacter{00EB
}{\"e
}
9299 \DeclareUnicodeCharacter{00EC
}{\`
{\dotless{i
}}}
9300 \DeclareUnicodeCharacter{00ED
}{\'
{\dotless{i
}}}
9301 \DeclareUnicodeCharacter{00EE
}{\^
{\dotless{i
}}}
9302 \DeclareUnicodeCharacter{00EF
}{\"
{\dotless{i
}}}
9304 \DeclareUnicodeCharacter{00F0
}{\dh}
9305 \DeclareUnicodeCharacter{00F1
}{\~n
}
9306 \DeclareUnicodeCharacter{00F2
}{\`o
}
9307 \DeclareUnicodeCharacter{00F3
}{\'o
}
9308 \DeclareUnicodeCharacter{00F4
}{\^o
}
9309 \DeclareUnicodeCharacter{00F5
}{\~o
}
9310 \DeclareUnicodeCharacter{00F6
}{\"o
}
9311 \DeclareUnicodeCharacter{00F8
}{\o}
9312 \DeclareUnicodeCharacter{00F9
}{\`u
}
9313 \DeclareUnicodeCharacter{00FA
}{\'u
}
9314 \DeclareUnicodeCharacter{00FB
}{\^u
}
9315 \DeclareUnicodeCharacter{00FC
}{\"u
}
9316 \DeclareUnicodeCharacter{00FD
}{\'y
}
9317 \DeclareUnicodeCharacter{00FE
}{\th}
9318 \DeclareUnicodeCharacter{00FF
}{\"y
}
9320 \DeclareUnicodeCharacter{0100}{\=A
}
9321 \DeclareUnicodeCharacter{0101}{\=a
}
9322 \DeclareUnicodeCharacter{0102}{\u{A
}}
9323 \DeclareUnicodeCharacter{0103}{\u{a
}}
9324 \DeclareUnicodeCharacter{0104}{\ogonek{A
}}
9325 \DeclareUnicodeCharacter{0105}{\ogonek{a
}}
9326 \DeclareUnicodeCharacter{0106}{\'C
}
9327 \DeclareUnicodeCharacter{0107}{\'c
}
9328 \DeclareUnicodeCharacter{0108}{\^C
}
9329 \DeclareUnicodeCharacter{0109}{\^c
}
9330 \DeclareUnicodeCharacter{0118}{\ogonek{E
}}
9331 \DeclareUnicodeCharacter{0119}{\ogonek{e
}}
9332 \DeclareUnicodeCharacter{010A
}{\dotaccent{C
}}
9333 \DeclareUnicodeCharacter{010B
}{\dotaccent{c
}}
9334 \DeclareUnicodeCharacter{010C
}{\v{C
}}
9335 \DeclareUnicodeCharacter{010D
}{\v{c
}}
9336 \DeclareUnicodeCharacter{010E
}{\v{D
}}
9338 \DeclareUnicodeCharacter{0112}{\=E
}
9339 \DeclareUnicodeCharacter{0113}{\=e
}
9340 \DeclareUnicodeCharacter{0114}{\u{E
}}
9341 \DeclareUnicodeCharacter{0115}{\u{e
}}
9342 \DeclareUnicodeCharacter{0116}{\dotaccent{E
}}
9343 \DeclareUnicodeCharacter{0117}{\dotaccent{e
}}
9344 \DeclareUnicodeCharacter{011A
}{\v{E
}}
9345 \DeclareUnicodeCharacter{011B
}{\v{e
}}
9346 \DeclareUnicodeCharacter{011C
}{\^G
}
9347 \DeclareUnicodeCharacter{011D
}{\^g
}
9348 \DeclareUnicodeCharacter{011E
}{\u{G
}}
9349 \DeclareUnicodeCharacter{011F
}{\u{g
}}
9351 \DeclareUnicodeCharacter{0120}{\dotaccent{G
}}
9352 \DeclareUnicodeCharacter{0121}{\dotaccent{g
}}
9353 \DeclareUnicodeCharacter{0124}{\^H
}
9354 \DeclareUnicodeCharacter{0125}{\^h
}
9355 \DeclareUnicodeCharacter{0128}{\~I
}
9356 \DeclareUnicodeCharacter{0129}{\~
{\dotless{i
}}}
9357 \DeclareUnicodeCharacter{012A
}{\=I
}
9358 \DeclareUnicodeCharacter{012B
}{\=
{\dotless{i
}}}
9359 \DeclareUnicodeCharacter{012C
}{\u{I
}}
9360 \DeclareUnicodeCharacter{012D
}{\u{\dotless{i
}}}
9362 \DeclareUnicodeCharacter{0130}{\dotaccent{I
}}
9363 \DeclareUnicodeCharacter{0131}{\dotless{i
}}
9364 \DeclareUnicodeCharacter{0132}{IJ
}
9365 \DeclareUnicodeCharacter{0133}{ij
}
9366 \DeclareUnicodeCharacter{0134}{\^J
}
9367 \DeclareUnicodeCharacter{0135}{\^
{\dotless{j
}}}
9368 \DeclareUnicodeCharacter{0139}{\'L
}
9369 \DeclareUnicodeCharacter{013A
}{\'l
}
9371 \DeclareUnicodeCharacter{0141}{\L}
9372 \DeclareUnicodeCharacter{0142}{\l}
9373 \DeclareUnicodeCharacter{0143}{\'N
}
9374 \DeclareUnicodeCharacter{0144}{\'n
}
9375 \DeclareUnicodeCharacter{0147}{\v{N
}}
9376 \DeclareUnicodeCharacter{0148}{\v{n
}}
9377 \DeclareUnicodeCharacter{014C
}{\=O
}
9378 \DeclareUnicodeCharacter{014D
}{\=o
}
9379 \DeclareUnicodeCharacter{014E
}{\u{O
}}
9380 \DeclareUnicodeCharacter{014F
}{\u{o
}}
9382 \DeclareUnicodeCharacter{0150}{\H{O
}}
9383 \DeclareUnicodeCharacter{0151}{\H{o
}}
9384 \DeclareUnicodeCharacter{0152}{\OE}
9385 \DeclareUnicodeCharacter{0153}{\oe}
9386 \DeclareUnicodeCharacter{0154}{\'R
}
9387 \DeclareUnicodeCharacter{0155}{\'r
}
9388 \DeclareUnicodeCharacter{0158}{\v{R
}}
9389 \DeclareUnicodeCharacter{0159}{\v{r
}}
9390 \DeclareUnicodeCharacter{015A
}{\'S
}
9391 \DeclareUnicodeCharacter{015B
}{\'s
}
9392 \DeclareUnicodeCharacter{015C
}{\^S
}
9393 \DeclareUnicodeCharacter{015D
}{\^s
}
9394 \DeclareUnicodeCharacter{015E
}{\cedilla{S
}}
9395 \DeclareUnicodeCharacter{015F
}{\cedilla{s
}}
9397 \DeclareUnicodeCharacter{0160}{\v{S
}}
9398 \DeclareUnicodeCharacter{0161}{\v{s
}}
9399 \DeclareUnicodeCharacter{0162}{\cedilla{t
}}
9400 \DeclareUnicodeCharacter{0163}{\cedilla{T
}}
9401 \DeclareUnicodeCharacter{0164}{\v{T
}}
9403 \DeclareUnicodeCharacter{0168}{\~U
}
9404 \DeclareUnicodeCharacter{0169}{\~u
}
9405 \DeclareUnicodeCharacter{016A
}{\=U
}
9406 \DeclareUnicodeCharacter{016B
}{\=u
}
9407 \DeclareUnicodeCharacter{016C
}{\u{U
}}
9408 \DeclareUnicodeCharacter{016D
}{\u{u
}}
9409 \DeclareUnicodeCharacter{016E
}{\ringaccent{U
}}
9410 \DeclareUnicodeCharacter{016F
}{\ringaccent{u
}}
9412 \DeclareUnicodeCharacter{0170}{\H{U
}}
9413 \DeclareUnicodeCharacter{0171}{\H{u
}}
9414 \DeclareUnicodeCharacter{0174}{\^W
}
9415 \DeclareUnicodeCharacter{0175}{\^w
}
9416 \DeclareUnicodeCharacter{0176}{\^Y
}
9417 \DeclareUnicodeCharacter{0177}{\^y
}
9418 \DeclareUnicodeCharacter{0178}{\"Y
}
9419 \DeclareUnicodeCharacter{0179}{\'Z
}
9420 \DeclareUnicodeCharacter{017A
}{\'z
}
9421 \DeclareUnicodeCharacter{017B
}{\dotaccent{Z
}}
9422 \DeclareUnicodeCharacter{017C
}{\dotaccent{z
}}
9423 \DeclareUnicodeCharacter{017D
}{\v{Z
}}
9424 \DeclareUnicodeCharacter{017E
}{\v{z
}}
9426 \DeclareUnicodeCharacter{01C4
}{D
\v{Z
}}
9427 \DeclareUnicodeCharacter{01C5
}{D
\v{z
}}
9428 \DeclareUnicodeCharacter{01C6
}{d
\v{z
}}
9429 \DeclareUnicodeCharacter{01C7
}{LJ
}
9430 \DeclareUnicodeCharacter{01C8
}{Lj
}
9431 \DeclareUnicodeCharacter{01C9
}{lj
}
9432 \DeclareUnicodeCharacter{01CA
}{NJ
}
9433 \DeclareUnicodeCharacter{01CB
}{Nj
}
9434 \DeclareUnicodeCharacter{01CC
}{nj
}
9435 \DeclareUnicodeCharacter{01CD
}{\v{A
}}
9436 \DeclareUnicodeCharacter{01CE
}{\v{a
}}
9437 \DeclareUnicodeCharacter{01CF
}{\v{I
}}
9439 \DeclareUnicodeCharacter{01D0
}{\v{\dotless{i
}}}
9440 \DeclareUnicodeCharacter{01D1
}{\v{O
}}
9441 \DeclareUnicodeCharacter{01D2
}{\v{o
}}
9442 \DeclareUnicodeCharacter{01D3
}{\v{U
}}
9443 \DeclareUnicodeCharacter{01D4
}{\v{u
}}
9445 \DeclareUnicodeCharacter{01E2
}{\=
{\AE}}
9446 \DeclareUnicodeCharacter{01E3
}{\=
{\ae}}
9447 \DeclareUnicodeCharacter{01E6
}{\v{G
}}
9448 \DeclareUnicodeCharacter{01E7
}{\v{g
}}
9449 \DeclareUnicodeCharacter{01E8
}{\v{K
}}
9450 \DeclareUnicodeCharacter{01E9
}{\v{k
}}
9452 \DeclareUnicodeCharacter{01F0
}{\v{\dotless{j
}}}
9453 \DeclareUnicodeCharacter{01F1
}{DZ
}
9454 \DeclareUnicodeCharacter{01F2
}{Dz
}
9455 \DeclareUnicodeCharacter{01F3
}{dz
}
9456 \DeclareUnicodeCharacter{01F4
}{\'G
}
9457 \DeclareUnicodeCharacter{01F5
}{\'g
}
9458 \DeclareUnicodeCharacter{01F8
}{\`N
}
9459 \DeclareUnicodeCharacter{01F9
}{\`n
}
9460 \DeclareUnicodeCharacter{01FC
}{\'
{\AE}}
9461 \DeclareUnicodeCharacter{01FD
}{\'
{\ae}}
9462 \DeclareUnicodeCharacter{01FE
}{\'
{\O}}
9463 \DeclareUnicodeCharacter{01FF
}{\'
{\o}}
9465 \DeclareUnicodeCharacter{021E
}{\v{H
}}
9466 \DeclareUnicodeCharacter{021F
}{\v{h
}}
9468 \DeclareUnicodeCharacter{0226}{\dotaccent{A
}}
9469 \DeclareUnicodeCharacter{0227}{\dotaccent{a
}}
9470 \DeclareUnicodeCharacter{0228}{\cedilla{E
}}
9471 \DeclareUnicodeCharacter{0229}{\cedilla{e
}}
9472 \DeclareUnicodeCharacter{022E
}{\dotaccent{O
}}
9473 \DeclareUnicodeCharacter{022F
}{\dotaccent{o
}}
9475 \DeclareUnicodeCharacter{0232}{\=Y
}
9476 \DeclareUnicodeCharacter{0233}{\=y
}
9477 \DeclareUnicodeCharacter{0237}{\dotless{j
}}
9479 \DeclareUnicodeCharacter{02DB
}{\ogonek{ }}
9481 \DeclareUnicodeCharacter{1E02
}{\dotaccent{B
}}
9482 \DeclareUnicodeCharacter{1E03
}{\dotaccent{b
}}
9483 \DeclareUnicodeCharacter{1E04
}{\udotaccent{B
}}
9484 \DeclareUnicodeCharacter{1E05
}{\udotaccent{b
}}
9485 \DeclareUnicodeCharacter{1E06
}{\ubaraccent{B
}}
9486 \DeclareUnicodeCharacter{1E07
}{\ubaraccent{b
}}
9487 \DeclareUnicodeCharacter{1E0A
}{\dotaccent{D
}}
9488 \DeclareUnicodeCharacter{1E0B
}{\dotaccent{d
}}
9489 \DeclareUnicodeCharacter{1E0C
}{\udotaccent{D
}}
9490 \DeclareUnicodeCharacter{1E0D
}{\udotaccent{d
}}
9491 \DeclareUnicodeCharacter{1E0E
}{\ubaraccent{D
}}
9492 \DeclareUnicodeCharacter{1E0F
}{\ubaraccent{d
}}
9494 \DeclareUnicodeCharacter{1E1E
}{\dotaccent{F
}}
9495 \DeclareUnicodeCharacter{1E1F
}{\dotaccent{f
}}
9497 \DeclareUnicodeCharacter{1E20
}{\=G
}
9498 \DeclareUnicodeCharacter{1E21
}{\=g
}
9499 \DeclareUnicodeCharacter{1E22
}{\dotaccent{H
}}
9500 \DeclareUnicodeCharacter{1E23
}{\dotaccent{h
}}
9501 \DeclareUnicodeCharacter{1E24
}{\udotaccent{H
}}
9502 \DeclareUnicodeCharacter{1E25
}{\udotaccent{h
}}
9503 \DeclareUnicodeCharacter{1E26
}{\"H
}
9504 \DeclareUnicodeCharacter{1E27
}{\"h
}
9506 \DeclareUnicodeCharacter{1E30
}{\'K
}
9507 \DeclareUnicodeCharacter{1E31
}{\'k
}
9508 \DeclareUnicodeCharacter{1E32
}{\udotaccent{K
}}
9509 \DeclareUnicodeCharacter{1E33
}{\udotaccent{k
}}
9510 \DeclareUnicodeCharacter{1E34
}{\ubaraccent{K
}}
9511 \DeclareUnicodeCharacter{1E35
}{\ubaraccent{k
}}
9512 \DeclareUnicodeCharacter{1E36
}{\udotaccent{L
}}
9513 \DeclareUnicodeCharacter{1E37
}{\udotaccent{l
}}
9514 \DeclareUnicodeCharacter{1E3A
}{\ubaraccent{L
}}
9515 \DeclareUnicodeCharacter{1E3B
}{\ubaraccent{l
}}
9516 \DeclareUnicodeCharacter{1E3E
}{\'M
}
9517 \DeclareUnicodeCharacter{1E3F
}{\'m
}
9519 \DeclareUnicodeCharacter{1E40
}{\dotaccent{M
}}
9520 \DeclareUnicodeCharacter{1E41
}{\dotaccent{m
}}
9521 \DeclareUnicodeCharacter{1E42
}{\udotaccent{M
}}
9522 \DeclareUnicodeCharacter{1E43
}{\udotaccent{m
}}
9523 \DeclareUnicodeCharacter{1E44
}{\dotaccent{N
}}
9524 \DeclareUnicodeCharacter{1E45
}{\dotaccent{n
}}
9525 \DeclareUnicodeCharacter{1E46
}{\udotaccent{N
}}
9526 \DeclareUnicodeCharacter{1E47
}{\udotaccent{n
}}
9527 \DeclareUnicodeCharacter{1E48
}{\ubaraccent{N
}}
9528 \DeclareUnicodeCharacter{1E49
}{\ubaraccent{n
}}
9530 \DeclareUnicodeCharacter{1E54
}{\'P
}
9531 \DeclareUnicodeCharacter{1E55
}{\'p
}
9532 \DeclareUnicodeCharacter{1E56
}{\dotaccent{P
}}
9533 \DeclareUnicodeCharacter{1E57
}{\dotaccent{p
}}
9534 \DeclareUnicodeCharacter{1E58
}{\dotaccent{R
}}
9535 \DeclareUnicodeCharacter{1E59
}{\dotaccent{r
}}
9536 \DeclareUnicodeCharacter{1E5A
}{\udotaccent{R
}}
9537 \DeclareUnicodeCharacter{1E5B
}{\udotaccent{r
}}
9538 \DeclareUnicodeCharacter{1E5E
}{\ubaraccent{R
}}
9539 \DeclareUnicodeCharacter{1E5F
}{\ubaraccent{r
}}
9541 \DeclareUnicodeCharacter{1E60
}{\dotaccent{S
}}
9542 \DeclareUnicodeCharacter{1E61
}{\dotaccent{s
}}
9543 \DeclareUnicodeCharacter{1E62
}{\udotaccent{S
}}
9544 \DeclareUnicodeCharacter{1E63
}{\udotaccent{s
}}
9545 \DeclareUnicodeCharacter{1E6A
}{\dotaccent{T
}}
9546 \DeclareUnicodeCharacter{1E6B
}{\dotaccent{t
}}
9547 \DeclareUnicodeCharacter{1E6C
}{\udotaccent{T
}}
9548 \DeclareUnicodeCharacter{1E6D
}{\udotaccent{t
}}
9549 \DeclareUnicodeCharacter{1E6E
}{\ubaraccent{T
}}
9550 \DeclareUnicodeCharacter{1E6F
}{\ubaraccent{t
}}
9552 \DeclareUnicodeCharacter{1E7C
}{\~V
}
9553 \DeclareUnicodeCharacter{1E7D
}{\~v
}
9554 \DeclareUnicodeCharacter{1E7E
}{\udotaccent{V
}}
9555 \DeclareUnicodeCharacter{1E7F
}{\udotaccent{v
}}
9557 \DeclareUnicodeCharacter{1E80
}{\`W
}
9558 \DeclareUnicodeCharacter{1E81
}{\`w
}
9559 \DeclareUnicodeCharacter{1E82
}{\'W
}
9560 \DeclareUnicodeCharacter{1E83
}{\'w
}
9561 \DeclareUnicodeCharacter{1E84
}{\"W
}
9562 \DeclareUnicodeCharacter{1E85
}{\"w
}
9563 \DeclareUnicodeCharacter{1E86
}{\dotaccent{W
}}
9564 \DeclareUnicodeCharacter{1E87
}{\dotaccent{w
}}
9565 \DeclareUnicodeCharacter{1E88
}{\udotaccent{W
}}
9566 \DeclareUnicodeCharacter{1E89
}{\udotaccent{w
}}
9567 \DeclareUnicodeCharacter{1E8A
}{\dotaccent{X
}}
9568 \DeclareUnicodeCharacter{1E8B
}{\dotaccent{x
}}
9569 \DeclareUnicodeCharacter{1E8C
}{\"X
}
9570 \DeclareUnicodeCharacter{1E8D
}{\"x
}
9571 \DeclareUnicodeCharacter{1E8E
}{\dotaccent{Y
}}
9572 \DeclareUnicodeCharacter{1E8F
}{\dotaccent{y
}}
9574 \DeclareUnicodeCharacter{1E90
}{\^Z
}
9575 \DeclareUnicodeCharacter{1E91
}{\^z
}
9576 \DeclareUnicodeCharacter{1E92
}{\udotaccent{Z
}}
9577 \DeclareUnicodeCharacter{1E93
}{\udotaccent{z
}}
9578 \DeclareUnicodeCharacter{1E94
}{\ubaraccent{Z
}}
9579 \DeclareUnicodeCharacter{1E95
}{\ubaraccent{z
}}
9580 \DeclareUnicodeCharacter{1E96
}{\ubaraccent{h
}}
9581 \DeclareUnicodeCharacter{1E97
}{\"t
}
9582 \DeclareUnicodeCharacter{1E98
}{\ringaccent{w
}}
9583 \DeclareUnicodeCharacter{1E99
}{\ringaccent{y
}}
9585 \DeclareUnicodeCharacter{1EA0
}{\udotaccent{A
}}
9586 \DeclareUnicodeCharacter{1EA1
}{\udotaccent{a
}}
9588 \DeclareUnicodeCharacter{1EB8
}{\udotaccent{E
}}
9589 \DeclareUnicodeCharacter{1EB9
}{\udotaccent{e
}}
9590 \DeclareUnicodeCharacter{1EBC
}{\~E
}
9591 \DeclareUnicodeCharacter{1EBD
}{\~e
}
9593 \DeclareUnicodeCharacter{1ECA
}{\udotaccent{I
}}
9594 \DeclareUnicodeCharacter{1ECB
}{\udotaccent{i
}}
9595 \DeclareUnicodeCharacter{1ECC
}{\udotaccent{O
}}
9596 \DeclareUnicodeCharacter{1ECD
}{\udotaccent{o
}}
9598 \DeclareUnicodeCharacter{1EE4
}{\udotaccent{U
}}
9599 \DeclareUnicodeCharacter{1EE5
}{\udotaccent{u
}}
9601 \DeclareUnicodeCharacter{1EF2
}{\`Y
}
9602 \DeclareUnicodeCharacter{1EF3
}{\`y
}
9603 \DeclareUnicodeCharacter{1EF4
}{\udotaccent{Y
}}
9605 \DeclareUnicodeCharacter{1EF8
}{\~Y
}
9606 \DeclareUnicodeCharacter{1EF9
}{\~y
}
9608 \DeclareUnicodeCharacter{2013}{--
}
9609 \DeclareUnicodeCharacter{2014}{---
}
9610 \DeclareUnicodeCharacter{2018}{\quoteleft}
9611 \DeclareUnicodeCharacter{2019}{\quoteright}
9612 \DeclareUnicodeCharacter{201A
}{\quotesinglbase}
9613 \DeclareUnicodeCharacter{201C
}{\quotedblleft}
9614 \DeclareUnicodeCharacter{201D
}{\quotedblright}
9615 \DeclareUnicodeCharacter{201E
}{\quotedblbase}
9616 \DeclareUnicodeCharacter{2022}{\bullet}
9617 \DeclareUnicodeCharacter{2026}{\dots}
9618 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9619 \DeclareUnicodeCharacter{203A
}{\guilsinglright}
9620 \DeclareUnicodeCharacter{20AC
}{\euro}
9622 \DeclareUnicodeCharacter{2192}{\expansion}
9623 \DeclareUnicodeCharacter{21D2
}{\result}
9625 \DeclareUnicodeCharacter{2212}{\minus}
9626 \DeclareUnicodeCharacter{2217}{\point}
9627 \DeclareUnicodeCharacter{2261}{\equiv}
9628 }% end of \utfeightchardefs
9631 % US-ASCII character definitions.
9632 \def\asciichardefs{% nothing need be done
9636 % Make non-ASCII characters printable again for compatibility with
9637 % existing Texinfo documents that may use them, even without declaring a
9638 % document encoding.
9640 \setnonasciicharscatcode \other
9643 \message{formatting,
}
9645 \newdimen\defaultparindent \defaultparindent =
15pt
9647 \chapheadingskip =
15pt plus
4pt minus
2pt
9648 \secheadingskip =
12pt plus
3pt minus
2pt
9649 \subsecheadingskip =
9pt plus
2pt minus
2pt
9651 % Prevent underfull vbox error messages.
9654 % Don't be very finicky about underfull hboxes, either.
9657 % Following George Bush, get rid of widows and orphans.
9661 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9662 % using an old version of TeX, don't do anything. We want the amount of
9663 % stretch added to depend on the line length, hence the dependence on
9664 % \hsize. We call this whenever the paper size is set.
9666 \def\setemergencystretch{%
9667 \ifx\emergencystretch\thisisundefined
9668 % Allow us to assign to \emergencystretch anyway.
9669 \def\emergencystretch{\dimen0}%
9671 \emergencystretch =
.15\hsize
9675 % Parameters in order: 1) textheight; 2) textwidth;
9676 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9677 % 7) physical page height; 8) physical page width.
9679 % We also call \setleading{\textleading}, so the caller should define
9680 % \textleading. The caller should also set \parskip.
9682 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9685 \splittopskip =
\topskip
9688 \advance\vsize by
\topskip
9689 \outervsize =
\vsize
9690 \advance\outervsize by
2\topandbottommargin
9691 \pageheight =
\vsize
9694 \outerhsize =
\hsize
9695 \advance\outerhsize by
0.5in
9698 \normaloffset =
#4\relax
9699 \bindingoffset =
#5\relax
9702 \pdfpageheight #7\relax
9703 \pdfpagewidth #8\relax
9704 % if we don't reset these, they will remain at "1 true in" of
9705 % whatever layout pdftex was dumped with.
9706 \pdfhorigin =
1 true in
9707 \pdfvorigin =
1 true in
9710 \setleading{\textleading}
9712 \parindent =
\defaultparindent
9713 \setemergencystretch
9716 % @letterpaper (the default).
9717 \def\letterpaper{{\globaldefs =
1
9718 \parskip =
3pt plus
2pt minus
1pt
9719 \textleading =
13.2pt
9721 % If page is nothing but text, make it come out even.
9722 \internalpagesizes{607.2pt
}{6in
}% that's 46 lines
9724 {\bindingoffset}{36pt
}%
9728 % Use @smallbook to reset parameters for 7x9.25 trim size.
9729 \def\smallbook{{\globaldefs =
1
9730 \parskip =
2pt plus
1pt
9733 \internalpagesizes{7.5in
}{5in
}%
9735 {\bindingoffset}{16pt
}%
9738 \lispnarrowing =
0.3in
9741 \contentsrightmargin =
0pt
9742 \defbodyindent =
.5cm
9745 % Use @smallerbook to reset parameters for 6x9 trim size.
9746 % (Just testing, parameters still in flux.)
9747 \def\smallerbook{{\globaldefs =
1
9748 \parskip =
1.5pt plus
1pt
9751 \internalpagesizes{7.4in
}{4.8in
}%
9756 \lispnarrowing =
0.25in
9759 \contentsrightmargin =
0pt
9760 \defbodyindent =
.4cm
9763 % Use @afourpaper to print on European A4 paper.
9764 \def\afourpaper{{\globaldefs =
1
9765 \parskip =
3pt plus
2pt minus
1pt
9766 \textleading =
13.2pt
9768 % Double-side printing via postscript on Laserjet 4050
9769 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9770 % To change the settings for a different printer or situation, adjust
9771 % \normaloffset until the front-side and back-side texts align. Then
9772 % do the same for \bindingoffset. You can set these for testing in
9773 % your texinfo source file like this:
9775 % \global\normaloffset = -6mm
9776 % \global\bindingoffset = 10mm
9778 \internalpagesizes{673.2pt
}{160mm
}% that's 51 lines
9779 {\voffset}{\hoffset}%
9780 {\bindingoffset}{44pt
}%
9785 \contentsrightmargin =
0pt
9786 \defbodyindent =
5mm
9789 % Use @afivepaper to print on European A5 paper.
9790 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9791 % He also recommends making @example and @lisp be small.
9792 \def\afivepaper{{\globaldefs =
1
9793 \parskip =
2pt plus
1pt minus
0.1pt
9794 \textleading =
12.5pt
9796 \internalpagesizes{160mm
}{120mm
}%
9797 {\voffset}{\hoffset}%
9798 {\bindingoffset}{8pt
}%
9801 \lispnarrowing =
0.2in
9804 \contentsrightmargin =
0pt
9805 \defbodyindent =
2mm
9809 % A specific text layout, 24x15cm overall, intended for A4 paper.
9810 \def\afourlatex{{\globaldefs =
1
9812 \internalpagesizes{237mm
}{150mm
}%
9814 {\bindingoffset}{7mm
}%
9817 % Must explicitly reset to 0 because we call \afourpaper.
9821 % Use @afourwide to print on A4 paper in landscape format.
9822 \def\afourwide{{\globaldefs =
1
9824 \internalpagesizes{241mm
}{165mm
}%
9825 {\voffset}{-
2.95mm
}%
9826 {\bindingoffset}{7mm
}%
9831 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9832 % Perhaps we should allow setting the margins, \topskip, \parskip,
9833 % and/or leading, also. Or perhaps we should compute them somehow.
9835 \parseargdef\pagesizes{\pagesizesyyy #1,,
\finish}
9836 \def\pagesizesyyy#1,
#2,
#3\finish{{%
9837 \setbox0 =
\hbox{\ignorespaces #2}\ifdim\wd0 >
0pt
\hsize=
#2\relax \fi
9840 \parskip =
3pt plus
2pt minus
1pt
9841 \setleading{\textleading}%
9844 \advance\dimen0 by
\voffset
9847 \advance\dimen2 by
\normaloffset
9849 \internalpagesizes{#1}{\hsize}%
9850 {\voffset}{\normaloffset}%
9851 {\bindingoffset}{44pt
}%
9855 % Set default to letter.
9860 \message{and turning on texinfo input format.
}
9862 \def^^L
{\par} % remove \outer, so ^L can appear in an @comment
9864 % DEL is a comment character, in case @c does not suffice.
9867 % Define macros to output various characters with catcode for normal text.
9868 \catcode`\"=
\other \def\normaldoublequote{"
}
9869 \catcode`\$=
\other \def\normaldollar{$
}%$ font-lock fix
9870 \catcode`\+=
\other \def\normalplus{+
}
9871 \catcode`\<=
\other \def\normalless{<
}
9872 \catcode`\>=
\other \def\normalgreater{>
}
9873 \catcode`\^=
\other \def\normalcaret{^
}
9874 \catcode`
\_=
\other \def\normalunderscore{_
}
9875 \catcode`\|=
\other \def\normalverticalbar{|
}
9876 \catcode`\~=
\other \def\normaltilde{~
}
9878 % This macro is used to make a character print one way in \tt
9879 % (where it can probably be output as-is), and another way in other fonts,
9880 % where something hairier probably needs to be done.
9882 % #1 is what to print if we are indeed using \tt; #2 is what to print
9883 % otherwise. Since all the Computer Modern typewriter fonts have zero
9884 % interword stretch (and shrink), and it is reasonable to expect all
9885 % typewriter fonts to have this, we can check that font parameter.
9887 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=
0pt
#1\else #2\fi}
9889 % Same as above, but check for italic font. Actually this also catches
9890 % non-italic slanted fonts since it is impossible to distinguish them from
9891 % italic fonts. But since this is only used by $ and it uses \sl anyway
9892 % this is not a problem.
9893 \def\ifusingit#1#2{\ifdim \fontdimen1\font>
0pt
#1\else #2\fi}
9895 % Turn off all special characters except @
9896 % (and those which the user can use as if they were ordinary).
9897 % Most of these we simply print from the \tt font, but for some, we can
9898 % use math or other variants that look better in normal text.
9901 \def\activedoublequote{{\tt\char34}}
9902 \let"=
\activedoublequote
9904 \def~
{{\tt\char126}}
9910 \def_{\ifusingtt\normalunderscore\_}
9912 % Subroutine for the previous macro.
9913 \def\_{\leavevmode \kern.07em
\vbox{\hrule width
.3em height
.1ex
}\kern .07em
}
9916 \def|
{{\tt\char124}}
9924 \def+
{{\tt \char 43}}
9926 \def$
{\ifusingit{{\sl\$
}}\normaldollar}%$ font-lock fix
9928 % If a .fmt file is being used, characters that might appear in a file
9929 % name cannot be active until we have parsed the command line.
9930 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9931 % \otherifyactive is called near the end of this file.
9932 \def\otherifyactive{\catcode`+=
\other \catcode`
\_=
\other}
9934 % Used sometimes to turn off (effectively) the active characters even after
9936 \def\turnoffactive{%
9937 \normalturnoffactive
9943 % \backslashcurfont outputs one backslash character in current font,
9945 \global\chardef\backslashcurfont=`\\
9946 \global\let\rawbackslashxx=
\backslashcurfont % let existing .??s files work
9948 % \realbackslash is an actual character `\' with catcode other, and
9949 % \doublebackslash is two of them (for the pdf outlines).
9950 {\catcode`\\=
\other @gdef@realbackslash
{\
} @gdef@doublebackslash
{\\
}}
9952 % In texinfo, backslash is an active character; it prints the backslash
9953 % in fixed width font.
9954 \catcode`\\=
\active % @ for escape char from now on.
9956 % The story here is that in math mode, the \char of \backslashcurfont
9957 % ends up printing the roman \ from the math symbol font (because \char
9958 % in math mode uses the \mathcode, and plain.tex sets
9959 % \mathcode`\\="026E). It seems better for @backslashchar{} to always
9960 % print a typewriter backslash, hence we use an explicit \mathchar,
9961 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
9962 % ignored family value; char position "5C). We can't use " for the
9963 % usual hex value because it has already been made active.
9964 @def@normalbackslash
{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi
}}
9965 @let@backslashchar = @normalbackslash
% @backslashchar{} is for user documents.
9967 % On startup, @fixbackslash assigns:
9968 % @let \ = @normalbackslash
9969 % \rawbackslash defines an active \ to do \backslashcurfont.
9970 % \otherbackslash defines an active \ to be a literal `\' character with
9971 % catcode other. We switch back and forth between these.
9972 @gdef@rawbackslash
{@let\=@backslashcurfont
}
9973 @gdef@otherbackslash
{@let\=@realbackslash
}
9975 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9976 % the literal character `\'.
9978 @def@normalturnoffactive
{%
9979 @let"=@normaldoublequote
9980 @let$=@normaldollar
%$ font-lock fix
9983 @let>=@normalgreater
9984 @let\=@normalbackslash
9986 @let_=@normalunderscore
9987 @let|=@normalverticalbar
9989 @markupsetuplqdefault
9990 @markupsetuprqdefault
9994 % Make _ and + \other characters, temporarily.
9995 % This is canceled by @fixbackslash.
9998 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9999 % That is what \eatinput is for; after that, the `\' should revert to printing
10002 @gdef@eatinput input texinfo
{@fixbackslash
}
10003 @global@let\ = @eatinput
10005 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
10006 % the first `\' in the file would cause an error. This macro tries to fix
10007 % that, assuming it is called before the first `\' could plausibly occur.
10008 % Also turn back on active characters that might appear in the input
10009 % file name, in case not using a pre-dumped format.
10011 @gdef@fixbackslash
{%
10012 @ifx\@eatinput @let\ = @normalbackslash @fi
10014 @catcode`@_=@active
10017 % Say @foo, not \foo, in error messages.
10020 % These (along with & and #) are made active for url-breaking, so need
10021 % active definitions as the normal characters.
10023 @def@normalquest
{?
}
10024 @def@normalslash
{/
}
10026 % These look ok in all fonts, so just make them not special.
10027 % @hashchar{} gets its own user-level command, because of #line.
10028 @catcode`@& = @other @def@normalamp
{&
}
10029 @catcode`@# = @other @def@normalhash
{#
}
10030 @catcode`@
% = @other @def@normalpercent{%}
10032 @let @hashchar = @normalhash
10034 @c Finally, make ` and ' active, so that txicodequoteundirected and
10035 @c txicodequotebacktick work right in, e.g., @w
{@code
{`foo'
}}. If we
10036 @c don't make ` and ' active, @code will not get them as active chars.
10037 @c Do this last of all since we use ` in the previous @catcode assignments.
10038 @catcode`@'=@active
10039 @catcode`@`=@active
10040 @markupsetuplqdefault
10041 @markupsetuprqdefault
10043 @c Local variables:
10044 @c eval: (add-hook 'write-file-hooks 'time-stamp)
10045 @c page-delimiter: "^\\\
\message"
10046 @c time-stamp-start: "def\\\
\texinfoversion{"
10047 @c time-stamp-format: "
%:y-%02m-%02d.%02H"
10048 @c time-stamp-end: "
}"
10054 arch-tag: e1b36e32-c96e-4135-a41a-
0b2efa2ea115