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{2010-05-22.17}
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 Free Software Foundation, Inc.
12 % This texinfo.tex file is free software: you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation, either version 3 of the
15 % License, or (at your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this program. If not, see <http://www.gnu.org/licenses/>.
25 % As a special exception, when this file is read by TeX when processing
26 % a Texinfo source document, you may use the result without
27 % restriction. (This has been our intent since Texinfo was invented.)
29 % Please try the latest version of texinfo.tex before submitting bug
30 % reports; you can get the latest version from:
31 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
32 % ftp://tug.org/tex/texinfo.tex
33 % (and all CTAN mirrors, see http://www.ctan.org).
34 % The texinfo.tex in any given distribution could well be out
35 % of date, so if that's what you're using, please check.
37 % Send bug reports to bug-texinfo@gnu.org. Please include including a
38 % complete document in each bug report with which we can reproduce the
39 % problem. Patches are, of course, greatly appreciated.
41 % To process a Texinfo manual with TeX, it's most reliable to use the
42 % texi2dvi shell script that comes with the distribution. For a simple
43 % manual foo.texi, however, you can get away with this:
48 % dvips foo.dvi -o # or whatever; this makes foo.ps.
49 % The extra TeX runs get the cross-reference information correct.
50 % Sometimes one run after texindex suffices, and sometimes you need more
51 % than two; texi2dvi does it as many times as necessary.
53 % It is possible to adapt texinfo.tex for other languages, to some
54 % extent. You can get the existing language-specific files from the
55 % full Texinfo distribution.
57 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60 \message{Loading texinfo [version \texinfoversion]:}
62 % If in a .fmt file, print the version number
63 % and turn on active characters that we couldn't do earlier because
64 % they might have appeared in the input file name.
65 \everyjob{\message{[Texinfo version \texinfoversion]}%
66 \catcode`+=\active \catcode`\_=\active}
70 % We never want plain's \outer definition of \+ in Texinfo.
71 % For @tex, we can use \tabalign.
74 % Save some plain tex macros whose names we will redefine.
76 \let\ptexbullet=\bullet
84 \let\ptexfootnote=\footnote
88 \let\ptexindent=\indent
89 \let\ptexinsert=\insert
92 \let\ptexnewwrite\newwrite
93 \let\ptexnoindent=\noindent
95 \let\ptexraggedright=\raggedright
101 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
103 % If this character appears in an error message or help string, it
104 % starts a new line in the output.
107 % Use TeX 3.0's \inputlineno to get the line number, for better error
108 % messages, but if we're using an old version of TeX, don't do anything.
110 \ifx\inputlineno\thisisundefined
111 \let\linenumber = \empty % Pre-3.0.
113 \def\linenumber{l.\the\inputlineno:\space}
116 % Set up fixed words for English if not already set.
117 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
118 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
119 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
120 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
121 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
122 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
123 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
124 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
125 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
126 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
127 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
128 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
129 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
130 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
131 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
132 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
133 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
134 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
135 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
137 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
138 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
139 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
140 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
141 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
142 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
143 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
144 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
145 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
146 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
147 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
148 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
150 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
151 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
152 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
153 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
154 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
156 % Since the category of space is not known, we have to be careful.
157 \chardef\spacecat = 10
158 \def\spaceisspace{\catcode`\ =\spacecat}
160 % sometimes characters are active, so we need control sequences.
161 \chardef\colonChar = `\:
162 \chardef\commaChar = `\,
163 \chardef\dashChar = `\-
164 \chardef\dotChar = `\.
165 \chardef\exclamChar= `\!
166 \chardef\lquoteChar= `\`
167 \chardef\questChar = `\?
168 \chardef\rquoteChar= `\'
169 \chardef\semiChar = `\;
170 \chardef\underChar = `\_
176 % The following is used inside several \edef's.
177 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
181 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
182 ap-pen-dix bit-map bit-maps
183 data-base data-bases eshell fall-ing half-way long-est man-u-script
184 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
185 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
187 stand-alone strong-est time-stamp time-stamps which-ever white-space
188 wide-spread wrap-around
191 % Margin to add to right of even pages, to left of odd pages.
192 \newdimen\bindingoffset
193 \newdimen\normaloffset
194 \newdimen\pagewidth \newdimen\pageheight
196 % For a final copy, take out the rectangles
197 % that mark overfull boxes (in case you have decided
198 % that the text looks ok even though it passes the margin).
200 \def\finalout{\overfullrule=0pt }
202 % Sometimes it is convenient to have everything in the transcript file
203 % and nothing on the terminal. We don't just call \tracingall here,
204 % since that produces some useless output on the terminal. We also make
205 % some effort to order the tracing commands to reduce output in the log
206 % file; cf. trace.sty in LaTeX.
208 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
212 \tracinglostchars2 % 2 gives us more in etex
217 \showboxbreadth\maxdimen \showboxdepth\maxdimen
218 \ifx\eTeXversion\undefined\else % etex gives us more logging
225 \tracingcommands3 % 3 gives us more in etex
229 % add check for \lastpenalty to plain's definitions. If the last thing
230 % we did was a \nobreak, we don't want to insert more space.
232 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
233 \removelastskip\penalty-50\smallskip\fi\fi}
234 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
235 \removelastskip\penalty-100\medskip\fi\fi}
236 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
237 \removelastskip\penalty-200\bigskip\fi\fi}
239 % Do @cropmarks to get crop marks.
242 \let\cropmarks = \cropmarkstrue
244 % Dimensions to add cropmarks at corners.
245 % Added by P. A. MacKay, 12 Nov. 1986
247 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
248 \newdimen\cornerlong \cornerlong=1pc
249 \newdimen\cornerthick \cornerthick=.3pt
250 \newdimen\topandbottommargin \topandbottommargin=.75in
252 % Output a mark which sets \thischapter, \thissection and \thiscolor.
253 % We dump everything together because we only have one kind of mark.
254 % This works because we only use \botmark / \topmark, not \firstmark.
256 % A mark contains a subexpression of the \ifcase ... \fi construct.
257 % \get*marks macros below extract the needed part using \ifcase.
259 % Another complication is to let the user choose whether \thischapter
260 % (\thissection) refers to the chapter (section) in effect at the top
261 % of a page, or that at the bottom of a page. The solution is
262 % described on page 260 of The TeXbook. It involves outputting two
263 % marks for the sectioning macros, one before the section break, and
264 % one after. I won't pretend I can describe this better than DEK...
266 \toks0=\expandafter{\lastchapterdefs}%
267 \toks2=\expandafter{\lastsectiondefs}%
268 \toks4=\expandafter{\prevchapterdefs}%
269 \toks6=\expandafter{\prevsectiondefs}%
270 \toks8=\expandafter{\lastcolordefs}%
272 \the\toks0 \the\toks2
273 \noexpand\or \the\toks4 \the\toks6
274 \noexpand\else \the\toks8
277 % \topmark doesn't work for the very first chapter (after the title
278 % page or the contents), so we use \firstmark there -- this gets us
279 % the mark with the chapter defs, unless the user sneaks in, e.g.,
280 % @setcolor (or @url, or @link, etc.) between @contents and the very
282 \def\gettopheadingmarks{%
284 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
286 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
287 \def\getcolormarks{\ifcase2\topmark\fi}
289 % Avoid "undefined control sequence" errors.
290 \def\lastchapterdefs{}
291 \def\lastsectiondefs{}
292 \def\prevchapterdefs{}
293 \def\prevsectiondefs{}
296 % Main output routine.
298 \output = {\onepageout{\pagecontents\PAGE}}
303 % \onepageout takes a vbox as an argument. Note that \pagecontents
304 % does insertions, but you have to call it yourself.
306 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
308 \ifodd\pageno \advance\hoffset by \bindingoffset
309 \else \advance\hoffset by -\bindingoffset\fi
311 % Do this outside of the \shipout so @code etc. will be expanded in
312 % the headline as they should be, not taken literally (outputting ''code).
313 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
314 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
315 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
316 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
319 % Have to do this stuff outside the \shipout because we want it to
320 % take effect in \write's, yet the group defined by the \vbox ends
321 % before the \shipout runs.
323 \indexdummies % don't expand commands in the output.
324 \normalturnoffactive % \ in index entries must not stay \, e.g., if
325 % the page break happens to be in the middle of an example.
326 % We don't want .vr (or whatever) entries like this:
327 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
328 % "\acronym" won't work when it's read back in;
330 % {\code {{\tt \backslashcurfont }acronym}
332 % Do this early so pdf references go to the beginning of the page.
333 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
335 \ifcropmarks \vbox to \outervsize\bgroup
337 \vskip-\topandbottommargin
339 \line{\ewtop\hfil\ewtop}%
342 \vbox{\moveleft\cornerthick\nstop}%
344 \vbox{\moveright\cornerthick\nstop}%
347 \vskip\topandbottommargin
349 \hfil % center the page within the outer (page) hsize.
350 \ifodd\pageno\hskip\bindingoffset\fi
356 \ifdim\ht\footlinebox > 0pt
357 % Only leave this space if the footline is nonempty.
358 % (We lessened \vsize for it in \oddfootingyyy.)
359 % The \baselineskip=24pt in plain's \makefootline has no effect.
365 \egroup % end of \vbox\bgroup
366 \hfil\egroup % end of (centering) \line\bgroup
367 \vskip\topandbottommargin plus1fill minus1fill
368 \boxmaxdepth = \cornerthick
371 \vbox{\moveleft\cornerthick\nsbot}%
373 \vbox{\moveright\cornerthick\nsbot}%
376 \line{\ewbot\hfil\ewbot}%
378 \egroup % \vbox from first cropmarks clause
380 }% end of \shipout\vbox
381 }% end of group with \indexdummies
383 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
386 \newinsert\margin \dimen\margin=\maxdimen
388 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
390 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
391 % marginal hacks, juha@viisa.uucp (Juha Takala)
392 \ifvoid\margin\else % marginal info is present
393 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
394 \dimen@=\dp#1\relax \unvbox#1\relax
395 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
396 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
399 % Here are the rules for the cropmarks. Note that they are
400 % offset so that the space between them is truly \outerhsize or \outervsize
401 % (P. A. MacKay, 12 November, 1986)
403 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
405 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
406 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
408 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
410 % Parse an argument, then pass it to #1. The argument is the rest of
411 % the input line (except we remove a trailing comment). #1 should be a
412 % macro which expects an ordinary undelimited TeX argument.
414 \def\parsearg{\parseargusing{}}
415 \def\parseargusing#1#2{%
421 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
425 \gdef\parseargline#1^^M{%
426 \endgroup % End of the group started in \parsearg.
427 \argremovecomment #1\comment\ArgTerm%
431 % First remove any @comment, then any @c comment.
432 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
433 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
435 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
437 % \argremovec might leave us with trailing space, e.g.,
438 % @end itemize @c foo
439 % This space token undergoes the same procedure and is eventually removed
440 % by \finishparsearg.
442 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
443 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
444 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
447 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
448 \let\temp\finishparsearg
450 \let\temp\argcheckspaces
452 % Put the space token in:
456 % If a _delimited_ argument is enclosed in braces, they get stripped; so
457 % to get _exactly_ the rest of the line, we had to prevent such situation.
458 % We prepended an \empty token at the very beginning and we expand it now,
459 % just before passing the control to \argtorun.
460 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
461 % either the null string, or it ends with \^^M---thus there is no danger
462 % that a pair of braces would be stripped.
464 % But first, we have to remove the trailing space token.
466 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
468 % \parseargdef\foo{...}
469 % is roughly equivalent to
470 % \def\foo{\parsearg\Xfoo}
473 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
474 % favourite TeX trick. --kasal, 16nov03
477 \expandafter \doparseargdef \csname\string#1\endcsname #1%
479 \def\doparseargdef#1#2{%
484 % Several utility definitions with active space:
489 % Make each space character in the input produce a normal interword
490 % space in the output. Don't allow a line break at this space, as this
491 % is used only in environments like @example, where each line of input
492 % should produce a line of output anyway.
494 \gdef\sepspaces{\obeyspaces\let =\tie}
496 % If an index command is used in an @example environment, any spaces
497 % therein should become regular spaces in the raw index file, not the
498 % expansion of \tie (\leavevmode \penalty \@M \ ).
499 \gdef\unsepspaces{\let =\space}
503 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
505 % Define the framework for environments in texinfo.tex. It's used like this:
510 % It's the responsibility of \envdef to insert \begingroup before the
511 % actual body; @end closes the group after calling \Efoo. \envdef also
512 % defines \thisenv, so the current environment is known; @end checks
513 % whether the environment name matches. The \checkenv macro can also be
514 % used to check whether the current environment is the one expected.
516 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
517 % are not treated as environments; they don't open a group. (The
518 % implementation of @end takes care not to call \endgroup in this
522 % At run-time, environments start with this:
523 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
527 % ... but they get defined via ``\envdef\foo{...}'':
528 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
529 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
531 % Check whether we're in the right environment:
540 % Environment mismatch, #1 expected:
543 \errmessage{This command can appear only \inenvironment\temp,
544 not \inenvironment\thisenv}%
546 \def\inenvironment#1{%
548 out of any environment%
550 in environment \expandafter\string#1%
554 % @end foo executes the definition of \Efoo.
555 % But first, it executes a specialized version of \checkenv
558 \if 1\csname iscond.#1\endcsname
560 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
561 \expandafter\checkenv\csname#1\endcsname
562 \csname E#1\endcsname
567 \newhelp\EMsimple{Press RETURN to continue.}
570 % Be sure we're in horizontal mode when doing a tie, since we make space
571 % equivalent to this in @example-like environments. Otherwise, a space
572 % at the beginning of a line will start with \penalty -- and
573 % since \penalty is valid in vertical mode, we'd end up putting the
574 % penalty on the vertical list instead of in the new paragraph.
576 % Avoid using \@M directly, because that causes trouble
577 % if the definition is written into an index file.
578 \global\let\tiepenalty = \@M
579 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
582 % @: forces normal size whitespace following.
583 \def\:{\spacefactor=1000 }
585 % @* forces a line break.
586 \def\*{\hfil\break\hbox{}\ignorespaces}
588 % @/ allows a line break.
591 % @. is an end-of-sentence period.
592 \def\.{.\spacefactor=\endofsentencespacefactor\space}
594 % @! is an end-of-sentence bang.
595 \def\!{!\spacefactor=\endofsentencespacefactor\space}
597 % @? is an end-of-sentence query.
598 \def\?{?\spacefactor=\endofsentencespacefactor\space}
600 % @frenchspacing on|off says whether to put extra space after punctuation.
605 \parseargdef\frenchspacing{%
607 \ifx\temp\onword \plainfrenchspacing
608 \else\ifx\temp\offword \plainnonfrenchspacing
611 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
615 % @w prevents a word break. Without the \leavevmode, @w at the
616 % beginning of a paragraph, when TeX is still in vertical mode, would
617 % produce a whole line of output instead of starting the paragraph.
618 \def\w#1{\leavevmode\hbox{#1}}
620 % @group ... @end group forces ... to be all on one page, by enclosing
621 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
622 % to keep its height that of a normal line. According to the rules for
623 % \topskip (p.114 of the TeXbook), the glue inserted is
624 % max (\topskip - \ht (first item), 0). If that height is large,
625 % therefore, no glue is inserted, and the space between the headline and
626 % the text is small, which looks bad.
628 % Another complication is that the group might be very large. This can
629 % cause the glue on the previous page to be unduly stretched, because it
630 % does not have much material. In this case, it's better to add an
631 % explicit \vfill so that the extra space is at the bottom. The
632 % threshold for doing this is if the group is more than \vfilllimit
633 % percent of a page (\vfilllimit can be changed inside of @tex).
639 \ifnum\catcode`\^^M=\active \else
640 \errhelp = \groupinvalidhelp
641 \errmessage{@group invalid in context where filling is enabled}%
645 \setbox\groupbox = \vtop\bgroup
646 % Do @comment since we are called inside an environment such as
647 % @example, where each end-of-line in the input causes an
648 % end-of-line in the output. We don't want the end-of-line after
649 % the `@group' to put extra space in the output. Since @group
650 % should appear on a line by itself (according to the Texinfo
651 % manual), we don't worry about eating any user text.
655 % The \vtop produces a box with normal height and large depth; thus, TeX puts
656 % \baselineskip glue before it, and (when the next line of text is done)
657 % \lineskip glue after it. Thus, space below is not quite equal to space
658 % above. But it's pretty close.
660 % To get correct interline space between the last line of the group
661 % and the first line afterwards, we have to propagate \prevdepth.
662 \endgraf % Not \par, as it may have been set to \lisppar.
663 \global\dimen1 = \prevdepth
664 \egroup % End the \vtop.
665 % \dimen0 is the vertical size of the group's box.
666 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
667 % \dimen2 is how much space is left on the page (more or less).
668 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
669 % if the group doesn't fit on the current page, and it's a big big
670 % group, force a page break.
671 \ifdim \dimen0 > \dimen2
672 \ifdim \pagetotal < \vfilllimit\pageheight
681 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
682 % message, so this ends up printing `@group can only ...'.
684 \newhelp\groupinvalidhelp{%
685 group can only be used in environments such as @example,^^J%
686 where each line of input produces a line of output.}
688 % @need space-in-mils
689 % forces a page break if there is not space-in-mils remaining.
691 \newdimen\mil \mil=0.001in
693 % Old definition--didn't work.
694 %\parseargdef\need{\par %
695 %% This method tries to make TeX break the page naturally
696 %% if the depth of the box does not fit.
698 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
703 % Ensure vertical mode, so we don't make a big box in the middle of a
707 % If the @need value is less than one line space, it's useless.
709 \dimen2 = \ht\strutbox
710 \advance\dimen2 by \dp\strutbox
711 \ifdim\dimen0 > \dimen2
713 % Do a \strut just to make the height of this box be normal, so the
714 % normal leading is inserted relative to the preceding line.
715 % And a page break here is fine.
716 \vtop to #1\mil{\strut\vfil}%
718 % TeX does not even consider page breaks if a penalty added to the
719 % main vertical list is 10000 or more. But in order to see if the
720 % empty box we just added fits on the page, we must make it consider
721 % page breaks. On the other hand, we don't want to actually break the
722 % page after the empty box. So we use a penalty of 9999.
724 % There is an extremely small chance that TeX will actually break the
725 % page at this \penalty, if there are no other feasible breakpoints in
726 % sight. (If the user is using lots of big @group commands, which
727 % almost-but-not-quite fill up a page, TeX will have a hard time doing
728 % good page breaking, for example.) However, I could not construct an
729 % example where a page broke at this \penalty; if it happens in a real
730 % document, then we can reconsider our strategy.
733 % Back up by the size of the box, whether we did a page break or not.
736 % Do not allow a page break right after this kern.
741 % @br forces paragraph break (and is undocumented).
745 % @page forces the start of a new page.
747 \def\page{\par\vfill\supereject}
750 % outputs text on separate line in roman font, starting at standard page margin
752 % This records the amount of indent in the innermost environment.
753 % That's how much \exdent should take out.
754 \newskip\exdentamount
756 % This defn is used inside fill environments such as @defun.
757 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
759 % This defn is used inside nofill environments such as @example.
760 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
761 \leftline{\hskip\leftskip{\rm#1}}}}
763 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
764 % paragraph. For more general purposes, use the \margin insertion
765 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
767 \newskip\inmarginspacing \inmarginspacing=1cm
768 \def\strutdepth{\dp\strutbox}
770 \def\doinmargin#1#2{\strut\vadjust{%
773 \vtop to \strutdepth{%
774 \baselineskip=\strutdepth
776 % if you have multiple lines of stuff to put here, you'll need to
777 % make the vbox yourself of the appropriate size.
779 \llap{\ignorespaces #2\hskip\inmarginspacing}%
781 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
786 \def\inleftmargin{\doinmargin l}
787 \def\inrightmargin{\doinmargin r}
789 % @inmargin{TEXT [, RIGHT-TEXT]}
790 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
791 % else use TEXT for both).
793 \def\inmargin#1{\parseinmargin #1,,\finish}
794 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
795 \setbox0 = \hbox{\ignorespaces #2}%
797 \def\lefttext{#1}% have both texts
800 \def\lefttext{#1}% have only one text
805 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
807 \def\temp{\inleftmargin\lefttext}%
812 % @| inserts a changebar to the left of the current line. It should
813 % surround any changed text. This approach does *not* work if the
814 % change spans more than two lines of output. To handle that, we would
815 % have adopt a much more difficult approach (putting marks into the main
816 % vertical list for the beginning and end of each change). This command
817 % is not documented, not supported, and doesn't work.
820 % \vadjust can only be used in horizontal mode.
823 % Append this vertical mode material after the current line in the output.
825 % We want to insert a rule with the height and depth of the current
826 % leading; that is exactly what \strutbox is supposed to record.
829 % \vadjust-items are inserted at the left edge of the type. So
830 % the \llap here moves out into the left-hand margin.
833 % For a thicker or thinner bar, change the `1pt'.
834 \vrule height\baselineskip width1pt
836 % This is the space between the bar and the text.
842 % @include FILE -- \input text of FILE.
844 \def\include{\parseargusing\filenamecatcodes\includezzz}
849 \makevalueexpandable % we want to expand any @value in FILE.
850 \turnoffactive % and allow special characters in the expansion
851 \indexnofonts % Allow `@@' and other weird things in file names.
852 \edef\temp{\noexpand\input #1 }%
854 % This trickery is to read FILE outside of a group, in case it makes
860 \def\filenamecatcodes{%
874 \def\pushthisfilestack{%
875 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
877 \def\pushthisfilestackX{%
878 \expandafter\pushthisfilestackY\thisfile\StackTerm
880 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
881 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
884 \def\popthisfilestack{\errthisfilestackempty}
885 \def\errthisfilestackempty{\errmessage{Internal error:
886 the stack of filenames is empty.}}
891 % outputs that line, centered.
893 \parseargdef\center{%
899 \next{\hfil \ignorespaces#1\unskip \hfil}%
904 \advance\hsize by -\leftskip
905 \advance\hsize by -\rightskip
910 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
912 % @sp n outputs n lines of vertical space
914 \parseargdef\sp{\vskip #1\baselineskip}
916 % @comment ...line which is ignored...
917 % @c is the same as @comment
918 % @ignore ... @end ignore is another way to write a comment
920 \def\comment{\begingroup \catcode`\^^M=\other%
921 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
923 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
927 % @paragraphindent NCHARS
928 % We'll use ems for NCHARS, close enough.
929 % NCHARS can also be the word `asis' or `none'.
930 % We cannot feasibly implement @paragraphindent asis, though.
932 \def\asisword{asis} % no translation, these are keywords
935 \parseargdef\paragraphindent{%
940 \defaultparindent = 0pt
942 \defaultparindent = #1em
945 \parindent = \defaultparindent
948 % @exampleindent NCHARS
949 % We'll use ems for NCHARS like @paragraphindent.
950 % It seems @exampleindent asis isn't necessary, but
951 % I preserve it to make it similar to @paragraphindent.
952 \parseargdef\exampleindent{%
959 \lispnarrowing = #1em
964 % @firstparagraphindent WORD
965 % If WORD is `none', then suppress indentation of the first paragraph
966 % after a section heading. If WORD is `insert', then do indent at such
969 % The paragraph indentation is suppressed or not by calling
970 % \suppressfirstparagraphindent, which the sectioning commands do.
971 % We switch the definition of this back and forth according to WORD.
972 % By default, we suppress indentation.
974 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
975 \def\insertword{insert}
977 \parseargdef\firstparagraphindent{%
980 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
981 \else\ifx\temp\insertword
982 \let\suppressfirstparagraphindent = \relax
985 \errmessage{Unknown @firstparagraphindent option `\temp'}%
989 % Here is how we actually suppress indentation. Redefine \everypar to
990 % \kern backwards by \parindent, and then reset itself to empty.
992 % We also make \indent itself not actually do anything until the next
995 \gdef\dosuppressfirstparagraphindent{%
997 \restorefirstparagraphindent
1001 \restorefirstparagraphindent
1004 \global\everypar = {%
1006 \restorefirstparagraphindent
1010 \gdef\restorefirstparagraphindent{%
1011 \global \let \indent = \ptexindent
1012 \global \let \noindent = \ptexnoindent
1013 \global \everypar = {}%
1017 % @refill is a no-op.
1020 % If working on a large document in chapters, it is convenient to
1021 % be able to disable indexing, cross-referencing, and contents, for test runs.
1022 % This is done with @novalidate (before @setfilename).
1024 \newif\iflinks \linkstrue % by default we want the aux files.
1025 \let\novalidate = \linksfalse
1027 % @setfilename is done at the beginning of every texinfo file.
1028 % So open here the files we need to have open while reading the input.
1029 % This makes it possible to make a .fmt file for texinfo.
1031 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1034 % Open the new aux file. TeX will close it automatically at exit.
1035 \immediate\openout\auxfile=\jobname.aux
1036 \fi % \openindices needs to do some work in any case.
1038 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1040 % If texinfo.cnf is present on the system, read it.
1041 % Useful for site-wide @afourpaper, etc.
1042 \openin 1 texinfo.cnf
1043 \ifeof 1 \else \input texinfo.cnf \fi
1046 \comment % Ignore the actual filename.
1049 % Called from \setfilename.
1061 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1065 % adobe `portable' document format
1069 \newcount\filenamelength
1078 \newif\ifpdfmakepagedest
1080 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1081 % can be set). So we test for \relax and 0 as well as \undefined,
1082 % borrowed from ifpdf.sty.
1083 \ifx\pdfoutput\undefined
1085 \ifx\pdfoutput\relax
1094 % PDF uses PostScript string constants for the names of xref targets,
1095 % for display in the outlines, and in other places. Thus, we have to
1096 % double any backslashes. Otherwise, a name like "\node" will be
1097 % interpreted as a newline (\n), followed by o, d, e. Not good.
1098 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1099 % (and related messages, the final outcome is that it is up to the TeX
1100 % user to double the backslashes and otherwise make the string valid, so
1101 % that's what we do).
1103 % double active backslashes.
1105 {\catcode`\@=0 \catcode`\\=\active
1106 @gdef@activebackslashdouble{%
1108 @let\=@doublebackslash}
1111 % To handle parens, we must adopt a different approach, since parens are
1112 % not active characters. hyperref.dtx (which has the same problem as
1113 % us) handles it with this amazing macro to replace tokens, with minor
1114 % changes for Texinfo. It is included here under the GPL by permission
1115 % from the author, Heiko Oberdiek.
1117 % #1 is the tokens to replace.
1118 % #2 is the replacement.
1119 % #3 is the control sequence with the string.
1121 \def\HyPsdSubst#1#2#3{%
1122 \def\HyPsdReplace##1#1##2\END{%
1128 \HyPsdReplace##2\END
1132 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1134 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1136 % #1 is a control sequence in which to do the replacements.
1137 \def\backslashparens#1{%
1138 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1139 % \lastnode when called from \setref -> \pdfmkdest.
1140 \HyPsdSubst{(}{\realbackslash(}{#1}%
1141 \HyPsdSubst{)}{\realbackslash)}{#1}%
1144 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1145 with PDF output, and none of those formats could be found. (.eps cannot
1146 be supported due to the design of the PDF format; use regular TeX (DVI
1151 % Color manipulation macros based on pdfcolor.tex,
1152 % except using rgb instead of cmyk; the latter is said to render as a
1153 % very dark gray on-screen and a very dark halftone in print, instead
1155 \def\rgbDarkRed{0.50 0.09 0.12}
1156 \def\rgbBlack{0 0 0}
1158 % k sets the color for filling (usual text, etc.);
1159 % K sets the color for stroking (thin rules, e.g., normal _'s).
1160 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1162 % Set color, and create a mark which defines \thiscolor accordingly,
1163 % so that \makeheadline knows which color to restore.
1165 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1170 \def\maincolor{\rgbBlack}
1171 \pdfsetcolor{\maincolor}
1172 \edef\thiscolor{\maincolor}
1173 \def\lastcolordefs{}
1177 \line{\pdfsetcolor{\maincolor}\the\footline}%
1185 % Extract \thiscolor definition from the marks.
1187 % Typeset the headline with \maincolor, then restore the color.
1188 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1196 \pdfcatalog{/PageMode /UseOutlines}
1198 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1199 \def\dopdfimage#1#2#3{%
1200 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1201 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1203 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1204 % others). Let's try in that order.
1205 \let\pdfimgext=\empty
1207 \openin 1 #1.png \ifeof 1
1208 \openin 1 #1.jpg \ifeof 1
1209 \openin 1 #1.jpeg \ifeof 1
1210 \openin 1 #1.JPG \ifeof 1
1211 \openin 1 #1.pdf \ifeof 1
1212 \openin 1 #1.PDF \ifeof 1
1213 \errhelp = \nopdfimagehelp
1214 \errmessage{Could not find image file #1 for pdf}%
1215 \else \gdef\pdfimgext{PDF}%
1217 \else \gdef\pdfimgext{pdf}%
1219 \else \gdef\pdfimgext{JPG}%
1221 \else \gdef\pdfimgext{jpeg}%
1223 \else \gdef\pdfimgext{jpg}%
1225 \else \gdef\pdfimgext{png}%
1230 % without \immediate, ancient pdftex seg faults when the same image is
1231 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1232 \ifnum\pdftexversion < 14
1235 \immediate\pdfximage
1237 \ifdim \wd0 >0pt width \imagewidth \fi
1238 \ifdim \wd2 >0pt height \imageheight \fi
1239 \ifnum\pdftexversion<13
1244 \ifnum\pdftexversion < 14 \else
1245 \pdfrefximage \pdflastximage
1249 % We have to set dummies so commands such as @code, and characters
1250 % such as \, aren't expanded when present in a section title.
1253 \activebackslashdouble
1254 \makevalueexpandable
1255 \def\pdfdestname{#1}%
1256 \backslashparens\pdfdestname
1257 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1260 % used to mark target names; must be expandable.
1263 % by default, use a color that is dark enough to print on paper as
1264 % nearly black, but still distinguishable for online viewing.
1265 \def\urlcolor{\rgbDarkRed}
1266 \def\linkcolor{\rgbDarkRed}
1267 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1269 % Adding outlines to PDF; macros for calculating structure of outlines
1270 % come from Petr Olsak
1271 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1272 \else \csname#1\endcsname \fi}
1273 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1274 \advance\tempnum by 1
1275 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1277 % #1 is the section text, which is what will be displayed in the
1278 % outline by the pdf viewer. #2 is the pdf expression for the number
1279 % of subentries (or empty, for subsubsections). #3 is the node text,
1280 % which might be empty if this toc entry had no corresponding node.
1281 % #4 is the page number
1283 \def\dopdfoutline#1#2#3#4{%
1284 % Generate a link to the node text if that exists; else, use the
1285 % page number. We could generate a destination for the section
1286 % text in the case where a section has no node, but it doesn't
1287 % seem worth the trouble, since most documents are normally structured.
1288 \def\pdfoutlinedest{#3}%
1289 \ifx\pdfoutlinedest\empty
1290 \def\pdfoutlinedest{#4}%
1292 % Doubled backslashes in the name.
1293 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1294 \backslashparens\pdfoutlinedest}%
1297 % Also double the backslashes in the display string.
1298 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1299 \backslashparens\pdfoutlinetext}%
1301 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1304 \def\pdfmakeoutlines{%
1306 % Thanh's hack / proper braces in bookmarks
1307 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1308 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1310 % Read toc silently, to get counts of subentries for \pdfoutline.
1311 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1312 \def\numchapentry##1##2##3##4{%
1313 \def\thischapnum{##2}%
1315 \def\thissubsecnum{0}%
1317 \def\numsecentry##1##2##3##4{%
1318 \advancenumber{chap\thischapnum}%
1319 \def\thissecnum{##2}%
1320 \def\thissubsecnum{0}%
1322 \def\numsubsecentry##1##2##3##4{%
1323 \advancenumber{sec\thissecnum}%
1324 \def\thissubsecnum{##2}%
1326 \def\numsubsubsecentry##1##2##3##4{%
1327 \advancenumber{subsec\thissubsecnum}%
1329 \def\thischapnum{0}%
1331 \def\thissubsecnum{0}%
1333 % use \def rather than \let here because we redefine \chapentry et
1334 % al. a second time, below.
1335 \def\appentry{\numchapentry}%
1336 \def\appsecentry{\numsecentry}%
1337 \def\appsubsecentry{\numsubsecentry}%
1338 \def\appsubsubsecentry{\numsubsubsecentry}%
1339 \def\unnchapentry{\numchapentry}%
1340 \def\unnsecentry{\numsecentry}%
1341 \def\unnsubsecentry{\numsubsecentry}%
1342 \def\unnsubsubsecentry{\numsubsubsecentry}%
1345 % Read toc second time, this time actually producing the outlines.
1346 % The `-' means take the \expnumber as the absolute number of
1347 % subentries, which we calculated on our first read of the .toc above.
1349 % We use the node names as the destinations.
1350 \def\numchapentry##1##2##3##4{%
1351 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1352 \def\numsecentry##1##2##3##4{%
1353 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1354 \def\numsubsecentry##1##2##3##4{%
1355 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1356 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1357 \dopdfoutline{##1}{}{##3}{##4}}%
1359 % PDF outlines are displayed using system fonts, instead of
1360 % document fonts. Therefore we cannot use special characters,
1361 % since the encoding is unknown. For example, the eogonek from
1362 % Latin 2 (0xea) gets translated to a | character. Info from
1363 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1365 % xx to do this right, we have to translate 8-bit characters to
1366 % their "best" equivalent, based on the @documentencoding. Right
1367 % now, I guess we'll just let the pdf reader have its way.
1370 \catcode`\\=\active \otherbackslash
1371 \input \tocreadfilename
1375 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1376 \ifx\PP\D\let\nextsp\relax
1377 \else\let\nextsp\skipspaces
1378 \ifx\p\space\else\addtokens{\filename}{\PP}%
1379 \advance\filenamelength by 1
1383 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1384 \ifnum\pdftexversion < 14
1385 \let \startlink \pdfannotlink
1387 \let \startlink \pdfstartlink
1389 % make a live url in pdf output.
1392 % it seems we really need yet another set of dummies; have not
1393 % tried to figure out what each command should do in the context
1394 % of @url. for now, just make @/ a no-op, that's the only one
1395 % people have actually reported a problem with.
1397 \normalturnoffactive
1400 \makevalueexpandable
1401 % do we want to go so far as to use \indexnofonts instead of just
1402 % special-casing \var here?
1405 \leavevmode\setcolor{\urlcolor}%
1406 \startlink attr{/Border [0 0 0]}%
1407 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1409 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1410 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1411 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1412 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1414 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1416 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1417 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1418 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1420 \ifnum0=\countA\else\makelink\fi
1421 \ifx\first.\let\next=\done\else
1423 \addtokens{\toksB}{\the\toksD}
1424 \ifx\first,\addtokens{\toksB}{\space}\fi
1426 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1428 \def\makelink{\addtokens{\toksB}%
1429 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1431 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1432 \setcolor{\linkcolor}#1\endlink}
1433 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1436 \let\pdfmkdest = \gobble
1437 \let\pdfurl = \gobble
1438 \let\endlink = \relax
1439 \let\setcolor = \gobble
1440 \let\pdfsetcolor = \gobble
1441 \let\pdfmakeoutlines = \relax
1442 \fi % \ifx\pdfoutput
1447 % Change the current font style to #1, remembering it in \curfontstyle.
1448 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1449 % italics, not bold italics.
1451 \def\setfontstyle#1{%
1452 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1453 \csname ten#1\endcsname % change the current font
1456 % Select #1 fonts with the current style.
1458 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1460 \def\rm{\fam=0 \setfontstyle{rm}}
1461 \def\it{\fam=\itfam \setfontstyle{it}}
1462 \def\sl{\fam=\slfam \setfontstyle{sl}}
1463 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1464 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1466 % Unfortunately, we have to override this for titles and the like, since
1467 % in those cases "rm" is bold. Sigh.
1468 \def\rmisbold{\rm\def\curfontstyle{bf}}
1470 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1471 % So we set up a \sf.
1473 \def\sf{\fam=\sffam \setfontstyle{sf}}
1474 \let\li = \sf % Sometimes we call it \li, not \sf.
1476 % We don't need math for this font style.
1477 \def\ttsl{\setfontstyle{ttsl}}
1481 \newdimen\textleading \textleading = 13.2pt
1483 % Set the baselineskip to #1, and the lineskip and strut size
1484 % correspondingly. There is no deep meaning behind these magic numbers
1485 % used as factors; they just match (closely enough) what Knuth defined.
1487 \def\lineskipfactor{.08333}
1488 \def\strutheightpercent{.70833}
1489 \def\strutdepthpercent {.29167}
1491 % can get a sort of poor man's double spacing by redefining this.
1492 \def\baselinefactor{1}
1496 \normalbaselineskip = \baselinefactor\dimen0
1497 \normallineskip = \lineskipfactor\normalbaselineskip
1499 \setbox\strutbox =\hbox{%
1500 \vrule width0pt height\strutheightpercent\baselineskip
1501 depth \strutdepthpercent \baselineskip
1505 % PDF CMaps. See also LaTeX's t1.cmap.
1507 % do nothing with this by default.
1508 \expandafter\let\csname cmapOT1\endcsname\gobble
1509 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1510 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1512 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1513 % (\pdffontattr was introduced many years ago, but people still run
1514 % older pdftex's; it's easy to conditionalize, so we do.)
1515 \ifpdf \ifx\pdffontattr\undefined \else
1517 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1518 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1519 %%DocumentNeededResources: ProcSet (CIDInit)
1520 %%IncludeResource: ProcSet (CIDInit)
1521 %%BeginResource: CMap (TeX-OT1-0)
1522 %%Title: (TeX-OT1-0 TeX OT1 0)
1525 /CIDInit /ProcSet findresource begin
1533 /CMapName /TeX-OT1-0 def
1535 1 begincodespacerange
1591 CMapName currentdict /CMap defineresource pop
1597 \expandafter\edef\csname cmapOT1\endcsname#1{%
1598 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1603 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1604 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1605 %%DocumentNeededResources: ProcSet (CIDInit)
1606 %%IncludeResource: ProcSet (CIDInit)
1607 %%BeginResource: CMap (TeX-OT1IT-0)
1608 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1611 /CIDInit /ProcSet findresource begin
1619 /CMapName /TeX-OT1IT-0 def
1621 1 begincodespacerange
1679 CMapName currentdict /CMap defineresource pop
1685 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1686 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1691 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1692 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1693 %%DocumentNeededResources: ProcSet (CIDInit)
1694 %%IncludeResource: ProcSet (CIDInit)
1695 %%BeginResource: CMap (TeX-OT1TT-0)
1696 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1699 /CIDInit /ProcSet findresource begin
1707 /CMapName /TeX-OT1TT-0 def
1709 1 begincodespacerange
1754 CMapName currentdict /CMap defineresource pop
1760 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1761 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1766 % Set the font macro #1 to the font named #2, adding on the
1767 % specified font prefix (normally `cm').
1768 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1769 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1771 \def\setfont#1#2#3#4#5{%
1772 \font#1=\fontprefix#2#3 scaled #4
1773 \csname cmap#5\endcsname#1%
1775 % This is what gets called when #5 of \setfont is empty.
1777 % emacs-page end of cmaps
1779 % Use cm as the default font prefix.
1780 % To specify the font prefix, you must define \fontprefix
1781 % before you read in texinfo.tex.
1782 \ifx\fontprefix\undefined
1785 % Support font families that don't use the same naming scheme as CM.
1787 \def\rmbshape{bx} %where the normal face is bold
1792 \def\ttslshape{sltt}
1802 % Definitions for a main text size of 11pt. This is the default in
1805 \def\definetextfontsizexi{%
1806 % Text fonts (11.2pt, magstep1).
1807 \def\textnominalsize{11pt}
1808 \edef\mainmagstep{\magstephalf}
1809 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1810 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1811 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1812 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1813 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1814 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1815 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1816 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1817 \font\texti=cmmi10 scaled \mainmagstep
1818 \font\textsy=cmsy10 scaled \mainmagstep
1819 \def\textecsize{1095}
1821 % A few fonts for @defun names and args.
1822 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1823 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1824 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1825 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1827 % Fonts for indices, footnotes, small examples (9pt).
1828 \def\smallnominalsize{9pt}
1829 \setfont\smallrm\rmshape{9}{1000}{OT1}
1830 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1831 \setfont\smallbf\bfshape{10}{900}{OT1}
1832 \setfont\smallit\itshape{9}{1000}{OT1IT}
1833 \setfont\smallsl\slshape{9}{1000}{OT1}
1834 \setfont\smallsf\sfshape{9}{1000}{OT1}
1835 \setfont\smallsc\scshape{10}{900}{OT1}
1836 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1839 \def\smallecsize{0900}
1841 % Fonts for small examples (8pt).
1842 \def\smallernominalsize{8pt}
1843 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1844 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1845 \setfont\smallerbf\bfshape{10}{800}{OT1}
1846 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1847 \setfont\smallersl\slshape{8}{1000}{OT1}
1848 \setfont\smallersf\sfshape{8}{1000}{OT1}
1849 \setfont\smallersc\scshape{10}{800}{OT1}
1850 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1851 \font\smalleri=cmmi8
1852 \font\smallersy=cmsy8
1853 \def\smallerecsize{0800}
1855 % Fonts for title page (20.4pt):
1856 \def\titlenominalsize{20pt}
1857 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1858 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1859 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1860 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1861 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1862 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1863 \let\titlebf=\titlerm
1864 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1865 \font\titlei=cmmi12 scaled \magstep3
1866 \font\titlesy=cmsy10 scaled \magstep4
1867 \def\titleecsize{2074}
1869 % Chapter (and unnumbered) fonts (17.28pt).
1870 \def\chapnominalsize{17pt}
1871 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1872 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1873 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1874 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1875 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1876 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1878 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1879 \font\chapi=cmmi12 scaled \magstep2
1880 \font\chapsy=cmsy10 scaled \magstep3
1881 \def\chapecsize{1728}
1883 % Section fonts (14.4pt).
1884 \def\secnominalsize{14pt}
1885 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1886 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1887 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1888 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1889 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1890 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1892 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1893 \font\seci=cmmi12 scaled \magstep1
1894 \font\secsy=cmsy10 scaled \magstep2
1895 \def\sececsize{1440}
1897 % Subsection fonts (13.15pt).
1898 \def\ssecnominalsize{13pt}
1899 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1900 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1901 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1902 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1903 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1904 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1906 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1907 \font\sseci=cmmi12 scaled \magstephalf
1908 \font\ssecsy=cmsy10 scaled 1315
1909 \def\ssececsize{1200}
1911 % Reduced fonts for @acro in text (10pt).
1912 \def\reducednominalsize{10pt}
1913 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1914 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1915 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1916 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1917 \setfont\reducedsl\slshape{10}{1000}{OT1}
1918 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1919 \setfont\reducedsc\scshape{10}{1000}{OT1}
1920 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1921 \font\reducedi=cmmi10
1922 \font\reducedsy=cmsy10
1923 \def\reducedecsize{1000}
1925 \textleading = 13.2pt % line spacing for 11pt CM
1926 \textfonts % reset the current fonts
1928 } % end of 11pt text font size definitions
1931 % Definitions to make the main text be 10pt Computer Modern, with
1932 % section, chapter, etc., sizes following suit. This is for the GNU
1933 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1934 % future. Used with @smallbook, which sets the leading to 12pt.
1936 \def\definetextfontsizex{%
1937 % Text fonts (10pt).
1938 \def\textnominalsize{10pt}
1939 \edef\mainmagstep{1000}
1940 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1941 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1942 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1943 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1944 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1945 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1946 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1947 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1948 \font\texti=cmmi10 scaled \mainmagstep
1949 \font\textsy=cmsy10 scaled \mainmagstep
1950 \def\textecsize{1000}
1952 % A few fonts for @defun names and args.
1953 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
1954 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
1955 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
1956 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1958 % Fonts for indices, footnotes, small examples (9pt).
1959 \def\smallnominalsize{9pt}
1960 \setfont\smallrm\rmshape{9}{1000}{OT1}
1961 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1962 \setfont\smallbf\bfshape{10}{900}{OT1}
1963 \setfont\smallit\itshape{9}{1000}{OT1IT}
1964 \setfont\smallsl\slshape{9}{1000}{OT1}
1965 \setfont\smallsf\sfshape{9}{1000}{OT1}
1966 \setfont\smallsc\scshape{10}{900}{OT1}
1967 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1970 \def\smallecsize{0900}
1972 % Fonts for small examples (8pt).
1973 \def\smallernominalsize{8pt}
1974 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1975 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1976 \setfont\smallerbf\bfshape{10}{800}{OT1}
1977 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1978 \setfont\smallersl\slshape{8}{1000}{OT1}
1979 \setfont\smallersf\sfshape{8}{1000}{OT1}
1980 \setfont\smallersc\scshape{10}{800}{OT1}
1981 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1982 \font\smalleri=cmmi8
1983 \font\smallersy=cmsy8
1984 \def\smallerecsize{0800}
1986 % Fonts for title page (20.4pt):
1987 \def\titlenominalsize{20pt}
1988 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1989 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1990 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1991 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1992 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1993 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1994 \let\titlebf=\titlerm
1995 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1996 \font\titlei=cmmi12 scaled \magstep3
1997 \font\titlesy=cmsy10 scaled \magstep4
1998 \def\titleecsize{2074}
2000 % Chapter fonts (14.4pt).
2001 \def\chapnominalsize{14pt}
2002 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2003 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2004 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2005 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2006 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2007 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2009 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2010 \font\chapi=cmmi12 scaled \magstep1
2011 \font\chapsy=cmsy10 scaled \magstep2
2012 \def\chapecsize{1440}
2014 % Section fonts (12pt).
2015 \def\secnominalsize{12pt}
2016 \setfont\secrm\rmbshape{12}{1000}{OT1}
2017 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2018 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2019 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2020 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2021 \setfont\secsf\sfbshape{12}{1000}{OT1}
2023 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2025 \font\secsy=cmsy10 scaled \magstep1
2026 \def\sececsize{1200}
2028 % Subsection fonts (10pt).
2029 \def\ssecnominalsize{10pt}
2030 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2031 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2032 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2033 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2034 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2035 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2037 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2040 \def\ssececsize{1000}
2042 % Reduced fonts for @acro in text (9pt).
2043 \def\reducednominalsize{9pt}
2044 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2045 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2046 \setfont\reducedbf\bfshape{10}{900}{OT1}
2047 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2048 \setfont\reducedsl\slshape{9}{1000}{OT1}
2049 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2050 \setfont\reducedsc\scshape{10}{900}{OT1}
2051 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2052 \font\reducedi=cmmi9
2053 \font\reducedsy=cmsy9
2054 \def\reducedecsize{0900}
2056 \divide\parskip by 2 % reduce space between paragraphs
2057 \textleading = 12pt % line spacing for 10pt CM
2058 \textfonts % reset the current fonts
2060 } % end of 10pt text font size definitions
2063 % We provide the user-level command
2065 % (or 11) to redefine the text font size. pt is assumed.
2070 \parseargdef\fonttextsize{%
2071 \def\textsizearg{#1}%
2072 \wlog{doing @fonttextsize \textsizearg}%
2074 % Set \globaldefs so that documents can use this inside @tex, since
2075 % makeinfo 4.8 does not support it, but we need it nonetheless.
2077 \begingroup \globaldefs=1
2078 \ifx\textsizearg\xword \definetextfontsizex
2079 \else \ifx\textsizearg\xiword \definetextfontsizexi
2082 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2088 % In order for the font changes to affect most math symbols and letters,
2089 % we have to define the \textfont of the standard families. Since
2090 % texinfo doesn't allow for producing subscripts and superscripts except
2091 % in the main text, we don't bother to reset \scriptfont and
2092 % \scriptscriptfont (which would also require loading a lot more fonts).
2094 \def\resetmathfonts{%
2095 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2096 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2097 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2100 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2101 % of just \STYLE. We do this because \STYLE needs to also set the
2102 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2103 % \tenSTYLE to set the current font.
2105 % Each font-changing command also sets the names \lsize (one size lower)
2106 % and \lllsize (three sizes lower). These relative commands are used in
2107 % the LaTeX logo and acronyms.
2109 % This all needs generalizing, badly.
2112 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2113 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2114 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2115 \let\tenttsl=\textttsl
2116 \def\curfontsize{text}%
2117 \def\lsize{reduced}\def\lllsize{smaller}%
2118 \resetmathfonts \setleading{\textleading}}
2120 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2121 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2122 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2123 \let\tenttsl=\titlettsl
2124 \def\curfontsize{title}%
2125 \def\lsize{chap}\def\lllsize{subsec}%
2126 \resetmathfonts \setleading{27pt}}
2127 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2129 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2130 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2131 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2132 \let\tenttsl=\chapttsl
2133 \def\curfontsize{chap}%
2134 \def\lsize{sec}\def\lllsize{text}%
2135 \resetmathfonts \setleading{19pt}}
2137 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2138 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2139 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2140 \let\tenttsl=\secttsl
2141 \def\curfontsize{sec}%
2142 \def\lsize{subsec}\def\lllsize{reduced}%
2143 \resetmathfonts \setleading{16pt}}
2145 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2146 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2147 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2148 \let\tenttsl=\ssecttsl
2149 \def\curfontsize{ssec}%
2150 \def\lsize{text}\def\lllsize{small}%
2151 \resetmathfonts \setleading{15pt}}
2152 \let\subsubsecfonts = \subsecfonts
2154 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2155 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2156 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2157 \let\tenttsl=\reducedttsl
2158 \def\curfontsize{reduced}%
2159 \def\lsize{small}\def\lllsize{smaller}%
2160 \resetmathfonts \setleading{10.5pt}}
2162 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2163 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2164 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2165 \let\tenttsl=\smallttsl
2166 \def\curfontsize{small}%
2167 \def\lsize{smaller}\def\lllsize{smaller}%
2168 \resetmathfonts \setleading{10.5pt}}
2170 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2171 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2172 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2173 \let\tenttsl=\smallerttsl
2174 \def\curfontsize{smaller}%
2175 \def\lsize{smaller}\def\lllsize{smaller}%
2176 \resetmathfonts \setleading{9.5pt}}
2178 % Fonts for short table of contents.
2179 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2180 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2181 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2182 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2184 % Define these just so they can be easily changed for other fonts.
2185 \def\angleleft{$\langle$}
2186 \def\angleright{$\rangle$}
2188 % Set the fonts to use with the @small... environments.
2189 \let\smallexamplefonts = \smallfonts
2191 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2192 % can fit this many characters:
2193 % 8.5x11=86 smallbook=72 a4=90 a5=69
2194 % If we use \scriptfonts (8pt), then we can fit this many characters:
2195 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2196 % For me, subjectively, the few extra characters that fit aren't worth
2197 % the additional smallness of 8pt. So I'm making the default 9pt.
2199 % By the way, for comparison, here's what fits with @example (10pt):
2200 % 8.5x11=71 smallbook=60 a4=75 a5=58
2203 % Set up the default fonts, so we can use them for creating boxes.
2205 \definetextfontsizexi
2210 % Check if we are currently using a typewriter font. Since all the
2211 % Computer Modern typewriter fonts have zero interword stretch (and
2212 % shrink), and it is reasonable to expect all typewriter fonts to have
2213 % this property, we can check that font parameter.
2215 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2217 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2218 % define and register \INITMACRO to be called on markup style changes.
2219 % \INITMACRO can check \currentmarkupstyle for the innermost
2220 % style and the set of \ifmarkupSTYLE switches for all styles
2221 % currently in effect.
2225 %\newif\ifmarkupfile % @file == @samp.
2226 %\newif\ifmarkupoption % @option == @samp.
2229 %\newif\ifmarkupenv % @env == @code.
2230 %\newif\ifmarkupcommand % @command == @code.
2231 \newif\ifmarkuptex % @tex (and part of @math, for now).
2232 \newif\ifmarkupexample
2234 \newif\ifmarkupverbatim
2236 \let\currentmarkupstyle\empty
2238 \def\setupmarkupstyle#1{%
2239 \csname markup#1true\endcsname
2240 \def\currentmarkupstyle{#1}%
2244 \let\markupstylesetup\empty
2246 \def\defmarkupstylesetup#1{%
2247 \expandafter\def\expandafter\markupstylesetup
2248 \expandafter{\markupstylesetup #1}%
2252 % Markup style setup for left and right quotes.
2253 \defmarkupstylesetup\markupsetuplq{%
2254 \expandafter\let\expandafter \temp \csname markupsetuplq\currentmarkupstyle\endcsname
2255 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2258 \defmarkupstylesetup\markupsetuprq{%
2259 \expandafter\let\expandafter \temp \csname markupsetuprq\currentmarkupstyle\endcsname
2260 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2267 \gdef\markupsetuplqdefault{\let`\lq}
2268 \gdef\markupsetuprqdefault{\let'\rq}
2270 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2271 \gdef\markupsetcodequoteright{\let'\codequoteright}
2273 \gdef\markupsetnoligaturesquoteleft{\let`\noligaturesquoteleft}
2276 \let\markupsetuplqcode \markupsetcodequoteleft
2277 \let\markupsetuprqcode \markupsetcodequoteright
2279 \let\markupsetuplqexample \markupsetcodequoteleft
2280 \let\markupsetuprqexample \markupsetcodequoteright
2282 \let\markupsetuplqsamp \markupsetcodequoteleft
2283 \let\markupsetuprqsamp \markupsetcodequoteright
2285 \let\markupsetuplqverb \markupsetcodequoteleft
2286 \let\markupsetuprqverb \markupsetcodequoteright
2288 \let\markupsetuplqverbatim \markupsetcodequoteleft
2289 \let\markupsetuprqverbatim \markupsetcodequoteright
2291 \let\markupsetuplqkbd \markupsetnoligaturesquoteleft
2293 % Allow an option to not replace quotes with a regular directed right
2294 % quote/apostrophe (char 0x27), but instead use the undirected quote
2295 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
2296 % the default, but it works for pasting with more pdf viewers (at least
2297 % evince), the lilypond developers report. xpdf does work with the
2300 \def\codequoteright{%
2301 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2302 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2308 % and a similar option for the left quote char vs. a grave accent.
2309 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2310 % the code environments to do likewise.
2312 \def\codequoteleft{%
2313 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2314 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2315 % [Knuth] pp. 380,381,391
2316 % \relax disables Spanish ligatures ?` and !` of \tt font.
2322 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2323 \def\noligaturesquoteleft{\relax\lq}
2325 % Count depth in font-changes, for error checks
2326 \newcount\fontdepth \fontdepth=0
2330 % #1 is the font command (\sl or \it), #2 is the text to slant.
2331 % If we are in a monospaced environment, however, 1) always use \ttsl,
2332 % and 2) do not add an italic correction.
2333 \def\dosmartslant#1#2{%
2335 {\ttsl #2\let\next=\relax}%
2336 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2339 \def\smartslanted{\dosmartslant\sl}
2340 \def\smartitalic{\dosmartslant\it}
2342 % Output an italic correction unless \next (presumed to be the following
2343 % character) is such as not to need one.
2344 \def\smartitaliccorrection{%
2351 % like \smartslanted except unconditionally uses \ttsl, and no ic.
2352 % @var is set to this for defun arguments.
2353 \def\ttslanted#1{{\ttsl #1}}
2355 % @cite is like \smartslanted except unconditionally use \sl. We never want
2356 % ttsl for book titles, do we?
2357 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2360 \let\slanted=\smartslanted
2361 \def\var#1{\smartslanted{#1}}
2362 \let\dfn=\smartslanted
2363 \let\emph=\smartitalic
2365 % Explicit font changes: @r, @sc, undocumented @ii.
2366 \def\r#1{{\rm #1}} % roman font
2367 \def\sc#1{{\smallcaps#1}} % smallcaps font
2368 \def\ii#1{{\it #1}} % italic font
2370 % @b, explicit bold. Also @strong.
2374 % @sansserif, explicit sans.
2375 \def\sansserif#1{{\sf #1}}
2377 % We can't just use \exhyphenpenalty, because that only has effect at
2378 % the end of a paragraph. Restore normal hyphenation at the end of the
2379 % group within which \nohyphenation is presumably called.
2381 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2382 \def\restorehyphenation{\hyphenchar\font = `- }
2384 % Set sfcode to normal for the chars that usually have another value.
2385 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2386 % sometimes \x has an active definition that messes things up.
2389 \def\plainfrenchspacing{%
2390 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2391 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2392 \def\endofsentencespacefactor{1000}% for @. and friends
2394 \def\plainnonfrenchspacing{%
2395 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2396 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2397 \def\endofsentencespacefactor{3000}% for @. and friends
2400 \def\endofsentencespacefactor{3000}% default
2402 % @t, explicit typewriter.
2404 {\tt \rawbackslash \plainfrenchspacing #1}%
2409 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2411 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2412 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2414 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2415 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2416 % \vbox{\hrule\kern-0.4pt
2417 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2418 % \kern-0.4pt\hrule}%
2419 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2421 % definition of @key with no lozenge. If the current font is already
2422 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2423 % if it isn't monospace, then use \tt.
2425 \def\key#1{{\setupmarkupstyle{key}%
2427 \ifmonospace\else\tt\fi
2430 % ctrl is no longer a Texinfo command.
2431 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2433 % @file, @option are the same as @samp.
2437 % @code is a modification of @t,
2438 % which makes spaces the same size as normal in the surrounding text.
2441 % Change normal interword space to be same as for the current font.
2442 \spaceskip = \fontdimen2\font
2444 % Switch to typewriter.
2447 % But `\ ' produces the large typewriter interword space.
2448 \def\ {{\spaceskip = 0pt{} }}%
2450 % Turn off hyphenation.
2460 % We *must* turn on hyphenation at `-' and `_' in @code.
2461 % Otherwise, it is too hard to avoid overfull hboxes
2462 % in the Emacs manual, the Library manual, etc.
2464 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2465 % both hyphenation at - and hyphenation within words.
2466 % We must therefore turn them both off (\tclose does that)
2467 % and arrange explicitly to hyphenate at a dash.
2470 \catcode`\-=\active \catcode`\_=\active
2471 \catcode`\'=\active \catcode`\`=\active
2472 \global\let'=\rq \global\let`=\lq % default definitions
2474 \global\def\code{\begingroup
2475 \setupmarkupstyle{code}%
2476 % The following should really be moved into \setupmarkupstyle handlers.
2477 \catcode\dashChar=\active \catcode\underChar=\active
2490 \def\codedash{-\discretionary{}{}{}}
2492 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2493 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2494 % will therefore expand the active definition of _, which is us
2495 % (inside @code that is), therefore an endless loop.
2497 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2498 \else\normalunderscore \fi
2499 \discretionary{}{}{}}%
2502 \def\codex #1{\tclose{#1}\endgroup}
2504 % An additional complication: the above will allow breaks after, e.g.,
2505 % each of the four underscores in __typeof__. This is undesirable in
2506 % some manuals, especially if they don't have long identifiers in
2507 % general. @allowcodebreaks provides a way to control this.
2509 \newif\ifallowcodebreaks \allowcodebreakstrue
2511 \def\keywordtrue{true}
2512 \def\keywordfalse{false}
2514 \parseargdef\allowcodebreaks{%
2516 \ifx\txiarg\keywordtrue
2517 \allowcodebreakstrue
2518 \else\ifx\txiarg\keywordfalse
2519 \allowcodebreaksfalse
2521 \errhelp = \EMsimple
2522 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2526 % @kbd is like @code, except that if the argument is just one @key command,
2527 % then @kbd has no effect.
2528 \def\kbd#1{{\setupmarkupstyle{kbd}\def\look{#1}\expandafter\kbdfoo\look??\par}}
2530 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2531 % `example' (@kbd uses ttsl only inside of @example and friends),
2532 % or `code' (@kbd uses normal tty font always).
2533 \parseargdef\kbdinputstyle{%
2535 \ifx\txiarg\worddistinct
2536 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2537 \else\ifx\txiarg\wordexample
2538 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2539 \else\ifx\txiarg\wordcode
2540 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2542 \errhelp = \EMsimple
2543 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2546 \def\worddistinct{distinct}
2547 \def\wordexample{example}
2550 % Default is `distinct'.
2551 \kbdinputstyle distinct
2554 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2555 \ifx\one\xkey\ifx\threex\three \key{#2}%
2556 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2557 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi}
2559 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2560 \let\indicateurl=\code
2564 % @clicksequence{File @click{} Open ...}
2565 \def\clicksequence#1{\begingroup #1\endgroup}
2567 % @clickstyle @arrow (by default)
2568 \parseargdef\clickstyle{\def\click{#1}}
2571 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2572 % second argument specifying the text to display and an optional third
2573 % arg as text to display instead of (rather than in addition to) the url
2574 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2575 % a hypertex \special here.
2577 \def\uref#1{\douref #1,,,\finish}
2578 \def\douref#1,#2,#3,#4\finish{\begingroup
2581 \setbox0 = \hbox{\ignorespaces #3}%
2583 \unhbox0 % third arg given, show only that
2585 \setbox0 = \hbox{\ignorespaces #2}%
2588 \unhbox0 % PDF: 2nd arg given, show only it
2590 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2593 \code{#1}% only url given, so show it
2599 % @url synonym for @uref, since that's how everyone uses it.
2603 % rms does not like angle brackets --karl, 17may97.
2604 % So now @email is just like @uref, unless we are pdf.
2606 %\def\email#1{\angleleft{\tt #1}\angleright}
2608 \def\email#1{\doemail#1,,\finish}
2609 \def\doemail#1,#2,#3\finish{\begingroup
2612 \setbox0 = \hbox{\ignorespaces #2}%
2613 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2620 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2621 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2623 \def\dmn#1{\thinspace #1}
2625 % @l was never documented to mean ``switch to the Lisp font'',
2626 % and it is not used as such in any manual I can find. We need it for
2627 % Polish suppressed-l. --karl, 22sep96.
2628 %\def\l#1{{\li #1}\null}
2630 % @acronym for "FBI", "NATO", and the like.
2631 % We print this one point size smaller, since it's intended for
2634 \def\acronym#1{\doacronym #1,,\finish}
2635 \def\doacronym#1,#2,#3\finish{%
2636 {\selectfonts\lsize #1}%
2638 \ifx\temp\empty \else
2639 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2643 % @abbr for "Comput. J." and the like.
2644 % No font change, but don't do end-of-sentence spacing.
2646 \def\abbr#1{\doabbr #1,,\finish}
2647 \def\doabbr#1,#2,#3\finish{%
2648 {\plainfrenchspacing #1}%
2650 \ifx\temp\empty \else
2651 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2655 % @asis just yields its argument. Used with @table, for example.
2659 % @math outputs its argument in math mode.
2661 % One complication: _ usually means subscripts, but it could also mean
2662 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2663 % _ active, and distinguish by seeing if the current family is \slfam,
2664 % which is what @var uses.
2666 \catcode`\_ = \active
2667 \gdef\mathunderscore{%
2669 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
2672 % Another complication: we want \\ (and @\) to output a \ character.
2673 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
2674 % this is not advertised and we don't care. Texinfo does not
2675 % otherwise define @\.
2677 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2678 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
2683 \let\\ = \mathbackslash
2685 % make the texinfo accent commands work in math mode
2697 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
2699 % Some active characters (such as <) are spaced differently in math.
2700 % We have to reset their definitions in case the @math was an argument
2701 % to a command which sets the catcodes (such as @item or @section).
2704 \catcode`^ = \active
2705 \catcode`< = \active
2706 \catcode`> = \active
2707 \catcode`+ = \active
2708 \catcode`' = \active
2714 \let' = \ptexquoteright
2725 % Used to generate quoted braces. Unless we're in typewriter, use
2726 % \ecfont because the CM text fonts do not have braces, and we don't
2727 % want to switch into math.
2728 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2729 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2733 % Definitions to produce \{ and \} commands for indices,
2734 % and @{ and @} for the aux/toc files.
2735 \catcode`\{ = \other \catcode`\} = \other
2736 \catcode`\[ = 1 \catcode`\] = 2
2737 \catcode`\! = 0 \catcode`\\ = \other
2738 !gdef!lbracecmd[\{]%
2739 !gdef!rbracecmd[\}]%
2740 !gdef!lbraceatcmd[@{]%
2741 !gdef!rbraceatcmd[@}]%
2744 % @comma{} to avoid , parsing problems.
2747 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2748 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2750 \let\dotaccent = \ptexdot
2751 \def\ringaccent#1{{\accent23 #1}}
2752 \let\tieaccent = \ptext
2753 \let\ubaraccent = \ptexb
2754 \let\udotaccent = \d
2756 % Other special characters: @questiondown @exclamdown @ordf @ordm
2757 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2758 \def\questiondown{?`}
2760 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
2761 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
2763 % Dotless i and dotless j, used for accents.
2768 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2769 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2770 \else \errmessage{@dotless can be used only with i or j}%
2774 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2775 % period following counts as ending a sentence. (Idea found in latex.)
2777 \edef\TeX{\TeX \spacefactor=1000 }
2779 % @LaTeX{} logo. Not quite the same results as the definition in
2780 % latex.ltx, since we use a different font for the raised A; it's most
2781 % convenient for us to use an explicitly smaller font, rather than using
2782 % the \scriptstyle font (since we don't reset \scriptstyle and
2783 % \scriptscriptstyle).
2788 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
2793 % Some math mode symbols.
2794 \def\bullet{$\ptexbullet$}
2795 \def\geq{\ifmmode \ge\else $\ge$\fi}
2796 \def\leq{\ifmmode \le\else $\le$\fi}
2797 \def\minus{\ifmmode -\else $-$\fi}
2799 % @dots{} outputs an ellipsis using the current font.
2800 % We do .5em per period so that it has the same spacing in the cm
2801 % typewriter fonts as three actual period characters; on the other hand,
2802 % in other typewriter fonts three periods are wider than 1.5em. So do
2803 % whichever is larger.
2807 \setbox0=\hbox{...}% get width of three periods
2814 \hskip 0pt plus.25fil
2815 .\hskip 0pt plus1fil
2816 .\hskip 0pt plus1fil
2817 .\hskip 0pt plus.5fil
2821 % @enddots{} is an end-of-sentence ellipsis.
2825 \spacefactor=\endofsentencespacefactor
2828 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
2830 % Since these characters are used in examples, they should be an even number of
2831 % \tt widths. Each \tt character is 1en, so two makes it 1em.
2834 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
2835 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
2836 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
2837 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
2838 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
2840 % The @error{} command.
2841 % Adapted from the TeXbook's \boxit.
2845 {\tentt \global\dimen0 = 3em}% Width of the box.
2846 \dimen2 = .55pt % Thickness of rules
2847 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
2848 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
2850 \setbox\errorbox=\hbox to \dimen0{\hfil
2851 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
2852 \advance\hsize by -2\dimen2 % Rules.
2854 \hrule height\dimen2
2855 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
2856 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
2857 \kern3pt\vrule width\dimen2}% Space to right.
2858 \hrule height\dimen2}
2861 \def\error{\leavevmode\lower.7ex\copy\errorbox}
2863 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2865 \def\pounds{{\it\$}}
2867 % @euro{} comes from a separate font, depending on the current style.
2868 % We use the free feym* fonts from the eurosym package by Henrik
2869 % Theiling, which support regular, slanted, bold and bold slanted (and
2870 % "outlined" (blackboard board, sort of) versions, which we don't need).
2871 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2873 % Although only regular is the truly official Euro symbol, we ignore
2874 % that. The Euro is designed to be slightly taller than the regular
2880 % feybo - bold slanted
2882 % There is no good (free) typewriter version, to my knowledge.
2883 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2886 % Also doesn't work in math. Do we need to do math with euro symbols?
2890 \def\euro{{\eurofont e}}
2892 % We set the font at each command, rather than predefining it in
2893 % \textfonts and the other font-switching commands, so that
2894 % installations which never need the symbol don't have to have the
2897 % There is only one designed size (nominal 10pt), so we always scale
2898 % that to the current nominal size.
2900 % By the way, simply using "at 1em" works for cmr10 and the like, but
2901 % does not work for cmbx10 and other extended/shrunken fonts.
2903 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2905 \ifx\curfontstyle\bfstylename
2907 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2910 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2915 % Glyphs from the EC fonts. We don't use \let for the aliases, because
2916 % sometimes we redefine the original macro, and the alias should reflect
2919 % Use LaTeX names for the Icelandic letters.
2920 \def\DH{{\ecfont \char"D0}} % Eth
2921 \def\dh{{\ecfont \char"F0}} % eth
2922 \def\TH{{\ecfont \char"DE}} % Thorn
2923 \def\th{{\ecfont \char"FE}} % thorn
2925 \def\guillemetleft{{\ecfont \char"13}}
2926 \def\guillemotleft{\guillemetleft}
2927 \def\guillemetright{{\ecfont \char"14}}
2928 \def\guillemotright{\guillemetright}
2929 \def\guilsinglleft{{\ecfont \char"0E}}
2930 \def\guilsinglright{{\ecfont \char"0F}}
2931 \def\quotedblbase{{\ecfont \char"12}}
2932 \def\quotesinglbase{{\ecfont \char"0D}}
2934 % This positioning is not perfect (see the ogonek LaTeX package), but
2935 % we have the precomposed glyphs for the most common cases. We put the
2936 % tests to use those glyphs in the single \ogonek macro so we have fewer
2937 % dummy definitions to worry about for index entries, etc.
2939 % ogonek is also used with other letters in Lithuanian (IOU), but using
2940 % the precomposed glyphs for those is not so easy since they aren't in
2944 \ifx\temp\macrocharA\Aogonek
2945 \else\ifx\temp\macrochara\aogonek
2946 \else\ifx\temp\macrocharE\Eogonek
2947 \else\ifx\temp\macrochare\eogonek
2949 \ecfont \setbox0=\hbox{#1}%
2950 \ifdim\ht0=1ex\accent"0C #1%
2951 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
2956 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
2957 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
2958 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
2959 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
2961 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
2963 % We can't distinguish serif/sans and italic/slanted, but this
2964 % is used for crude hacks anyway (like adding French and German
2965 % quotes to documents typeset with CM, where we lose kerning), so
2966 % hopefully nobody will notice/care.
2967 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
2968 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
2969 \ifx\curfontstyle\bfstylename
2971 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
2974 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
2979 % @registeredsymbol - R in a circle. The font for the R should really
2980 % be smaller yet, but lllsize is the best we can do for now.
2981 % Adapted from the plain.tex definition of \copyright.
2983 \def\registeredsymbol{%
2984 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2989 % @textdegree - the normal degrees sign.
2991 \def\textdegree{$^\circ$}
2993 % Laurent Siebenmann reports \Orb undefined with:
2994 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2995 % so we'll define it if necessary.
2998 \def\Orb{\mathhexbox20D}
3002 \chardef\quotedblleft="5C
3003 \chardef\quotedblright=`\"
3004 \chardef\quoteleft=`\`
3005 \chardef\quoteright=`\'
3008 \message{page headings,}
3010 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3011 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3013 % First the title page. Must do @settitle before @titlepage.
3015 \newif\iffinishedtitlepage
3017 % Do an implicit @contents or @shortcontents after @end titlepage if the
3018 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3020 \newif\ifsetcontentsaftertitlepage
3021 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3022 \newif\ifsetshortcontentsaftertitlepage
3023 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3025 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3026 \endgroup\page\hbox{}\page}
3029 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3031 \parindent=0pt \textfonts
3032 % Leave some space at the very top of the page.
3033 \vglue\titlepagetopglue
3034 % No rule at page bottom unless we print one at the top with @title.
3035 \finishedtitlepagetrue
3037 % Most title ``pages'' are actually two pages long, with space
3038 % at the top of the second. We don't want the ragged left on the second.
3039 \let\oldpage = \page
3041 \iffinishedtitlepage\else
3044 \let\page = \oldpage
3051 \iffinishedtitlepage\else
3054 % It is important to do the page break before ending the group,
3055 % because the headline and footline are only empty inside the group.
3056 % If we use the new definition of \page, we always get a blank page
3057 % after the title page, which we certainly don't want.
3061 % Need this before the \...aftertitlepage checks so that if they are
3062 % in effect the toc pages will come out with page numbers.
3065 % If they want short, they certainly want long too.
3066 \ifsetshortcontentsaftertitlepage
3069 \global\let\shortcontents = \relax
3070 \global\let\contents = \relax
3073 \ifsetcontentsaftertitlepage
3075 \global\let\contents = \relax
3076 \global\let\shortcontents = \relax
3080 \def\finishtitlepage{%
3081 \vskip4pt \hrule height 2pt width \hsize
3082 \vskip\titlepagebottomglue
3083 \finishedtitlepagetrue
3086 %%% Macros to be used within @titlepage:
3088 \let\subtitlerm=\tenrm
3089 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3091 \parseargdef\title{%
3093 \leftline{\titlefonts\rmisbold #1}
3094 % print a rule at the page bottom also.
3095 \finishedtitlepagefalse
3096 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3099 \parseargdef\subtitle{%
3101 {\subtitlefont \rightline{#1}}%
3104 % @author should come last, but may come many times.
3105 % It can also be used inside @quotation.
3107 \parseargdef\author{%
3108 \def\temp{\quotation}%
3110 \def\quotationauthor{#1}% printed in \Equotation.
3113 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3114 {\secfonts\rmisbold \leftline{#1}}%
3119 %%% Set up page headings and footings.
3121 \let\thispage=\folio
3123 \newtoks\evenheadline % headline on even pages
3124 \newtoks\oddheadline % headline on odd pages
3125 \newtoks\evenfootline % footline on even pages
3126 \newtoks\oddfootline % footline on odd pages
3128 % Now make TeX use those variables
3129 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3130 \else \the\evenheadline \fi}}
3131 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3132 \else \the\evenfootline \fi}\HEADINGShook}
3133 \let\HEADINGShook=\relax
3135 % Commands to set those variables.
3136 % For example, this is what @headings on does
3137 % @evenheading @thistitle|@thispage|@thischapter
3138 % @oddheading @thischapter|@thispage|@thistitle
3139 % @evenfooting @thisfile||
3140 % @oddfooting ||@thisfile
3143 \def\evenheading{\parsearg\evenheadingxxx}
3144 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3145 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3146 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3148 \def\oddheading{\parsearg\oddheadingxxx}
3149 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3150 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3151 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3153 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3155 \def\evenfooting{\parsearg\evenfootingxxx}
3156 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3157 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3158 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3160 \def\oddfooting{\parsearg\oddfootingxxx}
3161 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3162 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3163 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3165 % Leave some space for the footline. Hopefully ok to assume
3166 % @evenfooting will not be used by itself.
3167 \global\advance\pageheight by -12pt
3168 \global\advance\vsize by -12pt
3171 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3173 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3174 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3176 % The same set of arguments for:
3181 % @everyheadingmarks
3182 % @everyfootingmarks
3184 \def\evenheadingmarks{\headingmarks{even}{heading}}
3185 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3186 \def\evenfootingmarks{\headingmarks{even}{footing}}
3187 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3188 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3189 \headingmarks{odd}{heading}{#1} }
3190 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3191 \headingmarks{odd}{footing}{#1} }
3192 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3193 \def\headingmarks#1#2#3 {%
3194 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3195 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3198 \everyheadingmarks bottom
3199 \everyfootingmarks bottom
3201 % @headings double turns headings on for double-sided printing.
3202 % @headings single turns headings on for single-sided printing.
3203 % @headings off turns them off.
3204 % @headings on same as @headings double, retained for compatibility.
3205 % @headings after turns on double-sided headings after this page.
3206 % @headings doubleafter turns on double-sided headings after this page.
3207 % @headings singleafter turns on single-sided headings after this page.
3208 % By default, they are off at the start of a document,
3209 % and turned `on' after @end titlepage.
3211 \def\headings #1 {\csname HEADINGS#1\endcsname}
3213 \def\headingsoff{% non-global headings elimination
3214 \evenheadline={\hfil}\evenfootline={\hfil}%
3215 \oddheadline={\hfil}\oddfootline={\hfil}%
3218 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3219 \HEADINGSoff % it's the default
3221 % When we turn headings on, set the page number to 1.
3222 % For double-sided printing, put current file name in lower left corner,
3223 % chapter name on inside top of right hand pages, document
3224 % title on inside top of left hand pages, and page numbers on outside top
3225 % edge of all pages.
3226 \def\HEADINGSdouble{%
3228 \global\evenfootline={\hfil}
3229 \global\oddfootline={\hfil}
3230 \global\evenheadline={\line{\folio\hfil\thistitle}}
3231 \global\oddheadline={\line{\thischapter\hfil\folio}}
3232 \global\let\contentsalignmacro = \chapoddpage
3234 \let\contentsalignmacro = \chappager
3236 % For single-sided printing, chapter title goes across top left of page,
3237 % page number on top right.
3238 \def\HEADINGSsingle{%
3240 \global\evenfootline={\hfil}
3241 \global\oddfootline={\hfil}
3242 \global\evenheadline={\line{\thischapter\hfil\folio}}
3243 \global\oddheadline={\line{\thischapter\hfil\folio}}
3244 \global\let\contentsalignmacro = \chappager
3246 \def\HEADINGSon{\HEADINGSdouble}
3248 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3249 \let\HEADINGSdoubleafter=\HEADINGSafter
3250 \def\HEADINGSdoublex{%
3251 \global\evenfootline={\hfil}
3252 \global\oddfootline={\hfil}
3253 \global\evenheadline={\line{\folio\hfil\thistitle}}
3254 \global\oddheadline={\line{\thischapter\hfil\folio}}
3255 \global\let\contentsalignmacro = \chapoddpage
3258 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3259 \def\HEADINGSsinglex{%
3260 \global\evenfootline={\hfil}
3261 \global\oddfootline={\hfil}
3262 \global\evenheadline={\line{\thischapter\hfil\folio}}
3263 \global\oddheadline={\line{\thischapter\hfil\folio}}
3264 \global\let\contentsalignmacro = \chappager
3267 % Subroutines used in generating headings
3268 % This produces Day Month Year style of output.
3269 % Only define if not already defined, in case a txi-??.tex file has set
3270 % up a different format (e.g., txi-cs.tex does this).
3271 \ifx\today\undefined
3275 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3276 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3277 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3282 % @settitle line... specifies the title of the document, for headings.
3283 % It generates no output of its own.
3284 \def\thistitle{\putwordNoTitle}
3285 \def\settitle{\parsearg{\gdef\thistitle}}
3289 % Tables -- @table, @ftable, @vtable, @item(x).
3291 % default indentation of table text
3292 \newdimen\tableindent \tableindent=.8in
3293 % default indentation of @itemize and @enumerate text
3294 \newdimen\itemindent \itemindent=.3in
3295 % margin between end of table item and start of table text.
3296 \newdimen\itemmargin \itemmargin=.1in
3298 % used internally for \itemindent minus \itemmargin
3301 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3303 % They also define \itemindex
3304 % to index the item name in whatever manner is desired (perhaps none).
3306 \newif\ifitemxneedsnegativevskip
3308 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3310 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3311 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3313 \def\itemzzz #1{\begingroup %
3314 \advance\hsize by -\rightskip
3315 \advance\hsize by -\tableindent
3316 \setbox0=\hbox{\itemindicate{#1}}%
3318 \nobreak % This prevents a break before @itemx.
3320 % If the item text does not fit in the space we have, put it on a line
3321 % by itself, and do not allow a page break either before or after that
3322 % line. We do not start a paragraph here because then if the next
3323 % command is, e.g., @kindex, the whatsit would get put into the
3324 % horizontal list on a line by itself, resulting in extra blank space.
3325 \ifdim \wd0>\itemmax
3327 % Make this a paragraph so we get the \parskip glue and wrapping,
3328 % but leave it ragged-right.
3330 \advance\leftskip by-\tableindent
3331 \advance\hsize by\tableindent
3332 \advance\rightskip by0pt plus1fil\relax
3333 \leavevmode\unhbox0\par
3336 % We're going to be starting a paragraph, but we don't want the
3337 % \parskip glue -- logically it's part of the @item we just started.
3338 \nobreak \vskip-\parskip
3340 % Stop a page break at the \parskip glue coming up. However, if
3341 % what follows is an environment such as @example, there will be no
3342 % \parskip glue; then the negative vskip we just inserted would
3343 % cause the example and the item to crash together. So we use this
3344 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3345 % \parskip glue after all. Section titles are handled this way also.
3349 \itemxneedsnegativevskipfalse
3351 % The item text fits into the space. Start a paragraph, so that the
3352 % following text (if any) will end up on the same line.
3354 % Do this with kerns and \unhbox so that if there is a footnote in
3355 % the item text, it can migrate to the main vertical list and
3356 % eventually be printed.
3357 \nobreak\kern-\tableindent
3358 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3360 \nobreak\kern\dimen0
3362 \itemxneedsnegativevskiptrue
3366 \def\item{\errmessage{@item while not in a list environment}}
3367 \def\itemx{\errmessage{@itemx while not in a list environment}}
3369 % @table, @ftable, @vtable.
3371 \let\itemindex\gobble
3375 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3376 \tablecheck{ftable}%
3379 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3380 \tablecheck{vtable}%
3383 \ifnum \the\catcode`\^^M=\active
3385 \errmessage{This command won't work in this context; perhaps the problem is
3386 that we are \inenvironment\thisenv}%
3387 \def\next{\doignore{#1}}%
3394 \def\itemindicate{#1}%
3399 \makevalueexpandable
3400 \edef\temp{\noexpand\tablez #1\space\space\space}%
3404 \def\tablez #1 #2 #3 #4\endtablez{%
3406 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3407 \ifnum 0#2>0 \tableindent=#2\mil \fi
3408 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3409 \itemmax=\tableindent
3410 \advance \itemmax by -\itemmargin
3411 \advance \leftskip by \tableindent
3412 \exdentamount=\tableindent
3414 \parskip = \smallskipamount
3415 \ifdim \parskip=0pt \parskip=2pt \fi
3416 \let\item = \internalBitem
3417 \let\itemx = \internalBitemx
3419 \def\Etable{\endgraf\afterenvbreak}
3422 \let\Eitemize\Etable
3423 \let\Eenumerate\Etable
3425 % This is the counter used by @enumerate, which is really @itemize
3429 \envdef\itemize{\parsearg\doitemize}
3433 \itemmax=\itemindent
3434 \advance\itemmax by -\itemmargin
3435 \advance\leftskip by \itemindent
3436 \exdentamount=\itemindent
3438 \parskip=\smallskipamount
3439 \ifdim\parskip=0pt \parskip=2pt \fi
3441 % Try typesetting the item mark that if the document erroneously says
3442 % something like @itemize @samp (intending @table), there's an error
3443 % right away at the @itemize. It's not the best error message in the
3444 % world, but it's better than leaving it to the @item. This means if
3445 % the user wants an empty mark, they have to say @w{} not just @w.
3446 \def\itemcontents{#1}%
3447 \setbox0 = \hbox{\itemcontents}%
3449 % @itemize with no arg is equivalent to @itemize @bullet.
3450 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3452 \let\item=\itemizeitem
3455 % Definition of @item while inside @itemize and @enumerate.
3458 \advance\itemno by 1 % for enumerations
3459 {\let\par=\endgraf \smallbreak}% reasonable place to break
3461 % If the document has an @itemize directly after a section title, a
3462 % \nobreak will be last on the list, and \sectionheading will have
3463 % done a \vskip-\parskip. In that case, we don't want to zero
3464 % parskip, or the item text will crash with the heading. On the
3465 % other hand, when there is normal text preceding the item (as there
3466 % usually is), we do want to zero parskip, or there would be too much
3467 % space. In that case, we won't have a \nobreak before. At least
3468 % that's the theory.
3469 \ifnum\lastpenalty<10000 \parskip=0in \fi
3471 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3473 \vadjust{\penalty 1200}}% not good to break after first line of item.
3477 % \splitoff TOKENS\endmark defines \first to be the first token in
3478 % TOKENS, and \rest to be the remainder.
3480 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3482 % Allow an optional argument of an uppercase letter, lowercase letter,
3483 % or number, to specify the first label in the enumerated list. No
3484 % argument is the same as `1'.
3486 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3487 \def\enumeratey #1 #2\endenumeratey{%
3488 % If we were given no argument, pretend we were given `1'.
3490 \ifx\thearg\empty \def\thearg{1}\fi
3492 % Detect if the argument is a single token. If so, it might be a
3493 % letter. Otherwise, the only valid thing it can be is a number.
3494 % (We will always have one token, because of the test we just made.
3495 % This is a good thing, since \splitoff doesn't work given nothing at
3496 % all -- the first parameter is undelimited.)
3497 \expandafter\splitoff\thearg\endmark
3499 % Only one token in the argument. It could still be anything.
3500 % A ``lowercase letter'' is one whose \lccode is nonzero.
3501 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3502 % not equal to itself.
3503 % Otherwise, we assume it's a number.
3505 % We need the \relax at the end of the \ifnum lines to stop TeX from
3506 % continuing to look for a <number>.
3508 \ifnum\lccode\expandafter`\thearg=0\relax
3509 \numericenumerate % a number (we hope)
3512 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3513 \lowercaseenumerate % lowercase letter
3515 \uppercaseenumerate % uppercase letter
3519 % Multiple tokens in the argument. We hope it's a number.
3524 % An @enumerate whose labels are integers. The starting integer is
3527 \def\numericenumerate{%
3529 \startenumeration{\the\itemno}%
3532 % The starting (lowercase) letter is in \thearg.
3533 \def\lowercaseenumerate{%
3534 \itemno = \expandafter`\thearg
3536 % Be sure we're not beyond the end of the alphabet.
3538 \errmessage{No more lowercase letters in @enumerate; get a bigger
3545 % The starting (uppercase) letter is in \thearg.
3546 \def\uppercaseenumerate{%
3547 \itemno = \expandafter`\thearg
3549 % Be sure we're not beyond the end of the alphabet.
3551 \errmessage{No more uppercase letters in @enumerate; get a bigger
3558 % Call \doitemize, adding a period to the first argument and supplying the
3559 % common last two arguments. Also subtract one from the initial value in
3560 % \itemno, since @item increments \itemno.
3562 \def\startenumeration#1{%
3563 \advance\itemno by -1
3564 \doitemize{#1.}\flushcr
3567 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3570 \def\alphaenumerate{\enumerate{a}}
3571 \def\capsenumerate{\enumerate{A}}
3572 \def\Ealphaenumerate{\Eenumerate}
3573 \def\Ecapsenumerate{\Eenumerate}
3576 % @multitable macros
3577 % Amy Hendrickson, 8/18/94, 3/6/96
3579 % @multitable ... @end multitable will make as many columns as desired.
3580 % Contents of each column will wrap at width given in preamble. Width
3581 % can be specified either with sample text given in a template line,
3582 % or in percent of \hsize, the current width of text on page.
3584 % Table can continue over pages but will only break between lines.
3588 % Either define widths of columns in terms of percent of \hsize:
3589 % @multitable @columnfractions .25 .3 .45
3592 % Numbers following @columnfractions are the percent of the total
3593 % current hsize to be used for each column. You may use as many
3594 % columns as desired.
3597 % Or use a template:
3598 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3600 % using the widest term desired in each column.
3602 % Each new table line starts with @item, each subsequent new column
3603 % starts with @tab. Empty columns may be produced by supplying @tab's
3604 % with nothing between them for as many times as empty columns are needed,
3605 % ie, @tab@tab@tab will produce two empty columns.
3607 % @item, @tab do not need to be on their own lines, but it will not hurt
3610 % Sample multitable:
3612 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3613 % @item first col stuff @tab second col stuff @tab third col
3620 % @item first col stuff @tab second col stuff
3621 % @tab Many paragraphs of text may be used in any column.
3623 % They will wrap at the width determined by the template.
3624 % @item@tab@tab This will be in third column.
3627 % Default dimensions may be reset by user.
3628 % @multitableparskip is vertical space between paragraphs in table.
3629 % @multitableparindent is paragraph indent in table.
3630 % @multitablecolmargin is horizontal space to be left between columns.
3631 % @multitablelinespace is space to leave between table items, baseline
3633 % 0pt means it depends on current normal line spacing.
3635 \newskip\multitableparskip
3636 \newskip\multitableparindent
3637 \newdimen\multitablecolspace
3638 \newskip\multitablelinespace
3639 \multitableparskip=0pt
3640 \multitableparindent=6pt
3641 \multitablecolspace=12pt
3642 \multitablelinespace=0pt
3644 % Macros used to set up halign preamble:
3646 \let\endsetuptable\relax
3647 \def\xendsetuptable{\endsetuptable}
3648 \let\columnfractions\relax
3649 \def\xcolumnfractions{\columnfractions}
3652 % #1 is the @columnfraction, usually a decimal number like .5, but might
3653 % be just 1. We just use it, whatever it is.
3655 \def\pickupwholefraction#1 {%
3656 \global\advance\colcount by 1
3657 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3664 \ifx\firstarg\xendsetuptable
3667 \ifx\firstarg\xcolumnfractions
3668 \global\setpercenttrue
3671 \let\go\pickupwholefraction
3673 \global\advance\colcount by 1
3674 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3675 % separator; typically that is always in the input, anyway.
3676 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3679 \ifx\go\pickupwholefraction
3680 % Put the argument back for the \pickupwholefraction call, so
3681 % we'll always have a period there to be parsed.
3682 \def\go{\pickupwholefraction#1}%
3684 \let\go = \setuptable
3690 % multitable-only commands.
3692 % @headitem starts a heading row, which we typeset in bold.
3693 % Assignments have to be global since we are inside the implicit group
3694 % of an alignment entry. \everycr resets \everytab so we don't have to
3695 % undo it ourselves.
3696 \def\headitemfont{\b}% for people to use in the template row; not changeable
3698 \checkenv\multitable
3700 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3701 \the\everytab % for the first item
3704 % A \tab used to include \hskip1sp. But then the space in a template
3705 % line is not enough. That is bad. So let's go back to just `&' until
3706 % we again encounter the problem the 1sp was intended to solve.
3707 % --karl, nathan@acm.org, 20apr99.
3708 \def\tab{\checkenv\multitable &\the\everytab}%
3710 % @multitable ... @end multitable definitions:
3712 \newtoks\everytab % insert after every tab.
3714 \envdef\multitable{%
3718 % @item within a multitable starts a normal row.
3719 % We use \def instead of \let so that if one of the multitable entries
3720 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3721 % \endtemplate) expanding \doitemize.
3726 \setmultitablespacing
3727 \parskip=\multitableparskip
3728 \parindent=\multitableparindent
3734 \global\everytab={}%
3735 \global\colcount=0 % Reset the column counter.
3736 % Check for saved footnotes, etc.
3738 % Keeps underfull box messages off when table breaks over pages.
3740 % Maybe so, but it also creates really weird page breaks when the
3741 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3742 % problem manifests itself, so it can be fixed for real --karl.
3746 \parsearg\domultitable
3748 \def\domultitable#1{%
3749 % To parse everything between @multitable and @item:
3750 \setuptable#1 \endsetuptable
3752 % This preamble sets up a generic column definition, which will
3753 % be used as many times as user calls for columns.
3754 % \vtop will set a single line and will also let text wrap and
3755 % continue for many paragraphs if desired.
3757 \global\advance\colcount by 1
3760 % Use the current \colcount to find the correct column width:
3761 \hsize=\expandafter\csname col\the\colcount\endcsname
3763 % In order to keep entries from bumping into each other
3764 % we will add a \leftskip of \multitablecolspace to all columns after
3767 % If a template has been used, we will add \multitablecolspace
3768 % to the width of each template entry.
3770 % If the user has set preamble in terms of percent of \hsize we will
3771 % use that dimension as the width of the column, and the \leftskip
3772 % will keep entries from bumping into each other. Table will start at
3773 % left margin and final column will justify at right margin.
3775 % Make sure we don't inherit \rightskip from the outer environment.
3778 % The first column will be indented with the surrounding text.
3779 \advance\hsize by\leftskip
3782 % If user has not set preamble in terms of percent of \hsize
3783 % we will advance \hsize by \multitablecolspace.
3784 \advance\hsize by \multitablecolspace
3786 % In either case we will make \leftskip=\multitablecolspace:
3787 \leftskip=\multitablecolspace
3789 % Ignoring space at the beginning and end avoids an occasional spurious
3790 % blank line, when TeX decides to break the line at the space before the
3791 % box from the multistrut, so the strut ends up on a line by itself.
3793 % @multitable @columnfractions .11 .89
3795 % @tab Legal holiday which is valid in major parts of the whole country.
3796 % Is automatically provided with highlighting sequences respectively
3797 % marking characters.
3798 \noindent\ignorespaces##\unskip\multistrut
3803 \egroup % end the \halign
3804 \global\setpercentfalse
3807 \def\setmultitablespacing{%
3808 \def\multistrut{\strut}% just use the standard line spacing
3810 % Compute \multitablelinespace (if not defined by user) for use in
3811 % \multitableparskip calculation. We used define \multistrut based on
3812 % this, but (ironically) that caused the spacing to be off.
3813 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3814 \ifdim\multitablelinespace=0pt
3815 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3816 \global\advance\multitablelinespace by-\ht0
3818 %% Test to see if parskip is larger than space between lines of
3819 %% table. If not, do nothing.
3820 %% If so, set to same dimension as multitablelinespace.
3821 \ifdim\multitableparskip>\multitablelinespace
3822 \global\multitableparskip=\multitablelinespace
3823 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3824 %% than skip between lines in the table.
3826 \ifdim\multitableparskip=0pt
3827 \global\multitableparskip=\multitablelinespace
3828 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3829 %% than skip between lines in the table.
3833 \message{conditionals,}
3835 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3836 % @ifnotxml always succeed. They currently do nothing; we don't
3837 % attempt to check whether the conditionals are properly nested. But we
3838 % have to remember that they are conditionals, so that @end doesn't
3839 % attempt to close an environment group.
3842 \expandafter\let\csname #1\endcsname = \relax
3843 \expandafter\let\csname iscond.#1\endcsname = 1
3846 \makecond{ifnotdocbook}
3847 \makecond{ifnothtml}
3848 \makecond{ifnotinfo}
3849 \makecond{ifnotplaintext}
3852 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3854 \def\direntry{\doignore{direntry}}
3855 \def\documentdescription{\doignore{documentdescription}}
3856 \def\docbook{\doignore{docbook}}
3857 \def\html{\doignore{html}}
3858 \def\ifdocbook{\doignore{ifdocbook}}
3859 \def\ifhtml{\doignore{ifhtml}}
3860 \def\ifinfo{\doignore{ifinfo}}
3861 \def\ifnottex{\doignore{ifnottex}}
3862 \def\ifplaintext{\doignore{ifplaintext}}
3863 \def\ifxml{\doignore{ifxml}}
3864 \def\ignore{\doignore{ignore}}
3865 \def\menu{\doignore{menu}}
3866 \def\xml{\doignore{xml}}
3868 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3870 % A count to remember the depth of nesting.
3871 \newcount\doignorecount
3873 \def\doignore#1{\begingroup
3874 % Scan in ``verbatim'' mode:
3876 \catcode`\@ = \other
3877 \catcode`\{ = \other
3878 \catcode`\} = \other
3880 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3883 % Count number of #1's that we've seen.
3886 % Swallow text until we reach the matching `@end #1'.
3890 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3893 \gdef\dodoignore#1{%
3894 % #1 contains the command name as a string, e.g., `ifinfo'.
3896 % Define a command to find the next `@end #1'.
3897 \long\def\doignoretext##1^^M@end #1{%
3898 \doignoretextyyy##1^^M@#1\_STOP_}%
3900 % And this command to find another #1 command, at the beginning of a
3901 % line. (Otherwise, we would consider a line `@c @ifset', for
3902 % example, to count as an @ifset for nesting.)
3903 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3905 % And now expand that command.
3910 \def\doignoreyyy#1{%
3912 \ifx\temp\empty % Nothing found.
3913 \let\next\doignoretextzzz
3914 \else % Found a nested condition, ...
3915 \advance\doignorecount by 1
3916 \let\next\doignoretextyyy % ..., look for another.
3917 % If we're here, #1 ends with ^^M\ifinfo (for example).
3919 \next #1% the token \_STOP_ is present just after this macro.
3922 % We have to swallow the remaining "\_STOP_".
3924 \def\doignoretextzzz#1{%
3925 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3926 \let\next\enddoignore
3927 \else % Still inside a nested condition.
3928 \advance\doignorecount by -1
3929 \let\next\doignoretext % Look for the next @end.
3934 % Finish off ignored text.
3936 % Ignore anything after the last `@end #1'; this matters in verbatim
3937 % environments, where otherwise the newline after an ignored conditional
3938 % would result in a blank line in the output.
3939 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3943 % @set VAR sets the variable VAR to an empty value.
3944 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3946 % Since we want to separate VAR from REST-OF-LINE (which might be
3947 % empty), we can't just use \parsearg; we have to insert a space of our
3948 % own to delimit the rest of the line, and then take it out again if we
3950 % We rely on the fact that \parsearg sets \catcode`\ =10.
3952 \parseargdef\set{\setyyy#1 \endsetyyy}
3953 \def\setyyy#1 #2\endsetyyy{%
3955 \makevalueexpandable
3957 \edef\next{\gdef\makecsname{SET#1}}%
3965 % Remove the trailing space \setxxx inserted.
3966 \def\setzzz#1 \endsetzzz{\next{#1}}
3968 % @clear VAR clears (i.e., unsets) the variable VAR.
3970 \parseargdef\clear{%
3972 \makevalueexpandable
3973 \global\expandafter\let\csname SET#1\endcsname=\relax
3977 % @value{foo} gets the text saved in variable foo.
3978 \def\value{\begingroup\makevalueexpandable\valuexxx}
3979 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3981 \catcode`\- = \active \catcode`\_ = \active
3983 \gdef\makevalueexpandable{%
3984 \let\value = \expandablevalue
3985 % We don't want these characters active, ...
3986 \catcode`\-=\other \catcode`\_=\other
3987 % ..., but we might end up with active ones in the argument if
3988 % we're called from @code, as @code{@value{foo-bar_}}, though.
3989 % So \let them to their normal equivalents.
3990 \let-\realdash \let_\normalunderscore
3994 % We have this subroutine so that we can handle at least some @value's
3995 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3996 % The command has to be fully expandable (if the variable is set), since
3997 % the result winds up in the index file. This means that if the
3998 % variable's value contains other Texinfo commands, it's almost certain
3999 % it will fail (although perhaps we could fix that with sufficient work
4000 % to do a one-level expansion on the result, instead of complete).
4002 \def\expandablevalue#1{%
4003 \expandafter\ifx\csname SET#1\endcsname\relax
4004 {[No value for ``#1'']}%
4005 \message{Variable `#1', used in @value, is not set.}%
4007 \csname SET#1\endcsname
4011 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4014 % To get special treatment of `@end ifset,' call \makeond and the redefine.
4017 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4020 \makevalueexpandable
4022 \expandafter\ifx\csname SET#2\endcsname\relax
4023 #1% If not set, redefine \next.
4028 \def\ifsetfail{\doignore{ifset}}
4030 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
4031 % defined with @set, or has been undefined with @clear.
4033 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4034 % above code: if the variable is not set, do nothing, if it is set,
4035 % then redefine \next to \ifclearfail.
4038 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4039 \def\ifclearfail{\doignore{ifclear}}
4041 % @dircategory CATEGORY -- specify a category of the dir file
4042 % which this file should belong to. Ignore this in TeX.
4043 \let\dircategory=\comment
4045 % @defininfoenclose.
4046 \let\definfoenclose=\comment
4050 % Index generation facilities
4052 % Define \newwrite to be identical to plain tex's \newwrite
4053 % except not \outer, so it can be used within macros and \if's.
4054 \edef\newwrite{\makecsname{ptexnewwrite}}
4056 % \newindex {foo} defines an index named foo.
4057 % It automatically defines \fooindex such that
4058 % \fooindex ...rest of line... puts an entry in the index foo.
4059 % It also defines \fooindfile to be the number of the output channel for
4060 % the file that accumulates this index. The file's extension is foo.
4061 % The name of an index should be no more than 2 characters long
4062 % for the sake of vms.
4066 \expandafter\newwrite \csname#1indfile\endcsname
4067 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4069 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4070 \noexpand\doindex{#1}}
4073 % @defindex foo == \newindex{foo}
4075 \def\defindex{\parsearg\newindex}
4077 % Define @defcodeindex, like @defindex except put all entries in @code.
4079 \def\defcodeindex{\parsearg\newcodeindex}
4081 \def\newcodeindex#1{%
4083 \expandafter\newwrite \csname#1indfile\endcsname
4084 \openout \csname#1indfile\endcsname \jobname.#1
4086 \expandafter\xdef\csname#1index\endcsname{%
4087 \noexpand\docodeindex{#1}}%
4091 % @synindex foo bar makes index foo feed into index bar.
4092 % Do this instead of @defindex foo if you don't want it as a separate index.
4094 % @syncodeindex foo bar similar, but put all entries made for index foo
4097 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4098 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4100 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4101 % #3 the target index (bar).
4102 \def\dosynindex#1#2#3{%
4103 % Only do \closeout if we haven't already done it, else we'll end up
4104 % closing the target index.
4105 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4106 % The \closeout helps reduce unnecessary open files; the limit on the
4107 % Acorn RISC OS is a mere 16 files.
4108 \expandafter\closeout\csname#2indfile\endcsname
4109 \expandafter\let\csname donesynindex#2\endcsname = 1
4111 % redefine \fooindfile:
4112 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4113 \expandafter\let\csname#2indfile\endcsname=\temp
4114 % redefine \fooindex:
4115 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4118 % Define \doindex, the driver for all \fooindex macros.
4119 % Argument #1 is generated by the calling \fooindex macro,
4120 % and it is "foo", the name of the index.
4122 % \doindex just uses \parsearg; it calls \doind for the actual work.
4123 % This is because \doind is more useful to call from other macros.
4125 % There is also \dosubind {index}{topic}{subtopic}
4126 % which makes an entry in a two-level index such as the operation index.
4128 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4129 \def\singleindexer #1{\doind{\indexname}{#1}}
4131 % like the previous two, but they put @code around the argument.
4132 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4133 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4135 % Take care of Texinfo commands that can appear in an index entry.
4136 % Since there are some commands we want to expand, and others we don't,
4137 % we have to laboriously prevent expansion for those that we don't.
4140 \escapechar = `\\ % use backslash in output files.
4141 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4142 \def\ {\realbackslash\space }%
4144 % Need these unexpandable (because we define \tt as a dummy)
4145 % definitions when @{ or @} appear in index entry text. Also, more
4146 % complicated, when \tex is in effect and \{ is a \delimiter again.
4147 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4148 % braces and backslashes are used only as delimiters. Perhaps we
4149 % should define @lbrace and @rbrace commands a la @comma.
4150 \def\{{{\tt\char123}}%
4151 \def\}{{\tt\char125}}%
4153 % I don't entirely understand this, but when an index entry is
4154 % generated from a macro call, the \endinput which \scanmacro inserts
4155 % causes processing to be prematurely terminated. This is,
4156 % apparently, because \indexsorttmp is fully expanded, and \endinput
4157 % is an expandable command. The redefinition below makes \endinput
4158 % disappear altogether for that purpose -- although logging shows that
4159 % processing continues to some further point. On the other hand, it
4160 % seems \endinput does not hurt in the printed index arg, since that
4161 % is still getting written without apparent harm.
4163 % Sample source (mac-idx3.tex, reported by Graham Percival to
4164 % help-texinfo, 22may06):
4165 % @macro funindex {WORD}
4169 % @funindex commtest
4171 % The above is not enough to reproduce the bug, but it gives the flavor.
4173 % Sample whatsit resulting:
4174 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4177 \let\endinput = \empty
4179 % Do the redefinitions.
4183 % For the aux and toc files, @ is the escape character. So we want to
4184 % redefine everything using @ as the escape character (instead of
4185 % \realbackslash, still used for index files). When everything uses @,
4186 % this will be simpler.
4191 \let\{ = \lbraceatcmd
4192 \let\} = \rbraceatcmd
4194 % Do the redefinitions.
4199 % Called from \indexdummies and \atdummies.
4201 \def\commondummies{%
4203 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4204 % preventing its expansion. This is used only for control% words,
4205 % not control letters, because the \space would be incorrect for
4206 % control characters, but is needed to separate the control word
4207 % from whatever follows.
4209 % For control letters, we have \definedummyletter, which omits the
4212 % These can be used both for control words that take an argument and
4213 % those that do not. If it is followed by {arg} in the input, then
4214 % that will dutifully get written to the index (or wherever).
4216 \def\definedummyword ##1{\def##1{\string##1\space}}%
4217 \def\definedummyletter##1{\def##1{\string##1}}%
4218 \let\definedummyaccent\definedummyletter
4220 \commondummiesnofonts
4222 \definedummyletter\_%
4224 % Non-English letters.
4235 \definedummyword\exclamdown
4239 \definedummyword\ordf
4240 \definedummyword\ordm
4241 \definedummyword\questiondown
4245 % Although these internal commands shouldn't show up, sometimes they do.
4247 \definedummyword\gtr
4248 \definedummyword\hat
4249 \definedummyword\less
4252 \definedummyword\tclose
4255 \definedummyword\LaTeX
4256 \definedummyword\TeX
4258 % Assorted special characters.
4259 \definedummyword\bullet
4260 \definedummyword\comma
4261 \definedummyword\copyright
4262 \definedummyword\registeredsymbol
4263 \definedummyword\dots
4264 \definedummyword\enddots
4265 \definedummyword\entrybreak
4266 \definedummyword\equiv
4267 \definedummyword\error
4268 \definedummyword\euro
4269 \definedummyword\guillemetleft
4270 \definedummyword\guillemetright
4271 \definedummyword\guilsinglleft
4272 \definedummyword\guilsinglright
4273 \definedummyword\expansion
4274 \definedummyword\minus
4275 \definedummyword\ogonek
4276 \definedummyword\pounds
4277 \definedummyword\point
4278 \definedummyword\print
4279 \definedummyword\quotedblbase
4280 \definedummyword\quotedblleft
4281 \definedummyword\quotedblright
4282 \definedummyword\quoteleft
4283 \definedummyword\quoteright
4284 \definedummyword\quotesinglbase
4285 \definedummyword\result
4286 \definedummyword\textdegree
4288 % We want to disable all macros so that they are not expanded by \write.
4291 \normalturnoffactive
4293 % Handle some cases of @value -- where it does not contain any
4294 % (non-fully-expandable) commands.
4295 \makevalueexpandable
4298 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4300 \def\commondummiesnofonts{%
4301 % Control letters and accents.
4302 \definedummyletter\!%
4303 \definedummyaccent\"%
4304 \definedummyaccent\'%
4305 \definedummyletter\*%
4306 \definedummyaccent\,%
4307 \definedummyletter\.%
4308 \definedummyletter\/%
4309 \definedummyletter\:%
4310 \definedummyaccent\=%
4311 \definedummyletter\?%
4312 \definedummyaccent\^%
4313 \definedummyaccent\`%
4314 \definedummyaccent\~%
4318 \definedummyword\dotaccent
4319 \definedummyword\ogonek
4320 \definedummyword\ringaccent
4321 \definedummyword\tieaccent
4322 \definedummyword\ubaraccent
4323 \definedummyword\udotaccent
4324 \definedummyword\dotless
4326 % Texinfo font commands.
4333 % Commands that take arguments.
4334 \definedummyword\acronym
4335 \definedummyword\cite
4336 \definedummyword\code
4337 \definedummyword\command
4338 \definedummyword\dfn
4339 \definedummyword\email
4340 \definedummyword\emph
4341 \definedummyword\env
4342 \definedummyword\file
4343 \definedummyword\kbd
4344 \definedummyword\key
4345 \definedummyword\math
4346 \definedummyword\option
4347 \definedummyword\pxref
4348 \definedummyword\ref
4349 \definedummyword\samp
4350 \definedummyword\strong
4351 \definedummyword\tie
4352 \definedummyword\uref
4353 \definedummyword\url
4354 \definedummyword\var
4355 \definedummyword\verb
4357 \definedummyword\xref
4360 % \indexnofonts is used when outputting the strings to sort the index
4361 % by, and when constructing control sequence names. It eliminates all
4362 % control sequences and just writes whatever the best ASCII sort string
4363 % would be for a given command (usually its argument).
4366 % Accent commands should become @asis.
4367 \def\definedummyaccent##1{\let##1\asis}%
4368 % We can just ignore other control letters.
4369 \def\definedummyletter##1{\let##1\empty}%
4370 % Hopefully, all control words can become @asis.
4371 \let\definedummyword\definedummyaccent
4373 \commondummiesnofonts
4375 % Don't no-op \tt, since it isn't a user-level command
4376 % and is used in the definitions of the active chars like <, >, |, etc.
4377 % Likewise with the other plain tex font commands.
4382 % how to handle braces?
4383 \def\_{\normalunderscore}%
4385 % Non-English letters.
4402 \def\questiondown{?}%
4409 % Assorted special characters.
4410 % (The following {} will end up in the sort string, but that's ok.)
4411 \def\bullet{bullet}%
4413 \def\copyright{copyright}%
4419 \def\expansion{==>}%
4420 \def\guillemetleft{<<}%
4421 \def\guillemetright{>>}%
4422 \def\guilsinglleft{<}%
4423 \def\guilsinglright{>}%
4426 \def\pounds{pounds}%
4428 \def\quotedblbase{"}%
4429 \def\quotedblleft{"}%
4430 \def\quotedblright{"}%
4433 \def\quotesinglbase{,}%
4434 \def\registeredsymbol{R}%
4438 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4439 \else \indexlquoteignore \fi
4441 % We need to get rid of all macros, leaving only the arguments (if present).
4442 % Of course this is not nearly correct, but it is the best we can do for now.
4443 % makeinfo does not expand macros in the argument to @deffn, which ends up
4444 % writing an index entry, and texindex isn't prepared for an index sort entry
4445 % that starts with \.
4447 % Since macro invocations are followed by braces, we can just redefine them
4448 % to take a single TeX argument. The case of a macro invocation that
4449 % goes to end-of-line is not handled.
4454 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4455 % ignore left quotes in the sort term.
4456 {\catcode`\`=\active
4457 \gdef\indexlquoteignore{\let`=\empty}}
4459 \let\indexbackslash=0 %overridden during \printindex.
4460 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4462 % Most index entries go through here, but \dosubind is the general case.
4463 % #1 is the index name, #2 is the entry text.
4464 \def\doind#1#2{\dosubind{#1}{#2}{}}
4466 % Workhorse for all \fooindexes.
4467 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4468 % empty if called from \doind, as we usually are (the main exception
4469 % is with most defuns, which call us directly).
4471 \def\dosubind#1#2#3{%
4474 % Store the main index entry text (including the third arg).
4476 % If third arg is present, precede it with a space.
4478 \ifx\thirdarg\empty \else
4479 \toks0 = \expandafter{\the\toks0 \space #3}%
4482 \edef\writeto{\csname#1indfile\endcsname}%
4484 \safewhatsit\dosubindwrite
4489 % Write the entry in \toks0 to the index file:
4491 \def\dosubindwrite{%
4492 % Put the index entry in the margin if desired.
4493 \ifx\SETmarginindex\relax\else
4494 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4497 % Remember, we are within a group.
4498 \indexdummies % Must do this here, since \bf, etc expand at this stage
4499 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4500 % so it will be output as is; and it will print as backslash.
4502 % Process the index entry with all font commands turned off, to
4503 % get the string to sort by.
4505 \edef\temp{\the\toks0}% need full expansion
4506 \xdef\indexsorttmp{\temp}%
4509 % Set up the complete index entry, with both the sort key and
4510 % the original text, including any font commands. We write
4511 % three arguments to \entry to the .?? file (four in the
4512 % subentry case), texindex reduces to two when writing the .??s
4516 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4521 % Take care of unwanted page breaks/skips around a whatsit:
4523 % If a skip is the last thing on the list now, preserve it
4524 % by backing up by \lastskip, doing the \write, then inserting
4525 % the skip again. Otherwise, the whatsit generated by the
4526 % \write or \pdfdest will make \lastskip zero. The result is that
4527 % sequences like this:
4531 % will have extra space inserted, because the \medbreak in the
4532 % start of the @defun won't see the skip inserted by the @end of
4533 % the previous defun.
4535 % But don't do any of this if we're not in vertical mode. We
4536 % don't want to do a \vskip and prematurely end a paragraph.
4538 % Avoid page breaks due to these extra skips, too.
4540 % But wait, there is a catch there:
4541 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4542 % sufficient for this purpose, as it ignores stretch and shrink parts
4543 % of the skip. The only way seems to be to check the textual
4544 % representation of the skip.
4546 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4547 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4549 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4551 \newskip\whatsitskip
4552 \newcount\whatsitpenalty
4556 \def\safewhatsit#1{%
4560 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4561 \whatsitskip = \lastskip
4562 \edef\lastskipmacro{\the\lastskip}%
4563 \whatsitpenalty = \lastpenalty
4565 % If \lastskip is nonzero, that means the last item was a
4566 % skip. And since a skip is discardable, that means this
4567 % -\whatsitskip glue we're inserting is preceded by a
4568 % non-discardable item, therefore it is not a potential
4569 % breakpoint, therefore no \nobreak needed.
4570 \ifx\lastskipmacro\zeroskipmacro
4577 \ifx\lastskipmacro\zeroskipmacro
4578 % If \lastskip was zero, perhaps the last item was a penalty, and
4579 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4580 % to re-insert the same penalty (values >10000 are used for various
4581 % signals); since we just inserted a non-discardable item, any
4582 % following glue (such as a \parskip) would be a breakpoint. For example:
4584 % @deffn deffn-whatever
4585 % @vindex index-whatever
4587 % would allow a break between the index-whatever whatsit
4588 % and the "Description." paragraph.
4589 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4591 % On the other hand, if we had a nonzero \lastskip,
4592 % this make-up glue would be preceded by a non-discardable item
4593 % (the whatsit from the \write), so we must insert a \nobreak.
4594 \nobreak\vskip\whatsitskip
4599 % The index entry written in the file actually looks like
4600 % \entry {sortstring}{page}{topic}
4602 % \entry {sortstring}{page}{topic}{subtopic}
4603 % The texindex program reads in these files and writes files
4604 % containing these kinds of lines:
4606 % before the first topic whose initial is c
4607 % \entry {topic}{pagelist}
4608 % for a topic that is used without subtopics
4610 % for the beginning of a topic that is used with subtopics
4611 % \secondary {subtopic}{pagelist}
4612 % for each subtopic.
4614 % Define the user-accessible indexing commands
4615 % @findex, @vindex, @kindex, @cindex.
4617 \def\findex {\fnindex}
4618 \def\kindex {\kyindex}
4619 \def\cindex {\cpindex}
4620 \def\vindex {\vrindex}
4621 \def\tindex {\tpindex}
4622 \def\pindex {\pgindex}
4624 \def\cindexsub {\begingroup\obeylines\cindexsub}
4626 \gdef\cindexsub "#1" #2^^M{\endgroup %
4627 \dosubind{cp}{#2}{#1}}}
4629 % Define the macros used in formatting output of the sorted index material.
4631 % @printindex causes a particular index (the ??s file) to get printed.
4632 % It does not print any chapter heading (usually an @unnumbered).
4634 \parseargdef\printindex{\begingroup
4635 \dobreak \chapheadingskip{10000}%
4640 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4642 % See if the index file exists and is nonempty.
4643 % Change catcode of @ here so that if the index file contains
4645 % as its first line, TeX doesn't complain about mismatched braces
4646 % (because it thinks @} is a control sequence).
4648 \openin 1 \jobname.#1s
4650 % \enddoublecolumns gets confused if there is no text in the index,
4651 % and it loses the chapter title and the aux file entries for the
4652 % index. The easiest way to prevent this problem is to make sure
4653 % there is some text.
4654 \putwordIndexNonexistent
4657 % If the index file exists but is empty, then \openin leaves \ifeof
4658 % false. We have to make TeX try to read something from the file, so
4659 % it can discover if there is anything in it.
4662 \putwordIndexIsEmpty
4664 % Index files are almost Texinfo source, but we use \ as the escape
4665 % character. It would be better to use @, but that's too big a change
4666 % to make right now.
4667 \def\indexbackslash{\backslashcurfont}%
4678 % These macros are used by the sorted index file itself.
4679 % Change them to control the appearance of the index.
4682 % Some minor font changes for the special characters.
4683 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4685 % Remove any glue we may have, we'll be inserting our own.
4688 % We like breaks before the index initials, so insert a bonus.
4690 \vskip 0pt plus 3\baselineskip
4692 \vskip 0pt plus -3\baselineskip
4694 % Typeset the initial. Making this add up to a whole number of
4695 % baselineskips increases the chance of the dots lining up from column
4696 % to column. It still won't often be perfect, because of the stretch
4697 % we need before each entry, but it's better.
4699 % No shrink because it confuses \balancecolumns.
4700 \vskip 1.67\baselineskip plus .5\baselineskip
4701 \leftline{\secbf #1}%
4702 % Do our best not to break after the initial.
4704 \vskip .33\baselineskip plus .1\baselineskip
4707 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4708 % then page number (#2) flushed to the right margin. It is used for index
4709 % and table of contents entries. The paragraph is indented by \leftskip.
4711 % A straightforward implementation would start like this:
4712 % \def\entry#1#2{...
4713 % But this freezes the catcodes in the argument, and can cause problems to
4714 % @code, which sets - active. This problem was fixed by a kludge---
4715 % ``-'' was active throughout whole index, but this isn't really right.
4716 % The right solution is to prevent \entry from swallowing the whole text.
4721 % Start a new paragraph if necessary, so our assignments below can't
4722 % affect previous text.
4725 % Do not fill out the last line with white space.
4728 % No extra space above this paragraph.
4731 % Do not prefer a separate line ending with a hyphen to fewer lines.
4732 \finalhyphendemerits = 0
4734 % \hangindent is only relevant when the entry text and page number
4735 % don't both fit on one line. In that case, bob suggests starting the
4736 % dots pretty far over on the line. Unfortunately, a large
4737 % indentation looks wrong when the entry text itself is broken across
4738 % lines. So we use a small indentation and put up with long leaders.
4740 % \hangafter is reset to 1 (which is the value we want) at the start
4741 % of each paragraph, so we need not do anything with that.
4744 % When the entry text needs to be broken, just fill out the first line
4746 \rightskip = 0pt plus1fil
4748 % A bit of stretch before each entry for the benefit of balancing
4752 % When reading the text of entry, convert explicit line breaks
4753 % from @* into spaces. The user might give these in long section
4754 % titles, for instance.
4755 \def\*{\unskip\space\ignorespaces}%
4756 \def\entrybreak{\hfil\break}%
4758 % Swallow the left brace of the text (first parameter):
4759 \afterassignment\doentry
4762 \def\entrybreak{\unskip\space\ignorespaces}%
4764 \bgroup % Instead of the swallowed brace.
4766 \aftergroup\finishentry
4767 % And now comes the text of the entry.
4769 \def\finishentry#1{%
4770 % #1 is the page number.
4772 % The following is kludged to not output a line of dots in the index if
4773 % there are no page numbers. The next person who breaks this will be
4774 % cursed by a Unix daemon.
4775 \setbox\boxA = \hbox{#1}%
4776 \ifdim\wd\boxA = 0pt
4780 % If we must, put the page number on a line of its own, and fill out
4781 % this line with blank space. (The \hfil is overwhelmed with the
4782 % fill leaders glue in \indexdotfill if the page number does fit.)
4784 \null\nobreak\indexdotfill % Have leaders before the page number.
4786 % The `\ ' here is removed by the implicit \unskip that TeX does as
4787 % part of (the primitive) \par. Without it, a spurious underfull
4800 % Like plain.tex's \dotfill, except uses up at least 1 em.
4801 \def\indexdotfill{\cleaders
4802 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4804 \def\primary #1{\line{#1\hfil}}
4806 \newskip\secondaryindent \secondaryindent=0.5cm
4807 \def\secondary#1#2{{%
4812 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4814 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4821 % Define two-column mode, which we use to typeset indexes.
4822 % Adapted from the TeXbook, page 416, which is to say,
4823 % the manmac.tex format used to print the TeXbook itself.
4827 \newdimen\doublecolumnhsize
4829 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4830 % Grab any single-column material above us.
4833 % Here is a possibility not foreseen in manmac: if we accumulate a
4834 % whole lot of material, we might end up calling this \output
4835 % routine twice in a row (see the doublecol-lose test, which is
4836 % essentially a couple of indexes with @setchapternewpage off). In
4837 % that case we just ship out what is in \partialpage with the normal
4838 % output routine. Generally, \partialpage will be empty when this
4839 % runs and this will be a no-op. See the indexspread.tex test case.
4840 \ifvoid\partialpage \else
4841 \onepageout{\pagecontents\partialpage}%
4844 \global\setbox\partialpage = \vbox{%
4845 % Unvbox the main output page.
4847 \kern-\topskip \kern\baselineskip
4850 \eject % run that output routine to set \partialpage
4852 % Use the double-column output routine for subsequent pages.
4853 \output = {\doublecolumnout}%
4855 % Change the page size parameters. We could do this once outside this
4856 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4857 % format, but then we repeat the same computation. Repeating a couple
4858 % of assignments once per index is clearly meaningless for the
4859 % execution time, so we may as well do it in one place.
4861 % First we halve the line length, less a little for the gutter between
4862 % the columns. We compute the gutter based on the line length, so it
4863 % changes automatically with the paper format. The magic constant
4864 % below is chosen so that the gutter has the same value (well, +-<1pt)
4865 % as it did when we hard-coded it.
4867 % We put the result in a separate register, \doublecolumhsize, so we
4868 % can restore it in \pagesofar, after \hsize itself has (potentially)
4871 \doublecolumnhsize = \hsize
4872 \advance\doublecolumnhsize by -.04154\hsize
4873 \divide\doublecolumnhsize by 2
4874 \hsize = \doublecolumnhsize
4876 % Double the \vsize as well. (We don't need a separate register here,
4877 % since nobody clobbers \vsize.)
4881 % The double-column output routine for all double-column pages except
4884 \def\doublecolumnout{%
4885 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4886 % Get the available space for the double columns -- the normal
4887 % (undoubled) page height minus any material left over from the
4891 \advance\dimen@ by -\ht\partialpage
4893 % box0 will be the left-hand column, box2 the right.
4894 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4895 \onepageout\pagesofar
4897 \penalty\outputpenalty
4900 % Re-output the contents of the output page -- any previous material,
4901 % followed by the two boxes we just split, in box0 and box2.
4905 \hsize = \doublecolumnhsize
4906 \wd0=\hsize \wd2=\hsize
4907 \hbox to\pagewidth{\box0\hfil\box2}%
4910 % All done with double columns.
4911 \def\enddoublecolumns{%
4912 % The following penalty ensures that the page builder is exercised
4913 % _before_ we change the output routine. This is necessary in the
4914 % following situation:
4916 % The last section of the index consists only of a single entry.
4917 % Before this section, \pagetotal is less than \pagegoal, so no
4918 % break occurs before the last section starts. However, the last
4919 % section, consisting of \initial and the single \entry, does not
4920 % fit on the page and has to be broken off. Without the following
4921 % penalty the page builder will not be exercised until \eject
4922 % below, and by that time we'll already have changed the output
4923 % routine to the \balancecolumns version, so the next-to-last
4924 % double-column page will be processed with \balancecolumns, which
4925 % is wrong: The two columns will go to the main vertical list, with
4926 % the broken-off section in the recent contributions. As soon as
4927 % the output routine finishes, TeX starts reconsidering the page
4928 % break. The two columns and the broken-off section both fit on the
4929 % page, because the two columns now take up only half of the page
4930 % goal. When TeX sees \eject from below which follows the final
4931 % section, it invokes the new output routine that we've set after
4932 % \balancecolumns below; \onepageout will try to fit the two columns
4933 % and the final section into the vbox of \pageheight (see
4934 % \pagebody), causing an overfull box.
4936 % Note that glue won't work here, because glue does not exercise the
4937 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4941 % Split the last of the double-column material. Leave it on the
4942 % current page, no automatic page break.
4945 % If we end up splitting too much material for the current page,
4946 % though, there will be another page break right after this \output
4947 % invocation ends. Having called \balancecolumns once, we do not
4948 % want to call it again. Therefore, reset \output to its normal
4949 % definition right away. (We hope \balancecolumns will never be
4950 % called on to balance too much material, but if it is, this makes
4951 % the output somewhat more palatable.)
4952 \global\output = {\onepageout{\pagecontents\PAGE}}%
4955 \endgroup % started in \begindoublecolumns
4957 % \pagegoal was set to the doubled \vsize above, since we restarted
4958 % the current page. We're now back to normal single-column
4959 % typesetting, so reset \pagegoal to the normal \vsize (after the
4960 % \endgroup where \vsize got restored).
4964 % Called at the end of the double column material.
4965 \def\balancecolumns{%
4966 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4968 \advance\dimen@ by \topskip
4969 \advance\dimen@ by-\baselineskip
4970 \divide\dimen@ by 2 % target to split to
4971 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4972 \splittopskip = \topskip
4973 % Loop until we get a decent breakpoint.
4977 \global\setbox3 = \copy0
4978 \global\setbox1 = \vsplit3 to \dimen@
4980 \global\advance\dimen@ by 1pt
4983 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4984 \setbox0=\vbox to\dimen@{\unvbox1}%
4985 \setbox2=\vbox to\dimen@{\unvbox3}%
4989 \catcode`\@ = \other
4992 \message{sectioning,}
4993 % Chapters, sections, etc.
4995 % Let's start with @part.
4996 \outer\parseargdef\part{\partzzz{#1}}
5000 \vskip.3\vsize % move it down on the page a bit
5002 \noindent \titlefonts\rmisbold #1\par % the text
5003 \let\lastnode=\empty % no node to associate with
5004 \writetocentry{part}{#1}{}% but put it in the toc
5005 \headingsoff % no headline or footline on the part page
5010 % \unnumberedno is an oxymoron. But we count the unnumbered
5011 % sections so that we can refer to them unambiguously in the pdf
5012 % outlines by their "section number". We avoid collisions with chapter
5013 % numbers by starting them at 10000. (If a document ever has 10000
5014 % chapters, we're in trouble anyway, I'm sure.)
5015 \newcount\unnumberedno \unnumberedno = 10000
5017 \newcount\secno \secno=0
5018 \newcount\subsecno \subsecno=0
5019 \newcount\subsubsecno \subsubsecno=0
5021 % This counter is funny since it counts through charcodes of letters A, B, ...
5022 \newcount\appendixno \appendixno = `\@
5024 % \def\appendixletter{\char\the\appendixno}
5025 % We do the following ugly conditional instead of the above simple
5026 % construct for the sake of pdftex, which needs the actual
5027 % letter in the expansion, not just typeset.
5029 \def\appendixletter{%
5030 \ifnum\appendixno=`A A%
5031 \else\ifnum\appendixno=`B B%
5032 \else\ifnum\appendixno=`C C%
5033 \else\ifnum\appendixno=`D D%
5034 \else\ifnum\appendixno=`E E%
5035 \else\ifnum\appendixno=`F F%
5036 \else\ifnum\appendixno=`G G%
5037 \else\ifnum\appendixno=`H H%
5038 \else\ifnum\appendixno=`I I%
5039 \else\ifnum\appendixno=`J J%
5040 \else\ifnum\appendixno=`K K%
5041 \else\ifnum\appendixno=`L L%
5042 \else\ifnum\appendixno=`M M%
5043 \else\ifnum\appendixno=`N N%
5044 \else\ifnum\appendixno=`O O%
5045 \else\ifnum\appendixno=`P P%
5046 \else\ifnum\appendixno=`Q Q%
5047 \else\ifnum\appendixno=`R R%
5048 \else\ifnum\appendixno=`S S%
5049 \else\ifnum\appendixno=`T T%
5050 \else\ifnum\appendixno=`U U%
5051 \else\ifnum\appendixno=`V V%
5052 \else\ifnum\appendixno=`W W%
5053 \else\ifnum\appendixno=`X X%
5054 \else\ifnum\appendixno=`Y Y%
5055 \else\ifnum\appendixno=`Z Z%
5056 % The \the is necessary, despite appearances, because \appendixletter is
5057 % expanded while writing the .toc file. \char\appendixno is not
5058 % expandable, thus it is written literally, thus all appendixes come out
5059 % with the same letter (or @) in the toc without it.
5060 \else\char\the\appendixno
5061 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5062 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5064 % Each @chapter defines these (using marks) as the number+name, number
5065 % and name of the chapter. Page headings and footings can use
5066 % these. @section does likewise.
5068 \def\thischapternum{}
5069 \def\thischaptername{}
5071 \def\thissectionnum{}
5072 \def\thissectionname{}
5074 \newcount\absseclevel % used to calculate proper heading level
5075 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5077 % @raisesections: treat @section as chapter, @subsection as section, etc.
5078 \def\raisesections{\global\advance\secbase by -1}
5079 \let\up=\raisesections % original BFox name
5081 % @lowersections: treat @chapter as section, @section as subsection, etc.
5082 \def\lowersections{\global\advance\secbase by 1}
5083 \let\down=\lowersections % original BFox name
5085 % we only have subsub.
5086 \chardef\maxseclevel = 3
5088 % A numbered section within an unnumbered changes to unnumbered too.
5089 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5090 \chardef\unnlevel = \maxseclevel
5092 % Trace whether the current chapter is an appendix or not:
5093 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5094 \def\chapheadtype{N}
5096 % Choose a heading macro
5097 % #1 is heading type
5098 % #2 is heading level
5099 % #3 is text for heading
5100 \def\genhead#1#2#3{%
5101 % Compute the abs. sec. level:
5103 \advance\absseclevel by \secbase
5104 % Make sure \absseclevel doesn't fall outside the range:
5105 \ifnum \absseclevel < 0
5108 \ifnum \absseclevel > 3
5115 \ifnum \absseclevel < \unnlevel
5116 \chardef\unnlevel = \absseclevel
5119 % Check for appendix sections:
5120 \ifnum \absseclevel = 0
5121 \edef\chapheadtype{\headtype}%
5123 \if \headtype A\if \chapheadtype N%
5124 \errmessage{@appendix... within a non-appendix chapter}%
5127 % Check for numbered within unnumbered:
5128 \ifnum \absseclevel > \unnlevel
5131 \chardef\unnlevel = 3
5134 % Now print the heading:
5138 \or \unnumberedseczzz{#3}%
5139 \or \unnumberedsubseczzz{#3}%
5140 \or \unnumberedsubsubseczzz{#3}%
5146 \or \appendixsectionzzz{#3}%
5147 \or \appendixsubseczzz{#3}%
5148 \or \appendixsubsubseczzz{#3}%
5154 \or \numberedsubseczzz{#3}%
5155 \or \numberedsubsubseczzz{#3}%
5159 \suppressfirstparagraphindent
5163 \def\numhead{\genhead N}
5164 \def\apphead{\genhead A}
5165 \def\unnmhead{\genhead U}
5167 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5168 % all lower-level sectioning counters to zero.
5170 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5171 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5172 \let\chaplevelprefix = \empty
5174 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5176 % section resetting is \global in case the chapter is in a group, such
5177 % as an @include file.
5178 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5179 \global\advance\chapno by 1
5182 \gdef\chaplevelprefix{\the\chapno.}%
5185 % \putwordChapter can contain complex things in translations.
5186 \toks0=\expandafter{\putwordChapter}%
5187 \message{\the\toks0 \space \the\chapno}%
5189 % Write the actual heading.
5190 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5192 % So @section and the like are numbered underneath this chapter.
5193 \global\let\section = \numberedsec
5194 \global\let\subsection = \numberedsubsec
5195 \global\let\subsubsection = \numberedsubsubsec
5198 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5200 \def\appendixzzz#1{%
5201 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5202 \global\advance\appendixno by 1
5203 \gdef\chaplevelprefix{\appendixletter.}%
5206 % \putwordAppendix can contain complex things in translations.
5207 \toks0=\expandafter{\putwordAppendix}%
5208 \message{\the\toks0 \space \appendixletter}%
5210 \chapmacro{#1}{Yappendix}{\appendixletter}%
5212 \global\let\section = \appendixsec
5213 \global\let\subsection = \appendixsubsec
5214 \global\let\subsubsection = \appendixsubsubsec
5217 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
5218 \def\unnumberedzzz#1{%
5219 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5220 \global\advance\unnumberedno by 1
5222 % Since an unnumbered has no number, no prefix for figures.
5223 \global\let\chaplevelprefix = \empty
5226 % This used to be simply \message{#1}, but TeX fully expands the
5227 % argument to \message. Therefore, if #1 contained @-commands, TeX
5228 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5229 % expanded @cite (which turns out to cause errors because \cite is meant
5230 % to be executed, not expanded).
5232 % Anyway, we don't want the fully-expanded definition of @cite to appear
5233 % as a result of the \message, we just want `@cite' itself. We use
5234 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5235 % simply yielding the contents of <toks register>. (We also do this for
5238 \message{(\the\toks0)}%
5240 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5242 \global\let\section = \unnumberedsec
5243 \global\let\subsection = \unnumberedsubsec
5244 \global\let\subsubsection = \unnumberedsubsubsec
5247 % @centerchap is like @unnumbered, but the heading is centered.
5248 \outer\parseargdef\centerchap{%
5249 % Well, we could do the following in a group, but that would break
5250 % an assumption that \chapmacro is called at the outermost level.
5251 % Thus we are safer this way: --kasal, 24feb04
5252 \let\centerparametersmaybe = \centerparameters
5254 \let\centerparametersmaybe = \relax
5257 % @top is like @unnumbered.
5261 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5263 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5264 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5267 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
5268 \def\appendixsectionzzz#1{%
5269 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5270 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5272 \let\appendixsec\appendixsection
5274 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
5275 \def\unnumberedseczzz#1{%
5276 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5277 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5281 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
5282 \def\numberedsubseczzz#1{%
5283 \global\subsubsecno=0 \global\advance\subsecno by 1
5284 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5287 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
5288 \def\appendixsubseczzz#1{%
5289 \global\subsubsecno=0 \global\advance\subsecno by 1
5290 \sectionheading{#1}{subsec}{Yappendix}%
5291 {\appendixletter.\the\secno.\the\subsecno}%
5294 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
5295 \def\unnumberedsubseczzz#1{%
5296 \global\subsubsecno=0 \global\advance\subsecno by 1
5297 \sectionheading{#1}{subsec}{Ynothing}%
5298 {\the\unnumberedno.\the\secno.\the\subsecno}%
5302 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
5303 \def\numberedsubsubseczzz#1{%
5304 \global\advance\subsubsecno by 1
5305 \sectionheading{#1}{subsubsec}{Ynumbered}%
5306 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5309 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
5310 \def\appendixsubsubseczzz#1{%
5311 \global\advance\subsubsecno by 1
5312 \sectionheading{#1}{subsubsec}{Yappendix}%
5313 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5316 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
5317 \def\unnumberedsubsubseczzz#1{%
5318 \global\advance\subsubsecno by 1
5319 \sectionheading{#1}{subsubsec}{Ynothing}%
5320 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5323 % These macros control what the section commands do, according
5324 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5325 % Define them by default for a numbered chapter.
5326 \let\section = \numberedsec
5327 \let\subsection = \numberedsubsec
5328 \let\subsubsection = \numberedsubsubsec
5330 % Define @majorheading, @heading and @subheading
5332 % NOTE on use of \vbox for chapter headings, section headings, and such:
5333 % 1) We use \vbox rather than the earlier \line to permit
5334 % overlong headings to fold.
5335 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5336 % heading is obnoxious; this forbids it.
5337 % 3) Likewise, headings look best if no \parindent is used, and
5338 % if justification is not attempted. Hence \raggedright.
5341 {\advance\chapheadingskip by 10pt \chapbreak }%
5342 \parsearg\chapheadingzzz
5345 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5346 \def\chapheadingzzz#1{%
5347 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5348 \parindent=0pt\ptexraggedright
5349 \rmisbold #1\hfill}}%
5350 \bigskip \par\penalty 200\relax
5351 \suppressfirstparagraphindent
5354 % @heading, @subheading, @subsubheading.
5355 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5356 \suppressfirstparagraphindent}
5357 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5358 \suppressfirstparagraphindent}
5359 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5360 \suppressfirstparagraphindent}
5362 % These macros generate a chapter, section, etc. heading only
5363 % (including whitespace, linebreaking, etc. around it),
5364 % given all the information in convenient, parsed form.
5366 %%% Args are the skip and penalty (usually negative)
5367 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5369 %%% Define plain chapter starts, and page on/off switching for it
5370 % Parameter controlling skip before chapter headings (if needed)
5372 \newskip\chapheadingskip
5374 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5375 \def\chappager{\par\vfill\supereject}
5376 % Because \domark is called before \chapoddpage, the filler page will
5377 % get the headings for the next chapter, which is wrong. But we don't
5378 % care -- we just disable all headings on the filler page.
5390 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5393 \global\let\contentsalignmacro = \chappager
5394 \global\let\pchapsepmacro=\chapbreak
5395 \global\let\pagealignmacro=\chappager}
5398 \global\let\contentsalignmacro = \chappager
5399 \global\let\pchapsepmacro=\chappager
5400 \global\let\pagealignmacro=\chappager
5401 \global\def\HEADINGSon{\HEADINGSsingle}}
5404 \global\let\contentsalignmacro = \chapoddpage
5405 \global\let\pchapsepmacro=\chapoddpage
5406 \global\let\pagealignmacro=\chapoddpage
5407 \global\def\HEADINGSon{\HEADINGSdouble}}
5413 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5414 % Yappendix, Yomitfromtoc), #3 the chapter number.
5416 % To test against our argument.
5417 \def\Ynothingkeyword{Ynothing}
5418 \def\Yomitfromtockeyword{Yomitfromtoc}
5419 \def\Yappendixkeyword{Yappendix}
5421 \def\chapmacro#1#2#3{%
5422 % Insert the first mark before the heading break (see notes for \domark).
5423 \let\prevchapterdefs=\lastchapterdefs
5424 \let\prevsectiondefs=\lastsectiondefs
5425 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5426 \gdef\thissection{}}%
5429 \ifx\temptype\Ynothingkeyword
5430 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5431 \gdef\thischapter{\thischaptername}}%
5432 \else\ifx\temptype\Yomitfromtockeyword
5433 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5434 \gdef\thischapter{}}%
5435 \else\ifx\temptype\Yappendixkeyword
5437 \xdef\lastchapterdefs{%
5438 \gdef\noexpand\thischaptername{\the\toks0}%
5439 \gdef\noexpand\thischapternum{\appendixletter}%
5440 % \noexpand\putwordAppendix avoids expanding indigestible
5441 % commands in some of the translations.
5442 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5443 \noexpand\thischapternum:
5444 \noexpand\thischaptername}%
5448 \xdef\lastchapterdefs{%
5449 \gdef\noexpand\thischaptername{\the\toks0}%
5450 \gdef\noexpand\thischapternum{\the\chapno}%
5451 % \noexpand\putwordChapter avoids expanding indigestible
5452 % commands in some of the translations.
5453 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5454 \noexpand\thischapternum:
5455 \noexpand\thischaptername}%
5459 % Output the mark. Pass it through \safewhatsit, to take care of
5460 % the preceding space.
5463 % Insert the chapter heading break.
5466 % Now the second mark, after the heading break. No break points
5467 % between here and the heading.
5468 \let\prevchapterdefs=\lastchapterdefs
5469 \let\prevsectiondefs=\lastsectiondefs
5473 \chapfonts \rmisbold
5475 % Have to define \lastsection before calling \donoderef, because the
5476 % xref code eventually uses it. On the other hand, it has to be called
5477 % after \pchapsepmacro, or the headline will change too soon.
5478 \gdef\lastsection{#1}%
5480 % Only insert the separating space if we have a chapter/appendix
5481 % number, and don't print the unnumbered ``number''.
5482 \ifx\temptype\Ynothingkeyword
5484 \def\toctype{unnchap}%
5485 \else\ifx\temptype\Yomitfromtockeyword
5486 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5488 \else\ifx\temptype\Yappendixkeyword
5489 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5492 \setbox0 = \hbox{#3\enspace}%
5493 \def\toctype{numchap}%
5496 % Write the toc entry for this chapter. Must come before the
5497 % \donoderef, because we include the current node name in the toc
5498 % entry, and \donoderef resets it to empty.
5499 \writetocentry{\toctype}{#1}{#3}%
5501 % For pdftex, we have to write out the node definition (aka, make
5502 % the pdfdest) after any page break, but before the actual text has
5503 % been typeset. If the destination for the pdf outline is after the
5504 % text, then jumping from the outline may wind up with the text not
5505 % being visible, for instance under high magnification.
5508 % Typeset the actual heading.
5509 \nobreak % Avoid page breaks at the interline glue.
5510 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5511 \hangindent=\wd0 \centerparametersmaybe
5514 \nobreak\bigskip % no page break after a chapter title
5518 % @centerchap -- centered and unnumbered.
5519 \let\centerparametersmaybe = \relax
5520 \def\centerparameters{%
5521 \advance\rightskip by 3\rightskip
5522 \leftskip = \rightskip
5527 % I don't think this chapter style is supported any more, so I'm not
5528 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5530 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5532 \def\unnchfopen #1{%
5533 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5534 \parindent=0pt\ptexraggedright
5535 \rmisbold #1\hfill}}\bigskip \par\nobreak
5537 \def\chfopen #1#2{\chapoddpage {\chapfonts
5538 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5541 \def\centerchfopen #1{%
5542 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5544 \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
5547 \global\let\chapmacro=\chfopen
5548 \global\let\centerchapmacro=\centerchfopen}
5551 % Section titles. These macros combine the section number parts and
5552 % call the generic \sectionheading to do the printing.
5554 \newskip\secheadingskip
5555 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5557 % Subsection titles.
5558 \newskip\subsecheadingskip
5559 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5561 % Subsubsection titles.
5562 \def\subsubsecheadingskip{\subsecheadingskip}
5563 \def\subsubsecheadingbreak{\subsecheadingbreak}
5566 % Print any size, any type, section title.
5568 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5569 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5572 \def\seckeyword{sec}
5574 \def\sectionheading#1#2#3#4{%
5576 % Switch to the right set of fonts.
5577 \csname #2fonts\endcsname \rmisbold
5579 \def\sectionlevel{#2}%
5582 % Insert first mark before the heading break (see notes for \domark).
5583 \let\prevsectiondefs=\lastsectiondefs
5584 \ifx\temptype\Ynothingkeyword
5585 \ifx\sectionlevel\seckeyword
5586 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5587 \gdef\thissection{\thissectionname}}%
5589 \else\ifx\temptype\Yomitfromtockeyword
5590 % Don't redefine \thissection.
5591 \else\ifx\temptype\Yappendixkeyword
5592 \ifx\sectionlevel\seckeyword
5594 \xdef\lastsectiondefs{%
5595 \gdef\noexpand\thissectionname{\the\toks0}%
5596 \gdef\noexpand\thissectionnum{#4}%
5597 % \noexpand\putwordSection avoids expanding indigestible
5598 % commands in some of the translations.
5599 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5600 \noexpand\thissectionnum:
5601 \noexpand\thissectionname}%
5605 \ifx\sectionlevel\seckeyword
5607 \xdef\lastsectiondefs{%
5608 \gdef\noexpand\thissectionname{\the\toks0}%
5609 \gdef\noexpand\thissectionnum{#4}%
5610 % \noexpand\putwordSection avoids expanding indigestible
5611 % commands in some of the translations.
5612 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5613 \noexpand\thissectionnum:
5614 \noexpand\thissectionname}%
5619 % Go into vertical mode. Usually we'll already be there, but we
5620 % don't want the following whatsit to end up in a preceding paragraph
5621 % if the document didn't happen to have a blank line.
5624 % Output the mark. Pass it through \safewhatsit, to take care of
5625 % the preceding space.
5628 % Insert space above the heading.
5629 \csname #2headingbreak\endcsname
5631 % Now the second mark, after the heading break. No break points
5632 % between here and the heading.
5633 \let\prevsectiondefs=\lastsectiondefs
5636 % Only insert the space after the number if we have a section number.
5637 \ifx\temptype\Ynothingkeyword
5640 \gdef\lastsection{#1}%
5641 \else\ifx\temptype\Yomitfromtockeyword
5642 % for @headings -- no section number, don't include in toc,
5643 % and don't redefine \lastsection.
5646 \let\sectionlevel=\empty
5647 \else\ifx\temptype\Yappendixkeyword
5648 \setbox0 = \hbox{#4\enspace}%
5650 \gdef\lastsection{#1}%
5652 \setbox0 = \hbox{#4\enspace}%
5654 \gdef\lastsection{#1}%
5657 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5658 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5660 % Write the node reference (= pdf destination for pdftex).
5661 % Again, see comments in \chapmacro.
5664 % Interline glue will be inserted when the vbox is completed.
5665 % That glue will be a valid breakpoint for the page, since it'll be
5666 % preceded by a whatsit (usually from the \donoderef, or from the
5667 % \writetocentry if there was no node). We don't want to allow that
5668 % break, since then the whatsits could end up on page n while the
5669 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5672 % Output the actual section heading.
5673 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5674 \hangindent=\wd0 % zero if no section number
5677 % Add extra space after the heading -- half of whatever came above it.
5678 % Don't allow stretch, though.
5679 \kern .5 \csname #2headingskip\endcsname
5681 % Do not let the kern be a potential breakpoint, as it would be if it
5682 % was followed by glue.
5685 % We'll almost certainly start a paragraph next, so don't let that
5686 % glue accumulate. (Not a breakpoint because it's preceded by a
5687 % discardable item.)
5690 % This is purely so the last item on the list is a known \penalty >
5691 % 10000. This is so \startdefun can avoid allowing breakpoints after
5692 % section headings. Otherwise, it would insert a valid breakpoint between:
5694 % @section sec-whatever
5695 % @deffn def-whatever
5701 % Table of contents.
5704 % Write an entry to the toc file, opening it if necessary.
5705 % Called from @chapter, etc.
5707 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5708 % We append the current node name (if any) and page number as additional
5709 % arguments for the \{chap,sec,...}entry macros which will eventually
5710 % read this. The node name is used in the pdf outlines as the
5711 % destination to jump to.
5713 % We open the .toc file for writing here instead of at @setfilename (or
5714 % any other fixed time) so that @contents can be anywhere in the document.
5715 % But if #1 is `omit', then we don't do anything. This is used for the
5716 % table of contents chapter openings themselves.
5718 \newif\iftocfileopened
5719 \def\omitkeyword{omit}%
5721 \def\writetocentry#1#2#3{%
5722 \edef\writetoctype{#1}%
5723 \ifx\writetoctype\omitkeyword \else
5724 \iftocfileopened\else
5725 \immediate\openout\tocfile = \jobname.toc
5726 \global\tocfileopenedtrue
5732 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5738 % Tell \shipout to create a pdf destination on each page, if we're
5739 % writing pdf. These are used in the table of contents. We can't
5740 % just write one on every page because the title pages are numbered
5741 % 1 and 2 (the page numbers aren't printed), and so are the first
5742 % two pages of the document. Thus, we'd have two destinations named
5743 % `1', and two named `2'.
5744 \ifpdf \global\pdfmakepagedesttrue \fi
5748 % These characters do not print properly in the Computer Modern roman
5749 % fonts, so we must take special care. This is more or less redundant
5750 % with the Texinfo input format setup at the end of this file.
5752 \def\activecatcodes{%
5765 % Read the toc file, which is essentially Texinfo input.
5769 \input \tocreadfilename
5772 \newskip\contentsrightmargin \contentsrightmargin=1in
5773 \newcount\savepageno
5774 \newcount\lastnegativepageno \lastnegativepageno = -1
5776 % Prepare to read what we've written to \tocfile.
5778 \def\startcontents#1{%
5779 % If @setchapternewpage on, and @headings double, the contents should
5780 % start on an odd page, unlike chapters. Thus, we maintain
5781 % \contentsalignmacro in parallel with \pagealignmacro.
5782 % From: Torbjorn Granlund <tege@matematik.su.se>
5784 \immediate\closeout\tocfile
5786 % Don't need to put `Contents' or `Short Contents' in the headline.
5787 % It is abundantly clear what they are.
5788 \chapmacro{#1}{Yomitfromtoc}{}%
5790 \savepageno = \pageno
5791 \begingroup % Set up to handle contents files properly.
5792 \raggedbottom % Worry more about breakpoints than the bottom.
5793 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5795 % Roman numerals for page numbers.
5796 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5799 % redefined for the two-volume lispref. We always output on
5800 % \jobname.toc even if this is redefined.
5802 \def\tocreadfilename{\jobname.toc}
5804 % Normal (long) toc.
5807 \startcontents{\putwordTOC}%
5808 \openin 1 \tocreadfilename\space
5813 \contentsalignmacro % in case @setchapternewpage odd is in effect
5819 \lastnegativepageno = \pageno
5820 \global\pageno = \savepageno
5823 % And just the chapters.
5824 \def\summarycontents{%
5825 \startcontents{\putwordShortTOC}%
5827 \let\partentry = \shortpartentry
5828 \let\numchapentry = \shortchapentry
5829 \let\appentry = \shortchapentry
5830 \let\unnchapentry = \shortunnchapentry
5831 % We want a true roman here for the page numbers.
5833 \let\rm=\shortcontrm \let\bf=\shortcontbf
5834 \let\sl=\shortcontsl \let\tt=\shortconttt
5836 \hyphenpenalty = 10000
5837 \advance\baselineskip by 1pt % Open it up a little.
5838 \def\numsecentry##1##2##3##4{}
5839 \let\appsecentry = \numsecentry
5840 \let\unnsecentry = \numsecentry
5841 \let\numsubsecentry = \numsecentry
5842 \let\appsubsecentry = \numsecentry
5843 \let\unnsubsecentry = \numsecentry
5844 \let\numsubsubsecentry = \numsecentry
5845 \let\appsubsubsecentry = \numsecentry
5846 \let\unnsubsubsecentry = \numsecentry
5847 \openin 1 \tocreadfilename\space
5853 \contentsalignmacro % in case @setchapternewpage odd is in effect
5855 \lastnegativepageno = \pageno
5856 \global\pageno = \savepageno
5858 \let\shortcontents = \summarycontents
5860 % Typeset the label for a chapter or appendix for the short contents.
5861 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
5863 \def\shortchaplabel#1{%
5864 % This space should be enough, since a single number is .5em, and the
5865 % widest letter (M) is 1em, at least in the Computer Modern fonts.
5866 % But use \hss just in case.
5867 % (This space doesn't include the extra space that gets added after
5868 % the label; that gets put in by \shortchapentry above.)
5870 % We'd like to right-justify chapter numbers, but that looks strange
5871 % with appendix letters. And right-justifying numbers and
5872 % left-justifying letters looks strange when there is less than 10
5873 % chapters. Have to read the whole toc once to know how many chapters
5874 % there are before deciding ...
5875 \hbox to 1em{#1\hss}%
5878 % These macros generate individual entries in the table of contents.
5879 % The first argument is the chapter or section name.
5880 % The last argument is the page number.
5881 % The arguments in between are the chapter number, section number, ...
5883 % Parts, in the main contents. Replace the part number, which doesn't
5884 % exist, with an empty box. Let's hope all the numbers have the same width.
5885 % Also ignore the page number, which is conventionally not printed.
5886 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
5887 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
5889 % Parts, in the short toc.
5890 \def\shortpartentry#1#2#3#4{%
5892 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
5893 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
5896 % Chapters, in the main contents.
5897 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5899 % Chapters, in the short toc.
5900 % See comments in \dochapentry re vbox and related settings.
5901 \def\shortchapentry#1#2#3#4{%
5902 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5905 % Appendices, in the main contents.
5906 % Need the word Appendix, and a fixed-size box.
5908 \def\appendixbox#1{%
5909 % We use M since it's probably the widest letter.
5910 \setbox0 = \hbox{\putwordAppendix{} M}%
5911 \hbox to \wd0{\putwordAppendix{} #1\hss}}
5913 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5915 % Unnumbered chapters.
5916 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5917 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5920 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5921 \let\appsecentry=\numsecentry
5922 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5925 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5926 \let\appsubsecentry=\numsubsecentry
5927 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5929 % And subsubsections.
5930 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5931 \let\appsubsubsecentry=\numsubsubsecentry
5932 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5934 % This parameter controls the indentation of the various levels.
5935 % Same as \defaultparindent.
5936 \newdimen\tocindent \tocindent = 15pt
5938 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5941 % If the toc has to be broken over pages, we want it to be at chapters
5942 % if at all possible; hence the \penalty.
5943 \def\dochapentry#1#2{%
5944 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5947 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5949 \nobreak\vskip .25\baselineskip plus.1\baselineskip
5952 \def\dosecentry#1#2{\begingroup
5953 \secentryfonts \leftskip=\tocindent
5954 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5957 \def\dosubsecentry#1#2{\begingroup
5958 \subsecentryfonts \leftskip=2\tocindent
5959 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5962 \def\dosubsubsecentry#1#2{\begingroup
5963 \subsubsecentryfonts \leftskip=3\tocindent
5964 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5967 % We use the same \entry macro as for the index entries.
5968 \let\tocentry = \entry
5970 % Space between chapter (or whatever) number and the title.
5971 \def\labelspace{\hskip1em \relax}
5973 \def\dopageno#1{{\rm #1}}
5974 \def\doshortpageno#1{{\rm #1}}
5976 \def\chapentryfonts{\secfonts \rm}
5977 \def\secentryfonts{\textfonts}
5978 \def\subsecentryfonts{\textfonts}
5979 \def\subsubsecentryfonts{\textfonts}
5982 \message{environments,}
5983 % @foo ... @end foo.
5985 % @tex ... @end tex escapes into raw TeX temporarily.
5986 % One exception: @ is still an escape character, so that @end tex works.
5987 % But \@ or @@ will get a plain @ character.
5990 \setupmarkupstyle{tex}%
5991 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5992 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5993 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6004 % ' is active in math mode (mathcode"8000). So reset it, and all our
6005 % other math active characters (just in case), to plain's definitions.
6009 \let\bullet=\ptexbullet
6014 \let\equiv=\ptexequiv
6017 \let\indent=\ptexindent
6018 \let\noindent=\ptexnoindent
6025 \expandafter \let\csname top\endcsname=\ptextop % outer
6026 \let\frenchspacing=\plainfrenchspacing
6028 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6029 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6032 % There is no need to define \Etex.
6034 % Define @lisp ... @end lisp.
6035 % @lisp environment forms a group so it can rebind things,
6036 % including the definition of @end lisp (which normally is erroneous).
6038 % Amount to narrow the margins by for @lisp.
6039 \newskip\lispnarrowing \lispnarrowing=0.4in
6041 % This is the definition that ^^M gets inside @lisp, @example, and other
6042 % such environments. \null is better than a space, since it doesn't
6044 \def\lisppar{\null\endgraf}
6046 % This space is always present above and below environments.
6047 \newskip\envskipamount \envskipamount = 0pt
6049 % Make spacing and below environment symmetrical. We use \parskip here
6050 % to help in doing that, since in @example-like environments \parskip
6051 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6052 % start of the next paragraph will insert \parskip.
6054 \def\aboveenvbreak{{%
6055 % =10000 instead of <10000 because of a special case in \itemzzz and
6056 % \sectionheading, q.v.
6057 \ifnum \lastpenalty=10000 \else
6058 \advance\envskipamount by \parskip
6060 \ifdim\lastskip<\envskipamount
6062 % it's not a good place to break if the last penalty was \nobreak
6064 \ifnum\lastpenalty<10000 \penalty-50 \fi
6065 \vskip\envskipamount
6070 \let\afterenvbreak = \aboveenvbreak
6072 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6073 % also clear it, so that its embedded environments do the narrowing again.
6074 \let\nonarrowing=\relax
6076 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6077 % environment contents.
6078 \font\circle=lcircle10
6080 \newdimen\cartouter\newdimen\cartinner
6081 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6082 \circthick=\fontdimen8\circle
6084 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6085 \def\ctr{{\hskip 6pt\circle\char'010}}
6086 \def\cbl{{\circle\char'012\hskip -6pt}}
6087 \def\cbr{{\hskip 6pt\circle\char'011}}
6088 \def\carttop{\hbox to \cartouter{\hskip\lskip
6089 \ctl\leaders\hrule height\circthick\hfil\ctr
6091 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6092 \cbl\leaders\hrule height\circthick\hfil\cbr
6095 \newskip\lskip\newskip\rskip
6098 \ifhmode\par\fi % can't be in the midst of a paragraph.
6100 \lskip=\leftskip \rskip=\rightskip
6101 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6102 \cartinner=\hsize \advance\cartinner by-\lskip
6103 \advance\cartinner by-\rskip
6105 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6106 % side, and for 6pt waste from
6107 % each corner char, and rule thickness
6108 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6109 % Flag to tell @lisp, etc., not to narrow margin.
6110 \let\nonarrowing = t%
6112 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6120 \baselineskip=\normbskip
6121 \lineskip=\normlskip
6124 \comment % For explanation, see the end of \def\group.
6139 % This macro is called at the beginning of all the @example variants,
6141 \newdimen\nonfillparindent
6144 \hfuzz = 12pt % Don't be fussy
6145 \sepspaces % Make spaces be word-separators rather than space tokens.
6146 \let\par = \lisppar % don't ignore blank lines
6147 \obeylines % each line of input is a line of output
6149 % Turn off paragraph indentation but redefine \indent to emulate
6150 % the normal \indent.
6151 \nonfillparindent=\parindent
6153 \let\indent\nonfillindent
6155 \emergencystretch = 0pt % don't try to avoid overfull boxes
6156 \ifx\nonarrowing\relax
6157 \advance \leftskip by \lispnarrowing
6158 \exdentamount=\lispnarrowing
6160 \let\nonarrowing = \relax
6162 \let\exdent=\nofillexdent
6167 % We want to swallow spaces (but not other tokens) after the fake
6168 % @indent in our nonfill-environments, where spaces are normally
6169 % active and set to @tie, resulting in them not being ignored after
6171 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6172 \gdef\nonfillindentcheck{%
6174 \expandafter\nonfillindentgobble%
6176 \leavevmode\nonfillindentbox%
6180 \def\nonfillindentgobble#1{\nonfillindent}
6181 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6183 % If you want all examples etc. small: @set dispenvsize small.
6184 % If you want even small examples the full size: @set dispenvsize nosmall.
6185 % This affects the following displayed environments:
6186 % @example, @display, @format, @lisp
6188 \def\smallword{small}
6189 \def\nosmallword{nosmall}
6190 \let\SETdispenvsize\relax
6191 \def\setnormaldispenv{%
6192 \ifx\SETdispenvsize\smallword
6193 % end paragraph for sake of leading, in case document has no blank
6194 % line. This is redundant with what happens in \aboveenvbreak, but
6195 % we need to do it before changing the fonts, and it's inconvenient
6196 % to change the fonts afterward.
6197 \ifnum \lastpenalty=10000 \else \endgraf \fi
6198 \smallexamplefonts \rm
6201 \def\setsmalldispenv{%
6202 \ifx\SETdispenvsize\nosmallword
6204 \ifnum \lastpenalty=10000 \else \endgraf \fi
6205 \smallexamplefonts \rm
6209 % We often define two environments, @foo and @smallfoo.
6210 % Let's do it in one command. #1 is the env name, #2 the definition.
6211 \def\makedispenvdef#1#2{%
6212 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6213 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6214 \expandafter\let\csname E#1\endcsname \afterenvbreak
6215 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6218 % Define two environment synonyms (#1 and #2) for an environment.
6219 \def\maketwodispenvdef#1#2#3{%
6220 \makedispenvdef{#1}{#3}%
6221 \makedispenvdef{#2}{#3}%
6224 % @lisp: indented, narrowed, typewriter font;
6225 % @example: same as @lisp.
6227 % @smallexample and @smalllisp: use smaller fonts.
6228 % Originally contributed by Pavel@xerox.
6230 \maketwodispenvdef{lisp}{example}{%
6232 \tt\setupmarkupstyle{example}%
6233 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6234 \gobble % eat return
6236 % @display/@smalldisplay: same as @lisp except keep current font.
6238 \makedispenvdef{display}{%
6243 % @format/@smallformat: same as @display except don't narrow margins.
6245 \makedispenvdef{format}{%
6246 \let\nonarrowing = t%
6251 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6253 \let\nonarrowing = t%
6257 \let\Eflushleft = \afterenvbreak
6261 \envdef\flushright{%
6262 \let\nonarrowing = t%
6264 \advance\leftskip by 0pt plus 1fill\relax
6267 \let\Eflushright = \afterenvbreak
6270 % @raggedright does more-or-less normal line breaking but no right
6271 % justification. From plain.tex.
6272 \envdef\raggedright{%
6273 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6275 \let\Eraggedright\par
6277 \envdef\raggedleft{%
6278 \parindent=0pt \leftskip0pt plus2em
6279 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6280 \hbadness=10000 % Last line will usually be underfull, so turn off
6281 % badness reporting.
6283 \let\Eraggedleft\par
6285 \envdef\raggedcenter{%
6286 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6287 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6288 \hbadness=10000 % Last line will usually be underfull, so turn off
6289 % badness reporting.
6291 \let\Eraggedcenter\par
6294 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6295 % and narrows the margins. We keep \parskip nonzero in general, since
6296 % we're doing normal filling. So, when using \aboveenvbreak and
6297 % \afterenvbreak, temporarily make \parskip 0.
6299 \makedispenvdef{quotation}{\quotationstart}
6301 \def\quotationstart{%
6302 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6305 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6306 \ifx\nonarrowing\relax
6307 \advance\leftskip by \lispnarrowing
6308 \advance\rightskip by \lispnarrowing
6309 \exdentamount = \lispnarrowing
6311 \let\nonarrowing = \relax
6313 \parsearg\quotationlabel
6316 % We have retained a nonzero parskip for the environment, since we're
6317 % doing normal filling.
6321 \ifx\quotationauthor\undefined\else
6323 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6325 {\parskip=0pt \afterenvbreak}%
6327 \def\Esmallquotation{\Equotation}
6329 % If we're given an argument, typeset it in bold with a colon after.
6330 \def\quotationlabel#1{%
6332 \ifx\temp\empty \else
6338 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6339 % If we want to allow any <char> as delimiter,
6340 % we need the curly braces so that makeinfo sees the @verb command, eg:
6341 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6343 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6345 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6346 % active too. Otherwise, they get lost as the first character on a
6349 \do\ \do\\\do\{\do\}\do\$\do\&%
6350 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6351 \do\<\do\>\do\|\do\@\do+\do\"%
6352 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6353 % @set txicodequotebacktick will not have effect on @verb and
6354 % @verbatim, and ?` and !` ligatures won't get disabled.
6359 \def\uncatcodespecials{%
6360 \def\do##1{\catcode`##1=\other}\dospecials}
6362 % Setup for the @verb command.
6364 % Eight spaces for a tab
6366 \catcode`\^^I=\active
6367 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6371 \tt % easiest (and conventionally used) font for verbatim
6372 \def\par{\leavevmode\endgraf}%
6373 \setupmarkupstyle{verb}%
6375 % Respect line breaks,
6376 % print special symbols as themselves, and
6377 % make each space count
6378 % must do in this order:
6379 \obeylines \uncatcodespecials \sepspaces
6382 % Setup for the @verbatim environment
6384 % Real tab expansion
6385 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6387 \def\starttabbox{\setbox0=\hbox\bgroup}
6390 \catcode`\^^I=\active
6392 \catcode`\^^I=\active
6393 \def^^I{\leavevmode\egroup
6394 \dimen0=\wd0 % the width so far, or since the previous tab
6395 \divide\dimen0 by\tabw
6396 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
6397 \advance\dimen0 by\tabw % advance to next multiple of \tabw
6398 \wd0=\dimen0 \box0 \starttabbox
6403 % start the verbatim environment.
6404 \def\setupverbatim{%
6405 \let\nonarrowing = t%
6407 % Easiest (and conventionally used) font for verbatim
6409 \def\par{\leavevmode\egroup\box0\endgraf}%
6411 \setupmarkupstyle{verbatim}%
6412 % Respect line breaks,
6413 % print special symbols as themselves, and
6414 % make each space count
6415 % must do in this order:
6416 \obeylines \uncatcodespecials \sepspaces
6417 \everypar{\starttabbox}%
6420 % Do the @verb magic: verbatim text is quoted by unique
6421 % delimiter characters. Before first delimiter expect a
6422 % right brace, after last delimiter expect closing brace:
6424 % \def\doverb'{'<char>#1<char>'}'{#1}
6426 % [Knuth] p. 382; only eat outer {}
6428 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6429 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6432 \def\verb{\begingroup\setupverb\doverb}
6435 % Do the @verbatim magic: define the macro \doverbatim so that
6436 % the (first) argument ends when '@end verbatim' is reached, ie:
6438 % \def\doverbatim#1@end verbatim{#1}
6440 % For Texinfo it's a lot easier than for LaTeX,
6441 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6442 % we need not redefine '\', '{' and '}'.
6444 % Inspired by LaTeX's verbatim command set [latex.ltx]
6449 % ignore everything up to the first ^^M, that's the newline at the end
6450 % of the @verbatim input line itself. Otherwise we get an extra blank
6451 % line in the output.
6452 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6453 % We really want {...\end verbatim} in the body of the macro, but
6454 % without the active space; thus we have to use \xdef and \gobble.
6458 \setupverbatim\doverbatim
6460 \let\Everbatim = \afterenvbreak
6463 % @verbatiminclude FILE - insert text of file in verbatim environment.
6465 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6467 \def\doverbatiminclude#1{%
6469 \makevalueexpandable
6471 \indexnofonts % Allow `@@' and other weird things in file names.
6477 % @copying ... @end copying.
6478 % Save the text away for @insertcopying later.
6480 % We save the uninterpreted tokens, rather than creating a box.
6481 % Saving the text in a box would be much easier, but then all the
6482 % typesetting commands (@smallbook, font changes, etc.) have to be done
6483 % beforehand -- and a) we want @copying to be done first in the source
6484 % file; b) letting users define the frontmatter in as flexible order as
6485 % possible is very desirable.
6487 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6488 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6490 \def\insertcopying{%
6492 \parindent = 0pt % paragraph indentation looks wrong on title page
6493 \scanexp\copyingtext
6501 \newskip\defbodyindent \defbodyindent=.4in
6502 \newskip\defargsindent \defargsindent=50pt
6503 \newskip\deflastargmargin \deflastargmargin=18pt
6504 \newcount\defunpenalty
6506 % Start the processing of @deffn:
6508 \ifnum\lastpenalty<10000
6510 \defunpenalty=10003 % Will keep this @deffn together with the
6511 % following @def command, see below.
6513 % If there are two @def commands in a row, we'll have a \nobreak,
6514 % which is there to keep the function description together with its
6515 % header. But if there's nothing but headers, we need to allow a
6516 % break somewhere. Check specifically for penalty 10002, inserted
6517 % by \printdefunline, instead of 10000, since the sectioning
6518 % commands also insert a nobreak penalty, and we don't want to allow
6519 % a break between a section heading and a defun.
6521 % As a minor refinement, we avoid "club" headers by signalling
6522 % with penalty of 10003 after the very first @deffn in the
6523 % sequence (see above), and penalty of 10002 after any following
6525 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6527 % Similarly, after a section heading, do not allow a break.
6528 % But do insert the glue.
6529 \medskip % preceded by discardable penalty, so not a breakpoint
6533 \advance\leftskip by \defbodyindent
6534 \exdentamount=\defbodyindent
6538 % First, check whether we are in the right environment:
6541 % As above, allow line break if we have multiple x headers in a row.
6542 % It's not a great place, though.
6543 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6545 % And now, it's time to reuse the body of the original defun:
6546 \expandafter\gobbledefun#1%
6548 \def\gobbledefun#1\startdefun{}
6550 % \printdefunline \deffnheader{text}
6552 \def\printdefunline#1#2{%
6554 % call \deffnheader:
6557 \interlinepenalty = 10000
6558 \advance\rightskip by 0pt plus 1fil\relax
6560 \nobreak\vskip -\parskip
6561 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6562 % Some of the @defun-type tags do not enable magic parentheses,
6563 % rendering the following check redundant. But we don't optimize.
6568 \def\Edefun{\endgraf\medbreak}
6570 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6571 % the only thing remaining is to define \deffnheader.
6574 \expandafter\let\csname E#1\endcsname = \Edefun
6575 \edef\temp{\noexpand\domakedefun
6576 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6580 % \domakedefun \deffn \deffnx \deffnheader
6582 % Define \deffn and \deffnx, without parameters.
6583 % \deffnheader has to be defined explicitly.
6585 \def\domakedefun#1#2#3{%
6588 \parseargusing\activeparens{\printdefunline#3}%
6590 \def#2{\dodefunx#1}%
6594 %%% Untyped functions:
6596 % @deffn category name args
6597 \makedefun{deffn}{\deffngeneral{}}
6599 % @deffn category class name args
6600 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6602 % \defopon {category on}class name args
6603 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6605 % \deffngeneral {subind}category name args
6607 \def\deffngeneral#1#2 #3 #4\endheader{%
6608 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6609 \dosubind{fn}{\code{#3}}{#1}%
6610 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6613 %%% Typed functions:
6615 % @deftypefn category type name args
6616 \makedefun{deftypefn}{\deftypefngeneral{}}
6618 % @deftypeop category class type name args
6619 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6621 % \deftypeopon {category on}class type name args
6622 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6624 % \deftypefngeneral {subind}category type name args
6626 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6627 \dosubind{fn}{\code{#4}}{#1}%
6628 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6631 %%% Typed variables:
6633 % @deftypevr category type var args
6634 \makedefun{deftypevr}{\deftypecvgeneral{}}
6636 % @deftypecv category class type var args
6637 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6639 % \deftypecvof {category of}class type var args
6640 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6642 % \deftypecvgeneral {subind}category type var args
6644 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6645 \dosubind{vr}{\code{#4}}{#1}%
6646 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6649 %%% Untyped variables:
6651 % @defvr category var args
6652 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6654 % @defcv category class var args
6655 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6657 % \defcvof {category of}class var args
6658 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6661 % @deftp category name args
6662 \makedefun{deftp}#1 #2 #3\endheader{%
6663 \doind{tp}{\code{#2}}%
6664 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6667 % Remaining @defun-like shortcuts:
6668 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6669 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6670 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6671 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6672 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6673 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6674 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6675 \makedefun{defmethod}{\defopon\putwordMethodon}
6676 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6677 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6678 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6680 % \defname, which formats the name of the @def (not the args).
6681 % #1 is the category, such as "Function".
6682 % #2 is the return type, if any.
6683 % #3 is the function name.
6685 % We are followed by (but not passed) the arguments, if any.
6687 \def\defname#1#2#3{%
6688 % Get the values of \leftskip and \rightskip as they were outside the @def...
6689 \advance\leftskip by -\defbodyindent
6691 % How we'll format the type name. Putting it in brackets helps
6692 % distinguish it from the body text that may end up on the next line
6695 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6697 % Figure out line sizes for the paragraph shape.
6698 % The first line needs space for \box0; but if \rightskip is nonzero,
6699 % we need only space for the part of \box0 which exceeds it:
6700 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6701 % The continuations:
6702 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6703 % (plain.tex says that \dimen1 should be used only as global.)
6704 \parshape 2 0in \dimen0 \defargsindent \dimen2
6706 % Put the type name to the right margin.
6709 \hfil\box0 \kern-\hsize
6710 % \hsize has to be shortened this way:
6712 % Intentionally do not respect \rightskip, since we need the space.
6715 % Allow all lines to be underfull without complaint:
6716 \tolerance=10000 \hbadness=10000
6717 \exdentamount=\defbodyindent
6719 % defun fonts. We use typewriter by default (used to be bold) because:
6720 % . we're printing identifiers, they should be in tt in principle.
6721 % . in languages with many accents, such as Czech or French, it's
6722 % common to leave accents off identifiers. The result looks ok in
6723 % tt, but exceedingly strange in rm.
6724 % . we don't want -- and --- to be treated as ligatures.
6725 % . this still does not fix the ?` and !` ligatures, but so far no
6726 % one has made identifiers using them :).
6728 \def\temp{#2}% return value type
6729 \ifx\temp\empty\else \tclose{\temp} \fi
6730 #3% output function name
6732 {\rm\enskip}% hskip 0.5 em of \tenrm
6735 % arguments will be output next, if any.
6738 % Print arguments in slanted roman (not ttsl), inconsistently with using
6739 % tt for the name. This is because literal text is sometimes needed in
6740 % the argument list (groff manual), and ttsl and tt are not very
6741 % distinguishable. Prevent hyphenation at `-' chars.
6744 % use sl by default (not ttsl),
6746 \df \sl \hyphenchar\font=0
6748 % On the other hand, if an argument has two dashes (for instance), we
6749 % want a way to get ttsl. Let's try @var for that.
6750 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
6752 \sl\hyphenchar\font=45
6755 % We want ()&[] to print specially on the defun line.
6758 \catcode`\(=\active \catcode`\)=\active
6759 \catcode`\[=\active \catcode`\]=\active
6763 % Make control sequences which act like normal parenthesis chars.
6764 \let\lparen = ( \let\rparen = )
6766 % Be sure that we always have a definition for `(', etc. For example,
6767 % if the fn name has parens in it, \boldbrax will not be in effect yet,
6768 % so TeX would otherwise complain about undefined control sequence.
6771 \global\let(=\lparen \global\let)=\rparen
6772 \global\let[=\lbrack \global\let]=\rbrack
6775 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
6776 \gdef\magicamp{\let&=\amprm}
6779 \newcount\parencount
6781 % If we encounter &foo, then turn on ()-hacking afterwards
6783 \def\amprm#1 {\ampseentrue{\bf\ }}
6787 % At the first level, print parens in roman,
6788 % otherwise use the default font.
6789 \ifnum \parencount=1 \rm \fi
6791 % The \sf parens (in \boldbrax) actually are a little bolder than
6792 % the contained text. This is especially needed for [ and ] .
6796 \def\infirstlevel#1{%
6803 \def\bfafterword#1 {#1 \bf}
6806 \global\advance\parencount by 1
6808 \infirstlevel \bfafterword
6813 \global\advance\parencount by -1
6816 \newcount\brackcount
6818 \global\advance\brackcount by 1
6823 \global\advance\brackcount by -1
6826 \def\checkparencounts{%
6827 \ifnum\parencount=0 \else \badparencount \fi
6828 \ifnum\brackcount=0 \else \badbrackcount \fi
6830 % these should not use \errmessage; the glibc manual, at least, actually
6831 % has such constructs (when documenting function pointers).
6832 \def\badparencount{%
6833 \message{Warning: unbalanced parentheses in @def...}%
6834 \global\parencount=0
6836 \def\badbrackcount{%
6837 \message{Warning: unbalanced square brackets in @def...}%
6838 \global\brackcount=0
6845 % To do this right we need a feature of e-TeX, \scantokens,
6846 % which we arrange to emulate with a temporary file in ordinary TeX.
6847 \ifx\eTeXversion\undefined
6848 \newwrite\macscribble
6851 \immediate\openout\macscribble=\jobname.tmp
6852 \immediate\write\macscribble{\the\toks0}%
6853 \immediate\closeout\macscribble
6861 \let\xeatspaces\eatspaces
6862 % Undo catcode changes of \startcontents and \doprintindex
6863 % When called from @insertcopying or (short)caption, we need active
6864 % backslash to get it printed correctly. Previously, we had
6865 % \catcode`\\=\other instead. We'll see whether a problem appears
6866 % with macro expansion. --kasal, 19aug04
6867 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6871 % Append \endinput to make sure that TeX does not see the ending newline.
6872 % I've verified that it is necessary both for e-TeX and for ordinary TeX
6874 \scantokens{#1\endinput}%
6879 \edef\temp{\noexpand\scanmacro{#1}}%
6883 \newcount\paramno % Count of parameters
6884 \newtoks\macname % Macro name
6885 \newif\ifrecursive % Is it recursive?
6887 % List of all defined macros in the form
6888 % \definedummyword\macro1\definedummyword\macro2...
6889 % Currently is also contains all @aliases; the list can be split
6890 % if there is a need.
6893 % Add the macro to \macrolist
6894 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6895 \def\addtomacrolistxxx#1{%
6896 \toks0 = \expandafter{\macrolist\definedummyword#1}%
6897 \xdef\macrolist{\the\toks0}%
6901 % This does \let #1 = #2, with \csnames; that is,
6902 % \let \csname#1\endcsname = \csname#2\endcsname
6903 % (except of course we have to play expansion games).
6907 \csname#1\expandafter\endcsname
6911 % Trim leading and trailing spaces off a string.
6912 % Concepts from aro-bend problem 15 (see CTAN).
6914 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6915 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6916 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6918 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6921 % Trim a single trailing ^^M off a string.
6922 {\catcode`\^^M=\other \catcode`\Q=3%
6923 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6924 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6925 \gdef\eatcrb#1Q#2Q{#1}%
6928 % Macro bodies are absorbed as an argument in a context where
6929 % all characters are catcode 10, 11 or 12, except \ which is active
6930 % (as in normal texinfo). It is necessary to change the definition of \.
6932 % Non-ASCII encodings make 8-bit characters active, so un-activate
6933 % them to avoid their expansion. Must do this non-globally, to
6934 % confine the change to the current group.
6936 % It's necessary to have hard CRs when the macro is executed. This is
6937 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
6938 % body, and then making it the \newlinechar in \scanmacro.
6950 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
6956 \catcode`\^^M=\other
6959 \def\macrobodyctxt{%
6963 \catcode`\^^M=\other
6972 % \mbodybackslash is the definition of \ in @macro bodies.
6973 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6974 % where N is the macro parameter number.
6975 % We define \csname macarg.\endcsname to be \realbackslash, so
6976 % \\ in macro replacement text gets you a backslash.
6978 {\catcode`@=0 @catcode`@\=@active
6979 @gdef@usembodybackslash{@let\=@mbodybackslash}
6980 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6982 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6984 \def\macro{\recursivefalse\parsearg\macroxxx}
6985 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6988 \getargs{#1}% now \macname is the macname and \argl the arglist
6989 \ifx\argl\empty % no arguments
6992 \expandafter\parsemargdef \argl;%
6994 \if1\csname ismacro.\the\macname\endcsname
6995 \message{Warning: redefining \the\macname}%
6997 \expandafter\ifx\csname \the\macname\endcsname \relax
6998 \else \errmessage{Macro name \the\macname\space already defined}\fi
6999 \global\cslet{macsave.\the\macname}{\the\macname}%
7000 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7001 \addtomacrolist{\the\macname}%
7003 \begingroup \macrobodyctxt
7004 \ifrecursive \expandafter\parsermacbody
7005 \else \expandafter\parsemacbody
7008 \parseargdef\unmacro{%
7009 \if1\csname ismacro.#1\endcsname
7010 \global\cslet{#1}{macsave.#1}%
7011 \global\expandafter\let \csname ismacro.#1\endcsname=0%
7012 % Remove the macro name from \macrolist:
7014 \expandafter\let\csname#1\endcsname \relax
7015 \let\definedummyword\unmacrodo
7016 \xdef\macrolist{\macrolist}%
7019 \errmessage{Macro #1 not defined}%
7023 % Called by \do from \dounmacro on each macro. The idea is to omit any
7024 % macro definitions that have been changed to \relax.
7030 \noexpand\definedummyword \noexpand#1%
7034 % This makes use of the obscure feature that if the last token of a
7035 % <parameter list> is #, then the preceding argument is delimited by
7036 % an opening brace, and that opening brace is not consumed.
7037 \def\getargs#1{\getargsxxx#1{}}
7038 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7039 \def\getmacname #1 #2\relax{\macname={#1}}
7040 \def\getmacargs#1{\def\argl{#1}}
7042 % Parse the optional {params} list. Set up \paramno and \paramlist
7043 % so \defmacro knows what to do. Define \macarg.blah for each blah
7044 % in the params list, to be ##N where N is the position in that list.
7045 % That gets used by \mbodybackslash (above).
7047 % We need to get `macro parameter char #' into several definitions.
7048 % The technique used is stolen from LaTeX: let \hash be something
7049 % unexpandable, insert that wherever you need a #, and then redefine
7050 % it to # just before using the token list produced.
7052 % The same technique is used to protect \eatspaces till just before
7053 % the macro is used.
7055 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
7056 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
7057 \def\parsemargdefxxx#1,{%
7058 \if#1;\let\next=\relax
7059 \else \let\next=\parsemargdefxxx
7060 \advance\paramno by 1%
7061 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7062 {\xeatspaces{\hash\the\paramno}}%
7063 \edef\paramlist{\paramlist\hash\the\paramno,}%
7066 % These two commands read recursive and nonrecursive macro bodies.
7067 % (They're different since rec and nonrec macros end differently.)
7069 \long\def\parsemacbody#1@end macro%
7070 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7071 \long\def\parsermacbody#1@end rmacro%
7072 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7074 % This defines the macro itself. There are six cases: recursive and
7075 % nonrecursive macros of zero, one, and many arguments.
7076 % Much magic with \expandafter here.
7077 % \xdef is used so that macro definitions will survive the file
7078 % they're defined in; @include reads the file inside a group.
7080 \let\hash=##% convert placeholders to macro parameter chars
7084 \expandafter\xdef\csname\the\macname\endcsname{%
7085 \noexpand\scanmacro{\temp}}%
7087 \expandafter\xdef\csname\the\macname\endcsname{%
7088 \bgroup\noexpand\macroargctxt
7089 \noexpand\braceorline
7090 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7091 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7092 \egroup\noexpand\scanmacro{\temp}}%
7094 \expandafter\xdef\csname\the\macname\endcsname{%
7095 \bgroup\noexpand\macroargctxt
7096 \noexpand\csname\the\macname xx\endcsname}%
7097 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7098 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7099 \expandafter\expandafter
7101 \expandafter\expandafter
7102 \csname\the\macname xxx\endcsname
7103 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7108 \expandafter\xdef\csname\the\macname\endcsname{%
7109 \noexpand\norecurse{\the\macname}%
7110 \noexpand\scanmacro{\temp}\egroup}%
7112 \expandafter\xdef\csname\the\macname\endcsname{%
7113 \bgroup\noexpand\macroargctxt
7114 \noexpand\braceorline
7115 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7116 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7118 \noexpand\norecurse{\the\macname}%
7119 \noexpand\scanmacro{\temp}\egroup}%
7121 \expandafter\xdef\csname\the\macname\endcsname{%
7122 \bgroup\noexpand\macroargctxt
7123 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7124 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7125 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7126 \expandafter\expandafter
7128 \expandafter\expandafter
7129 \csname\the\macname xxx\endcsname
7132 \noexpand\norecurse{\the\macname}%
7133 \noexpand\scanmacro{\temp}\egroup}%
7137 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7139 % \braceorline decides whether the next nonwhitespace character is a
7140 % {. If so it reads up to the closing }, if not, it reads the whole
7141 % line. Whatever was read is then fed to the next control sequence
7142 % as an argument (by \parsebrace or \parsearg)
7143 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7144 \def\braceorlinexxx{%
7145 \ifx\nchar\bgroup\else
7146 \expandafter\parsearg
7151 % We need some trickery to remove the optional spaces around the equal
7152 % sign. Just make them active and then expand them all to nothing.
7153 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7154 \def\aliasxxx #1{\aliasyyy#1\relax}
7155 \def\aliasyyy #1=#2\relax{%
7157 \expandafter\let\obeyedspace=\empty
7158 \addtomacrolist{#1}%
7159 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7165 \message{cross references,}
7168 \newif\ifhavexrefs % True if xref values are known.
7169 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7171 % @inforef is relatively simple.
7172 \def\inforef #1{\inforefzzz #1,,,,**}
7173 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7174 node \samp{\ignorespaces#1{}}}
7176 % @node's only job in TeX is to define \lastnode, which is used in
7177 % cross-references. The @node line might or might not have commas, and
7178 % might or might not have spaces before the first comma, like:
7179 % @node foo , bar , ...
7180 % We don't want such trailing spaces in the node name.
7182 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7184 % also remove a trailing comma, in case of something like this:
7185 % @node Help-Cross, , , Cross-refs
7186 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7187 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7190 \let\lastnode=\empty
7192 % Write a cross-reference definition for the current node. #1 is the
7193 % type (Ynumbered, Yappendix, Ynothing).
7196 \ifx\lastnode\empty\else
7197 \setref{\lastnode}{#1}%
7198 \global\let\lastnode=\empty
7202 % @anchor{NAME} -- define xref target at arbitrary point.
7204 \newcount\savesfregister
7206 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7207 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7208 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7210 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7211 % anchor), which consists of three parts:
7212 % 1) NAME-title - the current sectioning name taken from \lastsection,
7213 % or the anchor name.
7214 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7215 % empty for anchors.
7216 % 3) NAME-pg - the page number.
7218 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7219 % floats, there is an additional part, which is not written here:
7220 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7226 \atdummies % preserve commands, but don't expand them
7227 \edef\writexrdef##1##2{%
7228 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7229 ##1}{##2}}% these are parameters of \writexrdef
7231 \toks0 = \expandafter{\lastsection}%
7232 \immediate \writexrdef{title}{\the\toks0 }%
7233 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7234 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout
7239 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7240 % the node name, #2 the name of the Info cross-reference, #3 the printed
7241 % node name, #4 the name of the Info file, #5 the name of the printed
7242 % manual. All but the node name can be omitted.
7244 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7245 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7246 \def\ref#1{\xrefX[#1,,,,,,,]}
7247 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7249 \def\printedmanual{\ignorespaces #5}%
7250 \def\printedrefname{\ignorespaces #3}%
7251 \setbox1=\hbox{\printedmanual\unskip}%
7252 \setbox0=\hbox{\printedrefname\unskip}%
7254 % No printed node name was explicitly given.
7255 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
7256 % Use the node name inside the square brackets.
7257 \def\printedrefname{\ignorespaces #1}%
7259 % Use the actual chapter/section title appear inside
7260 % the square brackets. Use the real section title if we have it.
7262 % It is in another manual, so we don't have it.
7263 \def\printedrefname{\ignorespaces #1}%
7266 % We know the real title if we have the xref values.
7267 \def\printedrefname{\refx{#1-title}{}}%
7269 % Otherwise just copy the Info node name.
7270 \def\printedrefname{\ignorespaces #1}%
7276 % Make link in pdf output.
7280 % This expands tokens, so do it after making catcode changes, so _
7281 % etc. don't get their TeX definitions.
7284 % See comments at \activebackslashdouble.
7285 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
7286 \backslashparens\pdfxrefdest}%
7289 \startlink attr{/Border [0 0 0]}%
7290 \ifnum\filenamelength>0
7291 goto file{\the\filename.pdf} name{\pdfxrefdest}%
7293 goto name{\pdfmkpgn{\pdfxrefdest}}%
7296 \setcolor{\linkcolor}%
7299 % Float references are printed completely differently: "Figure 1.2"
7300 % instead of "[somenode], p.3". We distinguish them by the
7301 % LABEL-title being set to a magic string.
7303 % Have to otherify everything special to allow the \csname to
7304 % include an _ in the xref name, etc.
7307 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7308 \csname XR#1-title\endcsname
7310 \iffloat\Xthisreftitle
7311 % If the user specified the print name (third arg) to the ref,
7312 % print it instead of our usual "Figure 1.2".
7319 % if the user also gave the printed manual name (fifth arg), append
7322 \space \putwordin{} \cite{\printedmanual}%
7325 % node/anchor (non-float) references.
7327 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7328 % insert empty discretionaries after hyphens, which means that it will
7329 % not find a line break at a hyphen in a node names. Since some manuals
7330 % are best written with fairly long node names, containing hyphens, this
7331 % is a loss. Therefore, we give the text of the node name again, so it
7332 % is as if TeX is seeing it for the first time.
7334 \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7336 % _ (for example) has to be the character _ for the purposes of the
7337 % control sequence corresponding to the node, but it has to expand
7338 % into the usual \leavevmode...\vrule stuff for purposes of
7339 % printing. So we \turnoffactive for the \refx-snt, back on for the
7340 % printing, back off for the \refx-pg.
7342 % Only output a following space if the -snt ref is nonempty; for
7343 % @unnumbered and @anchor, it won't be.
7344 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7345 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7347 % output the `[mynode]' via a macro so it can be overridden.
7348 \xrefprintnodename\printedrefname
7350 % But we always want a comma and a space:
7353 % output the `page 3'.
7354 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7360 % This macro is called from \xrefX for the `[nodename]' part of xref
7361 % output. It's a separate macro only so it can be changed more easily,
7362 % since square brackets don't work well in some documents. Particularly
7363 % one that Bob is working on :).
7365 \def\xrefprintnodename#1{[#1]}
7367 % Things referred to by \setref.
7373 \putwordChapter@tie \the\chapno
7374 \else \ifnum\subsecno=0
7375 \putwordSection@tie \the\chapno.\the\secno
7376 \else \ifnum\subsubsecno=0
7377 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7379 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7384 \putwordAppendix@tie @char\the\appendixno{}%
7385 \else \ifnum\subsecno=0
7386 \putwordSection@tie @char\the\appendixno.\the\secno
7387 \else \ifnum\subsubsecno=0
7388 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7391 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7395 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7396 % If its value is nonempty, SUFFIX is output afterward.
7402 \expandafter\global\expandafter\let\expandafter\thisrefX
7403 \csname XR#1\endcsname
7406 % If not defined, say something at least.
7407 \angleleft un\-de\-fined\angleright
7410 \message{\linenumber Undefined cross reference `#1'.}%
7413 \global\warnedxrefstrue
7414 \message{Cross reference values unknown; you must run TeX again.}%
7419 % It's defined, so just use it.
7422 #2% Output the suffix in any case.
7425 % This is the macro invoked by entries in the aux file. Usually it's
7426 % just a \def (we prepend XR to the control sequence name to avoid
7427 % collisions). But if this is a float type, we have more work to do.
7430 {% The node name might contain 8-bit characters, which in our current
7431 % implementation are changed to commands like @'e. Don't let these
7432 % mess up the control sequence name.
7435 \xdef\safexrefname{#1}%
7438 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7440 % Was that xref control sequence that we just defined for a float?
7441 \expandafter\iffloat\csname XR\safexrefname\endcsname
7442 % it was a float, and we have the (safe) float type in \iffloattype.
7443 \expandafter\let\expandafter\floatlist
7444 \csname floatlist\iffloattype\endcsname
7446 % Is this the first time we've seen this float type?
7447 \expandafter\ifx\floatlist\relax
7448 \toks0 = {\do}% yes, so just \do
7450 % had it before, so preserve previous elements in list.
7451 \toks0 = \expandafter{\floatlist\do}%
7454 % Remember this xref in the control sequence \floatlistFLOATTYPE,
7455 % for later use in \listoffloats.
7456 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
7461 % Read the last existing aux file, if any. No error if none exists.
7464 \openin 1 \jobname.aux
7467 \global\havexrefstrue
7472 \def\setupdatafile{%
7473 \catcode`\^^@=\other
7474 \catcode`\^^A=\other
7475 \catcode`\^^B=\other
7476 \catcode`\^^C=\other
7477 \catcode`\^^D=\other
7478 \catcode`\^^E=\other
7479 \catcode`\^^F=\other
7480 \catcode`\^^G=\other
7481 \catcode`\^^H=\other
7482 \catcode`\^^K=\other
7483 \catcode`\^^L=\other
7484 \catcode`\^^N=\other
7485 \catcode`\^^P=\other
7486 \catcode`\^^Q=\other
7487 \catcode`\^^R=\other
7488 \catcode`\^^S=\other
7489 \catcode`\^^T=\other
7490 \catcode`\^^U=\other
7491 \catcode`\^^V=\other
7492 \catcode`\^^W=\other
7493 \catcode`\^^X=\other
7494 \catcode`\^^Z=\other
7495 \catcode`\^^[=\other
7496 \catcode`\^^\=\other
7497 \catcode`\^^]=\other
7498 \catcode`\^^^=\other
7499 \catcode`\^^_=\other
7500 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
7501 % in xref tags, i.e., node names. But since ^^e4 notation isn't
7502 % supported in the main text, it doesn't seem desirable. Furthermore,
7503 % that is not enough: for node names that actually contain a ^
7504 % character, we would end up writing a line like this: 'xrdef {'hat
7505 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
7506 % argument, and \hat is not an expandable control sequence. It could
7507 % all be worked out, but why? Either we support ^^ or we don't.
7509 % The other change necessary for this was to define \auxhat:
7510 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
7511 % and then to call \auxhat in \setq.
7515 % Special characters. Should be turned off anyway, but...
7528 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
7530 % This is to support \ in node names and titles, since the \
7531 % characters end up in a \csname. It's easier than
7532 % leaving it active and making its active definition an actual \
7533 % character. What I don't understand is why it works in the *value*
7534 % of the xrdef. Seems like it should be a catcode12 \, and that
7535 % should not typeset properly. But it works, so I'm moving on for
7536 % now. --karl, 15jan04.
7539 % Make the characters 128-255 be printing characters.
7543 \catcode\count1=\other
7544 \advance\count1 by 1
7545 \ifnum \count1<256 \loop \fi
7549 % @ is our escape character in .aux files, and we need braces.
7555 \def\readdatafile#1{%
7562 \message{insertions,}
7563 % including footnotes.
7565 \newcount \footnoteno
7567 % The trailing space in the following definition for supereject is
7568 % vital for proper filling; pages come out unaligned when you do a
7569 % pagealignmacro call if that space before the closing brace is
7570 % removed. (Generally, numeric constants should always be followed by a
7571 % space to prevent strange expansion errors.)
7572 \def\supereject{\par\penalty -20000\footnoteno =0 }
7574 % @footnotestyle is meaningful for info output only.
7575 \let\footnotestyle=\comment
7579 % Auto-number footnotes. Otherwise like plain.
7581 \let\indent=\ptexindent
7582 \let\noindent=\ptexnoindent
7583 \global\advance\footnoteno by \@ne
7584 \edef\thisfootno{$^{\the\footnoteno}$}%
7586 % In case the footnote comes at the end of a sentence, preserve the
7587 % extra spacing after we do the footnote number.
7589 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
7591 % Remove inadvertent blank space before typesetting the footnote number.
7597 % Don't bother with the trickery in plain.tex to not require the
7598 % footnote text as a parameter. Our footnotes don't need to be so general.
7600 % Oh yes, they do; otherwise, @ifset (and anything else that uses
7601 % \parseargline) fails inside footnotes because the tokens are fixed when
7602 % the footnote is read. --karl, 16nov96.
7605 \insert\footins\bgroup
7606 % We want to typeset this text as a normal paragraph, even if the
7607 % footnote reference occurs in (for example) a display environment.
7608 % So reset some parameters.
7610 \interlinepenalty\interfootnotelinepenalty
7611 \splittopskip\ht\strutbox % top baseline for broken footnotes
7612 \splitmaxdepth\dp\strutbox
7613 \floatingpenalty\@MM
7618 \parindent\defaultparindent
7622 % Because we use hanging indentation in footnotes, a @noindent appears
7623 % to exdent this text, so make it be a no-op. makeinfo does not use
7624 % hanging indentation so @noindent can still be needed within footnote
7625 % text after an @example or the like (not that this is good style).
7626 \let\noindent = \relax
7628 % Hang the footnote text off the number. Use \everypar in case the
7629 % footnote extends for more than one paragraph.
7630 \everypar = {\hang}%
7631 \textindent{\thisfootno}%
7633 % Don't crash into the line above the footnote text. Since this
7634 % expands into a box, it must come within the paragraph, lest it
7635 % provide a place where TeX can split the footnote.
7637 \futurelet\next\fo@t
7639 }%end \catcode `\@=11
7641 % In case a @footnote appears in a vbox, save the footnote text and create
7642 % the real \insert just after the vbox finished. Otherwise, the insertion
7644 % Similarly, if a @footnote appears inside an alignment, save the footnote
7645 % text to a box and make the \insert when a row of the table is finished.
7646 % And the same can be done for other insert classes. --kasal, 16nov03.
7648 % Replace the \insert primitive by a cheating macro.
7649 % Deeper inside, just make sure that the saved insertions are not spilled
7652 \def\startsavinginserts{%
7653 \ifx \insert\ptexinsert
7654 \let\insert\saveinsert
7656 \let\checkinserts\relax
7660 % This \insert replacement works for both \insert\footins{foo} and
7661 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
7664 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
7665 \afterassignment\next
7666 % swallow the left brace
7669 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
7670 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
7672 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
7674 \def\placesaveins#1{%
7675 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
7679 % eat @SAVE -- beware, all of them have catcode \other:
7681 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
7682 \gdef\gobblesave @SAVE{}
7686 \def\newsaveins #1{%
7687 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
7690 \def\newsaveinsX #1{%
7691 \csname newbox\endcsname #1%
7692 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7697 \let\checkinserts\empty
7702 % @image. We use the macros from epsf.tex to support this.
7703 % If epsf.tex is not installed and @image is used, we complain.
7705 % Check for and read epsf.tex up front. If we read it only at @image
7706 % time, we might be inside a group, and then its definitions would get
7707 % undone and the next image would fail.
7708 \openin 1 = epsf.tex
7710 % Do not bother showing banner with epsf.tex v2.7k (available in
7711 % doc/epsf.tex and on ctan).
7712 \def\epsfannounce{\toks0 = }%
7717 % We will only complain once about lack of epsf.tex.
7718 \newif\ifwarnednoepsf
7719 \newhelp\noepsfhelp{epsf.tex must be installed for images to
7720 work. It is also included in the Texinfo distribution, or you can get
7721 it from ftp://tug.org/tex/epsf.tex.}
7724 \ifx\epsfbox\undefined
7725 \ifwarnednoepsf \else
7726 \errhelp = \noepsfhelp
7727 \errmessage{epsf.tex not found, images will be ignored}%
7728 \global\warnednoepsftrue
7731 \imagexxx #1,,,,,\finish
7735 % Arguments to @image:
7736 % #1 is (mandatory) image filename; we tack on .eps extension.
7737 % #2 is (optional) width, #3 is (optional) height.
7738 % #4 is (ignored optional) html alt text.
7739 % #5 is (ignored optional) extension.
7740 % #6 is just the usual extra ignored arg for parsing stuff.
7742 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7743 \catcode`\^^M = 5 % in case we're inside an example
7744 \normalturnoffactive % allow _ et al. in names
7745 % If the image is by itself, center it.
7749 % Usually we'll have text after the image which will insert
7750 % \parskip glue, so insert it here too to equalize the space
7752 \nobreak\vskip\parskip
7756 % Leave vertical mode so that indentation from an enclosing
7757 % environment such as @quotation is respected. On the other hand, if
7758 % it's at the top level, we don't want the normal paragraph indentation.
7763 \dopdfimage{#1}{#2}{#3}%
7765 % \epsfbox itself resets \epsf?size at each figure.
7766 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
7767 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7771 \ifimagevmode \medskip \fi % space after the standalone image
7775 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7776 % etc. We don't actually implement floating yet, we always include the
7777 % float "here". But it seemed the best name for the future.
7779 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7781 % There may be a space before second and/or third parameter; delete it.
7782 \def\eatcommaspace#1, {#1,}
7784 % #1 is the optional FLOATTYPE, the text label for this float, typically
7785 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
7786 % this float will not be numbered and cannot be referred to.
7788 % #2 is the optional xref label. Also must be present for the float to
7791 % #3 is the optional positioning argument; for now, it is ignored. It
7792 % will somehow specify the positions allowed to float to (here, top, bottom).
7794 % We keep a separate counter for each FLOATTYPE, which we reset at each
7795 % chapter-level command.
7796 \let\resetallfloatnos=\empty
7798 \def\dofloat#1,#2,#3,#4\finish{%
7799 \let\thiscaption=\empty
7800 \let\thisshortcaption=\empty
7802 % don't lose footnotes inside @float.
7804 % BEWARE: when the floats start float, we have to issue warning whenever an
7805 % insert appears inside a float which could possibly float. --kasal, 26may04
7809 % We can't be used inside a paragraph.
7814 \def\floatlabel{#2}%
7815 \def\floatloc{#3}% we do nothing with this yet.
7817 \ifx\floattype\empty
7818 \let\safefloattype=\empty
7821 % the floattype might have accents or other special characters,
7822 % but we need to use it in a control sequence name.
7825 \xdef\safefloattype{\floattype}%
7829 % If label is given but no type, we handle that as the empty type.
7830 \ifx\floatlabel\empty \else
7831 % We want each FLOATTYPE to be numbered separately (Figure 1,
7832 % Table 1, Figure 2, ...). (And if no label, no number.)
7834 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7835 \global\advance\floatno by 1
7838 % This magic value for \lastsection is output by \setref as the
7839 % XREFLABEL-title value. \xrefX uses it to distinguish float
7840 % labels (which have a completely different output format) from
7841 % node and anchor labels. And \xrdef uses it to construct the
7844 \edef\lastsection{\floatmagic=\safefloattype}%
7845 \setref{\floatlabel}{Yfloat}%
7849 % start with \parskip glue, I guess.
7852 % Don't suppress indentation if a float happens to start a section.
7853 \restorefirstparagraphindent
7856 % we have these possibilities:
7857 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7858 % @float Foo,lbl & no caption: Foo 1.1
7859 % @float Foo & @caption{Cap}: Foo: Cap
7860 % @float Foo & no caption: Foo
7861 % @float ,lbl & Caption{Cap}: 1.1: Cap
7862 % @float ,lbl & no caption: 1.1
7863 % @float & @caption{Cap}: Cap
7864 % @float & no caption:
7867 \let\floatident = \empty
7869 % In all cases, if we have a float type, it comes first.
7870 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7872 % If we have an xref label, the number comes next.
7873 \ifx\floatlabel\empty \else
7874 \ifx\floattype\empty \else % if also had float type, need tie first.
7875 \appendtomacro\floatident{\tie}%
7878 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
7881 % Start the printed caption with what we've constructed in
7882 % \floatident, but keep it separate; we need \floatident again.
7883 \let\captionline = \floatident
7885 \ifx\thiscaption\empty \else
7886 \ifx\floatident\empty \else
7887 \appendtomacro\captionline{: }% had ident, so need a colon between
7891 \appendtomacro\captionline{\scanexp\thiscaption}%
7894 % If we have anything to print, print it, with space before.
7895 % Eventually this needs to become an \insert.
7896 \ifx\captionline\empty \else
7900 % Space below caption.
7904 % If have an xref label, write the list of floats info. Do this
7905 % after the caption, to avoid chance of it being a breakpoint.
7906 \ifx\floatlabel\empty \else
7907 % Write the text that goes in the lof to the aux file as
7908 % \floatlabel-lof. Besides \floatident, we include the short
7909 % caption if specified, else the full caption if specified, else nothing.
7913 % since we read the caption text in the macro world, where ^^M
7914 % is turned into a normal character, we have to scan it back, so
7915 % we don't write the literal three characters "^^M" into the aux file.
7917 \xdef\noexpand\gtemp{%
7918 \ifx\thisshortcaption\empty
7925 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7926 \ifx\gtemp\empty \else : \gtemp \fi}}%
7929 \egroup % end of \vtop
7931 % place the captured inserts
7933 % BEWARE: when the floats start floating, we have to issue warning
7934 % whenever an insert appears inside a float which could possibly
7935 % float. --kasal, 26may04
7940 % Append the tokens #2 to the definition of macro #1, not expanding either.
7942 \def\appendtomacro#1#2{%
7943 \expandafter\def\expandafter#1\expandafter{#1#2}%
7946 % @caption, @shortcaption
7948 \def\caption{\docaption\thiscaption}
7949 \def\shortcaption{\docaption\thisshortcaption}
7950 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7951 \def\defcaption#1#2{\egroup \def#1{#2}}
7953 % The parameter is the control sequence identifying the counter we are
7954 % going to use. Create it if it doesn't exist and assign it to \floatno.
7957 % Haven't seen this figure type before.
7958 \csname newcount\endcsname #1%
7960 % Remember to reset this floatno at the next chap.
7961 \expandafter\gdef\expandafter\resetallfloatnos
7962 \expandafter{\resetallfloatnos #1=0 }%
7967 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
7968 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
7969 % first read the @float command.
7971 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7973 % Magic string used for the XREFLABEL-title value, so \xrefX can
7974 % distinguish floats from other xref types.
7975 \def\floatmagic{!!float!!}
7977 % #1 is the control sequence we are passed; we expand into a conditional
7978 % which is true if #1 represents a float ref. That is, the magic
7979 % \lastsection value which we \setref above.
7981 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7983 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
7984 % (safe) float type for this float. We set \iffloattype to #2.
7986 \def\doiffloat#1=#2=#3\finish{%
7988 \def\iffloattype{#2}%
7989 \ifx\temp\floatmagic
7992 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7994 \parseargdef\listoffloats{%
7995 \def\floattype{#1}% floattype
7997 % the floattype might have accents or other special characters,
7998 % but we need to use it in a control sequence name.
8001 \xdef\safefloattype{\floattype}%
8004 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8005 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8007 % if the user said @listoffloats foo but never @float foo.
8008 \message{\linenumber No `\safefloattype' floats to list.}%
8012 \leftskip=\tocindent % indent these entries like a toc
8013 \let\do=\listoffloatsdo
8014 \csname floatlist\safefloattype\endcsname
8019 % This is called on each entry in a list of floats. We're passed the
8020 % xref label, in the form LABEL-title, which is how we save it in the
8021 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8022 % has the text we're supposed to typeset here.
8024 % Figures without xref labels will not be included in the list (since
8025 % they won't appear in the aux file).
8027 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8028 \def\listoffloatsdoentry#1-title\finish{{%
8029 % Can't fully expand XR#1-lof because it can contain anything. Just
8030 % pass the control sequence. On the other hand, XR#1-pg is just the
8031 % page number, and we want to fully expand that so we can get a link
8033 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8035 % use the same \entry macro we use to generate the TOC and index.
8036 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8041 \message{localization,}
8043 % For single-language documents, @documentlanguage is usually given very
8044 % early, just after @documentencoding. Single argument is the language
8045 % (de) or locale (de_DE) abbreviation.
8048 \catcode`\_ = \active
8050 \parseargdef\documentlanguage{\begingroup
8051 \let_=\normalunderscore % normal _ character for filenames
8052 \tex % read txi-??.tex file in plain TeX.
8053 % Read the file by the name they passed if it exists.
8054 \openin 1 txi-#1.tex
8056 \documentlanguagetrywithoutunderscore{#1_\finish}%
8058 \globaldefs = 1 % everything in the txi-LL files needs to persist
8062 \endgroup % end raw TeX
8065 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8068 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8069 \openin 1 txi-#1.tex
8071 \errhelp = \nolanghelp
8072 \errmessage{Cannot read language file txi-#1.tex}%
8074 \globaldefs = 1 % everything in the txi-LL files needs to persist
8079 }% end of special _ catcode
8081 \newhelp\nolanghelp{The given language definition file cannot be found or
8082 is empty. Maybe you need to install it? Putting it in the current
8083 directory should work if nowhere else does.}
8085 % This macro is called from txi-??.tex files; the first argument is the
8086 % \language name to set (without the "\lang@" prefix), the second and
8087 % third args are \{left,right}hyphenmin.
8089 % The language names to pass are determined when the format is built.
8090 % See the etex.log file created at that time, e.g.,
8091 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8093 % With TeX Live 2008, etex now includes hyphenation patterns for all
8094 % available languages. This means we can support hyphenation in
8095 % Texinfo, at least to some extent. (This still doesn't solve the
8096 % accented characters problem.)
8099 \def\txisetlanguage#1#2#3{%
8100 % do not set the language if the name is undefined in the current TeX.
8101 \expandafter\ifx\csname lang@#1\endcsname \relax
8102 \message{no patterns for #1}%
8104 \global\language = \csname lang@#1\endcsname
8106 % but there is no harm in adjusting the hyphenmin values regardless.
8107 \global\lefthyphenmin = #2\relax
8108 \global\righthyphenmin = #3\relax
8111 % Helpers for encodings.
8112 % Set the catcode of characters 128 through 255 to the specified number.
8114 \def\setnonasciicharscatcode#1{%
8116 \loop\ifnum\count255<256
8117 \global\catcode\count255=#1\relax
8118 \advance\count255 by 1
8122 \def\setnonasciicharscatcodenonglobal#1{%
8124 \loop\ifnum\count255<256
8125 \catcode\count255=#1\relax
8126 \advance\count255 by 1
8130 % @documentencoding sets the definition of non-ASCII characters
8131 % according to the specified encoding.
8133 \parseargdef\documentencoding{%
8134 % Encoding being declared for the document.
8135 \def\declaredencoding{\csname #1.enc\endcsname}%
8137 % Supported encodings: names converted to tokens in order to be able
8138 % to compare them with \ifx.
8139 \def\ascii{\csname US-ASCII.enc\endcsname}%
8140 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8141 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8142 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8143 \def\utfeight{\csname UTF-8.enc\endcsname}%
8145 \ifx \declaredencoding \ascii
8148 \else \ifx \declaredencoding \lattwo
8149 \setnonasciicharscatcode\active
8152 \else \ifx \declaredencoding \latone
8153 \setnonasciicharscatcode\active
8156 \else \ifx \declaredencoding \latnine
8157 \setnonasciicharscatcode\active
8160 \else \ifx \declaredencoding \utfeight
8161 \setnonasciicharscatcode\active
8165 \message{Unknown document encoding #1, ignoring.}%
8174 % A message to be logged when using a character that isn't available
8175 % the default font encoding (OT1).
8177 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8179 % Take account of \c (plain) vs. \, (Texinfo) difference.
8180 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8182 % First, make active non-ASCII characters in order for them to be
8183 % correctly categorized when TeX reads the replacement text of
8184 % macros containing the character definitions.
8185 \setnonasciicharscatcode\active
8187 % Latin1 (ISO-8859-1) character definitions.
8188 \def\latonechardefs{%
8190 \gdef^^a1{\exclamdown}
8191 \gdef^^a2{\missingcharmsg{CENT SIGN}}
8192 \gdef^^a3{{\pounds}}
8193 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8194 \gdef^^a5{\missingcharmsg{YEN SIGN}}
8195 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8198 \gdef^^a9{\copyright}
8200 \gdef^^ab{\guillemetleft}
8203 \gdef^^ae{\registeredsymbol}
8206 \gdef^^b0{\textdegree}
8215 \gdef^^b8{\cedilla\ }
8219 \gdef^^bb{\guilletright}
8220 \gdef^^bc{$1\over4$}
8221 \gdef^^bd{$1\over2$}
8222 \gdef^^be{$3\over4$}
8223 \gdef^^bf{\questiondown}
8230 \gdef^^c5{\ringaccent A}
8232 \gdef^^c7{\cedilla C}
8264 \gdef^^e5{\ringaccent a}
8266 \gdef^^e7{\cedilla c}
8271 \gdef^^ec{\`{\dotless i}}
8272 \gdef^^ed{\'{\dotless i}}
8273 \gdef^^ee{\^{\dotless i}}
8274 \gdef^^ef{\"{\dotless i}}
8294 % Latin9 (ISO-8859-15) encoding character definitions.
8295 \def\latninechardefs{%
8296 % Encoding is almost identical to Latin1.
8309 % Latin2 (ISO-8859-2) character definitions.
8310 \def\lattwochardefs{%
8312 \gdef^^a1{\ogonek{A}}
8315 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8321 \gdef^^aa{\cedilla S}
8326 \gdef^^af{\dotaccent Z}
8328 \gdef^^b0{\textdegree}
8329 \gdef^^b1{\ogonek{a}}
8330 \gdef^^b2{\ogonek{ }}
8336 \gdef^^b8{\cedilla\ }
8338 \gdef^^ba{\cedilla s}
8343 \gdef^^bf{\dotaccent z}
8352 \gdef^^c7{\cedilla C}
8355 \gdef^^ca{\ogonek{E}}
8371 \gdef^^d9{\ringaccent U}
8376 \gdef^^de{\cedilla T}
8386 \gdef^^e7{\cedilla c}
8389 \gdef^^ea{\ogonek{e}}
8405 \gdef^^f9{\ringaccent u}
8410 \gdef^^fe{\cedilla t}
8411 \gdef^^ff{\dotaccent{}}
8414 % UTF-8 character definitions.
8416 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8417 % changes for Texinfo conventions. It is included here under the GPL by
8418 % permission from Frank Mittelbach and the LaTeX team.
8424 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8425 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8427 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8428 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8430 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8431 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8433 \gdef\UTFviiiDefined#1{%
8435 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8446 \global\catcode\countUTFx\active
8447 \uccode`\~\countUTFx
8448 \uppercase\expandafter{\UTFviiiTmp}%
8449 \advance\countUTFx by 1
8450 \ifnum\countUTFx < \countUTFy
8451 \expandafter\UTFviiiLoop
8457 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
8463 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
8469 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
8482 \gdef\DeclareUnicodeCharacter#1#2{%
8483 \countUTFz = "#1\relax
8484 \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
8487 \def\UTFviiiTwoOctets##1##2{%
8488 \csname u8:##1\string ##2\endcsname}%
8489 \def\UTFviiiThreeOctets##1##2##3{%
8490 \csname u8:##1\string ##2\string ##3\endcsname}%
8491 \def\UTFviiiFourOctets##1##2##3##4{%
8492 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
8493 \expandafter\expandafter\expandafter\expandafter
8494 \expandafter\expandafter\expandafter
8495 \gdef\UTFviiiTmp{#2}%
8498 \gdef\parseXMLCharref{%
8499 \ifnum\countUTFz < "A0\relax
8500 \errhelp = \EMsimple
8501 \errmessage{Cannot define Unicode char value < 00A0}%
8502 \else\ifnum\countUTFz < "800\relax
8504 \parseUTFviiiB C\UTFviiiTwoOctets.,%
8505 \else\ifnum\countUTFz < "10000\relax
8508 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
8513 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
8517 \gdef\parseUTFviiiA#1{%
8518 \countUTFx = \countUTFz
8519 \divide\countUTFz by 64
8520 \countUTFy = \countUTFz
8521 \multiply\countUTFz by 64
8522 \advance\countUTFx by -\countUTFz
8523 \advance\countUTFx by 128
8524 \uccode `#1\countUTFx
8525 \countUTFz = \countUTFy}
8527 \gdef\parseUTFviiiB#1#2#3#4{%
8528 \advance\countUTFz by "#10\relax
8529 \uccode `#3\countUTFz
8530 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
8533 \def\utfeightchardefs{%
8534 \DeclareUnicodeCharacter{00A0}{\tie}
8535 \DeclareUnicodeCharacter{00A1}{\exclamdown}
8536 \DeclareUnicodeCharacter{00A3}{\pounds}
8537 \DeclareUnicodeCharacter{00A8}{\"{ }}
8538 \DeclareUnicodeCharacter{00A9}{\copyright}
8539 \DeclareUnicodeCharacter{00AA}{\ordf}
8540 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
8541 \DeclareUnicodeCharacter{00AD}{\-}
8542 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
8543 \DeclareUnicodeCharacter{00AF}{\={ }}
8545 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
8546 \DeclareUnicodeCharacter{00B4}{\'{ }}
8547 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
8548 \DeclareUnicodeCharacter{00BA}{\ordm}
8549 \DeclareUnicodeCharacter{00BB}{\guillemetright}
8550 \DeclareUnicodeCharacter{00BF}{\questiondown}
8552 \DeclareUnicodeCharacter{00C0}{\`A}
8553 \DeclareUnicodeCharacter{00C1}{\'A}
8554 \DeclareUnicodeCharacter{00C2}{\^A}
8555 \DeclareUnicodeCharacter{00C3}{\~A}
8556 \DeclareUnicodeCharacter{00C4}{\"A}
8557 \DeclareUnicodeCharacter{00C5}{\AA}
8558 \DeclareUnicodeCharacter{00C6}{\AE}
8559 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
8560 \DeclareUnicodeCharacter{00C8}{\`E}
8561 \DeclareUnicodeCharacter{00C9}{\'E}
8562 \DeclareUnicodeCharacter{00CA}{\^E}
8563 \DeclareUnicodeCharacter{00CB}{\"E}
8564 \DeclareUnicodeCharacter{00CC}{\`I}
8565 \DeclareUnicodeCharacter{00CD}{\'I}
8566 \DeclareUnicodeCharacter{00CE}{\^I}
8567 \DeclareUnicodeCharacter{00CF}{\"I}
8569 \DeclareUnicodeCharacter{00D0}{\DH}
8570 \DeclareUnicodeCharacter{00D1}{\~N}
8571 \DeclareUnicodeCharacter{00D2}{\`O}
8572 \DeclareUnicodeCharacter{00D3}{\'O}
8573 \DeclareUnicodeCharacter{00D4}{\^O}
8574 \DeclareUnicodeCharacter{00D5}{\~O}
8575 \DeclareUnicodeCharacter{00D6}{\"O}
8576 \DeclareUnicodeCharacter{00D8}{\O}
8577 \DeclareUnicodeCharacter{00D9}{\`U}
8578 \DeclareUnicodeCharacter{00DA}{\'U}
8579 \DeclareUnicodeCharacter{00DB}{\^U}
8580 \DeclareUnicodeCharacter{00DC}{\"U}
8581 \DeclareUnicodeCharacter{00DD}{\'Y}
8582 \DeclareUnicodeCharacter{00DE}{\TH}
8583 \DeclareUnicodeCharacter{00DF}{\ss}
8585 \DeclareUnicodeCharacter{00E0}{\`a}
8586 \DeclareUnicodeCharacter{00E1}{\'a}
8587 \DeclareUnicodeCharacter{00E2}{\^a}
8588 \DeclareUnicodeCharacter{00E3}{\~a}
8589 \DeclareUnicodeCharacter{00E4}{\"a}
8590 \DeclareUnicodeCharacter{00E5}{\aa}
8591 \DeclareUnicodeCharacter{00E6}{\ae}
8592 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
8593 \DeclareUnicodeCharacter{00E8}{\`e}
8594 \DeclareUnicodeCharacter{00E9}{\'e}
8595 \DeclareUnicodeCharacter{00EA}{\^e}
8596 \DeclareUnicodeCharacter{00EB}{\"e}
8597 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
8598 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
8599 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
8600 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
8602 \DeclareUnicodeCharacter{00F0}{\dh}
8603 \DeclareUnicodeCharacter{00F1}{\~n}
8604 \DeclareUnicodeCharacter{00F2}{\`o}
8605 \DeclareUnicodeCharacter{00F3}{\'o}
8606 \DeclareUnicodeCharacter{00F4}{\^o}
8607 \DeclareUnicodeCharacter{00F5}{\~o}
8608 \DeclareUnicodeCharacter{00F6}{\"o}
8609 \DeclareUnicodeCharacter{00F8}{\o}
8610 \DeclareUnicodeCharacter{00F9}{\`u}
8611 \DeclareUnicodeCharacter{00FA}{\'u}
8612 \DeclareUnicodeCharacter{00FB}{\^u}
8613 \DeclareUnicodeCharacter{00FC}{\"u}
8614 \DeclareUnicodeCharacter{00FD}{\'y}
8615 \DeclareUnicodeCharacter{00FE}{\th}
8616 \DeclareUnicodeCharacter{00FF}{\"y}
8618 \DeclareUnicodeCharacter{0100}{\=A}
8619 \DeclareUnicodeCharacter{0101}{\=a}
8620 \DeclareUnicodeCharacter{0102}{\u{A}}
8621 \DeclareUnicodeCharacter{0103}{\u{a}}
8622 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
8623 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
8624 \DeclareUnicodeCharacter{0106}{\'C}
8625 \DeclareUnicodeCharacter{0107}{\'c}
8626 \DeclareUnicodeCharacter{0108}{\^C}
8627 \DeclareUnicodeCharacter{0109}{\^c}
8628 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
8629 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
8630 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
8631 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
8632 \DeclareUnicodeCharacter{010C}{\v{C}}
8633 \DeclareUnicodeCharacter{010D}{\v{c}}
8634 \DeclareUnicodeCharacter{010E}{\v{D}}
8636 \DeclareUnicodeCharacter{0112}{\=E}
8637 \DeclareUnicodeCharacter{0113}{\=e}
8638 \DeclareUnicodeCharacter{0114}{\u{E}}
8639 \DeclareUnicodeCharacter{0115}{\u{e}}
8640 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
8641 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
8642 \DeclareUnicodeCharacter{011A}{\v{E}}
8643 \DeclareUnicodeCharacter{011B}{\v{e}}
8644 \DeclareUnicodeCharacter{011C}{\^G}
8645 \DeclareUnicodeCharacter{011D}{\^g}
8646 \DeclareUnicodeCharacter{011E}{\u{G}}
8647 \DeclareUnicodeCharacter{011F}{\u{g}}
8649 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8650 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8651 \DeclareUnicodeCharacter{0124}{\^H}
8652 \DeclareUnicodeCharacter{0125}{\^h}
8653 \DeclareUnicodeCharacter{0128}{\~I}
8654 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8655 \DeclareUnicodeCharacter{012A}{\=I}
8656 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8657 \DeclareUnicodeCharacter{012C}{\u{I}}
8658 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8660 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8661 \DeclareUnicodeCharacter{0131}{\dotless{i}}
8662 \DeclareUnicodeCharacter{0132}{IJ}
8663 \DeclareUnicodeCharacter{0133}{ij}
8664 \DeclareUnicodeCharacter{0134}{\^J}
8665 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8666 \DeclareUnicodeCharacter{0139}{\'L}
8667 \DeclareUnicodeCharacter{013A}{\'l}
8669 \DeclareUnicodeCharacter{0141}{\L}
8670 \DeclareUnicodeCharacter{0142}{\l}
8671 \DeclareUnicodeCharacter{0143}{\'N}
8672 \DeclareUnicodeCharacter{0144}{\'n}
8673 \DeclareUnicodeCharacter{0147}{\v{N}}
8674 \DeclareUnicodeCharacter{0148}{\v{n}}
8675 \DeclareUnicodeCharacter{014C}{\=O}
8676 \DeclareUnicodeCharacter{014D}{\=o}
8677 \DeclareUnicodeCharacter{014E}{\u{O}}
8678 \DeclareUnicodeCharacter{014F}{\u{o}}
8680 \DeclareUnicodeCharacter{0150}{\H{O}}
8681 \DeclareUnicodeCharacter{0151}{\H{o}}
8682 \DeclareUnicodeCharacter{0152}{\OE}
8683 \DeclareUnicodeCharacter{0153}{\oe}
8684 \DeclareUnicodeCharacter{0154}{\'R}
8685 \DeclareUnicodeCharacter{0155}{\'r}
8686 \DeclareUnicodeCharacter{0158}{\v{R}}
8687 \DeclareUnicodeCharacter{0159}{\v{r}}
8688 \DeclareUnicodeCharacter{015A}{\'S}
8689 \DeclareUnicodeCharacter{015B}{\'s}
8690 \DeclareUnicodeCharacter{015C}{\^S}
8691 \DeclareUnicodeCharacter{015D}{\^s}
8692 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8693 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8695 \DeclareUnicodeCharacter{0160}{\v{S}}
8696 \DeclareUnicodeCharacter{0161}{\v{s}}
8697 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8698 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8699 \DeclareUnicodeCharacter{0164}{\v{T}}
8701 \DeclareUnicodeCharacter{0168}{\~U}
8702 \DeclareUnicodeCharacter{0169}{\~u}
8703 \DeclareUnicodeCharacter{016A}{\=U}
8704 \DeclareUnicodeCharacter{016B}{\=u}
8705 \DeclareUnicodeCharacter{016C}{\u{U}}
8706 \DeclareUnicodeCharacter{016D}{\u{u}}
8707 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8708 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8710 \DeclareUnicodeCharacter{0170}{\H{U}}
8711 \DeclareUnicodeCharacter{0171}{\H{u}}
8712 \DeclareUnicodeCharacter{0174}{\^W}
8713 \DeclareUnicodeCharacter{0175}{\^w}
8714 \DeclareUnicodeCharacter{0176}{\^Y}
8715 \DeclareUnicodeCharacter{0177}{\^y}
8716 \DeclareUnicodeCharacter{0178}{\"Y}
8717 \DeclareUnicodeCharacter{0179}{\'Z}
8718 \DeclareUnicodeCharacter{017A}{\'z}
8719 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8720 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8721 \DeclareUnicodeCharacter{017D}{\v{Z}}
8722 \DeclareUnicodeCharacter{017E}{\v{z}}
8724 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8725 \DeclareUnicodeCharacter{01C5}{D\v{z}}
8726 \DeclareUnicodeCharacter{01C6}{d\v{z}}
8727 \DeclareUnicodeCharacter{01C7}{LJ}
8728 \DeclareUnicodeCharacter{01C8}{Lj}
8729 \DeclareUnicodeCharacter{01C9}{lj}
8730 \DeclareUnicodeCharacter{01CA}{NJ}
8731 \DeclareUnicodeCharacter{01CB}{Nj}
8732 \DeclareUnicodeCharacter{01CC}{nj}
8733 \DeclareUnicodeCharacter{01CD}{\v{A}}
8734 \DeclareUnicodeCharacter{01CE}{\v{a}}
8735 \DeclareUnicodeCharacter{01CF}{\v{I}}
8737 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8738 \DeclareUnicodeCharacter{01D1}{\v{O}}
8739 \DeclareUnicodeCharacter{01D2}{\v{o}}
8740 \DeclareUnicodeCharacter{01D3}{\v{U}}
8741 \DeclareUnicodeCharacter{01D4}{\v{u}}
8743 \DeclareUnicodeCharacter{01E2}{\={\AE}}
8744 \DeclareUnicodeCharacter{01E3}{\={\ae}}
8745 \DeclareUnicodeCharacter{01E6}{\v{G}}
8746 \DeclareUnicodeCharacter{01E7}{\v{g}}
8747 \DeclareUnicodeCharacter{01E8}{\v{K}}
8748 \DeclareUnicodeCharacter{01E9}{\v{k}}
8750 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8751 \DeclareUnicodeCharacter{01F1}{DZ}
8752 \DeclareUnicodeCharacter{01F2}{Dz}
8753 \DeclareUnicodeCharacter{01F3}{dz}
8754 \DeclareUnicodeCharacter{01F4}{\'G}
8755 \DeclareUnicodeCharacter{01F5}{\'g}
8756 \DeclareUnicodeCharacter{01F8}{\`N}
8757 \DeclareUnicodeCharacter{01F9}{\`n}
8758 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8759 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8760 \DeclareUnicodeCharacter{01FE}{\'{\O}}
8761 \DeclareUnicodeCharacter{01FF}{\'{\o}}
8763 \DeclareUnicodeCharacter{021E}{\v{H}}
8764 \DeclareUnicodeCharacter{021F}{\v{h}}
8766 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8767 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8768 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8769 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8770 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8771 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8773 \DeclareUnicodeCharacter{0232}{\=Y}
8774 \DeclareUnicodeCharacter{0233}{\=y}
8775 \DeclareUnicodeCharacter{0237}{\dotless{j}}
8777 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
8779 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8780 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8781 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8782 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8783 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8784 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8785 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8786 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8787 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8788 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8789 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8790 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8792 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8793 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8795 \DeclareUnicodeCharacter{1E20}{\=G}
8796 \DeclareUnicodeCharacter{1E21}{\=g}
8797 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8798 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8799 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8800 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8801 \DeclareUnicodeCharacter{1E26}{\"H}
8802 \DeclareUnicodeCharacter{1E27}{\"h}
8804 \DeclareUnicodeCharacter{1E30}{\'K}
8805 \DeclareUnicodeCharacter{1E31}{\'k}
8806 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8807 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8808 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8809 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8810 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8811 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8812 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8813 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8814 \DeclareUnicodeCharacter{1E3E}{\'M}
8815 \DeclareUnicodeCharacter{1E3F}{\'m}
8817 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8818 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8819 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8820 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8821 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8822 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8823 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8824 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8825 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8826 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8828 \DeclareUnicodeCharacter{1E54}{\'P}
8829 \DeclareUnicodeCharacter{1E55}{\'p}
8830 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8831 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8832 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8833 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8834 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8835 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8836 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8837 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8839 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8840 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8841 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8842 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8843 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8844 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8845 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8846 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8847 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8848 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8850 \DeclareUnicodeCharacter{1E7C}{\~V}
8851 \DeclareUnicodeCharacter{1E7D}{\~v}
8852 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8853 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8855 \DeclareUnicodeCharacter{1E80}{\`W}
8856 \DeclareUnicodeCharacter{1E81}{\`w}
8857 \DeclareUnicodeCharacter{1E82}{\'W}
8858 \DeclareUnicodeCharacter{1E83}{\'w}
8859 \DeclareUnicodeCharacter{1E84}{\"W}
8860 \DeclareUnicodeCharacter{1E85}{\"w}
8861 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8862 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8863 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8864 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8865 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8866 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8867 \DeclareUnicodeCharacter{1E8C}{\"X}
8868 \DeclareUnicodeCharacter{1E8D}{\"x}
8869 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8870 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8872 \DeclareUnicodeCharacter{1E90}{\^Z}
8873 \DeclareUnicodeCharacter{1E91}{\^z}
8874 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8875 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8876 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
8877 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
8878 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
8879 \DeclareUnicodeCharacter{1E97}{\"t}
8880 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
8881 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
8883 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
8884 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
8886 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
8887 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
8888 \DeclareUnicodeCharacter{1EBC}{\~E}
8889 \DeclareUnicodeCharacter{1EBD}{\~e}
8891 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
8892 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
8893 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
8894 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
8896 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
8897 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
8899 \DeclareUnicodeCharacter{1EF2}{\`Y}
8900 \DeclareUnicodeCharacter{1EF3}{\`y}
8901 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
8903 \DeclareUnicodeCharacter{1EF8}{\~Y}
8904 \DeclareUnicodeCharacter{1EF9}{\~y}
8906 \DeclareUnicodeCharacter{2013}{--}
8907 \DeclareUnicodeCharacter{2014}{---}
8908 \DeclareUnicodeCharacter{2018}{\quoteleft}
8909 \DeclareUnicodeCharacter{2019}{\quoteright}
8910 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
8911 \DeclareUnicodeCharacter{201C}{\quotedblleft}
8912 \DeclareUnicodeCharacter{201D}{\quotedblright}
8913 \DeclareUnicodeCharacter{201E}{\quotedblbase}
8914 \DeclareUnicodeCharacter{2022}{\bullet}
8915 \DeclareUnicodeCharacter{2026}{\dots}
8916 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
8917 \DeclareUnicodeCharacter{203A}{\guilsinglright}
8918 \DeclareUnicodeCharacter{20AC}{\euro}
8920 \DeclareUnicodeCharacter{2192}{\expansion}
8921 \DeclareUnicodeCharacter{21D2}{\result}
8923 \DeclareUnicodeCharacter{2212}{\minus}
8924 \DeclareUnicodeCharacter{2217}{\point}
8925 \DeclareUnicodeCharacter{2261}{\equiv}
8926 }% end of \utfeightchardefs
8929 % US-ASCII character definitions.
8930 \def\asciichardefs{% nothing need be done
8934 % Make non-ASCII characters printable again for compatibility with
8935 % existing Texinfo documents that may use them, even without declaring a
8936 % document encoding.
8938 \setnonasciicharscatcode \other
8941 \message{formatting,}
8943 \newdimen\defaultparindent \defaultparindent = 15pt
8945 \chapheadingskip = 15pt plus 4pt minus 2pt
8946 \secheadingskip = 12pt plus 3pt minus 2pt
8947 \subsecheadingskip = 9pt plus 2pt minus 2pt
8949 % Prevent underfull vbox error messages.
8952 % Don't be very finicky about underfull hboxes, either.
8955 % Following George Bush, get rid of widows and orphans.
8959 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
8960 % using an old version of TeX, don't do anything. We want the amount of
8961 % stretch added to depend on the line length, hence the dependence on
8962 % \hsize. We call this whenever the paper size is set.
8964 \def\setemergencystretch{%
8965 \ifx\emergencystretch\thisisundefined
8966 % Allow us to assign to \emergencystretch anyway.
8967 \def\emergencystretch{\dimen0}%
8969 \emergencystretch = .15\hsize
8973 % Parameters in order: 1) textheight; 2) textwidth;
8974 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
8975 % 7) physical page height; 8) physical page width.
8977 % We also call \setleading{\textleading}, so the caller should define
8978 % \textleading. The caller should also set \parskip.
8980 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
8983 \splittopskip = \topskip
8986 \advance\vsize by \topskip
8987 \outervsize = \vsize
8988 \advance\outervsize by 2\topandbottommargin
8989 \pageheight = \vsize
8992 \outerhsize = \hsize
8993 \advance\outerhsize by 0.5in
8996 \normaloffset = #4\relax
8997 \bindingoffset = #5\relax
9000 \pdfpageheight #7\relax
9001 \pdfpagewidth #8\relax
9002 % if we don't reset these, they will remain at "1 true in" of
9003 % whatever layout pdftex was dumped with.
9004 \pdfhorigin = 1 true in
9005 \pdfvorigin = 1 true in
9008 \setleading{\textleading}
9010 \parindent = \defaultparindent
9011 \setemergencystretch
9014 % @letterpaper (the default).
9015 \def\letterpaper{{\globaldefs = 1
9016 \parskip = 3pt plus 2pt minus 1pt
9017 \textleading = 13.2pt
9019 % If page is nothing but text, make it come out even.
9020 \internalpagesizes{607.2pt}{6in}% that's 46 lines
9022 {\bindingoffset}{36pt}%
9026 % Use @smallbook to reset parameters for 7x9.25 trim size.
9027 \def\smallbook{{\globaldefs = 1
9028 \parskip = 2pt plus 1pt
9031 \internalpagesizes{7.5in}{5in}%
9033 {\bindingoffset}{16pt}%
9036 \lispnarrowing = 0.3in
9039 \contentsrightmargin = 0pt
9040 \defbodyindent = .5cm
9043 % Use @smallerbook to reset parameters for 6x9 trim size.
9044 % (Just testing, parameters still in flux.)
9045 \def\smallerbook{{\globaldefs = 1
9046 \parskip = 1.5pt plus 1pt
9049 \internalpagesizes{7.4in}{4.8in}%
9054 \lispnarrowing = 0.25in
9057 \contentsrightmargin = 0pt
9058 \defbodyindent = .4cm
9061 % Use @afourpaper to print on European A4 paper.
9062 \def\afourpaper{{\globaldefs = 1
9063 \parskip = 3pt plus 2pt minus 1pt
9064 \textleading = 13.2pt
9066 % Double-side printing via postscript on Laserjet 4050
9067 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9068 % To change the settings for a different printer or situation, adjust
9069 % \normaloffset until the front-side and back-side texts align. Then
9070 % do the same for \bindingoffset. You can set these for testing in
9071 % your texinfo source file like this:
9073 % \global\normaloffset = -6mm
9074 % \global\bindingoffset = 10mm
9076 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9077 {\voffset}{\hoffset}%
9078 {\bindingoffset}{44pt}%
9083 \contentsrightmargin = 0pt
9084 \defbodyindent = 5mm
9087 % Use @afivepaper to print on European A5 paper.
9088 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9089 % He also recommends making @example and @lisp be small.
9090 \def\afivepaper{{\globaldefs = 1
9091 \parskip = 2pt plus 1pt minus 0.1pt
9092 \textleading = 12.5pt
9094 \internalpagesizes{160mm}{120mm}%
9095 {\voffset}{\hoffset}%
9096 {\bindingoffset}{8pt}%
9099 \lispnarrowing = 0.2in
9102 \contentsrightmargin = 0pt
9103 \defbodyindent = 2mm
9107 % A specific text layout, 24x15cm overall, intended for A4 paper.
9108 \def\afourlatex{{\globaldefs = 1
9110 \internalpagesizes{237mm}{150mm}%
9112 {\bindingoffset}{7mm}%
9115 % Must explicitly reset to 0 because we call \afourpaper.
9119 % Use @afourwide to print on A4 paper in landscape format.
9120 \def\afourwide{{\globaldefs = 1
9122 \internalpagesizes{241mm}{165mm}%
9123 {\voffset}{-2.95mm}%
9124 {\bindingoffset}{7mm}%
9129 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9130 % Perhaps we should allow setting the margins, \topskip, \parskip,
9131 % and/or leading, also. Or perhaps we should compute them somehow.
9133 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9134 \def\pagesizesyyy#1,#2,#3\finish{{%
9135 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9138 \parskip = 3pt plus 2pt minus 1pt
9139 \setleading{\textleading}%
9142 \advance\dimen0 by \voffset
9145 \advance\dimen2 by \normaloffset
9147 \internalpagesizes{#1}{\hsize}%
9148 {\voffset}{\normaloffset}%
9149 {\bindingoffset}{44pt}%
9153 % Set default to letter.
9158 \message{and turning on texinfo input format.}
9160 % DEL is a comment character, in case @c does not suffice.
9163 % Define macros to output various characters with catcode for normal text.
9173 \def\normaldoublequote{"}
9176 \def\normalunderscore{_}
9177 \def\normalverticalbar{|}
9179 \def\normalgreater{>}
9181 \def\normaldollar{$}%$ font-lock fix
9183 % This macro is used to make a character print one way in \tt
9184 % (where it can probably be output as-is), and another way in other fonts,
9185 % where something hairier probably needs to be done.
9187 % #1 is what to print if we are indeed using \tt; #2 is what to print
9188 % otherwise. Since all the Computer Modern typewriter fonts have zero
9189 % interword stretch (and shrink), and it is reasonable to expect all
9190 % typewriter fonts to have this, we can check that font parameter.
9192 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9194 % Same as above, but check for italic font. Actually this also catches
9195 % non-italic slanted fonts since it is impossible to distinguish them from
9196 % italic fonts. But since this is only used by $ and it uses \sl anyway
9197 % this is not a problem.
9198 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9200 % Turn off all special characters except @
9201 % (and those which the user can use as if they were ordinary).
9202 % Most of these we simply print from the \tt font, but for some, we can
9203 % use math or other variants that look better in normal text.
9206 \def\activedoublequote{{\tt\char34}}
9207 \let"=\activedoublequote
9209 \def~{{\tt\char126}}
9215 \def_{\ifusingtt\normalunderscore\_}
9217 % Subroutine for the previous macro.
9218 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9221 \def|{{\tt\char124}}
9229 \def+{{\tt \char 43}}
9231 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9233 % If a .fmt file is being used, characters that might appear in a file
9234 % name cannot be active until we have parsed the command line.
9235 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9236 % \otherifyactive is called near the end of this file.
9237 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9239 % Used sometimes to turn off (effectively) the active characters even after
9241 \def\turnoffactive{%
9242 \normalturnoffactive
9248 % \backslashcurfont outputs one backslash character in current font,
9250 \global\chardef\backslashcurfont=`\\
9251 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
9253 % \realbackslash is an actual character `\' with catcode other, and
9254 % \doublebackslash is two of them (for the pdf outlines).
9255 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9257 % In texinfo, backslash is an active character; it prints the backslash
9258 % in fixed width font.
9260 @def@normalbackslash{{@tt@backslashcurfont}}
9261 % On startup, @fixbackslash assigns:
9262 % @let \ = @normalbackslash
9264 % \rawbackslash defines an active \ to do \backslashcurfont.
9265 % \otherbackslash defines an active \ to be a literal `\' character with
9267 @gdef@rawbackslash{@let\=@backslashcurfont}
9268 @gdef@otherbackslash{@let\=@realbackslash}
9270 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9271 % the literal character `\'.
9273 @def@normalturnoffactive{%
9274 @let\=@normalbackslash
9275 @let"=@normaldoublequote
9278 @let_=@normalunderscore
9279 @let|=@normalverticalbar
9281 @let>=@normalgreater
9283 @let$=@normaldollar %$ font-lock fix
9284 @markupsetuplqdefault
9285 @markupsetuprqdefault
9289 % Make _ and + \other characters, temporarily.
9290 % This is canceled by @fixbackslash.
9293 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9294 % That is what \eatinput is for; after that, the `\' should revert to printing
9297 @gdef@eatinput input texinfo{@fixbackslash}
9298 @global@let\ = @eatinput
9300 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
9301 % the first `\' in the file would cause an error. This macro tries to fix
9302 % that, assuming it is called before the first `\' could plausibly occur.
9303 % Also turn back on active characters that might appear in the input
9304 % file name, in case not using a pre-dumped format.
9306 @gdef@fixbackslash{%
9307 @ifx\@eatinput @let\ = @normalbackslash @fi
9312 % Say @foo, not \foo, in error messages.
9315 % These look ok in all fonts, so just make them not special.
9316 @catcode`@& = @other
9317 @catcode`@# = @other
9318 @catcode`@% = @other
9320 @c Finally, make ` and ' active, so that txicodequoteundirected and
9321 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
9322 @c don't make ` and ' active, @code will not get them as active chars.
9323 @c Do this last of all since we use ` in the previous @catcode assignments.
9326 @markupsetuplqdefault
9327 @markupsetuprqdefault
9330 @c eval: (add-hook 'write-file-hooks 'time-stamp)
9331 @c page-delimiter: "^\\\\message"
9332 @c time-stamp-start: "def\\\\texinfoversion{"
9333 @c time-stamp-format: "%:y-%02m-%02d.%02H"
9334 @c time-stamp-end: "}"
9340 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115