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{2015-
09-
05.20}
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, 2013, 2014, 2015
11 % Free Software Foundation, Inc.
13 % This texinfo.tex file is free software: you can redistribute it and/or
14 % modify it under the terms of the GNU General Public License as
15 % published by the Free Software Foundation, either version 3 of the
16 % License, or (at your option) any later version.
18 % This texinfo.tex file is distributed in the hope that it will be
19 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
20 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 % General Public License for more details.
23 % You should have received a copy of the GNU General Public License
24 % along with this program. If not, see <http://www.gnu.org/licenses/>.
26 % As a special exception, when this file is read by TeX when processing
27 % a Texinfo source document, you may use the result without
28 % restriction. This Exception is an additional permission under section 7
29 % of the GNU General Public License, version 3 ("GPLv3").
31 % Please try the latest version of texinfo.tex before submitting bug
32 % reports; you can get the latest version from:
33 % http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
34 % http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
35 % http://www.gnu.org/software/texinfo/ (the Texinfo home page)
36 % The texinfo.tex in any given distribution could well be out
37 % of date, so if that's what you're using, please check.
39 % Send bug reports to bug-texinfo@gnu.org. Please include including a
40 % complete document in each bug report with which we can reproduce the
41 % problem. Patches are, of course, greatly appreciated.
43 % To process a Texinfo manual with TeX, it's most reliable to use the
44 % texi2dvi shell script that comes with the distribution. For a simple
45 % manual foo.texi, however, you can get away with this:
50 % dvips foo.dvi -o # or whatever; this makes foo.ps.
51 % The extra TeX runs get the cross-reference information correct.
52 % Sometimes one run after texindex suffices, and sometimes you need more
53 % than two; texi2dvi does it as many times as necessary.
55 % It is possible to adapt texinfo.tex for other languages, to some
56 % extent. You can get the existing language-specific files from the
57 % full Texinfo distribution.
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
62 \message{Loading texinfo
[version
\texinfoversion]:
}
64 % If in a .fmt file, print the version number
65 % and turn on active characters that we couldn't do earlier because
66 % they might have appeared in the input file name.
67 \everyjob{\message{[Texinfo version
\texinfoversion]}%
68 \catcode`+=
\active \catcode`
\_=
\active}
72 % We never want plain's \outer definition of \+ in Texinfo.
73 % For @tex, we can use \tabalign.
76 % Save some plain tex macros whose names we will redefine.
78 \let\ptexbullet=
\bullet
86 \let\ptexfootnote=
\footnote
90 \let\ptexindent=
\indent
91 \let\ptexinsert=
\insert
94 \let\ptexnewwrite\newwrite
95 \let\ptexnoindent=
\noindent
97 \let\ptexraggedright=
\raggedright
105 {\catcode`\'=
\active \global\let\ptexquoteright'
}% active in plain's math mode
107 % If this character appears in an error message or help string, it
108 % starts a new line in the output.
111 % Use TeX 3.0's \inputlineno to get the line number, for better error
112 % messages, but if we're using an old version of TeX, don't do anything.
114 \ifx\inputlineno\thisisundefined
115 \let\linenumber =
\empty % Pre-3.0.
117 \def\linenumber{l.
\the\inputlineno:
\space}
120 % Set up fixed words for English if not already set.
121 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix
}\fi
122 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter
}\fi
123 \ifx\putworderror\undefined \gdef\putworderror{error
}\fi
124 \ifx\putwordfile\undefined \gdef\putwordfile{file
}\fi
125 \ifx\putwordin\undefined \gdef\putwordin{in
}\fi
126 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)
}\fi
127 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)
}\fi
128 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info
}\fi
129 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of
}\fi
130 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on
}\fi
131 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title
}\fi
132 \ifx\putwordof\undefined \gdef\putwordof{of
}\fi
133 \ifx\putwordon\undefined \gdef\putwordon{on
}\fi
134 \ifx\putwordpage\undefined \gdef\putwordpage{page
}\fi
135 \ifx\putwordsection\undefined \gdef\putwordsection{section
}\fi
136 \ifx\putwordSection\undefined \gdef\putwordSection{Section
}\fi
137 \ifx\putwordsee\undefined \gdef\putwordsee{see
}\fi
138 \ifx\putwordSee\undefined \gdef\putwordSee{See
}\fi
139 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents
}\fi
140 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents
}\fi
142 \ifx\putwordMJan\undefined \gdef\putwordMJan{January
}\fi
143 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February
}\fi
144 \ifx\putwordMMar\undefined \gdef\putwordMMar{March
}\fi
145 \ifx\putwordMApr\undefined \gdef\putwordMApr{April
}\fi
146 \ifx\putwordMMay\undefined \gdef\putwordMMay{May
}\fi
147 \ifx\putwordMJun\undefined \gdef\putwordMJun{June
}\fi
148 \ifx\putwordMJul\undefined \gdef\putwordMJul{July
}\fi
149 \ifx\putwordMAug\undefined \gdef\putwordMAug{August
}\fi
150 \ifx\putwordMSep\undefined \gdef\putwordMSep{September
}\fi
151 \ifx\putwordMOct\undefined \gdef\putwordMOct{October
}\fi
152 \ifx\putwordMNov\undefined \gdef\putwordMNov{November
}\fi
153 \ifx\putwordMDec\undefined \gdef\putwordMDec{December
}\fi
155 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro
}\fi
156 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form
}\fi
157 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable
}\fi
158 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option
}\fi
159 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function
}\fi
161 % Since the category of space is not known, we have to be careful.
162 \chardef\spacecat =
10
163 \def\spaceisspace{\catcode`\ =
\spacecat}
165 % sometimes characters are active, so we need control sequences.
166 \chardef\ampChar = `\&
167 \chardef\colonChar = `\:
168 \chardef\commaChar = `\,
169 \chardef\dashChar = `\-
170 \chardef\dotChar = `\.
171 \chardef\exclamChar= `\!
172 \chardef\hashChar = `\#
173 \chardef\lquoteChar= `\`
174 \chardef\questChar = `\?
175 \chardef\rquoteChar= `\'
176 \chardef\semiChar = `\;
177 \chardef\slashChar = `\/
178 \chardef\underChar = `
\_
184 % The following is used inside several \edef's.
185 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
189 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
190 ap-pen-dix bit-map bit-maps
191 data-base data-bases eshell fall-ing half-way long-est man-u-script
192 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
193 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
195 stand-alone strong-est time-stamp time-stamps which-ever white-space
196 wide-spread wrap-around
199 % Margin to add to right of even pages, to left of odd pages.
200 \newdimen\bindingoffset
201 \newdimen\normaloffset
202 \newdimen\pagewidth \newdimen\pageheight
204 % For a final copy, take out the rectangles
205 % that mark overfull boxes (in case you have decided
206 % that the text looks ok even though it passes the margin).
208 \def\finalout{\overfullrule=
0pt
}
210 % Sometimes it is convenient to have everything in the transcript file
211 % and nothing on the terminal. We don't just call \tracingall here,
212 % since that produces some useless output on the terminal. We also make
213 % some effort to order the tracing commands to reduce output in the log
214 % file; cf. trace.sty in LaTeX.
216 \def\gloggingall{\begingroup \globaldefs =
1 \loggingall \endgroup}%
220 \tracinglostchars2 % 2 gives us more in etex
225 \showboxbreadth\maxdimen \showboxdepth\maxdimen
226 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
233 \tracingcommands3 % 3 gives us more in etex
237 % @errormsg{MSG}. Do the index-like expansions on MSG, but if things
238 % aren't perfect, it's not the end of the world, being an error message,
241 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
242 \def\doerrormsg#1{\errmessage{#1}}
244 % add check for \lastpenalty to plain's definitions. If the last thing
245 % we did was a \nobreak, we don't want to insert more space.
247 \def\smallbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\smallskipamount
248 \removelastskip\penalty-
50\smallskip\fi\fi}
249 \def\medbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\medskipamount
250 \removelastskip\penalty-
100\medskip\fi\fi}
251 \def\bigbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\bigskipamount
252 \removelastskip\penalty-
200\bigskip\fi\fi}
254 % Do @cropmarks to get crop marks.
257 \let\cropmarks =
\cropmarkstrue
259 % Dimensions to add cropmarks at corners.
260 % Added by P. A. MacKay, 12 Nov. 1986
262 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
263 \newdimen\cornerlong \cornerlong=
1pc
264 \newdimen\cornerthick \cornerthick=
.3pt
265 \newdimen\topandbottommargin \topandbottommargin=
.75in
267 % Output a mark which sets \thischapter, \thissection and \thiscolor.
268 % We dump everything together because we only have one kind of mark.
269 % This works because we only use \botmark / \topmark, not \firstmark.
271 % A mark contains a subexpression of the \ifcase ... \fi construct.
272 % \get*marks macros below extract the needed part using \ifcase.
274 % Another complication is to let the user choose whether \thischapter
275 % (\thissection) refers to the chapter (section) in effect at the top
276 % of a page, or that at the bottom of a page. The solution is
277 % described on page 260 of The TeXbook. It involves outputting two
278 % marks for the sectioning macros, one before the section break, and
279 % one after. I won't pretend I can describe this better than DEK...
282 \toks0=
\expandafter{\lastchapterdefs}%
283 \toks2=
\expandafter{\lastsectiondefs}%
284 \toks4=
\expandafter{\prevchapterdefs}%
285 \toks6=
\expandafter{\prevsectiondefs}%
286 \toks8=
\expandafter{\lastcolordefs}%
288 \the\toks0 \the\toks2 % 0: top marks (\last...)
289 \noexpand\or \the\toks4 \the\toks6 % 1: bottom marks (default, \prev...)
290 \noexpand\else \the\toks8 % 2: color marks
293 % \topmark doesn't work for the very first chapter (after the title
294 % page or the contents), so we use \firstmark there -- this gets us
295 % the mark with the chapter defs, unless the user sneaks in, e.g.,
296 % @setcolor (or @url, or @link, etc.) between @contents and the very
298 \def\gettopheadingmarks{%
300 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
302 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
303 \def\getcolormarks{\ifcase2\topmark\fi}
305 % Avoid "undefined control sequence" errors.
306 \def\lastchapterdefs{}
307 \def\lastsectiondefs{}
309 \def\prevchapterdefs{}
310 \def\prevsectiondefs{}
314 % Main output routine.
317 \output =
{\onepageout{\pagecontents\PAGE}}
322 % \onepageout takes a vbox as an argument. Note that \pagecontents
323 % does insertions, but you have to call it yourself.
325 \ifcropmarks \hoffset=
0pt
\else \hoffset=
\normaloffset \fi
327 \ifodd\pageno \advance\hoffset by
\bindingoffset
328 \else \advance\hoffset by -
\bindingoffset\fi
330 % Do this outside of the \shipout so @code etc. will be expanded in
331 % the headline as they should be, not taken literally (outputting ''code).
332 \def\commmonheadfootline{\let\hsize=
\pagewidth \texinfochars}
334 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
335 \global\setbox\headlinebox =
\vbox{\commmonheadfootline \makeheadline}%
337 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
338 \global\setbox\footlinebox =
\vbox{\commmonheadfootline \makefootline}%
341 % Have to do this stuff outside the \shipout because we want it to
342 % take effect in \write's, yet the group defined by the \vbox ends
343 % before the \shipout runs.
345 \indexdummies % don't expand commands in the output.
346 \normalturnoffactive % \ in index entries must not stay \, e.g., if
347 % the page break happens to be in the middle of an example.
348 % We don't want .vr (or whatever) entries like this:
349 % \entry{{\indexbackslash }acronym}{32}{\code {\acronym}}
350 % "\acronym" won't work when it's read back in;
352 % {\code {{\backslashcurfont }acronym}
354 % Do this early so pdf references go to the beginning of the page.
355 \ifpdfmakepagedest \pdfdest name
{\the\pageno} xyz
\fi
357 \ifcropmarks \vbox to
\outervsize\bgroup
359 \vskip-
\topandbottommargin
361 \line{\ewtop\hfil\ewtop}%
364 \vbox{\moveleft\cornerthick\nstop}%
366 \vbox{\moveright\cornerthick\nstop}%
369 \vskip\topandbottommargin
371 \hfil % center the page within the outer (page) hsize.
372 \ifodd\pageno\hskip\bindingoffset\fi
378 \ifdim\ht\footlinebox >
0pt
379 % Only leave this space if the footline is nonempty.
380 % (We lessened \vsize for it in \oddfootingyyy.)
381 % The \baselineskip=24pt in plain's \makefootline has no effect.
387 \egroup % end of \vbox\bgroup
388 \hfil\egroup % end of (centering) \line\bgroup
389 \vskip\topandbottommargin plus1fill minus1fill
390 \boxmaxdepth =
\cornerthick
393 \vbox{\moveleft\cornerthick\nsbot}%
395 \vbox{\moveright\cornerthick\nsbot}%
398 \line{\ewbot\hfil\ewbot}%
400 \egroup % \vbox from first cropmarks clause
402 }% end of \shipout\vbox
403 }% end of group with \indexdummies
405 \ifnum\outputpenalty>-
20000 \else\dosupereject\fi
408 \newinsert\margin \dimen\margin=
\maxdimen
410 \def\pagebody#1{\vbox to
\pageheight{\boxmaxdepth=
\maxdepth #1}}
412 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
413 % marginal hacks, juha@viisa.uucp (Juha Takala)
414 \ifvoid\margin\else % marginal info is present
415 \rlap{\kern\hsize\vbox to
\z@
{\kern1pt\box\margin \vss}}\fi
416 \dimen@=
\dp#1\relax \unvbox#1\relax
417 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
418 \ifr@ggedbottom
\kern-
\dimen@
\vfil \fi}
421 % Here are the rules for the cropmarks. Note that they are
422 % offset so that the space between them is truly \outerhsize or \outervsize
423 % (P. A. MacKay, 12 November, 1986)
425 \def\ewtop{\vrule height
\cornerthick depth0pt width
\cornerlong}
427 {\hrule height
\cornerthick depth
\cornerlong width
\cornerthick}}
428 \def\ewbot{\vrule height0pt depth
\cornerthick width
\cornerlong}
430 {\hrule height
\cornerlong depth
\cornerthick width
\cornerthick}}
435 % Parse an argument, then pass it to #1. The argument is the rest of
436 % the input line (except we remove a trailing comment). #1 should be a
437 % macro which expects an ordinary undelimited TeX argument.
438 % For example, \def\foo{\parsearg\fooxxx}.
440 \def\parsearg{\parseargusing{}}
441 \def\parseargusing#1#2{%
447 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
451 \gdef\parseargline#1^^M
{%
452 \endgroup % End of the group started in \parsearg.
453 \argremovecomment #1\comment\ArgTerm%
457 % First remove any @comment, then any @c comment. Also remove a @texinfoc
458 % comment (see \scanmacro for details). Pass the result on to \argcheckspaces.
459 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
460 \def\argremovec#1\c#2\ArgTerm{\argremovetexinfoc #1\texinfoc\ArgTerm}
461 \def\argremovetexinfoc#1\texinfoc#2\ArgTerm{\argcheckspaces#1\^^M
\ArgTerm}
463 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
465 % \argremovec might leave us with trailing space, e.g.,
466 % @end itemize @c foo
467 % This space token undergoes the same procedure and is eventually removed
468 % by \finishparsearg.
470 \def\argcheckspaces#1\^^M
{\argcheckspacesX#1\^^M \^^M
}
471 \def\argcheckspacesX#1 \^^M
{\argcheckspacesY#1\^^M
}
472 \def\argcheckspacesY#1\^^M
#2\^^M
#3\ArgTerm{%
475 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
476 \let\temp\finishparsearg
478 \let\temp\argcheckspaces
480 % Put the space token in:
484 % If a _delimited_ argument is enclosed in braces, they get stripped; so
485 % to get _exactly_ the rest of the line, we had to prevent such situation.
486 % We prepended an \empty token at the very beginning and we expand it now,
487 % just before passing the control to \argtorun.
488 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
489 % either the null string, or it ends with \^^M---thus there is no danger
490 % that a pair of braces would be stripped.
492 % But first, we have to remove the trailing space token.
494 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
496 % \parseargdef\foo{...}
497 % is roughly equivalent to
498 % \def\foo{\parsearg\Xfoo}
501 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
502 % favourite TeX trick. --kasal, 16nov03
505 \expandafter \doparseargdef \csname\string#1\endcsname #1%
507 \def\doparseargdef#1#2{%
512 % Several utility definitions with active space:
517 % Make each space character in the input produce a normal interword
518 % space in the output. Don't allow a line break at this space, as this
519 % is used only in environments like @example, where each line of input
520 % should produce a line of output anyway.
522 \gdef\sepspaces{\obeyspaces\let =
\tie}
524 % If an index command is used in an @example environment, any spaces
525 % therein should become regular spaces in the raw index file, not the
526 % expansion of \tie (\leavevmode \penalty \@M \ ).
527 \gdef\unsepspaces{\let =
\space}
531 \def\flushcr{\ifx\par\lisppar \def\next#
#1{}\else \let\next=
\relax \fi \next}
533 % Define the framework for environments in texinfo.tex. It's used like this:
538 % It's the responsibility of \envdef to insert \begingroup before the
539 % actual body; @end closes the group after calling \Efoo. \envdef also
540 % defines \thisenv, so the current environment is known; @end checks
541 % whether the environment name matches. The \checkenv macro can also be
542 % used to check whether the current environment is the one expected.
544 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
545 % are not treated as environments; they don't open a group. (The
546 % implementation of @end takes care not to call \endgroup in this
550 % At run-time, environments start with this:
551 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
555 % ... but they get defined via ``\envdef\foo{...}'':
556 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
557 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
559 % Check whether we're in the right environment:
568 % Environment mismatch, #1 expected:
571 \errmessage{This command can appear only
\inenvironment\temp,
572 not
\inenvironment\thisenv}%
574 \def\inenvironment#1{%
576 outside of any environment
%
578 in environment
\expandafter\string#1%
582 % @end foo executes the definition of \Efoo.
583 % But first, it executes a specialized version of \checkenv
586 \if 1\csname iscond.
#1\endcsname
588 % The general wording of \badenverr may not be ideal.
589 \expandafter\checkenv\csname#1\endcsname
590 \csname E
#1\endcsname
595 \newhelp\EMsimple{Press RETURN to continue.
}
598 % Be sure we're in horizontal mode when doing a tie, since we make space
599 % equivalent to this in @example-like environments. Otherwise, a space
600 % at the beginning of a line will start with \penalty -- and
601 % since \penalty is valid in vertical mode, we'd end up putting the
602 % penalty on the vertical list instead of in the new paragraph.
604 % Avoid using \@M directly, because that causes trouble
605 % if the definition is written into an index file.
606 \global\let\tiepenalty = \@M
607 \gdef\tie{\leavevmode\penalty\tiepenalty\
}
610 % @: forces normal size whitespace following.
611 \def\:
{\spacefactor=
1000 }
613 % @* forces a line break.
614 \def\*
{\unskip\hfil\break\hbox{}\ignorespaces}
616 % @/ allows a line break.
619 % @. is an end-of-sentence period.
620 \def\.
{.
\spacefactor=
\endofsentencespacefactor\space}
622 % @! is an end-of-sentence bang.
623 \def\!
{!
\spacefactor=
\endofsentencespacefactor\space}
625 % @? is an end-of-sentence query.
626 \def\?
{?
\spacefactor=
\endofsentencespacefactor\space}
628 % @frenchspacing on|off says whether to put extra space after punctuation.
633 \parseargdef\frenchspacing{%
635 \ifx\temp\onword \plainfrenchspacing
636 \else\ifx\temp\offword \plainnonfrenchspacing
639 \errmessage{Unknown @frenchspacing option `
\temp', must be on|off
}%
643 % @w prevents a word break. Without the \leavevmode, @w at the
644 % beginning of a paragraph, when TeX is still in vertical mode, would
645 % produce a whole line of output instead of starting the paragraph.
646 \def\w#1{\leavevmode\hbox{#1}}
648 % @group ... @end group forces ... to be all on one page, by enclosing
649 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
650 % to keep its height that of a normal line. According to the rules for
651 % \topskip (p.114 of the TeXbook), the glue inserted is
652 % max (\topskip - \ht (first item), 0). If that height is large,
653 % therefore, no glue is inserted, and the space between the headline and
654 % the text is small, which looks bad.
656 % Another complication is that the group might be very large. This can
657 % cause the glue on the previous page to be unduly stretched, because it
658 % does not have much material. In this case, it's better to add an
659 % explicit \vfill so that the extra space is at the bottom. The
660 % threshold for doing this is if the group is more than \vfilllimit
661 % percent of a page (\vfilllimit can be changed inside of @tex).
667 \ifnum\catcode`\^^M=
\active \else
668 \errhelp =
\groupinvalidhelp
669 \errmessage{@group invalid in context where filling is enabled
}%
673 \setbox\groupbox =
\vtop\bgroup
674 % Do @comment since we are called inside an environment such as
675 % @example, where each end-of-line in the input causes an
676 % end-of-line in the output. We don't want the end-of-line after
677 % the `@group' to put extra space in the output. Since @group
678 % should appear on a line by itself (according to the Texinfo
679 % manual), we don't worry about eating any user text.
683 % The \vtop produces a box with normal height and large depth; thus, TeX puts
684 % \baselineskip glue before it, and (when the next line of text is done)
685 % \lineskip glue after it. Thus, space below is not quite equal to space
686 % above. But it's pretty close.
688 % To get correct interline space between the last line of the group
689 % and the first line afterwards, we have to propagate \prevdepth.
690 \endgraf % Not \par, as it may have been set to \lisppar.
691 \global\dimen1 =
\prevdepth
692 \egroup % End the \vtop.
693 % \dimen0 is the vertical size of the group's box.
694 \dimen0 =
\ht\groupbox \advance\dimen0 by
\dp\groupbox
695 % \dimen2 is how much space is left on the page (more or less).
696 \dimen2 =
\pageheight \advance\dimen2 by -
\pagetotal
697 % if the group doesn't fit on the current page, and it's a big big
698 % group, force a page break.
699 \ifdim \dimen0 >
\dimen2
700 \ifdim \pagetotal <
\vfilllimit\pageheight
709 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
710 % message, so this ends up printing `@group can only ...'.
712 \newhelp\groupinvalidhelp{%
713 group can only be used in environments such as @example,^^J
%
714 where each line of input produces a line of output.
}
716 % @need space-in-mils
717 % forces a page break if there is not space-in-mils remaining.
719 \newdimen\mil \mil=
0.001in
722 % Ensure vertical mode, so we don't make a big box in the middle of a
726 % If the @need value is less than one line space, it's useless.
728 \dimen2 =
\ht\strutbox
729 \advance\dimen2 by
\dp\strutbox
730 \ifdim\dimen0 >
\dimen2
732 % Do a \strut just to make the height of this box be normal, so the
733 % normal leading is inserted relative to the preceding line.
734 % And a page break here is fine.
735 \vtop to
#1\mil{\strut\vfil}%
737 % TeX does not even consider page breaks if a penalty added to the
738 % main vertical list is 10000 or more. But in order to see if the
739 % empty box we just added fits on the page, we must make it consider
740 % page breaks. On the other hand, we don't want to actually break the
741 % page after the empty box. So we use a penalty of 9999.
743 % There is an extremely small chance that TeX will actually break the
744 % page at this \penalty, if there are no other feasible breakpoints in
745 % sight. (If the user is using lots of big @group commands, which
746 % almost-but-not-quite fill up a page, TeX will have a hard time doing
747 % good page breaking, for example.) However, I could not construct an
748 % example where a page broke at this \penalty; if it happens in a real
749 % document, then we can reconsider our strategy.
752 % Back up by the size of the box, whether we did a page break or not.
755 % Do not allow a page break right after this kern.
760 % @br forces paragraph break (and is undocumented).
764 % @page forces the start of a new page.
766 \def\page{\par\vfill\supereject}
769 % outputs text on separate line in roman font, starting at standard page margin
771 % This records the amount of indent in the innermost environment.
772 % That's how much \exdent should take out.
773 \newskip\exdentamount
775 % This defn is used inside fill environments such as @defun.
776 \parseargdef\exdent{\hfil\break\hbox{\kern -
\exdentamount{\rm#1}}\hfil\break}
778 % This defn is used inside nofill environments such as @example.
779 \parseargdef\nofillexdent{{\advance \leftskip by -
\exdentamount
780 \leftline{\hskip\leftskip{\rm#1}}}}
782 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
783 % paragraph. For more general purposes, use the \margin insertion
784 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
786 \newskip\inmarginspacing \inmarginspacing=
1cm
787 \def\strutdepth{\dp\strutbox}
789 \def\doinmargin#1#2{\strut\vadjust{%
792 \vtop to
\strutdepth{%
793 \baselineskip=
\strutdepth
795 % if you have multiple lines of stuff to put here, you'll need to
796 % make the vbox yourself of the appropriate size.
798 \llap{\ignorespaces #2\hskip\inmarginspacing}%
800 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
805 \def\inleftmargin{\doinmargin l
}
806 \def\inrightmargin{\doinmargin r
}
808 % @inmargin{TEXT [, RIGHT-TEXT]}
809 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
810 % else use TEXT for both).
812 \def\inmargin#1{\parseinmargin #1,,
\finish}
813 \def\parseinmargin#1,
#2,
#3\finish{% not perfect, but better than nothing.
814 \setbox0 =
\hbox{\ignorespaces #2}%
816 \def\lefttext{#1}% have both texts
819 \def\lefttext{#1}% have only one text
824 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
826 \def\temp{\inleftmargin\lefttext}%
831 % @| inserts a changebar to the left of the current line. It should
832 % surround any changed text. This approach does *not* work if the
833 % change spans more than two lines of output. To handle that, we would
834 % have adopt a much more difficult approach (putting marks into the main
835 % vertical list for the beginning and end of each change). This command
836 % is not documented, not supported, and doesn't work.
839 % \vadjust can only be used in horizontal mode.
842 % Append this vertical mode material after the current line in the output.
844 % We want to insert a rule with the height and depth of the current
845 % leading; that is exactly what \strutbox is supposed to record.
848 % \vadjust-items are inserted at the left edge of the type. So
849 % the \llap here moves out into the left-hand margin.
852 % For a thicker or thinner bar, change the `1pt'.
853 \vrule height
\baselineskip width1pt
855 % This is the space between the bar and the text.
861 % @include FILE -- \input text of FILE.
863 \def\include{\parseargusing\filenamecatcodes\includezzz}
868 \makevalueexpandable % we want to expand any @value in FILE.
869 \turnoffactive % and allow special characters in the expansion
870 \indexnofonts % Allow `@@' and other weird things in file names.
871 \wlog{texinfo.tex: doing @include of
#1^^J
}%
872 \edef\temp{\noexpand\input #1 }%
874 % This trickery is to read FILE outside of a group, in case it makes
880 \def\filenamecatcodes{%
894 \def\pushthisfilestack{%
895 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
897 \def\pushthisfilestackX{%
898 \expandafter\pushthisfilestackY\thisfile\StackTerm
900 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
901 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
904 \def\popthisfilestack{\errthisfilestackempty}
905 \def\errthisfilestackempty{\errmessage{Internal error:
906 the stack of filenames is empty.
}}
911 % outputs that line, centered.
913 \parseargdef\center{%
915 \let\centersub\centerH
917 \let\centersub\centerV
919 \centersub{\hfil \ignorespaces#1\unskip \hfil}%
920 \let\centersub\relax % don't let the definition persist, just in case
924 \advance\hsize by -
\leftskip
925 \advance\hsize by -
\rightskip
930 \newcount\centerpenalty
932 % The idea here is the same as in \startdefun, \cartouche, etc.: if
933 % @center is the first thing after a section heading, we need to wipe
934 % out the negative parskip inserted by \sectionheading, but still
935 % prevent a page break here.
936 \centerpenalty =
\lastpenalty
937 \ifnum\centerpenalty>
10000 \vskip\parskip \fi
938 \ifnum\centerpenalty>
9999 \penalty\centerpenalty \fi
939 \line{\kern\leftskip #1\kern\rightskip}%
942 % @sp n outputs n lines of vertical space
944 \parseargdef\sp{\vskip #1\baselineskip}
946 % @comment ...line which is ignored...
947 % @c is the same as @comment
948 % @ignore ... @end ignore is another way to write a comment
950 \def\comment{\begingroup \catcode`\^^M=
\active%
951 \catcode`\@=
\other \catcode`\
{=
\other \catcode`\
}=
\other\commentxxx}%
953 {\catcode`\^^M=
\active%
954 \gdef\commentxxx#1^^M
{\endgroup%
955 \futurelet\nexttoken\commentxxxx}%
956 \gdef\commentxxxx{\ifx\nexttoken\aftermacro\expandafter\comment\fi}%
959 \def\c{\begingroup \catcode`\^^M=
\active%
960 \catcode`\@=
\other \catcode`\
{=
\other \catcode`\
}=
\other%
962 {\catcode`\^^M=
\active \gdef\cxxx#1^^M
{\endgroup}}
963 % See comment in \scanmacro about why the definitions of @c and @comment differ
965 % @paragraphindent NCHARS
966 % We'll use ems for NCHARS, close enough.
967 % NCHARS can also be the word `asis' or `none'.
968 % We cannot feasibly implement @paragraphindent asis, though.
970 \def\asisword{asis
} % no translation, these are keywords
973 \parseargdef\paragraphindent{%
978 \defaultparindent =
0pt
980 \defaultparindent =
#1em
983 \parindent =
\defaultparindent
986 % @exampleindent NCHARS
987 % We'll use ems for NCHARS like @paragraphindent.
988 % It seems @exampleindent asis isn't necessary, but
989 % I preserve it to make it similar to @paragraphindent.
990 \parseargdef\exampleindent{%
997 \lispnarrowing =
#1em
1002 % @firstparagraphindent WORD
1003 % If WORD is `none', then suppress indentation of the first paragraph
1004 % after a section heading. If WORD is `insert', then do indent at such
1007 % The paragraph indentation is suppressed or not by calling
1008 % \suppressfirstparagraphindent, which the sectioning commands do.
1009 % We switch the definition of this back and forth according to WORD.
1010 % By default, we suppress indentation.
1012 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1013 \def\insertword{insert
}
1015 \parseargdef\firstparagraphindent{%
1018 \let\suppressfirstparagraphindent =
\dosuppressfirstparagraphindent
1019 \else\ifx\temp\insertword
1020 \let\suppressfirstparagraphindent =
\relax
1022 \errhelp =
\EMsimple
1023 \errmessage{Unknown @firstparagraphindent option `
\temp'
}%
1027 % Here is how we actually suppress indentation. Redefine \everypar to
1028 % \kern backwards by \parindent, and then reset itself to empty.
1030 % We also make \indent itself not actually do anything until the next
1033 \gdef\dosuppressfirstparagraphindent{%
1034 \gdef\indent {\restorefirstparagraphindent \indent}%
1035 \gdef\noindent{\restorefirstparagraphindent \noindent}%
1036 \global\everypar =
{\kern -
\parindent \restorefirstparagraphindent}%
1039 \gdef\restorefirstparagraphindent{%
1040 \global\let\indent =
\ptexindent
1041 \global\let\noindent =
\ptexnoindent
1042 \global\everypar =
{}%
1046 % @refill is a no-op.
1049 % If working on a large document in chapters, it is convenient to
1050 % be able to disable indexing, cross-referencing, and contents, for test runs.
1051 % This is done with @novalidate (before @setfilename).
1053 \newif\iflinks \linkstrue % by default we want the aux files.
1054 \let\novalidate =
\linksfalse
1056 % @setfilename is done at the beginning of every texinfo file. So open
1057 % here some of the files we need to have open while reading the input.
1058 % This makes it possible to make a .fmt file for texinfo.
1062 % Open the new aux file. TeX will close it automatically at exit.
1063 \immediate\openout\auxfile=
\jobname.aux
1064 \fi % \openindices needs to do some work in any case.
1065 \let\setfilename=
\comment % Ignore extra @setfilename cmds.
1067 % If texinfo.cnf is present on the system, read it.
1068 % Useful for site-wide @afourpaper, etc.
1069 \openin 1 texinfo.cnf
1070 \ifeof 1 \else \input texinfo.cnf
\fi
1073 \comment % Ignore the actual filename.
1077 \outer\def\bye{\pagealignmacro\tracingstats=
1\ptexend}
1081 % adobe `portable' document format
1085 \newcount\filenamelength
1094 \newif\ifpdfmakepagedest
1096 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1097 % can be set). So we test for \relax and 0 as well as being undefined.
1098 \ifx\pdfoutput\thisisundefined
1100 \ifx\pdfoutput\relax
1109 % PDF uses PostScript string constants for the names of xref targets,
1110 % for display in the outlines, and in other places. Thus, we have to
1111 % double any backslashes. Otherwise, a name like "\node" will be
1112 % interpreted as a newline (\n), followed by o, d, e. Not good.
1114 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1115 % related messages. The final outcome is that it is up to the TeX user
1116 % to double the backslashes and otherwise make the string valid, so
1117 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1118 % do this reliably, so we use it.
1120 % #1 is a control sequence in which to do the replacements,
1122 \def\txiescapepdf#1{%
1123 \ifx\pdfescapestring\thisisundefined
1124 % No primitive available; should we give a warning or log?
1125 % Many times it won't matter.
1127 % The expandable \pdfescapestring primitive escapes parentheses,
1128 % backslashes, and other special chars.
1129 \xdef#1{\pdfescapestring{#1}}%
1133 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1134 with PDF output, and none of those formats could be found. (.eps cannot
1135 be supported due to the design of the PDF format; use regular TeX (DVI
1140 % Color manipulation macros using ideas from pdfcolor.tex,
1141 % except using rgb instead of cmyk; the latter is said to render as a
1142 % very dark gray on-screen and a very dark halftone in print, instead
1143 % of actual black. The dark red here is dark enough to print on paper as
1144 % nearly black, but still distinguishable for online viewing. We use
1145 % black by default, though.
1146 \def\rgbDarkRed{0.50 0.09 0.12}
1147 \def\rgbBlack{0 0 0}
1149 % k sets the color for filling (usual text, etc.);
1150 % K sets the color for stroking (thin rules, e.g., normal _'s).
1151 \def\pdfsetcolor#1{\pdfliteral{#1 rg
#1 RG
}}
1153 % Set color, and create a mark which defines \thiscolor accordingly,
1154 % so that \makeheadline knows which color to restore.
1156 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1161 \def\maincolor{\rgbBlack}
1162 \pdfsetcolor{\maincolor}
1163 \edef\thiscolor{\maincolor}
1164 \def\lastcolordefs{}
1168 \line{\pdfsetcolor{\maincolor}\the\footline}%
1176 % Extract \thiscolor definition from the marks.
1178 % Typeset the headline with \maincolor, then restore the color.
1179 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1187 \pdfcatalog{/PageMode /UseOutlines
}
1189 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1190 \def\dopdfimage#1#2#3{%
1191 \def\pdfimagewidth{#2}\setbox0 =
\hbox{\ignorespaces #2}%
1192 \def\pdfimageheight{#3}\setbox2 =
\hbox{\ignorespaces #3}%
1194 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1195 % others). Let's try in that order, PDF first since if
1196 % someone has a scalable image, presumably better to use that than a
1198 \let\pdfimgext=
\empty
1200 \openin 1 #1.pdf
\ifeof 1
1201 \openin 1 #1.PDF
\ifeof 1
1202 \openin 1 #1.png
\ifeof 1
1203 \openin 1 #1.jpg
\ifeof 1
1204 \openin 1 #1.jpeg
\ifeof 1
1205 \openin 1 #1.JPG
\ifeof 1
1206 \errhelp =
\nopdfimagehelp
1207 \errmessage{Could not find image file
#1 for pdf
}%
1208 \else \gdef\pdfimgext{JPG
}%
1210 \else \gdef\pdfimgext{jpeg
}%
1212 \else \gdef\pdfimgext{jpg
}%
1214 \else \gdef\pdfimgext{png
}%
1216 \else \gdef\pdfimgext{PDF
}%
1218 \else \gdef\pdfimgext{pdf
}%
1223 % without \immediate, ancient pdftex seg faults when the same image is
1224 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1225 \ifnum\pdftexversion <
14
1228 \immediate\pdfximage
1230 \ifdim \wd0 >
0pt width
\pdfimagewidth \fi
1231 \ifdim \wd2 >
0pt height
\pdfimageheight \fi
1232 \ifnum\pdftexversion<
13
1237 \ifnum\pdftexversion <
14 \else
1238 \pdfrefximage \pdflastximage
1242 % We have to set dummies so commands such as @code, and characters
1243 % such as \, aren't expanded when present in a section title.
1246 \makevalueexpandable
1247 \def\pdfdestname{#1}%
1248 \txiescapepdf\pdfdestname
1249 \safewhatsit{\pdfdest name
{\pdfdestname} xyz
}%
1252 % used to mark target names; must be expandable.
1255 % by default, use black for everything.
1256 \def\urlcolor{\rgbBlack}
1257 \def\linkcolor{\rgbBlack}
1258 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1260 % Adding outlines to PDF; macros for calculating structure of outlines
1261 % come from Petr Olsak
1262 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1263 \else \csname#1\endcsname \fi}
1264 \def\advancenumber#1{\tempnum=
\expnumber{#1}\relax
1265 \advance\tempnum by
1
1266 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1268 % #1 is the section text, which is what will be displayed in the
1269 % outline by the pdf viewer. #2 is the pdf expression for the number
1270 % of subentries (or empty, for subsubsections). #3 is the node text,
1271 % which might be empty if this toc entry had no corresponding node.
1272 % #4 is the page number
1274 \def\dopdfoutline#1#2#3#4{%
1275 % Generate a link to the node text if that exists; else, use the
1276 % page number. We could generate a destination for the section
1277 % text in the case where a section has no node, but it doesn't
1278 % seem worth the trouble, since most documents are normally structured.
1279 \edef\pdfoutlinedest{#3}%
1280 \ifx\pdfoutlinedest\empty
1281 \def\pdfoutlinedest{#4}%
1283 \txiescapepdf\pdfoutlinedest
1286 % Also escape PDF chars in the display string.
1287 \edef\pdfoutlinetext{#1}%
1288 \txiescapepdf\pdfoutlinetext
1290 \pdfoutline goto name
{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1293 \def\pdfmakeoutlines{%
1295 % Read toc silently, to get counts of subentries for \pdfoutline.
1296 \def\partentry#
#1#
#2#
#3#
#4{}% ignore parts in the outlines
1297 \def\numchapentry#
#1#
#2#
#3#
#4{%
1298 \def\thischapnum{#
#2}%
1300 \def\thissubsecnum{0}%
1302 \def\numsecentry#
#1#
#2#
#3#
#4{%
1303 \advancenumber{chap
\thischapnum}%
1304 \def\thissecnum{#
#2}%
1305 \def\thissubsecnum{0}%
1307 \def\numsubsecentry#
#1#
#2#
#3#
#4{%
1308 \advancenumber{sec
\thissecnum}%
1309 \def\thissubsecnum{#
#2}%
1311 \def\numsubsubsecentry#
#1#
#2#
#3#
#4{%
1312 \advancenumber{subsec
\thissubsecnum}%
1314 \def\thischapnum{0}%
1316 \def\thissubsecnum{0}%
1318 % use \def rather than \let here because we redefine \chapentry et
1319 % al. a second time, below.
1320 \def\appentry{\numchapentry}%
1321 \def\appsecentry{\numsecentry}%
1322 \def\appsubsecentry{\numsubsecentry}%
1323 \def\appsubsubsecentry{\numsubsubsecentry}%
1324 \def\unnchapentry{\numchapentry}%
1325 \def\unnsecentry{\numsecentry}%
1326 \def\unnsubsecentry{\numsubsecentry}%
1327 \def\unnsubsubsecentry{\numsubsubsecentry}%
1330 % Read toc second time, this time actually producing the outlines.
1331 % The `-' means take the \expnumber as the absolute number of
1332 % subentries, which we calculated on our first read of the .toc above.
1334 % We use the node names as the destinations.
1335 \def\numchapentry#
#1#
#2#
#3#
#4{%
1336 \dopdfoutline{#
#1}{count-
\expnumber{chap#
#2}}{#
#3}{#
#4}}%
1337 \def\numsecentry#
#1#
#2#
#3#
#4{%
1338 \dopdfoutline{#
#1}{count-
\expnumber{sec#
#2}}{#
#3}{#
#4}}%
1339 \def\numsubsecentry#
#1#
#2#
#3#
#4{%
1340 \dopdfoutline{#
#1}{count-
\expnumber{subsec#
#2}}{#
#3}{#
#4}}%
1341 \def\numsubsubsecentry#
#1#
#2#
#3#
#4{% count is always zero
1342 \dopdfoutline{#
#1}{}{#
#3}{#
#4}}%
1344 % PDF outlines are displayed using system fonts, instead of
1345 % document fonts. Therefore we cannot use special characters,
1346 % since the encoding is unknown. For example, the eogonek from
1347 % Latin 2 (0xea) gets translated to a | character. Info from
1348 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1350 % TODO this right, we have to translate 8-bit characters to
1351 % their "best" equivalent, based on the @documentencoding. Too
1352 % much work for too little return. Just use the ASCII equivalents
1353 % we use for the index sort strings.
1357 % We can have normal brace characters in the PDF outlines, unlike
1358 % Texinfo index files. So set that up.
1359 \def\
{{\lbracecharliteral}%
1360 \def\
}{\rbracecharliteral}%
1361 \catcode`\\=
\active \otherbackslash
1362 \input \tocreadfilename
1365 {\catcode`
[=
1 \catcode`
]=
2
1366 \catcode`
{=
\other \catcode`
}=
\other
1367 \gdef\lbracecharliteral[{]%
1368 \gdef\rbracecharliteral[}]%
1371 \def\skipspaces#1{\def\PP{#1}\def\D{|
}%
1372 \ifx\PP\D\let\nextsp\relax
1373 \else\let\nextsp\skipspaces
1374 \addtokens{\filename}{\PP}%
1375 \advance\filenamelength by
1
1378 \def\getfilename#1{%
1380 % If we don't expand the argument now, \skipspaces will get
1381 % snagged on things like "@value{foo}".
1383 \expandafter\skipspaces\temp|
\relax
1385 \ifnum\pdftexversion <
14
1386 \let \startlink \pdfannotlink
1388 \let \startlink \pdfstartlink
1390 % make a live url in pdf output.
1393 % it seems we really need yet another set of dummies; have not
1394 % tried to figure out what each command should do in the context
1395 % of @url. for now, just make @/ a no-op, that's the only one
1396 % people have actually reported a problem with.
1398 \normalturnoffactive
1401 \makevalueexpandable
1402 % do we want to go so far as to use \indexnofonts instead of just
1403 % special-casing \var here?
1406 \leavevmode\setcolor{\urlcolor}%
1407 \startlink attr
{/Border
[0 0 0]}%
1408 user
{/Subtype /Link /A << /S /URI /URI (
#1) >>
}%
1410 \def\pdfgettoks#1.
{\setbox\boxA=
\hbox{\toksA=
{#1.
}\toksB=
{}\maketoks}}
1411 \def\addtokens#1#2{\edef\addtoks{\noexpand#1=
{\the#1#2}}\addtoks}
1412 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=
1\let\next=
\maketoks}
1413 \def\poptoks#1#2|ENDTOKS|
{\let\first=
#1\toksD=
{#1}\toksA=
{#2}}
1415 \expandafter\poptoks\the\toksA|ENDTOKS|
\relax
1417 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1418 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1419 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1421 \ifnum0=
\countA\else\makelink\fi
1422 \ifx\first.
\let\next=
\done\else
1424 \addtokens{\toksB}{\the\toksD}
1425 \ifx\first,
\addtokens{\toksB}{\space}\fi
1427 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1429 \def\makelink{\addtokens{\toksB}%
1430 {\noexpand\pdflink{\the\toksC}}\toksC=
{}\global\countA=
0}
1432 \startlink attr
{/Border
[0 0 0]} goto name
{\pdfmkpgn{#1}}
1433 \setcolor{\linkcolor}#1\endlink}
1434 \def\done{\edef\st{\global\noexpand\toksA=
{\the\toksB}}\st}
1437 \let\pdfmkdest =
\gobble
1438 \let\pdfurl =
\gobble
1439 \let\endlink =
\relax
1440 \let\setcolor =
\gobble
1441 \let\pdfsetcolor =
\gobble
1442 \let\pdfmakeoutlines =
\relax
1443 \fi % \ifx\pdfoutput
1448 % Change the current font style to #1, remembering it in \curfontstyle.
1449 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1450 % italics, not bold italics.
1452 \def\setfontstyle#1{%
1453 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1454 \csname ten
#1\endcsname % change the current font
1457 % Select #1 fonts with the current style.
1459 \def\selectfonts#1{\csname #1fonts
\endcsname \csname\curfontstyle\endcsname}
1461 \def\rm{\fam=
0 \setfontstyle{rm
}}
1462 \def\it{\fam=
\itfam \setfontstyle{it
}}
1463 \def\sl{\fam=
\slfam \setfontstyle{sl
}}
1464 \def\bf{\fam=
\bffam \setfontstyle{bf
}}\def\bfstylename{bf
}
1465 \def\tt{\fam=
\ttfam \setfontstyle{tt
}}
1467 % Unfortunately, we have to override this for titles and the like, since
1468 % in those cases "rm" is bold. Sigh.
1469 \def\rmisbold{\rm\def\curfontstyle{bf
}}
1471 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1472 % So we set up a \sf.
1474 \def\sf{\fam=
\sffam \setfontstyle{sf
}}
1475 \let\li =
\sf % Sometimes we call it \li, not \sf.
1477 % We don't need math for this font style.
1478 \def\ttsl{\setfontstyle{ttsl
}}
1481 % Set the baselineskip to #1, and the lineskip and strut size
1482 % correspondingly. There is no deep meaning behind these magic numbers
1483 % used as factors; they just match (closely enough) what Knuth defined.
1485 \def\lineskipfactor{.08333}
1486 \def\strutheightpercent{.70833}
1487 \def\strutdepthpercent {.29167}
1489 % can get a sort of poor man's double spacing by redefining this.
1490 \def\baselinefactor{1}
1492 \newdimen\textleading
1495 \normalbaselineskip =
\baselinefactor\dimen0
1496 \normallineskip =
\lineskipfactor\normalbaselineskip
1498 \setbox\strutbox =
\hbox{%
1499 \vrule width0pt height
\strutheightpercent\baselineskip
1500 depth
\strutdepthpercent \baselineskip
1504 % PDF CMaps. See also LaTeX's t1.cmap.
1506 % do nothing with this by default.
1507 \expandafter\let\csname cmapOT1
\endcsname\gobble
1508 \expandafter\let\csname cmapOT1IT
\endcsname\gobble
1509 \expandafter\let\csname cmapOT1TT
\endcsname\gobble
1511 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1512 % (\pdffontattr was introduced many years ago, but people still run
1513 % older pdftex's; it's easy to conditionalize, so we do.)
1514 \ifpdf \ifx\pdffontattr\thisisundefined \else
1516 \catcode`\^^M=
\active \def^^M
{^^J
}% Output line endings as the ^^J char.
1517 \catcode`\%=
12 \immediate\pdfobj stream
{%!PS-Adobe-3.0 Resource-CMap
1518 %%DocumentNeededResources: ProcSet (CIDInit)
1519 %%IncludeResource: ProcSet (CIDInit)
1520 %%BeginResource: CMap (TeX-OT1-0)
1521 %%Title: (TeX-OT1-0 TeX OT1 0)
1524 /CIDInit /ProcSet findresource begin
1532 /CMapName /TeX-OT1-
0 def
1534 1 begincodespacerange
1590 CMapName currentdict /CMap defineresource pop
1596 \expandafter\edef\csname cmapOT1
\endcsname#1{%
1597 \pdffontattr#1{/ToUnicode
\the\pdflastobj\space 0 R
}%
1602 \catcode`\^^M=
\active \def^^M
{^^J
}% Output line endings as the ^^J char.
1603 \catcode`\%=
12 \immediate\pdfobj stream
{%!PS-Adobe-3.0 Resource-CMap
1604 %%DocumentNeededResources: ProcSet (CIDInit)
1605 %%IncludeResource: ProcSet (CIDInit)
1606 %%BeginResource: CMap (TeX-OT1IT-0)
1607 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1610 /CIDInit /ProcSet findresource begin
1618 /CMapName /TeX-OT1IT-
0 def
1620 1 begincodespacerange
1678 CMapName currentdict /CMap defineresource pop
1684 \expandafter\edef\csname cmapOT1IT
\endcsname#1{%
1685 \pdffontattr#1{/ToUnicode
\the\pdflastobj\space 0 R
}%
1690 \catcode`\^^M=
\active \def^^M
{^^J
}% Output line endings as the ^^J char.
1691 \catcode`\%=
12 \immediate\pdfobj stream
{%!PS-Adobe-3.0 Resource-CMap
1692 %%DocumentNeededResources: ProcSet (CIDInit)
1693 %%IncludeResource: ProcSet (CIDInit)
1694 %%BeginResource: CMap (TeX-OT1TT-0)
1695 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1698 /CIDInit /ProcSet findresource begin
1706 /CMapName /TeX-OT1TT-
0 def
1708 1 begincodespacerange
1753 CMapName currentdict /CMap defineresource pop
1759 \expandafter\edef\csname cmapOT1TT
\endcsname#1{%
1760 \pdffontattr#1{/ToUnicode
\the\pdflastobj\space 0 R
}%
1765 % Set the font macro #1 to the font named \fontprefix#2.
1766 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1767 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
1775 \def\setfont#1#2#3#4#5{%
1776 \font#1=
\fontprefix#2#3 scaled
#4
1777 \csname cmap
#5\endcsname#1%
1779 % This is what gets called when #5 of \setfont is empty.
1784 % Use cm as the default font prefix.
1785 % To specify the font prefix, you must define \fontprefix
1786 % before you read in texinfo.tex.
1787 \ifx\fontprefix\thisisundefined
1790 % Support font families that don't use the same naming scheme as CM.
1792 \def\rmbshape{bx
} % where the normal face is bold
1797 \def\ttslshape{sltt
}
1807 % Definitions for a main text size of 11pt. (The default in Texinfo.)
1809 \def\definetextfontsizexi{%
1810 % Text fonts (11.2pt, magstep1).
1811 \def\textnominalsize{11pt
}
1812 \edef\mainmagstep{\magstephalf}
1813 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1
}
1814 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT
}
1815 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1
}
1816 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT
}
1817 \setfont\textsl\slshape{10}{\mainmagstep}{OT1
}
1818 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1
}
1819 \setfont\textsc\scshape{10}{\mainmagstep}{OT1
}
1820 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT
}
1821 \font\texti=cmmi10 scaled
\mainmagstep
1822 \font\textsy=cmsy10 scaled
\mainmagstep
1823 \def\textecsize{1095}
1825 % A few fonts for @defun names and args.
1826 \setfont\defbf\bfshape{10}{\magstep1}{OT1
}
1827 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT
}
1828 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT
}
1829 \def\df{\let\tentt=
\deftt \let\tenbf =
\defbf \let\tenttsl=
\defttsl \bf}
1831 % Fonts for indices, footnotes, small examples (9pt).
1832 \def\smallnominalsize{9pt
}
1833 \setfont\smallrm\rmshape{9}{1000}{OT1
}
1834 \setfont\smalltt\ttshape{9}{1000}{OT1TT
}
1835 \setfont\smallbf\bfshape{10}{900}{OT1
}
1836 \setfont\smallit\itshape{9}{1000}{OT1IT
}
1837 \setfont\smallsl\slshape{9}{1000}{OT1
}
1838 \setfont\smallsf\sfshape{9}{1000}{OT1
}
1839 \setfont\smallsc\scshape{10}{900}{OT1
}
1840 \setfont\smallttsl\ttslshape{10}{900}{OT1TT
}
1843 \def\smallecsize{0900}
1845 % Fonts for small examples (8pt).
1846 \def\smallernominalsize{8pt
}
1847 \setfont\smallerrm\rmshape{8}{1000}{OT1
}
1848 \setfont\smallertt\ttshape{8}{1000}{OT1TT
}
1849 \setfont\smallerbf\bfshape{10}{800}{OT1
}
1850 \setfont\smallerit\itshape{8}{1000}{OT1IT
}
1851 \setfont\smallersl\slshape{8}{1000}{OT1
}
1852 \setfont\smallersf\sfshape{8}{1000}{OT1
}
1853 \setfont\smallersc\scshape{10}{800}{OT1
}
1854 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT
}
1855 \font\smalleri=cmmi8
1856 \font\smallersy=cmsy8
1857 \def\smallerecsize{0800}
1859 % Fonts for title page (20.4pt):
1860 \def\titlenominalsize{20pt
}
1861 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1
}
1862 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT
}
1863 \setfont\titlesl\slbshape{10}{\magstep4}{OT1
}
1864 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT
}
1865 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT
}
1866 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1
}
1867 \let\titlebf=
\titlerm
1868 \setfont\titlesc\scbshape{10}{\magstep4}{OT1
}
1869 \font\titlei=cmmi12 scaled
\magstep3
1870 \font\titlesy=cmsy10 scaled
\magstep4
1871 \def\titleecsize{2074}
1873 % Chapter (and unnumbered) fonts (17.28pt).
1874 \def\chapnominalsize{17pt
}
1875 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1
}
1876 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT
}
1877 \setfont\chapsl\slbshape{10}{\magstep3}{OT1
}
1878 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT
}
1879 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT
}
1880 \setfont\chapsf\sfbshape{17}{1000}{OT1
}
1882 \setfont\chapsc\scbshape{10}{\magstep3}{OT1
}
1883 \font\chapi=cmmi12 scaled
\magstep2
1884 \font\chapsy=cmsy10 scaled
\magstep3
1885 \def\chapecsize{1728}
1887 % Section fonts (14.4pt).
1888 \def\secnominalsize{14pt
}
1889 \setfont\secrm\rmbshape{12}{\magstep1}{OT1
}
1890 \setfont\secrmnotbold\rmshape{12}{\magstep1}{OT1
}
1891 \setfont\secit\itbshape{10}{\magstep2}{OT1IT
}
1892 \setfont\secsl\slbshape{10}{\magstep2}{OT1
}
1893 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT
}
1894 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT
}
1895 \setfont\secsf\sfbshape{12}{\magstep1}{OT1
}
1897 \setfont\secsc\scbshape{10}{\magstep2}{OT1
}
1898 \font\seci=cmmi12 scaled
\magstep1
1899 \font\secsy=cmsy10 scaled
\magstep2
1900 \def\sececsize{1440}
1902 % Subsection fonts (13.15pt).
1903 \def\ssecnominalsize{13pt
}
1904 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1
}
1905 \setfont\ssecit\itbshape{10}{1315}{OT1IT
}
1906 \setfont\ssecsl\slbshape{10}{1315}{OT1
}
1907 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT
}
1908 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT
}
1909 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1
}
1911 \setfont\ssecsc\scbshape{10}{1315}{OT1
}
1912 \font\sseci=cmmi12 scaled
\magstephalf
1913 \font\ssecsy=cmsy10 scaled
1315
1914 \def\ssececsize{1200}
1916 % Reduced fonts for @acro in text (10pt).
1917 \def\reducednominalsize{10pt
}
1918 \setfont\reducedrm\rmshape{10}{1000}{OT1
}
1919 \setfont\reducedtt\ttshape{10}{1000}{OT1TT
}
1920 \setfont\reducedbf\bfshape{10}{1000}{OT1
}
1921 \setfont\reducedit\itshape{10}{1000}{OT1IT
}
1922 \setfont\reducedsl\slshape{10}{1000}{OT1
}
1923 \setfont\reducedsf\sfshape{10}{1000}{OT1
}
1924 \setfont\reducedsc\scshape{10}{1000}{OT1
}
1925 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT
}
1926 \font\reducedi=cmmi10
1927 \font\reducedsy=cmsy10
1928 \def\reducedecsize{1000}
1930 \textleading =
13.2pt
% line spacing for 11pt CM
1931 \textfonts % reset the current fonts
1933 } % end of 11pt text font size definitions, \definetextfontsizexi
1936 % Definitions to make the main text be 10pt Computer Modern, with
1937 % section, chapter, etc., sizes following suit. This is for the GNU
1938 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1939 % future. Used with @smallbook, which sets the leading to 12pt.
1941 \def\definetextfontsizex{%
1942 % Text fonts (10pt).
1943 \def\textnominalsize{10pt
}
1944 \edef\mainmagstep{1000}
1945 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1
}
1946 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT
}
1947 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1
}
1948 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT
}
1949 \setfont\textsl\slshape{10}{\mainmagstep}{OT1
}
1950 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1
}
1951 \setfont\textsc\scshape{10}{\mainmagstep}{OT1
}
1952 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT
}
1953 \font\texti=cmmi10 scaled
\mainmagstep
1954 \font\textsy=cmsy10 scaled
\mainmagstep
1955 \def\textecsize{1000}
1957 % A few fonts for @defun names and args.
1958 \setfont\defbf\bfshape{10}{\magstephalf}{OT1
}
1959 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT
}
1960 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT
}
1961 \def\df{\let\tentt=
\deftt \let\tenbf =
\defbf \let\tenttsl=
\defttsl \bf}
1963 % Fonts for indices, footnotes, small examples (9pt).
1964 \def\smallnominalsize{9pt
}
1965 \setfont\smallrm\rmshape{9}{1000}{OT1
}
1966 \setfont\smalltt\ttshape{9}{1000}{OT1TT
}
1967 \setfont\smallbf\bfshape{10}{900}{OT1
}
1968 \setfont\smallit\itshape{9}{1000}{OT1IT
}
1969 \setfont\smallsl\slshape{9}{1000}{OT1
}
1970 \setfont\smallsf\sfshape{9}{1000}{OT1
}
1971 \setfont\smallsc\scshape{10}{900}{OT1
}
1972 \setfont\smallttsl\ttslshape{10}{900}{OT1TT
}
1975 \def\smallecsize{0900}
1977 % Fonts for small examples (8pt).
1978 \def\smallernominalsize{8pt
}
1979 \setfont\smallerrm\rmshape{8}{1000}{OT1
}
1980 \setfont\smallertt\ttshape{8}{1000}{OT1TT
}
1981 \setfont\smallerbf\bfshape{10}{800}{OT1
}
1982 \setfont\smallerit\itshape{8}{1000}{OT1IT
}
1983 \setfont\smallersl\slshape{8}{1000}{OT1
}
1984 \setfont\smallersf\sfshape{8}{1000}{OT1
}
1985 \setfont\smallersc\scshape{10}{800}{OT1
}
1986 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT
}
1987 \font\smalleri=cmmi8
1988 \font\smallersy=cmsy8
1989 \def\smallerecsize{0800}
1991 % Fonts for title page (20.4pt):
1992 \def\titlenominalsize{20pt
}
1993 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1
}
1994 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT
}
1995 \setfont\titlesl\slbshape{10}{\magstep4}{OT1
}
1996 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT
}
1997 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT
}
1998 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1
}
1999 \let\titlebf=
\titlerm
2000 \setfont\titlesc\scbshape{10}{\magstep4}{OT1
}
2001 \font\titlei=cmmi12 scaled
\magstep3
2002 \font\titlesy=cmsy10 scaled
\magstep4
2003 \def\titleecsize{2074}
2005 % Chapter fonts (14.4pt).
2006 \def\chapnominalsize{14pt
}
2007 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1
}
2008 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT
}
2009 \setfont\chapsl\slbshape{10}{\magstep2}{OT1
}
2010 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT
}
2011 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT
}
2012 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1
}
2014 \setfont\chapsc\scbshape{10}{\magstep2}{OT1
}
2015 \font\chapi=cmmi12 scaled
\magstep1
2016 \font\chapsy=cmsy10 scaled
\magstep2
2017 \def\chapecsize{1440}
2019 % Section fonts (12pt).
2020 \def\secnominalsize{12pt
}
2021 \setfont\secrm\rmbshape{12}{1000}{OT1
}
2022 \setfont\secit\itbshape{10}{\magstep1}{OT1IT
}
2023 \setfont\secsl\slbshape{10}{\magstep1}{OT1
}
2024 \setfont\sectt\ttbshape{12}{1000}{OT1TT
}
2025 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT
}
2026 \setfont\secsf\sfbshape{12}{1000}{OT1
}
2028 \setfont\secsc\scbshape{10}{\magstep1}{OT1
}
2030 \font\secsy=cmsy10 scaled
\magstep1
2031 \def\sececsize{1200}
2033 % Subsection fonts (10pt).
2034 \def\ssecnominalsize{10pt
}
2035 \setfont\ssecrm\rmbshape{10}{1000}{OT1
}
2036 \setfont\ssecit\itbshape{10}{1000}{OT1IT
}
2037 \setfont\ssecsl\slbshape{10}{1000}{OT1
}
2038 \setfont\ssectt\ttbshape{10}{1000}{OT1TT
}
2039 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT
}
2040 \setfont\ssecsf\sfbshape{10}{1000}{OT1
}
2042 \setfont\ssecsc\scbshape{10}{1000}{OT1
}
2045 \def\ssececsize{1000}
2047 % Reduced fonts for @acro in text (9pt).
2048 \def\reducednominalsize{9pt
}
2049 \setfont\reducedrm\rmshape{9}{1000}{OT1
}
2050 \setfont\reducedtt\ttshape{9}{1000}{OT1TT
}
2051 \setfont\reducedbf\bfshape{10}{900}{OT1
}
2052 \setfont\reducedit\itshape{9}{1000}{OT1IT
}
2053 \setfont\reducedsl\slshape{9}{1000}{OT1
}
2054 \setfont\reducedsf\sfshape{9}{1000}{OT1
}
2055 \setfont\reducedsc\scshape{10}{900}{OT1
}
2056 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT
}
2057 \font\reducedi=cmmi9
2058 \font\reducedsy=cmsy9
2059 \def\reducedecsize{0900}
2061 \divide\parskip by
2 % reduce space between paragraphs
2062 \textleading =
12pt
% line spacing for 10pt CM
2063 \textfonts % reset the current fonts
2065 } % end of 10pt text font size definitions, \definetextfontsizex
2068 % We provide the user-level command
2070 % (or 11) to redefine the text font size. pt is assumed.
2076 \parseargdef\fonttextsize{%
2077 \def\textsizearg{#1}%
2078 %\wlog{doing @fonttextsize \textsizearg}%
2080 % Set \globaldefs so that documents can use this inside @tex, since
2081 % makeinfo 4.8 does not support it, but we need it nonetheless.
2083 \begingroup \globaldefs=
1
2084 \ifx\textsizearg\xword \definetextfontsizex
2085 \else \ifx\textsizearg\xiword \definetextfontsizexi
2088 \errmessage{@fonttextsize only supports `
10' or `
11', not `
\textsizearg'
}
2093 % In order for the font changes to affect most math symbols and letters,
2094 % we have to define the \textfont of the standard families. We don't
2095 % bother to reset \scriptfont and \scriptscriptfont; awaiting user need.
2097 \def\resetmathfonts{%
2098 \textfont0=
\tenrm \textfont1=
\teni \textfont2=
\tensy
2099 \textfont\itfam=
\tenit \textfont\slfam=
\tensl \textfont\bffam=
\tenbf
2100 \textfont\ttfam=
\tentt \textfont\sffam=
\tensf
2103 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2104 % of just \STYLE. We do this because \STYLE needs to also set the
2105 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2106 % \tenSTYLE to set the current font.
2108 % Each font-changing command also sets the names \lsize (one size lower)
2109 % and \lllsize (three sizes lower). These relative commands are used
2110 % in, e.g., the LaTeX logo and acronyms.
2112 % This all needs generalizing, badly.
2115 \let\tenrm=
\textrm \let\tenit=
\textit \let\tensl=
\textsl
2116 \let\tenbf=
\textbf \let\tentt=
\texttt \let\smallcaps=
\textsc
2117 \let\tensf=
\textsf \let\teni=
\texti \let\tensy=
\textsy
2118 \let\tenttsl=
\textttsl
2119 \def\curfontsize{text
}%
2120 \def\lsize{reduced
}\def\lllsize{smaller
}%
2121 \resetmathfonts \setleading{\textleading}}
2123 \let\tenrm=
\titlerm \let\tenit=
\titleit \let\tensl=
\titlesl
2124 \let\tenbf=
\titlebf \let\tentt=
\titlett \let\smallcaps=
\titlesc
2125 \let\tensf=
\titlesf \let\teni=
\titlei \let\tensy=
\titlesy
2126 \let\tenttsl=
\titlettsl
2127 \def\curfontsize{title
}%
2128 \def\lsize{chap
}\def\lllsize{subsec
}%
2129 \resetmathfonts \setleading{27pt
}}
2130 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2132 \let\tenrm=
\chaprm \let\tenit=
\chapit \let\tensl=
\chapsl
2133 \let\tenbf=
\chapbf \let\tentt=
\chaptt \let\smallcaps=
\chapsc
2134 \let\tensf=
\chapsf \let\teni=
\chapi \let\tensy=
\chapsy
2135 \let\tenttsl=
\chapttsl
2136 \def\curfontsize{chap
}%
2137 \def\lsize{sec
}\def\lllsize{text
}%
2138 \resetmathfonts \setleading{19pt
}}
2140 \let\tenrm=
\secrm \let\tenit=
\secit \let\tensl=
\secsl
2141 \let\tenbf=
\secbf \let\tentt=
\sectt \let\smallcaps=
\secsc
2142 \let\tensf=
\secsf \let\teni=
\seci \let\tensy=
\secsy
2143 \let\tenttsl=
\secttsl
2144 \def\curfontsize{sec
}%
2145 \def\lsize{subsec
}\def\lllsize{reduced
}%
2146 \resetmathfonts \setleading{17pt
}}
2148 \let\tenrm=
\ssecrm \let\tenit=
\ssecit \let\tensl=
\ssecsl
2149 \let\tenbf=
\ssecbf \let\tentt=
\ssectt \let\smallcaps=
\ssecsc
2150 \let\tensf=
\ssecsf \let\teni=
\sseci \let\tensy=
\ssecsy
2151 \let\tenttsl=
\ssecttsl
2152 \def\curfontsize{ssec
}%
2153 \def\lsize{text
}\def\lllsize{small
}%
2154 \resetmathfonts \setleading{15pt
}}
2155 \let\subsubsecfonts =
\subsecfonts
2157 \let\tenrm=
\reducedrm \let\tenit=
\reducedit \let\tensl=
\reducedsl
2158 \let\tenbf=
\reducedbf \let\tentt=
\reducedtt \let\reducedcaps=
\reducedsc
2159 \let\tensf=
\reducedsf \let\teni=
\reducedi \let\tensy=
\reducedsy
2160 \let\tenttsl=
\reducedttsl
2161 \def\curfontsize{reduced
}%
2162 \def\lsize{small
}\def\lllsize{smaller
}%
2163 \resetmathfonts \setleading{10.5pt
}}
2165 \let\tenrm=
\smallrm \let\tenit=
\smallit \let\tensl=
\smallsl
2166 \let\tenbf=
\smallbf \let\tentt=
\smalltt \let\smallcaps=
\smallsc
2167 \let\tensf=
\smallsf \let\teni=
\smalli \let\tensy=
\smallsy
2168 \let\tenttsl=
\smallttsl
2169 \def\curfontsize{small
}%
2170 \def\lsize{smaller
}\def\lllsize{smaller
}%
2171 \resetmathfonts \setleading{10.5pt
}}
2173 \let\tenrm=
\smallerrm \let\tenit=
\smallerit \let\tensl=
\smallersl
2174 \let\tenbf=
\smallerbf \let\tentt=
\smallertt \let\smallcaps=
\smallersc
2175 \let\tensf=
\smallersf \let\teni=
\smalleri \let\tensy=
\smallersy
2176 \let\tenttsl=
\smallerttsl
2177 \def\curfontsize{smaller
}%
2178 \def\lsize{smaller
}\def\lllsize{smaller
}%
2179 \resetmathfonts \setleading{9.5pt
}}
2181 % Fonts for short table of contents.
2182 \setfont\shortcontrm\rmshape{12}{1000}{OT1
}
2183 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1
} % no cmb12
2184 \setfont\shortcontsl\slshape{12}{1000}{OT1
}
2185 \setfont\shortconttt\ttshape{12}{1000}{OT1TT
}
2187 % Define these just so they can be easily changed for other fonts.
2188 \def\angleleft{$
\langle$
}
2189 \def\angleright{$
\rangle$
}
2191 % Set the fonts to use with the @small... environments.
2192 \let\smallexamplefonts =
\smallfonts
2194 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2195 % can fit this many characters:
2196 % 8.5x11=86 smallbook=72 a4=90 a5=69
2197 % If we use \scriptfonts (8pt), then we can fit this many characters:
2198 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2199 % For me, subjectively, the few extra characters that fit aren't worth
2200 % the additional smallness of 8pt. So I'm making the default 9pt.
2202 % By the way, for comparison, here's what fits with @example (10pt):
2203 % 8.5x11=71 smallbook=60 a4=75 a5=58
2206 % Set up the default fonts, so we can use them for creating boxes.
2208 \definetextfontsizexi
2213 % Check if we are currently using a typewriter font. Since all the
2214 % Computer Modern typewriter fonts have zero interword stretch (and
2215 % shrink), and it is reasonable to expect all typewriter fonts to have
2216 % this property, we can check that font parameter.
2218 \def\ifmonospace{\ifdim\fontdimen3\font=
0pt
}
2220 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2221 % define and register \INITMACRO to be called on markup style changes.
2222 % \INITMACRO can check \currentmarkupstyle for the innermost
2223 % style and the set of \ifmarkupSTYLE switches for all styles
2224 % currently in effect.
2228 %\newif\ifmarkupfile % @file == @samp.
2229 %\newif\ifmarkupoption % @option == @samp.
2232 %\newif\ifmarkupenv % @env == @code.
2233 %\newif\ifmarkupcommand % @command == @code.
2234 \newif\ifmarkuptex % @tex (and part of @math, for now).
2235 \newif\ifmarkupexample
2237 \newif\ifmarkupverbatim
2239 \let\currentmarkupstyle\empty
2241 \def\setupmarkupstyle#1{%
2242 \csname markup
#1true
\endcsname
2243 \def\currentmarkupstyle{#1}%
2247 \let\markupstylesetup\empty
2249 \def\defmarkupstylesetup#1{%
2250 \expandafter\def\expandafter\markupstylesetup
2251 \expandafter{\markupstylesetup #1}%
2255 % Markup style setup for left and right quotes.
2256 \defmarkupstylesetup\markupsetuplq{%
2257 \expandafter\let\expandafter \temp
2258 \csname markupsetuplq
\currentmarkupstyle\endcsname
2259 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2262 \defmarkupstylesetup\markupsetuprq{%
2263 \expandafter\let\expandafter \temp
2264 \csname markupsetuprq
\currentmarkupstyle\endcsname
2265 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2272 \gdef\markupsetuplqdefault{\let`
\lq}
2273 \gdef\markupsetuprqdefault{\let'
\rq}
2275 \gdef\markupsetcodequoteleft{\let`
\codequoteleft}
2276 \gdef\markupsetcodequoteright{\let'
\codequoteright}
2279 \let\markupsetuplqcode \markupsetcodequoteleft
2280 \let\markupsetuprqcode \markupsetcodequoteright
2282 \let\markupsetuplqexample \markupsetcodequoteleft
2283 \let\markupsetuprqexample \markupsetcodequoteright
2285 \let\markupsetuplqkbd \markupsetcodequoteleft
2286 \let\markupsetuprqkbd \markupsetcodequoteright
2288 \let\markupsetuplqsamp \markupsetcodequoteleft
2289 \let\markupsetuprqsamp \markupsetcodequoteright
2291 \let\markupsetuplqverb \markupsetcodequoteleft
2292 \let\markupsetuprqverb \markupsetcodequoteright
2294 \let\markupsetuplqverbatim \markupsetcodequoteleft
2295 \let\markupsetuprqverbatim \markupsetcodequoteright
2297 % Allow an option to not use regular directed right quote/apostrophe
2298 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2299 % The undirected quote is ugly, so don't make it the default, but it
2300 % works for pasting with more pdf viewers (at least evince), the
2301 % lilypond developers report. xpdf does work with the regular 0x27.
2303 \def\codequoteright{%
2304 \expandafter\ifx\csname SETtxicodequoteundirected
\endcsname\relax
2305 \expandafter\ifx\csname SETcodequoteundirected
\endcsname\relax
2311 % and a similar option for the left quote char vs. a grave accent.
2312 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2313 % the code environments to do likewise.
2315 \def\codequoteleft{%
2316 \expandafter\ifx\csname SETtxicodequotebacktick
\endcsname\relax
2317 \expandafter\ifx\csname SETcodequotebacktick
\endcsname\relax
2318 % [Knuth] pp. 380,381,391
2319 % \relax disables Spanish ligatures ?` and !` of \tt font.
2325 % Commands to set the quote options.
2327 \parseargdef\codequoteundirected{%
2330 \expandafter\let\csname SETtxicodequoteundirected
\endcsname
2332 \else\ifx\temp\offword
2333 \expandafter\let\csname SETtxicodequoteundirected
\endcsname
2336 \errhelp =
\EMsimple
2337 \errmessage{Unknown @codequoteundirected value `
\temp', must be on|off
}%
2341 \parseargdef\codequotebacktick{%
2344 \expandafter\let\csname SETtxicodequotebacktick
\endcsname
2346 \else\ifx\temp\offword
2347 \expandafter\let\csname SETtxicodequotebacktick
\endcsname
2350 \errhelp =
\EMsimple
2351 \errmessage{Unknown @codequotebacktick value `
\temp', must be on|off
}%
2355 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2356 \def\noligaturesquoteleft{\relax\lq}
2358 % Count depth in font-changes, for error checks
2359 \newcount\fontdepth \fontdepth=
0
2363 % #1 is the font command (\sl or \it), #2 is the text to slant.
2364 % If we are in a monospaced environment, however, 1) always use \ttsl,
2365 % and 2) do not add an italic correction.
2366 \def\dosmartslant#1#2{%
2368 {{\ttsl #2}\let\next=
\relax}%
2369 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2372 \def\smartslanted{\dosmartslant\sl}
2373 \def\smartitalic{\dosmartslant\it}
2375 % Output an italic correction unless \next (presumed to be the following
2376 % character) is such as not to need one.
2377 \def\smartitaliccorrection{%
2382 \else\ifx\next\comma%
2388 % Unconditional use \ttsl, and no ic. @var is set to this for defuns.
2389 \def\ttslanted#1{{\ttsl #1}}
2391 % @cite is like \smartslanted except unconditionally use \sl. We never want
2392 % ttsl for book titles, do we?
2393 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2397 \let\saveaftersmartic =
\aftersmartic
2398 \def\aftersmartic{\null\let\aftersmartic=
\saveaftersmartic}%
2403 \let\slanted=
\smartslanted
2404 \let\dfn=
\smartslanted
2405 \let\emph=
\smartitalic
2407 % Explicit font changes: @r, @sc, undocumented @ii.
2408 \def\r#1{{\rm #1}} % roman font
2409 \def\sc#1{{\smallcaps#1}} % smallcaps font
2410 \def\ii#1{{\it #1}} % italic font
2412 % @b, explicit bold. Also @strong.
2416 % @sansserif, explicit sans.
2417 \def\sansserif#1{{\sf #1}}
2419 % We can't just use \exhyphenpenalty, because that only has effect at
2420 % the end of a paragraph. Restore normal hyphenation at the end of the
2421 % group within which \nohyphenation is presumably called.
2423 \def\nohyphenation{\hyphenchar\font = -
1 \aftergroup\restorehyphenation}
2424 \def\restorehyphenation{\hyphenchar\font = `-
}
2426 % Set sfcode to normal for the chars that usually have another value.
2427 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2428 % sometimes \x has an active definition that messes things up.
2431 \def\plainfrenchspacing{%
2432 \sfcode\dotChar =\@m
\sfcode\questChar=\@m
\sfcode\exclamChar=\@m
2433 \sfcode\colonChar=\@m
\sfcode\semiChar =\@m
\sfcode\commaChar =\@m
2434 \def\endofsentencespacefactor{1000}% for @. and friends
2436 \def\plainnonfrenchspacing{%
2437 \sfcode`\
.3000\sfcode`\?
3000\sfcode`\!
3000
2438 \sfcode`\:
2000\sfcode`\;
1500\sfcode`\,
1250
2439 \def\endofsentencespacefactor{3000}% for @. and friends
2442 \def\endofsentencespacefactor{3000}% default
2444 % @t, explicit typewriter.
2446 {\tt \rawbackslash \plainfrenchspacing #1}%
2451 \def\samp#1{{\setupmarkupstyle{samp
}\lq\tclose{#1}\rq\null}}
2453 % @indicateurl is \samp, that is, with quotes.
2454 \let\indicateurl=
\samp
2456 % @code (and similar) prints in typewriter, but with spaces the same
2457 % size as normal in the surrounding text, without hyphenation, etc.
2458 % This is a subroutine for that.
2461 % Change normal interword space to be same as for the current font.
2462 \spaceskip =
\fontdimen2\font
2464 % Switch to typewriter.
2467 % But `\ ' produces the large typewriter interword space.
2468 \def\
{{\spaceskip =
0pt
{} }}%
2470 % Turn off hyphenation.
2477 \null % reset spacefactor to 1000
2480 % We *must* turn on hyphenation at `-' and `_' in @code.
2481 % (But see \codedashfinish below.)
2482 % Otherwise, it is too hard to avoid overfull hboxes
2483 % in the Emacs manual, the Library manual, etc.
2485 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2486 % both hyphenation at - and hyphenation within words.
2487 % We must therefore turn them both off (\tclose does that)
2488 % and arrange explicitly to hyphenate at a dash. -- rms.
2490 \catcode`\-=
\active \catcode`
\_=
\active
2491 \catcode`\'=
\active \catcode`\`=
\active
2492 \global\let'=
\rq \global\let`=
\lq % default definitions
2494 \global\def\code{\begingroup
2495 \setupmarkupstyle{code
}%
2496 % The following should really be moved into \setupmarkupstyle handlers.
2497 \catcode\dashChar=
\active \catcode\underChar=
\active
2505 % Given -foo (with a single dash), we do not want to allow a break
2507 \global\let\codedashprev=
\codedash
2512 \gdef\codedash{\futurelet\next\codedashfinish}
2513 \gdef\codedashfinish{%
2514 \normaldash % always output the dash character itself.
2516 % Now, output a discretionary to allow a line break, unless
2517 % (a) the next character is a -, or
2518 % (b) the preceding character is a -.
2519 % E.g., given --posix, we do not want to allow a break after either -.
2520 % Given --foo-bar, we do want to allow a break between the - and the b.
2521 \ifx\next\codedash \else
2522 \ifx\codedashprev\codedash
2523 \else \discretionary{}{}{}\fi
2525 % we need the space after the = for the case when \next itself is a
2526 % space token; it would get swallowed otherwise. As in @code{- a}.
2527 \global\let\codedashprev=
\next
2532 \def\codex #1{\tclose{#1}\endgroup}
2535 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2536 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2537 % will therefore expand the active definition of _, which is us
2538 % (inside @code that is), therefore an endless loop.
2540 \mathchar"
075F
% class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2541 \else\normalunderscore \fi
2542 \discretionary{}{}{}}%
2546 % An additional complication: the above will allow breaks after, e.g.,
2547 % each of the four underscores in __typeof__. This is bad.
2548 % @allowcodebreaks provides a document-level way to turn breaking at -
2551 \newif\ifallowcodebreaks \allowcodebreakstrue
2553 \def\keywordtrue{true
}
2554 \def\keywordfalse{false
}
2556 \parseargdef\allowcodebreaks{%
2558 \ifx\txiarg\keywordtrue
2559 \allowcodebreakstrue
2560 \else\ifx\txiarg\keywordfalse
2561 \allowcodebreaksfalse
2563 \errhelp =
\EMsimple
2564 \errmessage{Unknown @allowcodebreaks option `
\txiarg', must be true|false
}%
2568 % For @command, @env, @file, @option quotes seem unnecessary,
2569 % so use \code rather than \samp.
2575 % @uref (abbreviation for `urlref') aka @url takes an optional
2576 % (comma-separated) second argument specifying the text to display and
2577 % an optional third arg as text to display instead of (rather than in
2578 % addition to) the url itself. First (mandatory) arg is the url.
2580 % TeX-only option to allow changing PDF output to show only the second
2581 % arg (if given), and not the url (which is then just the link target).
2582 \newif\ifurefurlonlylink
2584 % The main macro is \urefbreak, which allows breaking at expected
2585 % places within the url. (There used to be another version, which
2586 % didn't support automatic breaking.)
2587 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2588 \let\uref=
\urefbreak
2590 \def\dourefbreak#1{\urefbreakfinish #1,,,
\finish}
2591 \def\urefbreakfinish#1,
#2,
#3,
#4\finish{% doesn't work in @example
2594 \setbox0 =
\hbox{\ignorespaces #3}%
2596 \unhbox0 % third arg given, show only that
2598 \setbox0 =
\hbox{\ignorespaces #2}% look for second arg
2602 % PDF plus option to not display url, show just arg
2605 % PDF, normally display both arg and url for consistency,
2606 % visibility, if the pdf is eventually used to print, etc.
2607 \unhbox0\ (
\urefcode{#1})
%
2610 \unhbox0\ (
\urefcode{#1})
% DVI, always show arg and url
2613 \urefcode{#1}% only url given, so show it
2619 % Allow line breaks around only a few characters (only).
2621 \catcode\ampChar=
\active \catcode\dotChar=
\active
2622 \catcode\hashChar=
\active \catcode\questChar=
\active
2623 \catcode\slashChar=
\active
2628 \global\def\urefcode{\begingroup
2629 \setupmarkupstyle{code
}%
2639 % By default, they are just regular characters.
2640 \global\def&
{\normalamp}
2641 \global\def.
{\normaldot}
2642 \global\def#
{\normalhash}
2643 \global\def?
{\normalquest}
2644 \global\def/
{\normalslash}
2647 % we put a little stretch before and after the breakable chars, to help
2648 % line breaking of long url's. The unequal skips make look better in
2649 % cmtt at least, especially for dots.
2650 \def\urefprestretchamount{.13em
}
2651 \def\urefpoststretchamount{.1em
}
2652 \def\urefprestretch{\urefprebreak \hskip0pt plus
\urefprestretchamount\relax}
2653 \def\urefpoststretch{\urefpostbreak \hskip0pt plus
\urefprestretchamount\relax}
2655 \def\urefcodeamp{\urefprestretch \&
\urefpoststretch}
2656 \def\urefcodedot{\urefprestretch .
\urefpoststretch}
2657 \def\urefcodehash{\urefprestretch \#
\urefpoststretch}
2658 \def\urefcodequest{\urefprestretch ?
\urefpoststretch}
2659 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2662 \global\def\urefcodeslashfinish{%
2663 \urefprestretch \slashChar
2664 % Allow line break only after the final / in a sequence of
2665 % slashes, to avoid line break between the slashes in http://.
2666 \ifx\next/
\else \urefpoststretch \fi
2670 % One more complication: by default we'll break after the special
2671 % characters, but some people like to break before the special chars, so
2672 % allow that. Also allow no breaking at all, for manual control.
2674 \parseargdef\urefbreakstyle{%
2676 \ifx\txiarg\wordnone
2677 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2678 \else\ifx\txiarg\wordbefore
2679 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2680 \else\ifx\txiarg\wordafter
2681 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2683 \errhelp =
\EMsimple
2684 \errmessage{Unknown @urefbreakstyle setting `
\txiarg'
}%
2687 \def\wordafter{after
}
2688 \def\wordbefore{before
}
2691 \urefbreakstyle after
2693 % @url synonym for @uref, since that's how everyone uses it.
2697 % rms does not like angle brackets --karl, 17may97.
2698 % So now @email is just like @uref, unless we are pdf.
2700 %\def\email#1{\angleleft{\tt #1}\angleright}
2702 \def\email#1{\doemail#1,,
\finish}
2703 \def\doemail#1,
#2,
#3\finish{\begingroup
2706 \setbox0 =
\hbox{\ignorespaces #2}%
2707 \ifdim\wd0>
0pt
\unhbox0\else\code{#1}\fi
2714 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2715 % `example' (@kbd uses ttsl only inside of @example and friends),
2716 % or `code' (@kbd uses normal tty font always).
2717 \parseargdef\kbdinputstyle{%
2719 \ifx\txiarg\worddistinct
2720 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2721 \else\ifx\txiarg\wordexample
2722 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2723 \else\ifx\txiarg\wordcode
2724 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2726 \errhelp =
\EMsimple
2727 \errmessage{Unknown @kbdinputstyle setting `
\txiarg'
}%
2730 \def\worddistinct{distinct
}
2731 \def\wordexample{example
}
2734 % Default is `distinct'.
2735 \kbdinputstyle distinct
2737 % @kbd is like @code, except that if the argument is just one @key command,
2738 % then @kbd has no effect.
2739 \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??
\par}}
2742 \def\kbdsub#1#2#3\par{%
2743 \def\one{#1}\def\three{#3}\def\threex{??
}%
2744 \ifx\one\xkey\ifx\threex\three \key{#2}%
2745 \else{\tclose{\kbdfont\setupmarkupstyle{kbd
}\look}}\fi
2746 \else{\tclose{\kbdfont\setupmarkupstyle{kbd
}\look}}\fi
2749 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2750 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2752 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2753 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2754 % \vbox{\hrule\kern-0.4pt
2755 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2756 % \kern-0.4pt\hrule}%
2757 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2759 % definition of @key with no lozenge. If the current font is already
2760 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2761 % if it isn't monospace, then use \tt.
2763 \def\key#1{{\setupmarkupstyle{key
}%
2765 \ifmonospace\else\tt\fi
2768 % @clicksequence{File @click{} Open ...}
2769 \def\clicksequence#1{\begingroup #1\endgroup}
2771 % @clickstyle @arrow (by default)
2772 \parseargdef\clickstyle{\def\click{#1}}
2775 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2776 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2778 \def\dmn#1{\thinspace #1}
2780 % @l was never documented to mean ``switch to the Lisp font'',
2781 % and it is not used as such in any manual I can find. We need it for
2782 % Polish suppressed-l. --karl, 22sep96.
2783 %\def\l#1{{\li #1}\null}
2785 % @acronym for "FBI", "NATO", and the like.
2786 % We print this one point size smaller, since it's intended for
2789 \def\acronym#1{\doacronym #1,,
\finish}
2790 \def\doacronym#1,
#2,
#3\finish{%
2791 {\selectfonts\lsize #1}%
2793 \ifx\temp\empty \else
2794 \space (
{\unsepspaces \ignorespaces \temp \unskip})
%
2796 \null % reset \spacefactor=1000
2799 % @abbr for "Comput. J." and the like.
2800 % No font change, but don't do end-of-sentence spacing.
2802 \def\abbr#1{\doabbr #1,,
\finish}
2803 \def\doabbr#1,
#2,
#3\finish{%
2804 {\plainfrenchspacing #1}%
2806 \ifx\temp\empty \else
2807 \space (
{\unsepspaces \ignorespaces \temp \unskip})
%
2809 \null % reset \spacefactor=1000
2812 % @asis just yields its argument. Used with @table, for example.
2816 % @math outputs its argument in math mode.
2818 % One complication: _ usually means subscripts, but it could also mean
2819 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2820 % _ active, and distinguish by seeing if the current family is \slfam,
2821 % which is what @var uses.
2823 \catcode`
\_ =
\active
2824 \gdef\mathunderscore{%
2826 \def_{\ifnum\fam=
\slfam \_\else\sb\fi}%
2829 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2830 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2831 % particular reason), but this is not advertised and we don't care.
2833 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2834 \def\mathbackslash{\ifnum\fam=
\ttfam \mathchar"
075C
\else\backslash \fi}
2839 \let\\ =
\mathbackslash
2841 % make the texinfo accent commands work in math mode
2851 % have to provide another name for sup operator
2855 \def\finishmath#1{#1$
\endgroup} % Close the group opened by \tex.
2857 % Some active characters (such as <) are spaced differently in math.
2858 % We have to reset their definitions in case the @math was an argument
2859 % to a command which sets the catcodes (such as @item or @section).
2862 \catcode`^ =
\active
2863 \catcode`< =
\active
2864 \catcode`> =
\active
2865 \catcode`+ =
\active
2866 \catcode`' =
\active
2872 \let' =
\ptexquoteright
2876 % for @sub and @sup, if in math mode, just do a normal sub/superscript.
2877 % If in text, use math to place as sub/superscript, but switch
2878 % into text mode, with smaller fonts. This is a different font than the
2879 % one used for real math sub/superscripts (8pt vs. 7pt), but let's not
2880 % fix it (significant additions to font machinery) until someone notices.
2882 \def\sub{\ifmmode \expandafter\sb \else \expandafter\finishsub\fi}
2883 \def\finishsub#1{$
\sb{\hbox{\selectfonts\lllsize #1}}$
}%
2885 \def\sup{\ifmmode \expandafter\ptexsp \else \expandafter\finishsup\fi}
2886 \def\finishsup#1{$
\ptexsp{\hbox{\selectfonts\lllsize #1}}$
}%
2888 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
2889 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
2890 % except specified as a normal braced arg, so no newlines to worry about.
2892 \def\outfmtnametex{tex
}
2894 \long\def\inlinefmt#1{\doinlinefmt #1,
\finish}
2895 \long\def\doinlinefmt#1,
#2,
\finish{%
2896 \def\inlinefmtname{#1}%
2897 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
2900 % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
2901 % FMTNAME is tex, else ELSE-TEXT.
2902 \long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,
\finish}
2903 \long\def\doinlinefmtifelse#1,
#2,
#3,
#4,
\finish{%
2904 \def\inlinefmtname{#1}%
2905 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
2908 % For raw, must switch into @tex before parsing the argument, to avoid
2909 % setting catcodes prematurely. Doing it this way means that, for
2910 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
2911 % ignored. But this isn't important because if people want a literal
2912 % *right* brace they would have to use a command anyway, so they may as
2913 % well use a command to get a left brace too. We could re-use the
2914 % delimiter character idea from \verb, but it seems like overkill.
2916 \long\def\inlineraw{\tex \doinlineraw}
2917 \long\def\doinlineraw#1{\doinlinerawtwo #1,
\finish}
2918 \def\doinlinerawtwo#1,
#2,
\finish{%
2919 \def\inlinerawname{#1}%
2920 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
2921 \endgroup % close group opened by \tex.
2924 % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
2926 \long\def\inlineifset#1{\doinlineifset #1,
\finish}
2927 \long\def\doinlineifset#1,
#2,
\finish{%
2928 \def\inlinevarname{#1}%
2929 \expandafter\ifx\csname SET
\inlinevarname\endcsname\relax
2930 \else\ignorespaces#2\fi
2933 % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
2935 \long\def\inlineifclear#1{\doinlineifclear #1,
\finish}
2936 \long\def\doinlineifclear#1,
#2,
\finish{%
2937 \def\inlinevarname{#1}%
2938 \expandafter\ifx\csname SET
\inlinevarname\endcsname\relax \ignorespaces#2\fi
2945 % @@ prints an @, as does @atchar{}.
2949 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
2950 % Unless we're in typewriter, use \ecfont because the CM text fonts do
2951 % not have braces, and we don't want to switch into math.
2952 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2953 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2954 \let\
{=
\mylbrace \let\lbracechar=\
{
2955 \let\
}=
\myrbrace \let\rbracechar=\
}
2957 % Definitions to produce \{ and \} commands for indices,
2958 % and @{ and @} for the aux/toc files.
2959 \catcode`\
{ =
\other \catcode`\
} =
\other
2960 \catcode`\
[ =
1 \catcode`\
] =
2
2961 \catcode`\! =
0 \catcode`\\ =
\other
2962 !gdef!lbracecmd
[\
{]%
2963 !gdef!rbracecmd
[\
}]%
2964 !gdef!lbraceatcmd
[@
{]%
2965 !gdef!rbraceatcmd
[@
}]%
2968 % @comma{} to avoid , parsing problems.
2971 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2972 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2974 \let\dotaccent =
\ptexdot
2975 \def\ringaccent#1{{\accent23 #1}}
2976 \let\tieaccent =
\ptext
2977 \let\ubaraccent =
\ptexb
2978 \let\udotaccent =
\d
2980 % Other special characters: @questiondown @exclamdown @ordf @ordm
2981 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2982 \def\questiondown{?`
}
2984 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a
}}}
2985 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o
}}}
2987 % Dotless i and dotless j, used for accents.
2992 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2993 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2994 \else \errmessage{@dotless can be used only with i or j
}%
2998 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2999 % period following counts as ending a sentence. (Idea found in latex.)
3001 \edef\TeX{\TeX \spacefactor=
1000 }
3003 % @LaTeX{} logo. Not quite the same results as the definition in
3004 % latex.ltx, since we use a different font for the raised A; it's most
3005 % convenient for us to use an explicitly smaller font, rather than using
3006 % the \scriptstyle font (since we don't reset \scriptstyle and
3007 % \scriptscriptstyle).
3012 \vbox to
\ht0{\hbox{%
3013 \ifx\textnominalsize\xwordpt
3014 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
3015 % Revert to plain's \scriptsize, which is 7pt.
3016 \count255=
\the\fam $
\fam\count255 \scriptstyle A$
%
3018 % For 11pt, we can use our lllsize.
3019 \selectfonts\lllsize A
%
3028 % Some math mode symbols. Define \ensuremath to switch into math mode
3029 % unless we are already there. Expansion tricks may not be needed here,
3030 % but safer, and can't hurt.
3031 \def\ensuremath{\ifmmode \expandafter\asis \else\expandafter\ensuredmath \fi}
3032 \def\ensuredmath#1{$
\relax#1$
}
3034 \def\bullet{\ensuremath\ptexbullet}
3035 \def\geq{\ensuremath\ge}
3036 \def\leq{\ensuremath\le}
3037 \def\minus{\ensuremath-
}
3039 % @dots{} outputs an ellipsis using the current font.
3040 % We do .5em per period so that it has the same spacing in the cm
3041 % typewriter fonts as three actual period characters; on the other hand,
3042 % in other typewriter fonts three periods are wider than 1.5em. So do
3043 % whichever is larger.
3047 \setbox0=
\hbox{...
}% get width of three periods
3054 \hskip 0pt plus
.25fil
3055 .
\hskip 0pt plus1fil
3056 .
\hskip 0pt plus1fil
3057 .
\hskip 0pt plus
.5fil
3061 % @enddots{} is an end-of-sentence ellipsis.
3065 \spacefactor=
\endofsentencespacefactor
3068 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3070 % Since these characters are used in examples, they should be an even number of
3071 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3074 \def\arrow{\leavevmode\raise.05ex
\hbox to
1em
{\hfil$
\rightarrow$
\hfil}}
3075 \def\result{\leavevmode\raise.05ex
\hbox to
1em
{\hfil$
\Rightarrow$
\hfil}}
3076 \def\expansion{\leavevmode\hbox to
1em
{\hfil$
\mapsto$
\hfil}}
3077 \def\print{\leavevmode\lower.1ex
\hbox to
1em
{\hfil$
\dashv$
\hfil}}
3078 \def\equiv{\leavevmode\hbox to
1em
{\hfil$
\ptexequiv$
\hfil}}
3080 % The @error{} command.
3081 % Adapted from the TeXbook's \boxit.
3085 {\tentt \global\dimen0 =
3em
}% Width of the box.
3086 \dimen2 =
.55pt
% Thickness of rules
3087 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3088 \setbox0 =
\hbox{\kern-
.75pt
\reducedsf \putworderror\kern-
1.5pt
}
3090 \setbox\errorbox=
\hbox to
\dimen0{\hfil
3091 \hsize =
\dimen0 \advance\hsize by -
5.8pt
% Space to left+right.
3092 \advance\hsize by -
2\dimen2 % Rules.
3094 \hrule height
\dimen2
3095 \hbox{\vrule width
\dimen2 \kern3pt % Space to left of text.
3096 \vtop{\kern2.4pt
\box0 \kern2.4pt
}% Space above/below.
3097 \kern3pt\vrule width
\dimen2}% Space to right.
3098 \hrule height
\dimen2}
3101 \def\error{\leavevmode\lower.7ex
\copy\errorbox}
3103 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3105 \def\pounds{{\it\$
}}
3107 % @euro{} comes from a separate font, depending on the current style.
3108 % We use the free feym* fonts from the eurosym package by Henrik
3109 % Theiling, which support regular, slanted, bold and bold slanted (and
3110 % "outlined" (blackboard board, sort of) versions, which we don't need).
3111 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3113 % Although only regular is the truly official Euro symbol, we ignore
3114 % that. The Euro is designed to be slightly taller than the regular
3120 % feybo - bold slanted
3122 % There is no good (free) typewriter version, to my knowledge.
3123 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3126 % Also doesn't work in math. Do we need to do math with euro symbols?
3130 \def\euro{{\eurofont e
}}
3132 % We set the font at each command, rather than predefining it in
3133 % \textfonts and the other font-switching commands, so that
3134 % installations which never need the symbol don't have to have the
3137 % There is only one designed size (nominal 10pt), so we always scale
3138 % that to the current nominal size.
3140 % By the way, simply using "at 1em" works for cmr10 and the like, but
3141 % does not work for cmbx10 and other extended/shrunken fonts.
3143 \def\eurosize{\csname\curfontsize nominalsize
\endcsname}%
3145 \ifx\curfontstyle\bfstylename
3147 \font\thiseurofont =
\ifusingit{feybo10
}{feybr10
} at
\eurosize
3150 \font\thiseurofont =
\ifusingit{feymo10
}{feymr10
} at
\eurosize
3155 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3156 % sometimes we redefine the original macro, and the alias should reflect
3159 % Use LaTeX names for the Icelandic letters.
3160 \def\DH{{\ecfont \char"D0
}} % Eth
3161 \def\dh{{\ecfont \char"F0
}} % eth
3162 \def\TH{{\ecfont \char"DE
}} % Thorn
3163 \def\th{{\ecfont \char"FE
}} % thorn
3165 \def\guillemetleft{{\ecfont \char"
13}}
3166 \def\guillemotleft{\guillemetleft}
3167 \def\guillemetright{{\ecfont \char"
14}}
3168 \def\guillemotright{\guillemetright}
3169 \def\guilsinglleft{{\ecfont \char"
0E
}}
3170 \def\guilsinglright{{\ecfont \char"
0F
}}
3171 \def\quotedblbase{{\ecfont \char"
12}}
3172 \def\quotesinglbase{{\ecfont \char"
0D
}}
3174 % This positioning is not perfect (see the ogonek LaTeX package), but
3175 % we have the precomposed glyphs for the most common cases. We put the
3176 % tests to use those glyphs in the single \ogonek macro so we have fewer
3177 % dummy definitions to worry about for index entries, etc.
3179 % ogonek is also used with other letters in Lithuanian (IOU), but using
3180 % the precomposed glyphs for those is not so easy since they aren't in
3184 \ifx\temp\macrocharA\Aogonek
3185 \else\ifx\temp\macrochara\aogonek
3186 \else\ifx\temp\macrocharE\Eogonek
3187 \else\ifx\temp\macrochare\eogonek
3189 \ecfont \setbox0=
\hbox{#1}%
3190 \ifdim\ht0=
1ex
\accent"
0C
#1%
3191 \else\ooalign{\unhbox0\crcr\hidewidth\char"
0C
\hidewidth}%
3196 \def\Aogonek{{\ecfont \char"
81}}\def\macrocharA{A
}
3197 \def\aogonek{{\ecfont \char"A1
}}\def\macrochara{a
}
3198 \def\Eogonek{{\ecfont \char"
86}}\def\macrocharE{E
}
3199 \def\eogonek{{\ecfont \char"A6
}}\def\macrochare{e
}
3201 % Use the European Computer Modern fonts (cm-super in outline format)
3202 % for non-CM glyphs. That is ec* for regular text and tc* for the text
3203 % companion symbols (LaTeX TS1 encoding). Both are part of the ec
3204 % package and follow the same conventions.
3206 \def\ecfont{\etcfont{e
}}
3207 \def\tcfont{\etcfont{t
}}
3210 % We can't distinguish serif/sans and italic/slanted, but this
3211 % is used for crude hacks anyway (like adding French and German
3212 % quotes to documents typeset with CM, where we lose kerning), so
3213 % hopefully nobody will notice/care.
3214 \edef\ecsize{\csname\curfontsize ecsize
\endcsname}%
3215 \edef\nominalsize{\csname\curfontsize nominalsize
\endcsname}%
3218 \font\thisecfont =
#1ctt
\ecsize \space at
\nominalsize
3220 \ifx\curfontstyle\bfstylename
3222 \font\thisecfont =
#1cb
\ifusingit{i
}{x
}\ecsize \space at
\nominalsize
3225 \font\thisecfont =
#1c
\ifusingit{ti
}{rm
}\ecsize \space at
\nominalsize
3231 % @registeredsymbol - R in a circle. The font for the R should really
3232 % be smaller yet, but lllsize is the best we can do for now.
3233 % Adapted from the plain.tex definition of \copyright.
3235 \def\registeredsymbol{%
3236 $^
{{\ooalign{\hfil\raise.07ex
\hbox{\selectfonts\lllsize R
}%
3241 % @textdegree - the normal degrees sign.
3243 \def\textdegree{$^
\circ$
}
3245 % Laurent Siebenmann reports \Orb undefined with:
3246 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3247 % so we'll define it if necessary.
3249 \ifx\Orb\thisisundefined
3250 \def\Orb{\mathhexbox20D}
3254 \chardef\quotedblleft="
5C
3255 \chardef\quotedblright=`\"
3256 \chardef\quoteleft=`\`
3257 \chardef\quoteright=`\'
3260 \message{page headings,
}
3262 \newskip\titlepagetopglue \titlepagetopglue =
1.5in
3263 \newskip\titlepagebottomglue \titlepagebottomglue =
2pc
3265 % First the title page. Must do @settitle before @titlepage.
3267 \newif\iffinishedtitlepage
3269 % Do an implicit @contents or @shortcontents after @end titlepage if the
3270 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3272 \newif\ifsetcontentsaftertitlepage
3273 \let\setcontentsaftertitlepage =
\setcontentsaftertitlepagetrue
3274 \newif\ifsetshortcontentsaftertitlepage
3275 \let\setshortcontentsaftertitlepage =
\setshortcontentsaftertitlepagetrue
3277 \parseargdef\shorttitlepage{%
3278 \begingroup \hbox{}\vskip 1.5in
\chaprm \centerline{#1}%
3279 \endgroup\page\hbox{}\page}
3282 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3284 \parindent=
0pt
\textfonts
3285 % Leave some space at the very top of the page.
3286 \vglue\titlepagetopglue
3287 % No rule at page bottom unless we print one at the top with @title.
3288 \finishedtitlepagetrue
3290 % Most title ``pages'' are actually two pages long, with space
3291 % at the top of the second. We don't want the ragged left on the second.
3292 \let\oldpage =
\page
3294 \iffinishedtitlepage\else
3297 \let\page =
\oldpage
3304 \iffinishedtitlepage\else
3307 % It is important to do the page break before ending the group,
3308 % because the headline and footline are only empty inside the group.
3309 % If we use the new definition of \page, we always get a blank page
3310 % after the title page, which we certainly don't want.
3314 % Need this before the \...aftertitlepage checks so that if they are
3315 % in effect the toc pages will come out with page numbers.
3318 % If they want short, they certainly want long too.
3319 \ifsetshortcontentsaftertitlepage
3322 \global\let\shortcontents =
\relax
3323 \global\let\contents =
\relax
3326 \ifsetcontentsaftertitlepage
3328 \global\let\contents =
\relax
3329 \global\let\shortcontents =
\relax
3333 \def\finishtitlepage{%
3334 \vskip4pt \hrule height
2pt width
\hsize
3335 \vskip\titlepagebottomglue
3336 \finishedtitlepagetrue
3339 % Settings used for typesetting titles: no hyphenation, no indentation,
3340 % don't worry much about spacing, ragged right. This should be used
3341 % inside a \vbox, and fonts need to be set appropriately first. Because
3342 % it is always used for titles, nothing else, we call \rmisbold. \par
3343 % should be specified before the end of the \vbox, since a vbox is a group.
3345 \def\raggedtitlesettings{%
3347 \hyphenpenalty=
10000
3353 % Macros to be used within @titlepage:
3355 \let\subtitlerm=
\tenrm
3356 \def\subtitlefont{\subtitlerm \normalbaselineskip =
13pt
\normalbaselines}
3358 \parseargdef\title{%
3360 \vbox{\titlefonts \raggedtitlesettings #1\par}%
3361 % print a rule at the page bottom also.
3362 \finishedtitlepagefalse
3363 \vskip4pt \hrule height
4pt width
\hsize \vskip4pt
3366 \parseargdef\subtitle{%
3368 {\subtitlefont \rightline{#1}}%
3371 % @author should come last, but may come many times.
3372 % It can also be used inside @quotation.
3374 \parseargdef\author{%
3375 \def\temp{\quotation}%
3377 \def\quotationauthor{#1}% printed in \Equotation.
3380 \ifseenauthor\else \vskip 0pt plus
1filll
\seenauthortrue \fi
3381 {\secfonts\rmisbold \leftline{#1}}%
3386 % Set up page headings and footings.
3388 \let\thispage=
\folio
3390 \newtoks\evenheadline % headline on even pages
3391 \newtoks\oddheadline % headline on odd pages
3392 \newtoks\evenfootline % footline on even pages
3393 \newtoks\oddfootline % footline on odd pages
3395 % Now make TeX use those variables
3396 \headline=
{{\textfonts\rm \ifodd\pageno \the\oddheadline
3397 \else \the\evenheadline \fi}}
3398 \footline=
{{\textfonts\rm \ifodd\pageno \the\oddfootline
3399 \else \the\evenfootline \fi}\HEADINGShook}
3400 \let\HEADINGShook=
\relax
3402 % Commands to set those variables.
3403 % For example, this is what @headings on does
3404 % @evenheading @thistitle|@thispage|@thischapter
3405 % @oddheading @thischapter|@thispage|@thistitle
3406 % @evenfooting @thisfile||
3407 % @oddfooting ||@thisfile
3410 \def\evenheading{\parsearg\evenheadingxxx}
3411 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|
\finish}
3412 \def\evenheadingyyy #1\|
#2\|
#3\|
#4\finish{%
3413 \global\evenheadline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3415 \def\oddheading{\parsearg\oddheadingxxx}
3416 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|
\finish}
3417 \def\oddheadingyyy #1\|
#2\|
#3\|
#4\finish{%
3418 \global\oddheadline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3420 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3422 \def\evenfooting{\parsearg\evenfootingxxx}
3423 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|
\finish}
3424 \def\evenfootingyyy #1\|
#2\|
#3\|
#4\finish{%
3425 \global\evenfootline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3427 \def\oddfooting{\parsearg\oddfootingxxx}
3428 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|
\finish}
3429 \def\oddfootingyyy #1\|
#2\|
#3\|
#4\finish{%
3430 \global\oddfootline =
{\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3432 % Leave some space for the footline. Hopefully ok to assume
3433 % @evenfooting will not be used by itself.
3434 \global\advance\pageheight by -
12pt
3435 \global\advance\vsize by -
12pt
3438 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3440 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3441 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3443 % The same set of arguments for:
3448 % @everyheadingmarks
3449 % @everyfootingmarks
3451 \def\evenheadingmarks{\headingmarks{even
}{heading
}}
3452 \def\oddheadingmarks{\headingmarks{odd
}{heading
}}
3453 \def\evenfootingmarks{\headingmarks{even
}{footing
}}
3454 \def\oddfootingmarks{\headingmarks{odd
}{footing
}}
3455 \def\everyheadingmarks#1 {\headingmarks{even
}{heading
}{#1}
3456 \headingmarks{odd
}{heading
}{#1} }
3457 \def\everyfootingmarks#1 {\headingmarks{even
}{footing
}{#1}
3458 \headingmarks{odd
}{footing
}{#1} }
3459 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3460 \def\headingmarks#1#2#3 {%
3461 \expandafter\let\expandafter\temp \csname get
#3headingmarks
\endcsname
3462 \global\expandafter\let\csname get
#1#2marks
\endcsname \temp
3465 \everyheadingmarks bottom
3466 \everyfootingmarks bottom
3468 % @headings double turns headings on for double-sided printing.
3469 % @headings single turns headings on for single-sided printing.
3470 % @headings off turns them off.
3471 % @headings on same as @headings double, retained for compatibility.
3472 % @headings after turns on double-sided headings after this page.
3473 % @headings doubleafter turns on double-sided headings after this page.
3474 % @headings singleafter turns on single-sided headings after this page.
3475 % By default, they are off at the start of a document,
3476 % and turned `on' after @end titlepage.
3478 \def\headings #1 {\csname HEADINGS
#1\endcsname}
3480 \def\headingsoff{% non-global headings elimination
3481 \evenheadline=
{\hfil}\evenfootline=
{\hfil}%
3482 \oddheadline=
{\hfil}\oddfootline=
{\hfil}%
3485 \def\HEADINGSoff{{\globaldefs=
1 \headingsoff}} % global setting
3486 \HEADINGSoff % it's the default
3488 % When we turn headings on, set the page number to 1.
3489 % For double-sided printing, put current file name in lower left corner,
3490 % chapter name on inside top of right hand pages, document
3491 % title on inside top of left hand pages, and page numbers on outside top
3492 % edge of all pages.
3493 \def\HEADINGSdouble{%
3495 \global\evenfootline=
{\hfil}
3496 \global\oddfootline=
{\hfil}
3497 \global\evenheadline=
{\line{\folio\hfil\thistitle}}
3498 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
3499 \global\let\contentsalignmacro =
\chapoddpage
3501 \let\contentsalignmacro =
\chappager
3503 % For single-sided printing, chapter title goes across top left of page,
3504 % page number on top right.
3505 \def\HEADINGSsingle{%
3507 \global\evenfootline=
{\hfil}
3508 \global\oddfootline=
{\hfil}
3509 \global\evenheadline=
{\line{\thischapter\hfil\folio}}
3510 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
3511 \global\let\contentsalignmacro =
\chappager
3513 \def\HEADINGSon{\HEADINGSdouble}
3515 \def\HEADINGSafter{\let\HEADINGShook=
\HEADINGSdoublex}
3516 \let\HEADINGSdoubleafter=
\HEADINGSafter
3517 \def\HEADINGSdoublex{%
3518 \global\evenfootline=
{\hfil}
3519 \global\oddfootline=
{\hfil}
3520 \global\evenheadline=
{\line{\folio\hfil\thistitle}}
3521 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
3522 \global\let\contentsalignmacro =
\chapoddpage
3525 \def\HEADINGSsingleafter{\let\HEADINGShook=
\HEADINGSsinglex}
3526 \def\HEADINGSsinglex{%
3527 \global\evenfootline=
{\hfil}
3528 \global\oddfootline=
{\hfil}
3529 \global\evenheadline=
{\line{\thischapter\hfil\folio}}
3530 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
3531 \global\let\contentsalignmacro =
\chappager
3534 % Subroutines used in generating headings
3535 % This produces Day Month Year style of output.
3536 % Only define if not already defined, in case a txi-??.tex file has set
3537 % up a different format (e.g., txi-cs.tex does this).
3538 \ifx\today\thisisundefined
3542 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3543 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3544 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3549 % @settitle line... specifies the title of the document, for headings.
3550 % It generates no output of its own.
3551 \def\thistitle{\putwordNoTitle}
3552 \def\settitle{\parsearg{\gdef\thistitle}}
3556 % Tables -- @table, @ftable, @vtable, @item(x).
3558 % default indentation of table text
3559 \newdimen\tableindent \tableindent=
.8in
3560 % default indentation of @itemize and @enumerate text
3561 \newdimen\itemindent \itemindent=
.3in
3562 % margin between end of table item and start of table text.
3563 \newdimen\itemmargin \itemmargin=
.1in
3565 % used internally for \itemindent minus \itemmargin
3568 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3570 % They also define \itemindex
3571 % to index the item name in whatever manner is desired (perhaps none).
3573 \newif\ifitemxneedsnegativevskip
3575 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-
\parskip\nobreak\fi}
3577 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3578 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3580 \def\itemzzz #1{\begingroup %
3581 \advance\hsize by -
\rightskip
3582 \advance\hsize by -
\tableindent
3583 \setbox0=
\hbox{\itemindicate{#1}}%
3585 \nobreak % This prevents a break before @itemx.
3587 % If the item text does not fit in the space we have, put it on a line
3588 % by itself, and do not allow a page break either before or after that
3589 % line. We do not start a paragraph here because then if the next
3590 % command is, e.g., @kindex, the whatsit would get put into the
3591 % horizontal list on a line by itself, resulting in extra blank space.
3592 \ifdim \wd0>
\itemmax
3594 % Make this a paragraph so we get the \parskip glue and wrapping,
3595 % but leave it ragged-right.
3597 \advance\leftskip by-
\tableindent
3598 \advance\hsize by
\tableindent
3599 \advance\rightskip by0pt plus1fil
\relax
3600 \leavevmode\unhbox0\par
3603 % We're going to be starting a paragraph, but we don't want the
3604 % \parskip glue -- logically it's part of the @item we just started.
3605 \nobreak \vskip-
\parskip
3607 % Stop a page break at the \parskip glue coming up. However, if
3608 % what follows is an environment such as @example, there will be no
3609 % \parskip glue; then the negative vskip we just inserted would
3610 % cause the example and the item to crash together. So we use this
3611 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3612 % \parskip glue after all. Section titles are handled this way also.
3616 \itemxneedsnegativevskipfalse
3618 % The item text fits into the space. Start a paragraph, so that the
3619 % following text (if any) will end up on the same line.
3621 % Do this with kerns and \unhbox so that if there is a footnote in
3622 % the item text, it can migrate to the main vertical list and
3623 % eventually be printed.
3624 \nobreak\kern-
\tableindent
3625 \dimen0 =
\itemmax \advance\dimen0 by
\itemmargin \advance\dimen0 by -
\wd0
3627 \nobreak\kern\dimen0
3629 \itemxneedsnegativevskiptrue
3633 \def\item{\errmessage{@item while not in a list environment
}}
3634 \def\itemx{\errmessage{@itemx while not in a list environment
}}
3636 % @table, @ftable, @vtable.
3638 \let\itemindex\gobble
3642 \def\itemindex #
#1{\doind {fn
}{\code{#
#1}}}%
3643 \tablecheck{ftable
}%
3646 \def\itemindex #
#1{\doind {vr
}{\code{#
#1}}}%
3647 \tablecheck{vtable
}%
3650 \ifnum \the\catcode`\^^M=
\active
3652 \errmessage{This command won't work in this context; perhaps the problem is
3653 that we are
\inenvironment\thisenv}%
3654 \def\next{\doignore{#1}}%
3661 \def\itemindicate{#1}%
3666 \makevalueexpandable
3667 \edef\temp{\noexpand\tablez #1\space\space\space}%
3671 \def\tablez #1 #2 #3 #4\endtablez{%
3673 \ifnum 0#1>
0 \advance \leftskip by
#1\mil \fi
3674 \ifnum 0#2>
0 \tableindent=
#2\mil \fi
3675 \ifnum 0#3>
0 \advance \rightskip by
#3\mil \fi
3676 \itemmax=
\tableindent
3677 \advance \itemmax by -
\itemmargin
3678 \advance \leftskip by
\tableindent
3679 \exdentamount=
\tableindent
3681 \parskip =
\smallskipamount
3682 \ifdim \parskip=
0pt
\parskip=
2pt
\fi
3683 \let\item =
\internalBitem
3684 \let\itemx =
\internalBitemx
3686 \def\Etable{\endgraf\afterenvbreak}
3689 \let\Eitemize\Etable
3690 \let\Eenumerate\Etable
3692 % This is the counter used by @enumerate, which is really @itemize
3696 \envdef\itemize{\parsearg\doitemize}
3700 \itemmax=
\itemindent
3701 \advance\itemmax by -
\itemmargin
3702 \advance\leftskip by
\itemindent
3703 \exdentamount=
\itemindent
3705 \parskip=
\smallskipamount
3706 \ifdim\parskip=
0pt
\parskip=
2pt
\fi
3708 % Try typesetting the item mark so that if the document erroneously says
3709 % something like @itemize @samp (intending @table), there's an error
3710 % right away at the @itemize. It's not the best error message in the
3711 % world, but it's better than leaving it to the @item. This means if
3712 % the user wants an empty mark, they have to say @w{} not just @w.
3713 \def\itemcontents{#1}%
3714 \setbox0 =
\hbox{\itemcontents}%
3716 % @itemize with no arg is equivalent to @itemize @bullet.
3717 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3719 \let\item=
\itemizeitem
3722 % Definition of @item while inside @itemize and @enumerate.
3725 \advance\itemno by
1 % for enumerations
3726 {\let\par=
\endgraf \smallbreak}% reasonable place to break
3728 % If the document has an @itemize directly after a section title, a
3729 % \nobreak will be last on the list, and \sectionheading will have
3730 % done a \vskip-\parskip. In that case, we don't want to zero
3731 % parskip, or the item text will crash with the heading. On the
3732 % other hand, when there is normal text preceding the item (as there
3733 % usually is), we do want to zero parskip, or there would be too much
3734 % space. In that case, we won't have a \nobreak before. At least
3735 % that's the theory.
3736 \ifnum\lastpenalty<
10000 \parskip=
0in
\fi
3738 \hbox to
0pt
{\hss \itemcontents \kern\itemmargin}%
3740 \vadjust{\penalty 1200}}% not good to break after first line of item.
3744 % \splitoff TOKENS\endmark defines \first to be the first token in
3745 % TOKENS, and \rest to be the remainder.
3747 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3749 % Allow an optional argument of an uppercase letter, lowercase letter,
3750 % or number, to specify the first label in the enumerated list. No
3751 % argument is the same as `1'.
3753 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3754 \def\enumeratey #1 #2\endenumeratey{%
3755 % If we were given no argument, pretend we were given `1'.
3757 \ifx\thearg\empty \def\thearg{1}\fi
3759 % Detect if the argument is a single token. If so, it might be a
3760 % letter. Otherwise, the only valid thing it can be is a number.
3761 % (We will always have one token, because of the test we just made.
3762 % This is a good thing, since \splitoff doesn't work given nothing at
3763 % all -- the first parameter is undelimited.)
3764 \expandafter\splitoff\thearg\endmark
3766 % Only one token in the argument. It could still be anything.
3767 % A ``lowercase letter'' is one whose \lccode is nonzero.
3768 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3769 % not equal to itself.
3770 % Otherwise, we assume it's a number.
3772 % We need the \relax at the end of the \ifnum lines to stop TeX from
3773 % continuing to look for a <number>.
3775 \ifnum\lccode\expandafter`
\thearg=
0\relax
3776 \numericenumerate % a number (we hope)
3779 \ifnum\lccode\expandafter`
\thearg=
\expandafter`
\thearg\relax
3780 \lowercaseenumerate % lowercase letter
3782 \uppercaseenumerate % uppercase letter
3786 % Multiple tokens in the argument. We hope it's a number.
3791 % An @enumerate whose labels are integers. The starting integer is
3794 \def\numericenumerate{%
3796 \startenumeration{\the\itemno}%
3799 % The starting (lowercase) letter is in \thearg.
3800 \def\lowercaseenumerate{%
3801 \itemno =
\expandafter`
\thearg
3803 % Be sure we're not beyond the end of the alphabet.
3805 \errmessage{No more lowercase letters in @enumerate; get a bigger
3812 % The starting (uppercase) letter is in \thearg.
3813 \def\uppercaseenumerate{%
3814 \itemno =
\expandafter`
\thearg
3816 % Be sure we're not beyond the end of the alphabet.
3818 \errmessage{No more uppercase letters in @enumerate; get a bigger
3825 % Call \doitemize, adding a period to the first argument and supplying the
3826 % common last two arguments. Also subtract one from the initial value in
3827 % \itemno, since @item increments \itemno.
3829 \def\startenumeration#1{%
3830 \advance\itemno by -
1
3831 \doitemize{#1.
}\flushcr
3834 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3837 \def\alphaenumerate{\enumerate{a
}}
3838 \def\capsenumerate{\enumerate{A
}}
3839 \def\Ealphaenumerate{\Eenumerate}
3840 \def\Ecapsenumerate{\Eenumerate}
3843 % @multitable macros
3844 % Amy Hendrickson, 8/18/94, 3/6/96
3846 % @multitable ... @end multitable will make as many columns as desired.
3847 % Contents of each column will wrap at width given in preamble. Width
3848 % can be specified either with sample text given in a template line,
3849 % or in percent of \hsize, the current width of text on page.
3851 % Table can continue over pages but will only break between lines.
3855 % Either define widths of columns in terms of percent of \hsize:
3856 % @multitable @columnfractions .25 .3 .45
3859 % Numbers following @columnfractions are the percent of the total
3860 % current hsize to be used for each column. You may use as many
3861 % columns as desired.
3864 % Or use a template:
3865 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3867 % using the widest term desired in each column.
3869 % Each new table line starts with @item, each subsequent new column
3870 % starts with @tab. Empty columns may be produced by supplying @tab's
3871 % with nothing between them for as many times as empty columns are needed,
3872 % ie, @tab@tab@tab will produce two empty columns.
3874 % @item, @tab do not need to be on their own lines, but it will not hurt
3877 % Sample multitable:
3879 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3880 % @item first col stuff @tab second col stuff @tab third col
3887 % @item first col stuff @tab second col stuff
3888 % @tab Many paragraphs of text may be used in any column.
3890 % They will wrap at the width determined by the template.
3891 % @item@tab@tab This will be in third column.
3894 % Default dimensions may be reset by user.
3895 % @multitableparskip is vertical space between paragraphs in table.
3896 % @multitableparindent is paragraph indent in table.
3897 % @multitablecolmargin is horizontal space to be left between columns.
3898 % @multitablelinespace is space to leave between table items, baseline
3900 % 0pt means it depends on current normal line spacing.
3902 \newskip\multitableparskip
3903 \newskip\multitableparindent
3904 \newdimen\multitablecolspace
3905 \newskip\multitablelinespace
3906 \multitableparskip=
0pt
3907 \multitableparindent=
6pt
3908 \multitablecolspace=
12pt
3909 \multitablelinespace=
0pt
3911 % Macros used to set up halign preamble:
3913 \let\endsetuptable\relax
3914 \def\xendsetuptable{\endsetuptable}
3915 \let\columnfractions\relax
3916 \def\xcolumnfractions{\columnfractions}
3919 % #1 is the @columnfraction, usually a decimal number like .5, but might
3920 % be just 1. We just use it, whatever it is.
3922 \def\pickupwholefraction#1 {%
3923 \global\advance\colcount by
1
3924 \expandafter\xdef\csname col
\the\colcount\endcsname{#1\hsize}%
3931 \ifx\firstarg\xendsetuptable
3934 \ifx\firstarg\xcolumnfractions
3935 \global\setpercenttrue
3938 \let\go\pickupwholefraction
3940 \global\advance\colcount by
1
3941 \setbox0=
\hbox{#1\unskip\space}% Add a normal word space as a
3942 % separator; typically that is always in the input, anyway.
3943 \expandafter\xdef\csname col
\the\colcount\endcsname{\the\wd0}%
3946 \ifx\go\pickupwholefraction
3947 % Put the argument back for the \pickupwholefraction call, so
3948 % we'll always have a period there to be parsed.
3949 \def\go{\pickupwholefraction#1}%
3951 \let\go =
\setuptable
3957 % multitable-only commands.
3959 % @headitem starts a heading row, which we typeset in bold. Assignments
3960 % have to be global since we are inside the implicit group of an
3961 % alignment entry. \everycr below resets \everytab so we don't have to
3962 % undo it ourselves.
3963 \def\headitemfont{\b}% for people to use in the template row; not changeable
3965 \checkenv\multitable
3967 \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings
3968 \global\everytab=
{\bf}% can't use \headitemfont since the parsing differs
3969 \the\everytab % for the first item
3972 % default for tables with no headings.
3973 \let\headitemcrhook=
\relax
3975 % A \tab used to include \hskip1sp. But then the space in a template
3976 % line is not enough. That is bad. So let's go back to just `&' until
3977 % we again encounter the problem the 1sp was intended to solve.
3978 % --karl, nathan@acm.org, 20apr99.
3979 \def\tab{\checkenv\multitable &
\the\everytab}%
3981 % @multitable ... @end multitable definitions:
3983 \newtoks\everytab % insert after every tab.
3985 \envdef\multitable{%
3989 % @item within a multitable starts a normal row.
3990 % We use \def instead of \let so that if one of the multitable entries
3991 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3992 % \endtemplate) expanding \doitemize.
3997 \setmultitablespacing
3998 \parskip=
\multitableparskip
3999 \parindent=
\multitableparindent
4005 \global\everytab=
{}% Reset from possible headitem.
4006 \global\colcount=
0 % Reset the column counter.
4008 % Check for saved footnotes, etc.:
4011 % Perhaps a \nobreak, then reset:
4013 \global\let\headitemcrhook=
\relax
4017 \parsearg\domultitable
4019 \def\domultitable#1{%
4020 % To parse everything between @multitable and @item:
4021 \setuptable#1 \endsetuptable
4023 % This preamble sets up a generic column definition, which will
4024 % be used as many times as user calls for columns.
4025 % \vtop will set a single line and will also let text wrap and
4026 % continue for many paragraphs if desired.
4028 \global\advance\colcount by
1
4031 % Use the current \colcount to find the correct column width:
4032 \hsize=
\expandafter\csname col
\the\colcount\endcsname
4034 % In order to keep entries from bumping into each other
4035 % we will add a \leftskip of \multitablecolspace to all columns after
4038 % If a template has been used, we will add \multitablecolspace
4039 % to the width of each template entry.
4041 % If the user has set preamble in terms of percent of \hsize we will
4042 % use that dimension as the width of the column, and the \leftskip
4043 % will keep entries from bumping into each other. Table will start at
4044 % left margin and final column will justify at right margin.
4046 % Make sure we don't inherit \rightskip from the outer environment.
4049 % The first column will be indented with the surrounding text.
4050 \advance\hsize by
\leftskip
4053 % If user has not set preamble in terms of percent of \hsize
4054 % we will advance \hsize by \multitablecolspace.
4055 \advance\hsize by
\multitablecolspace
4057 % In either case we will make \leftskip=\multitablecolspace:
4058 \leftskip=
\multitablecolspace
4060 % Ignoring space at the beginning and end avoids an occasional spurious
4061 % blank line, when TeX decides to break the line at the space before the
4062 % box from the multistrut, so the strut ends up on a line by itself.
4064 % @multitable @columnfractions .11 .89
4066 % @tab Legal holiday which is valid in major parts of the whole country.
4067 % Is automatically provided with highlighting sequences respectively
4068 % marking characters.
4069 \noindent\ignorespaces##
\unskip\multistrut
4074 \egroup % end the \halign
4075 \global\setpercentfalse
4078 \def\setmultitablespacing{%
4079 \def\multistrut{\strut}% just use the standard line spacing
4081 % Compute \multitablelinespace (if not defined by user) for use in
4082 % \multitableparskip calculation. We used define \multistrut based on
4083 % this, but (ironically) that caused the spacing to be off.
4084 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
4085 \ifdim\multitablelinespace=
0pt
4086 \setbox0=
\vbox{X
}\global\multitablelinespace=
\the\baselineskip
4087 \global\advance\multitablelinespace by-
\ht0
4089 % Test to see if parskip is larger than space between lines of
4090 % table. If not, do nothing.
4091 % If so, set to same dimension as multitablelinespace.
4092 \ifdim\multitableparskip>
\multitablelinespace
4093 \global\multitableparskip=
\multitablelinespace
4094 \global\advance\multitableparskip-
7pt
% to keep parskip somewhat smaller
4095 % than skip between lines in the table.
4097 \ifdim\multitableparskip=
0pt
4098 \global\multitableparskip=
\multitablelinespace
4099 \global\advance\multitableparskip-
7pt
% to keep parskip somewhat smaller
4100 % than skip between lines in the table.
4104 \message{conditionals,
}
4106 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4107 % @ifnotxml always succeed. They currently do nothing; we don't
4108 % attempt to check whether the conditionals are properly nested. But we
4109 % have to remember that they are conditionals, so that @end doesn't
4110 % attempt to close an environment group.
4113 \expandafter\let\csname #1\endcsname =
\relax
4114 \expandafter\let\csname iscond.
#1\endcsname =
1
4117 \makecond{ifnotdocbook
}
4118 \makecond{ifnothtml
}
4119 \makecond{ifnotinfo
}
4120 \makecond{ifnotplaintext
}
4123 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4125 \def\direntry{\doignore{direntry
}}
4126 \def\documentdescription{\doignore{documentdescription
}}
4127 \def\docbook{\doignore{docbook
}}
4128 \def\html{\doignore{html
}}
4129 \def\ifdocbook{\doignore{ifdocbook
}}
4130 \def\ifhtml{\doignore{ifhtml
}}
4131 \def\ifinfo{\doignore{ifinfo
}}
4132 \def\ifnottex{\doignore{ifnottex
}}
4133 \def\ifplaintext{\doignore{ifplaintext
}}
4134 \def\ifxml{\doignore{ifxml
}}
4135 \def\ignore{\doignore{ignore
}}
4136 \def\menu{\doignore{menu
}}
4137 \def\xml{\doignore{xml
}}
4139 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4141 % A count to remember the depth of nesting.
4142 \newcount\doignorecount
4144 \def\doignore#1{\begingroup
4145 % Scan in ``verbatim'' mode:
4147 \catcode`\@ =
\other
4148 \catcode`\
{ =
\other
4149 \catcode`\
} =
\other
4151 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4154 % Count number of #1's that we've seen.
4157 % Swallow text until we reach the matching `@end #1'.
4161 { \catcode`_=
11 % We want to use \_STOP_ which cannot appear in texinfo source.
4164 \gdef\dodoignore#1{%
4165 % #1 contains the command name as a string, e.g., `ifinfo'.
4167 % Define a command to find the next `@end #1'.
4168 \long\def\doignoretext#
#1^^M@end
#1{%
4169 \doignoretextyyy#
#1^^M@
#1\_STOP_}%
4171 % And this command to find another #1 command, at the beginning of a
4172 % line. (Otherwise, we would consider a line `@c @ifset', for
4173 % example, to count as an @ifset for nesting.)
4174 \long\def\doignoretextyyy#
#1^^M@
#1#
#2\_STOP_{\doignoreyyy{#
#2}\_STOP_}%
4176 % And now expand that command.
4181 \def\doignoreyyy#1{%
4183 \ifx\temp\empty % Nothing found.
4184 \let\next\doignoretextzzz
4185 \else % Found a nested condition, ...
4186 \advance\doignorecount by
1
4187 \let\next\doignoretextyyy % ..., look for another.
4188 % If we're here, #1 ends with ^^M\ifinfo (for example).
4190 \next #1% the token \_STOP_ is present just after this macro.
4193 % We have to swallow the remaining "\_STOP_".
4195 \def\doignoretextzzz#1{%
4196 \ifnum\doignorecount =
0 % We have just found the outermost @end.
4197 \let\next\enddoignore
4198 \else % Still inside a nested condition.
4199 \advance\doignorecount by -
1
4200 \let\next\doignoretext % Look for the next @end.
4205 % Finish off ignored text.
4207 % Ignore anything after the last `@end #1'; this matters in verbatim
4208 % environments, where otherwise the newline after an ignored conditional
4209 % would result in a blank line in the output.
4210 \gdef\enddoignore#1^^M
{\endgroup\ignorespaces}%
4214 % @set VAR sets the variable VAR to an empty value.
4215 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4217 % Since we want to separate VAR from REST-OF-LINE (which might be
4218 % empty), we can't just use \parsearg; we have to insert a space of our
4219 % own to delimit the rest of the line, and then take it out again if we
4221 % We rely on the fact that \parsearg sets \catcode`\ =10.
4223 \parseargdef\set{\setyyy#1 \endsetyyy}
4224 \def\setyyy#1 #2\endsetyyy{%
4226 \makevalueexpandable
4228 \edef\next{\gdef\makecsname{SET
#1}}%
4236 % Remove the trailing space \setxxx inserted.
4237 \def\setzzz#1 \endsetzzz{\next{#1}}
4239 % @clear VAR clears (i.e., unsets) the variable VAR.
4241 \parseargdef\clear{%
4243 \makevalueexpandable
4244 \global\expandafter\let\csname SET
#1\endcsname=
\relax
4248 % @value{foo} gets the text saved in variable foo.
4249 \def\value{\begingroup\makevalueexpandable\valuexxx}
4250 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4252 \catcode`\-=
\active \catcode`
\_=
\active
4254 \gdef\makevalueexpandable{%
4255 \let\value =
\expandablevalue
4256 % We don't want these characters active, ...
4257 \catcode`\-=
\other \catcode`
\_=
\other
4258 % ..., but we might end up with active ones in the argument if
4259 % we're called from @code, as @code{@value{foo-bar_}}, though.
4260 % So \let them to their normal equivalents.
4261 \let-
\normaldash \let_\normalunderscore
4265 % We have this subroutine so that we can handle at least some @value's
4266 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4267 % The command has to be fully expandable (if the variable is set), since
4268 % the result winds up in the index file. This means that if the
4269 % variable's value contains other Texinfo commands, it's almost certain
4270 % it will fail (although perhaps we could fix that with sufficient work
4271 % to do a one-level expansion on the result, instead of complete).
4273 % Unfortunately, this has the consequence that when _ is in the *value*
4274 % of an @set, it does not print properly in the roman fonts (get the cmr
4275 % dot accent at position 126 instead). No fix comes to mind, and it's
4276 % been this way since 2003 or earlier, so just ignore it.
4278 \def\expandablevalue#1{%
4279 \expandafter\ifx\csname SET
#1\endcsname\relax
4280 {[No value for ``
#1''
]}%
4281 \message{Variable `
#1', used in @value, is not set.
}%
4283 \csname SET
#1\endcsname
4287 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4290 % To get the special treatment we need for `@end ifset,' we call
4291 % \makecond and then redefine.
4294 \def\ifset{\parsearg{\doifset{\let\next=
\ifsetfail}}}
4297 \makevalueexpandable
4299 \expandafter\ifx\csname SET
#2\endcsname\relax
4300 #1% If not set, redefine \next.
4305 \def\ifsetfail{\doignore{ifset
}}
4307 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4308 % defined with @set, or has been undefined with @clear.
4310 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4311 % above code: if the variable is not set, do nothing, if it is set,
4312 % then redefine \next to \ifclearfail.
4315 \def\ifclear{\parsearg{\doifset{\else \let\next=
\ifclearfail}}}
4316 \def\ifclearfail{\doignore{ifclear
}}
4318 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4319 % without the @) is in fact defined. We can only feasibly check at the
4320 % TeX level, so something like `mathcode' is going to considered
4321 % defined even though it is not a Texinfo command.
4323 \makecond{ifcommanddefined
}
4324 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=
\ifcmddefinedfail}}}
4326 \def\doifcmddefined#1#2{{%
4327 \makevalueexpandable
4329 \expandafter\ifx\csname #2\endcsname\relax
4330 #1% If not defined, \let\next as above.
4335 \def\ifcmddefinedfail{\doignore{ifcommanddefined
}}
4337 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4338 \makecond{ifcommandnotdefined
}
4339 \def\ifcommandnotdefined{%
4340 \parsearg{\doifcmddefined{\else \let\next=
\ifcmdnotdefinedfail}}}
4341 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined
}}
4343 % Set the `txicommandconditionals' variable, so documents have a way to
4344 % test if the @ifcommand...defined conditionals are available.
4345 \set txicommandconditionals
4347 % @dircategory CATEGORY -- specify a category of the dir file
4348 % which this file should belong to. Ignore this in TeX.
4349 \let\dircategory=
\comment
4351 % @defininfoenclose.
4352 \let\definfoenclose=
\comment
4356 % Index generation facilities
4358 % Define \newwrite to be identical to plain tex's \newwrite
4359 % except not \outer, so it can be used within macros and \if's.
4360 \edef\newwrite{\makecsname{ptexnewwrite
}}
4362 % \newindex {foo} defines an index named IX.
4363 % It automatically defines \IXindex such that
4364 % \IXindex ...rest of line... puts an entry in the index IX.
4365 % It also defines \IXindfile to be the number of the output channel for
4366 % the file that accumulates this index. The file's extension is IX.
4367 % The name of an index should be no more than 2 characters long
4368 % for the sake of vms.
4371 \expandafter\chardef\csname#1indfile
\endcsname=
0
4372 \expandafter\xdef\csname#1index
\endcsname{% % Define @#1index
4373 \noexpand\doindex{#1}}
4376 % @defindex foo == \newindex{foo}
4378 \def\defindex{\parsearg\newindex}
4380 % Define @defcodeindex, like @defindex except put all entries in @code.
4382 \def\defcodeindex{\parsearg\newcodeindex}
4384 \def\newcodeindex#1{%
4385 \expandafter\chardef\csname#1indfile
\endcsname=
0
4386 \expandafter\xdef\csname#1index
\endcsname{%
4387 \noexpand\docodeindex{#1}}%
4390 % The default indices:
4391 \newindex{cp
}% concepts,
4392 \newcodeindex{fn
}% functions,
4393 \newcodeindex{vr
}% variables,
4394 \newcodeindex{tp
}% types,
4395 \newcodeindex{ky
}% keys
4396 \newcodeindex{pg
}% and programs.
4399 % @synindex foo bar makes index foo feed into index bar.
4400 % Do this instead of @defindex foo if you don't want it as a separate index.
4402 % @syncodeindex foo bar similar, but put all entries made for index foo
4405 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4406 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4408 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4409 % #3 the target index (bar).
4410 \def\dosynindex#1#2#3{%
4411 % Only do \closeout if we haven't already done it, else we'll end up
4412 % closing the target index.
4413 \expandafter \ifx\csname donesynindex
#2\endcsname \relax
4414 % The \closeout helps reduce unnecessary open files; the limit on the
4415 % Acorn RISC OS is a mere 16 files.
4416 \expandafter\closeout\csname#2indfile
\endcsname
4417 \expandafter\let\csname donesynindex
#2\endcsname =
1
4419 % redefine \fooindfile:
4420 \expandafter\let\expandafter\temp\expandafter=
\csname#3indfile
\endcsname
4421 \expandafter\let\csname#2indfile
\endcsname=
\temp
4422 % redefine \fooindex:
4423 \expandafter\xdef\csname#2index
\endcsname{\noexpand#1{#3}}%
4426 % Define \doindex, the driver for all index macros.
4427 % Argument #1 is generated by the calling \fooindex macro,
4428 % and it the two-letter name of the index.
4430 \def\doindex#1{\edef\indexname{#1}\parsearg\doindexxxx}
4431 \def\doindexxxx #1{\doind{\indexname}{#1}}
4433 % like the previous two, but they put @code around the argument.
4434 \def\docodeindex#1{\edef\indexname{#1}\parsearg\docodeindexxxx}
4435 \def\docodeindexxxx #1{\doind{\indexname}{\code{#1}}}
4437 % Used when writing an index entry out to an index file, to prevent
4438 % expansion of Texinfo commands that can appear in an index entry.
4439 % Since there are some commands we want to expand, and others we don't,
4440 % we have to laboriously prevent expansion for those that we don't.
4443 \escapechar = `\\
% use backslash in output files.
4444 \def\@
{@
}% change to @@ when we switch to @ as escape char in index files.
4445 \def\
{\realbackslash\space }%
4447 % Need these unexpandable (because we define \tt as a dummy)
4448 % definitions when @{ or @} appear in index entry text. Also, more
4449 % complicated, when \tex is in effect and \{ is a \delimiter again.
4450 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4451 % braces and backslashes are used only as delimiters. Perhaps we
4452 % should use @lbracechar and @rbracechar?
4453 \def\
{{{\tt\char123}}%
4454 \def\
}{{\tt\char125}}%
4456 % Do the redefinitions.
4460 % For the aux and toc files, @ is the escape character. So we want to
4461 % redefine everything using @ as the escape character (instead of
4462 % \realbackslash, still used for index files). When everything uses @,
4463 % this will be simpler.
4468 \let\
{ =
\lbraceatcmd
4469 \let\
} =
\rbraceatcmd
4471 % Do the redefinitions.
4476 % Called from \indexdummies and \atdummies.
4478 \def\commondummies{%
4479 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4480 % preventing its expansion. This is used only for control words,
4481 % not control letters, because the \space would be incorrect for
4482 % control characters, but is needed to separate the control word
4483 % from whatever follows.
4485 % For control letters, we have \definedummyletter, which omits the
4488 % These can be used both for control words that take an argument and
4489 % those that do not. If it is followed by {arg} in the input, then
4490 % that will dutifully get written to the index (or wherever).
4492 \def\definedummyword #
#1{\def#
#1{\string#
#1\space}}%
4493 \def\definedummyletter#
#1{\def#
#1{\string#
#1}}%
4494 \let\definedummyaccent\definedummyletter
4496 \commondummiesnofonts
4498 \definedummyletter\_%
4499 \definedummyletter\-
%
4501 % Non-English letters.
4512 \definedummyword\exclamdown
4516 \definedummyword\ordf
4517 \definedummyword\ordm
4518 \definedummyword\questiondown
4522 % Although these internal commands shouldn't show up, sometimes they do.
4524 \definedummyword\gtr
4525 \definedummyword\hat
4526 \definedummyword\less
4529 \definedummyword\tclose
4532 \definedummyword\LaTeX
4533 \definedummyword\TeX
4535 % Assorted special characters.
4536 \definedummyword\arrow
4537 \definedummyword\bullet
4538 \definedummyword\comma
4539 \definedummyword\copyright
4540 \definedummyword\registeredsymbol
4541 \definedummyword\dots
4542 \definedummyword\enddots
4543 \definedummyword\entrybreak
4544 \definedummyword\equiv
4545 \definedummyword\error
4546 \definedummyword\euro
4547 \definedummyword\expansion
4548 \definedummyword\geq
4549 \definedummyword\guillemetleft
4550 \definedummyword\guillemetright
4551 \definedummyword\guilsinglleft
4552 \definedummyword\guilsinglright
4553 \definedummyword\lbracechar
4554 \definedummyword\leq
4555 \definedummyword\mathopsup
4556 \definedummyword\minus
4557 \definedummyword\ogonek
4558 \definedummyword\pounds
4559 \definedummyword\point
4560 \definedummyword\print
4561 \definedummyword\quotedblbase
4562 \definedummyword\quotedblleft
4563 \definedummyword\quotedblright
4564 \definedummyword\quoteleft
4565 \definedummyword\quoteright
4566 \definedummyword\quotesinglbase
4567 \definedummyword\rbracechar
4568 \definedummyword\result
4569 \definedummyword\sub
4570 \definedummyword\sup
4571 \definedummyword\textdegree
4573 % We want to disable all macros so that they are not expanded by \write.
4576 \normalturnoffactive
4578 % Handle some cases of @value -- where it does not contain any
4579 % (non-fully-expandable) commands.
4580 \makevalueexpandable
4583 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4585 \def\commondummiesnofonts{%
4586 % Control letters and accents.
4587 \definedummyletter\!
%
4588 \definedummyaccent\"
%
4589 \definedummyaccent\'
%
4590 \definedummyletter\*
%
4591 \definedummyaccent\,
%
4592 \definedummyletter\.
%
4593 \definedummyletter\/
%
4594 \definedummyletter\:
%
4595 \definedummyaccent\=
%
4596 \definedummyletter\?
%
4597 \definedummyaccent\^
%
4598 \definedummyaccent\`
%
4599 \definedummyaccent\~
%
4603 \definedummyword\dotaccent
4604 \definedummyword\ogonek
4605 \definedummyword\ringaccent
4606 \definedummyword\tieaccent
4607 \definedummyword\ubaraccent
4608 \definedummyword\udotaccent
4609 \definedummyword\dotless
4611 % Texinfo font commands.
4615 \definedummyword\sansserif
4617 \definedummyword\slanted
4620 % Commands that take arguments.
4621 \definedummyword\abbr
4622 \definedummyword\acronym
4623 \definedummyword\anchor
4624 \definedummyword\cite
4625 \definedummyword\code
4626 \definedummyword\command
4627 \definedummyword\dfn
4628 \definedummyword\dmn
4629 \definedummyword\email
4630 \definedummyword\emph
4631 \definedummyword\env
4632 \definedummyword\file
4633 \definedummyword\image
4634 \definedummyword\indicateurl
4635 \definedummyword\inforef
4636 \definedummyword\kbd
4637 \definedummyword\key
4638 \definedummyword\math
4639 \definedummyword\option
4640 \definedummyword\pxref
4641 \definedummyword\ref
4642 \definedummyword\samp
4643 \definedummyword\strong
4644 \definedummyword\tie
4646 \definedummyword\uref
4647 \definedummyword\url
4648 \definedummyword\var
4649 \definedummyword\verb
4651 \definedummyword\xref
4654 % @macro mkind{arg1,arg2}
4658 % The space after the comma will end up in the temporary definition
4659 % that we make for arg2 (see \parsemargdef ff.). We want all this to be
4660 % expanded for the sake of the index, so we end up just seeing "bar".
4661 \let\xeatspaces =
\eatspaces
4664 % For testing: output @{ and @} in index sort strings as \{ and \}.
4665 \newif\ifusebracesinindexes
4667 \let\indexlbrace\relax
4668 \let\indexrbrace\relax
4672 @gdef@backslashdisappear
{@def\
{}}
4678 \gdef\indexnonalnumdisappear{%
4684 \gdef\indexnonalnumreappear{%
4692 % \indexnofonts is used when outputting the strings to sort the index
4693 % by, and when constructing control sequence names. It eliminates all
4694 % control sequences and just writes whatever the best ASCII sort string
4695 % would be for a given command (usually its argument).
4698 % Accent commands should become @asis.
4699 \def\definedummyaccent#
#1{\let#
#1\asis}%
4700 % We can just ignore other control letters.
4701 \def\definedummyletter#
#1{\let#
#1\empty}%
4702 % All control words become @asis by default; overrides below.
4703 \let\definedummyword\definedummyaccent
4705 \commondummiesnofonts
4707 % Don't no-op \tt, since it isn't a user-level command
4708 % and is used in the definitions of the active chars like <, >, |, etc.
4709 % Likewise with the other plain tex font commands.
4714 \def\_{\normalunderscore}%
4715 \def\-
{}% @- shouldn't affect sorting
4717 % Unfortunately, texindex < 6.0 is not prepared to handle braces in the
4718 % content at all, so these won't be sorted in ASCII order.
4719 \def\lbracechar{{\indexlbrace}}%
4720 \def\rbracechar{{\indexrbrace}}%
4725 % Non-English letters.
4742 \def\questiondown{?
}%
4749 % Assorted special characters.
4750 % (The following {} will end up in the sort string, but that's ok.)
4752 \def\bullet{bullet
}%
4754 \def\copyright{copyright
}%
4760 \def\expansion{==>
}%
4762 \def\guillemetleft{<<
}%
4763 \def\guillemetright{>>
}%
4764 \def\guilsinglleft{<
}%
4765 \def\guilsinglright{>
}%
4769 \def\pounds{pounds
}%
4771 \def\quotedblbase{"
}%
4772 \def\quotedblleft{"
}%
4773 \def\quotedblright{"
}%
4776 \def\quotesinglbase{,
}%
4777 \def\registeredsymbol{R
}%
4781 \expandafter\ifx\csname SETtxiindexlquoteignore
\endcsname\relax
4782 \else \indexlquoteignore \fi
4784 % We need to get rid of all macros, leaving only the arguments (if present).
4785 % Of course this is not nearly correct, but it is the best we can do for now.
4786 % makeinfo does not expand macros in the argument to @deffn, which ends up
4787 % writing an index entry, and texindex isn't prepared for an index sort entry
4788 % that starts with \.
4790 % Since macro invocations are followed by braces, we can just redefine them
4791 % to take a single TeX argument. The case of a macro invocation that
4792 % goes to end-of-line is not handled.
4797 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4798 % ignore left quotes in the sort term.
4799 {\catcode`\`=
\active
4800 \gdef\indexlquoteignore{\let`=
\empty}}
4802 \let\SETmarginindex=
\relax % put index entries in margin (undocumented)?
4804 % Most index entries go through here, but \dosubind is the general case.
4805 % #1 is the index name, #2 is the entry text.
4806 \def\doind#1#2{\dosubind{#1}{#2}{}}
4808 % There is also \dosubind {index}{topic}{subtopic}
4809 % which makes an entry in a two-level index such as the operation index.
4810 % TODO: Two-level index? Operation index?
4812 % Workhorse for all indexes.
4813 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4814 % empty if called from \doind, as we usually are (the main exception
4815 % is with most defuns, which call us directly).
4817 \def\dosubind#1#2#3{%
4820 \requireopenindexfile{#1}%
4821 % Store the main index entry text (including the third arg).
4823 % If third arg is present, precede it with a space.
4825 \ifx\thirdarg\empty \else
4826 \toks0 =
\expandafter{\the\toks0 \space #3}%
4829 \edef\writeto{\csname#1indfile
\endcsname}%
4831 \safewhatsit\dosubindwrite
4836 % Check if an index file has been opened, and if not, open it.
4837 \def\requireopenindexfile#1{%
4838 \ifnum\csname #1indfile
\endcsname=
0
4839 \expandafter\newwrite \csname#1indfile
\endcsname
4840 \openout \csname#1indfile
\endcsname \jobname.
#1 % Open the file
4843 % Output \ as {\indexbackslash}, because \ is an escape character in
4845 \let\indexbackslash=
\relax
4846 {\catcode`\@=
0 \catcode`\\=
\active
4847 @gdef@useindexbackslash
{@def\
{{@indexbackslash
}}}
4850 % Definition for writing index entry text.
4851 \def\sortas#1{\ignorespaces}%
4853 % Definition for writing index entry sort key. Should occur at the at
4854 % the beginning of the index entry, like
4855 % @cindex @sortas{september} \september
4856 % The \ignorespaces takes care of following space, but there's no way
4857 % to remove space before it.
4860 \gdef\indexwritesortas{%
4862 \indexnonalnumreappear
4863 \indexwritesortasxxx}
4864 \gdef\indexwritesortasxxx#1{%
4865 \xdef\indexsortkey{#1}\endgroup}
4869 % Write the entry in \toks0 to the index file.
4871 \def\dosubindwrite{%
4872 % Put the index entry in the margin if desired.
4873 \ifx\SETmarginindex\relax\else
4874 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt
\the\toks0}}%
4877 % Remember, we are within a group.
4878 \indexdummies % Must do this here, since \bf, etc expand at this stage
4879 \useindexbackslash % \indexbackslash isn't defined now so it will be output
4880 % as is; and it will print as backslash.
4881 % Get the string to sort by, by processing the index entry with all
4882 % font commands turned off.
4884 \xdef\indexsortkey{}%
4885 \let\sortas=
\indexwritesortas
4886 \indexnonalnumdisappear
4887 \edef\temp{\the\toks0}%
4888 \setbox\dummybox =
\hbox{\temp}% Make sure to execute any \sortas
4889 \ifx\indexsortkey\empty
4890 \xdef\indexsortkey{\temp}%
4891 \ifx\indexsortkey\empty\xdef\indexsortkey{ }\fi
4895 % Set up the complete index entry, with both the sort key and
4896 % the original text, including any font commands. We write
4897 % three arguments to \entry to the .?? file (four in the
4898 % subentry case), texindex reduces to two when writing the .??s
4902 \string\entry{\indexsortkey}{\noexpand\folio}{\the\toks0}}%
4906 \newbox\dummybox % used above
4908 % Take care of unwanted page breaks/skips around a whatsit:
4910 % If a skip is the last thing on the list now, preserve it
4911 % by backing up by \lastskip, doing the \write, then inserting
4912 % the skip again. Otherwise, the whatsit generated by the
4913 % \write or \pdfdest will make \lastskip zero. The result is that
4914 % sequences like this:
4918 % will have extra space inserted, because the \medbreak in the
4919 % start of the @defun won't see the skip inserted by the @end of
4920 % the previous defun.
4922 % But don't do any of this if we're not in vertical mode. We
4923 % don't want to do a \vskip and prematurely end a paragraph.
4925 % Avoid page breaks due to these extra skips, too.
4927 % But wait, there is a catch there:
4928 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4929 % sufficient for this purpose, as it ignores stretch and shrink parts
4930 % of the skip. The only way seems to be to check the textual
4931 % representation of the skip.
4933 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4934 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4936 \edef\zeroskipmacro{\expandafter\the\csname z@skip
\endcsname}
4938 \newskip\whatsitskip
4939 \newcount\whatsitpenalty
4943 \def\safewhatsit#1{\ifhmode
4946 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4947 \whatsitskip =
\lastskip
4948 \edef\lastskipmacro{\the\lastskip}%
4949 \whatsitpenalty =
\lastpenalty
4951 % If \lastskip is nonzero, that means the last item was a
4952 % skip. And since a skip is discardable, that means this
4953 % -\whatsitskip glue we're inserting is preceded by a
4954 % non-discardable item, therefore it is not a potential
4955 % breakpoint, therefore no \nobreak needed.
4956 \ifx\lastskipmacro\zeroskipmacro
4963 \ifx\lastskipmacro\zeroskipmacro
4964 % If \lastskip was zero, perhaps the last item was a penalty, and
4965 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4966 % to re-insert the same penalty (values >10000 are used for various
4967 % signals); since we just inserted a non-discardable item, any
4968 % following glue (such as a \parskip) would be a breakpoint. For example:
4969 % @deffn deffn-whatever
4970 % @vindex index-whatever
4972 % would allow a break between the index-whatever whatsit
4973 % and the "Description." paragraph.
4974 \ifnum\whatsitpenalty>
9999 \penalty\whatsitpenalty \fi
4976 % On the other hand, if we had a nonzero \lastskip,
4977 % this make-up glue would be preceded by a non-discardable item
4978 % (the whatsit from the \write), so we must insert a \nobreak.
4979 \nobreak\vskip\whatsitskip
4983 % The index entry written in the file actually looks like
4984 % \entry {sortstring}{page}{topic}
4986 % \entry {sortstring}{page}{topic}{subtopic}
4987 % The texindex program reads in these files and writes files
4988 % containing these kinds of lines:
4990 % before the first topic whose initial is c
4991 % \entry {topic}{pagelist}
4992 % for a topic that is used without subtopics
4994 % for the beginning of a topic that is used with subtopics
4995 % \secondary {subtopic}{pagelist}
4996 % for each subtopic.
4998 % Define the user-accessible indexing commands
4999 % @findex, @vindex, @kindex, @cindex.
5001 \def\findex {\fnindex}
5002 \def\kindex {\kyindex}
5003 \def\cindex {\cpindex}
5004 \def\vindex {\vrindex}
5005 \def\tindex {\tpindex}
5006 \def\pindex {\pgindex}
5008 \def\cindexsub {\begingroup\obeylines\cindexsub}
5010 \gdef\cindexsub "
#1"
#2^^M
{\endgroup %
5011 \dosubind{cp
}{#2}{#1}}}
5013 % Define the macros used in formatting output of the sorted index material.
5015 % @printindex causes a particular index (the ??s file) to get printed.
5016 % It does not print any chapter heading (usually an @unnumbered).
5018 \parseargdef\printindex{\begingroup
5019 \dobreak \chapheadingskip{10000}%
5024 \everypar =
{}% don't want the \kern\-parindent from indentation suppression.
5026 % See if the index file exists and is nonempty.
5027 % Change catcode of @ here so that if the index file contains
5029 % as its first line, TeX doesn't complain about mismatched braces
5030 % (because it thinks @} is a control sequence).
5032 \openin 1 \jobname.
#1s
5034 % \enddoublecolumns gets confused if there is no text in the index,
5035 % and it loses the chapter title and the aux file entries for the
5036 % index. The easiest way to prevent this problem is to make sure
5037 % there is some text.
5038 \putwordIndexNonexistent
5041 % If the index file exists but is empty, then \openin leaves \ifeof
5042 % false. We have to make TeX try to read something from the file, so
5043 % it can discover if there is anything in it.
5046 \putwordIndexIsEmpty
5048 % Index files are almost Texinfo source, but we use \ as the escape
5049 % character. It would be better to use @, but that's too big a change
5050 % to make right now.
5051 \def\indexbackslash{\ttbackslash}%
5052 \let\indexlbrace\
{ % Likewise, set these sequences for braces
5053 \let\indexrbrace\
} % used in the sort key.
5064 % These macros are used by the sorted index file itself.
5065 % Change them to control the appearance of the index.
5067 {\catcode`\/=
13 \catcode`\-=
13 \catcode`\^=
13 \catcode`\~=
13 \catcode`
\_=
13
5068 \catcode`\|=
13 \catcode`\<=
13 \catcode`\>=
13 \catcode`\+=
13 \catcode`\"=
13
5070 \gdef\initialglyphs{%
5071 % Some changes for non-alphabetic characters. Using the glyphs from the
5072 % math fonts looks more consistent than the typewriter font used elsewhere
5073 % for these characters.
5074 \def\indexbackslash{\math{\backslash}}%
5075 \let\\=
\indexbackslash
5077 % Can't get bold backslash so don't use bold forward slash
5079 \def/
{{\secrmnotbold \normalslash}}%
5080 \def-
{{\normaldash\normaldash}}% en dash `--'
5081 \def^
{{\chapbf \normalcaret}}
5084 \leavevmode \kern.07em
\vbox{\hrule width
.3em height
.1ex
}\kern .07em
}%
5088 \def+
{$
\normalplus$
}%
5098 % Remove any glue we may have, we'll be inserting our own.
5101 % We like breaks before the index initials, so insert a bonus.
5102 % The glue before the bonus allows a little bit of space at the
5103 % bottom of a column to reduce an increase in inter-line spacing.
5105 \vskip 0pt plus
6\baselineskip
5107 \vskip 0pt plus -
6\baselineskip
5109 % Typeset the initial. Making this add up to a whole number of
5110 % baselineskips increases the chance of the dots lining up from column
5111 % to column. It still won't often be perfect, because of the stretch
5112 % we need before each entry, but it's better.
5114 % No shrink because it confuses \balancecolumns.
5115 \vskip 1.67\baselineskip plus
.5\baselineskip
5116 \leftline{\secfonts \secbf #1}%
5117 % \secfonts is inside the argument of \leftline so that the change of
5118 % \baselineskip will not affect any glue inserted before the vbox that
5119 % \leftline creates.
5120 % Do our best not to break after the initial.
5122 \vskip .33\baselineskip plus
.1\baselineskip
5123 \egroup % \initialglyphs
5126 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
5127 % then page number (#2) flushed to the right margin. It is used for index
5128 % and table of contents entries. The paragraph is indented by \leftskip.
5133 % Start a new paragraph if necessary, so our assignments below can't
5134 % affect previous text.
5137 % Do not fill out the last line with white space.
5140 % No extra space above this paragraph.
5143 % Do not prefer a separate line ending with a hyphen to fewer lines.
5144 \finalhyphendemerits =
0
5146 % \hangindent is only relevant when the entry text and page number
5147 % don't both fit on one line. In that case, bob suggests starting the
5148 % dots pretty far over on the line. Unfortunately, a large
5149 % indentation looks wrong when the entry text itself is broken across
5150 % lines. So we use a small indentation and put up with long leaders.
5152 % \hangafter is reset to 1 (which is the value we want) at the start
5153 % of each paragraph, so we need not do anything with that.
5156 % When the entry text needs to be broken, just fill out the first line
5158 \rightskip =
0pt plus1fil
5160 % A bit of stretch before each entry for the benefit of balancing
5162 \vskip 0pt plus0.5pt
5164 % When reading the text of entry, convert explicit line breaks
5165 % from @* into spaces. The user might give these in long section
5166 % titles, for instance.
5167 \def\*
{\unskip\space\ignorespaces}%
5168 \def\entrybreak{\hfil\break}%
5170 % Swallow the left brace of the text (first parameter):
5171 \afterassignment\doentry
5174 \def\entrybreak{\unskip\space\ignorespaces}%
5176 \bgroup % Instead of the swallowed brace.
5178 \aftergroup\finishentry
5179 % And now comes the text of the entry.
5181 \def\finishentry#1{%
5182 % #1 is the page number.
5184 % The following is kludged to not output a line of dots in the index if
5185 % there are no page numbers. The next person who breaks this will be
5186 % cursed by a Unix daemon.
5187 \setbox\boxA =
\hbox{#1}%
5188 \ifdim\wd\boxA =
0pt
5192 % If we must, put the page number on a line of its own, and fill out
5193 % this line with blank space. (The \hfil is overwhelmed with the
5194 % fill leaders glue in \indexdotfill if the page number does fit.)
5196 \null\nobreak\indexdotfill % Have leaders before the page number.
5198 % The `\ ' here is removed by the implicit \unskip that TeX does as
5199 % part of (the primitive) \par. Without it, a spurious underfull
5212 % Like plain.tex's \dotfill, except uses up at least 1 em.
5213 \def\indexdotfill{\cleaders
5214 \hbox{$
\mathsurround=
0pt
\mkern1.5mu.
\mkern1.5mu$
}\hskip 1em plus
1fill
}
5216 \def\primary #1{\line{#1\hfil}}
5218 \newskip\secondaryindent \secondaryindent=
0.5cm
5219 \def\secondary#1#2{{%
5224 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5226 \pdfgettoks#2.\
\the\toksA % The page number ends the paragraph.
5233 % Define two-column mode, which we use to typeset indexes.
5234 % Adapted from the TeXbook, page 416, which is to say,
5235 % the manmac.tex format used to print the TeXbook itself.
5239 \newdimen\doublecolumnhsize
5241 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5242 % Grab any single-column material above us.
5245 % Here is a possibility not foreseen in manmac: if we accumulate a
5246 % whole lot of material, we might end up calling this \output
5247 % routine twice in a row (see the doublecol-lose test, which is
5248 % essentially a couple of indexes with @setchapternewpage off). In
5249 % that case we just ship out what is in \partialpage with the normal
5250 % output routine. Generally, \partialpage will be empty when this
5251 % runs and this will be a no-op. See the indexspread.tex test case.
5252 \ifvoid\partialpage \else
5253 \onepageout{\pagecontents\partialpage}%
5256 \global\setbox\partialpage =
\vbox{%
5257 % Unvbox the main output page.
5259 \kern-
\topskip \kern\baselineskip
5262 \eject % run that output routine to set \partialpage
5264 % Use the double-column output routine for subsequent pages.
5265 \output =
{\doublecolumnout}%
5267 % Change the page size parameters. We could do this once outside this
5268 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5269 % format, but then we repeat the same computation. Repeating a couple
5270 % of assignments once per index is clearly meaningless for the
5271 % execution time, so we may as well do it in one place.
5273 % First we halve the line length, less a little for the gutter between
5274 % the columns. We compute the gutter based on the line length, so it
5275 % changes automatically with the paper format. The magic constant
5276 % below is chosen so that the gutter has the same value (well, +-<1pt)
5277 % as it did when we hard-coded it.
5279 % We put the result in a separate register, \doublecolumhsize, so we
5280 % can restore it in \pagesofar, after \hsize itself has (potentially)
5283 \doublecolumnhsize =
\hsize
5284 \advance\doublecolumnhsize by -
.04154\hsize
5285 \divide\doublecolumnhsize by
2
5286 \hsize =
\doublecolumnhsize
5288 % Double the \vsize as well. (We don't need a separate register here,
5289 % since nobody clobbers \vsize.)
5293 % The double-column output routine for all double-column pages except
5294 % the last, which is done by \balancecolumns.
5296 \def\doublecolumnout{%
5297 \splittopskip=
\topskip \splitmaxdepth=
\maxdepth
5298 % Get the available space for the double columns -- the normal
5299 % (undoubled) page height minus any material left over from the
5303 \advance\dimen@ by -
\ht\partialpage
5305 % box0 will be the left-hand column, box2 the right.
5306 \setbox0=
\vsplit255 to
\dimen@
\setbox2=
\vsplit255 to
\dimen@
5307 \onepageout\pagesofar
5309 \penalty\outputpenalty
5312 % Re-output the contents of the output page -- any previous material,
5313 % followed by the two boxes we just split, in box0 and box2.
5317 \hsize =
\doublecolumnhsize
5318 \wd0=
\hsize \wd2=
\hsize
5319 \hbox to
\pagewidth{\box0\hfil\box2}%
5322 % All done with double columns.
5323 \def\enddoublecolumns{%
5324 % The following penalty ensures that the page builder is exercised
5325 % _before_ we change the output routine. This is necessary in the
5326 % following situation:
5328 % The last section of the index consists only of a single entry.
5329 % Before this section, \pagetotal is less than \pagegoal, so no
5330 % break occurs before the last section starts. However, the last
5331 % section, consisting of \initial and the single \entry, does not
5332 % fit on the page and has to be broken off. Without the following
5333 % penalty the page builder will not be exercised until \eject
5334 % below, and by that time we'll already have changed the output
5335 % routine to the \balancecolumns version, so the next-to-last
5336 % double-column page will be processed with \balancecolumns, which
5337 % is wrong: The two columns will go to the main vertical list, with
5338 % the broken-off section in the recent contributions. As soon as
5339 % the output routine finishes, TeX starts reconsidering the page
5340 % break. The two columns and the broken-off section both fit on the
5341 % page, because the two columns now take up only half of the page
5342 % goal. When TeX sees \eject from below which follows the final
5343 % section, it invokes the new output routine that we've set after
5344 % \balancecolumns below; \onepageout will try to fit the two columns
5345 % and the final section into the vbox of \pageheight (see
5346 % \pagebody), causing an overfull box.
5348 % Note that glue won't work here, because glue does not exercise the
5349 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5353 % Split the last of the double-column material. Leave it on the
5354 % current page, no automatic page break.
5357 % If we end up splitting too much material for the current page,
5358 % though, there will be another page break right after this \output
5359 % invocation ends. Having called \balancecolumns once, we do not
5360 % want to call it again. Therefore, reset \output to its normal
5361 % definition right away. (We hope \balancecolumns will never be
5362 % called on to balance too much material, but if it is, this makes
5363 % the output somewhat more palatable.)
5364 \global\output =
{\onepageout{\pagecontents\PAGE}}%
5367 \endgroup % started in \begindoublecolumns
5369 % \pagegoal was set to the doubled \vsize above, since we restarted
5370 % the current page. We're now back to normal single-column
5371 % typesetting, so reset \pagegoal to the normal \vsize (after the
5372 % \endgroup where \vsize got restored).
5376 % Only called for the last of the double column material. \doublecolumnout
5378 \def\balancecolumns{%
5379 \setbox0 =
\vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5381 \advance\dimen@ by
\topskip
5382 \advance\dimen@ by-
\baselineskip
5383 \ifdim\dimen@<
14\baselineskip
5384 % Don't split a short final column in two.
5387 \divide\dimen@ by
2 % target to split to
5389 \splittopskip =
\topskip
5390 % Loop until the second column is no higher than the first
5394 \global\setbox3 =
\copy0
5395 \global\setbox1 =
\vsplit3 to
\dimen@
5396 % Remove glue from bottom of first column to
5397 % make sure it is higher than the second.
5398 \global\setbox1 =
\vbox{\unvbox1\unpenalty\unskip}%
5400 \global\advance\dimen@ by
1pt
5403 \multiply\dimen@ii by
4
5404 \divide\dimen@ii by
5
5405 \ifdim\ht3<
\dimen@ii
5406 % Column heights are too different, so don't make their bottoms
5407 % flush with each other
5408 \setbox0=
\vbox to
\dimen@
{\unvbox1\vfill}%
5409 \setbox2=
\vbox to
\dimen@
{\unvbox3\vfill}%
5411 \setbox0=
\vbox to
\dimen@
{\unvbox1}%
5412 \setbox2=
\vbox to
\dimen@
{\unvbox3}%
5418 \catcode`\@ =
\other
5421 \message{sectioning,
}
5422 % Chapters, sections, etc.
5424 % Let's start with @part.
5425 \outer\parseargdef\part{\partzzz{#1}}
5429 \vskip.3\vsize % move it down on the page a bit
5431 \noindent \titlefonts\rmisbold #1\par % the text
5432 \let\lastnode=
\empty % no node to associate with
5433 \writetocentry{part
}{#1}{}% but put it in the toc
5434 \headingsoff % no headline or footline on the part page
5439 % \unnumberedno is an oxymoron. But we count the unnumbered
5440 % sections so that we can refer to them unambiguously in the pdf
5441 % outlines by their "section number". We avoid collisions with chapter
5442 % numbers by starting them at 10000. (If a document ever has 10000
5443 % chapters, we're in trouble anyway, I'm sure.)
5444 \newcount\unnumberedno \unnumberedno =
10000
5446 \newcount\secno \secno=
0
5447 \newcount\subsecno \subsecno=
0
5448 \newcount\subsubsecno \subsubsecno=
0
5450 % This counter is funny since it counts through charcodes of letters A, B, ...
5451 \newcount\appendixno \appendixno = `\@
5453 % \def\appendixletter{\char\the\appendixno}
5454 % We do the following ugly conditional instead of the above simple
5455 % construct for the sake of pdftex, which needs the actual
5456 % letter in the expansion, not just typeset.
5458 \def\appendixletter{%
5459 \ifnum\appendixno=`A A
%
5460 \else\ifnum\appendixno=`B B
%
5461 \else\ifnum\appendixno=`C C
%
5462 \else\ifnum\appendixno=`D D
%
5463 \else\ifnum\appendixno=`E E
%
5464 \else\ifnum\appendixno=`F F
%
5465 \else\ifnum\appendixno=`G G
%
5466 \else\ifnum\appendixno=`H H
%
5467 \else\ifnum\appendixno=`I I
%
5468 \else\ifnum\appendixno=`J J
%
5469 \else\ifnum\appendixno=`K K
%
5470 \else\ifnum\appendixno=`L L
%
5471 \else\ifnum\appendixno=`M M
%
5472 \else\ifnum\appendixno=`N N
%
5473 \else\ifnum\appendixno=`O O
%
5474 \else\ifnum\appendixno=`P P
%
5475 \else\ifnum\appendixno=`Q Q
%
5476 \else\ifnum\appendixno=`R R
%
5477 \else\ifnum\appendixno=`S S
%
5478 \else\ifnum\appendixno=`T T
%
5479 \else\ifnum\appendixno=`U U
%
5480 \else\ifnum\appendixno=`V V
%
5481 \else\ifnum\appendixno=`W W
%
5482 \else\ifnum\appendixno=`X X
%
5483 \else\ifnum\appendixno=`Y Y
%
5484 \else\ifnum\appendixno=`Z Z
%
5485 % The \the is necessary, despite appearances, because \appendixletter is
5486 % expanded while writing the .toc file. \char\appendixno is not
5487 % expandable, thus it is written literally, thus all appendixes come out
5488 % with the same letter (or @) in the toc without it.
5489 \else\char\the\appendixno
5490 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5491 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5493 % Each @chapter defines these (using marks) as the number+name, number
5494 % and name of the chapter. Page headings and footings can use
5495 % these. @section does likewise.
5497 \def\thischapternum{}
5498 \def\thischaptername{}
5500 \def\thissectionnum{}
5501 \def\thissectionname{}
5503 \newcount\absseclevel % used to calculate proper heading level
5504 \newcount\secbase\secbase=
0 % @raisesections/@lowersections modify this count
5506 % @raisesections: treat @section as chapter, @subsection as section, etc.
5507 \def\raisesections{\global\advance\secbase by -
1}
5508 \let\up=
\raisesections % original BFox name
5510 % @lowersections: treat @chapter as section, @section as subsection, etc.
5511 \def\lowersections{\global\advance\secbase by
1}
5512 \let\down=
\lowersections % original BFox name
5514 % we only have subsub.
5515 \chardef\maxseclevel =
3
5517 % A numbered section within an unnumbered changes to unnumbered too.
5518 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5519 \chardef\unnlevel =
\maxseclevel
5521 % Trace whether the current chapter is an appendix or not:
5522 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5523 \def\chapheadtype{N
}
5525 % Choose a heading macro
5526 % #1 is heading type
5527 % #2 is heading level
5528 % #3 is text for heading
5529 \def\genhead#1#2#3{%
5530 % Compute the abs. sec. level:
5532 \advance\absseclevel by
\secbase
5533 % Make sure \absseclevel doesn't fall outside the range:
5534 \ifnum \absseclevel <
0
5537 \ifnum \absseclevel >
3
5544 \ifnum \absseclevel <
\unnlevel
5545 \chardef\unnlevel =
\absseclevel
5548 % Check for appendix sections:
5549 \ifnum \absseclevel =
0
5550 \edef\chapheadtype{\headtype}%
5552 \if \headtype A
\if \chapheadtype N
%
5553 \errmessage{@appendix... within a non-appendix chapter
}%
5556 % Check for numbered within unnumbered:
5557 \ifnum \absseclevel >
\unnlevel
5560 \chardef\unnlevel =
3
5563 % Now print the heading:
5567 \or \unnumberedseczzz{#3}%
5568 \or \unnumberedsubseczzz{#3}%
5569 \or \unnumberedsubsubseczzz{#3}%
5575 \or \appendixsectionzzz{#3}%
5576 \or \appendixsubseczzz{#3}%
5577 \or \appendixsubsubseczzz{#3}%
5583 \or \numberedsubseczzz{#3}%
5584 \or \numberedsubsubseczzz{#3}%
5588 \suppressfirstparagraphindent
5592 \def\numhead{\genhead N
}
5593 \def\apphead{\genhead A
}
5594 \def\unnmhead{\genhead U
}
5596 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5597 % all lower-level sectioning counters to zero.
5599 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5600 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5601 \let\chaplevelprefix =
\empty
5603 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5605 % section resetting is \global in case the chapter is in a group, such
5606 % as an @include file.
5607 \global\secno=
0 \global\subsecno=
0 \global\subsubsecno=
0
5608 \global\advance\chapno by
1
5611 \gdef\chaplevelprefix{\the\chapno.
}%
5614 % \putwordChapter can contain complex things in translations.
5615 \toks0=
\expandafter{\putwordChapter}%
5616 \message{\the\toks0 \space \the\chapno}%
5618 % Write the actual heading.
5619 \chapmacro{#1}{Ynumbered
}{\the\chapno}%
5621 % So @section and the like are numbered underneath this chapter.
5622 \global\let\section =
\numberedsec
5623 \global\let\subsection =
\numberedsubsec
5624 \global\let\subsubsection =
\numberedsubsubsec
5627 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5629 \def\appendixzzz#1{%
5630 \global\secno=
0 \global\subsecno=
0 \global\subsubsecno=
0
5631 \global\advance\appendixno by
1
5632 \gdef\chaplevelprefix{\appendixletter.
}%
5635 % \putwordAppendix can contain complex things in translations.
5636 \toks0=
\expandafter{\putwordAppendix}%
5637 \message{\the\toks0 \space \appendixletter}%
5639 \chapmacro{#1}{Yappendix
}{\appendixletter}%
5641 \global\let\section =
\appendixsec
5642 \global\let\subsection =
\appendixsubsec
5643 \global\let\subsubsection =
\appendixsubsubsec
5646 % normally unnmhead0 calls unnumberedzzz:
5647 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5648 \def\unnumberedzzz#1{%
5649 \global\secno=
0 \global\subsecno=
0 \global\subsubsecno=
0
5650 \global\advance\unnumberedno by
1
5652 % Since an unnumbered has no number, no prefix for figures.
5653 \global\let\chaplevelprefix =
\empty
5656 % This used to be simply \message{#1}, but TeX fully expands the
5657 % argument to \message. Therefore, if #1 contained @-commands, TeX
5658 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5659 % expanded @cite (which turns out to cause errors because \cite is meant
5660 % to be executed, not expanded).
5662 % Anyway, we don't want the fully-expanded definition of @cite to appear
5663 % as a result of the \message, we just want `@cite' itself. We use
5664 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5665 % simply yielding the contents of <toks register>. (We also do this for
5668 \message{(
\the\toks0)
}%
5670 \chapmacro{#1}{Ynothing
}{\the\unnumberedno}%
5672 \global\let\section =
\unnumberedsec
5673 \global\let\subsection =
\unnumberedsubsec
5674 \global\let\subsubsection =
\unnumberedsubsubsec
5677 % @centerchap is like @unnumbered, but the heading is centered.
5678 \outer\parseargdef\centerchap{%
5679 % Well, we could do the following in a group, but that would break
5680 % an assumption that \chapmacro is called at the outermost level.
5681 % Thus we are safer this way: --kasal, 24feb04
5682 \let\centerparametersmaybe =
\centerparameters
5684 \let\centerparametersmaybe =
\relax
5687 % @top is like @unnumbered.
5692 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5694 \global\subsecno=
0 \global\subsubsecno=
0 \global\advance\secno by
1
5695 \sectionheading{#1}{sec
}{Ynumbered
}{\the\chapno.
\the\secno}%
5698 % normally calls appendixsectionzzz:
5699 \outer\parseargdef\appendixsection{\apphead1{#1}}
5700 \def\appendixsectionzzz#1{%
5701 \global\subsecno=
0 \global\subsubsecno=
0 \global\advance\secno by
1
5702 \sectionheading{#1}{sec
}{Yappendix
}{\appendixletter.
\the\secno}%
5704 \let\appendixsec\appendixsection
5706 % normally calls unnumberedseczzz:
5707 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5708 \def\unnumberedseczzz#1{%
5709 \global\subsecno=
0 \global\subsubsecno=
0 \global\advance\secno by
1
5710 \sectionheading{#1}{sec
}{Ynothing
}{\the\unnumberedno.
\the\secno}%
5715 % normally calls numberedsubseczzz:
5716 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5717 \def\numberedsubseczzz#1{%
5718 \global\subsubsecno=
0 \global\advance\subsecno by
1
5719 \sectionheading{#1}{subsec
}{Ynumbered
}{\the\chapno.
\the\secno.
\the\subsecno}%
5722 % normally calls appendixsubseczzz:
5723 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5724 \def\appendixsubseczzz#1{%
5725 \global\subsubsecno=
0 \global\advance\subsecno by
1
5726 \sectionheading{#1}{subsec
}{Yappendix
}%
5727 {\appendixletter.
\the\secno.
\the\subsecno}%
5730 % normally calls unnumberedsubseczzz:
5731 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5732 \def\unnumberedsubseczzz#1{%
5733 \global\subsubsecno=
0 \global\advance\subsecno by
1
5734 \sectionheading{#1}{subsec
}{Ynothing
}%
5735 {\the\unnumberedno.
\the\secno.
\the\subsecno}%
5740 % normally numberedsubsubseczzz:
5741 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5742 \def\numberedsubsubseczzz#1{%
5743 \global\advance\subsubsecno by
1
5744 \sectionheading{#1}{subsubsec
}{Ynumbered
}%
5745 {\the\chapno.
\the\secno.
\the\subsecno.
\the\subsubsecno}%
5748 % normally appendixsubsubseczzz:
5749 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5750 \def\appendixsubsubseczzz#1{%
5751 \global\advance\subsubsecno by
1
5752 \sectionheading{#1}{subsubsec
}{Yappendix
}%
5753 {\appendixletter.
\the\secno.
\the\subsecno.
\the\subsubsecno}%
5756 % normally unnumberedsubsubseczzz:
5757 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5758 \def\unnumberedsubsubseczzz#1{%
5759 \global\advance\subsubsecno by
1
5760 \sectionheading{#1}{subsubsec
}{Ynothing
}%
5761 {\the\unnumberedno.
\the\secno.
\the\subsecno.
\the\subsubsecno}%
5764 % These macros control what the section commands do, according
5765 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5766 % Define them by default for a numbered chapter.
5767 \let\section =
\numberedsec
5768 \let\subsection =
\numberedsubsec
5769 \let\subsubsection =
\numberedsubsubsec
5771 % Define @majorheading, @heading and @subheading
5774 {\advance\chapheadingskip by
10pt
\chapbreak }%
5775 \parsearg\chapheadingzzz
5778 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5779 \def\chapheadingzzz#1{%
5780 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5781 \nobreak\bigskip \nobreak
5782 \suppressfirstparagraphindent
5785 % @heading, @subheading, @subsubheading.
5786 \parseargdef\heading{\sectionheading{#1}{sec
}{Yomitfromtoc
}{}
5787 \suppressfirstparagraphindent}
5788 \parseargdef\subheading{\sectionheading{#1}{subsec
}{Yomitfromtoc
}{}
5789 \suppressfirstparagraphindent}
5790 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec
}{Yomitfromtoc
}{}
5791 \suppressfirstparagraphindent}
5793 % These macros generate a chapter, section, etc. heading only
5794 % (including whitespace, linebreaking, etc. around it),
5795 % given all the information in convenient, parsed form.
5797 % Args are the skip and penalty (usually negative)
5798 \def\dobreak#1#2{\par\ifdim\lastskip<
#1\removelastskip\penalty#2\vskip#1\fi}
5800 % Parameter controlling skip before chapter headings (if needed)
5801 \newskip\chapheadingskip
5803 % Define plain chapter starts, and page on/off switching for it.
5804 \def\chapbreak{\dobreak \chapheadingskip {-
4000}}
5805 \def\chappager{\par\vfill\supereject}
5806 % Because \domark is called before \chapoddpage, the filler page will
5807 % get the headings for the next chapter, which is wrong. But we don't
5808 % care -- we just disable all headings on the filler page.
5820 \def\setchapternewpage #1 {\csname CHAPPAG
#1\endcsname}
5823 \global\let\contentsalignmacro =
\chappager
5824 \global\let\pchapsepmacro=
\chapbreak
5825 \global\let\pagealignmacro=
\chappager}
5828 \global\let\contentsalignmacro =
\chappager
5829 \global\let\pchapsepmacro=
\chappager
5830 \global\let\pagealignmacro=
\chappager
5831 \global\def\HEADINGSon{\HEADINGSsingle}}
5834 \global\let\contentsalignmacro =
\chapoddpage
5835 \global\let\pchapsepmacro=
\chapoddpage
5836 \global\let\pagealignmacro=
\chapoddpage
5837 \global\def\HEADINGSon{\HEADINGSdouble}}
5843 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5844 % Yappendix, Yomitfromtoc), #3 the chapter number.
5845 % Not used for @heading series.
5847 % To test against our argument.
5848 \def\Ynothingkeyword{Ynothing
}
5849 \def\Yappendixkeyword{Yappendix
}
5850 \def\Yomitfromtockeyword{Yomitfromtoc
}
5852 \def\chapmacro#1#2#3{%
5853 \checkenv{}% chapters, etc., should not start inside an environment.
5855 % Insert the first mark before the heading break (see notes for \domark).
5856 \let\prevchapterdefs=
\lastchapterdefs
5857 \let\prevsectiondefs=
\lastsectiondefs
5858 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5859 \gdef\thissection{}}%
5862 \ifx\temptype\Ynothingkeyword
5863 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5864 \gdef\thischapter{\thischaptername}}%
5865 \else\ifx\temptype\Yomitfromtockeyword
5866 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5867 \gdef\thischapter{}}%
5868 \else\ifx\temptype\Yappendixkeyword
5870 \xdef\lastchapterdefs{%
5871 \gdef\noexpand\thischaptername{\the\toks0}%
5872 \gdef\noexpand\thischapternum{\appendixletter}%
5873 % \noexpand\putwordAppendix avoids expanding indigestible
5874 % commands in some of the translations.
5875 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5876 \noexpand\thischapternum:
5877 \noexpand\thischaptername}%
5881 \xdef\lastchapterdefs{%
5882 \gdef\noexpand\thischaptername{\the\toks0}%
5883 \gdef\noexpand\thischapternum{\the\chapno}%
5884 % \noexpand\putwordChapter avoids expanding indigestible
5885 % commands in some of the translations.
5886 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5887 \noexpand\thischapternum:
5888 \noexpand\thischaptername}%
5892 % Output the mark. Pass it through \safewhatsit, to take care of
5893 % the preceding space.
5896 % Insert the chapter heading break.
5899 % Now the second mark, after the heading break. No break points
5900 % between here and the heading.
5901 \let\prevchapterdefs=
\lastchapterdefs
5902 \let\prevsectiondefs=
\lastsectiondefs
5906 \chapfonts \rmisbold
5907 \let\footnote=
\errfootnoteheading % give better error message
5909 % Have to define \lastsection before calling \donoderef, because the
5910 % xref code eventually uses it. On the other hand, it has to be called
5911 % after \pchapsepmacro, or the headline will change too soon.
5912 \gdef\lastsection{#1}%
5914 % Only insert the separating space if we have a chapter/appendix
5915 % number, and don't print the unnumbered ``number''.
5916 \ifx\temptype\Ynothingkeyword
5918 \def\toctype{unnchap
}%
5919 \else\ifx\temptype\Yomitfromtockeyword
5920 \setbox0 =
\hbox{}% contents like unnumbered, but no toc entry
5922 \else\ifx\temptype\Yappendixkeyword
5923 \setbox0 =
\hbox{\putwordAppendix{} #3\enspace}%
5926 \setbox0 =
\hbox{#3\enspace}%
5927 \def\toctype{numchap
}%
5930 % Write the toc entry for this chapter. Must come before the
5931 % \donoderef, because we include the current node name in the toc
5932 % entry, and \donoderef resets it to empty.
5933 \writetocentry{\toctype}{#1}{#3}%
5935 % For pdftex, we have to write out the node definition (aka, make
5936 % the pdfdest) after any page break, but before the actual text has
5937 % been typeset. If the destination for the pdf outline is after the
5938 % text, then jumping from the outline may wind up with the text not
5939 % being visible, for instance under high magnification.
5942 % Typeset the actual heading.
5943 \nobreak % Avoid page breaks at the interline glue.
5944 \vbox{\raggedtitlesettings \hangindent=
\wd0 \centerparametersmaybe
5947 \nobreak\bigskip % no page break after a chapter title
5951 % @centerchap -- centered and unnumbered.
5952 \let\centerparametersmaybe =
\relax
5953 \def\centerparameters{%
5954 \advance\rightskip by
3\rightskip
5955 \leftskip =
\rightskip
5960 % I don't think this chapter style is supported any more, so I'm not
5961 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5963 \def\setchapterstyle #1 {\csname CHAPF
#1\endcsname}
5965 \def\unnchfopen #1{%
5967 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5968 \nobreak\bigskip\nobreak
5970 \def\chfopen #1#2{\chapoddpage {\chapfonts
5971 \vbox to
3in
{\vfil \hbox to
\hsize{\hfil #2} \hbox to
\hsize{\hfil #1} \vfil}}%
5974 \def\centerchfopen #1{%
5976 \vbox{\chapfonts \raggedtitlesettings \hfill #1\hfill}%
5977 \nobreak\bigskip \nobreak
5980 \global\let\chapmacro=
\chfopen
5981 \global\let\centerchapmacro=
\centerchfopen}
5984 % Section titles. These macros combine the section number parts and
5985 % call the generic \sectionheading to do the printing.
5987 \newskip\secheadingskip
5988 \def\secheadingbreak{\dobreak \secheadingskip{-
1000}}
5990 % Subsection titles.
5991 \newskip\subsecheadingskip
5992 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-
500}}
5994 % Subsubsection titles.
5995 \def\subsubsecheadingskip{\subsecheadingskip}
5996 \def\subsubsecheadingbreak{\subsecheadingbreak}
5999 % Print any size, any type, section title.
6001 % #1 is the text of the title,
6002 % #2 is the section level (sec/subsec/subsubsec),
6003 % #3 is the section type (Ynumbered, Ynothing, Yappendix, Yomitfromtoc),
6004 % #4 is the section number.
6006 \def\seckeyword{sec
}
6008 \def\sectionheading#1#2#3#4{%
6010 \def\sectionlevel{#2}%
6013 % It is ok for the @heading series commands to appear inside an
6014 % environment (it's been historically allowed, though the logic is
6015 % dubious), but not the others.
6016 \ifx\temptype\Yomitfromtockeyword\else
6017 \checkenv{}% non-@*heading should not be in an environment.
6019 \let\footnote=
\errfootnoteheading
6021 % Switch to the right set of fonts.
6022 \csname #2fonts
\endcsname \rmisbold
6024 % Insert first mark before the heading break (see notes for \domark).
6025 \let\prevsectiondefs=
\lastsectiondefs
6026 \ifx\temptype\Ynothingkeyword
6027 \ifx\sectionlevel\seckeyword
6028 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
6029 \gdef\thissection{\thissectionname}}%
6031 \else\ifx\temptype\Yomitfromtockeyword
6032 % Don't redefine \thissection.
6033 \else\ifx\temptype\Yappendixkeyword
6034 \ifx\sectionlevel\seckeyword
6036 \xdef\lastsectiondefs{%
6037 \gdef\noexpand\thissectionname{\the\toks0}%
6038 \gdef\noexpand\thissectionnum{#4}%
6039 % \noexpand\putwordSection avoids expanding indigestible
6040 % commands in some of the translations.
6041 \gdef\noexpand\thissection{\noexpand\putwordSection{}
6042 \noexpand\thissectionnum:
6043 \noexpand\thissectionname}%
6047 \ifx\sectionlevel\seckeyword
6049 \xdef\lastsectiondefs{%
6050 \gdef\noexpand\thissectionname{\the\toks0}%
6051 \gdef\noexpand\thissectionnum{#4}%
6052 % \noexpand\putwordSection avoids expanding indigestible
6053 % commands in some of the translations.
6054 \gdef\noexpand\thissection{\noexpand\putwordSection{}
6055 \noexpand\thissectionnum:
6056 \noexpand\thissectionname}%
6061 % Go into vertical mode. Usually we'll already be there, but we
6062 % don't want the following whatsit to end up in a preceding paragraph
6063 % if the document didn't happen to have a blank line.
6066 % Output the mark. Pass it through \safewhatsit, to take care of
6067 % the preceding space.
6070 % Insert space above the heading.
6071 \csname #2headingbreak
\endcsname
6073 % Now the second mark, after the heading break. No break points
6074 % between here and the heading.
6075 \global\let\prevsectiondefs=
\lastsectiondefs
6078 % Only insert the space after the number if we have a section number.
6079 \ifx\temptype\Ynothingkeyword
6082 \gdef\lastsection{#1}%
6083 \else\ifx\temptype\Yomitfromtockeyword
6084 % for @headings -- no section number, don't include in toc,
6085 % and don't redefine \lastsection.
6088 \let\sectionlevel=
\empty
6089 \else\ifx\temptype\Yappendixkeyword
6090 \setbox0 =
\hbox{#4\enspace}%
6092 \gdef\lastsection{#1}%
6094 \setbox0 =
\hbox{#4\enspace}%
6096 \gdef\lastsection{#1}%
6099 % Write the toc entry (before \donoderef). See comments in \chapmacro.
6100 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
6102 % Write the node reference (= pdf destination for pdftex).
6103 % Again, see comments in \chapmacro.
6106 % Interline glue will be inserted when the vbox is completed.
6107 % That glue will be a valid breakpoint for the page, since it'll be
6108 % preceded by a whatsit (usually from the \donoderef, or from the
6109 % \writetocentry if there was no node). We don't want to allow that
6110 % break, since then the whatsits could end up on page n while the
6111 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
6114 % Output the actual section heading.
6115 \vbox{\hyphenpenalty=
10000 \tolerance=
5000 \parindent=
0pt
\ptexraggedright
6116 \hangindent=
\wd0 % zero if no section number
6119 % Add extra space after the heading -- half of whatever came above it.
6120 % Don't allow stretch, though.
6121 \kern .5 \csname #2headingskip
\endcsname
6123 % Do not let the kern be a potential breakpoint, as it would be if it
6124 % was followed by glue.
6127 % We'll almost certainly start a paragraph next, so don't let that
6128 % glue accumulate. (Not a breakpoint because it's preceded by a
6129 % discardable item.) However, when a paragraph is not started next
6130 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
6131 % or the negative glue will cause weirdly wrong output, typically
6132 % obscuring the section heading with something else.
6135 % This is so the last item on the main vertical list is a known
6136 % \penalty > 10000, so \startdefun, etc., can recognize the situation
6137 % and do the needful.
6143 % Table of contents.
6146 % Write an entry to the toc file, opening it if necessary.
6147 % Called from @chapter, etc.
6149 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
6150 % We append the current node name (if any) and page number as additional
6151 % arguments for the \{chap,sec,...}entry macros which will eventually
6152 % read this. The node name is used in the pdf outlines as the
6153 % destination to jump to.
6155 % We open the .toc file for writing here instead of at @setfilename (or
6156 % any other fixed time) so that @contents can be anywhere in the document.
6157 % But if #1 is `omit', then we don't do anything. This is used for the
6158 % table of contents chapter openings themselves.
6160 \newif\iftocfileopened
6161 \def\omitkeyword{omit
}%
6163 \def\writetocentry#1#2#3{%
6164 \edef\writetoctype{#1}%
6165 \ifx\writetoctype\omitkeyword \else
6166 \iftocfileopened\else
6167 \immediate\openout\tocfile =
\jobname.toc
6168 \global\tocfileopenedtrue
6174 \write\tocfile{@
#1entry
{#2}{#3}{\lastnode}{\noexpand\folio}}}%
6180 % Tell \shipout to create a pdf destination on each page, if we're
6181 % writing pdf. These are used in the table of contents. We can't
6182 % just write one on every page because the title pages are numbered
6183 % 1 and 2 (the page numbers aren't printed), and so are the first
6184 % two pages of the document. Thus, we'd have two destinations named
6185 % `1', and two named `2'.
6186 \ifpdf \global\pdfmakepagedesttrue \fi
6190 % These characters do not print properly in the Computer Modern roman
6191 % fonts, so we must take special care. This is more or less redundant
6192 % with the Texinfo input format setup at the end of this file.
6194 \def\activecatcodes{%
6207 % Read the toc file, which is essentially Texinfo input.
6211 \input \tocreadfilename
6214 \newskip\contentsrightmargin \contentsrightmargin=
1in
6215 \newcount\savepageno
6216 \newcount\lastnegativepageno \lastnegativepageno = -
1
6218 % Prepare to read what we've written to \tocfile.
6220 \def\startcontents#1{%
6221 % If @setchapternewpage on, and @headings double, the contents should
6222 % start on an odd page, unlike chapters. Thus, we maintain
6223 % \contentsalignmacro in parallel with \pagealignmacro.
6224 % From: Torbjorn Granlund <tege@matematik.su.se>
6226 \immediate\closeout\tocfile
6228 % Don't need to put `Contents' or `Short Contents' in the headline.
6229 % It is abundantly clear what they are.
6230 \chapmacro{#1}{Yomitfromtoc
}{}%
6232 \savepageno =
\pageno
6233 \begingroup % Set up to handle contents files properly.
6234 \raggedbottom % Worry more about breakpoints than the bottom.
6235 \advance\hsize by -
\contentsrightmargin % Don't use the full line length.
6237 % Roman numerals for page numbers.
6238 \ifnum \pageno>
0 \global\pageno =
\lastnegativepageno \fi
6241 % redefined for the two-volume lispref. We always output on
6242 % \jobname.toc even if this is redefined.
6244 \def\tocreadfilename{\jobname.toc
}
6246 % Normal (long) toc.
6249 \startcontents{\putwordTOC}%
6250 \openin 1 \tocreadfilename\space
6255 \contentsalignmacro % in case @setchapternewpage odd is in effect
6261 \lastnegativepageno =
\pageno
6262 \global\pageno =
\savepageno
6265 % And just the chapters.
6266 \def\summarycontents{%
6267 \startcontents{\putwordShortTOC}%
6269 \let\partentry =
\shortpartentry
6270 \let\numchapentry =
\shortchapentry
6271 \let\appentry =
\shortchapentry
6272 \let\unnchapentry =
\shortunnchapentry
6273 % We want a true roman here for the page numbers.
6275 \let\rm=
\shortcontrm \let\bf=
\shortcontbf
6276 \let\sl=
\shortcontsl \let\tt=
\shortconttt
6278 \hyphenpenalty =
10000
6279 \advance\baselineskip by
1pt
% Open it up a little.
6280 \def\numsecentry#
#1#
#2#
#3#
#4{}
6281 \let\appsecentry =
\numsecentry
6282 \let\unnsecentry =
\numsecentry
6283 \let\numsubsecentry =
\numsecentry
6284 \let\appsubsecentry =
\numsecentry
6285 \let\unnsubsecentry =
\numsecentry
6286 \let\numsubsubsecentry =
\numsecentry
6287 \let\appsubsubsecentry =
\numsecentry
6288 \let\unnsubsubsecentry =
\numsecentry
6289 \openin 1 \tocreadfilename\space
6295 \contentsalignmacro % in case @setchapternewpage odd is in effect
6297 \lastnegativepageno =
\pageno
6298 \global\pageno =
\savepageno
6300 \let\shortcontents =
\summarycontents
6302 % Typeset the label for a chapter or appendix for the short contents.
6303 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6305 \def\shortchaplabel#1{%
6306 % This space should be enough, since a single number is .5em, and the
6307 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6308 % But use \hss just in case.
6309 % (This space doesn't include the extra space that gets added after
6310 % the label; that gets put in by \shortchapentry above.)
6312 % We'd like to right-justify chapter numbers, but that looks strange
6313 % with appendix letters. And right-justifying numbers and
6314 % left-justifying letters looks strange when there is less than 10
6315 % chapters. Have to read the whole toc once to know how many chapters
6316 % there are before deciding ...
6317 \hbox to
1em
{#1\hss}%
6320 % These macros generate individual entries in the table of contents.
6321 % The first argument is the chapter or section name.
6322 % The last argument is the page number.
6323 % The arguments in between are the chapter number, section number, ...
6325 % Parts, in the main contents. Replace the part number, which doesn't
6326 % exist, with an empty box. Let's hope all the numbers have the same width.
6327 % Also ignore the page number, which is conventionally not printed.
6328 \def\numeralbox{\setbox0=
\hbox{8}\hbox to
\wd0{\hfil}}
6329 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6331 % Parts, in the short toc.
6332 \def\shortpartentry#1#2#3#4{%
6334 \vskip.5\baselineskip plus
.15\baselineskip minus
.1\baselineskip
6335 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6338 % Chapters, in the main contents.
6339 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6341 % Chapters, in the short toc.
6342 % See comments in \dochapentry re vbox and related settings.
6343 \def\shortchapentry#1#2#3#4{%
6344 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6347 % Appendices, in the main contents.
6348 % Need the word Appendix, and a fixed-size box.
6350 \def\appendixbox#1{%
6351 % We use M since it's probably the widest letter.
6352 \setbox0 =
\hbox{\putwordAppendix{} M
}%
6353 \hbox to
\wd0{\putwordAppendix{} #1\hss}}
6355 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6357 % Unnumbered chapters.
6358 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6359 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6362 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6363 \let\appsecentry=
\numsecentry
6364 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6367 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6368 \let\appsubsecentry=
\numsubsecentry
6369 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6371 % And subsubsections.
6372 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6373 \let\appsubsubsecentry=
\numsubsubsecentry
6374 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6376 % This parameter controls the indentation of the various levels.
6377 % Same as \defaultparindent.
6378 \newdimen\tocindent \tocindent =
15pt
6380 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6383 % If the toc has to be broken over pages, we want it to be at chapters
6384 % if at all possible; hence the \penalty.
6385 \def\dochapentry#1#2{%
6386 \penalty-
300 \vskip1\baselineskip plus
.33\baselineskip minus
.25\baselineskip
6389 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6391 \nobreak\vskip .25\baselineskip plus
.1\baselineskip
6394 \def\dosecentry#1#2{\begingroup
6395 \secentryfonts \leftskip=
\tocindent
6396 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6399 \def\dosubsecentry#1#2{\begingroup
6400 \subsecentryfonts \leftskip=
2\tocindent
6401 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6404 \def\dosubsubsecentry#1#2{\begingroup
6405 \subsubsecentryfonts \leftskip=
3\tocindent
6406 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6409 % We use the same \entry macro as for the index entries.
6410 \let\tocentry =
\entry
6412 % Space between chapter (or whatever) number and the title.
6413 \def\labelspace{\hskip1em \relax}
6415 \def\dopageno#1{{\rm #1}}
6416 \def\doshortpageno#1{{\rm #1}}
6418 \def\chapentryfonts{\secfonts \rm}
6419 \def\secentryfonts{\textfonts}
6420 \def\subsecentryfonts{\textfonts}
6421 \def\subsubsecentryfonts{\textfonts}
6424 \message{environments,
}
6425 % @foo ... @end foo.
6427 % @tex ... @end tex escapes into raw TeX temporarily.
6428 % One exception: @ is still an escape character, so that @end tex works.
6429 % But \@ or @@ will get a plain @ character.
6432 \setupmarkupstyle{tex
}%
6433 \catcode `\\=
0 \catcode `\
{=
1 \catcode `\
}=
2
6434 \catcode `\$=
3 \catcode `\&=
4 \catcode `\#=
6
6435 \catcode `\^=
7 \catcode `
\_=
8 \catcode `\~=
\active \let~=
\tie
6446 % ' is active in math mode (mathcode"8000). So reset it, and all our
6447 % other math active characters (just in case), to plain's definitions.
6450 % Inverse of the list at the beginning of the file.
6452 \let\bullet=
\ptexbullet
6457 \let\equiv=
\ptexequiv
6460 \let\indent=
\ptexindent
6461 \let\noindent=
\ptexnoindent
6468 %\let\sup=\ptexsup % do not redefine, we want @sup to work in math mode
6470 \expandafter \let\csname top
\endcsname=
\ptextop % we've made it outer
6471 \let\frenchspacing=
\plainfrenchspacing
6473 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6474 \def\enddots{\relax\ifmmode\endldots\else$
\mathsurround=
0pt
\endldots\,$
\fi}%
6477 % There is no need to define \Etex.
6479 % Define @lisp ... @end lisp.
6480 % @lisp environment forms a group so it can rebind things,
6481 % including the definition of @end lisp (which normally is erroneous).
6483 % Amount to narrow the margins by for @lisp.
6484 \newskip\lispnarrowing \lispnarrowing=
0.4in
6486 % This is the definition that ^^M gets inside @lisp, @example, and other
6487 % such environments. \null is better than a space, since it doesn't
6489 \def\lisppar{\null\endgraf}
6491 % This space is always present above and below environments.
6492 \newskip\envskipamount \envskipamount =
0pt
6494 % Make spacing and below environment symmetrical. We use \parskip here
6495 % to help in doing that, since in @example-like environments \parskip
6496 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6497 % start of the next paragraph will insert \parskip.
6499 \def\aboveenvbreak{{%
6500 % =10000 instead of <10000 because of a special case in \itemzzz and
6501 % \sectionheading, q.v.
6502 \ifnum \lastpenalty=
10000 \else
6503 \advance\envskipamount by
\parskip
6505 \ifdim\lastskip<
\envskipamount
6507 % it's not a good place to break if the last penalty was \nobreak
6509 \ifnum\lastpenalty<
10000 \penalty-
50 \fi
6510 \vskip\envskipamount
6515 \let\afterenvbreak =
\aboveenvbreak
6517 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6518 % also clear it, so that its embedded environments do the narrowing again.
6519 \let\nonarrowing=
\relax
6521 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6522 % environment contents.
6523 \font\circle=lcircle10
6525 \newdimen\cartouter\newdimen\cartinner
6526 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6527 \circthick=
\fontdimen8\circle
6529 \def\ctl{{\circle\char'
013\hskip -
6pt
}}% 6pt from pl file: 1/2charwidth
6530 \def\ctr{{\hskip 6pt
\circle\char'
010}}
6531 \def\cbl{{\circle\char'
012\hskip -
6pt
}}
6532 \def\cbr{{\hskip 6pt
\circle\char'
011}}
6533 \def\carttop{\hbox to
\cartouter{\hskip\lskip
6534 \ctl\leaders\hrule height
\circthick\hfil\ctr
6536 \def\cartbot{\hbox to
\cartouter{\hskip\lskip
6537 \cbl\leaders\hrule height
\circthick\hfil\cbr
6540 \newskip\lskip\newskip\rskip
6543 \ifhmode\par\fi % can't be in the midst of a paragraph.
6545 \lskip=
\leftskip \rskip=
\rightskip
6546 \leftskip=
0pt
\rightskip=
0pt
% we want these *outside*.
6547 \cartinner=
\hsize \advance\cartinner by-
\lskip
6548 \advance\cartinner by-
\rskip
6550 \advance\cartouter by
18.4pt
% allow for 3pt kerns on either
6551 % side, and for 6pt waste from
6552 % each corner char, and rule thickness
6553 \normbskip=
\baselineskip \normpskip=
\parskip \normlskip=
\lineskip
6555 % If this cartouche directly follows a sectioning command, we need the
6556 % \parskip glue (backspaced over by default) or the cartouche can
6557 % collide with the section heading.
6558 \ifnum\lastpenalty>
10000 \vskip\parskip \penalty\lastpenalty \fi
6561 \baselineskip=
0pt
\parskip=
0pt
\lineskip=
0pt
6569 \baselineskip=
\normbskip
6570 \lineskip=
\normlskip
6573 \comment % For explanation, see the end of def\group.
6588 % This macro is called at the beginning of all the @example variants,
6590 \newdimen\nonfillparindent
6593 \ifdim\hfuzz <
12pt
\hfuzz =
12pt
\fi % Don't be fussy
6594 \sepspaces % Make spaces be word-separators rather than space tokens.
6595 \let\par =
\lisppar % don't ignore blank lines
6596 \obeylines % each line of input is a line of output
6598 % Turn off paragraph indentation but redefine \indent to emulate
6599 % the normal \indent.
6600 \nonfillparindent=
\parindent
6602 \let\indent\nonfillindent
6604 \emergencystretch =
0pt
% don't try to avoid overfull boxes
6605 \ifx\nonarrowing\relax
6606 \advance \leftskip by
\lispnarrowing
6607 \exdentamount=
\lispnarrowing
6609 \let\nonarrowing =
\relax
6611 \let\exdent=
\nofillexdent
6616 % We want to swallow spaces (but not other tokens) after the fake
6617 % @indent in our nonfill-environments, where spaces are normally
6618 % active and set to @tie, resulting in them not being ignored after
6620 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6621 \gdef\nonfillindentcheck{%
6623 \expandafter\nonfillindentgobble%
6625 \leavevmode\nonfillindentbox%
6629 \def\nonfillindentgobble#1{\nonfillindent}
6630 \def\nonfillindentbox{\hbox to
\nonfillparindent{\hss}}
6632 % If you want all examples etc. small: @set dispenvsize small.
6633 % If you want even small examples the full size: @set dispenvsize nosmall.
6634 % This affects the following displayed environments:
6635 % @example, @display, @format, @lisp
6637 \def\smallword{small
}
6638 \def\nosmallword{nosmall
}
6639 \let\SETdispenvsize\relax
6640 \def\setnormaldispenv{%
6641 \ifx\SETdispenvsize\smallword
6642 % end paragraph for sake of leading, in case document has no blank
6643 % line. This is redundant with what happens in \aboveenvbreak, but
6644 % we need to do it before changing the fonts, and it's inconvenient
6645 % to change the fonts afterward.
6646 \ifnum \lastpenalty=
10000 \else \endgraf \fi
6647 \smallexamplefonts \rm
6650 \def\setsmalldispenv{%
6651 \ifx\SETdispenvsize\nosmallword
6653 \ifnum \lastpenalty=
10000 \else \endgraf \fi
6654 \smallexamplefonts \rm
6658 % We often define two environments, @foo and @smallfoo.
6659 % Let's do it in one command. #1 is the env name, #2 the definition.
6660 \def\makedispenvdef#1#2{%
6661 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6662 \expandafter\envdef\csname small
#1\endcsname {\setsmalldispenv #2}%
6663 \expandafter\let\csname E
#1\endcsname \afterenvbreak
6664 \expandafter\let\csname Esmall
#1\endcsname \afterenvbreak
6667 % Define two environment synonyms (#1 and #2) for an environment.
6668 \def\maketwodispenvdef#1#2#3{%
6669 \makedispenvdef{#1}{#3}%
6670 \makedispenvdef{#2}{#3}%
6673 % @lisp: indented, narrowed, typewriter font;
6674 % @example: same as @lisp.
6676 % @smallexample and @smalllisp: use smaller fonts.
6677 % Originally contributed by Pavel@xerox.
6679 \maketwodispenvdef{lisp
}{example
}{%
6681 \tt\setupmarkupstyle{example
}%
6682 \let\kbdfont =
\kbdexamplefont % Allow @kbd to do something special.
6683 \gobble % eat return
6685 % @display/@smalldisplay: same as @lisp except keep current font.
6687 \makedispenvdef{display
}{%
6692 % @format/@smallformat: same as @display except don't narrow margins.
6694 \makedispenvdef{format
}{%
6695 \let\nonarrowing = t
%
6700 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6702 \let\nonarrowing = t
%
6706 \let\Eflushleft =
\afterenvbreak
6710 \envdef\flushright{%
6711 \let\nonarrowing = t
%
6713 \advance\leftskip by
0pt plus
1fill
\relax
6716 \let\Eflushright =
\afterenvbreak
6719 % @raggedright does more-or-less normal line breaking but no right
6720 % justification. From plain.tex. Don't stretch around special
6721 % characters in urls in this environment, since the stretch at the right
6723 \envdef\raggedright{%
6724 \rightskip0pt plus2.4em
\spaceskip.3333em
\xspaceskip.5em
\relax
6725 \def\urefprestretchamount{0pt
}%
6726 \def\urefpoststretchamount{0pt
}%
6728 \let\Eraggedright\par
6730 \envdef\raggedleft{%
6731 \parindent=
0pt
\leftskip0pt plus2em
6732 \spaceskip.3333em
\xspaceskip.5em
\parfillskip=
0pt
6733 \hbadness=
10000 % Last line will usually be underfull, so turn off
6734 % badness reporting.
6736 \let\Eraggedleft\par
6738 \envdef\raggedcenter{%
6739 \parindent=
0pt
\rightskip0pt plus1em
\leftskip0pt plus1em
6740 \spaceskip.3333em
\xspaceskip.5em
\parfillskip=
0pt
6741 \hbadness=
10000 % Last line will usually be underfull, so turn off
6742 % badness reporting.
6744 \let\Eraggedcenter\par
6747 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6748 % and narrows the margins. We keep \parskip nonzero in general, since
6749 % we're doing normal filling. So, when using \aboveenvbreak and
6750 % \afterenvbreak, temporarily make \parskip 0.
6752 \makedispenvdef{quotation
}{\quotationstart}
6754 \def\quotationstart{%
6755 \indentedblockstart % same as \indentedblock, but increase right margin too.
6756 \ifx\nonarrowing\relax
6757 \advance\rightskip by
\lispnarrowing
6759 \parsearg\quotationlabel
6762 % We have retained a nonzero parskip for the environment, since we're
6763 % doing normal filling.
6767 \ifx\quotationauthor\thisisundefined\else
6769 \leftline{\kern 2\leftskip \sl ---
\quotationauthor}%
6771 {\parskip=
0pt
\afterenvbreak}%
6773 \def\Esmallquotation{\Equotation}
6775 % If we're given an argument, typeset it in bold with a colon after.
6776 \def\quotationlabel#1{%
6778 \ifx\temp\empty \else
6783 % @indentedblock is like @quotation, but indents only on the left and
6784 % has no optional argument.
6786 \makedispenvdef{indentedblock
}{\indentedblockstart}
6788 \def\indentedblockstart{%
6789 {\parskip=
0pt
\aboveenvbreak}% because \aboveenvbreak inserts \parskip
6792 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6793 \ifx\nonarrowing\relax
6794 \advance\leftskip by
\lispnarrowing
6795 \exdentamount =
\lispnarrowing
6797 \let\nonarrowing =
\relax
6801 % Keep a nonzero parskip for the environment, since we're doing normal filling.
6803 \def\Eindentedblock{%
6805 {\parskip=
0pt
\afterenvbreak}%
6807 \def\Esmallindentedblock{\Eindentedblock}
6810 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6811 % If we want to allow any <char> as delimiter,
6812 % we need the curly braces so that makeinfo sees the @verb command, eg:
6813 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6815 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6817 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6818 % active too. Otherwise, they get lost as the first character on a
6821 \do\
\do\\
\do\
{\do\
}\do\$
\do\&
%
6822 \do\#
\do\^
\do\^^K
\do\_\do\^^A
\do\%
\do\~
%
6823 \do\<
\do\>
\do\|
\do\@
\do+
\do\"
%
6824 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6825 % @set txicodequotebacktick will not have effect on @verb and
6826 % @verbatim, and ?` and !` ligatures won't get disabled.
6831 \def\uncatcodespecials{%
6832 \def\do#
#1{\catcode`#
#1=
\other}\dospecials}
6834 % Setup for the @verb command.
6836 % Eight spaces for a tab
6838 \catcode`\^^I=
\active
6839 \gdef\tabeightspaces{\catcode`\^^I=
\active\def^^I
{\ \ \ \ \ \ \ \
}}
6843 \tt % easiest (and conventionally used) font for verbatim
6844 \def\par{\leavevmode\endgraf}%
6845 \setupmarkupstyle{verb
}%
6847 % Respect line breaks,
6848 % print special symbols as themselves, and
6849 % make each space count
6850 % must do in this order:
6851 \obeylines \uncatcodespecials \sepspaces
6854 % Setup for the @verbatim environment
6856 % Real tab expansion.
6857 \newdimen\tabw \setbox0=
\hbox{\tt\space} \tabw=
8\wd0 % tab amount
6859 % We typeset each line of the verbatim in an \hbox, so we can handle
6860 % tabs. The \global is in case the verbatim line starts with an accent,
6861 % or some other command that starts with a begin-group. Otherwise, the
6862 % entire \verbbox would disappear at the corresponding end-group, before
6863 % it is typeset. Meanwhile, we can't have nested verbatim commands
6864 % (can we?), so the \global won't be overwriting itself.
6866 \def\starttabbox{\global\setbox\verbbox=
\hbox\bgroup}
6869 \catcode`\^^I=
\active
6871 \catcode`\^^I=
\active
6872 \def^^I
{\leavevmode\egroup
6873 \dimen\verbbox=
\wd\verbbox % the width so far, or since the previous tab
6874 \divide\dimen\verbbox by
\tabw
6875 \multiply\dimen\verbbox by
\tabw % compute previous multiple of \tabw
6876 \advance\dimen\verbbox by
\tabw % advance to next multiple of \tabw
6877 \wd\verbbox=
\dimen\verbbox \box\verbbox \starttabbox
6882 % start the verbatim environment.
6883 \def\setupverbatim{%
6884 \let\nonarrowing = t
%
6886 \tt % easiest (and conventionally used) font for verbatim
6887 % The \leavevmode here is for blank lines. Otherwise, we would
6888 % never \starttabox and the \egroup would end verbatim mode.
6889 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6891 \setupmarkupstyle{verbatim
}%
6892 % Respect line breaks,
6893 % print special symbols as themselves, and
6894 % make each space count.
6895 % Must do in this order:
6896 \obeylines \uncatcodespecials \sepspaces
6897 \everypar{\starttabbox}%
6900 % Do the @verb magic: verbatim text is quoted by unique
6901 % delimiter characters. Before first delimiter expect a
6902 % right brace, after last delimiter expect closing brace:
6904 % \def\doverb'{'<char>#1<char>'}'{#1}
6906 % [Knuth] p. 382; only eat outer {}
6908 \catcode`
[=
1\catcode`
]=
2\catcode`\
{=
\other\catcode`\
}=
\other
6909 \gdef\doverb{#1[\def\next#
#1#1}[#
#1\endgroup]\next]
6912 \def\verb{\begingroup\setupverb\doverb}
6915 % Do the @verbatim magic: define the macro \doverbatim so that
6916 % the (first) argument ends when '@end verbatim' is reached, ie:
6918 % \def\doverbatim#1@end verbatim{#1}
6920 % For Texinfo it's a lot easier than for LaTeX,
6921 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6922 % we need not redefine '\', '{' and '}'.
6924 % Inspired by LaTeX's verbatim command set [latex.ltx]
6929 % ignore everything up to the first ^^M, that's the newline at the end
6930 % of the @verbatim input line itself. Otherwise we get an extra blank
6931 % line in the output.
6932 \xdef\doverbatim#1^^M
#2@end verbatim
{#2\noexpand\end\gobble verbatim
}%
6933 % We really want {...\end verbatim} in the body of the macro, but
6934 % without the active space; thus we have to use \xdef and \gobble.
6938 \setupverbatim\doverbatim
6940 \let\Everbatim =
\afterenvbreak
6943 % @verbatiminclude FILE - insert text of file in verbatim environment.
6945 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6947 \def\doverbatiminclude#1{%
6949 \makevalueexpandable
6951 \indexnofonts % Allow `@@' and other weird things in file names.
6952 \wlog{texinfo.tex: doing @verbatiminclude of
#1^^J
}%
6958 % @copying ... @end copying.
6959 % Save the text away for @insertcopying later.
6961 % We save the uninterpreted tokens, rather than creating a box.
6962 % Saving the text in a box would be much easier, but then all the
6963 % typesetting commands (@smallbook, font changes, etc.) have to be done
6964 % beforehand -- and a) we want @copying to be done first in the source
6965 % file; b) letting users define the frontmatter in as flexible order as
6966 % possible is desirable.
6968 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6969 \def\docopying#1@end copying
{\endgroup\def\copyingtext{#1}}
6971 \def\insertcopying{%
6973 \parindent =
0pt
% paragraph indentation looks wrong on title page
6974 \scanexp\copyingtext
6982 \newskip\defbodyindent \defbodyindent=
.4in
6983 \newskip\defargsindent \defargsindent=
50pt
6984 \newskip\deflastargmargin \deflastargmargin=
18pt
6985 \newcount\defunpenalty
6987 % Start the processing of @deffn:
6989 \ifnum\lastpenalty<
10000
6991 \defunpenalty=
10003 % Will keep this @deffn together with the
6992 % following @def command, see below.
6994 % If there are two @def commands in a row, we'll have a \nobreak,
6995 % which is there to keep the function description together with its
6996 % header. But if there's nothing but headers, we need to allow a
6997 % break somewhere. Check specifically for penalty 10002, inserted
6998 % by \printdefunline, instead of 10000, since the sectioning
6999 % commands also insert a nobreak penalty, and we don't want to allow
7000 % a break between a section heading and a defun.
7002 % As a further refinement, we avoid "club" headers by signalling
7003 % with penalty of 10003 after the very first @deffn in the
7004 % sequence (see above), and penalty of 10002 after any following
7006 \ifnum\lastpenalty=
10002 \penalty2000 \else \defunpenalty=
10002 \fi
7008 % Similarly, after a section heading, do not allow a break.
7009 % But do insert the glue.
7010 \medskip % preceded by discardable penalty, so not a breakpoint
7014 \advance\leftskip by
\defbodyindent
7015 \exdentamount=
\defbodyindent
7019 % First, check whether we are in the right environment:
7022 % As above, allow line break if we have multiple x headers in a row.
7023 % It's not a great place, though.
7024 \ifnum\lastpenalty=
10002 \penalty3000 \else \defunpenalty=
10002 \fi
7026 % And now, it's time to reuse the body of the original defun:
7027 \expandafter\gobbledefun#1%
7029 \def\gobbledefun#1\startdefun{}
7031 % \printdefunline \deffnheader{text}
7033 \def\printdefunline#1#2{%
7035 % call \deffnheader:
7038 \interlinepenalty =
10000
7039 \advance\rightskip by
0pt plus
1fil
\relax
7041 \nobreak\vskip -
\parskip
7042 \penalty\defunpenalty % signal to \startdefun and \dodefunx
7043 % Some of the @defun-type tags do not enable magic parentheses,
7044 % rendering the following check redundant. But we don't optimize.
7049 \def\Edefun{\endgraf\medbreak}
7051 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
7052 % the only thing remaining is to define \deffnheader.
7055 \expandafter\let\csname E
#1\endcsname =
\Edefun
7056 \edef\temp{\noexpand\domakedefun
7057 \makecsname{#1}\makecsname{#1x
}\makecsname{#1header
}}%
7061 % \domakedefun \deffn \deffnx \deffnheader
7063 % Define \deffn and \deffnx, without parameters.
7064 % \deffnheader has to be defined explicitly.
7066 \def\domakedefun#1#2#3{%
7069 \doingtypefnfalse % distinguish typed functions from all else
7070 \parseargusing\activeparens{\printdefunline#3}%
7072 \def#2{\dodefunx#1}%
7076 \newif\ifdoingtypefn % doing typed function?
7077 \newif\ifrettypeownline % typeset return type on its own line?
7079 % @deftypefnnewline on|off says whether the return type of typed functions
7080 % are printed on their own line. This affects @deftypefn, @deftypefun,
7081 % @deftypeop, and @deftypemethod.
7083 \parseargdef\deftypefnnewline{%
7086 \expandafter\let\csname SETtxideftypefnnl
\endcsname
7088 \else\ifx\temp\offword
7089 \expandafter\let\csname SETtxideftypefnnl
\endcsname
7092 \errhelp =
\EMsimple
7093 \errmessage{Unknown @txideftypefnnl value `
\temp',
7098 % Untyped functions:
7100 % @deffn category name args
7101 \makedefun{deffn
}{\deffngeneral{}}
7103 % @deffn category class name args
7104 \makedefun{defop
}#1 {\defopon{#1\
\putwordon}}
7106 % \defopon {category on}class name args
7107 \def\defopon#1#2 {\deffngeneral{\putwordon\
\code{#2}}{#1\
\code{#2}} }
7109 % \deffngeneral {subind}category name args
7111 \def\deffngeneral#1#2 #3 #4\endheader{%
7112 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
7113 \dosubind{fn
}{\code{#3}}{#1}%
7114 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
7119 % @deftypefn category type name args
7120 \makedefun{deftypefn
}{\deftypefngeneral{}}
7122 % @deftypeop category class type name args
7123 \makedefun{deftypeop
}#1 {\deftypeopon{#1\
\putwordon}}
7125 % \deftypeopon {category on}class type name args
7126 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\
\code{#2}}{#1\
\code{#2}} }
7128 % \deftypefngeneral {subind}category type name args
7130 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
7131 \dosubind{fn
}{\code{#4}}{#1}%
7133 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7138 % @deftypevr category type var args
7139 \makedefun{deftypevr
}{\deftypecvgeneral{}}
7141 % @deftypecv category class type var args
7142 \makedefun{deftypecv
}#1 {\deftypecvof{#1\
\putwordof}}
7144 % \deftypecvof {category of}class type var args
7145 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\
\code{#2}}{#1\
\code{#2}} }
7147 % \deftypecvgeneral {subind}category type var args
7149 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
7150 \dosubind{vr
}{\code{#4}}{#1}%
7151 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7154 % Untyped variables:
7156 % @defvr category var args
7157 \makedefun{defvr
}#1 {\deftypevrheader{#1} {} }
7159 % @defcv category class var args
7160 \makedefun{defcv
}#1 {\defcvof{#1\
\putwordof}}
7162 % \defcvof {category of}class var args
7163 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
7167 % @deftp category name args
7168 \makedefun{deftp
}#1 #2 #3\endheader{%
7169 \doind{tp
}{\code{#2}}%
7170 \defname{#1}{}{#2}\defunargs{#3\unskip}%
7173 % Remaining @defun-like shortcuts:
7174 \makedefun{defun
}{\deffnheader{\putwordDeffunc} }
7175 \makedefun{defmac
}{\deffnheader{\putwordDefmac} }
7176 \makedefun{defspec
}{\deffnheader{\putwordDefspec} }
7177 \makedefun{deftypefun
}{\deftypefnheader{\putwordDeffunc} }
7178 \makedefun{defvar
}{\defvrheader{\putwordDefvar} }
7179 \makedefun{defopt
}{\defvrheader{\putwordDefopt} }
7180 \makedefun{deftypevar
}{\deftypevrheader{\putwordDefvar} }
7181 \makedefun{defmethod
}{\defopon\putwordMethodon}
7182 \makedefun{deftypemethod
}{\deftypeopon\putwordMethodon}
7183 \makedefun{defivar
}{\defcvof\putwordInstanceVariableof}
7184 \makedefun{deftypeivar
}{\deftypecvof\putwordInstanceVariableof}
7186 % \defname, which formats the name of the @def (not the args).
7187 % #1 is the category, such as "Function".
7188 % #2 is the return type, if any.
7189 % #3 is the function name.
7191 % We are followed by (but not passed) the arguments, if any.
7193 \def\defname#1#2#3{%
7195 % Get the values of \leftskip and \rightskip as they were outside the @def...
7196 \advance\leftskip by -
\defbodyindent
7198 % Determine if we are typesetting the return type of a typed function
7199 % on a line by itself.
7200 \rettypeownlinefalse
7201 \ifdoingtypefn % doing a typed function specifically?
7202 % then check user option for putting return type on its own line:
7203 \expandafter\ifx\csname SETtxideftypefnnl
\endcsname\relax \else
7208 % How we'll format the category name. Putting it in brackets helps
7209 % distinguish it from the body text that may end up on the next line
7212 \setbox0=
\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7214 % Figure out line sizes for the paragraph shape. We'll always have at
7218 % The first line needs space for \box0; but if \rightskip is nonzero,
7219 % we need only space for the part of \box0 which exceeds it:
7220 \dimen0=
\hsize \advance\dimen0 by -
\wd0 \advance\dimen0 by
\rightskip
7222 % If doing a return type on its own line, we'll have another line.
7224 \advance\tempnum by
1
7225 \def\maybeshapeline{0in
\hsize}%
7227 \def\maybeshapeline{}%
7230 % The continuations:
7231 \dimen2=
\hsize \advance\dimen2 by -
\defargsindent
7233 % The final paragraph shape:
7234 \parshape \tempnum 0in
\dimen0 \maybeshapeline \defargsindent \dimen2
7236 % Put the category name at the right margin.
7239 \hfil\box0 \kern-
\hsize
7240 % \hsize has to be shortened this way:
7242 % Intentionally do not respect \rightskip, since we need the space.
7245 % Allow all lines to be underfull without complaint:
7246 \tolerance=
10000 \hbadness=
10000
7247 \exdentamount=
\defbodyindent
7249 % defun fonts. We use typewriter by default (used to be bold) because:
7250 % . we're printing identifiers, they should be in tt in principle.
7251 % . in languages with many accents, such as Czech or French, it's
7252 % common to leave accents off identifiers. The result looks ok in
7253 % tt, but exceedingly strange in rm.
7254 % . we don't want -- and --- to be treated as ligatures.
7255 % . this still does not fix the ?` and !` ligatures, but so far no
7256 % one has made identifiers using them :).
7258 \def\temp{#2}% text of the return type
7259 \ifx\temp\empty\else
7260 \tclose{\temp}% typeset the return type
7262 % put return type on its own line; prohibit line break following:
7263 \hfil\vadjust{\nobreak}\break
7265 \space % type on same line, so just followed by a space
7267 \fi % no return type
7268 #3% output function name
7270 {\rm\enskip}% hskip 0.5 em of \tenrm
7273 % arguments will be output next, if any.
7276 % Print arguments in slanted roman (not ttsl), inconsistently with using
7277 % tt for the name. This is because literal text is sometimes needed in
7278 % the argument list (groff manual), and ttsl and tt are not very
7279 % distinguishable. Prevent hyphenation at `-' chars.
7282 % use sl by default (not ttsl),
7284 \df \sl \hyphenchar\font=
0
7286 % On the other hand, if an argument has two dashes (for instance), we
7287 % want a way to get ttsl. We used to recommend @var for that, so
7288 % leave the code in, but it's strange for @var to lead to typewriter.
7289 % Nowadays we recommend @code, since the difference between a ttsl hyphen
7290 % and a tt hyphen is pretty tiny. @code also disables ?` !`.
7291 \def\var#
#1{{\setupmarkupstyle{var
}\ttslanted{#
#1}}}%
7293 \sl\hyphenchar\font=
45
7296 % We want ()&[] to print specially on the defun line.
7299 \catcode`\(=
\active \catcode`\)=
\active
7300 \catcode`\
[=
\active \catcode`\
]=
\active
7304 % Make control sequences which act like normal parenthesis chars.
7305 \let\lparen = (
\let\rparen = )
7307 % Be sure that we always have a definition for `(', etc. For example,
7308 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7309 % so TeX would otherwise complain about undefined control sequence.
7312 \global\let(=
\lparen \global\let)=
\rparen
7313 \global\let[=
\lbrack \global\let]=
\rbrack
7316 \gdef\boldbrax{\let(=
\opnr\let)=
\clnr\let[=
\lbrb\let]=
\rbrb}
7317 \gdef\magicamp{\let&=
\amprm}
7320 \newcount\parencount
7322 % If we encounter &foo, then turn on ()-hacking afterwards
7324 \def\amprm#1 {\ampseentrue{\bf\&
#1 }}
7328 % At the first level, print parens in roman,
7329 % otherwise use the default font.
7330 \ifnum \parencount=
1 \rm \fi
7332 % The \sf parens (in \boldbrax) actually are a little bolder than
7333 % the contained text. This is especially needed for [ and ] .
7337 \def\infirstlevel#1{%
7344 \def\bfafterword#1 {#1 \bf}
7347 \global\advance\parencount by
1
7349 \infirstlevel \bfafterword
7354 \global\advance\parencount by -
1
7357 \newcount\brackcount
7359 \global\advance\brackcount by
1
7364 \global\advance\brackcount by -
1
7367 \def\checkparencounts{%
7368 \ifnum\parencount=
0 \else \badparencount \fi
7369 \ifnum\brackcount=
0 \else \badbrackcount \fi
7371 % these should not use \errmessage; the glibc manual, at least, actually
7372 % has such constructs (when documenting function pointers).
7373 \def\badparencount{%
7374 \message{Warning: unbalanced parentheses in @def...
}%
7375 \global\parencount=
0
7377 \def\badbrackcount{%
7378 \message{Warning: unbalanced square brackets in @def...
}%
7379 \global\brackcount=
0
7386 % To do this right we need a feature of e-TeX, \scantokens,
7387 % which we arrange to emulate with a temporary file in ordinary TeX.
7388 \ifx\eTeXversion\thisisundefined
7389 \newwrite\macscribble
7392 \immediate\openout\macscribble=
\jobname.tmp
7393 \immediate\write\macscribble{\the\toks0}%
7394 \immediate\closeout\macscribble
7399 \let\aftermacroxxx\relax
7400 \def\aftermacro{\aftermacroxxx}
7402 % alias because \c means cedilla in @tex or @math
7405 % Used at the time of macro expansion.
7406 % Argument is macro body with arguments substituted
7409 \let\xeatspaces\eatspaces
7411 % Process the macro body under the current catcode regime.
7412 \scantokens{#1\texinfoc}\aftermacro%
7414 % The \c is to remove the \newlinechar added by \scantokens, and
7415 % can be noticed by \parsearg.
7416 % The \aftermacro allows a \comment at the end of the macro definition
7417 % to duplicate itself past the final \newlinechar added by \scantokens:
7418 % this is used in the definition of \group to comment out a newline. We
7419 % don't do the same for \c to support Texinfo files with macros that ended
7420 % with a @c, which should no longer be necessary.
7421 % We avoid surrounding the call to \scantokens with \bgroup and \egroup
7422 % to allow macros to open or close groups themselves.
7427 % Undo catcode changes of \startcontents and \printindex
7428 % When called from @insertcopying or (short)caption, we need active
7429 % backslash to get it printed correctly.
7430 % FIXME: This may not be needed.
7431 %\catcode`\@=0 \catcode`\\=\active \escapechar=`\@
7432 \edef\temp{\noexpand\scanmacro{#1}}%
7437 \newcount\paramno % Count of parameters
7438 \newtoks\macname % Macro name
7439 \newif\ifrecursive % Is it recursive?
7441 % List of all defined macros in the form
7442 % \definedummyword\macro1\definedummyword\macro2...
7443 % Currently is also contains all @aliases; the list can be split
7444 % if there is a need.
7447 % Add the macro to \macrolist
7448 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7449 \def\addtomacrolistxxx#1{%
7450 \toks0 =
\expandafter{\macrolist\definedummyword#1}%
7451 \xdef\macrolist{\the\toks0}%
7455 % This does \let #1 = #2, with \csnames; that is,
7456 % \let \csname#1\endcsname = \csname#2\endcsname
7457 % (except of course we have to play expansion games).
7461 \csname#1\expandafter\endcsname
7465 % Trim leading and trailing spaces off a string.
7466 % Concepts from aro-bend problem 15 (see CTAN).
7468 \gdef\eatspaces #1{\expandafter\trim@
\expandafter{#1 }}
7469 \gdef\trim@
#1{\trim@@ @
#1 @
#1 @ @@
}
7470 \gdef\trim@@
#1@
#2@
#3@@
{\trim@@@
\empty #2 @
}
7472 \unbrace{\gdef\trim@@@
#1 } #2@
{#1}
7475 % Trim a single trailing ^^M off a string.
7476 {\catcode`\^^M=
\other \catcode`
\Q=
3%
7477 \gdef\eatcr #1{\eatcra #1Q^^MQ
}%
7478 \gdef\eatcra#1^^MQ
{\eatcrb#1Q
}%
7479 \gdef\eatcrb#1Q
#2Q
{#1}%
7482 % Macro bodies are absorbed as an argument in a context where
7483 % all characters are catcode 10, 11 or 12, except \ which is active
7484 % (as in normal texinfo). It is necessary to change the definition of \
7485 % to recognize macro arguments; this is the job of \mbodybackslash.
7487 % Non-ASCII encodings make 8-bit characters active, so un-activate
7488 % them to avoid their expansion. Must do this non-globally, to
7489 % confine the change to the current group.
7491 % It's necessary to have hard CRs when the macro is executed. This is
7492 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7493 % body, and then making it the \newlinechar in \scanmacro.
7495 \def\scanctxt{% used as subroutine
7504 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7507 \def\scanargctxt{% used for copying and captions, not macros.
7511 \catcode`\^^M=
\other
7514 \def\macrobodyctxt{% used for @macro definitions
7520 \catcode`\^^M=
\other
7524 % Used when scanning braced macro arguments. Note, however, that catcode
7525 % changes here are ineffectual if the macro invocation was nested inside
7526 % an argument to another Texinfo command.
7532 \def\macrolineargctxt{% used for whole-line arguments without braces
7538 % \mbodybackslash is the definition of \ in @macro bodies.
7539 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7540 % where N is the macro parameter number.
7541 % We define \csname macarg.\endcsname to be \realbackslash, so
7542 % \\ in macro replacement text gets you a backslash.
7544 {\catcode`@=
0 @catcode`@\=@active
7545 @gdef@usembodybackslash
{@let\=@mbodybackslash
}
7546 @gdef@mbodybackslash
#1\
{@csname macarg.
#1@endcsname
}
7548 \expandafter\def\csname macarg.
\endcsname{\realbackslash}
7550 \def\margbackslash#1{\char`\
#1 }
7552 \def\macro{\recursivefalse\parsearg\macroxxx}
7553 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7556 \getargs{#1}% now \macname is the macname and \argl the arglist
7557 \ifx\argl\empty % no arguments
7560 \expandafter\parsemargdef \argl;
%
7561 \if\paramno>
256\relax
7562 \ifx\eTeXversion\thisisundefined
7563 \errhelp =
\EMsimple
7564 \errmessage{You need eTeX to compile a file with macros with more than
256 arguments
}
7568 \if1\csname ismacro.
\the\macname\endcsname
7569 \message{Warning: redefining
\the\macname}%
7571 \expandafter\ifx\csname \the\macname\endcsname \relax
7572 \else \errmessage{Macro name
\the\macname\space already defined
}\fi
7573 \global\cslet{macsave.
\the\macname}{\the\macname}%
7574 \global\expandafter\let\csname ismacro.
\the\macname\endcsname=
1%
7575 \addtomacrolist{\the\macname}%
7577 \begingroup \macrobodyctxt
7578 \ifrecursive \expandafter\parsermacbody
7579 \else \expandafter\parsemacbody
7582 \parseargdef\unmacro{%
7583 \if1\csname ismacro.
#1\endcsname
7584 \global\cslet{#1}{macsave.
#1}%
7585 \global\expandafter\let \csname ismacro.
#1\endcsname=
0%
7586 % Remove the macro name from \macrolist:
7588 \expandafter\let\csname#1\endcsname \relax
7589 \let\definedummyword\unmacrodo
7590 \xdef\macrolist{\macrolist}%
7593 \errmessage{Macro
#1 not defined
}%
7597 % Called by \do from \dounmacro on each macro. The idea is to omit any
7598 % macro definitions that have been changed to \relax.
7604 \noexpand\definedummyword \noexpand#1%
7608 % This makes use of the obscure feature that if the last token of a
7609 % <parameter list> is #, then the preceding argument is delimited by
7610 % an opening brace, and that opening brace is not consumed.
7612 \def\getargs#1{\getargsxxx#1{}}
7613 \def\getargsxxx#1#
{\getmacname #1 \relax\getmacargs}
7614 \def\getmacname#1 #2\relax{\macname=
{#1}}
7615 \def\getmacargs#1{\def\argl{#1}}
7617 % For macro processing make @ a letter so that we can make
7618 % private-to-Texinfo macro names.
7619 \edef\texiatcatcode{\the\catcode`\@
}
7620 \catcode `@=
11\relax
7622 % Parse the optional {params} list. Set up \paramno and \paramlist
7623 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
7624 % in the params list to some hook where the argument is to be expanded. If
7625 % there are less than 10 arguments that hook is to be replaced by ##N where N
7626 % is the position in that list, that is to say the macro arguments are to be
7627 % defined `a la TeX in the macro body.
7629 % That gets used by \mbodybackslash (above).
7631 % We need to get `macro parameter char #' into several definitions.
7632 % The technique used is stolen from LaTeX: let \hash be something
7633 % unexpandable, insert that wherever you need a #, and then redefine
7634 % it to # just before using the token list produced.
7636 % The same technique is used to protect \eatspaces till just before
7637 % the macro is used.
7639 % If there are 10 or more arguments, a different technique is used, where the
7640 % hook remains in the body, and when macro is to be expanded the body is
7641 % processed again to replace the arguments.
7643 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7644 % argument N value and then \edef the body (nothing else will expand because of
7645 % the catcode regime underwhich the body was input).
7647 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7648 % arguments, no macro can have more than 256 arguments (else error).
7650 \def\parsemargdef#1;
{%
7651 \paramno=
0\def\paramlist{}%
7653 \let\xeatspaces\relax
7654 \parsemargdefxxx#1,;,
%
7655 % In case that there are 10 or more arguments we parse again the arguments
7656 % list to set new definitions for the \macarg.BLAH macros corresponding to
7657 % each BLAH argument. It was anyhow needed to parse already once this list
7658 % in order to count the arguments, and as macros with at most 9 arguments
7659 % are by far more frequent than macro with 10 or more arguments, defining
7660 % twice the \macarg.BLAH macros does not cost too much processing power.
7661 \ifnum\paramno<
10\relax\else
7663 \parsemmanyargdef@@
#1,;,
% 10 or more arguments
7666 \def\parsemargdefxxx#1,
{%
7667 \if#1;
\let\next=
\relax
7668 \else \let\next=
\parsemargdefxxx
7669 \advance\paramno by
1
7670 \expandafter\edef\csname macarg.
\eatspaces{#1}\endcsname
7671 {\xeatspaces{\hash\the\paramno}}%
7672 \edef\paramlist{\paramlist\hash\the\paramno,
}%
7675 \def\parsemmanyargdef@@
#1,
{%
7676 \if#1;
\let\next=
\relax
7678 \let\next=
\parsemmanyargdef@@
7679 \edef\tempb{\eatspaces{#1}}%
7680 \expandafter\def\expandafter\tempa
7681 \expandafter{\csname macarg.
\tempb\endcsname}%
7682 % Note that we need some extra \noexpand\noexpand, this is because we
7683 % don't want \the to be expanded in the \parsermacbody as it uses an
7685 \expandafter\edef\tempa
7686 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7687 \advance\paramno by
1\relax
7690 % These two commands read recursive and nonrecursive macro bodies.
7691 % (They're different since rec and nonrec macros end differently.)
7692 % Set \temp to the body of the macro, and call \defmacro.
7693 \catcode `\@
\texiatcatcode
7694 {\catcode`\ =
\other\long\gdef\parsemacbody#1@end macro
{%
7695 \xdef\temp{\eatcr{#1}}\endgroup\defmacro}}%
7696 {\catcode`\ =
\other\long\gdef\parsermacbody#1@end rmacro
{%
7697 \xdef\temp{\eatcr{#1}}\endgroup\defmacro}}%
7698 \catcode `\@=
11\relax
7703 \long\def\nillm@
{\nil@
}%
7705 % This macro is expanded during the Texinfo macro expansion, not during its
7706 % definition. It gets all the arguments' values and assigns them to macros
7709 % #1 is the macro name
7710 % #2 is the list of argument names
7711 % #3 is the list of argument values
7712 \def\getargvals@
#1#2#3{%
7713 \def\macargdeflist@
{}%
7714 \def\saveparamlist@
{#2}% Need to keep a copy for parameter expansion.
7715 \def\paramlist{#2,
\nil@
}%
7719 \def\argvaluelist{#3,
\nil@
}%
7728 % Internal for \getargsval@.
7731 \ifx\paramlist\nilm@
7732 % Some sanity check needed here that \argvaluelist is also empty.
7733 \ifx\argvaluelist\nillm@
7735 \errhelp =
\EMsimple
7736 \errmessage{Too many arguments in macro `
\macroname'!
}%
7738 \let\next\macargexpandinbody@
7740 \ifx\argvaluelist\nillm@
7741 % No more arguments values passed to macro. Set remaining named-arg
7743 \let\next\setemptyargvalues@
7745 % pop current arg name into \@tempb
7746 \def\@tempa#
#1{\pop@
{\@tempb
}{\paramlist}#
#1\endargs@
}%
7747 \expandafter\@tempa
\expandafter{\paramlist}%
7748 % pop current argument value into \@tempc
7749 \def\@tempa#
#1{\longpop@
{\@tempc
}{\argvaluelist}#
#1\endargs@
}%
7750 \expandafter\@tempa
\expandafter{\argvaluelist}%
7751 % Here \@tempb is the current arg name and \@tempc is the current arg value.
7752 % First place the new argument macro definition into \@tempd
7753 \expandafter\macname\expandafter{\@tempc
}%
7754 \expandafter\let\csname macarg.\@tempb
\endcsname\relax
7755 \expandafter\def\expandafter\@tempe
\expandafter{%
7756 \csname macarg.\@tempb
\endcsname}%
7757 \edef\@tempd
{\long\def\@tempe
{\the\macname}}%
7758 \push@\@tempd
\macargdeflist@
7759 \let\next\getargvals@@
7766 \expandafter\expandafter\expandafter\def
7767 \expandafter\expandafter\expandafter#2%
7768 \expandafter\expandafter\expandafter{%
7772 % Replace arguments by their values in the macro body, and place the result
7775 \def\macvalstoargs@
{%
7776 % To do this we use the property that token registers that are \the'ed
7777 % within an \edef expand only once. So we are going to place all argument
7778 % values into respective token registers.
7780 % First we save the token context, and initialize argument numbering.
7783 % Then, for each argument number #N, we place the corresponding argument
7784 % value into a new token list register \toks#N
7785 \expandafter\putargsintokens@
\saveparamlist@,;,
%
7786 % Then, we expand the body so that argument are replaced by their
7787 % values. The trick for values not to be expanded themselves is that they
7788 % are within tokens and that tokens expand only once in an \edef .
7789 \edef\@tempc
{\csname mac.
\macroname .body
\endcsname}%
7790 % Now we restore the token stack pointer to free the token list registers
7791 % which we have used, but we make sure that expanded body is saved after
7795 \expandafter\def\expandafter\@tempa
\expandafter{\@tempc
}%
7798 % Define the named-macro outside of this group and then close this group.
7800 \def\macargexpandinbody@
{%
7804 % First the replace in body the macro arguments by their values, the result
7807 % Then we point at the \norecurse or \gobble (for recursive) macro value
7809 \expandafter\let\expandafter\@tempb
\csname mac.
\macroname .recurse
\endcsname
7810 % Depending on whether it is recursive or not, we need some tailing
7817 % And now we do the real job:
7818 \edef\@tempd
{\noexpand\@tempb
{\macroname}\noexpand\scanmacro{\@tempa
}\@tempc
}%
7822 \def\putargsintokens@
#1,
{%
7823 \if#1;
\let\next\relax
7825 \let\next\putargsintokens@
7826 % First we allocate the new token list register, and give it a temporary
7828 \toksdef\@tempb
\the\paramno
7829 % Then we place the argument value into that token list register.
7830 \expandafter\let\expandafter\@tempa
\csname macarg.
#1\endcsname
7831 \expandafter\@tempb
\expandafter{\@tempa
}%
7832 \advance\paramno by
1\relax
7837 % Save the token stack pointer into macro #1:
7838 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi
}}
7840 % Restore the token stack pointer from number in macro #1:
7841 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef
7842 \expandafter\@cclvi
#1\relax}
7843 % Variant \newtoks that can be used non-\outer:
7844 \def\texinonouternewtoks{\alloc@
5\toks \toksdef \@cclvi
}
7846 % Tailing missing arguments are set to empty.
7848 \def\setemptyargvalues@
{%
7849 \ifx\paramlist\nilm@
7850 \let\next\macargexpandinbody@
7852 \expandafter\setemptyargvaluesparser@
\paramlist\endargs@
7853 \let\next\setemptyargvalues@
7858 \def\setemptyargvaluesparser@
#1,
#2\endargs@
{%
7859 \expandafter\def\expandafter\@tempa
\expandafter{%
7860 \expandafter\def\csname macarg.
#1\endcsname{}}%
7861 \push@\@tempa
\macargdeflist@
7865 % #1 is the element target macro
7866 % #2 is the list macro
7867 % #3,#4\endargs@ is the list value
7868 \def\pop@
#1#2#3,
#4\endargs@
{%
7872 \long\def\longpop@
#1#2#3,
#4\endargs@
{%
7877 % This defines a Texinfo @macro. \temp has the body of the macro in it.
7878 % There are eight cases: recursive and nonrecursive macros of zero, one,
7879 % up to nine, and many arguments.
7880 % Much magic with \expandafter here.
7881 % \xdef is used so that macro definitions will survive the file
7882 % they're defined in; @include reads the file inside a group.
7885 \let\hash=##
% convert placeholders to macro parameter chars
7886 \ifrecursive %%%%%%%%%%%%%% Recursive %%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7889 \expandafter\xdef\csname\the\macname\endcsname{%
7890 \noexpand\scanmacro{\temp}}%
7892 \expandafter\xdef\csname\the\macname\endcsname{%
7894 \noexpand\braceorline
7895 \expandafter\noexpand\csname\the\macname xxx
\endcsname}%
7896 \expandafter\xdef\csname\the\macname xxx
\endcsname#
#1{%
7897 \egroup\noexpand\scanmacro{\temp}}%
7899 \ifnum\paramno<
10\relax % at most 9
7900 \expandafter\xdef\csname\the\macname\endcsname{%
7901 \bgroup\noexpand\macroargctxt
7902 \noexpand\csname\the\macname xx
\endcsname}%
7903 \expandafter\xdef\csname\the\macname xx
\endcsname#
#1{%
7904 \expandafter\noexpand\csname\the\macname xxx
\endcsname #
#1,
}%
7905 \expandafter\expandafter
7907 \expandafter\expandafter
7908 \csname\the\macname xxx
\endcsname
7909 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7911 \expandafter\xdef\csname\the\macname\endcsname{%
7912 \noexpand\getargvals@
{\the\macname}{\argl}%
7914 \global\expandafter\let\csname mac.
\the\macname .body
\endcsname\temp
7915 \global\expandafter\let\csname mac.
\the\macname .recurse
\endcsname\gobble
7918 \else %%%%%%%%%%%%%%%%%%%%%% Non-recursive %%%%%%%%%%%%%%%%%%%%%%%%%%
7921 \expandafter\xdef\csname\the\macname\endcsname{%
7922 \noexpand\scanmacro{\temp}}%
7924 \expandafter\xdef\csname\the\macname\endcsname{%
7926 \noexpand\braceorline
7927 \expandafter\noexpand\csname\the\macname xxx
\endcsname}%
7928 \expandafter\xdef\csname\the\macname xxx
\endcsname#
#1{%
7930 \noexpand\scanmacro{\temp}%
7933 \ifnum\paramno<
10\relax
7934 \expandafter\xdef\csname\the\macname\endcsname{%
7935 \bgroup\noexpand\macroargctxt
7936 \expandafter\noexpand\csname\the\macname xx
\endcsname}%
7937 \expandafter\xdef\csname\the\macname xx
\endcsname#
#1{%
7938 \expandafter\noexpand\csname\the\macname xxx
\endcsname #
#1,
}%
7939 \expandafter\expandafter
7941 \expandafter\expandafter
7942 \csname\the\macname xxx
\endcsname
7945 \noexpand\scanmacro{\temp}%
7948 \expandafter\xdef\csname\the\macname\endcsname{%
7949 \noexpand\getargvals@
{\the\macname}{\argl}%
7951 \global\expandafter\let\csname mac.
\the\macname .body
\endcsname\temp
7952 \global\expandafter\let\csname mac.
\the\macname .recurse
\endcsname\norecurse
7957 \catcode `\@
\texiatcatcode\relax % end private-to-Texinfo catcodes
7959 \def\norecurse#1{\bgroup\cslet{#1}{macsave.
#1}}
7962 {\catcode`\@=
0 \catcode`\\=
13
7965 % Call #1 with a list of tokens #2, with any doubled backslashes in #2
7966 % compressed to one.
7967 @gdef@passargtomacro
#1#2{%
7969 @def@pending_backslash
{}%
7970 @def@finish
{@finish
}%
7972 @let@next_token=@relax
7973 @add_segment
#2\@finish\%
7976 % Input stream is just after a backslash. If the next token is not a
7977 % backslash, process the rest of the argument; otherwise, remove the next
7980 @futurelet@next_token@look_aheadzzz
}
7981 @gdef@look_aheadzzz
{%
7983 @let@next=@gobble_and_check_finish
7985 @let@next=@add_segment
7989 % Double backslash found. Add a single backslash here.
7990 @gdef@gobble_and_check_finish
#1{%
7992 @def@pending_backslash
{}%
7993 @futurelet@next_token@add_segment
7996 % append a backslash to \arg_result
7997 @gdef@add_the_backslash
{%
7998 @expandafter@gdef@expandafter@arg_result@expandafter
{@arg_result\
}%
8001 % Input stream is either at the start of the argument, or just after a
8002 % backslash sequence, either a lone backslash, or a doubled backslash.
8003 % \next_token contains the first token in the input stream: if it is \finish,
8004 % finish; otherwise, append to \arg_result the segment of the argument up until
8005 % the next backslash. \pending_backslash contains a backslash to represent
8006 % a backslash just before the start of the input stream that has not been
8007 % added to \arg_result.
8008 @gdef@add_segment
#1\
{%
8009 @ifx@next_token@finish
8010 @let@next=@call_the_macro
%
8012 @let@next=@look_ahead
8014 % append to @arg_result
8015 % token list registers might be better
8016 @expandafter@expandafter@expandafter@gdef
8017 @expandafter@expandafter@expandafter@arg_result
8018 @expandafter@expandafter@expandafter
{%
8019 @expandafter@arg_result
8020 @pending_backslash
#1}%
8021 @def@pending_backslash
{\
}%
8024 @gdef@call_the_macro
{@expandafter@the_macro@expandafter
{@arg_result
}}
8028 % \braceorline MAC is used for a one-argument macro MAC. It checks
8029 % whether the next non-whitespace character is a {. It sets the context
8030 % for reading the argument (slightly different in the two cases). Then,
8031 % to read the argument, in the whole-line case, it then calls the regular
8032 % \parsearg MAC; in the lbrace case, it calls \passargtomacro MAC.
8034 \def\braceorline#1{\let\macnamexxx=
#1\futurelet\nchar\braceorlinexxx}
8035 \def\braceorlinexxx{%
8038 \expandafter\passargtomacro
8040 \macrolineargctxt\expandafter\parsearg
8045 % We need some trickery to remove the optional spaces around the equal
8046 % sign. Make them active and then expand them all to nothing.
8048 \def\alias{\parseargusing\obeyspaces\aliasxxx}
8049 \def\aliasxxx #1{\aliasyyy#1\relax}
8050 \def\aliasyyy #1=
#2\relax{%
8052 \expandafter\let\obeyedspace=
\empty
8053 \addtomacrolist{#1}%
8054 \xdef\next{\global\let\makecsname{#1}=
\makecsname{#2}}%
8060 \message{cross references,
}
8063 \newif\ifhavexrefs % True if xref values are known.
8064 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
8066 % @inforef is relatively simple.
8067 \def\inforef #1{\inforefzzz #1,,,,**
}
8068 \def\inforefzzz #1,
#2,
#3,
#4**
{%
8069 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
8070 node
\samp{\ignorespaces#1{}}}
8072 % @node's only job in TeX is to define \lastnode, which is used in
8073 % cross-references. The @node line might or might not have commas, and
8074 % might or might not have spaces before the first comma, like:
8075 % @node foo , bar , ...
8076 % We don't want such trailing spaces in the node name.
8078 \parseargdef\node{\checkenv{}\donode #1 ,
\finishnodeparse}
8080 % also remove a trailing comma, in case of something like this:
8081 % @node Help-Cross, , , Cross-refs
8082 \def\donode#1 ,
#2\finishnodeparse{\dodonode #1,
\finishnodeparse}
8083 \def\dodonode#1,
#2\finishnodeparse{\gdef\lastnode{#1}}
8086 \let\lastnode=
\empty
8088 % Write a cross-reference definition for the current node. #1 is the
8089 % type (Ynumbered, Yappendix, Ynothing).
8092 \ifx\lastnode\empty\else
8093 \setref{\lastnode}{#1}%
8094 \global\let\lastnode=
\empty
8098 % @anchor{NAME} -- define xref target at arbitrary point.
8100 \newcount\savesfregister
8102 \def\savesf{\relax \ifhmode \savesfregister=
\spacefactor \fi}
8103 \def\restoresf{\relax \ifhmode \spacefactor=
\savesfregister \fi}
8104 \def\anchor#1{\savesf \setref{#1}{Ynothing
}\restoresf \ignorespaces}
8106 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
8107 % anchor), which consists of three parts:
8108 % 1) NAME-title - the current sectioning name taken from \lastsection,
8109 % or the anchor name.
8110 % 2) NAME-snt - section number and type, passed as the SNT arg, or
8111 % empty for anchors.
8112 % 3) NAME-pg - the page number.
8114 % This is called from \donoderef, \anchor, and \dofloat. In the case of
8115 % floats, there is an additional part, which is not written here:
8116 % 4) NAME-lof - the text as it should appear in a @listoffloats.
8122 \atdummies % preserve commands, but don't expand them
8123 \edef\writexrdef#
#1#
#2{%
8124 \write\auxfile{@xrdef
{#1-
% #1 of \setref, expanded by the \edef
8125 #
#1}{#
#2}}% these are parameters of \writexrdef
8127 \toks0 =
\expandafter{\lastsection}%
8128 \immediate \writexrdef{title
}{\the\toks0 }%
8129 \immediate \writexrdef{snt
}{\csname #2\endcsname}% \Ynumbered etc.
8130 \safewhatsit{\writexrdef{pg
}{\folio}}% will be written later, at \shipout
8135 % @xrefautosectiontitle on|off says whether @section(ing) names are used
8136 % automatically in xrefs, if the third arg is not explicitly specified.
8137 % This was provided as a "secret" @set xref-automatic-section-title
8138 % variable, now it's official.
8140 \parseargdef\xrefautomaticsectiontitle{%
8143 \expandafter\let\csname SETxref-automatic-section-title
\endcsname
8145 \else\ifx\temp\offword
8146 \expandafter\let\csname SETxref-automatic-section-title
\endcsname
8149 \errhelp =
\EMsimple
8150 \errmessage{Unknown @xrefautomaticsectiontitle value `
\temp',
8156 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
8157 % the node name, #2 the name of the Info cross-reference, #3 the printed
8158 % node name, #4 the name of the Info file, #5 the name of the printed
8159 % manual. All but the node name can be omitted.
8161 \def\pxref{\putwordsee{} \xrefXX}
8162 \def\xref{\putwordSee{} \xrefXX}
8165 \def\xrefXX#1{\def\xrefXXarg{#1}\futurelet\tokenafterxref\xrefXXX}
8166 \def\xrefXXX{\expandafter\xrefX\expandafter[\xrefXXarg,,,,,,,
]}
8169 \newbox\printedrefnamebox
8170 \newbox\infofilenamebox
8171 \newbox\printedmanualbox
8173 \def\xrefX[#1,
#2,
#3,
#4,
#5,
#6]{\begingroup
8176 % Get args without leading/trailing spaces.
8177 \def\printedrefname{\ignorespaces #3}%
8178 \setbox\printedrefnamebox =
\hbox{\printedrefname\unskip}%
8180 \def\infofilename{\ignorespaces #4}%
8181 \setbox\infofilenamebox =
\hbox{\infofilename\unskip}%
8183 \def\printedmanual{\ignorespaces #5}%
8184 \setbox\printedmanualbox =
\hbox{\printedmanual\unskip}%
8186 % If the printed reference name (arg #3) was not explicitly given in
8187 % the @xref, figure out what we want to use.
8188 \ifdim \wd\printedrefnamebox =
0pt
8189 % No printed node name was explicitly given.
8190 \expandafter\ifx\csname SETxref-automatic-section-title
\endcsname \relax
8191 % Not auto section-title: use node name inside the square brackets.
8192 \def\printedrefname{\ignorespaces #1}%
8194 % Auto section-title: use chapter/section title inside
8195 % the square brackets if we have it.
8196 \ifdim \wd\printedmanualbox >
0pt
8197 % It is in another manual, so we don't have it; use node name.
8198 \def\printedrefname{\ignorespaces #1}%
8201 % We (should) know the real title if we have the xref values.
8202 \def\printedrefname{\refx{#1-title
}{}}%
8204 % Otherwise just copy the Info node name.
8205 \def\printedrefname{\ignorespaces #1}%
8211 % Make link in pdf output.
8215 \makevalueexpandable
8216 % This expands tokens, so do it after making catcode changes, so _
8217 % etc. don't get their TeX definitions. This ignores all spaces in
8218 % #4, including (wrongly) those in the middle of the filename.
8221 % This (wrongly) does not take account of leading or trailing
8222 % spaces in #1, which should be ignored.
8223 \edef\pdfxrefdest{#1}%
8224 \ifx\pdfxrefdest\empty
8225 \def\pdfxrefdest{Top
}% no empty targets
8227 \txiescapepdf\pdfxrefdest % escape PDF special chars
8231 \startlink attr
{/Border
[0 0 0]}%
8232 \ifnum\filenamelength>
0
8233 goto file
{\the\filename.pdf
} name
{\pdfxrefdest}%
8235 goto name
{\pdfmkpgn{\pdfxrefdest}}%
8238 \setcolor{\linkcolor}%
8241 % Float references are printed completely differently: "Figure 1.2"
8242 % instead of "[somenode], p.3". We distinguish them by the
8243 % LABEL-title being set to a magic string.
8245 % Have to otherify everything special to allow the \csname to
8246 % include an _ in the xref name, etc.
8249 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
8250 \csname XR
#1-title
\endcsname
8252 \iffloat\Xthisreftitle
8253 % If the user specified the print name (third arg) to the ref,
8254 % print it instead of our usual "Figure 1.2".
8255 \ifdim\wd\printedrefnamebox =
0pt
8261 % If the user also gave the printed manual name (fifth arg), append
8263 \ifdim \wd\printedmanualbox >
0pt
8264 \space \putwordin{} \cite{\printedmanual}%
8267 % node/anchor (non-float) references.
8269 % If we use \unhbox to print the node names, TeX does not insert
8270 % empty discretionaries after hyphens, which means that it will not
8271 % find a line break at a hyphen in a node names. Since some manuals
8272 % are best written with fairly long node names, containing hyphens,
8273 % this is a loss. Therefore, we give the text of the node name
8274 % again, so it is as if TeX is seeing it for the first time.
8276 \ifdim \wd\printedmanualbox >
0pt
8277 % Cross-manual reference with a printed manual name.
8279 \crossmanualxref{\cite{\printedmanual\unskip}}%
8281 \else\ifdim \wd\infofilenamebox >
0pt
8282 % Cross-manual reference with only an info filename (arg 4), no
8283 % printed manual name (arg 5). This is essentially the same as
8284 % the case above; we output the filename, since we have nothing else.
8286 \crossmanualxref{\code{\infofilename\unskip}}%
8289 % Reference within this manual.
8291 % _ (for example) has to be the character _ for the purposes of the
8292 % control sequence corresponding to the node, but it has to expand
8293 % into the usual \leavevmode...\vrule stuff for purposes of
8294 % printing. So we \turnoffactive for the \refx-snt, back on for the
8295 % printing, back off for the \refx-pg.
8297 % Only output a following space if the -snt ref is nonempty; for
8298 % @unnumbered and @anchor, it won't be.
8299 \setbox2 =
\hbox{\ignorespaces \refx{#1-snt
}{}}%
8300 \ifdim \wd2 >
0pt
\refx{#1-snt
}\space\fi
8302 % output the `[mynode]' via the macro below so it can be overridden.
8303 \xrefprintnodename\printedrefname
8305 % But we always want a comma and a space:
8308 % output the `page 3'.
8309 \turnoffactive \putwordpage\tie\refx{#1-pg
}{}%
8310 \ifx,
\tokenafterxref
8311 \else\ifx.
\tokenafterxref
8312 \else\ifx;
\tokenafterxref
8313 \else\ifx)
\tokenafterxref
8314 \else,
% add a , if xref not followed by punctuation
8321 % Output a cross-manual xref to #1. Used just above (twice).
8323 % Only include the text "Section ``foo'' in" if the foo is neither
8324 % missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply
8325 % "see The Foo Manual", the idea being to refer to the whole manual.
8327 % But, this being TeX, we can't easily compare our node name against the
8328 % string "Top" while ignoring the possible spaces before and after in
8329 % the input. By adding the arbitrary 7sp below, we make it much less
8330 % likely that a real node name would have the same width as "Top" (e.g.,
8331 % in a monospaced font). Hopefully it will never happen in practice.
8333 % For the same basic reason, we retypeset the "Top" at every
8334 % reference, since the current font is indeterminate.
8336 \def\crossmanualxref#1{%
8337 \setbox\toprefbox =
\hbox{Top
\kern7sp}%
8338 \setbox2 =
\hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8339 \ifdim \wd2 >
7sp
% nonempty?
8340 \ifdim \wd2 =
\wd\toprefbox \else % same as Top?
8341 \putwordSection{} ``
\printedrefname''
\putwordin{}\space
8347 % This macro is called from \xrefX for the `[nodename]' part of xref
8348 % output. It's a separate macro only so it can be changed more easily,
8349 % since square brackets don't work well in some documents. Particularly
8350 % one that Bob is working on :).
8352 \def\xrefprintnodename#1{[#1]}
8354 % Things referred to by \setref.
8360 \putwordChapter@tie
\the\chapno
8361 \else \ifnum\subsecno=
0
8362 \putwordSection@tie
\the\chapno.
\the\secno
8363 \else \ifnum\subsubsecno=
0
8364 \putwordSection@tie
\the\chapno.
\the\secno.
\the\subsecno
8366 \putwordSection@tie
\the\chapno.
\the\secno.
\the\subsecno.
\the\subsubsecno
8371 \putwordAppendix@tie @char
\the\appendixno{}%
8372 \else \ifnum\subsecno=
0
8373 \putwordSection@tie @char
\the\appendixno.
\the\secno
8374 \else \ifnum\subsubsecno=
0
8375 \putwordSection@tie @char
\the\appendixno.
\the\secno.
\the\subsecno
8378 @char
\the\appendixno.
\the\secno.
\the\subsecno.
\the\subsubsecno
8382 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
8383 % If its value is nonempty, SUFFIX is output afterward.
8389 \expandafter\global\expandafter\let\expandafter\thisrefX
8390 \csname XR
#1\endcsname
8393 % If not defined, say something at least.
8394 \angleleft un\-de\-fined
\angleright
8397 {\toks0 =
{#1}% avoid expansion of possibly-complex value
8398 \message{\linenumber Undefined cross reference `
\the\toks0'.
}}%
8401 \global\warnedxrefstrue
8402 \message{Cross reference values unknown; you must run TeX again.
}%
8407 % It's defined, so just use it.
8410 #2% Output the suffix in any case.
8413 % This is the macro invoked by entries in the aux file. Usually it's
8414 % just a \def (we prepend XR to the control sequence name to avoid
8415 % collisions). But if this is a float type, we have more work to do.
8418 {% The node name might contain 8-bit characters, which in our current
8419 % implementation are changed to commands like @'e. Don't let these
8420 % mess up the control sequence name.
8423 \xdef\safexrefname{#1}%
8426 \expandafter\gdef\csname XR
\safexrefname\endcsname{#2}% remember this xref
8428 % Was that xref control sequence that we just defined for a float?
8429 \expandafter\iffloat\csname XR
\safexrefname\endcsname
8430 % it was a float, and we have the (safe) float type in \iffloattype.
8431 \expandafter\let\expandafter\floatlist
8432 \csname floatlist
\iffloattype\endcsname
8434 % Is this the first time we've seen this float type?
8435 \expandafter\ifx\floatlist\relax
8436 \toks0 =
{\do}% yes, so just \do
8438 % had it before, so preserve previous elements in list.
8439 \toks0 =
\expandafter{\floatlist\do}%
8442 % Remember this xref in the control sequence \floatlistFLOATTYPE,
8443 % for later use in \listoffloats.
8444 \expandafter\xdef\csname floatlist
\iffloattype\endcsname{\the\toks0
8449 % Read the last existing aux file, if any. No error if none exists.
8452 \openin 1 \jobname.aux
8455 \global\havexrefstrue
8460 \def\setupdatafile{%
8461 \catcode`\^^@=
\other
8462 \catcode`\^^A=
\other
8463 \catcode`\^^B=
\other
8464 \catcode`\^^C=
\other
8465 \catcode`\^^D=
\other
8466 \catcode`\^^E=
\other
8467 \catcode`\^^F=
\other
8468 \catcode`\^^G=
\other
8469 \catcode`\^^H=
\other
8470 \catcode`\^^K=
\other
8471 \catcode`\^^L=
\other
8472 \catcode`\^^N=
\other
8473 \catcode`\^^P=
\other
8474 \catcode`\^^Q=
\other
8475 \catcode`\^^R=
\other
8476 \catcode`\^^S=
\other
8477 \catcode`\^^T=
\other
8478 \catcode`\^^U=
\other
8479 \catcode`\^^V=
\other
8480 \catcode`\^^W=
\other
8481 \catcode`\^^X=
\other
8482 \catcode`\^^Z=
\other
8483 \catcode`\^^
[=
\other
8484 \catcode`\^^\=
\other
8485 \catcode`\^^
]=
\other
8486 \catcode`\^^^=
\other
8487 \catcode`\^^_=
\other
8488 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8489 % in xref tags, i.e., node names. But since ^^e4 notation isn't
8490 % supported in the main text, it doesn't seem desirable. Furthermore,
8491 % that is not enough: for node names that actually contain a ^
8492 % character, we would end up writing a line like this: 'xrdef {'hat
8493 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8494 % argument, and \hat is not an expandable control sequence. It could
8495 % all be worked out, but why? Either we support ^^ or we don't.
8497 % The other change necessary for this was to define \auxhat:
8498 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8499 % and then to call \auxhat in \setq.
8503 % Special characters. Should be turned off anyway, but...
8516 \catcode`+=
\other % avoid \+ for paranoia even though we've turned it off
8518 % This is to support \ in node names and titles, since the \
8519 % characters end up in a \csname. It's easier than
8520 % leaving it active and making its active definition an actual \
8521 % character. What I don't understand is why it works in the *value*
8522 % of the xrdef. Seems like it should be a catcode12 \, and that
8523 % should not typeset properly. But it works, so I'm moving on for
8524 % now. --karl, 15jan04.
8527 % Make the characters 128-255 be printing characters.
8528 {\setnonasciicharscatcodenonglobal\other}%
8530 % @ is our escape character in .aux files, and we need braces.
8536 \def\readdatafile#1{%
8543 \message{insertions,
}
8544 % including footnotes.
8546 \newcount \footnoteno
8548 % The trailing space in the following definition for supereject is
8549 % vital for proper filling; pages come out unaligned when you do a
8550 % pagealignmacro call if that space before the closing brace is
8551 % removed. (Generally, numeric constants should always be followed by a
8552 % space to prevent strange expansion errors.)
8553 \def\supereject{\par\penalty -
20000\footnoteno =
0 }
8555 % @footnotestyle is meaningful for Info output only.
8556 \let\footnotestyle=
\comment
8560 % Auto-number footnotes. Otherwise like plain.
8562 \global\advance\footnoteno by \@ne
8563 \edef\thisfootno{$^
{\the\footnoteno}$
}%
8565 % In case the footnote comes at the end of a sentence, preserve the
8566 % extra spacing after we do the footnote number.
8568 \ifhmode\edef\@sf
{\spacefactor\the\spacefactor}\ptexslash\fi
8570 % Remove inadvertent blank space before typesetting the footnote number.
8576 % Don't bother with the trickery in plain.tex to not require the
8577 % footnote text as a parameter. Our footnotes don't need to be so general.
8579 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8580 % \parseargline) fails inside footnotes because the tokens are fixed when
8581 % the footnote is read. --karl, 16nov96.
8584 \insert\footins\bgroup
8586 % Nested footnotes are not supported in TeX, that would take a lot
8587 % more work. (\startsavinginserts does not suffice.)
8588 \let\footnote=
\errfootnotenest
8590 % We want to typeset this text as a normal paragraph, even if the
8591 % footnote reference occurs in (for example) a display environment.
8592 % So reset some parameters.
8594 \interlinepenalty\interfootnotelinepenalty
8595 \splittopskip\ht\strutbox % top baseline for broken footnotes
8596 \splitmaxdepth\dp\strutbox
8597 \floatingpenalty\@MM
8602 \parindent\defaultparindent
8606 % Because we use hanging indentation in footnotes, a @noindent appears
8607 % to exdent this text, so make it be a no-op. makeinfo does not use
8608 % hanging indentation so @noindent can still be needed within footnote
8609 % text after an @example or the like (not that this is good style).
8610 \let\noindent =
\relax
8612 % Hang the footnote text off the number. Use \everypar in case the
8613 % footnote extends for more than one paragraph.
8614 \everypar =
{\hang}%
8615 \textindent{\thisfootno}%
8617 % Don't crash into the line above the footnote text. Since this
8618 % expands into a box, it must come within the paragraph, lest it
8619 % provide a place where TeX can split the footnote.
8622 % Invoke rest of plain TeX footnote routine.
8623 \futurelet\next\fo@t
8625 }%end \catcode `\@=11
8627 \def\errfootnotenest{%
8629 \errmessage{Nested footnotes not supported in texinfo.tex,
8630 even though they work in makeinfo; sorry
}
8633 \def\errfootnoteheading{%
8635 \errmessage{Footnotes in chapters, sections, etc., are not supported
}
8638 % In case a @footnote appears in a vbox, save the footnote text and create
8639 % the real \insert just after the vbox finished. Otherwise, the insertion
8641 % Similarly, if a @footnote appears inside an alignment, save the footnote
8642 % text to a box and make the \insert when a row of the table is finished.
8643 % And the same can be done for other insert classes. --kasal, 16nov03.
8645 % Replace the \insert primitive by a cheating macro.
8646 % Deeper inside, just make sure that the saved insertions are not spilled
8649 \def\startsavinginserts{%
8650 \ifx \insert\ptexinsert
8651 \let\insert\saveinsert
8653 \let\checkinserts\relax
8657 % This \insert replacement works for both \insert\footins{foo} and
8658 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8661 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8662 \afterassignment\next
8663 % swallow the left brace
8666 \def\makeSAVEname#1{\makecsname{SAVE
\expandafter\gobble\string#1}}
8667 \def\savetobox#1{\global\setbox#1 =
\vbox\bgroup \unvbox#1}
8669 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8671 \def\placesaveins#1{%
8672 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8676 % eat @SAVE -- beware, all of them have catcode \other:
8678 \def\dospecials{\do S
\do A
\do V
\do E
} \uncatcodespecials % ;-)
8679 \gdef\gobblesave @SAVE
{}
8683 \def\newsaveins #1{%
8684 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8687 \def\newsaveinsX #1{%
8688 \csname newbox
\endcsname #1%
8689 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8694 \let\checkinserts\empty
8699 % @image. We use the macros from epsf.tex to support this.
8700 % If epsf.tex is not installed and @image is used, we complain.
8702 % Check for and read epsf.tex up front. If we read it only at @image
8703 % time, we might be inside a group, and then its definitions would get
8704 % undone and the next image would fail.
8705 \openin 1 = epsf.tex
8707 % Do not bother showing banner with epsf.tex v2.7k (available in
8708 % doc/epsf.tex and on ctan).
8709 \def\epsfannounce{\toks0 =
}%
8714 % We will only complain once about lack of epsf.tex.
8715 \newif\ifwarnednoepsf
8716 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8717 work. It is also included in the Texinfo distribution, or you can get
8718 it from ftp://tug.org/tex/epsf.tex.
}
8721 \ifx\epsfbox\thisisundefined
8722 \ifwarnednoepsf \else
8723 \errhelp =
\noepsfhelp
8724 \errmessage{epsf.tex not found, images will be ignored
}%
8725 \global\warnednoepsftrue
8728 \imagexxx #1,,,,,
\finish
8732 % Arguments to @image:
8733 % #1 is (mandatory) image filename; we tack on .eps extension.
8734 % #2 is (optional) width, #3 is (optional) height.
8735 % #4 is (ignored optional) html alt text.
8736 % #5 is (ignored optional) extension.
8737 % #6 is just the usual extra ignored arg for parsing stuff.
8739 \def\imagexxx#1,
#2,
#3,
#4,
#5,
#6\finish{\begingroup
8740 \catcode`\^^M =
5 % in case we're inside an example
8741 \normalturnoffactive % allow _ et al. in names
8742 % If the image is by itself, center it.
8745 \else \ifx\centersub\centerV
8746 % for @center @image, we need a vbox so we can have our vertical space
8748 \vbox\bgroup % vbox has better behavior than vtop herev
8753 % Usually we'll have text after the image which will insert
8754 % \parskip glue, so insert it here too to equalize the space
8756 \nobreak\vskip\parskip
8760 % Leave vertical mode so that indentation from an enclosing
8761 % environment such as @quotation is respected.
8762 % However, if we're at the top level, we don't want the
8763 % normal paragraph indentation.
8764 % On the other hand, if we are in the case of @center @image, we don't
8765 % want to start a paragraph, which will create a hsize-width box and
8766 % eradicate the centering.
8767 \ifx\centersub\centerV\else \noindent \fi
8771 \dopdfimage{#1}{#2}{#3}%
8773 % \epsfbox itself resets \epsf?size at each figure.
8774 \setbox0 =
\hbox{\ignorespaces #2}\ifdim\wd0 >
0pt
\epsfxsize=
#2\relax \fi
8775 \setbox0 =
\hbox{\ignorespaces #3}\ifdim\wd0 >
0pt
\epsfysize=
#3\relax \fi
8780 \medskip % space after a standalone image
8782 \ifx\centersub\centerV \egroup \fi
8786 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8787 % etc. We don't actually implement floating yet, we always include the
8788 % float "here". But it seemed the best name for the future.
8790 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,
\finish}
8792 % There may be a space before second and/or third parameter; delete it.
8793 \def\eatcommaspace#1,
{#1,
}
8795 % #1 is the optional FLOATTYPE, the text label for this float, typically
8796 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
8797 % this float will not be numbered and cannot be referred to.
8799 % #2 is the optional xref label. Also must be present for the float to
8802 % #3 is the optional positioning argument; for now, it is ignored. It
8803 % will somehow specify the positions allowed to float to (here, top, bottom).
8805 % We keep a separate counter for each FLOATTYPE, which we reset at each
8806 % chapter-level command.
8807 \let\resetallfloatnos=
\empty
8809 \def\dofloat#1,
#2,
#3,
#4\finish{%
8810 \let\thiscaption=
\empty
8811 \let\thisshortcaption=
\empty
8813 % don't lose footnotes inside @float.
8815 % BEWARE: when the floats start float, we have to issue warning whenever an
8816 % insert appears inside a float which could possibly float. --kasal, 26may04
8820 % We can't be used inside a paragraph.
8825 \def\floatlabel{#2}%
8826 \def\floatloc{#3}% we do nothing with this yet.
8828 \ifx\floattype\empty
8829 \let\safefloattype=
\empty
8832 % the floattype might have accents or other special characters,
8833 % but we need to use it in a control sequence name.
8836 \xdef\safefloattype{\floattype}%
8840 % If label is given but no type, we handle that as the empty type.
8841 \ifx\floatlabel\empty \else
8842 % We want each FLOATTYPE to be numbered separately (Figure 1,
8843 % Table 1, Figure 2, ...). (And if no label, no number.)
8845 \expandafter\getfloatno\csname\safefloattype floatno
\endcsname
8846 \global\advance\floatno by
1
8849 % This magic value for \lastsection is output by \setref as the
8850 % XREFLABEL-title value. \xrefX uses it to distinguish float
8851 % labels (which have a completely different output format) from
8852 % node and anchor labels. And \xrdef uses it to construct the
8855 \edef\lastsection{\floatmagic=
\safefloattype}%
8856 \setref{\floatlabel}{Yfloat
}%
8860 % start with \parskip glue, I guess.
8863 % Don't suppress indentation if a float happens to start a section.
8864 \restorefirstparagraphindent
8867 % we have these possibilities:
8868 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8869 % @float Foo,lbl & no caption: Foo 1.1
8870 % @float Foo & @caption{Cap}: Foo: Cap
8871 % @float Foo & no caption: Foo
8872 % @float ,lbl & Caption{Cap}: 1.1: Cap
8873 % @float ,lbl & no caption: 1.1
8874 % @float & @caption{Cap}: Cap
8875 % @float & no caption:
8878 \let\floatident =
\empty
8880 % In all cases, if we have a float type, it comes first.
8881 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8883 % If we have an xref label, the number comes next.
8884 \ifx\floatlabel\empty \else
8885 \ifx\floattype\empty \else % if also had float type, need tie first.
8886 \appendtomacro\floatident{\tie}%
8889 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8892 % Start the printed caption with what we've constructed in
8893 % \floatident, but keep it separate; we need \floatident again.
8894 \let\captionline =
\floatident
8896 \ifx\thiscaption\empty \else
8897 \ifx\floatident\empty \else
8898 \appendtomacro\captionline{:
}% had ident, so need a colon between
8902 \appendtomacro\captionline{\scanexp\thiscaption}%
8905 % If we have anything to print, print it, with space before.
8906 % Eventually this needs to become an \insert.
8907 \ifx\captionline\empty \else
8911 % Space below caption.
8915 % If have an xref label, write the list of floats info. Do this
8916 % after the caption, to avoid chance of it being a breakpoint.
8917 \ifx\floatlabel\empty \else
8918 % Write the text that goes in the lof to the aux file as
8919 % \floatlabel-lof. Besides \floatident, we include the short
8920 % caption if specified, else the full caption if specified, else nothing.
8924 % since we read the caption text in the macro world, where ^^M
8925 % is turned into a normal character, we have to scan it back, so
8926 % we don't write the literal three characters "^^M" into the aux file.
8928 \xdef\noexpand\gtemp{%
8929 \ifx\thisshortcaption\empty
8936 \immediate\write\auxfile{@xrdef
{\floatlabel-lof
}{\floatident
8937 \ifx\gtemp\empty \else :
\gtemp \fi}}%
8940 \egroup % end of \vtop
8942 % place the captured inserts
8944 % BEWARE: when the floats start floating, we have to issue warning
8945 % whenever an insert appears inside a float which could possibly
8946 % float. --kasal, 26may04
8951 % Append the tokens #2 to the definition of macro #1, not expanding either.
8953 \def\appendtomacro#1#2{%
8954 \expandafter\def\expandafter#1\expandafter{#1#2}%
8957 % @caption, @shortcaption
8959 \def\caption{\docaption\thiscaption}
8960 \def\shortcaption{\docaption\thisshortcaption}
8961 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8962 \def\defcaption#1#2{\egroup \def#1{#2}}
8964 % The parameter is the control sequence identifying the counter we are
8965 % going to use. Create it if it doesn't exist and assign it to \floatno.
8968 % Haven't seen this figure type before.
8969 \csname newcount
\endcsname #1%
8971 % Remember to reset this floatno at the next chap.
8972 \expandafter\gdef\expandafter\resetallfloatnos
8973 \expandafter{\resetallfloatnos #1=
0 }%
8978 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8979 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8980 % first read the @float command.
8982 \def\Yfloat{\floattype@tie
\chaplevelprefix\the\floatno}%
8984 % Magic string used for the XREFLABEL-title value, so \xrefX can
8985 % distinguish floats from other xref types.
8986 \def\floatmagic{!!float!!
}
8988 % #1 is the control sequence we are passed; we expand into a conditional
8989 % which is true if #1 represents a float ref. That is, the magic
8990 % \lastsection value which we \setref above.
8992 \def\iffloat#1{\expandafter\doiffloat#1==
\finish}
8994 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8995 % (safe) float type for this float. We set \iffloattype to #2.
8997 \def\doiffloat#1=
#2=
#3\finish{%
8999 \def\iffloattype{#2}%
9000 \ifx\temp\floatmagic
9003 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
9005 \parseargdef\listoffloats{%
9006 \def\floattype{#1}% floattype
9008 % the floattype might have accents or other special characters,
9009 % but we need to use it in a control sequence name.
9012 \xdef\safefloattype{\floattype}%
9015 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
9016 \expandafter\ifx\csname floatlist
\safefloattype\endcsname \relax
9018 % if the user said @listoffloats foo but never @float foo.
9019 \message{\linenumber No `
\safefloattype' floats to list.
}%
9023 \leftskip=
\tocindent % indent these entries like a toc
9024 \let\do=
\listoffloatsdo
9025 \csname floatlist
\safefloattype\endcsname
9030 % This is called on each entry in a list of floats. We're passed the
9031 % xref label, in the form LABEL-title, which is how we save it in the
9032 % aux file. We strip off the -title and look up \XRLABEL-lof, which
9033 % has the text we're supposed to typeset here.
9035 % Figures without xref labels will not be included in the list (since
9036 % they won't appear in the aux file).
9038 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
9039 \def\listoffloatsdoentry#1-title
\finish{{%
9040 % Can't fully expand XR#1-lof because it can contain anything. Just
9041 % pass the control sequence. On the other hand, XR#1-pg is just the
9042 % page number, and we want to fully expand that so we can get a link
9044 \toksA =
\expandafter{\csname XR
#1-lof
\endcsname}%
9046 % use the same \entry macro we use to generate the TOC and index.
9047 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR
#1-pg
\endcsname}}%
9052 \message{localization,
}
9054 % For single-language documents, @documentlanguage is usually given very
9055 % early, just after @documentencoding. Single argument is the language
9056 % (de) or locale (de_DE) abbreviation.
9059 \catcode`
\_ =
\active
9061 \parseargdef\documentlanguage{%
9062 \tex % read txi-??.tex file in plain TeX.
9063 % Read the file by the name they passed if it exists.
9064 \let_ =
\normalunderscore % normal _ character for filename test
9065 \openin 1 txi-
#1.tex
9067 \documentlanguagetrywithoutunderscore #1_
\finish
9069 \globaldefs =
1 % everything in the txi-LL files needs to persist
9073 \endgroup % end raw TeX
9076 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
9079 \gdef\documentlanguagetrywithoutunderscore#1_
#2\finish{%
9080 \openin 1 txi-
#1.tex
9082 \errhelp =
\nolanghelp
9083 \errmessage{Cannot read language file txi-
#1.tex
}%
9085 \globaldefs =
1 % everything in the txi-LL files needs to persist
9090 }% end of special _ catcode
9092 \newhelp\nolanghelp{The given language definition file cannot be found or
9093 is empty. Maybe you need to install it? Putting it in the current
9094 directory should work if nowhere else does.
}
9096 % This macro is called from txi-??.tex files; the first argument is the
9097 % \language name to set (without the "\lang@" prefix), the second and
9098 % third args are \{left,right}hyphenmin.
9100 % The language names to pass are determined when the format is built.
9101 % See the etex.log file created at that time, e.g.,
9102 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
9104 % With TeX Live 2008, etex now includes hyphenation patterns for all
9105 % available languages. This means we can support hyphenation in
9106 % Texinfo, at least to some extent. (This still doesn't solve the
9107 % accented characters problem.)
9110 \def\txisetlanguage#1#2#3{%
9111 % do not set the language if the name is undefined in the current TeX.
9112 \expandafter\ifx\csname lang@
#1\endcsname \relax
9113 \message{no patterns for
#1}%
9115 \global\language =
\csname lang@
#1\endcsname
9117 % but there is no harm in adjusting the hyphenmin values regardless.
9118 \global\lefthyphenmin =
#2\relax
9119 \global\righthyphenmin =
#3\relax
9122 % Helpers for encodings.
9123 % Set the catcode of characters 128 through 255 to the specified number.
9125 \def\setnonasciicharscatcode#1{%
9127 \loop\ifnum\count255<
256
9128 \global\catcode\count255=
#1\relax
9129 \advance\count255 by
1
9133 \def\setnonasciicharscatcodenonglobal#1{%
9135 \loop\ifnum\count255<
256
9136 \catcode\count255=
#1\relax
9137 \advance\count255 by
1
9141 % @documentencoding sets the definition of non-ASCII characters
9142 % according to the specified encoding.
9144 \parseargdef\documentencoding{%
9145 % Encoding being declared for the document.
9146 \def\declaredencoding{\csname #1.enc
\endcsname}%
9148 % Supported encodings: names converted to tokens in order to be able
9149 % to compare them with \ifx.
9150 \def\ascii{\csname US-ASCII.enc
\endcsname}%
9151 \def\latnine{\csname ISO-
8859-
15.enc
\endcsname}%
9152 \def\latone{\csname ISO-
8859-
1.enc
\endcsname}%
9153 \def\lattwo{\csname ISO-
8859-
2.enc
\endcsname}%
9154 \def\utfeight{\csname UTF-
8.enc
\endcsname}%
9156 \ifx \declaredencoding \ascii
9159 \else \ifx \declaredencoding \lattwo
9160 \setnonasciicharscatcode\active
9163 \else \ifx \declaredencoding \latone
9164 \setnonasciicharscatcode\active
9167 \else \ifx \declaredencoding \latnine
9168 \setnonasciicharscatcode\active
9171 \else \ifx \declaredencoding \utfeight
9172 \setnonasciicharscatcode\active
9173 % since we already invoked \utfeightchardefs at the top level
9174 % (below), do not re-invoke it, then our check for duplicated
9175 % definitions triggers. Making non-ascii chars active is enough.
9178 \message{Ignoring unknown
document encoding:
#1.
}%
9188 % A message to be logged when using a character that isn't available
9189 % the default font encoding (OT1).
9191 \def\missingcharmsg#1{\message{Character missing, sorry:
#1.
}}
9193 % Take account of \c (plain) vs. \, (Texinfo) difference.
9194 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,
{#1}\fi}
9196 % First, make active non-ASCII characters in order for them to be
9197 % correctly categorized when TeX reads the replacement text of
9198 % macros containing the character definitions.
9199 \setnonasciicharscatcode\active
9201 % Latin1 (ISO-8859-1) character definitions.
9202 \def\latonechardefs{%
9204 \gdef^^a1
{\exclamdown}
9205 \gdef^^a2
{{\tcfont \char162}} % cent
9207 \gdef^^a4
{{\tcfont \char164}} % currency
9208 \gdef^^a5
{{\tcfont \char165}} % yen
9209 \gdef^^a6
{{\tcfont \char166}} % broken bar
9212 \gdef^^a9
{\copyright}
9214 \gdef^^ab
{\guillemetleft}
9215 \gdef^^ac
{\ensuremath\lnot}
9217 \gdef^^ae
{\registeredsymbol}
9220 \gdef^^b0
{\textdegree}
9227 \gdef^^b7
{\ensuremath\cdot}
9228 \gdef^^b8
{\cedilla\
}
9231 \gdef^^bb
{\guillemetright}
9232 \gdef^^bc
{$
1\over4$
}
9233 \gdef^^bd
{$
1\over2$
}
9234 \gdef^^be
{$
3\over4$
}
9235 \gdef^^bf
{\questiondown}
9242 \gdef^^c5
{\ringaccent A
}
9244 \gdef^^c7
{\cedilla C
}
9276 \gdef^^e5
{\ringaccent a
}
9278 \gdef^^e7
{\cedilla c
}
9283 \gdef^^ec
{\`
{\dotless i
}}
9284 \gdef^^ed
{\'
{\dotless i
}}
9285 \gdef^^ee
{\^
{\dotless i
}}
9286 \gdef^^ef
{\"
{\dotless i
}}
9306 % Latin9 (ISO-8859-15) encoding character definitions.
9307 \def\latninechardefs{%
9308 % Encoding is almost identical to Latin1.
9321 % Latin2 (ISO-8859-2) character definitions.
9322 \def\lattwochardefs{%
9324 \gdef^^a1
{\ogonek{A
}}
9327 \gdef^^a4
{\missingcharmsg{CURRENCY SIGN
}}
9333 \gdef^^aa
{\cedilla S
}
9338 \gdef^^af
{\dotaccent Z
}
9340 \gdef^^b0
{\textdegree}
9341 \gdef^^b1
{\ogonek{a
}}
9342 \gdef^^b2
{\ogonek{ }}
9348 \gdef^^b8
{\cedilla\
}
9350 \gdef^^ba
{\cedilla s
}
9355 \gdef^^bf
{\dotaccent z
}
9364 \gdef^^c7
{\cedilla C
}
9367 \gdef^^ca
{\ogonek{E
}}
9383 \gdef^^d9
{\ringaccent U
}
9388 \gdef^^de
{\cedilla T
}
9398 \gdef^^e7
{\cedilla c
}
9401 \gdef^^ea
{\ogonek{e
}}
9404 \gdef^^ed
{\'
{\dotless{i
}}}
9405 \gdef^^ee
{\^
{\dotless{i
}}}
9417 \gdef^^f9
{\ringaccent u
}
9422 \gdef^^fe
{\cedilla t
}
9423 \gdef^^ff
{\dotaccent{}}
9426 % UTF-8 character definitions.
9428 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
9429 % changes for Texinfo conventions. It is included here under the GPL by
9430 % permission from Frank Mittelbach and the LaTeX team.
9436 \gdef\UTFviiiTwoOctets#1#2{\expandafter
9437 \UTFviiiDefined\csname u8:
#1\string #2\endcsname}
9439 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
9440 \UTFviiiDefined\csname u8:
#1\string #2\string #3\endcsname}
9442 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
9443 \UTFviiiDefined\csname u8:
#1\string #2\string #3\string #4\endcsname}
9445 \gdef\UTFviiiDefined#1{%
9447 \message{\linenumber Unicode char
\string #1 not defined for Texinfo
}%
9458 \global\catcode\countUTFx\active
9459 \uccode`\~
\countUTFx
9460 \uppercase\expandafter{\UTFviiiTmp}%
9461 \advance\countUTFx by
1
9462 \ifnum\countUTFx <
\countUTFy
9463 \expandafter\UTFviiiLoop
9469 \xdef~
{\noexpand\UTFviiiTwoOctets\string~
}}
9475 \xdef~
{\noexpand\UTFviiiThreeOctets\string~
}}
9481 \xdef~
{\noexpand\UTFviiiFourOctets\string~
}}
9485 \def\globallet{\global\let} % save some \expandafter's below
9487 % @U{xxxx} to produce U+xxxx, if we support it.
9489 \expandafter\ifx\csname uni:
#1\endcsname \relax
9490 \errhelp =
\EMsimple
9491 \errmessage{Unicode character U+
#1 not supported, sorry
}%
9493 \csname uni:
#1\endcsname
9505 \gdef\DeclareUnicodeCharacter#1#2{%
9506 \countUTFz = "
#1\relax
9507 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9510 \def\UTFviiiTwoOctets#
#1#
#2{%
9511 \csname u8:#
#1\string #
#2\endcsname}%
9512 \def\UTFviiiThreeOctets#
#1#
#2#
#3{%
9513 \csname u8:#
#1\string #
#2\string #
#3\endcsname}%
9514 \def\UTFviiiFourOctets#
#1#
#2#
#3#
#4{%
9515 \csname u8:#
#1\string #
#2\string #
#3\string #
#4\endcsname}%
9516 \expandafter\expandafter\expandafter\expandafter
9517 \expandafter\expandafter\expandafter
9518 \gdef\UTFviiiTmp{#2}%
9520 \expandafter\ifx\csname uni:
#1\endcsname \relax \else
9521 \errmessage{Internal error, already defined:
#1}%
9524 % define an additional control sequence for this code point.
9525 \expandafter\globallet\csname uni:
#1\endcsname \UTFviiiTmp
9528 \gdef\parseXMLCharref{%
9529 \ifnum\countUTFz < "A0
\relax
9530 \errhelp =
\EMsimple
9531 \errmessage{Cannot define Unicode char value <
00A0
}%
9532 \else\ifnum\countUTFz < "
800\relax
9534 \parseUTFviiiB C
\UTFviiiTwoOctets.,
%
9535 \else\ifnum\countUTFz < "
10000\relax
9538 \parseUTFviiiB E
\UTFviiiThreeOctets.
{,;
}%
9543 \parseUTFviiiB F
\UTFviiiFourOctets.
{!,;
}%
9547 \gdef\parseUTFviiiA#1{%
9548 \countUTFx =
\countUTFz
9549 \divide\countUTFz by
64
9550 \countUTFy =
\countUTFz
9551 \multiply\countUTFz by
64
9552 \advance\countUTFx by -
\countUTFz
9553 \advance\countUTFx by
128
9554 \uccode `
#1\countUTFx
9555 \countUTFz =
\countUTFy}
9557 \gdef\parseUTFviiiB#1#2#3#4{%
9558 \advance\countUTFz by "
#10\relax
9559 \uccode `
#3\countUTFz
9560 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9563 % https://en.wikipedia.org/wiki/Plane_(Unicode)#Basic_M
9564 % U+0000..U+007F = https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)
9565 % U+0080..U+00FF = https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)
9566 % U+0100..U+017F = https://en.wikipedia.org/wiki/Latin_Extended-A
9567 % U+0180..U+024F = https://en.wikipedia.org/wiki/Latin_Extended-B
9569 % Many of our renditions are less than wonderful, and all the missing
9570 % characters are available somewhere. Loading the necessary fonts
9571 % awaits user request. We can't truly support Unicode without
9572 % reimplementing everything that's been done in LaTeX for many years,
9573 % plus probably using luatex or xetex, and who knows what else.
9574 % We won't be doing that here in this simple file. But we can try to at
9575 % least make most of the characters not bomb out.
9577 \def\utfeightchardefs{%
9578 \DeclareUnicodeCharacter{00A0
}{\tie}
9579 \DeclareUnicodeCharacter{00A1
}{\exclamdown}
9580 \DeclareUnicodeCharacter{00A2
}{{\tcfont \char162}}% 0242=cent
9581 \DeclareUnicodeCharacter{00A3
}{\pounds}
9582 \DeclareUnicodeCharacter{00A4
}{{\tcfont \char164}}% 0244=currency
9583 \DeclareUnicodeCharacter{00A5
}{{\tcfont \char165}}% 0245=yen
9584 \DeclareUnicodeCharacter{00A6
}{{\tcfont \char166}}% 0246=brokenbar
9585 \DeclareUnicodeCharacter{00A7
}{\S}
9586 \DeclareUnicodeCharacter{00A8
}{\"
{ }}
9587 \DeclareUnicodeCharacter{00A9
}{\copyright}
9588 \DeclareUnicodeCharacter{00AA
}{\ordf}
9589 \DeclareUnicodeCharacter{00AB
}{\guillemetleft}
9590 \DeclareUnicodeCharacter{00AC
}{\ensuremath\lnot}
9591 \DeclareUnicodeCharacter{00AD
}{\-
}
9592 \DeclareUnicodeCharacter{00AE
}{\registeredsymbol}
9593 \DeclareUnicodeCharacter{00AF
}{\=
{ }}
9595 \DeclareUnicodeCharacter{00B0
}{\ringaccent{ }}
9596 \DeclareUnicodeCharacter{00B1
}{\ensuremath\pm}
9597 \DeclareUnicodeCharacter{00B2
}{$^
2$
}
9598 \DeclareUnicodeCharacter{00B3
}{$^
3$
}
9599 \DeclareUnicodeCharacter{00B4
}{\'
{ }}
9600 \DeclareUnicodeCharacter{00B5
}{$
\mu$
}
9601 \DeclareUnicodeCharacter{00B6
}{\P}
9602 \DeclareUnicodeCharacter{00B7
}{\ensuremath\cdot}
9603 \DeclareUnicodeCharacter{00B8
}{\cedilla{ }}
9604 \DeclareUnicodeCharacter{00B9
}{$^
1$
}
9605 \DeclareUnicodeCharacter{00BA
}{\ordm}
9606 \DeclareUnicodeCharacter{00BB
}{\guillemetright}
9607 \DeclareUnicodeCharacter{00BC
}{$
1\over4$
}
9608 \DeclareUnicodeCharacter{00BD
}{$
1\over2$
}
9609 \DeclareUnicodeCharacter{00BE
}{$
3\over4$
}
9610 \DeclareUnicodeCharacter{00BF
}{\questiondown}
9612 \DeclareUnicodeCharacter{00C0
}{\`A
}
9613 \DeclareUnicodeCharacter{00C1
}{\'A
}
9614 \DeclareUnicodeCharacter{00C2
}{\^A
}
9615 \DeclareUnicodeCharacter{00C3
}{\~A
}
9616 \DeclareUnicodeCharacter{00C4
}{\"A
}
9617 \DeclareUnicodeCharacter{00C5
}{\AA}
9618 \DeclareUnicodeCharacter{00C6
}{\AE}
9619 \DeclareUnicodeCharacter{00C7
}{\cedilla{C
}}
9620 \DeclareUnicodeCharacter{00C8
}{\`E
}
9621 \DeclareUnicodeCharacter{00C9
}{\'E
}
9622 \DeclareUnicodeCharacter{00CA
}{\^E
}
9623 \DeclareUnicodeCharacter{00CB
}{\"E
}
9624 \DeclareUnicodeCharacter{00CC
}{\`I
}
9625 \DeclareUnicodeCharacter{00CD
}{\'I
}
9626 \DeclareUnicodeCharacter{00CE
}{\^I
}
9627 \DeclareUnicodeCharacter{00CF
}{\"I
}
9629 \DeclareUnicodeCharacter{00D0
}{\DH}
9630 \DeclareUnicodeCharacter{00D1
}{\~N
}
9631 \DeclareUnicodeCharacter{00D2
}{\`O
}
9632 \DeclareUnicodeCharacter{00D3
}{\'O
}
9633 \DeclareUnicodeCharacter{00D4
}{\^O
}
9634 \DeclareUnicodeCharacter{00D5
}{\~O
}
9635 \DeclareUnicodeCharacter{00D6
}{\"O
}
9636 \DeclareUnicodeCharacter{00D7
}{\ensuremath\times}
9637 \DeclareUnicodeCharacter{00D8
}{\O}
9638 \DeclareUnicodeCharacter{00D9
}{\`U
}
9639 \DeclareUnicodeCharacter{00DA
}{\'U
}
9640 \DeclareUnicodeCharacter{00DB
}{\^U
}
9641 \DeclareUnicodeCharacter{00DC
}{\"U
}
9642 \DeclareUnicodeCharacter{00DD
}{\'Y
}
9643 \DeclareUnicodeCharacter{00DE
}{\TH}
9644 \DeclareUnicodeCharacter{00DF
}{\ss}
9646 \DeclareUnicodeCharacter{00E0
}{\`a
}
9647 \DeclareUnicodeCharacter{00E1
}{\'a
}
9648 \DeclareUnicodeCharacter{00E2
}{\^a
}
9649 \DeclareUnicodeCharacter{00E3
}{\~a
}
9650 \DeclareUnicodeCharacter{00E4
}{\"a
}
9651 \DeclareUnicodeCharacter{00E5
}{\aa}
9652 \DeclareUnicodeCharacter{00E6
}{\ae}
9653 \DeclareUnicodeCharacter{00E7
}{\cedilla{c
}}
9654 \DeclareUnicodeCharacter{00E8
}{\`e
}
9655 \DeclareUnicodeCharacter{00E9
}{\'e
}
9656 \DeclareUnicodeCharacter{00EA
}{\^e
}
9657 \DeclareUnicodeCharacter{00EB
}{\"e
}
9658 \DeclareUnicodeCharacter{00EC
}{\`
{\dotless{i
}}}
9659 \DeclareUnicodeCharacter{00ED
}{\'
{\dotless{i
}}}
9660 \DeclareUnicodeCharacter{00EE
}{\^
{\dotless{i
}}}
9661 \DeclareUnicodeCharacter{00EF
}{\"
{\dotless{i
}}}
9663 \DeclareUnicodeCharacter{00F0
}{\dh}
9664 \DeclareUnicodeCharacter{00F1
}{\~n
}
9665 \DeclareUnicodeCharacter{00F2
}{\`o
}
9666 \DeclareUnicodeCharacter{00F3
}{\'o
}
9667 \DeclareUnicodeCharacter{00F4
}{\^o
}
9668 \DeclareUnicodeCharacter{00F5
}{\~o
}
9669 \DeclareUnicodeCharacter{00F6
}{\"o
}
9670 \DeclareUnicodeCharacter{00F7
}{\ensuremath\div}
9671 \DeclareUnicodeCharacter{00F8
}{\o}
9672 \DeclareUnicodeCharacter{00F9
}{\`u
}
9673 \DeclareUnicodeCharacter{00FA
}{\'u
}
9674 \DeclareUnicodeCharacter{00FB
}{\^u
}
9675 \DeclareUnicodeCharacter{00FC
}{\"u
}
9676 \DeclareUnicodeCharacter{00FD
}{\'y
}
9677 \DeclareUnicodeCharacter{00FE
}{\th}
9678 \DeclareUnicodeCharacter{00FF
}{\"y
}
9680 \DeclareUnicodeCharacter{0100}{\=A
}
9681 \DeclareUnicodeCharacter{0101}{\=a
}
9682 \DeclareUnicodeCharacter{0102}{\u{A
}}
9683 \DeclareUnicodeCharacter{0103}{\u{a
}}
9684 \DeclareUnicodeCharacter{0104}{\ogonek{A
}}
9685 \DeclareUnicodeCharacter{0105}{\ogonek{a
}}
9686 \DeclareUnicodeCharacter{0106}{\'C
}
9687 \DeclareUnicodeCharacter{0107}{\'c
}
9688 \DeclareUnicodeCharacter{0108}{\^C
}
9689 \DeclareUnicodeCharacter{0109}{\^c
}
9690 \DeclareUnicodeCharacter{010A
}{\dotaccent{C
}}
9691 \DeclareUnicodeCharacter{010B
}{\dotaccent{c
}}
9692 \DeclareUnicodeCharacter{010C
}{\v{C
}}
9693 \DeclareUnicodeCharacter{010D
}{\v{c
}}
9694 \DeclareUnicodeCharacter{010E
}{\v{D
}}
9695 \DeclareUnicodeCharacter{010F
}{d'
}
9697 \DeclareUnicodeCharacter{0110}{\DH}
9698 \DeclareUnicodeCharacter{0111}{\dh}
9699 \DeclareUnicodeCharacter{0112}{\=E
}
9700 \DeclareUnicodeCharacter{0113}{\=e
}
9701 \DeclareUnicodeCharacter{0114}{\u{E
}}
9702 \DeclareUnicodeCharacter{0115}{\u{e
}}
9703 \DeclareUnicodeCharacter{0116}{\dotaccent{E
}}
9704 \DeclareUnicodeCharacter{0117}{\dotaccent{e
}}
9705 \DeclareUnicodeCharacter{0118}{\ogonek{E
}}
9706 \DeclareUnicodeCharacter{0119}{\ogonek{e
}}
9707 \DeclareUnicodeCharacter{011A
}{\v{E
}}
9708 \DeclareUnicodeCharacter{011B
}{\v{e
}}
9709 \DeclareUnicodeCharacter{011C
}{\^G
}
9710 \DeclareUnicodeCharacter{011D
}{\^g
}
9711 \DeclareUnicodeCharacter{011E
}{\u{G
}}
9712 \DeclareUnicodeCharacter{011F
}{\u{g
}}
9714 \DeclareUnicodeCharacter{0120}{\dotaccent{G
}}
9715 \DeclareUnicodeCharacter{0121}{\dotaccent{g
}}
9716 \DeclareUnicodeCharacter{0122}{\cedilla{G
}}
9717 \DeclareUnicodeCharacter{0123}{\cedilla{g
}}
9718 \DeclareUnicodeCharacter{0124}{\^H
}
9719 \DeclareUnicodeCharacter{0125}{\^h
}
9720 \DeclareUnicodeCharacter{0126}{\missingcharmsg{H WITH STROKE
}}
9721 \DeclareUnicodeCharacter{0127}{\missingcharmsg{h WITH STROKE
}}
9722 \DeclareUnicodeCharacter{0128}{\~I
}
9723 \DeclareUnicodeCharacter{0129}{\~
{\dotless{i
}}}
9724 \DeclareUnicodeCharacter{012A
}{\=I
}
9725 \DeclareUnicodeCharacter{012B
}{\=
{\dotless{i
}}}
9726 \DeclareUnicodeCharacter{012C
}{\u{I
}}
9727 \DeclareUnicodeCharacter{012D
}{\u{\dotless{i
}}}
9728 \DeclareUnicodeCharacter{012E
}{\ogonek{I
}}
9729 \DeclareUnicodeCharacter{012F
}{\ogonek{i
}}
9731 \DeclareUnicodeCharacter{0130}{\dotaccent{I
}}
9732 \DeclareUnicodeCharacter{0131}{\dotless{i
}}
9733 \DeclareUnicodeCharacter{0132}{IJ
}
9734 \DeclareUnicodeCharacter{0133}{ij
}
9735 \DeclareUnicodeCharacter{0134}{\^J
}
9736 \DeclareUnicodeCharacter{0135}{\^
{\dotless{j
}}}
9737 \DeclareUnicodeCharacter{0136}{\cedilla{K
}}
9738 \DeclareUnicodeCharacter{0137}{\cedilla{k
}}
9739 \DeclareUnicodeCharacter{0138}{\ensuremath\kappa}
9740 \DeclareUnicodeCharacter{0139}{\'L
}
9741 \DeclareUnicodeCharacter{013A
}{\'l
}
9742 \DeclareUnicodeCharacter{013B
}{\cedilla{L
}}
9743 \DeclareUnicodeCharacter{013C
}{\cedilla{l
}}
9744 \DeclareUnicodeCharacter{013D
}{L'
}% should kern
9745 \DeclareUnicodeCharacter{013E
}{l'
}% should kern
9746 \DeclareUnicodeCharacter{013F
}{L
\U{00B7
}}
9748 \DeclareUnicodeCharacter{0140}{l
\U{00B7
}}
9749 \DeclareUnicodeCharacter{0141}{\L}
9750 \DeclareUnicodeCharacter{0142}{\l}
9751 \DeclareUnicodeCharacter{0143}{\'N
}
9752 \DeclareUnicodeCharacter{0144}{\'n
}
9753 \DeclareUnicodeCharacter{0145}{\cedilla{N
}}
9754 \DeclareUnicodeCharacter{0146}{\cedilla{n
}}
9755 \DeclareUnicodeCharacter{0147}{\v{N
}}
9756 \DeclareUnicodeCharacter{0148}{\v{n
}}
9757 \DeclareUnicodeCharacter{0149}{'n
}
9758 \DeclareUnicodeCharacter{014A
}{\missingcharmsg{ENG
}}
9759 \DeclareUnicodeCharacter{014B
}{\missingcharmsg{eng
}}
9760 \DeclareUnicodeCharacter{014C
}{\=O
}
9761 \DeclareUnicodeCharacter{014D
}{\=o
}
9762 \DeclareUnicodeCharacter{014E
}{\u{O
}}
9763 \DeclareUnicodeCharacter{014F
}{\u{o
}}
9765 \DeclareUnicodeCharacter{0150}{\H{O
}}
9766 \DeclareUnicodeCharacter{0151}{\H{o
}}
9767 \DeclareUnicodeCharacter{0152}{\OE}
9768 \DeclareUnicodeCharacter{0153}{\oe}
9769 \DeclareUnicodeCharacter{0154}{\'R
}
9770 \DeclareUnicodeCharacter{0155}{\'r
}
9771 \DeclareUnicodeCharacter{0156}{\cedilla{R
}}
9772 \DeclareUnicodeCharacter{0157}{\cedilla{r
}}
9773 \DeclareUnicodeCharacter{0158}{\v{R
}}
9774 \DeclareUnicodeCharacter{0159}{\v{r
}}
9775 \DeclareUnicodeCharacter{015A
}{\'S
}
9776 \DeclareUnicodeCharacter{015B
}{\'s
}
9777 \DeclareUnicodeCharacter{015C
}{\^S
}
9778 \DeclareUnicodeCharacter{015D
}{\^s
}
9779 \DeclareUnicodeCharacter{015E
}{\cedilla{S
}}
9780 \DeclareUnicodeCharacter{015F
}{\cedilla{s
}}
9782 \DeclareUnicodeCharacter{0160}{\v{S
}}
9783 \DeclareUnicodeCharacter{0161}{\v{s
}}
9784 \DeclareUnicodeCharacter{0162}{\cedilla{T
}}
9785 \DeclareUnicodeCharacter{0163}{\cedilla{t
}}
9786 \DeclareUnicodeCharacter{0164}{\v{T
}}
9787 \DeclareUnicodeCharacter{0165}{\v{t
}}
9788 \DeclareUnicodeCharacter{0166}{\missingcharmsg{H WITH STROKE
}}
9789 \DeclareUnicodeCharacter{0167}{\missingcharmsg{h WITH STROKE
}}
9790 \DeclareUnicodeCharacter{0168}{\~U
}
9791 \DeclareUnicodeCharacter{0169}{\~u
}
9792 \DeclareUnicodeCharacter{016A
}{\=U
}
9793 \DeclareUnicodeCharacter{016B
}{\=u
}
9794 \DeclareUnicodeCharacter{016C
}{\u{U
}}
9795 \DeclareUnicodeCharacter{016D
}{\u{u
}}
9796 \DeclareUnicodeCharacter{016E
}{\ringaccent{U
}}
9797 \DeclareUnicodeCharacter{016F
}{\ringaccent{u
}}
9799 \DeclareUnicodeCharacter{0170}{\H{U
}}
9800 \DeclareUnicodeCharacter{0171}{\H{u
}}
9801 \DeclareUnicodeCharacter{0172}{\ogonek{U
}}
9802 \DeclareUnicodeCharacter{0173}{\ogonek{u
}}
9803 \DeclareUnicodeCharacter{0174}{\^W
}
9804 \DeclareUnicodeCharacter{0175}{\^w
}
9805 \DeclareUnicodeCharacter{0176}{\^Y
}
9806 \DeclareUnicodeCharacter{0177}{\^y
}
9807 \DeclareUnicodeCharacter{0178}{\"Y
}
9808 \DeclareUnicodeCharacter{0179}{\'Z
}
9809 \DeclareUnicodeCharacter{017A
}{\'z
}
9810 \DeclareUnicodeCharacter{017B
}{\dotaccent{Z
}}
9811 \DeclareUnicodeCharacter{017C
}{\dotaccent{z
}}
9812 \DeclareUnicodeCharacter{017D
}{\v{Z
}}
9813 \DeclareUnicodeCharacter{017E
}{\v{z
}}
9814 \DeclareUnicodeCharacter{017F
}{\missingcharmsg{LONG S
}}
9816 \DeclareUnicodeCharacter{01C4
}{D
\v{Z
}}
9817 \DeclareUnicodeCharacter{01C5
}{D
\v{z
}}
9818 \DeclareUnicodeCharacter{01C6
}{d
\v{z
}}
9819 \DeclareUnicodeCharacter{01C7
}{LJ
}
9820 \DeclareUnicodeCharacter{01C8
}{Lj
}
9821 \DeclareUnicodeCharacter{01C9
}{lj
}
9822 \DeclareUnicodeCharacter{01CA
}{NJ
}
9823 \DeclareUnicodeCharacter{01CB
}{Nj
}
9824 \DeclareUnicodeCharacter{01CC
}{nj
}
9825 \DeclareUnicodeCharacter{01CD
}{\v{A
}}
9826 \DeclareUnicodeCharacter{01CE
}{\v{a
}}
9827 \DeclareUnicodeCharacter{01CF
}{\v{I
}}
9829 \DeclareUnicodeCharacter{01D0
}{\v{\dotless{i
}}}
9830 \DeclareUnicodeCharacter{01D1
}{\v{O
}}
9831 \DeclareUnicodeCharacter{01D2
}{\v{o
}}
9832 \DeclareUnicodeCharacter{01D3
}{\v{U
}}
9833 \DeclareUnicodeCharacter{01D4
}{\v{u
}}
9835 \DeclareUnicodeCharacter{01E2
}{\=
{\AE}}
9836 \DeclareUnicodeCharacter{01E3
}{\=
{\ae}}
9837 \DeclareUnicodeCharacter{01E6
}{\v{G
}}
9838 \DeclareUnicodeCharacter{01E7
}{\v{g
}}
9839 \DeclareUnicodeCharacter{01E8
}{\v{K
}}
9840 \DeclareUnicodeCharacter{01E9
}{\v{k
}}
9842 \DeclareUnicodeCharacter{01F0
}{\v{\dotless{j
}}}
9843 \DeclareUnicodeCharacter{01F1
}{DZ
}
9844 \DeclareUnicodeCharacter{01F2
}{Dz
}
9845 \DeclareUnicodeCharacter{01F3
}{dz
}
9846 \DeclareUnicodeCharacter{01F4
}{\'G
}
9847 \DeclareUnicodeCharacter{01F5
}{\'g
}
9848 \DeclareUnicodeCharacter{01F8
}{\`N
}
9849 \DeclareUnicodeCharacter{01F9
}{\`n
}
9850 \DeclareUnicodeCharacter{01FC
}{\'
{\AE}}
9851 \DeclareUnicodeCharacter{01FD
}{\'
{\ae}}
9852 \DeclareUnicodeCharacter{01FE
}{\'
{\O}}
9853 \DeclareUnicodeCharacter{01FF
}{\'
{\o}}
9855 \DeclareUnicodeCharacter{021E
}{\v{H
}}
9856 \DeclareUnicodeCharacter{021F
}{\v{h
}}
9858 \DeclareUnicodeCharacter{0226}{\dotaccent{A
}}
9859 \DeclareUnicodeCharacter{0227}{\dotaccent{a
}}
9860 \DeclareUnicodeCharacter{0228}{\cedilla{E
}}
9861 \DeclareUnicodeCharacter{0229}{\cedilla{e
}}
9862 \DeclareUnicodeCharacter{022E
}{\dotaccent{O
}}
9863 \DeclareUnicodeCharacter{022F
}{\dotaccent{o
}}
9865 \DeclareUnicodeCharacter{0232}{\=Y
}
9866 \DeclareUnicodeCharacter{0233}{\=y
}
9867 \DeclareUnicodeCharacter{0237}{\dotless{j
}}
9869 \DeclareUnicodeCharacter{02DB
}{\ogonek{ }}
9871 \DeclareUnicodeCharacter{1E02
}{\dotaccent{B
}}
9872 \DeclareUnicodeCharacter{1E03
}{\dotaccent{b
}}
9873 \DeclareUnicodeCharacter{1E04
}{\udotaccent{B
}}
9874 \DeclareUnicodeCharacter{1E05
}{\udotaccent{b
}}
9875 \DeclareUnicodeCharacter{1E06
}{\ubaraccent{B
}}
9876 \DeclareUnicodeCharacter{1E07
}{\ubaraccent{b
}}
9877 \DeclareUnicodeCharacter{1E0A
}{\dotaccent{D
}}
9878 \DeclareUnicodeCharacter{1E0B
}{\dotaccent{d
}}
9879 \DeclareUnicodeCharacter{1E0C
}{\udotaccent{D
}}
9880 \DeclareUnicodeCharacter{1E0D
}{\udotaccent{d
}}
9881 \DeclareUnicodeCharacter{1E0E
}{\ubaraccent{D
}}
9882 \DeclareUnicodeCharacter{1E0F
}{\ubaraccent{d
}}
9884 \DeclareUnicodeCharacter{1E1E
}{\dotaccent{F
}}
9885 \DeclareUnicodeCharacter{1E1F
}{\dotaccent{f
}}
9887 \DeclareUnicodeCharacter{1E20
}{\=G
}
9888 \DeclareUnicodeCharacter{1E21
}{\=g
}
9889 \DeclareUnicodeCharacter{1E22
}{\dotaccent{H
}}
9890 \DeclareUnicodeCharacter{1E23
}{\dotaccent{h
}}
9891 \DeclareUnicodeCharacter{1E24
}{\udotaccent{H
}}
9892 \DeclareUnicodeCharacter{1E25
}{\udotaccent{h
}}
9893 \DeclareUnicodeCharacter{1E26
}{\"H
}
9894 \DeclareUnicodeCharacter{1E27
}{\"h
}
9896 \DeclareUnicodeCharacter{1E30
}{\'K
}
9897 \DeclareUnicodeCharacter{1E31
}{\'k
}
9898 \DeclareUnicodeCharacter{1E32
}{\udotaccent{K
}}
9899 \DeclareUnicodeCharacter{1E33
}{\udotaccent{k
}}
9900 \DeclareUnicodeCharacter{1E34
}{\ubaraccent{K
}}
9901 \DeclareUnicodeCharacter{1E35
}{\ubaraccent{k
}}
9902 \DeclareUnicodeCharacter{1E36
}{\udotaccent{L
}}
9903 \DeclareUnicodeCharacter{1E37
}{\udotaccent{l
}}
9904 \DeclareUnicodeCharacter{1E3A
}{\ubaraccent{L
}}
9905 \DeclareUnicodeCharacter{1E3B
}{\ubaraccent{l
}}
9906 \DeclareUnicodeCharacter{1E3E
}{\'M
}
9907 \DeclareUnicodeCharacter{1E3F
}{\'m
}
9909 \DeclareUnicodeCharacter{1E40
}{\dotaccent{M
}}
9910 \DeclareUnicodeCharacter{1E41
}{\dotaccent{m
}}
9911 \DeclareUnicodeCharacter{1E42
}{\udotaccent{M
}}
9912 \DeclareUnicodeCharacter{1E43
}{\udotaccent{m
}}
9913 \DeclareUnicodeCharacter{1E44
}{\dotaccent{N
}}
9914 \DeclareUnicodeCharacter{1E45
}{\dotaccent{n
}}
9915 \DeclareUnicodeCharacter{1E46
}{\udotaccent{N
}}
9916 \DeclareUnicodeCharacter{1E47
}{\udotaccent{n
}}
9917 \DeclareUnicodeCharacter{1E48
}{\ubaraccent{N
}}
9918 \DeclareUnicodeCharacter{1E49
}{\ubaraccent{n
}}
9920 \DeclareUnicodeCharacter{1E54
}{\'P
}
9921 \DeclareUnicodeCharacter{1E55
}{\'p
}
9922 \DeclareUnicodeCharacter{1E56
}{\dotaccent{P
}}
9923 \DeclareUnicodeCharacter{1E57
}{\dotaccent{p
}}
9924 \DeclareUnicodeCharacter{1E58
}{\dotaccent{R
}}
9925 \DeclareUnicodeCharacter{1E59
}{\dotaccent{r
}}
9926 \DeclareUnicodeCharacter{1E5A
}{\udotaccent{R
}}
9927 \DeclareUnicodeCharacter{1E5B
}{\udotaccent{r
}}
9928 \DeclareUnicodeCharacter{1E5E
}{\ubaraccent{R
}}
9929 \DeclareUnicodeCharacter{1E5F
}{\ubaraccent{r
}}
9931 \DeclareUnicodeCharacter{1E60
}{\dotaccent{S
}}
9932 \DeclareUnicodeCharacter{1E61
}{\dotaccent{s
}}
9933 \DeclareUnicodeCharacter{1E62
}{\udotaccent{S
}}
9934 \DeclareUnicodeCharacter{1E63
}{\udotaccent{s
}}
9935 \DeclareUnicodeCharacter{1E6A
}{\dotaccent{T
}}
9936 \DeclareUnicodeCharacter{1E6B
}{\dotaccent{t
}}
9937 \DeclareUnicodeCharacter{1E6C
}{\udotaccent{T
}}
9938 \DeclareUnicodeCharacter{1E6D
}{\udotaccent{t
}}
9939 \DeclareUnicodeCharacter{1E6E
}{\ubaraccent{T
}}
9940 \DeclareUnicodeCharacter{1E6F
}{\ubaraccent{t
}}
9942 \DeclareUnicodeCharacter{1E7C
}{\~V
}
9943 \DeclareUnicodeCharacter{1E7D
}{\~v
}
9944 \DeclareUnicodeCharacter{1E7E
}{\udotaccent{V
}}
9945 \DeclareUnicodeCharacter{1E7F
}{\udotaccent{v
}}
9947 \DeclareUnicodeCharacter{1E80
}{\`W
}
9948 \DeclareUnicodeCharacter{1E81
}{\`w
}
9949 \DeclareUnicodeCharacter{1E82
}{\'W
}
9950 \DeclareUnicodeCharacter{1E83
}{\'w
}
9951 \DeclareUnicodeCharacter{1E84
}{\"W
}
9952 \DeclareUnicodeCharacter{1E85
}{\"w
}
9953 \DeclareUnicodeCharacter{1E86
}{\dotaccent{W
}}
9954 \DeclareUnicodeCharacter{1E87
}{\dotaccent{w
}}
9955 \DeclareUnicodeCharacter{1E88
}{\udotaccent{W
}}
9956 \DeclareUnicodeCharacter{1E89
}{\udotaccent{w
}}
9957 \DeclareUnicodeCharacter{1E8A
}{\dotaccent{X
}}
9958 \DeclareUnicodeCharacter{1E8B
}{\dotaccent{x
}}
9959 \DeclareUnicodeCharacter{1E8C
}{\"X
}
9960 \DeclareUnicodeCharacter{1E8D
}{\"x
}
9961 \DeclareUnicodeCharacter{1E8E
}{\dotaccent{Y
}}
9962 \DeclareUnicodeCharacter{1E8F
}{\dotaccent{y
}}
9964 \DeclareUnicodeCharacter{1E90
}{\^Z
}
9965 \DeclareUnicodeCharacter{1E91
}{\^z
}
9966 \DeclareUnicodeCharacter{1E92
}{\udotaccent{Z
}}
9967 \DeclareUnicodeCharacter{1E93
}{\udotaccent{z
}}
9968 \DeclareUnicodeCharacter{1E94
}{\ubaraccent{Z
}}
9969 \DeclareUnicodeCharacter{1E95
}{\ubaraccent{z
}}
9970 \DeclareUnicodeCharacter{1E96
}{\ubaraccent{h
}}
9971 \DeclareUnicodeCharacter{1E97
}{\"t
}
9972 \DeclareUnicodeCharacter{1E98
}{\ringaccent{w
}}
9973 \DeclareUnicodeCharacter{1E99
}{\ringaccent{y
}}
9975 \DeclareUnicodeCharacter{1EA0
}{\udotaccent{A
}}
9976 \DeclareUnicodeCharacter{1EA1
}{\udotaccent{a
}}
9978 \DeclareUnicodeCharacter{1EB8
}{\udotaccent{E
}}
9979 \DeclareUnicodeCharacter{1EB9
}{\udotaccent{e
}}
9980 \DeclareUnicodeCharacter{1EBC
}{\~E
}
9981 \DeclareUnicodeCharacter{1EBD
}{\~e
}
9983 \DeclareUnicodeCharacter{1ECA
}{\udotaccent{I
}}
9984 \DeclareUnicodeCharacter{1ECB
}{\udotaccent{i
}}
9985 \DeclareUnicodeCharacter{1ECC
}{\udotaccent{O
}}
9986 \DeclareUnicodeCharacter{1ECD
}{\udotaccent{o
}}
9988 \DeclareUnicodeCharacter{1EE4
}{\udotaccent{U
}}
9989 \DeclareUnicodeCharacter{1EE5
}{\udotaccent{u
}}
9991 \DeclareUnicodeCharacter{1EF2
}{\`Y
}
9992 \DeclareUnicodeCharacter{1EF3
}{\`y
}
9993 \DeclareUnicodeCharacter{1EF4
}{\udotaccent{Y
}}
9995 \DeclareUnicodeCharacter{1EF8
}{\~Y
}
9996 \DeclareUnicodeCharacter{1EF9
}{\~y
}
9998 \DeclareUnicodeCharacter{2013}{--
}
9999 \DeclareUnicodeCharacter{2014}{---
}
10000 \DeclareUnicodeCharacter{2018}{\quoteleft}
10001 \DeclareUnicodeCharacter{2019}{\quoteright}
10002 \DeclareUnicodeCharacter{201A
}{\quotesinglbase}
10003 \DeclareUnicodeCharacter{201C
}{\quotedblleft}
10004 \DeclareUnicodeCharacter{201D
}{\quotedblright}
10005 \DeclareUnicodeCharacter{201E
}{\quotedblbase}
10006 \DeclareUnicodeCharacter{2020}{\ensuremath\dagger}
10007 \DeclareUnicodeCharacter{2021}{\ensuremath\ddagger}
10008 \DeclareUnicodeCharacter{2022}{\bullet}
10009 \DeclareUnicodeCharacter{2026}{\dots}
10010 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
10011 \DeclareUnicodeCharacter{203A
}{\guilsinglright}
10012 \DeclareUnicodeCharacter{20AC
}{\euro}
10014 \DeclareUnicodeCharacter{2192}{\expansion}
10015 \DeclareUnicodeCharacter{21D2
}{\result}
10017 \DeclareUnicodeCharacter{2212}{\minus}
10018 \DeclareUnicodeCharacter{2217}{\point}
10019 \DeclareUnicodeCharacter{2225}{\ensuremath\parallel}
10020 \DeclareUnicodeCharacter{2261}{\equiv}
10021 }% end of \utfeightchardefs
10023 % US-ASCII character definitions.
10024 \def\asciichardefs{% nothing need be done
10028 % Latin1 (ISO-8859-1) character definitions.
10029 \def\nonasciistringdefs{%
10030 \setnonasciicharscatcode\active
10031 \def\defstringchar#
#1{\def#
#1{\string#
#1}}%
10033 \defstringchar^^
80\defstringchar^^
81\defstringchar^^
82\defstringchar^^
83%
10034 \defstringchar^^
84\defstringchar^^
85\defstringchar^^
86\defstringchar^^
87%
10035 \defstringchar^^
88\defstringchar^^
89\defstringchar^^
8a
\defstringchar^^
8b
%
10036 \defstringchar^^
8c
\defstringchar^^
8d
\defstringchar^^
8e
\defstringchar^^
8f
%
10038 \defstringchar^^
90\defstringchar^^
91\defstringchar^^
92\defstringchar^^
93%
10039 \defstringchar^^
94\defstringchar^^
95\defstringchar^^
96\defstringchar^^
97%
10040 \defstringchar^^
98\defstringchar^^
99\defstringchar^^
9a
\defstringchar^^
9b
%
10041 \defstringchar^^
9c
\defstringchar^^
9d
\defstringchar^^
9e
\defstringchar^^
9f
%
10043 \defstringchar^^a0
\defstringchar^^a1
\defstringchar^^a2
\defstringchar^^a3
%
10044 \defstringchar^^a4
\defstringchar^^a5
\defstringchar^^a6
\defstringchar^^a7
%
10045 \defstringchar^^a8
\defstringchar^^a9
\defstringchar^^aa
\defstringchar^^ab
%
10046 \defstringchar^^ac
\defstringchar^^ad
\defstringchar^^ae
\defstringchar^^af
%
10048 \defstringchar^^b0
\defstringchar^^b1
\defstringchar^^b2
\defstringchar^^b3
%
10049 \defstringchar^^b4
\defstringchar^^b5
\defstringchar^^b6
\defstringchar^^b7
%
10050 \defstringchar^^b8
\defstringchar^^b9
\defstringchar^^ba
\defstringchar^^bb
%
10051 \defstringchar^^bc
\defstringchar^^bd
\defstringchar^^be
\defstringchar^^bf
%
10053 \defstringchar^^c0
\defstringchar^^c1
\defstringchar^^c2
\defstringchar^^c3
%
10054 \defstringchar^^c4
\defstringchar^^c5
\defstringchar^^c6
\defstringchar^^c7
%
10055 \defstringchar^^c8
\defstringchar^^c9
\defstringchar^^ca
\defstringchar^^cb
%
10056 \defstringchar^^cc
\defstringchar^^cd
\defstringchar^^ce
\defstringchar^^cf
%
10058 \defstringchar^^d0
\defstringchar^^d1
\defstringchar^^d2
\defstringchar^^d3
%
10059 \defstringchar^^d4
\defstringchar^^d5
\defstringchar^^d6
\defstringchar^^d7
%
10060 \defstringchar^^d8
\defstringchar^^d9
\defstringchar^^da
\defstringchar^^db
%
10061 \defstringchar^^dc
\defstringchar^^dd
\defstringchar^^de
\defstringchar^^df
%
10063 \defstringchar^^e0
\defstringchar^^e1
\defstringchar^^e2
\defstringchar^^e3
%
10064 \defstringchar^^e4
\defstringchar^^e5
\defstringchar^^e6
\defstringchar^^e7
%
10065 \defstringchar^^e8
\defstringchar^^e9
\defstringchar^^ea
\defstringchar^^eb
%
10066 \defstringchar^^ec
\defstringchar^^ed
\defstringchar^^ee
\defstringchar^^ef
%
10068 \defstringchar^^f0
\defstringchar^^f1
\defstringchar^^f2
\defstringchar^^f3
%
10069 \defstringchar^^f4
\defstringchar^^f5
\defstringchar^^f6
\defstringchar^^f7
%
10070 \defstringchar^^f8
\defstringchar^^f9
\defstringchar^^fa
\defstringchar^^fb
%
10071 \defstringchar^^fc
\defstringchar^^fd
\defstringchar^^fe
\defstringchar^^ff
%
10075 % define all the unicode characters we know about, for the sake of @U.
10079 % Make non-ASCII characters printable again for compatibility with
10080 % existing Texinfo documents that may use them, even without declaring a
10081 % document encoding.
10083 \setnonasciicharscatcode \other
10086 \message{formatting,
}
10088 \newdimen\defaultparindent \defaultparindent =
15pt
10090 \chapheadingskip =
15pt plus
4pt minus
2pt
10091 \secheadingskip =
12pt plus
3pt minus
2pt
10092 \subsecheadingskip =
9pt plus
2pt minus
2pt
10094 % Prevent underfull vbox error messages.
10097 % Don't be very finicky about underfull hboxes, either.
10100 % Following George Bush, get rid of widows and orphans.
10101 \widowpenalty=
10000
10104 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
10105 % using an old version of TeX, don't do anything. We want the amount of
10106 % stretch added to depend on the line length, hence the dependence on
10107 % \hsize. We call this whenever the paper size is set.
10109 \def\setemergencystretch{%
10110 \ifx\emergencystretch\thisisundefined
10111 % Allow us to assign to \emergencystretch anyway.
10112 \def\emergencystretch{\dimen0}%
10114 \emergencystretch =
.15\hsize
10118 % Parameters in order: 1) textheight; 2) textwidth;
10119 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
10120 % 7) physical page height; 8) physical page width.
10122 % We also call \setleading{\textleading}, so the caller should define
10123 % \textleading. The caller should also set \parskip.
10125 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
10126 \voffset =
#3\relax
10127 \topskip =
#6\relax
10128 \splittopskip =
\topskip
10131 \advance\vsize by
\topskip
10132 \outervsize =
\vsize
10133 \advance\outervsize by
2\topandbottommargin
10134 \pageheight =
\vsize
10137 \outerhsize =
\hsize
10138 \advance\outerhsize by
0.5in
10139 \pagewidth =
\hsize
10141 \normaloffset =
#4\relax
10142 \bindingoffset =
#5\relax
10145 \pdfpageheight #7\relax
10146 \pdfpagewidth #8\relax
10147 % if we don't reset these, they will remain at "1 true in" of
10148 % whatever layout pdftex was dumped with.
10149 \pdfhorigin =
1 true in
10150 \pdfvorigin =
1 true in
10153 \setleading{\textleading}
10155 \parindent =
\defaultparindent
10156 \setemergencystretch
10159 % @letterpaper (the default).
10160 \def\letterpaper{{\globaldefs =
1
10161 \parskip =
3pt plus
2pt minus
1pt
10162 \textleading =
13.2pt
10164 % If page is nothing but text, make it come out even.
10165 \internalpagesizes{607.2pt
}{6in
}% that's 46 lines
10167 {\bindingoffset}{36pt
}%
10171 % Use @smallbook to reset parameters for 7x9.25 trim size.
10172 \def\smallbook{{\globaldefs =
1
10173 \parskip =
2pt plus
1pt
10174 \textleading =
12pt
10176 \internalpagesizes{7.5in
}{5in
}%
10178 {\bindingoffset}{16pt
}%
10181 \lispnarrowing =
0.3in
10184 \contentsrightmargin =
0pt
10185 \defbodyindent =
.5cm
10188 % Use @smallerbook to reset parameters for 6x9 trim size.
10189 % (Just testing, parameters still in flux.)
10190 \def\smallerbook{{\globaldefs =
1
10191 \parskip =
1.5pt plus
1pt
10192 \textleading =
12pt
10194 \internalpagesizes{7.4in
}{4.8in
}%
10199 \lispnarrowing =
0.25in
10202 \contentsrightmargin =
0pt
10203 \defbodyindent =
.4cm
10206 % Use @afourpaper to print on European A4 paper.
10207 \def\afourpaper{{\globaldefs =
1
10208 \parskip =
3pt plus
2pt minus
1pt
10209 \textleading =
13.2pt
10211 % Double-side printing via postscript on Laserjet 4050
10212 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
10213 % To change the settings for a different printer or situation, adjust
10214 % \normaloffset until the front-side and back-side texts align. Then
10215 % do the same for \bindingoffset. You can set these for testing in
10216 % your texinfo source file like this:
10218 % \global\normaloffset = -6mm
10219 % \global\bindingoffset = 10mm
10221 \internalpagesizes{673.2pt
}{160mm
}% that's 51 lines
10222 {\voffset}{\hoffset}%
10223 {\bindingoffset}{44pt
}%
10228 \contentsrightmargin =
0pt
10229 \defbodyindent =
5mm
10232 % Use @afivepaper to print on European A5 paper.
10233 % From romildo@urano.iceb.ufop.br, 2 July 2000.
10234 % He also recommends making @example and @lisp be small.
10235 \def\afivepaper{{\globaldefs =
1
10236 \parskip =
2pt plus
1pt minus
0.1pt
10237 \textleading =
12.5pt
10239 \internalpagesizes{160mm
}{120mm
}%
10240 {\voffset}{\hoffset}%
10241 {\bindingoffset}{8pt
}%
10244 \lispnarrowing =
0.2in
10247 \contentsrightmargin =
0pt
10248 \defbodyindent =
2mm
10249 \tableindent =
12mm
10252 % A specific text layout, 24x15cm overall, intended for A4 paper.
10253 \def\afourlatex{{\globaldefs =
1
10255 \internalpagesizes{237mm
}{150mm
}%
10257 {\bindingoffset}{7mm
}%
10260 % Must explicitly reset to 0 because we call \afourpaper.
10264 % Use @afourwide to print on A4 paper in landscape format.
10265 \def\afourwide{{\globaldefs =
1
10267 \internalpagesizes{241mm
}{165mm
}%
10268 {\voffset}{-
2.95mm
}%
10269 {\bindingoffset}{7mm
}%
10274 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
10275 % Perhaps we should allow setting the margins, \topskip, \parskip,
10276 % and/or leading, also. Or perhaps we should compute them somehow.
10278 \parseargdef\pagesizes{\pagesizesyyy #1,,
\finish}
10279 \def\pagesizesyyy#1,
#2,
#3\finish{{%
10280 \setbox0 =
\hbox{\ignorespaces #2}\ifdim\wd0 >
0pt
\hsize=
#2\relax \fi
10283 \parskip =
3pt plus
2pt minus
1pt
10284 \setleading{\textleading}%
10287 \advance\dimen0 by
\voffset
10290 \advance\dimen2 by
\normaloffset
10292 \internalpagesizes{#1}{\hsize}%
10293 {\voffset}{\normaloffset}%
10294 {\bindingoffset}{44pt
}%
10295 {\dimen0}{\dimen2}%
10298 % Set default to letter.
10303 \message{and turning on texinfo input format.
}
10305 \def^^L
{\par} % remove \outer, so ^L can appear in an @comment
10307 % DEL is a comment character, in case @c does not suffice.
10310 % Define macros to output various characters with catcode for normal text.
10311 \catcode`\"=
\other \def\normaldoublequote{"
}
10312 \catcode`\$=
\other \def\normaldollar{$
}%$ font-lock fix
10313 \catcode`\+=
\other \def\normalplus{+
}
10314 \catcode`\<=
\other \def\normalless{<
}
10315 \catcode`\>=
\other \def\normalgreater{>
}
10316 \catcode`\^=
\other \def\normalcaret{^
}
10317 \catcode`
\_=
\other \def\normalunderscore{_
}
10318 \catcode`\|=
\other \def\normalverticalbar{|
}
10319 \catcode`\~=
\other \def\normaltilde{~
}
10321 % This macro is used to make a character print one way in \tt
10322 % (where it can probably be output as-is), and another way in other fonts,
10323 % where something hairier probably needs to be done.
10325 % #1 is what to print if we are indeed using \tt; #2 is what to print
10326 % otherwise. Since all the Computer Modern typewriter fonts have zero
10327 % interword stretch (and shrink), and it is reasonable to expect all
10328 % typewriter fonts to have this, we can check that font parameter.
10330 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=
0pt
#1\else #2\fi}
10332 % Same as above, but check for italic font. Actually this also catches
10333 % non-italic slanted fonts since it is impossible to distinguish them from
10334 % italic fonts. But since this is only used by $ and it uses \sl anyway
10335 % this is not a problem.
10336 \def\ifusingit#1#2{\ifdim \fontdimen1\font>
0pt
#1\else #2\fi}
10338 % Turn off all special characters except @
10339 % (and those which the user can use as if they were ordinary).
10340 % Most of these we simply print from the \tt font, but for some, we can
10341 % use math or other variants that look better in normal text.
10343 \catcode`\"=
\active
10344 \def\activedoublequote{{\tt\char34}}
10345 \let"=
\activedoublequote
10346 \catcode`\~=
\active \def\activetilde{{\tt\char126}} \let~ =
\activetilde
10347 \chardef\hatchar=`\^
10348 \catcode`\^=
\active \def\activehat{{\tt \hatchar}} \let^ =
\activehat
10350 \catcode`
\_=
\active
10351 \def_{\ifusingtt\normalunderscore\_}
10353 % Subroutine for the previous macro.
10354 \def\_{\leavevmode \kern.07em
\vbox{\hrule width
.3em height
.1ex
}\kern .07em
}
10356 \catcode`\|=
\active
10357 \def|
{{\tt\char124}}
10360 \catcode`\<=
\active \def\activeless{{\tt \less}}\let< =
\activeless
10362 \catcode`\>=
\active \def\activegtr{{\tt \gtr}}\let> =
\activegtr
10363 \catcode`\+=
\active \def+
{{\tt \char 43}}
10364 \catcode`\$=
\active \def$
{\ifusingit{{\sl\$
}}\normaldollar}%$ font-lock fix
10365 \catcode`\-=
\active \let-=
\normaldash
10368 % used for headline/footline in the output routine, in case the page
10369 % breaks in the middle of an @tex block.
10370 \def\texinfochars{%
10371 \let< =
\activeless
10373 \let~ =
\activetilde
10375 \markupsetuplqdefault \markupsetuprqdefault
10377 \let\i =
\smartitalic
10378 % in principle, all other definitions in \tex have to be undone too.
10381 % Used sometimes to turn off (effectively) the active characters even after
10383 \def\turnoffactive{%
10384 \normalturnoffactive
10390 % \backslashcurfont outputs one backslash character in current font,
10392 \global\chardef\backslashcurfont=`\\
10393 \global\let\rawbackslashxx=
\backslashcurfont % let existing .??s files work
10395 % \realbackslash is an actual character `\' with catcode other, and
10396 % \doublebackslash is two of them (for the pdf outlines).
10397 {\catcode`\\=
\other @gdef@realbackslash
{\
} @gdef@doublebackslash
{\\
}}
10399 % In Texinfo, backslash is an active character; it prints the backslash
10400 % in fixed width font.
10401 \catcode`\\=
\active % @ for escape char from now on.
10403 % Print a typewriter backslash. For math mode, we can't simply use
10404 % \backslashcurfont: the story here is that in math mode, the \char
10405 % of \backslashcurfont ends up printing the roman \ from the math symbol
10406 % font (because \char in math mode uses the \mathcode, and plain.tex
10407 % sets \mathcode`\\="026E). Hence we use an explicit \mathchar,
10408 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
10409 % ignored family value; char position "5C). We can't use " for the
10410 % usual hex value because it has already been made active.
10412 @def@ttbackslash
{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi
}}
10413 @let@backslashchar = @ttbackslash
% @backslashchar{} is for user documents.
10415 % \rawbackslash defines an active \ to do \backslashcurfont.
10416 % \otherbackslash defines an active \ to be a literal `\' character with
10417 % catcode other. We switch back and forth between these.
10418 @gdef@rawbackslash
{@let\=@backslashcurfont
}
10419 @gdef@otherbackslash
{@let\=@realbackslash
}
10421 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
10422 % the literal character `\'.
10424 {@catcode`- = @active
10425 @gdef@normalturnoffactive
{%
10426 @nonasciistringdefs
10428 @let"=@normaldoublequote
10429 @let$=@normaldollar
%$ font-lock fix
10432 @let>=@normalgreater
10434 @let_=@normalunderscore
10435 @let|=@normalverticalbar
10438 @markupsetuplqdefault
10439 @markupsetuprqdefault
10444 % If a .fmt file is being used, characters that might appear in a file
10445 % name cannot be active until we have parsed the command line.
10446 % So turn them off again, and have @fixbackslash turn them back on.
10447 @catcode`+=@other @catcode`@_=@other
10449 % \enablebackslashhack - allow file to begin `\input texinfo'
10451 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
10452 % That is what \eatinput is for; after that, the `\' should revert to printing
10454 % If the file did not have a `\input texinfo', then it is turned off after
10455 % the first line; otherwise the first `\' in the file would cause an error.
10456 % This is used on the very last line of this file, texinfo.tex.
10457 % We also use @c to call @fixbackslash, in case ends of lines are hidden.
10460 @catcode`@^^M=
13@gdef@enablebackslashhack
{%
10461 @global@let\ = @eatinput
%
10463 @def@c
{@fixbackslash@c
}%
10464 @def ^^M
{@let^^M@secondlinenl
}%
10465 @gdef @secondlinenl
{@let^^M@thirdlinenl
}%
10466 @gdef @thirdlinenl
{@fixbackslash
}%
10469 {@catcode`@^=
7 @catcode`@^^M=
13%
10470 @gdef@eatinput input texinfo
#1^^M
{@fixbackslash
}}
10472 @gdef@fixbackslash
{%
10473 @ifx\@eatinput @let\ = @ttbackslash @fi
10474 @catcode13=
5 % regular end of line
10476 % Also turn back on active characters that might appear in the input
10477 % file name, in case not using a pre-dumped format.
10479 @catcode`@_=@active
10483 % Say @foo, not \foo, in error messages.
10486 % These (along with & and #) are made active for url-breaking, so need
10487 % active definitions as the normal characters.
10489 @def@normalquest
{?
}
10490 @def@normalslash
{/
}
10492 % These look ok in all fonts, so just make them not special.
10493 % @hashchar{} gets its own user-level command, because of #line.
10494 @catcode`@& = @other @def@normalamp
{&
}
10495 @catcode`@# = @other @def@normalhash
{#
}
10496 @catcode`@
% = @other @def@normalpercent{%}
10498 @let @hashchar = @normalhash
10500 @c Finally, make ` and ' active, so that txicodequoteundirected and
10501 @c txicodequotebacktick work right in, e.g., @w
{@code
{`foo'
}}. If we
10502 @c don't make ` and ' active, @code will not get them as active chars.
10503 @c Do this last of all since we use ` in the previous @catcode assignments.
10504 @catcode`@'=@active
10505 @catcode`@`=@active
10506 @markupsetuplqdefault
10507 @markupsetuprqdefault
10509 @c Local variables:
10510 @c eval: (add-hook 'write-file-hooks 'time-stamp)
10511 @c page-delimiter: "^\\\
\message\\|emacs-page"
10512 @c time-stamp-start: "def\\\
\texinfoversion{"
10513 @c time-stamp-format: "
%:y-%02m-%02d.%02H"
10514 @c time-stamp-end: "
}"
10520 arch-tag: e1b36e32-c96e-4135-a41a-
0b2efa2ea115
10522 @enablebackslashhack