1 % texinfo.tex -- TeX macros to handle Texinfo files.
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
6 \def\texinfoversion{2012-02-28.16}
8 % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007, 2008, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
12 % This texinfo.tex file is free software: you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation, either version 3 of the
15 % License, or (at your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this program. If not, see <http://www.gnu.org/licenses/>.
25 % As a special exception, when this file is read by TeX when processing
26 % a Texinfo source document, you may use the result without
27 % restriction. (This has been our intent since Texinfo was invented.)
29 % Please try the latest version of texinfo.tex before submitting bug
30 % reports; you can get the latest version from:
31 % http://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\putworderror\undefined \gdef\putworderror{error}\fi
120 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
121 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
122 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
123 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
124 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
125 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
126 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
127 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
128 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
129 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
130 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
131 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
132 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
133 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
134 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
135 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
136 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
138 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
139 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
140 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
141 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
142 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
143 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
144 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
145 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
146 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
147 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
148 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
149 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
151 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
152 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
153 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
154 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
155 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
157 % Since the category of space is not known, we have to be careful.
158 \chardef\spacecat = 10
159 \def\spaceisspace{\catcode`\ =\spacecat}
161 % sometimes characters are active, so we need control sequences.
162 \chardef\ampChar = `\&
163 \chardef\colonChar = `\:
164 \chardef\commaChar = `\,
165 \chardef\dashChar = `\-
166 \chardef\dotChar = `\.
167 \chardef\exclamChar= `\!
168 \chardef\hashChar = `\#
169 \chardef\lquoteChar= `\`
170 \chardef\questChar = `\?
171 \chardef\rquoteChar= `\'
172 \chardef\semiChar = `\;
173 \chardef\slashChar = `\/
174 \chardef\underChar = `\_
180 % The following is used inside several \edef's.
181 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
185 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
186 ap-pen-dix bit-map bit-maps
187 data-base data-bases eshell fall-ing half-way long-est man-u-script
188 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
189 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
191 stand-alone strong-est time-stamp time-stamps which-ever white-space
192 wide-spread wrap-around
195 % Margin to add to right of even pages, to left of odd pages.
196 \newdimen\bindingoffset
197 \newdimen\normaloffset
198 \newdimen\pagewidth \newdimen\pageheight
200 % For a final copy, take out the rectangles
201 % that mark overfull boxes (in case you have decided
202 % that the text looks ok even though it passes the margin).
204 \def\finalout{\overfullrule=0pt }
206 % Sometimes it is convenient to have everything in the transcript file
207 % and nothing on the terminal. We don't just call \tracingall here,
208 % since that produces some useless output on the terminal. We also make
209 % some effort to order the tracing commands to reduce output in the log
210 % file; cf. trace.sty in LaTeX.
212 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
216 \tracinglostchars2 % 2 gives us more in etex
221 \showboxbreadth\maxdimen \showboxdepth\maxdimen
222 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
229 \tracingcommands3 % 3 gives us more in etex
233 % @errormsg{MSG}. Do the index-like expansions on MSG, but if things
234 % aren't perfect, it's not the end of the world, being an error message,
237 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
238 \def\doerrormsg#1{\errmessage{#1}}
240 % add check for \lastpenalty to plain's definitions. If the last thing
241 % we did was a \nobreak, we don't want to insert more space.
243 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
244 \removelastskip\penalty-50\smallskip\fi\fi}
245 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
246 \removelastskip\penalty-100\medskip\fi\fi}
247 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
248 \removelastskip\penalty-200\bigskip\fi\fi}
250 % Do @cropmarks to get crop marks.
253 \let\cropmarks = \cropmarkstrue
255 % Dimensions to add cropmarks at corners.
256 % Added by P. A. MacKay, 12 Nov. 1986
258 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
259 \newdimen\cornerlong \cornerlong=1pc
260 \newdimen\cornerthick \cornerthick=.3pt
261 \newdimen\topandbottommargin \topandbottommargin=.75in
263 % Output a mark which sets \thischapter, \thissection and \thiscolor.
264 % We dump everything together because we only have one kind of mark.
265 % This works because we only use \botmark / \topmark, not \firstmark.
267 % A mark contains a subexpression of the \ifcase ... \fi construct.
268 % \get*marks macros below extract the needed part using \ifcase.
270 % Another complication is to let the user choose whether \thischapter
271 % (\thissection) refers to the chapter (section) in effect at the top
272 % of a page, or that at the bottom of a page. The solution is
273 % described on page 260 of The TeXbook. It involves outputting two
274 % marks for the sectioning macros, one before the section break, and
275 % one after. I won't pretend I can describe this better than DEK...
277 \toks0=\expandafter{\lastchapterdefs}%
278 \toks2=\expandafter{\lastsectiondefs}%
279 \toks4=\expandafter{\prevchapterdefs}%
280 \toks6=\expandafter{\prevsectiondefs}%
281 \toks8=\expandafter{\lastcolordefs}%
283 \the\toks0 \the\toks2
284 \noexpand\or \the\toks4 \the\toks6
285 \noexpand\else \the\toks8
288 % \topmark doesn't work for the very first chapter (after the title
289 % page or the contents), so we use \firstmark there -- this gets us
290 % the mark with the chapter defs, unless the user sneaks in, e.g.,
291 % @setcolor (or @url, or @link, etc.) between @contents and the very
293 \def\gettopheadingmarks{%
295 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
297 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
298 \def\getcolormarks{\ifcase2\topmark\fi}
300 % Avoid "undefined control sequence" errors.
301 \def\lastchapterdefs{}
302 \def\lastsectiondefs{}
303 \def\prevchapterdefs{}
304 \def\prevsectiondefs{}
307 % Main output routine.
309 \output = {\onepageout{\pagecontents\PAGE}}
314 % \onepageout takes a vbox as an argument. Note that \pagecontents
315 % does insertions, but you have to call it yourself.
317 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
319 \ifodd\pageno \advance\hoffset by \bindingoffset
320 \else \advance\hoffset by -\bindingoffset\fi
322 % Do this outside of the \shipout so @code etc. will be expanded in
323 % the headline as they should be, not taken literally (outputting ''code).
324 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
325 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
326 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
327 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
330 % Have to do this stuff outside the \shipout because we want it to
331 % take effect in \write's, yet the group defined by the \vbox ends
332 % before the \shipout runs.
334 \indexdummies % don't expand commands in the output.
335 \normalturnoffactive % \ in index entries must not stay \, e.g., if
336 % the page break happens to be in the middle of an example.
337 % We don't want .vr (or whatever) entries like this:
338 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
339 % "\acronym" won't work when it's read back in;
341 % {\code {{\tt \backslashcurfont }acronym}
343 % Do this early so pdf references go to the beginning of the page.
344 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
346 \ifcropmarks \vbox to \outervsize\bgroup
348 \vskip-\topandbottommargin
350 \line{\ewtop\hfil\ewtop}%
353 \vbox{\moveleft\cornerthick\nstop}%
355 \vbox{\moveright\cornerthick\nstop}%
358 \vskip\topandbottommargin
360 \hfil % center the page within the outer (page) hsize.
361 \ifodd\pageno\hskip\bindingoffset\fi
367 \ifdim\ht\footlinebox > 0pt
368 % Only leave this space if the footline is nonempty.
369 % (We lessened \vsize for it in \oddfootingyyy.)
370 % The \baselineskip=24pt in plain's \makefootline has no effect.
376 \egroup % end of \vbox\bgroup
377 \hfil\egroup % end of (centering) \line\bgroup
378 \vskip\topandbottommargin plus1fill minus1fill
379 \boxmaxdepth = \cornerthick
382 \vbox{\moveleft\cornerthick\nsbot}%
384 \vbox{\moveright\cornerthick\nsbot}%
387 \line{\ewbot\hfil\ewbot}%
389 \egroup % \vbox from first cropmarks clause
391 }% end of \shipout\vbox
392 }% end of group with \indexdummies
394 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
397 \newinsert\margin \dimen\margin=\maxdimen
399 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
401 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
402 % marginal hacks, juha@viisa.uucp (Juha Takala)
403 \ifvoid\margin\else % marginal info is present
404 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
405 \dimen@=\dp#1\relax \unvbox#1\relax
406 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
407 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
410 % Here are the rules for the cropmarks. Note that they are
411 % offset so that the space between them is truly \outerhsize or \outervsize
412 % (P. A. MacKay, 12 November, 1986)
414 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
416 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
417 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
419 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
421 % Parse an argument, then pass it to #1. The argument is the rest of
422 % the input line (except we remove a trailing comment). #1 should be a
423 % macro which expects an ordinary undelimited TeX argument.
425 \def\parsearg{\parseargusing{}}
426 \def\parseargusing#1#2{%
432 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
436 \gdef\parseargline#1^^M{%
437 \endgroup % End of the group started in \parsearg.
438 \argremovecomment #1\comment\ArgTerm%
442 % First remove any @comment, then any @c comment.
443 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
444 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
446 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
448 % \argremovec might leave us with trailing space, e.g.,
449 % @end itemize @c foo
450 % This space token undergoes the same procedure and is eventually removed
451 % by \finishparsearg.
453 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
454 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
455 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
458 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
459 \let\temp\finishparsearg
461 \let\temp\argcheckspaces
463 % Put the space token in:
467 % If a _delimited_ argument is enclosed in braces, they get stripped; so
468 % to get _exactly_ the rest of the line, we had to prevent such situation.
469 % We prepended an \empty token at the very beginning and we expand it now,
470 % just before passing the control to \argtorun.
471 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
472 % either the null string, or it ends with \^^M---thus there is no danger
473 % that a pair of braces would be stripped.
475 % But first, we have to remove the trailing space token.
477 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
479 % \parseargdef\foo{...}
480 % is roughly equivalent to
481 % \def\foo{\parsearg\Xfoo}
484 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
485 % favourite TeX trick. --kasal, 16nov03
488 \expandafter \doparseargdef \csname\string#1\endcsname #1%
490 \def\doparseargdef#1#2{%
495 % Several utility definitions with active space:
500 % Make each space character in the input produce a normal interword
501 % space in the output. Don't allow a line break at this space, as this
502 % is used only in environments like @example, where each line of input
503 % should produce a line of output anyway.
505 \gdef\sepspaces{\obeyspaces\let =\tie}
507 % If an index command is used in an @example environment, any spaces
508 % therein should become regular spaces in the raw index file, not the
509 % expansion of \tie (\leavevmode \penalty \@M \ ).
510 \gdef\unsepspaces{\let =\space}
514 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
516 % Define the framework for environments in texinfo.tex. It's used like this:
521 % It's the responsibility of \envdef to insert \begingroup before the
522 % actual body; @end closes the group after calling \Efoo. \envdef also
523 % defines \thisenv, so the current environment is known; @end checks
524 % whether the environment name matches. The \checkenv macro can also be
525 % used to check whether the current environment is the one expected.
527 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
528 % are not treated as environments; they don't open a group. (The
529 % implementation of @end takes care not to call \endgroup in this
533 % At run-time, environments start with this:
534 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
538 % ... but they get defined via ``\envdef\foo{...}'':
539 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
540 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
542 % Check whether we're in the right environment:
551 % Environment mismatch, #1 expected:
554 \errmessage{This command can appear only \inenvironment\temp,
555 not \inenvironment\thisenv}%
557 \def\inenvironment#1{%
559 outside of any environment%
561 in environment \expandafter\string#1%
565 % @end foo executes the definition of \Efoo.
566 % But first, it executes a specialized version of \checkenv
569 \if 1\csname iscond.#1\endcsname
571 % The general wording of \badenverr may not be ideal.
572 \expandafter\checkenv\csname#1\endcsname
573 \csname E#1\endcsname
578 \newhelp\EMsimple{Press RETURN to continue.}
581 % Be sure we're in horizontal mode when doing a tie, since we make space
582 % equivalent to this in @example-like environments. Otherwise, a space
583 % at the beginning of a line will start with \penalty -- and
584 % since \penalty is valid in vertical mode, we'd end up putting the
585 % penalty on the vertical list instead of in the new paragraph.
587 % Avoid using \@M directly, because that causes trouble
588 % if the definition is written into an index file.
589 \global\let\tiepenalty = \@M
590 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
593 % @: forces normal size whitespace following.
594 \def\:{\spacefactor=1000 }
596 % @* forces a line break.
597 \def\*{\hfil\break\hbox{}\ignorespaces}
599 % @/ allows a line break.
602 % @. is an end-of-sentence period.
603 \def\.{.\spacefactor=\endofsentencespacefactor\space}
605 % @! is an end-of-sentence bang.
606 \def\!{!\spacefactor=\endofsentencespacefactor\space}
608 % @? is an end-of-sentence query.
609 \def\?{?\spacefactor=\endofsentencespacefactor\space}
611 % @frenchspacing on|off says whether to put extra space after punctuation.
616 \parseargdef\frenchspacing{%
618 \ifx\temp\onword \plainfrenchspacing
619 \else\ifx\temp\offword \plainnonfrenchspacing
622 \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
626 % @w prevents a word break. Without the \leavevmode, @w at the
627 % beginning of a paragraph, when TeX is still in vertical mode, would
628 % produce a whole line of output instead of starting the paragraph.
629 \def\w#1{\leavevmode\hbox{#1}}
631 % @group ... @end group forces ... to be all on one page, by enclosing
632 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
633 % to keep its height that of a normal line. According to the rules for
634 % \topskip (p.114 of the TeXbook), the glue inserted is
635 % max (\topskip - \ht (first item), 0). If that height is large,
636 % therefore, no glue is inserted, and the space between the headline and
637 % the text is small, which looks bad.
639 % Another complication is that the group might be very large. This can
640 % cause the glue on the previous page to be unduly stretched, because it
641 % does not have much material. In this case, it's better to add an
642 % explicit \vfill so that the extra space is at the bottom. The
643 % threshold for doing this is if the group is more than \vfilllimit
644 % percent of a page (\vfilllimit can be changed inside of @tex).
650 \ifnum\catcode`\^^M=\active \else
651 \errhelp = \groupinvalidhelp
652 \errmessage{@group invalid in context where filling is enabled}%
656 \setbox\groupbox = \vtop\bgroup
657 % Do @comment since we are called inside an environment such as
658 % @example, where each end-of-line in the input causes an
659 % end-of-line in the output. We don't want the end-of-line after
660 % the `@group' to put extra space in the output. Since @group
661 % should appear on a line by itself (according to the Texinfo
662 % manual), we don't worry about eating any user text.
666 % The \vtop produces a box with normal height and large depth; thus, TeX puts
667 % \baselineskip glue before it, and (when the next line of text is done)
668 % \lineskip glue after it. Thus, space below is not quite equal to space
669 % above. But it's pretty close.
671 % To get correct interline space between the last line of the group
672 % and the first line afterwards, we have to propagate \prevdepth.
673 \endgraf % Not \par, as it may have been set to \lisppar.
674 \global\dimen1 = \prevdepth
675 \egroup % End the \vtop.
676 % \dimen0 is the vertical size of the group's box.
677 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
678 % \dimen2 is how much space is left on the page (more or less).
679 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
680 % if the group doesn't fit on the current page, and it's a big big
681 % group, force a page break.
682 \ifdim \dimen0 > \dimen2
683 \ifdim \pagetotal < \vfilllimit\pageheight
692 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
693 % message, so this ends up printing `@group can only ...'.
695 \newhelp\groupinvalidhelp{%
696 group can only be used in environments such as @example,^^J%
697 where each line of input produces a line of output.}
699 % @need space-in-mils
700 % forces a page break if there is not space-in-mils remaining.
702 \newdimen\mil \mil=0.001in
705 % Ensure vertical mode, so we don't make a big box in the middle of a
709 % If the @need value is less than one line space, it's useless.
711 \dimen2 = \ht\strutbox
712 \advance\dimen2 by \dp\strutbox
713 \ifdim\dimen0 > \dimen2
715 % Do a \strut just to make the height of this box be normal, so the
716 % normal leading is inserted relative to the preceding line.
717 % And a page break here is fine.
718 \vtop to #1\mil{\strut\vfil}%
720 % TeX does not even consider page breaks if a penalty added to the
721 % main vertical list is 10000 or more. But in order to see if the
722 % empty box we just added fits on the page, we must make it consider
723 % page breaks. On the other hand, we don't want to actually break the
724 % page after the empty box. So we use a penalty of 9999.
726 % There is an extremely small chance that TeX will actually break the
727 % page at this \penalty, if there are no other feasible breakpoints in
728 % sight. (If the user is using lots of big @group commands, which
729 % almost-but-not-quite fill up a page, TeX will have a hard time doing
730 % good page breaking, for example.) However, I could not construct an
731 % example where a page broke at this \penalty; if it happens in a real
732 % document, then we can reconsider our strategy.
735 % Back up by the size of the box, whether we did a page break or not.
738 % Do not allow a page break right after this kern.
743 % @br forces paragraph break (and is undocumented).
747 % @page forces the start of a new page.
749 \def\page{\par\vfill\supereject}
752 % outputs text on separate line in roman font, starting at standard page margin
754 % This records the amount of indent in the innermost environment.
755 % That's how much \exdent should take out.
756 \newskip\exdentamount
758 % This defn is used inside fill environments such as @defun.
759 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
761 % This defn is used inside nofill environments such as @example.
762 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
763 \leftline{\hskip\leftskip{\rm#1}}}}
765 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
766 % paragraph. For more general purposes, use the \margin insertion
767 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
769 \newskip\inmarginspacing \inmarginspacing=1cm
770 \def\strutdepth{\dp\strutbox}
772 \def\doinmargin#1#2{\strut\vadjust{%
775 \vtop to \strutdepth{%
776 \baselineskip=\strutdepth
778 % if you have multiple lines of stuff to put here, you'll need to
779 % make the vbox yourself of the appropriate size.
781 \llap{\ignorespaces #2\hskip\inmarginspacing}%
783 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
788 \def\inleftmargin{\doinmargin l}
789 \def\inrightmargin{\doinmargin r}
791 % @inmargin{TEXT [, RIGHT-TEXT]}
792 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
793 % else use TEXT for both).
795 \def\inmargin#1{\parseinmargin #1,,\finish}
796 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
797 \setbox0 = \hbox{\ignorespaces #2}%
799 \def\lefttext{#1}% have both texts
802 \def\lefttext{#1}% have only one text
807 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
809 \def\temp{\inleftmargin\lefttext}%
814 % @| inserts a changebar to the left of the current line. It should
815 % surround any changed text. This approach does *not* work if the
816 % change spans more than two lines of output. To handle that, we would
817 % have adopt a much more difficult approach (putting marks into the main
818 % vertical list for the beginning and end of each change). This command
819 % is not documented, not supported, and doesn't work.
822 % \vadjust can only be used in horizontal mode.
825 % Append this vertical mode material after the current line in the output.
827 % We want to insert a rule with the height and depth of the current
828 % leading; that is exactly what \strutbox is supposed to record.
831 % \vadjust-items are inserted at the left edge of the type. So
832 % the \llap here moves out into the left-hand margin.
835 % For a thicker or thinner bar, change the `1pt'.
836 \vrule height\baselineskip width1pt
838 % This is the space between the bar and the text.
844 % @include FILE -- \input text of FILE.
846 \def\include{\parseargusing\filenamecatcodes\includezzz}
851 \makevalueexpandable % we want to expand any @value in FILE.
852 \turnoffactive % and allow special characters in the expansion
853 \indexnofonts % Allow `@@' and other weird things in file names.
854 \wlog{texinfo.tex: doing @include of #1^^J}%
855 \edef\temp{\noexpand\input #1 }%
857 % This trickery is to read FILE outside of a group, in case it makes
863 \def\filenamecatcodes{%
877 \def\pushthisfilestack{%
878 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
880 \def\pushthisfilestackX{%
881 \expandafter\pushthisfilestackY\thisfile\StackTerm
883 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
884 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
887 \def\popthisfilestack{\errthisfilestackempty}
888 \def\errthisfilestackempty{\errmessage{Internal error:
889 the stack of filenames is empty.}}
894 % outputs that line, centered.
896 \parseargdef\center{%
898 \let\centersub\centerH
900 \let\centersub\centerV
902 \centersub{\hfil \ignorespaces#1\unskip \hfil}%
903 \let\centersub\relax % don't let the definition persist, just in case
907 \advance\hsize by -\leftskip
908 \advance\hsize by -\rightskip
913 \newcount\centerpenalty
915 % The idea here is the same as in \startdefun, \cartouche, etc.: if
916 % @center is the first thing after a section heading, we need to wipe
917 % out the negative parskip inserted by \sectionheading, but still
918 % prevent a page break here.
919 \centerpenalty = \lastpenalty
920 \ifnum\centerpenalty>10000 \vskip\parskip \fi
921 \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi
922 \line{\kern\leftskip #1\kern\rightskip}%
925 % @sp n outputs n lines of vertical space
927 \parseargdef\sp{\vskip #1\baselineskip}
929 % @comment ...line which is ignored...
930 % @c is the same as @comment
931 % @ignore ... @end ignore is another way to write a comment
933 \def\comment{\begingroup \catcode`\^^M=\other%
934 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
936 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
940 % @paragraphindent NCHARS
941 % We'll use ems for NCHARS, close enough.
942 % NCHARS can also be the word `asis' or `none'.
943 % We cannot feasibly implement @paragraphindent asis, though.
945 \def\asisword{asis} % no translation, these are keywords
948 \parseargdef\paragraphindent{%
953 \defaultparindent = 0pt
955 \defaultparindent = #1em
958 \parindent = \defaultparindent
961 % @exampleindent NCHARS
962 % We'll use ems for NCHARS like @paragraphindent.
963 % It seems @exampleindent asis isn't necessary, but
964 % I preserve it to make it similar to @paragraphindent.
965 \parseargdef\exampleindent{%
972 \lispnarrowing = #1em
977 % @firstparagraphindent WORD
978 % If WORD is `none', then suppress indentation of the first paragraph
979 % after a section heading. If WORD is `insert', then do indent at such
982 % The paragraph indentation is suppressed or not by calling
983 % \suppressfirstparagraphindent, which the sectioning commands do.
984 % We switch the definition of this back and forth according to WORD.
985 % By default, we suppress indentation.
987 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
988 \def\insertword{insert}
990 \parseargdef\firstparagraphindent{%
993 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
994 \else\ifx\temp\insertword
995 \let\suppressfirstparagraphindent = \relax
998 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1002 % Here is how we actually suppress indentation. Redefine \everypar to
1003 % \kern backwards by \parindent, and then reset itself to empty.
1005 % We also make \indent itself not actually do anything until the next
1008 \gdef\dosuppressfirstparagraphindent{%
1010 \restorefirstparagraphindent
1014 \restorefirstparagraphindent
1017 \global\everypar = {%
1019 \restorefirstparagraphindent
1023 \gdef\restorefirstparagraphindent{%
1024 \global \let \indent = \ptexindent
1025 \global \let \noindent = \ptexnoindent
1026 \global \everypar = {}%
1030 % @refill is a no-op.
1033 % If working on a large document in chapters, it is convenient to
1034 % be able to disable indexing, cross-referencing, and contents, for test runs.
1035 % This is done with @novalidate (before @setfilename).
1037 \newif\iflinks \linkstrue % by default we want the aux files.
1038 \let\novalidate = \linksfalse
1040 % @setfilename is done at the beginning of every texinfo file.
1041 % So open here the files we need to have open while reading the input.
1042 % This makes it possible to make a .fmt file for texinfo.
1044 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1047 % Open the new aux file. TeX will close it automatically at exit.
1048 \immediate\openout\auxfile=\jobname.aux
1049 \fi % \openindices needs to do some work in any case.
1051 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1053 % If texinfo.cnf is present on the system, read it.
1054 % Useful for site-wide @afourpaper, etc.
1055 \openin 1 texinfo.cnf
1056 \ifeof 1 \else \input texinfo.cnf \fi
1059 \comment % Ignore the actual filename.
1062 % Called from \setfilename.
1074 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1078 % adobe `portable' document format
1082 \newcount\filenamelength
1091 \newif\ifpdfmakepagedest
1093 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1094 % can be set). So we test for \relax and 0 as well as being undefined.
1095 \ifx\pdfoutput\thisisundefined
1097 \ifx\pdfoutput\relax
1106 % PDF uses PostScript string constants for the names of xref targets,
1107 % for display in the outlines, and in other places. Thus, we have to
1108 % double any backslashes. Otherwise, a name like "\node" will be
1109 % interpreted as a newline (\n), followed by o, d, e. Not good.
1111 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1112 % related messages. The final outcome is that it is up to the TeX user
1113 % to double the backslashes and otherwise make the string valid, so
1114 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1115 % do this reliably, so we use it.
1117 % #1 is a control sequence in which to do the replacements,
1119 \def\txiescapepdf#1{%
1120 \ifx\pdfescapestring\relax
1121 % No primitive available; should we give a warning or log?
1122 % Many times it won't matter.
1124 % The expandable \pdfescapestring primitive escapes parentheses,
1125 % backslashes, and other special chars.
1126 \xdef#1{\pdfescapestring{#1}}%
1130 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1131 with PDF output, and none of those formats could be found. (.eps cannot
1132 be supported due to the design of the PDF format; use regular TeX (DVI
1137 % Color manipulation macros based on pdfcolor.tex,
1138 % except using rgb instead of cmyk; the latter is said to render as a
1139 % very dark gray on-screen and a very dark halftone in print, instead
1141 \def\rgbDarkRed{0.50 0.09 0.12}
1142 \def\rgbBlack{0 0 0}
1144 % k sets the color for filling (usual text, etc.);
1145 % K sets the color for stroking (thin rules, e.g., normal _'s).
1146 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1148 % Set color, and create a mark which defines \thiscolor accordingly,
1149 % so that \makeheadline knows which color to restore.
1151 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1156 \def\maincolor{\rgbBlack}
1157 \pdfsetcolor{\maincolor}
1158 \edef\thiscolor{\maincolor}
1159 \def\lastcolordefs{}
1163 \line{\pdfsetcolor{\maincolor}\the\footline}%
1171 % Extract \thiscolor definition from the marks.
1173 % Typeset the headline with \maincolor, then restore the color.
1174 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1182 \pdfcatalog{/PageMode /UseOutlines}
1184 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1185 \def\dopdfimage#1#2#3{%
1186 \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1187 \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1189 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1190 % others). Let's try in that order, PDF first since if
1191 % someone has a scalable image, presumably better to use that than a
1193 \let\pdfimgext=\empty
1195 \openin 1 #1.pdf \ifeof 1
1196 \openin 1 #1.PDF \ifeof 1
1197 \openin 1 #1.png \ifeof 1
1198 \openin 1 #1.jpg \ifeof 1
1199 \openin 1 #1.jpeg \ifeof 1
1200 \openin 1 #1.JPG \ifeof 1
1201 \errhelp = \nopdfimagehelp
1202 \errmessage{Could not find image file #1 for pdf}%
1203 \else \gdef\pdfimgext{JPG}%
1205 \else \gdef\pdfimgext{jpeg}%
1207 \else \gdef\pdfimgext{jpg}%
1209 \else \gdef\pdfimgext{png}%
1211 \else \gdef\pdfimgext{PDF}%
1213 \else \gdef\pdfimgext{pdf}%
1218 % without \immediate, ancient pdftex seg faults when the same image is
1219 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1220 \ifnum\pdftexversion < 14
1223 \immediate\pdfximage
1225 \ifdim \wd0 >0pt width \pdfimagewidth \fi
1226 \ifdim \wd2 >0pt height \pdfimageheight \fi
1227 \ifnum\pdftexversion<13
1232 \ifnum\pdftexversion < 14 \else
1233 \pdfrefximage \pdflastximage
1237 % We have to set dummies so commands such as @code, and characters
1238 % such as \, aren't expanded when present in a section title.
1241 \makevalueexpandable
1242 \def\pdfdestname{#1}%
1243 \txiescapepdf\pdfdestname
1244 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1247 % used to mark target names; must be expandable.
1250 % by default, use a color that is dark enough to print on paper as
1251 % nearly black, but still distinguishable for online viewing.
1252 \def\urlcolor{\rgbDarkRed}
1253 \def\linkcolor{\rgbDarkRed}
1254 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1256 % Adding outlines to PDF; macros for calculating structure of outlines
1257 % come from Petr Olsak
1258 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1259 \else \csname#1\endcsname \fi}
1260 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1261 \advance\tempnum by 1
1262 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1264 % #1 is the section text, which is what will be displayed in the
1265 % outline by the pdf viewer. #2 is the pdf expression for the number
1266 % of subentries (or empty, for subsubsections). #3 is the node text,
1267 % which might be empty if this toc entry had no corresponding node.
1268 % #4 is the page number
1270 \def\dopdfoutline#1#2#3#4{%
1271 % Generate a link to the node text if that exists; else, use the
1272 % page number. We could generate a destination for the section
1273 % text in the case where a section has no node, but it doesn't
1274 % seem worth the trouble, since most documents are normally structured.
1275 \edef\pdfoutlinedest{#3}%
1276 \ifx\pdfoutlinedest\empty
1277 \def\pdfoutlinedest{#4}%
1279 \txiescapepdf\pdfoutlinedest
1282 % Also escape PDF chars in the display string.
1283 \edef\pdfoutlinetext{#1}%
1284 \txiescapepdf\pdfoutlinetext
1286 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1289 \def\pdfmakeoutlines{%
1291 % Read toc silently, to get counts of subentries for \pdfoutline.
1292 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1293 \def\numchapentry##1##2##3##4{%
1294 \def\thischapnum{##2}%
1296 \def\thissubsecnum{0}%
1298 \def\numsecentry##1##2##3##4{%
1299 \advancenumber{chap\thischapnum}%
1300 \def\thissecnum{##2}%
1301 \def\thissubsecnum{0}%
1303 \def\numsubsecentry##1##2##3##4{%
1304 \advancenumber{sec\thissecnum}%
1305 \def\thissubsecnum{##2}%
1307 \def\numsubsubsecentry##1##2##3##4{%
1308 \advancenumber{subsec\thissubsecnum}%
1310 \def\thischapnum{0}%
1312 \def\thissubsecnum{0}%
1314 % use \def rather than \let here because we redefine \chapentry et
1315 % al. a second time, below.
1316 \def\appentry{\numchapentry}%
1317 \def\appsecentry{\numsecentry}%
1318 \def\appsubsecentry{\numsubsecentry}%
1319 \def\appsubsubsecentry{\numsubsubsecentry}%
1320 \def\unnchapentry{\numchapentry}%
1321 \def\unnsecentry{\numsecentry}%
1322 \def\unnsubsecentry{\numsubsecentry}%
1323 \def\unnsubsubsecentry{\numsubsubsecentry}%
1326 % Read toc second time, this time actually producing the outlines.
1327 % The `-' means take the \expnumber as the absolute number of
1328 % subentries, which we calculated on our first read of the .toc above.
1330 % We use the node names as the destinations.
1331 \def\numchapentry##1##2##3##4{%
1332 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1333 \def\numsecentry##1##2##3##4{%
1334 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1335 \def\numsubsecentry##1##2##3##4{%
1336 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1337 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1338 \dopdfoutline{##1}{}{##3}{##4}}%
1340 % PDF outlines are displayed using system fonts, instead of
1341 % document fonts. Therefore we cannot use special characters,
1342 % since the encoding is unknown. For example, the eogonek from
1343 % Latin 2 (0xea) gets translated to a | character. Info from
1344 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1346 % TODO this right, we have to translate 8-bit characters to
1347 % their "best" equivalent, based on the @documentencoding. Too
1348 % much work for too little return. Just use the ASCII equivalents
1349 % we use for the index sort strings.
1353 % We can have normal brace characters in the PDF outlines, unlike
1354 % Texinfo index files. So set that up.
1355 \def\{{\lbracecharliteral}%
1356 \def\}{\rbracecharliteral}%
1357 \catcode`\\=\active \otherbackslash
1358 \input \tocreadfilename
1361 {\catcode`[=1 \catcode`]=2
1362 \catcode`{=\other \catcode`}=\other
1363 \gdef\lbracecharliteral[{]%
1364 \gdef\rbracecharliteral[}]%
1367 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1368 \ifx\PP\D\let\nextsp\relax
1369 \else\let\nextsp\skipspaces
1370 \ifx\p\space\else\addtokens{\filename}{\PP}%
1371 \advance\filenamelength by 1
1375 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1376 \ifnum\pdftexversion < 14
1377 \let \startlink \pdfannotlink
1379 \let \startlink \pdfstartlink
1381 % make a live url in pdf output.
1384 % it seems we really need yet another set of dummies; have not
1385 % tried to figure out what each command should do in the context
1386 % of @url. for now, just make @/ a no-op, that's the only one
1387 % people have actually reported a problem with.
1389 \normalturnoffactive
1392 \makevalueexpandable
1393 % do we want to go so far as to use \indexnofonts instead of just
1394 % special-casing \var here?
1397 \leavevmode\setcolor{\urlcolor}%
1398 \startlink attr{/Border [0 0 0]}%
1399 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1401 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1402 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1403 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1404 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1406 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1408 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1409 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1410 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1412 \ifnum0=\countA\else\makelink\fi
1413 \ifx\first.\let\next=\done\else
1415 \addtokens{\toksB}{\the\toksD}
1416 \ifx\first,\addtokens{\toksB}{\space}\fi
1418 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1420 \def\makelink{\addtokens{\toksB}%
1421 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1423 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1424 \setcolor{\linkcolor}#1\endlink}
1425 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1428 \let\pdfmkdest = \gobble
1429 \let\pdfurl = \gobble
1430 \let\endlink = \relax
1431 \let\setcolor = \gobble
1432 \let\pdfsetcolor = \gobble
1433 \let\pdfmakeoutlines = \relax
1434 \fi % \ifx\pdfoutput
1439 % Change the current font style to #1, remembering it in \curfontstyle.
1440 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1441 % italics, not bold italics.
1443 \def\setfontstyle#1{%
1444 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1445 \csname ten#1\endcsname % change the current font
1448 % Select #1 fonts with the current style.
1450 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1452 \def\rm{\fam=0 \setfontstyle{rm}}
1453 \def\it{\fam=\itfam \setfontstyle{it}}
1454 \def\sl{\fam=\slfam \setfontstyle{sl}}
1455 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1456 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1458 % Unfortunately, we have to override this for titles and the like, since
1459 % in those cases "rm" is bold. Sigh.
1460 \def\rmisbold{\rm\def\curfontstyle{bf}}
1462 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1463 % So we set up a \sf.
1465 \def\sf{\fam=\sffam \setfontstyle{sf}}
1466 \let\li = \sf % Sometimes we call it \li, not \sf.
1468 % We don't need math for this font style.
1469 \def\ttsl{\setfontstyle{ttsl}}
1473 \newdimen\textleading \textleading = 13.2pt
1475 % Set the baselineskip to #1, and the lineskip and strut size
1476 % correspondingly. There is no deep meaning behind these magic numbers
1477 % used as factors; they just match (closely enough) what Knuth defined.
1479 \def\lineskipfactor{.08333}
1480 \def\strutheightpercent{.70833}
1481 \def\strutdepthpercent {.29167}
1483 % can get a sort of poor man's double spacing by redefining this.
1484 \def\baselinefactor{1}
1488 \normalbaselineskip = \baselinefactor\dimen0
1489 \normallineskip = \lineskipfactor\normalbaselineskip
1491 \setbox\strutbox =\hbox{%
1492 \vrule width0pt height\strutheightpercent\baselineskip
1493 depth \strutdepthpercent \baselineskip
1497 % PDF CMaps. See also LaTeX's t1.cmap.
1499 % do nothing with this by default.
1500 \expandafter\let\csname cmapOT1\endcsname\gobble
1501 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1502 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1504 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1505 % (\pdffontattr was introduced many years ago, but people still run
1506 % older pdftex's; it's easy to conditionalize, so we do.)
1507 \ifpdf \ifx\pdffontattr\thisisundefined \else
1509 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1510 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1511 %%DocumentNeededResources: ProcSet (CIDInit)
1512 %%IncludeResource: ProcSet (CIDInit)
1513 %%BeginResource: CMap (TeX-OT1-0)
1514 %%Title: (TeX-OT1-0 TeX OT1 0)
1517 /CIDInit /ProcSet findresource begin
1525 /CMapName /TeX-OT1-0 def
1527 1 begincodespacerange
1583 CMapName currentdict /CMap defineresource pop
1589 \expandafter\edef\csname cmapOT1\endcsname#1{%
1590 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1595 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1596 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1597 %%DocumentNeededResources: ProcSet (CIDInit)
1598 %%IncludeResource: ProcSet (CIDInit)
1599 %%BeginResource: CMap (TeX-OT1IT-0)
1600 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1603 /CIDInit /ProcSet findresource begin
1611 /CMapName /TeX-OT1IT-0 def
1613 1 begincodespacerange
1671 CMapName currentdict /CMap defineresource pop
1677 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1678 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1683 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1684 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1685 %%DocumentNeededResources: ProcSet (CIDInit)
1686 %%IncludeResource: ProcSet (CIDInit)
1687 %%BeginResource: CMap (TeX-OT1TT-0)
1688 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1691 /CIDInit /ProcSet findresource begin
1699 /CMapName /TeX-OT1TT-0 def
1701 1 begincodespacerange
1746 CMapName currentdict /CMap defineresource pop
1752 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1753 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1758 % Set the font macro #1 to the font named #2, adding on the
1759 % specified font prefix (normally `cm').
1760 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1761 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1763 \def\setfont#1#2#3#4#5{%
1764 \font#1=\fontprefix#2#3 scaled #4
1765 \csname cmap#5\endcsname#1%
1767 % This is what gets called when #5 of \setfont is empty.
1769 % emacs-page end of cmaps
1771 % Use cm as the default font prefix.
1772 % To specify the font prefix, you must define \fontprefix
1773 % before you read in texinfo.tex.
1774 \ifx\fontprefix\thisisundefined
1777 % Support font families that don't use the same naming scheme as CM.
1779 \def\rmbshape{bx} %where the normal face is bold
1784 \def\ttslshape{sltt}
1794 % Definitions for a main text size of 11pt. This is the default in
1797 \def\definetextfontsizexi{%
1798 % Text fonts (11.2pt, magstep1).
1799 \def\textnominalsize{11pt}
1800 \edef\mainmagstep{\magstephalf}
1801 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1802 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1803 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1804 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1805 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1806 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1807 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1808 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1809 \font\texti=cmmi10 scaled \mainmagstep
1810 \font\textsy=cmsy10 scaled \mainmagstep
1811 \def\textecsize{1095}
1813 % A few fonts for @defun names and args.
1814 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1815 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1816 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1817 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1819 % Fonts for indices, footnotes, small examples (9pt).
1820 \def\smallnominalsize{9pt}
1821 \setfont\smallrm\rmshape{9}{1000}{OT1}
1822 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1823 \setfont\smallbf\bfshape{10}{900}{OT1}
1824 \setfont\smallit\itshape{9}{1000}{OT1IT}
1825 \setfont\smallsl\slshape{9}{1000}{OT1}
1826 \setfont\smallsf\sfshape{9}{1000}{OT1}
1827 \setfont\smallsc\scshape{10}{900}{OT1}
1828 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1831 \def\smallecsize{0900}
1833 % Fonts for small examples (8pt).
1834 \def\smallernominalsize{8pt}
1835 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1836 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1837 \setfont\smallerbf\bfshape{10}{800}{OT1}
1838 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1839 \setfont\smallersl\slshape{8}{1000}{OT1}
1840 \setfont\smallersf\sfshape{8}{1000}{OT1}
1841 \setfont\smallersc\scshape{10}{800}{OT1}
1842 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1843 \font\smalleri=cmmi8
1844 \font\smallersy=cmsy8
1845 \def\smallerecsize{0800}
1847 % Fonts for title page (20.4pt):
1848 \def\titlenominalsize{20pt}
1849 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1850 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1851 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1852 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1853 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1854 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1855 \let\titlebf=\titlerm
1856 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1857 \font\titlei=cmmi12 scaled \magstep3
1858 \font\titlesy=cmsy10 scaled \magstep4
1859 \def\titleecsize{2074}
1861 % Chapter (and unnumbered) fonts (17.28pt).
1862 \def\chapnominalsize{17pt}
1863 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1864 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1865 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1866 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1867 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1868 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1870 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1871 \font\chapi=cmmi12 scaled \magstep2
1872 \font\chapsy=cmsy10 scaled \magstep3
1873 \def\chapecsize{1728}
1875 % Section fonts (14.4pt).
1876 \def\secnominalsize{14pt}
1877 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1878 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1879 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1880 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1881 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1882 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1884 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1885 \font\seci=cmmi12 scaled \magstep1
1886 \font\secsy=cmsy10 scaled \magstep2
1887 \def\sececsize{1440}
1889 % Subsection fonts (13.15pt).
1890 \def\ssecnominalsize{13pt}
1891 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1892 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1893 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1894 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1895 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1896 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1898 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1899 \font\sseci=cmmi12 scaled \magstephalf
1900 \font\ssecsy=cmsy10 scaled 1315
1901 \def\ssececsize{1200}
1903 % Reduced fonts for @acro in text (10pt).
1904 \def\reducednominalsize{10pt}
1905 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1906 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1907 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1908 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1909 \setfont\reducedsl\slshape{10}{1000}{OT1}
1910 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1911 \setfont\reducedsc\scshape{10}{1000}{OT1}
1912 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1913 \font\reducedi=cmmi10
1914 \font\reducedsy=cmsy10
1915 \def\reducedecsize{1000}
1917 \textleading = 13.2pt % line spacing for 11pt CM
1918 \textfonts % reset the current fonts
1920 } % end of 11pt text font size definitions
1923 % Definitions to make the main text be 10pt Computer Modern, with
1924 % section, chapter, etc., sizes following suit. This is for the GNU
1925 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1926 % future. Used with @smallbook, which sets the leading to 12pt.
1928 \def\definetextfontsizex{%
1929 % Text fonts (10pt).
1930 \def\textnominalsize{10pt}
1931 \edef\mainmagstep{1000}
1932 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1933 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1934 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1935 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1936 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1937 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1938 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1939 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1940 \font\texti=cmmi10 scaled \mainmagstep
1941 \font\textsy=cmsy10 scaled \mainmagstep
1942 \def\textecsize{1000}
1944 % A few fonts for @defun names and args.
1945 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
1946 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
1947 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
1948 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1950 % Fonts for indices, footnotes, small examples (9pt).
1951 \def\smallnominalsize{9pt}
1952 \setfont\smallrm\rmshape{9}{1000}{OT1}
1953 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1954 \setfont\smallbf\bfshape{10}{900}{OT1}
1955 \setfont\smallit\itshape{9}{1000}{OT1IT}
1956 \setfont\smallsl\slshape{9}{1000}{OT1}
1957 \setfont\smallsf\sfshape{9}{1000}{OT1}
1958 \setfont\smallsc\scshape{10}{900}{OT1}
1959 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1962 \def\smallecsize{0900}
1964 % Fonts for small examples (8pt).
1965 \def\smallernominalsize{8pt}
1966 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1967 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1968 \setfont\smallerbf\bfshape{10}{800}{OT1}
1969 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1970 \setfont\smallersl\slshape{8}{1000}{OT1}
1971 \setfont\smallersf\sfshape{8}{1000}{OT1}
1972 \setfont\smallersc\scshape{10}{800}{OT1}
1973 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1974 \font\smalleri=cmmi8
1975 \font\smallersy=cmsy8
1976 \def\smallerecsize{0800}
1978 % Fonts for title page (20.4pt):
1979 \def\titlenominalsize{20pt}
1980 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1981 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1982 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1983 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1984 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1985 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1986 \let\titlebf=\titlerm
1987 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1988 \font\titlei=cmmi12 scaled \magstep3
1989 \font\titlesy=cmsy10 scaled \magstep4
1990 \def\titleecsize{2074}
1992 % Chapter fonts (14.4pt).
1993 \def\chapnominalsize{14pt}
1994 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
1995 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
1996 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
1997 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
1998 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
1999 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2001 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2002 \font\chapi=cmmi12 scaled \magstep1
2003 \font\chapsy=cmsy10 scaled \magstep2
2004 \def\chapecsize{1440}
2006 % Section fonts (12pt).
2007 \def\secnominalsize{12pt}
2008 \setfont\secrm\rmbshape{12}{1000}{OT1}
2009 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2010 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2011 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2012 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2013 \setfont\secsf\sfbshape{12}{1000}{OT1}
2015 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2017 \font\secsy=cmsy10 scaled \magstep1
2018 \def\sececsize{1200}
2020 % Subsection fonts (10pt).
2021 \def\ssecnominalsize{10pt}
2022 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2023 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2024 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2025 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2026 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2027 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2029 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2032 \def\ssececsize{1000}
2034 % Reduced fonts for @acro in text (9pt).
2035 \def\reducednominalsize{9pt}
2036 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2037 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2038 \setfont\reducedbf\bfshape{10}{900}{OT1}
2039 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2040 \setfont\reducedsl\slshape{9}{1000}{OT1}
2041 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2042 \setfont\reducedsc\scshape{10}{900}{OT1}
2043 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2044 \font\reducedi=cmmi9
2045 \font\reducedsy=cmsy9
2046 \def\reducedecsize{0900}
2048 \divide\parskip by 2 % reduce space between paragraphs
2049 \textleading = 12pt % line spacing for 10pt CM
2050 \textfonts % reset the current fonts
2052 } % end of 10pt text font size definitions
2055 % We provide the user-level command
2057 % (or 11) to redefine the text font size. pt is assumed.
2063 \parseargdef\fonttextsize{%
2064 \def\textsizearg{#1}%
2065 %\wlog{doing @fonttextsize \textsizearg}%
2067 % Set \globaldefs so that documents can use this inside @tex, since
2068 % makeinfo 4.8 does not support it, but we need it nonetheless.
2070 \begingroup \globaldefs=1
2071 \ifx\textsizearg\xword \definetextfontsizex
2072 \else \ifx\textsizearg\xiword \definetextfontsizexi
2075 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2081 % In order for the font changes to affect most math symbols and letters,
2082 % we have to define the \textfont of the standard families. Since
2083 % texinfo doesn't allow for producing subscripts and superscripts except
2084 % in the main text, we don't bother to reset \scriptfont and
2085 % \scriptscriptfont (which would also require loading a lot more fonts).
2087 \def\resetmathfonts{%
2088 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2089 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2090 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2093 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2094 % of just \STYLE. We do this because \STYLE needs to also set the
2095 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2096 % \tenSTYLE to set the current font.
2098 % Each font-changing command also sets the names \lsize (one size lower)
2099 % and \lllsize (three sizes lower). These relative commands are used in
2100 % the LaTeX logo and acronyms.
2102 % This all needs generalizing, badly.
2105 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2106 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2107 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2108 \let\tenttsl=\textttsl
2109 \def\curfontsize{text}%
2110 \def\lsize{reduced}\def\lllsize{smaller}%
2111 \resetmathfonts \setleading{\textleading}}
2113 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2114 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2115 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2116 \let\tenttsl=\titlettsl
2117 \def\curfontsize{title}%
2118 \def\lsize{chap}\def\lllsize{subsec}%
2119 \resetmathfonts \setleading{27pt}}
2120 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2122 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2123 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2124 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2125 \let\tenttsl=\chapttsl
2126 \def\curfontsize{chap}%
2127 \def\lsize{sec}\def\lllsize{text}%
2128 \resetmathfonts \setleading{19pt}}
2130 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2131 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2132 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2133 \let\tenttsl=\secttsl
2134 \def\curfontsize{sec}%
2135 \def\lsize{subsec}\def\lllsize{reduced}%
2136 \resetmathfonts \setleading{16pt}}
2138 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2139 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2140 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2141 \let\tenttsl=\ssecttsl
2142 \def\curfontsize{ssec}%
2143 \def\lsize{text}\def\lllsize{small}%
2144 \resetmathfonts \setleading{15pt}}
2145 \let\subsubsecfonts = \subsecfonts
2147 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2148 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2149 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2150 \let\tenttsl=\reducedttsl
2151 \def\curfontsize{reduced}%
2152 \def\lsize{small}\def\lllsize{smaller}%
2153 \resetmathfonts \setleading{10.5pt}}
2155 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2156 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2157 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2158 \let\tenttsl=\smallttsl
2159 \def\curfontsize{small}%
2160 \def\lsize{smaller}\def\lllsize{smaller}%
2161 \resetmathfonts \setleading{10.5pt}}
2163 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2164 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2165 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2166 \let\tenttsl=\smallerttsl
2167 \def\curfontsize{smaller}%
2168 \def\lsize{smaller}\def\lllsize{smaller}%
2169 \resetmathfonts \setleading{9.5pt}}
2171 % Fonts for short table of contents.
2172 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2173 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2174 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2175 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2177 % Define these just so they can be easily changed for other fonts.
2178 \def\angleleft{$\langle$}
2179 \def\angleright{$\rangle$}
2181 % Set the fonts to use with the @small... environments.
2182 \let\smallexamplefonts = \smallfonts
2184 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2185 % can fit this many characters:
2186 % 8.5x11=86 smallbook=72 a4=90 a5=69
2187 % If we use \scriptfonts (8pt), then we can fit this many characters:
2188 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2189 % For me, subjectively, the few extra characters that fit aren't worth
2190 % the additional smallness of 8pt. So I'm making the default 9pt.
2192 % By the way, for comparison, here's what fits with @example (10pt):
2193 % 8.5x11=71 smallbook=60 a4=75 a5=58
2196 % Set up the default fonts, so we can use them for creating boxes.
2198 \definetextfontsizexi
2203 % Check if we are currently using a typewriter font. Since all the
2204 % Computer Modern typewriter fonts have zero interword stretch (and
2205 % shrink), and it is reasonable to expect all typewriter fonts to have
2206 % this property, we can check that font parameter.
2208 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2210 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2211 % define and register \INITMACRO to be called on markup style changes.
2212 % \INITMACRO can check \currentmarkupstyle for the innermost
2213 % style and the set of \ifmarkupSTYLE switches for all styles
2214 % currently in effect.
2218 %\newif\ifmarkupfile % @file == @samp.
2219 %\newif\ifmarkupoption % @option == @samp.
2222 %\newif\ifmarkupenv % @env == @code.
2223 %\newif\ifmarkupcommand % @command == @code.
2224 \newif\ifmarkuptex % @tex (and part of @math, for now).
2225 \newif\ifmarkupexample
2227 \newif\ifmarkupverbatim
2229 \let\currentmarkupstyle\empty
2231 \def\setupmarkupstyle#1{%
2232 \csname markup#1true\endcsname
2233 \def\currentmarkupstyle{#1}%
2237 \let\markupstylesetup\empty
2239 \def\defmarkupstylesetup#1{%
2240 \expandafter\def\expandafter\markupstylesetup
2241 \expandafter{\markupstylesetup #1}%
2245 % Markup style setup for left and right quotes.
2246 \defmarkupstylesetup\markupsetuplq{%
2247 \expandafter\let\expandafter \temp
2248 \csname markupsetuplq\currentmarkupstyle\endcsname
2249 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2252 \defmarkupstylesetup\markupsetuprq{%
2253 \expandafter\let\expandafter \temp
2254 \csname markupsetuprq\currentmarkupstyle\endcsname
2255 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2262 \gdef\markupsetuplqdefault{\let`\lq}
2263 \gdef\markupsetuprqdefault{\let'\rq}
2265 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2266 \gdef\markupsetcodequoteright{\let'\codequoteright}
2268 \gdef\markupsetnoligaturesquoteleft{\let`\noligaturesquoteleft}
2271 \let\markupsetuplqcode \markupsetcodequoteleft
2272 \let\markupsetuprqcode \markupsetcodequoteright
2274 \let\markupsetuplqexample \markupsetcodequoteleft
2275 \let\markupsetuprqexample \markupsetcodequoteright
2277 \let\markupsetuplqsamp \markupsetcodequoteleft
2278 \let\markupsetuprqsamp \markupsetcodequoteright
2280 \let\markupsetuplqverb \markupsetcodequoteleft
2281 \let\markupsetuprqverb \markupsetcodequoteright
2283 \let\markupsetuplqverbatim \markupsetcodequoteleft
2284 \let\markupsetuprqverbatim \markupsetcodequoteright
2286 \let\markupsetuplqkbd \markupsetnoligaturesquoteleft
2288 % Allow an option to not use regular directed right quote/apostrophe
2289 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2290 % The undirected quote is ugly, so don't make it the default, but it
2291 % works for pasting with more pdf viewers (at least evince), the
2292 % lilypond developers report. xpdf does work with the regular 0x27.
2294 \def\codequoteright{%
2295 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2296 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2302 % and a similar option for the left quote char vs. a grave accent.
2303 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2304 % the code environments to do likewise.
2306 \def\codequoteleft{%
2307 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2308 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2309 % [Knuth] pp. 380,381,391
2310 % \relax disables Spanish ligatures ?` and !` of \tt font.
2316 % Commands to set the quote options.
2318 \parseargdef\codequoteundirected{%
2321 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2323 \else\ifx\temp\offword
2324 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2327 \errhelp = \EMsimple
2328 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2332 \parseargdef\codequotebacktick{%
2335 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2337 \else\ifx\temp\offword
2338 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2341 \errhelp = \EMsimple
2342 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2346 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2347 \def\noligaturesquoteleft{\relax\lq}
2349 % Count depth in font-changes, for error checks
2350 \newcount\fontdepth \fontdepth=0
2354 % #1 is the font command (\sl or \it), #2 is the text to slant.
2355 % If we are in a monospaced environment, however, 1) always use \ttsl,
2356 % and 2) do not add an italic correction.
2357 \def\dosmartslant#1#2{%
2359 {{\ttsl #2}\let\next=\relax}%
2360 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2363 \def\smartslanted{\dosmartslant\sl}
2364 \def\smartitalic{\dosmartslant\it}
2366 % Output an italic correction unless \next (presumed to be the following
2367 % character) is such as not to need one.
2368 \def\smartitaliccorrection{%
2377 % like \smartslanted except unconditionally uses \ttsl, and no ic.
2378 % @var is set to this for defun arguments.
2379 \def\ttslanted#1{{\ttsl #1}}
2381 % @cite is like \smartslanted except unconditionally use \sl. We never want
2382 % ttsl for book titles, do we?
2383 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2387 \let\saveaftersmartic = \aftersmartic
2388 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2393 \let\slanted=\smartslanted
2394 \let\dfn=\smartslanted
2395 \let\emph=\smartitalic
2397 % Explicit font changes: @r, @sc, undocumented @ii.
2398 \def\r#1{{\rm #1}} % roman font
2399 \def\sc#1{{\smallcaps#1}} % smallcaps font
2400 \def\ii#1{{\it #1}} % italic font
2402 % @b, explicit bold. Also @strong.
2406 % @sansserif, explicit sans.
2407 \def\sansserif#1{{\sf #1}}
2409 % We can't just use \exhyphenpenalty, because that only has effect at
2410 % the end of a paragraph. Restore normal hyphenation at the end of the
2411 % group within which \nohyphenation is presumably called.
2413 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2414 \def\restorehyphenation{\hyphenchar\font = `- }
2416 % Set sfcode to normal for the chars that usually have another value.
2417 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2418 % sometimes \x has an active definition that messes things up.
2421 \def\plainfrenchspacing{%
2422 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2423 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2424 \def\endofsentencespacefactor{1000}% for @. and friends
2426 \def\plainnonfrenchspacing{%
2427 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2428 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2429 \def\endofsentencespacefactor{3000}% for @. and friends
2432 \def\endofsentencespacefactor{3000}% default
2434 % @t, explicit typewriter.
2436 {\tt \rawbackslash \plainfrenchspacing #1}%
2441 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2443 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2444 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2446 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2447 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2448 % \vbox{\hrule\kern-0.4pt
2449 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2450 % \kern-0.4pt\hrule}%
2451 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2453 % definition of @key with no lozenge. If the current font is already
2454 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2455 % if it isn't monospace, then use \tt.
2457 \def\key#1{{\setupmarkupstyle{key}%
2459 \ifmonospace\else\tt\fi
2462 % ctrl is no longer a Texinfo command.
2463 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2465 % @file, @option are the same as @samp.
2469 % @code is a modification of @t,
2470 % which makes spaces the same size as normal in the surrounding text.
2473 % Change normal interword space to be same as for the current font.
2474 \spaceskip = \fontdimen2\font
2476 % Switch to typewriter.
2479 % But `\ ' produces the large typewriter interword space.
2480 \def\ {{\spaceskip = 0pt{} }}%
2482 % Turn off hyphenation.
2489 \null % reset spacefactor to 1000
2492 % We *must* turn on hyphenation at `-' and `_' in @code.
2493 % Otherwise, it is too hard to avoid overfull hboxes
2494 % in the Emacs manual, the Library manual, etc.
2496 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2497 % both hyphenation at - and hyphenation within words.
2498 % We must therefore turn them both off (\tclose does that)
2499 % and arrange explicitly to hyphenate at a dash.
2502 \catcode`\-=\active \catcode`\_=\active
2503 \catcode`\'=\active \catcode`\`=\active
2504 \global\let'=\rq \global\let`=\lq % default definitions
2506 \global\def\code{\begingroup
2507 \setupmarkupstyle{code}%
2508 % The following should really be moved into \setupmarkupstyle handlers.
2509 \catcode\dashChar=\active \catcode\underChar=\active
2521 \def\codex #1{\tclose{#1}\endgroup}
2524 \def\codedash{-\discretionary{}{}{}}
2526 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2527 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2528 % will therefore expand the active definition of _, which is us
2529 % (inside @code that is), therefore an endless loop.
2531 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2532 \else\normalunderscore \fi
2533 \discretionary{}{}{}}%
2537 % An additional complication: the above will allow breaks after, e.g.,
2538 % each of the four underscores in __typeof__. This is undesirable in
2539 % some manuals, especially if they don't have long identifiers in
2540 % general. @allowcodebreaks provides a way to control this.
2542 \newif\ifallowcodebreaks \allowcodebreakstrue
2544 \def\keywordtrue{true}
2545 \def\keywordfalse{false}
2547 \parseargdef\allowcodebreaks{%
2549 \ifx\txiarg\keywordtrue
2550 \allowcodebreakstrue
2551 \else\ifx\txiarg\keywordfalse
2552 \allowcodebreaksfalse
2554 \errhelp = \EMsimple
2555 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2559 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2560 % second argument specifying the text to display and an optional third
2561 % arg as text to display instead of (rather than in addition to) the url
2562 % itself. First (mandatory) arg is the url.
2563 % (This \urefnobreak definition isn't used now, leaving it for a while
2565 \def\urefnobreak#1{\dourefnobreak #1,,,\finish}
2566 \def\dourefnobreak#1,#2,#3,#4\finish{\begingroup
2569 \setbox0 = \hbox{\ignorespaces #3}%
2571 \unhbox0 % third arg given, show only that
2573 \setbox0 = \hbox{\ignorespaces #2}%
2576 \unhbox0 % PDF: 2nd arg given, show only it
2578 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2581 \code{#1}% only url given, so show it
2587 % This \urefbreak definition is the active one.
2588 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2589 \let\uref=\urefbreak
2590 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
2591 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
2594 \setbox0 = \hbox{\ignorespaces #3}%
2596 \unhbox0 % third arg given, show only that
2598 \setbox0 = \hbox{\ignorespaces #2}%
2601 \unhbox0 % PDF: 2nd arg given, show only it
2603 \unhbox0\ (\urefcode{#1})% DVI: 2nd arg given, show both it and url
2606 \urefcode{#1}% only url given, so show it
2612 % Allow line breaks around only a few characters (only).
2614 \catcode\ampChar=\active \catcode\dotChar=\active
2615 \catcode\hashChar=\active \catcode\questChar=\active
2616 \catcode\slashChar=\active
2621 \global\def\urefcode{\begingroup
2622 \setupmarkupstyle{code}%
2632 % By default, they are just regular characters.
2633 \global\def&{\normalamp}
2634 \global\def.{\normaldot}
2635 \global\def#{\normalhash}
2636 \global\def?{\normalquest}
2637 \global\def/{\normalslash}
2640 % we put a little stretch before and after the breakable chars, to help
2641 % line breaking of long url's. The unequal skips make look better in
2642 % cmtt at least, especially for dots.
2643 \def\urefprestretch{\urefprebreak \hskip0pt plus.13em }
2644 \def\urefpoststretch{\urefpostbreak \hskip0pt plus.1em }
2646 \def\urefcodeamp{\urefprestretch \&\urefpoststretch}
2647 \def\urefcodedot{\urefprestretch .\urefpoststretch}
2648 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
2649 \def\urefcodequest{\urefprestretch ?\urefpoststretch}
2650 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2653 \global\def\urefcodeslashfinish{%
2654 \urefprestretch \slashChar
2655 % Allow line break only after the final / in a sequence of
2656 % slashes, to avoid line break between the slashes in http://.
2657 \ifx\next/\else \urefpoststretch \fi
2661 % One more complication: by default we'll break after the special
2662 % characters, but some people like to break before the special chars, so
2663 % allow that. Also allow no breaking at all, for manual control.
2665 \parseargdef\urefbreakstyle{%
2667 \ifx\txiarg\wordnone
2668 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2669 \else\ifx\txiarg\wordbefore
2670 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2671 \else\ifx\txiarg\wordafter
2672 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2674 \errhelp = \EMsimple
2675 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
2678 \def\wordafter{after}
2679 \def\wordbefore{before}
2682 \urefbreakstyle after
2684 % @url synonym for @uref, since that's how everyone uses it.
2688 % rms does not like angle brackets --karl, 17may97.
2689 % So now @email is just like @uref, unless we are pdf.
2691 %\def\email#1{\angleleft{\tt #1}\angleright}
2693 \def\email#1{\doemail#1,,\finish}
2694 \def\doemail#1,#2,#3\finish{\begingroup
2697 \setbox0 = \hbox{\ignorespaces #2}%
2698 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2705 % @kbd is like @code, except that if the argument is just one @key command,
2706 % then @kbd has no effect.
2707 \def\kbd#1{{\setupmarkupstyle{kbd}\def\look{#1}\expandafter\kbdfoo\look??\par}}
2709 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2710 % `example' (@kbd uses ttsl only inside of @example and friends),
2711 % or `code' (@kbd uses normal tty font always).
2712 \parseargdef\kbdinputstyle{%
2714 \ifx\txiarg\worddistinct
2715 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2716 \else\ifx\txiarg\wordexample
2717 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2718 \else\ifx\txiarg\wordcode
2719 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2721 \errhelp = \EMsimple
2722 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
2725 \def\worddistinct{distinct}
2726 \def\wordexample{example}
2729 % Default is `distinct'.
2730 \kbdinputstyle distinct
2733 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2734 \ifx\one\xkey\ifx\threex\three \key{#2}%
2735 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2736 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi}
2738 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2739 \let\indicateurl=\code
2743 % @clicksequence{File @click{} Open ...}
2744 \def\clicksequence#1{\begingroup #1\endgroup}
2746 % @clickstyle @arrow (by default)
2747 \parseargdef\clickstyle{\def\click{#1}}
2750 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2751 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2753 \def\dmn#1{\thinspace #1}
2755 % @l was never documented to mean ``switch to the Lisp font'',
2756 % and it is not used as such in any manual I can find. We need it for
2757 % Polish suppressed-l. --karl, 22sep96.
2758 %\def\l#1{{\li #1}\null}
2760 % @acronym for "FBI", "NATO", and the like.
2761 % We print this one point size smaller, since it's intended for
2764 \def\acronym#1{\doacronym #1,,\finish}
2765 \def\doacronym#1,#2,#3\finish{%
2766 {\selectfonts\lsize #1}%
2768 \ifx\temp\empty \else
2769 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2771 \null % reset \spacefactor=1000
2774 % @abbr for "Comput. J." and the like.
2775 % No font change, but don't do end-of-sentence spacing.
2777 \def\abbr#1{\doabbr #1,,\finish}
2778 \def\doabbr#1,#2,#3\finish{%
2779 {\plainfrenchspacing #1}%
2781 \ifx\temp\empty \else
2782 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2784 \null % reset \spacefactor=1000
2787 % @asis just yields its argument. Used with @table, for example.
2791 % @math outputs its argument in math mode.
2793 % One complication: _ usually means subscripts, but it could also mean
2794 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2795 % _ active, and distinguish by seeing if the current family is \slfam,
2796 % which is what @var uses.
2798 \catcode`\_ = \active
2799 \gdef\mathunderscore{%
2801 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
2804 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2805 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2806 % particular reason), but this is not advertised and we don't care.
2808 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2809 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
2814 \let\\ = \mathbackslash
2816 % make the texinfo accent commands work in math mode
2828 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
2830 % Some active characters (such as <) are spaced differently in math.
2831 % We have to reset their definitions in case the @math was an argument
2832 % to a command which sets the catcodes (such as @item or @section).
2835 \catcode`^ = \active
2836 \catcode`< = \active
2837 \catcode`> = \active
2838 \catcode`+ = \active
2839 \catcode`' = \active
2845 \let' = \ptexquoteright
2849 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
2850 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
2851 % except specified as a normal braced arg, so no newlines to worry about.
2853 \def\outfmtnametex{tex}
2855 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
2856 \long\def\doinlinefmt#1,#2,\finish{%
2857 \def\inlinefmtname{#1}%
2858 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
2860 % For raw, must switch into @tex before parsing the argument, to avoid
2861 % setting catcodes prematurely. Doing it this way means that, for
2862 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
2863 % ignored. But this isn't important because if people want a literal
2864 % *right* brace they would have to use a command anyway, so they may as
2865 % well use a command to get a left brace too. We could re-use the
2866 % delimiter character idea from \verb, but it seems like overkill.
2868 \long\def\inlineraw{\tex \doinlineraw}
2869 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
2870 \def\doinlinerawtwo#1,#2,\finish{%
2871 \def\inlinerawname{#1}%
2872 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
2873 \endgroup % close group opened by \tex.
2880 % @@ prints an @, as does @atchar{}.
2884 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
2885 % Unless we're in typewriter, use \ecfont because the CM text fonts do
2886 % not have braces, and we don't want to switch into math.
2887 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2888 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2889 \let\{=\mylbrace \let\lbracechar=\{
2890 \let\}=\myrbrace \let\rbracechar=\}
2892 % Definitions to produce \{ and \} commands for indices,
2893 % and @{ and @} for the aux/toc files.
2894 \catcode`\{ = \other \catcode`\} = \other
2895 \catcode`\[ = 1 \catcode`\] = 2
2896 \catcode`\! = 0 \catcode`\\ = \other
2897 !gdef!lbracecmd[\{]%
2898 !gdef!rbracecmd[\}]%
2899 !gdef!lbraceatcmd[@{]%
2900 !gdef!rbraceatcmd[@}]%
2903 % @comma{} to avoid , parsing problems.
2906 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2907 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2909 \let\dotaccent = \ptexdot
2910 \def\ringaccent#1{{\accent23 #1}}
2911 \let\tieaccent = \ptext
2912 \let\ubaraccent = \ptexb
2913 \let\udotaccent = \d
2915 % Other special characters: @questiondown @exclamdown @ordf @ordm
2916 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2917 \def\questiondown{?`}
2919 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
2920 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
2922 % Dotless i and dotless j, used for accents.
2927 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2928 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2929 \else \errmessage{@dotless can be used only with i or j}%
2933 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2934 % period following counts as ending a sentence. (Idea found in latex.)
2936 \edef\TeX{\TeX \spacefactor=1000 }
2938 % @LaTeX{} logo. Not quite the same results as the definition in
2939 % latex.ltx, since we use a different font for the raised A; it's most
2940 % convenient for us to use an explicitly smaller font, rather than using
2941 % the \scriptstyle font (since we don't reset \scriptstyle and
2942 % \scriptscriptstyle).
2947 \vbox to \ht0{\hbox{%
2948 \ifx\textnominalsize\xwordpt
2949 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
2950 % Revert to plain's \scriptsize, which is 7pt.
2951 \count255=\the\fam $\fam\count255 \scriptstyle A$%
2953 % For 11pt, we can use our lllsize.
2954 \selectfonts\lllsize A%
2963 % Some math mode symbols.
2964 \def\bullet{$\ptexbullet$}
2965 \def\geq{\ifmmode \ge\else $\ge$\fi}
2966 \def\leq{\ifmmode \le\else $\le$\fi}
2967 \def\minus{\ifmmode -\else $-$\fi}
2969 % @dots{} outputs an ellipsis using the current font.
2970 % We do .5em per period so that it has the same spacing in the cm
2971 % typewriter fonts as three actual period characters; on the other hand,
2972 % in other typewriter fonts three periods are wider than 1.5em. So do
2973 % whichever is larger.
2977 \setbox0=\hbox{...}% get width of three periods
2984 \hskip 0pt plus.25fil
2985 .\hskip 0pt plus1fil
2986 .\hskip 0pt plus1fil
2987 .\hskip 0pt plus.5fil
2991 % @enddots{} is an end-of-sentence ellipsis.
2995 \spacefactor=\endofsentencespacefactor
2998 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3000 % Since these characters are used in examples, they should be an even number of
3001 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3004 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3005 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3006 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3007 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3008 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3010 % The @error{} command.
3011 % Adapted from the TeXbook's \boxit.
3015 {\tentt \global\dimen0 = 3em}% Width of the box.
3016 \dimen2 = .55pt % Thickness of rules
3017 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3018 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
3020 \setbox\errorbox=\hbox to \dimen0{\hfil
3021 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3022 \advance\hsize by -2\dimen2 % Rules.
3024 \hrule height\dimen2
3025 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3026 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3027 \kern3pt\vrule width\dimen2}% Space to right.
3028 \hrule height\dimen2}
3031 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3033 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3035 \def\pounds{{\it\$}}
3037 % @euro{} comes from a separate font, depending on the current style.
3038 % We use the free feym* fonts from the eurosym package by Henrik
3039 % Theiling, which support regular, slanted, bold and bold slanted (and
3040 % "outlined" (blackboard board, sort of) versions, which we don't need).
3041 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3043 % Although only regular is the truly official Euro symbol, we ignore
3044 % that. The Euro is designed to be slightly taller than the regular
3050 % feybo - bold slanted
3052 % There is no good (free) typewriter version, to my knowledge.
3053 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3056 % Also doesn't work in math. Do we need to do math with euro symbols?
3060 \def\euro{{\eurofont e}}
3062 % We set the font at each command, rather than predefining it in
3063 % \textfonts and the other font-switching commands, so that
3064 % installations which never need the symbol don't have to have the
3067 % There is only one designed size (nominal 10pt), so we always scale
3068 % that to the current nominal size.
3070 % By the way, simply using "at 1em" works for cmr10 and the like, but
3071 % does not work for cmbx10 and other extended/shrunken fonts.
3073 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3075 \ifx\curfontstyle\bfstylename
3077 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3080 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3085 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3086 % sometimes we redefine the original macro, and the alias should reflect
3089 % Use LaTeX names for the Icelandic letters.
3090 \def\DH{{\ecfont \char"D0}} % Eth
3091 \def\dh{{\ecfont \char"F0}} % eth
3092 \def\TH{{\ecfont \char"DE}} % Thorn
3093 \def\th{{\ecfont \char"FE}} % thorn
3095 \def\guillemetleft{{\ecfont \char"13}}
3096 \def\guillemotleft{\guillemetleft}
3097 \def\guillemetright{{\ecfont \char"14}}
3098 \def\guillemotright{\guillemetright}
3099 \def\guilsinglleft{{\ecfont \char"0E}}
3100 \def\guilsinglright{{\ecfont \char"0F}}
3101 \def\quotedblbase{{\ecfont \char"12}}
3102 \def\quotesinglbase{{\ecfont \char"0D}}
3104 % This positioning is not perfect (see the ogonek LaTeX package), but
3105 % we have the precomposed glyphs for the most common cases. We put the
3106 % tests to use those glyphs in the single \ogonek macro so we have fewer
3107 % dummy definitions to worry about for index entries, etc.
3109 % ogonek is also used with other letters in Lithuanian (IOU), but using
3110 % the precomposed glyphs for those is not so easy since they aren't in
3114 \ifx\temp\macrocharA\Aogonek
3115 \else\ifx\temp\macrochara\aogonek
3116 \else\ifx\temp\macrocharE\Eogonek
3117 \else\ifx\temp\macrochare\eogonek
3119 \ecfont \setbox0=\hbox{#1}%
3120 \ifdim\ht0=1ex\accent"0C #1%
3121 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3126 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3127 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3128 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3129 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3131 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
3133 % We can't distinguish serif/sans and italic/slanted, but this
3134 % is used for crude hacks anyway (like adding French and German
3135 % quotes to documents typeset with CM, where we lose kerning), so
3136 % hopefully nobody will notice/care.
3137 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3138 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3139 \ifx\curfontstyle\bfstylename
3141 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
3144 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3149 % @registeredsymbol - R in a circle. The font for the R should really
3150 % be smaller yet, but lllsize is the best we can do for now.
3151 % Adapted from the plain.tex definition of \copyright.
3153 \def\registeredsymbol{%
3154 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
3159 % @textdegree - the normal degrees sign.
3161 \def\textdegree{$^\circ$}
3163 % Laurent Siebenmann reports \Orb undefined with:
3164 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3165 % so we'll define it if necessary.
3167 \ifx\Orb\thisisundefined
3168 \def\Orb{\mathhexbox20D}
3172 \chardef\quotedblleft="5C
3173 \chardef\quotedblright=`\"
3174 \chardef\quoteleft=`\`
3175 \chardef\quoteright=`\'
3178 \message{page headings,}
3180 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3181 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3183 % First the title page. Must do @settitle before @titlepage.
3185 \newif\iffinishedtitlepage
3187 % Do an implicit @contents or @shortcontents after @end titlepage if the
3188 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3190 \newif\ifsetcontentsaftertitlepage
3191 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3192 \newif\ifsetshortcontentsaftertitlepage
3193 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3195 \parseargdef\shorttitlepage{%
3196 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3197 \endgroup\page\hbox{}\page}
3200 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3202 \parindent=0pt \textfonts
3203 % Leave some space at the very top of the page.
3204 \vglue\titlepagetopglue
3205 % No rule at page bottom unless we print one at the top with @title.
3206 \finishedtitlepagetrue
3208 % Most title ``pages'' are actually two pages long, with space
3209 % at the top of the second. We don't want the ragged left on the second.
3210 \let\oldpage = \page
3212 \iffinishedtitlepage\else
3215 \let\page = \oldpage
3222 \iffinishedtitlepage\else
3225 % It is important to do the page break before ending the group,
3226 % because the headline and footline are only empty inside the group.
3227 % If we use the new definition of \page, we always get a blank page
3228 % after the title page, which we certainly don't want.
3232 % Need this before the \...aftertitlepage checks so that if they are
3233 % in effect the toc pages will come out with page numbers.
3236 % If they want short, they certainly want long too.
3237 \ifsetshortcontentsaftertitlepage
3240 \global\let\shortcontents = \relax
3241 \global\let\contents = \relax
3244 \ifsetcontentsaftertitlepage
3246 \global\let\contents = \relax
3247 \global\let\shortcontents = \relax
3251 \def\finishtitlepage{%
3252 \vskip4pt \hrule height 2pt width \hsize
3253 \vskip\titlepagebottomglue
3254 \finishedtitlepagetrue
3257 % Macros to be used within @titlepage:
3259 \let\subtitlerm=\tenrm
3260 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3262 \parseargdef\title{%
3264 \leftline{\titlefonts\rmisbold #1}
3265 % print a rule at the page bottom also.
3266 \finishedtitlepagefalse
3267 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3270 \parseargdef\subtitle{%
3272 {\subtitlefont \rightline{#1}}%
3275 % @author should come last, but may come many times.
3276 % It can also be used inside @quotation.
3278 \parseargdef\author{%
3279 \def\temp{\quotation}%
3281 \def\quotationauthor{#1}% printed in \Equotation.
3284 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3285 {\secfonts\rmisbold \leftline{#1}}%
3290 % Set up page headings and footings.
3292 \let\thispage=\folio
3294 \newtoks\evenheadline % headline on even pages
3295 \newtoks\oddheadline % headline on odd pages
3296 \newtoks\evenfootline % footline on even pages
3297 \newtoks\oddfootline % footline on odd pages
3299 % Now make TeX use those variables
3300 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3301 \else \the\evenheadline \fi}}
3302 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3303 \else \the\evenfootline \fi}\HEADINGShook}
3304 \let\HEADINGShook=\relax
3306 % Commands to set those variables.
3307 % For example, this is what @headings on does
3308 % @evenheading @thistitle|@thispage|@thischapter
3309 % @oddheading @thischapter|@thispage|@thistitle
3310 % @evenfooting @thisfile||
3311 % @oddfooting ||@thisfile
3314 \def\evenheading{\parsearg\evenheadingxxx}
3315 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3316 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3317 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3319 \def\oddheading{\parsearg\oddheadingxxx}
3320 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3321 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3322 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3324 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3326 \def\evenfooting{\parsearg\evenfootingxxx}
3327 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3328 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3329 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3331 \def\oddfooting{\parsearg\oddfootingxxx}
3332 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3333 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3334 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3336 % Leave some space for the footline. Hopefully ok to assume
3337 % @evenfooting will not be used by itself.
3338 \global\advance\pageheight by -12pt
3339 \global\advance\vsize by -12pt
3342 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3344 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3345 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3347 % The same set of arguments for:
3352 % @everyheadingmarks
3353 % @everyfootingmarks
3355 \def\evenheadingmarks{\headingmarks{even}{heading}}
3356 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3357 \def\evenfootingmarks{\headingmarks{even}{footing}}
3358 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3359 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3360 \headingmarks{odd}{heading}{#1} }
3361 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3362 \headingmarks{odd}{footing}{#1} }
3363 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3364 \def\headingmarks#1#2#3 {%
3365 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3366 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3369 \everyheadingmarks bottom
3370 \everyfootingmarks bottom
3372 % @headings double turns headings on for double-sided printing.
3373 % @headings single turns headings on for single-sided printing.
3374 % @headings off turns them off.
3375 % @headings on same as @headings double, retained for compatibility.
3376 % @headings after turns on double-sided headings after this page.
3377 % @headings doubleafter turns on double-sided headings after this page.
3378 % @headings singleafter turns on single-sided headings after this page.
3379 % By default, they are off at the start of a document,
3380 % and turned `on' after @end titlepage.
3382 \def\headings #1 {\csname HEADINGS#1\endcsname}
3384 \def\headingsoff{% non-global headings elimination
3385 \evenheadline={\hfil}\evenfootline={\hfil}%
3386 \oddheadline={\hfil}\oddfootline={\hfil}%
3389 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3390 \HEADINGSoff % it's the default
3392 % When we turn headings on, set the page number to 1.
3393 % For double-sided printing, put current file name in lower left corner,
3394 % chapter name on inside top of right hand pages, document
3395 % title on inside top of left hand pages, and page numbers on outside top
3396 % edge of all pages.
3397 \def\HEADINGSdouble{%
3399 \global\evenfootline={\hfil}
3400 \global\oddfootline={\hfil}
3401 \global\evenheadline={\line{\folio\hfil\thistitle}}
3402 \global\oddheadline={\line{\thischapter\hfil\folio}}
3403 \global\let\contentsalignmacro = \chapoddpage
3405 \let\contentsalignmacro = \chappager
3407 % For single-sided printing, chapter title goes across top left of page,
3408 % page number on top right.
3409 \def\HEADINGSsingle{%
3411 \global\evenfootline={\hfil}
3412 \global\oddfootline={\hfil}
3413 \global\evenheadline={\line{\thischapter\hfil\folio}}
3414 \global\oddheadline={\line{\thischapter\hfil\folio}}
3415 \global\let\contentsalignmacro = \chappager
3417 \def\HEADINGSon{\HEADINGSdouble}
3419 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3420 \let\HEADINGSdoubleafter=\HEADINGSafter
3421 \def\HEADINGSdoublex{%
3422 \global\evenfootline={\hfil}
3423 \global\oddfootline={\hfil}
3424 \global\evenheadline={\line{\folio\hfil\thistitle}}
3425 \global\oddheadline={\line{\thischapter\hfil\folio}}
3426 \global\let\contentsalignmacro = \chapoddpage
3429 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3430 \def\HEADINGSsinglex{%
3431 \global\evenfootline={\hfil}
3432 \global\oddfootline={\hfil}
3433 \global\evenheadline={\line{\thischapter\hfil\folio}}
3434 \global\oddheadline={\line{\thischapter\hfil\folio}}
3435 \global\let\contentsalignmacro = \chappager
3438 % Subroutines used in generating headings
3439 % This produces Day Month Year style of output.
3440 % Only define if not already defined, in case a txi-??.tex file has set
3441 % up a different format (e.g., txi-cs.tex does this).
3442 \ifx\today\thisisundefined
3446 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3447 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3448 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3453 % @settitle line... specifies the title of the document, for headings.
3454 % It generates no output of its own.
3455 \def\thistitle{\putwordNoTitle}
3456 \def\settitle{\parsearg{\gdef\thistitle}}
3460 % Tables -- @table, @ftable, @vtable, @item(x).
3462 % default indentation of table text
3463 \newdimen\tableindent \tableindent=.8in
3464 % default indentation of @itemize and @enumerate text
3465 \newdimen\itemindent \itemindent=.3in
3466 % margin between end of table item and start of table text.
3467 \newdimen\itemmargin \itemmargin=.1in
3469 % used internally for \itemindent minus \itemmargin
3472 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3474 % They also define \itemindex
3475 % to index the item name in whatever manner is desired (perhaps none).
3477 \newif\ifitemxneedsnegativevskip
3479 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3481 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3482 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3484 \def\itemzzz #1{\begingroup %
3485 \advance\hsize by -\rightskip
3486 \advance\hsize by -\tableindent
3487 \setbox0=\hbox{\itemindicate{#1}}%
3489 \nobreak % This prevents a break before @itemx.
3491 % If the item text does not fit in the space we have, put it on a line
3492 % by itself, and do not allow a page break either before or after that
3493 % line. We do not start a paragraph here because then if the next
3494 % command is, e.g., @kindex, the whatsit would get put into the
3495 % horizontal list on a line by itself, resulting in extra blank space.
3496 \ifdim \wd0>\itemmax
3498 % Make this a paragraph so we get the \parskip glue and wrapping,
3499 % but leave it ragged-right.
3501 \advance\leftskip by-\tableindent
3502 \advance\hsize by\tableindent
3503 \advance\rightskip by0pt plus1fil\relax
3504 \leavevmode\unhbox0\par
3507 % We're going to be starting a paragraph, but we don't want the
3508 % \parskip glue -- logically it's part of the @item we just started.
3509 \nobreak \vskip-\parskip
3511 % Stop a page break at the \parskip glue coming up. However, if
3512 % what follows is an environment such as @example, there will be no
3513 % \parskip glue; then the negative vskip we just inserted would
3514 % cause the example and the item to crash together. So we use this
3515 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3516 % \parskip glue after all. Section titles are handled this way also.
3520 \itemxneedsnegativevskipfalse
3522 % The item text fits into the space. Start a paragraph, so that the
3523 % following text (if any) will end up on the same line.
3525 % Do this with kerns and \unhbox so that if there is a footnote in
3526 % the item text, it can migrate to the main vertical list and
3527 % eventually be printed.
3528 \nobreak\kern-\tableindent
3529 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3531 \nobreak\kern\dimen0
3533 \itemxneedsnegativevskiptrue
3537 \def\item{\errmessage{@item while not in a list environment}}
3538 \def\itemx{\errmessage{@itemx while not in a list environment}}
3540 % @table, @ftable, @vtable.
3542 \let\itemindex\gobble
3546 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3547 \tablecheck{ftable}%
3550 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3551 \tablecheck{vtable}%
3554 \ifnum \the\catcode`\^^M=\active
3556 \errmessage{This command won't work in this context; perhaps the problem is
3557 that we are \inenvironment\thisenv}%
3558 \def\next{\doignore{#1}}%
3565 \def\itemindicate{#1}%
3570 \makevalueexpandable
3571 \edef\temp{\noexpand\tablez #1\space\space\space}%
3575 \def\tablez #1 #2 #3 #4\endtablez{%
3577 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3578 \ifnum 0#2>0 \tableindent=#2\mil \fi
3579 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3580 \itemmax=\tableindent
3581 \advance \itemmax by -\itemmargin
3582 \advance \leftskip by \tableindent
3583 \exdentamount=\tableindent
3585 \parskip = \smallskipamount
3586 \ifdim \parskip=0pt \parskip=2pt \fi
3587 \let\item = \internalBitem
3588 \let\itemx = \internalBitemx
3590 \def\Etable{\endgraf\afterenvbreak}
3593 \let\Eitemize\Etable
3594 \let\Eenumerate\Etable
3596 % This is the counter used by @enumerate, which is really @itemize
3600 \envdef\itemize{\parsearg\doitemize}
3604 \itemmax=\itemindent
3605 \advance\itemmax by -\itemmargin
3606 \advance\leftskip by \itemindent
3607 \exdentamount=\itemindent
3609 \parskip=\smallskipamount
3610 \ifdim\parskip=0pt \parskip=2pt \fi
3612 % Try typesetting the item mark that if the document erroneously says
3613 % something like @itemize @samp (intending @table), there's an error
3614 % right away at the @itemize. It's not the best error message in the
3615 % world, but it's better than leaving it to the @item. This means if
3616 % the user wants an empty mark, they have to say @w{} not just @w.
3617 \def\itemcontents{#1}%
3618 \setbox0 = \hbox{\itemcontents}%
3620 % @itemize with no arg is equivalent to @itemize @bullet.
3621 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3623 \let\item=\itemizeitem
3626 % Definition of @item while inside @itemize and @enumerate.
3629 \advance\itemno by 1 % for enumerations
3630 {\let\par=\endgraf \smallbreak}% reasonable place to break
3632 % If the document has an @itemize directly after a section title, a
3633 % \nobreak will be last on the list, and \sectionheading will have
3634 % done a \vskip-\parskip. In that case, we don't want to zero
3635 % parskip, or the item text will crash with the heading. On the
3636 % other hand, when there is normal text preceding the item (as there
3637 % usually is), we do want to zero parskip, or there would be too much
3638 % space. In that case, we won't have a \nobreak before. At least
3639 % that's the theory.
3640 \ifnum\lastpenalty<10000 \parskip=0in \fi
3642 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3644 \vadjust{\penalty 1200}}% not good to break after first line of item.
3648 % \splitoff TOKENS\endmark defines \first to be the first token in
3649 % TOKENS, and \rest to be the remainder.
3651 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3653 % Allow an optional argument of an uppercase letter, lowercase letter,
3654 % or number, to specify the first label in the enumerated list. No
3655 % argument is the same as `1'.
3657 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3658 \def\enumeratey #1 #2\endenumeratey{%
3659 % If we were given no argument, pretend we were given `1'.
3661 \ifx\thearg\empty \def\thearg{1}\fi
3663 % Detect if the argument is a single token. If so, it might be a
3664 % letter. Otherwise, the only valid thing it can be is a number.
3665 % (We will always have one token, because of the test we just made.
3666 % This is a good thing, since \splitoff doesn't work given nothing at
3667 % all -- the first parameter is undelimited.)
3668 \expandafter\splitoff\thearg\endmark
3670 % Only one token in the argument. It could still be anything.
3671 % A ``lowercase letter'' is one whose \lccode is nonzero.
3672 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3673 % not equal to itself.
3674 % Otherwise, we assume it's a number.
3676 % We need the \relax at the end of the \ifnum lines to stop TeX from
3677 % continuing to look for a <number>.
3679 \ifnum\lccode\expandafter`\thearg=0\relax
3680 \numericenumerate % a number (we hope)
3683 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3684 \lowercaseenumerate % lowercase letter
3686 \uppercaseenumerate % uppercase letter
3690 % Multiple tokens in the argument. We hope it's a number.
3695 % An @enumerate whose labels are integers. The starting integer is
3698 \def\numericenumerate{%
3700 \startenumeration{\the\itemno}%
3703 % The starting (lowercase) letter is in \thearg.
3704 \def\lowercaseenumerate{%
3705 \itemno = \expandafter`\thearg
3707 % Be sure we're not beyond the end of the alphabet.
3709 \errmessage{No more lowercase letters in @enumerate; get a bigger
3716 % The starting (uppercase) letter is in \thearg.
3717 \def\uppercaseenumerate{%
3718 \itemno = \expandafter`\thearg
3720 % Be sure we're not beyond the end of the alphabet.
3722 \errmessage{No more uppercase letters in @enumerate; get a bigger
3729 % Call \doitemize, adding a period to the first argument and supplying the
3730 % common last two arguments. Also subtract one from the initial value in
3731 % \itemno, since @item increments \itemno.
3733 \def\startenumeration#1{%
3734 \advance\itemno by -1
3735 \doitemize{#1.}\flushcr
3738 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3741 \def\alphaenumerate{\enumerate{a}}
3742 \def\capsenumerate{\enumerate{A}}
3743 \def\Ealphaenumerate{\Eenumerate}
3744 \def\Ecapsenumerate{\Eenumerate}
3747 % @multitable macros
3748 % Amy Hendrickson, 8/18/94, 3/6/96
3750 % @multitable ... @end multitable will make as many columns as desired.
3751 % Contents of each column will wrap at width given in preamble. Width
3752 % can be specified either with sample text given in a template line,
3753 % or in percent of \hsize, the current width of text on page.
3755 % Table can continue over pages but will only break between lines.
3759 % Either define widths of columns in terms of percent of \hsize:
3760 % @multitable @columnfractions .25 .3 .45
3763 % Numbers following @columnfractions are the percent of the total
3764 % current hsize to be used for each column. You may use as many
3765 % columns as desired.
3768 % Or use a template:
3769 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3771 % using the widest term desired in each column.
3773 % Each new table line starts with @item, each subsequent new column
3774 % starts with @tab. Empty columns may be produced by supplying @tab's
3775 % with nothing between them for as many times as empty columns are needed,
3776 % ie, @tab@tab@tab will produce two empty columns.
3778 % @item, @tab do not need to be on their own lines, but it will not hurt
3781 % Sample multitable:
3783 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3784 % @item first col stuff @tab second col stuff @tab third col
3791 % @item first col stuff @tab second col stuff
3792 % @tab Many paragraphs of text may be used in any column.
3794 % They will wrap at the width determined by the template.
3795 % @item@tab@tab This will be in third column.
3798 % Default dimensions may be reset by user.
3799 % @multitableparskip is vertical space between paragraphs in table.
3800 % @multitableparindent is paragraph indent in table.
3801 % @multitablecolmargin is horizontal space to be left between columns.
3802 % @multitablelinespace is space to leave between table items, baseline
3804 % 0pt means it depends on current normal line spacing.
3806 \newskip\multitableparskip
3807 \newskip\multitableparindent
3808 \newdimen\multitablecolspace
3809 \newskip\multitablelinespace
3810 \multitableparskip=0pt
3811 \multitableparindent=6pt
3812 \multitablecolspace=12pt
3813 \multitablelinespace=0pt
3815 % Macros used to set up halign preamble:
3817 \let\endsetuptable\relax
3818 \def\xendsetuptable{\endsetuptable}
3819 \let\columnfractions\relax
3820 \def\xcolumnfractions{\columnfractions}
3823 % #1 is the @columnfraction, usually a decimal number like .5, but might
3824 % be just 1. We just use it, whatever it is.
3826 \def\pickupwholefraction#1 {%
3827 \global\advance\colcount by 1
3828 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3835 \ifx\firstarg\xendsetuptable
3838 \ifx\firstarg\xcolumnfractions
3839 \global\setpercenttrue
3842 \let\go\pickupwholefraction
3844 \global\advance\colcount by 1
3845 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3846 % separator; typically that is always in the input, anyway.
3847 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3850 \ifx\go\pickupwholefraction
3851 % Put the argument back for the \pickupwholefraction call, so
3852 % we'll always have a period there to be parsed.
3853 \def\go{\pickupwholefraction#1}%
3855 \let\go = \setuptable
3861 % multitable-only commands.
3863 % @headitem starts a heading row, which we typeset in bold.
3864 % Assignments have to be global since we are inside the implicit group
3865 % of an alignment entry. \everycr resets \everytab so we don't have to
3866 % undo it ourselves.
3867 \def\headitemfont{\b}% for people to use in the template row; not changeable
3869 \checkenv\multitable
3871 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3872 \the\everytab % for the first item
3875 % A \tab used to include \hskip1sp. But then the space in a template
3876 % line is not enough. That is bad. So let's go back to just `&' until
3877 % we again encounter the problem the 1sp was intended to solve.
3878 % --karl, nathan@acm.org, 20apr99.
3879 \def\tab{\checkenv\multitable &\the\everytab}%
3881 % @multitable ... @end multitable definitions:
3883 \newtoks\everytab % insert after every tab.
3885 \envdef\multitable{%
3889 % @item within a multitable starts a normal row.
3890 % We use \def instead of \let so that if one of the multitable entries
3891 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3892 % \endtemplate) expanding \doitemize.
3897 \setmultitablespacing
3898 \parskip=\multitableparskip
3899 \parindent=\multitableparindent
3905 \global\everytab={}%
3906 \global\colcount=0 % Reset the column counter.
3907 % Check for saved footnotes, etc.
3909 % Keeps underfull box messages off when table breaks over pages.
3911 % Maybe so, but it also creates really weird page breaks when the
3912 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3913 % problem manifests itself, so it can be fixed for real --karl.
3917 \parsearg\domultitable
3919 \def\domultitable#1{%
3920 % To parse everything between @multitable and @item:
3921 \setuptable#1 \endsetuptable
3923 % This preamble sets up a generic column definition, which will
3924 % be used as many times as user calls for columns.
3925 % \vtop will set a single line and will also let text wrap and
3926 % continue for many paragraphs if desired.
3928 \global\advance\colcount by 1
3931 % Use the current \colcount to find the correct column width:
3932 \hsize=\expandafter\csname col\the\colcount\endcsname
3934 % In order to keep entries from bumping into each other
3935 % we will add a \leftskip of \multitablecolspace to all columns after
3938 % If a template has been used, we will add \multitablecolspace
3939 % to the width of each template entry.
3941 % If the user has set preamble in terms of percent of \hsize we will
3942 % use that dimension as the width of the column, and the \leftskip
3943 % will keep entries from bumping into each other. Table will start at
3944 % left margin and final column will justify at right margin.
3946 % Make sure we don't inherit \rightskip from the outer environment.
3949 % The first column will be indented with the surrounding text.
3950 \advance\hsize by\leftskip
3953 % If user has not set preamble in terms of percent of \hsize
3954 % we will advance \hsize by \multitablecolspace.
3955 \advance\hsize by \multitablecolspace
3957 % In either case we will make \leftskip=\multitablecolspace:
3958 \leftskip=\multitablecolspace
3960 % Ignoring space at the beginning and end avoids an occasional spurious
3961 % blank line, when TeX decides to break the line at the space before the
3962 % box from the multistrut, so the strut ends up on a line by itself.
3964 % @multitable @columnfractions .11 .89
3966 % @tab Legal holiday which is valid in major parts of the whole country.
3967 % Is automatically provided with highlighting sequences respectively
3968 % marking characters.
3969 \noindent\ignorespaces##\unskip\multistrut
3974 \egroup % end the \halign
3975 \global\setpercentfalse
3978 \def\setmultitablespacing{%
3979 \def\multistrut{\strut}% just use the standard line spacing
3981 % Compute \multitablelinespace (if not defined by user) for use in
3982 % \multitableparskip calculation. We used define \multistrut based on
3983 % this, but (ironically) that caused the spacing to be off.
3984 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3985 \ifdim\multitablelinespace=0pt
3986 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3987 \global\advance\multitablelinespace by-\ht0
3989 % Test to see if parskip is larger than space between lines of
3990 % table. If not, do nothing.
3991 % If so, set to same dimension as multitablelinespace.
3992 \ifdim\multitableparskip>\multitablelinespace
3993 \global\multitableparskip=\multitablelinespace
3994 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
3995 % than skip between lines in the table.
3997 \ifdim\multitableparskip=0pt
3998 \global\multitableparskip=\multitablelinespace
3999 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4000 % than skip between lines in the table.
4004 \message{conditionals,}
4006 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4007 % @ifnotxml always succeed. They currently do nothing; we don't
4008 % attempt to check whether the conditionals are properly nested. But we
4009 % have to remember that they are conditionals, so that @end doesn't
4010 % attempt to close an environment group.
4013 \expandafter\let\csname #1\endcsname = \relax
4014 \expandafter\let\csname iscond.#1\endcsname = 1
4017 \makecond{ifnotdocbook}
4018 \makecond{ifnothtml}
4019 \makecond{ifnotinfo}
4020 \makecond{ifnotplaintext}
4023 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4025 \def\direntry{\doignore{direntry}}
4026 \def\documentdescription{\doignore{documentdescription}}
4027 \def\docbook{\doignore{docbook}}
4028 \def\html{\doignore{html}}
4029 \def\ifdocbook{\doignore{ifdocbook}}
4030 \def\ifhtml{\doignore{ifhtml}}
4031 \def\ifinfo{\doignore{ifinfo}}
4032 \def\ifnottex{\doignore{ifnottex}}
4033 \def\ifplaintext{\doignore{ifplaintext}}
4034 \def\ifxml{\doignore{ifxml}}
4035 \def\ignore{\doignore{ignore}}
4036 \def\menu{\doignore{menu}}
4037 \def\xml{\doignore{xml}}
4039 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4041 % A count to remember the depth of nesting.
4042 \newcount\doignorecount
4044 \def\doignore#1{\begingroup
4045 % Scan in ``verbatim'' mode:
4047 \catcode`\@ = \other
4048 \catcode`\{ = \other
4049 \catcode`\} = \other
4051 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4054 % Count number of #1's that we've seen.
4057 % Swallow text until we reach the matching `@end #1'.
4061 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4064 \gdef\dodoignore#1{%
4065 % #1 contains the command name as a string, e.g., `ifinfo'.
4067 % Define a command to find the next `@end #1'.
4068 \long\def\doignoretext##1^^M@end #1{%
4069 \doignoretextyyy##1^^M@#1\_STOP_}%
4071 % And this command to find another #1 command, at the beginning of a
4072 % line. (Otherwise, we would consider a line `@c @ifset', for
4073 % example, to count as an @ifset for nesting.)
4074 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4076 % And now expand that command.
4081 \def\doignoreyyy#1{%
4083 \ifx\temp\empty % Nothing found.
4084 \let\next\doignoretextzzz
4085 \else % Found a nested condition, ...
4086 \advance\doignorecount by 1
4087 \let\next\doignoretextyyy % ..., look for another.
4088 % If we're here, #1 ends with ^^M\ifinfo (for example).
4090 \next #1% the token \_STOP_ is present just after this macro.
4093 % We have to swallow the remaining "\_STOP_".
4095 \def\doignoretextzzz#1{%
4096 \ifnum\doignorecount = 0 % We have just found the outermost @end.
4097 \let\next\enddoignore
4098 \else % Still inside a nested condition.
4099 \advance\doignorecount by -1
4100 \let\next\doignoretext % Look for the next @end.
4105 % Finish off ignored text.
4107 % Ignore anything after the last `@end #1'; this matters in verbatim
4108 % environments, where otherwise the newline after an ignored conditional
4109 % would result in a blank line in the output.
4110 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4114 % @set VAR sets the variable VAR to an empty value.
4115 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4117 % Since we want to separate VAR from REST-OF-LINE (which might be
4118 % empty), we can't just use \parsearg; we have to insert a space of our
4119 % own to delimit the rest of the line, and then take it out again if we
4121 % We rely on the fact that \parsearg sets \catcode`\ =10.
4123 \parseargdef\set{\setyyy#1 \endsetyyy}
4124 \def\setyyy#1 #2\endsetyyy{%
4126 \makevalueexpandable
4128 \edef\next{\gdef\makecsname{SET#1}}%
4136 % Remove the trailing space \setxxx inserted.
4137 \def\setzzz#1 \endsetzzz{\next{#1}}
4139 % @clear VAR clears (i.e., unsets) the variable VAR.
4141 \parseargdef\clear{%
4143 \makevalueexpandable
4144 \global\expandafter\let\csname SET#1\endcsname=\relax
4148 % @value{foo} gets the text saved in variable foo.
4149 \def\value{\begingroup\makevalueexpandable\valuexxx}
4150 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4152 \catcode`\- = \active \catcode`\_ = \active
4154 \gdef\makevalueexpandable{%
4155 \let\value = \expandablevalue
4156 % We don't want these characters active, ...
4157 \catcode`\-=\other \catcode`\_=\other
4158 % ..., but we might end up with active ones in the argument if
4159 % we're called from @code, as @code{@value{foo-bar_}}, though.
4160 % So \let them to their normal equivalents.
4161 \let-\realdash \let_\normalunderscore
4165 % We have this subroutine so that we can handle at least some @value's
4166 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4167 % The command has to be fully expandable (if the variable is set), since
4168 % the result winds up in the index file. This means that if the
4169 % variable's value contains other Texinfo commands, it's almost certain
4170 % it will fail (although perhaps we could fix that with sufficient work
4171 % to do a one-level expansion on the result, instead of complete).
4173 \def\expandablevalue#1{%
4174 \expandafter\ifx\csname SET#1\endcsname\relax
4175 {[No value for ``#1'']}%
4176 \message{Variable `#1', used in @value, is not set.}%
4178 \csname SET#1\endcsname
4182 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4185 % To get special treatment of `@end ifset,' call \makeond and the redefine.
4188 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4191 \makevalueexpandable
4193 \expandafter\ifx\csname SET#2\endcsname\relax
4194 #1% If not set, redefine \next.
4199 \def\ifsetfail{\doignore{ifset}}
4201 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
4202 % defined with @set, or has been undefined with @clear.
4204 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4205 % above code: if the variable is not set, do nothing, if it is set,
4206 % then redefine \next to \ifclearfail.
4209 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4210 \def\ifclearfail{\doignore{ifclear}}
4212 % @dircategory CATEGORY -- specify a category of the dir file
4213 % which this file should belong to. Ignore this in TeX.
4214 \let\dircategory=\comment
4216 % @defininfoenclose.
4217 \let\definfoenclose=\comment
4221 % Index generation facilities
4223 % Define \newwrite to be identical to plain tex's \newwrite
4224 % except not \outer, so it can be used within macros and \if's.
4225 \edef\newwrite{\makecsname{ptexnewwrite}}
4227 % \newindex {foo} defines an index named foo.
4228 % It automatically defines \fooindex such that
4229 % \fooindex ...rest of line... puts an entry in the index foo.
4230 % It also defines \fooindfile to be the number of the output channel for
4231 % the file that accumulates this index. The file's extension is foo.
4232 % The name of an index should be no more than 2 characters long
4233 % for the sake of vms.
4237 \expandafter\newwrite \csname#1indfile\endcsname
4238 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4240 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4241 \noexpand\doindex{#1}}
4244 % @defindex foo == \newindex{foo}
4246 \def\defindex{\parsearg\newindex}
4248 % Define @defcodeindex, like @defindex except put all entries in @code.
4250 \def\defcodeindex{\parsearg\newcodeindex}
4252 \def\newcodeindex#1{%
4254 \expandafter\newwrite \csname#1indfile\endcsname
4255 \openout \csname#1indfile\endcsname \jobname.#1
4257 \expandafter\xdef\csname#1index\endcsname{%
4258 \noexpand\docodeindex{#1}}%
4262 % @synindex foo bar makes index foo feed into index bar.
4263 % Do this instead of @defindex foo if you don't want it as a separate index.
4265 % @syncodeindex foo bar similar, but put all entries made for index foo
4268 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4269 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4271 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4272 % #3 the target index (bar).
4273 \def\dosynindex#1#2#3{%
4274 % Only do \closeout if we haven't already done it, else we'll end up
4275 % closing the target index.
4276 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4277 % The \closeout helps reduce unnecessary open files; the limit on the
4278 % Acorn RISC OS is a mere 16 files.
4279 \expandafter\closeout\csname#2indfile\endcsname
4280 \expandafter\let\csname donesynindex#2\endcsname = 1
4282 % redefine \fooindfile:
4283 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4284 \expandafter\let\csname#2indfile\endcsname=\temp
4285 % redefine \fooindex:
4286 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4289 % Define \doindex, the driver for all \fooindex macros.
4290 % Argument #1 is generated by the calling \fooindex macro,
4291 % and it is "foo", the name of the index.
4293 % \doindex just uses \parsearg; it calls \doind for the actual work.
4294 % This is because \doind is more useful to call from other macros.
4296 % There is also \dosubind {index}{topic}{subtopic}
4297 % which makes an entry in a two-level index such as the operation index.
4299 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4300 \def\singleindexer #1{\doind{\indexname}{#1}}
4302 % like the previous two, but they put @code around the argument.
4303 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4304 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4306 % Take care of Texinfo commands that can appear in an index entry.
4307 % Since there are some commands we want to expand, and others we don't,
4308 % we have to laboriously prevent expansion for those that we don't.
4311 \escapechar = `\\ % use backslash in output files.
4312 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4313 \def\ {\realbackslash\space }%
4315 % Need these unexpandable (because we define \tt as a dummy)
4316 % definitions when @{ or @} appear in index entry text. Also, more
4317 % complicated, when \tex is in effect and \{ is a \delimiter again.
4318 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4319 % braces and backslashes are used only as delimiters. Perhaps we
4320 % should define @lbrace and @rbrace commands a la @comma.
4321 \def\{{{\tt\char123}}%
4322 \def\}{{\tt\char125}}%
4324 % I don't entirely understand this, but when an index entry is
4325 % generated from a macro call, the \endinput which \scanmacro inserts
4326 % causes processing to be prematurely terminated. This is,
4327 % apparently, because \indexsorttmp is fully expanded, and \endinput
4328 % is an expandable command. The redefinition below makes \endinput
4329 % disappear altogether for that purpose -- although logging shows that
4330 % processing continues to some further point. On the other hand, it
4331 % seems \endinput does not hurt in the printed index arg, since that
4332 % is still getting written without apparent harm.
4334 % Sample source (mac-idx3.tex, reported by Graham Percival to
4335 % help-texinfo, 22may06):
4336 % @macro funindex {WORD}
4340 % @funindex commtest
4342 % The above is not enough to reproduce the bug, but it gives the flavor.
4344 % Sample whatsit resulting:
4345 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4348 \let\endinput = \empty
4350 % Do the redefinitions.
4354 % For the aux and toc files, @ is the escape character. So we want to
4355 % redefine everything using @ as the escape character (instead of
4356 % \realbackslash, still used for index files). When everything uses @,
4357 % this will be simpler.
4362 \let\{ = \lbraceatcmd
4363 \let\} = \rbraceatcmd
4365 % Do the redefinitions.
4370 % Called from \indexdummies and \atdummies.
4372 \def\commondummies{%
4374 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4375 % preventing its expansion. This is used only for control words,
4376 % not control letters, because the \space would be incorrect for
4377 % control characters, but is needed to separate the control word
4378 % from whatever follows.
4380 % For control letters, we have \definedummyletter, which omits the
4383 % These can be used both for control words that take an argument and
4384 % those that do not. If it is followed by {arg} in the input, then
4385 % that will dutifully get written to the index (or wherever).
4387 \def\definedummyword ##1{\def##1{\string##1\space}}%
4388 \def\definedummyletter##1{\def##1{\string##1}}%
4389 \let\definedummyaccent\definedummyletter
4391 \commondummiesnofonts
4393 \definedummyletter\_%
4394 \definedummyletter\-%
4396 % Non-English letters.
4407 \definedummyword\exclamdown
4411 \definedummyword\ordf
4412 \definedummyword\ordm
4413 \definedummyword\questiondown
4417 % Although these internal commands shouldn't show up, sometimes they do.
4419 \definedummyword\gtr
4420 \definedummyword\hat
4421 \definedummyword\less
4424 \definedummyword\tclose
4427 \definedummyword\LaTeX
4428 \definedummyword\TeX
4430 % Assorted special characters.
4431 \definedummyword\arrow
4432 \definedummyword\bullet
4433 \definedummyword\comma
4434 \definedummyword\copyright
4435 \definedummyword\registeredsymbol
4436 \definedummyword\dots
4437 \definedummyword\enddots
4438 \definedummyword\entrybreak
4439 \definedummyword\equiv
4440 \definedummyword\error
4441 \definedummyword\euro
4442 \definedummyword\expansion
4443 \definedummyword\geq
4444 \definedummyword\guillemetleft
4445 \definedummyword\guillemetright
4446 \definedummyword\guilsinglleft
4447 \definedummyword\guilsinglright
4448 \definedummyword\leq
4449 \definedummyword\minus
4450 \definedummyword\ogonek
4451 \definedummyword\pounds
4452 \definedummyword\point
4453 \definedummyword\print
4454 \definedummyword\quotedblbase
4455 \definedummyword\quotedblleft
4456 \definedummyword\quotedblright
4457 \definedummyword\quoteleft
4458 \definedummyword\quoteright
4459 \definedummyword\quotesinglbase
4460 \definedummyword\result
4461 \definedummyword\textdegree
4463 % We want to disable all macros so that they are not expanded by \write.
4466 \normalturnoffactive
4468 % Handle some cases of @value -- where it does not contain any
4469 % (non-fully-expandable) commands.
4470 \makevalueexpandable
4473 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4475 \def\commondummiesnofonts{%
4476 % Control letters and accents.
4477 \definedummyletter\!%
4478 \definedummyaccent\"%
4479 \definedummyaccent\'%
4480 \definedummyletter\*%
4481 \definedummyaccent\,%
4482 \definedummyletter\.%
4483 \definedummyletter\/%
4484 \definedummyletter\:%
4485 \definedummyaccent\=%
4486 \definedummyletter\?%
4487 \definedummyaccent\^%
4488 \definedummyaccent\`%
4489 \definedummyaccent\~%
4493 \definedummyword\dotaccent
4494 \definedummyword\ogonek
4495 \definedummyword\ringaccent
4496 \definedummyword\tieaccent
4497 \definedummyword\ubaraccent
4498 \definedummyword\udotaccent
4499 \definedummyword\dotless
4501 % Texinfo font commands.
4505 \definedummyword\sansserif
4507 \definedummyword\slanted
4510 % Commands that take arguments.
4511 \definedummyword\acronym
4512 \definedummyword\anchor
4513 \definedummyword\cite
4514 \definedummyword\code
4515 \definedummyword\command
4516 \definedummyword\dfn
4517 \definedummyword\dmn
4518 \definedummyword\email
4519 \definedummyword\emph
4520 \definedummyword\env
4521 \definedummyword\file
4522 \definedummyword\indicateurl
4523 \definedummyword\kbd
4524 \definedummyword\key
4525 \definedummyword\math
4526 \definedummyword\option
4527 \definedummyword\pxref
4528 \definedummyword\ref
4529 \definedummyword\samp
4530 \definedummyword\strong
4531 \definedummyword\tie
4532 \definedummyword\uref
4533 \definedummyword\url
4534 \definedummyword\var
4535 \definedummyword\verb
4537 \definedummyword\xref
4540 % \indexnofonts is used when outputting the strings to sort the index
4541 % by, and when constructing control sequence names. It eliminates all
4542 % control sequences and just writes whatever the best ASCII sort string
4543 % would be for a given command (usually its argument).
4546 % Accent commands should become @asis.
4547 \def\definedummyaccent##1{\let##1\asis}%
4548 % We can just ignore other control letters.
4549 \def\definedummyletter##1{\let##1\empty}%
4550 % All control words become @asis by default; overrides below.
4551 \let\definedummyword\definedummyaccent
4553 \commondummiesnofonts
4555 % Don't no-op \tt, since it isn't a user-level command
4556 % and is used in the definitions of the active chars like <, >, |, etc.
4557 % Likewise with the other plain tex font commands.
4562 \def\_{\normalunderscore}%
4563 \def\-{}% @- shouldn't affect sorting
4565 % Unfortunately, texindex is not prepared to handle braces in the
4566 % content at all. So for index sorting, we map @{ and @} to strings
4567 % starting with |, since that ASCII character is between ASCII { and }.
4571 % Non-English letters.
4588 \def\questiondown{?}%
4595 % Assorted special characters.
4596 % (The following {} will end up in the sort string, but that's ok.)
4598 \def\bullet{bullet}%
4600 \def\copyright{copyright}%
4606 \def\expansion{==>}%
4608 \def\guillemetleft{<<}%
4609 \def\guillemetright{>>}%
4610 \def\guilsinglleft{<}%
4611 \def\guilsinglright{>}%
4615 \def\pounds{pounds}%
4617 \def\quotedblbase{"}%
4618 \def\quotedblleft{"}%
4619 \def\quotedblright{"}%
4622 \def\quotesinglbase{,}%
4623 \def\registeredsymbol{R}%
4627 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4628 \else \indexlquoteignore \fi
4630 % We need to get rid of all macros, leaving only the arguments (if present).
4631 % Of course this is not nearly correct, but it is the best we can do for now.
4632 % makeinfo does not expand macros in the argument to @deffn, which ends up
4633 % writing an index entry, and texindex isn't prepared for an index sort entry
4634 % that starts with \.
4636 % Since macro invocations are followed by braces, we can just redefine them
4637 % to take a single TeX argument. The case of a macro invocation that
4638 % goes to end-of-line is not handled.
4643 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4644 % ignore left quotes in the sort term.
4645 {\catcode`\`=\active
4646 \gdef\indexlquoteignore{\let`=\empty}}
4648 \let\indexbackslash=0 %overridden during \printindex.
4649 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4651 % Most index entries go through here, but \dosubind is the general case.
4652 % #1 is the index name, #2 is the entry text.
4653 \def\doind#1#2{\dosubind{#1}{#2}{}}
4655 % Workhorse for all \fooindexes.
4656 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4657 % empty if called from \doind, as we usually are (the main exception
4658 % is with most defuns, which call us directly).
4660 \def\dosubind#1#2#3{%
4663 % Store the main index entry text (including the third arg).
4665 % If third arg is present, precede it with a space.
4667 \ifx\thirdarg\empty \else
4668 \toks0 = \expandafter{\the\toks0 \space #3}%
4671 \edef\writeto{\csname#1indfile\endcsname}%
4673 \safewhatsit\dosubindwrite
4678 % Write the entry in \toks0 to the index file:
4680 \def\dosubindwrite{%
4681 % Put the index entry in the margin if desired.
4682 \ifx\SETmarginindex\relax\else
4683 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4686 % Remember, we are within a group.
4687 \indexdummies % Must do this here, since \bf, etc expand at this stage
4688 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4689 % so it will be output as is; and it will print as backslash.
4691 % Process the index entry with all font commands turned off, to
4692 % get the string to sort by.
4694 \edef\temp{\the\toks0}% need full expansion
4695 \xdef\indexsorttmp{\temp}%
4698 % Set up the complete index entry, with both the sort key and
4699 % the original text, including any font commands. We write
4700 % three arguments to \entry to the .?? file (four in the
4701 % subentry case), texindex reduces to two when writing the .??s
4705 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4710 % Take care of unwanted page breaks/skips around a whatsit:
4712 % If a skip is the last thing on the list now, preserve it
4713 % by backing up by \lastskip, doing the \write, then inserting
4714 % the skip again. Otherwise, the whatsit generated by the
4715 % \write or \pdfdest will make \lastskip zero. The result is that
4716 % sequences like this:
4720 % will have extra space inserted, because the \medbreak in the
4721 % start of the @defun won't see the skip inserted by the @end of
4722 % the previous defun.
4724 % But don't do any of this if we're not in vertical mode. We
4725 % don't want to do a \vskip and prematurely end a paragraph.
4727 % Avoid page breaks due to these extra skips, too.
4729 % But wait, there is a catch there:
4730 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4731 % sufficient for this purpose, as it ignores stretch and shrink parts
4732 % of the skip. The only way seems to be to check the textual
4733 % representation of the skip.
4735 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4736 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4738 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4740 \newskip\whatsitskip
4741 \newcount\whatsitpenalty
4745 \def\safewhatsit#1{\ifhmode
4748 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4749 \whatsitskip = \lastskip
4750 \edef\lastskipmacro{\the\lastskip}%
4751 \whatsitpenalty = \lastpenalty
4753 % If \lastskip is nonzero, that means the last item was a
4754 % skip. And since a skip is discardable, that means this
4755 % -\whatsitskip glue we're inserting is preceded by a
4756 % non-discardable item, therefore it is not a potential
4757 % breakpoint, therefore no \nobreak needed.
4758 \ifx\lastskipmacro\zeroskipmacro
4765 \ifx\lastskipmacro\zeroskipmacro
4766 % If \lastskip was zero, perhaps the last item was a penalty, and
4767 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4768 % to re-insert the same penalty (values >10000 are used for various
4769 % signals); since we just inserted a non-discardable item, any
4770 % following glue (such as a \parskip) would be a breakpoint. For example:
4771 % @deffn deffn-whatever
4772 % @vindex index-whatever
4774 % would allow a break between the index-whatever whatsit
4775 % and the "Description." paragraph.
4776 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4778 % On the other hand, if we had a nonzero \lastskip,
4779 % this make-up glue would be preceded by a non-discardable item
4780 % (the whatsit from the \write), so we must insert a \nobreak.
4781 \nobreak\vskip\whatsitskip
4785 % The index entry written in the file actually looks like
4786 % \entry {sortstring}{page}{topic}
4788 % \entry {sortstring}{page}{topic}{subtopic}
4789 % The texindex program reads in these files and writes files
4790 % containing these kinds of lines:
4792 % before the first topic whose initial is c
4793 % \entry {topic}{pagelist}
4794 % for a topic that is used without subtopics
4796 % for the beginning of a topic that is used with subtopics
4797 % \secondary {subtopic}{pagelist}
4798 % for each subtopic.
4800 % Define the user-accessible indexing commands
4801 % @findex, @vindex, @kindex, @cindex.
4803 \def\findex {\fnindex}
4804 \def\kindex {\kyindex}
4805 \def\cindex {\cpindex}
4806 \def\vindex {\vrindex}
4807 \def\tindex {\tpindex}
4808 \def\pindex {\pgindex}
4810 \def\cindexsub {\begingroup\obeylines\cindexsub}
4812 \gdef\cindexsub "#1" #2^^M{\endgroup %
4813 \dosubind{cp}{#2}{#1}}}
4815 % Define the macros used in formatting output of the sorted index material.
4817 % @printindex causes a particular index (the ??s file) to get printed.
4818 % It does not print any chapter heading (usually an @unnumbered).
4820 \parseargdef\printindex{\begingroup
4821 \dobreak \chapheadingskip{10000}%
4826 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4828 % See if the index file exists and is nonempty.
4829 % Change catcode of @ here so that if the index file contains
4831 % as its first line, TeX doesn't complain about mismatched braces
4832 % (because it thinks @} is a control sequence).
4834 \openin 1 \jobname.#1s
4836 % \enddoublecolumns gets confused if there is no text in the index,
4837 % and it loses the chapter title and the aux file entries for the
4838 % index. The easiest way to prevent this problem is to make sure
4839 % there is some text.
4840 \putwordIndexNonexistent
4843 % If the index file exists but is empty, then \openin leaves \ifeof
4844 % false. We have to make TeX try to read something from the file, so
4845 % it can discover if there is anything in it.
4848 \putwordIndexIsEmpty
4850 % Index files are almost Texinfo source, but we use \ as the escape
4851 % character. It would be better to use @, but that's too big a change
4852 % to make right now.
4853 \def\indexbackslash{\backslashcurfont}%
4864 % These macros are used by the sorted index file itself.
4865 % Change them to control the appearance of the index.
4868 % Some minor font changes for the special characters.
4869 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4871 % Remove any glue we may have, we'll be inserting our own.
4874 % We like breaks before the index initials, so insert a bonus.
4876 \vskip 0pt plus 3\baselineskip
4878 \vskip 0pt plus -3\baselineskip
4880 % Typeset the initial. Making this add up to a whole number of
4881 % baselineskips increases the chance of the dots lining up from column
4882 % to column. It still won't often be perfect, because of the stretch
4883 % we need before each entry, but it's better.
4885 % No shrink because it confuses \balancecolumns.
4886 \vskip 1.67\baselineskip plus .5\baselineskip
4887 \leftline{\secbf #1}%
4888 % Do our best not to break after the initial.
4890 \vskip .33\baselineskip plus .1\baselineskip
4893 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4894 % then page number (#2) flushed to the right margin. It is used for index
4895 % and table of contents entries. The paragraph is indented by \leftskip.
4897 % A straightforward implementation would start like this:
4898 % \def\entry#1#2{...
4899 % But this freezes the catcodes in the argument, and can cause problems to
4900 % @code, which sets - active. This problem was fixed by a kludge---
4901 % ``-'' was active throughout whole index, but this isn't really right.
4902 % The right solution is to prevent \entry from swallowing the whole text.
4907 % Start a new paragraph if necessary, so our assignments below can't
4908 % affect previous text.
4911 % Do not fill out the last line with white space.
4914 % No extra space above this paragraph.
4917 % Do not prefer a separate line ending with a hyphen to fewer lines.
4918 \finalhyphendemerits = 0
4920 % \hangindent is only relevant when the entry text and page number
4921 % don't both fit on one line. In that case, bob suggests starting the
4922 % dots pretty far over on the line. Unfortunately, a large
4923 % indentation looks wrong when the entry text itself is broken across
4924 % lines. So we use a small indentation and put up with long leaders.
4926 % \hangafter is reset to 1 (which is the value we want) at the start
4927 % of each paragraph, so we need not do anything with that.
4930 % When the entry text needs to be broken, just fill out the first line
4932 \rightskip = 0pt plus1fil
4934 % A bit of stretch before each entry for the benefit of balancing
4938 % When reading the text of entry, convert explicit line breaks
4939 % from @* into spaces. The user might give these in long section
4940 % titles, for instance.
4941 \def\*{\unskip\space\ignorespaces}%
4942 \def\entrybreak{\hfil\break}%
4944 % Swallow the left brace of the text (first parameter):
4945 \afterassignment\doentry
4948 \def\entrybreak{\unskip\space\ignorespaces}%
4950 \bgroup % Instead of the swallowed brace.
4952 \aftergroup\finishentry
4953 % And now comes the text of the entry.
4955 \def\finishentry#1{%
4956 % #1 is the page number.
4958 % The following is kludged to not output a line of dots in the index if
4959 % there are no page numbers. The next person who breaks this will be
4960 % cursed by a Unix daemon.
4961 \setbox\boxA = \hbox{#1}%
4962 \ifdim\wd\boxA = 0pt
4966 % If we must, put the page number on a line of its own, and fill out
4967 % this line with blank space. (The \hfil is overwhelmed with the
4968 % fill leaders glue in \indexdotfill if the page number does fit.)
4970 \null\nobreak\indexdotfill % Have leaders before the page number.
4972 % The `\ ' here is removed by the implicit \unskip that TeX does as
4973 % part of (the primitive) \par. Without it, a spurious underfull
4986 % Like plain.tex's \dotfill, except uses up at least 1 em.
4987 \def\indexdotfill{\cleaders
4988 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4990 \def\primary #1{\line{#1\hfil}}
4992 \newskip\secondaryindent \secondaryindent=0.5cm
4993 \def\secondary#1#2{{%
4998 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5000 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
5007 % Define two-column mode, which we use to typeset indexes.
5008 % Adapted from the TeXbook, page 416, which is to say,
5009 % the manmac.tex format used to print the TeXbook itself.
5013 \newdimen\doublecolumnhsize
5015 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5016 % Grab any single-column material above us.
5019 % Here is a possibility not foreseen in manmac: if we accumulate a
5020 % whole lot of material, we might end up calling this \output
5021 % routine twice in a row (see the doublecol-lose test, which is
5022 % essentially a couple of indexes with @setchapternewpage off). In
5023 % that case we just ship out what is in \partialpage with the normal
5024 % output routine. Generally, \partialpage will be empty when this
5025 % runs and this will be a no-op. See the indexspread.tex test case.
5026 \ifvoid\partialpage \else
5027 \onepageout{\pagecontents\partialpage}%
5030 \global\setbox\partialpage = \vbox{%
5031 % Unvbox the main output page.
5033 \kern-\topskip \kern\baselineskip
5036 \eject % run that output routine to set \partialpage
5038 % Use the double-column output routine for subsequent pages.
5039 \output = {\doublecolumnout}%
5041 % Change the page size parameters. We could do this once outside this
5042 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5043 % format, but then we repeat the same computation. Repeating a couple
5044 % of assignments once per index is clearly meaningless for the
5045 % execution time, so we may as well do it in one place.
5047 % First we halve the line length, less a little for the gutter between
5048 % the columns. We compute the gutter based on the line length, so it
5049 % changes automatically with the paper format. The magic constant
5050 % below is chosen so that the gutter has the same value (well, +-<1pt)
5051 % as it did when we hard-coded it.
5053 % We put the result in a separate register, \doublecolumhsize, so we
5054 % can restore it in \pagesofar, after \hsize itself has (potentially)
5057 \doublecolumnhsize = \hsize
5058 \advance\doublecolumnhsize by -.04154\hsize
5059 \divide\doublecolumnhsize by 2
5060 \hsize = \doublecolumnhsize
5062 % Double the \vsize as well. (We don't need a separate register here,
5063 % since nobody clobbers \vsize.)
5067 % The double-column output routine for all double-column pages except
5070 \def\doublecolumnout{%
5071 \splittopskip=\topskip \splitmaxdepth=\maxdepth
5072 % Get the available space for the double columns -- the normal
5073 % (undoubled) page height minus any material left over from the
5077 \advance\dimen@ by -\ht\partialpage
5079 % box0 will be the left-hand column, box2 the right.
5080 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
5081 \onepageout\pagesofar
5083 \penalty\outputpenalty
5086 % Re-output the contents of the output page -- any previous material,
5087 % followed by the two boxes we just split, in box0 and box2.
5091 \hsize = \doublecolumnhsize
5092 \wd0=\hsize \wd2=\hsize
5093 \hbox to\pagewidth{\box0\hfil\box2}%
5096 % All done with double columns.
5097 \def\enddoublecolumns{%
5098 % The following penalty ensures that the page builder is exercised
5099 % _before_ we change the output routine. This is necessary in the
5100 % following situation:
5102 % The last section of the index consists only of a single entry.
5103 % Before this section, \pagetotal is less than \pagegoal, so no
5104 % break occurs before the last section starts. However, the last
5105 % section, consisting of \initial and the single \entry, does not
5106 % fit on the page and has to be broken off. Without the following
5107 % penalty the page builder will not be exercised until \eject
5108 % below, and by that time we'll already have changed the output
5109 % routine to the \balancecolumns version, so the next-to-last
5110 % double-column page will be processed with \balancecolumns, which
5111 % is wrong: The two columns will go to the main vertical list, with
5112 % the broken-off section in the recent contributions. As soon as
5113 % the output routine finishes, TeX starts reconsidering the page
5114 % break. The two columns and the broken-off section both fit on the
5115 % page, because the two columns now take up only half of the page
5116 % goal. When TeX sees \eject from below which follows the final
5117 % section, it invokes the new output routine that we've set after
5118 % \balancecolumns below; \onepageout will try to fit the two columns
5119 % and the final section into the vbox of \pageheight (see
5120 % \pagebody), causing an overfull box.
5122 % Note that glue won't work here, because glue does not exercise the
5123 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5127 % Split the last of the double-column material. Leave it on the
5128 % current page, no automatic page break.
5131 % If we end up splitting too much material for the current page,
5132 % though, there will be another page break right after this \output
5133 % invocation ends. Having called \balancecolumns once, we do not
5134 % want to call it again. Therefore, reset \output to its normal
5135 % definition right away. (We hope \balancecolumns will never be
5136 % called on to balance too much material, but if it is, this makes
5137 % the output somewhat more palatable.)
5138 \global\output = {\onepageout{\pagecontents\PAGE}}%
5141 \endgroup % started in \begindoublecolumns
5143 % \pagegoal was set to the doubled \vsize above, since we restarted
5144 % the current page. We're now back to normal single-column
5145 % typesetting, so reset \pagegoal to the normal \vsize (after the
5146 % \endgroup where \vsize got restored).
5150 % Called at the end of the double column material.
5151 \def\balancecolumns{%
5152 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5154 \advance\dimen@ by \topskip
5155 \advance\dimen@ by-\baselineskip
5156 \divide\dimen@ by 2 % target to split to
5157 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5158 \splittopskip = \topskip
5159 % Loop until we get a decent breakpoint.
5163 \global\setbox3 = \copy0
5164 \global\setbox1 = \vsplit3 to \dimen@
5166 \global\advance\dimen@ by 1pt
5169 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5170 \setbox0=\vbox to\dimen@{\unvbox1}%
5171 \setbox2=\vbox to\dimen@{\unvbox3}%
5175 \catcode`\@ = \other
5178 \message{sectioning,}
5179 % Chapters, sections, etc.
5181 % Let's start with @part.
5182 \outer\parseargdef\part{\partzzz{#1}}
5186 \vskip.3\vsize % move it down on the page a bit
5188 \noindent \titlefonts\rmisbold #1\par % the text
5189 \let\lastnode=\empty % no node to associate with
5190 \writetocentry{part}{#1}{}% but put it in the toc
5191 \headingsoff % no headline or footline on the part page
5196 % \unnumberedno is an oxymoron. But we count the unnumbered
5197 % sections so that we can refer to them unambiguously in the pdf
5198 % outlines by their "section number". We avoid collisions with chapter
5199 % numbers by starting them at 10000. (If a document ever has 10000
5200 % chapters, we're in trouble anyway, I'm sure.)
5201 \newcount\unnumberedno \unnumberedno = 10000
5203 \newcount\secno \secno=0
5204 \newcount\subsecno \subsecno=0
5205 \newcount\subsubsecno \subsubsecno=0
5207 % This counter is funny since it counts through charcodes of letters A, B, ...
5208 \newcount\appendixno \appendixno = `\@
5210 % \def\appendixletter{\char\the\appendixno}
5211 % We do the following ugly conditional instead of the above simple
5212 % construct for the sake of pdftex, which needs the actual
5213 % letter in the expansion, not just typeset.
5215 \def\appendixletter{%
5216 \ifnum\appendixno=`A A%
5217 \else\ifnum\appendixno=`B B%
5218 \else\ifnum\appendixno=`C C%
5219 \else\ifnum\appendixno=`D D%
5220 \else\ifnum\appendixno=`E E%
5221 \else\ifnum\appendixno=`F F%
5222 \else\ifnum\appendixno=`G G%
5223 \else\ifnum\appendixno=`H H%
5224 \else\ifnum\appendixno=`I I%
5225 \else\ifnum\appendixno=`J J%
5226 \else\ifnum\appendixno=`K K%
5227 \else\ifnum\appendixno=`L L%
5228 \else\ifnum\appendixno=`M M%
5229 \else\ifnum\appendixno=`N N%
5230 \else\ifnum\appendixno=`O O%
5231 \else\ifnum\appendixno=`P P%
5232 \else\ifnum\appendixno=`Q Q%
5233 \else\ifnum\appendixno=`R R%
5234 \else\ifnum\appendixno=`S S%
5235 \else\ifnum\appendixno=`T T%
5236 \else\ifnum\appendixno=`U U%
5237 \else\ifnum\appendixno=`V V%
5238 \else\ifnum\appendixno=`W W%
5239 \else\ifnum\appendixno=`X X%
5240 \else\ifnum\appendixno=`Y Y%
5241 \else\ifnum\appendixno=`Z Z%
5242 % The \the is necessary, despite appearances, because \appendixletter is
5243 % expanded while writing the .toc file. \char\appendixno is not
5244 % expandable, thus it is written literally, thus all appendixes come out
5245 % with the same letter (or @) in the toc without it.
5246 \else\char\the\appendixno
5247 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5248 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5250 % Each @chapter defines these (using marks) as the number+name, number
5251 % and name of the chapter. Page headings and footings can use
5252 % these. @section does likewise.
5254 \def\thischapternum{}
5255 \def\thischaptername{}
5257 \def\thissectionnum{}
5258 \def\thissectionname{}
5260 \newcount\absseclevel % used to calculate proper heading level
5261 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5263 % @raisesections: treat @section as chapter, @subsection as section, etc.
5264 \def\raisesections{\global\advance\secbase by -1}
5265 \let\up=\raisesections % original BFox name
5267 % @lowersections: treat @chapter as section, @section as subsection, etc.
5268 \def\lowersections{\global\advance\secbase by 1}
5269 \let\down=\lowersections % original BFox name
5271 % we only have subsub.
5272 \chardef\maxseclevel = 3
5274 % A numbered section within an unnumbered changes to unnumbered too.
5275 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5276 \chardef\unnlevel = \maxseclevel
5278 % Trace whether the current chapter is an appendix or not:
5279 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5280 \def\chapheadtype{N}
5282 % Choose a heading macro
5283 % #1 is heading type
5284 % #2 is heading level
5285 % #3 is text for heading
5286 \def\genhead#1#2#3{%
5287 % Compute the abs. sec. level:
5289 \advance\absseclevel by \secbase
5290 % Make sure \absseclevel doesn't fall outside the range:
5291 \ifnum \absseclevel < 0
5294 \ifnum \absseclevel > 3
5301 \ifnum \absseclevel < \unnlevel
5302 \chardef\unnlevel = \absseclevel
5305 % Check for appendix sections:
5306 \ifnum \absseclevel = 0
5307 \edef\chapheadtype{\headtype}%
5309 \if \headtype A\if \chapheadtype N%
5310 \errmessage{@appendix... within a non-appendix chapter}%
5313 % Check for numbered within unnumbered:
5314 \ifnum \absseclevel > \unnlevel
5317 \chardef\unnlevel = 3
5320 % Now print the heading:
5324 \or \unnumberedseczzz{#3}%
5325 \or \unnumberedsubseczzz{#3}%
5326 \or \unnumberedsubsubseczzz{#3}%
5332 \or \appendixsectionzzz{#3}%
5333 \or \appendixsubseczzz{#3}%
5334 \or \appendixsubsubseczzz{#3}%
5340 \or \numberedsubseczzz{#3}%
5341 \or \numberedsubsubseczzz{#3}%
5345 \suppressfirstparagraphindent
5349 \def\numhead{\genhead N}
5350 \def\apphead{\genhead A}
5351 \def\unnmhead{\genhead U}
5353 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5354 % all lower-level sectioning counters to zero.
5356 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5357 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5358 \let\chaplevelprefix = \empty
5360 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5362 % section resetting is \global in case the chapter is in a group, such
5363 % as an @include file.
5364 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5365 \global\advance\chapno by 1
5368 \gdef\chaplevelprefix{\the\chapno.}%
5371 % \putwordChapter can contain complex things in translations.
5372 \toks0=\expandafter{\putwordChapter}%
5373 \message{\the\toks0 \space \the\chapno}%
5375 % Write the actual heading.
5376 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5378 % So @section and the like are numbered underneath this chapter.
5379 \global\let\section = \numberedsec
5380 \global\let\subsection = \numberedsubsec
5381 \global\let\subsubsection = \numberedsubsubsec
5384 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5386 \def\appendixzzz#1{%
5387 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5388 \global\advance\appendixno by 1
5389 \gdef\chaplevelprefix{\appendixletter.}%
5392 % \putwordAppendix can contain complex things in translations.
5393 \toks0=\expandafter{\putwordAppendix}%
5394 \message{\the\toks0 \space \appendixletter}%
5396 \chapmacro{#1}{Yappendix}{\appendixletter}%
5398 \global\let\section = \appendixsec
5399 \global\let\subsection = \appendixsubsec
5400 \global\let\subsubsection = \appendixsubsubsec
5403 % normally unnmhead0 calls unnumberedzzz:
5404 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5405 \def\unnumberedzzz#1{%
5406 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5407 \global\advance\unnumberedno by 1
5409 % Since an unnumbered has no number, no prefix for figures.
5410 \global\let\chaplevelprefix = \empty
5413 % This used to be simply \message{#1}, but TeX fully expands the
5414 % argument to \message. Therefore, if #1 contained @-commands, TeX
5415 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5416 % expanded @cite (which turns out to cause errors because \cite is meant
5417 % to be executed, not expanded).
5419 % Anyway, we don't want the fully-expanded definition of @cite to appear
5420 % as a result of the \message, we just want `@cite' itself. We use
5421 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5422 % simply yielding the contents of <toks register>. (We also do this for
5425 \message{(\the\toks0)}%
5427 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5429 \global\let\section = \unnumberedsec
5430 \global\let\subsection = \unnumberedsubsec
5431 \global\let\subsubsection = \unnumberedsubsubsec
5434 % @centerchap is like @unnumbered, but the heading is centered.
5435 \outer\parseargdef\centerchap{%
5436 % Well, we could do the following in a group, but that would break
5437 % an assumption that \chapmacro is called at the outermost level.
5438 % Thus we are safer this way: --kasal, 24feb04
5439 \let\centerparametersmaybe = \centerparameters
5441 \let\centerparametersmaybe = \relax
5444 % @top is like @unnumbered.
5449 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5451 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5452 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5455 % normally calls appendixsectionzzz:
5456 \outer\parseargdef\appendixsection{\apphead1{#1}}
5457 \def\appendixsectionzzz#1{%
5458 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5459 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5461 \let\appendixsec\appendixsection
5463 % normally calls unnumberedseczzz:
5464 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5465 \def\unnumberedseczzz#1{%
5466 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5467 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5472 % normally calls numberedsubseczzz:
5473 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5474 \def\numberedsubseczzz#1{%
5475 \global\subsubsecno=0 \global\advance\subsecno by 1
5476 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5479 % normally calls appendixsubseczzz:
5480 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5481 \def\appendixsubseczzz#1{%
5482 \global\subsubsecno=0 \global\advance\subsecno by 1
5483 \sectionheading{#1}{subsec}{Yappendix}%
5484 {\appendixletter.\the\secno.\the\subsecno}%
5487 % normally calls unnumberedsubseczzz:
5488 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5489 \def\unnumberedsubseczzz#1{%
5490 \global\subsubsecno=0 \global\advance\subsecno by 1
5491 \sectionheading{#1}{subsec}{Ynothing}%
5492 {\the\unnumberedno.\the\secno.\the\subsecno}%
5497 % normally numberedsubsubseczzz:
5498 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5499 \def\numberedsubsubseczzz#1{%
5500 \global\advance\subsubsecno by 1
5501 \sectionheading{#1}{subsubsec}{Ynumbered}%
5502 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5505 % normally appendixsubsubseczzz:
5506 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5507 \def\appendixsubsubseczzz#1{%
5508 \global\advance\subsubsecno by 1
5509 \sectionheading{#1}{subsubsec}{Yappendix}%
5510 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5513 % normally unnumberedsubsubseczzz:
5514 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5515 \def\unnumberedsubsubseczzz#1{%
5516 \global\advance\subsubsecno by 1
5517 \sectionheading{#1}{subsubsec}{Ynothing}%
5518 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5521 % These macros control what the section commands do, according
5522 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5523 % Define them by default for a numbered chapter.
5524 \let\section = \numberedsec
5525 \let\subsection = \numberedsubsec
5526 \let\subsubsection = \numberedsubsubsec
5528 % Define @majorheading, @heading and @subheading
5530 % NOTE on use of \vbox for chapter headings, section headings, and such:
5531 % 1) We use \vbox rather than the earlier \line to permit
5532 % overlong headings to fold.
5533 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5534 % heading is obnoxious; this forbids it.
5535 % 3) Likewise, headings look best if no \parindent is used, and
5536 % if justification is not attempted. Hence \raggedright.
5539 {\advance\chapheadingskip by 10pt \chapbreak }%
5540 \parsearg\chapheadingzzz
5543 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5544 \def\chapheadingzzz#1{%
5545 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5546 \parindent=0pt\ptexraggedright
5547 \rmisbold #1\hfill}}%
5548 \bigskip \par\penalty 200\relax
5549 \suppressfirstparagraphindent
5552 % @heading, @subheading, @subsubheading.
5553 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5554 \suppressfirstparagraphindent}
5555 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5556 \suppressfirstparagraphindent}
5557 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5558 \suppressfirstparagraphindent}
5560 % These macros generate a chapter, section, etc. heading only
5561 % (including whitespace, linebreaking, etc. around it),
5562 % given all the information in convenient, parsed form.
5564 % Args are the skip and penalty (usually negative)
5565 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5567 % Parameter controlling skip before chapter headings (if needed)
5568 \newskip\chapheadingskip
5570 % Define plain chapter starts, and page on/off switching for it.
5571 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5572 \def\chappager{\par\vfill\supereject}
5573 % Because \domark is called before \chapoddpage, the filler page will
5574 % get the headings for the next chapter, which is wrong. But we don't
5575 % care -- we just disable all headings on the filler page.
5587 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5590 \global\let\contentsalignmacro = \chappager
5591 \global\let\pchapsepmacro=\chapbreak
5592 \global\let\pagealignmacro=\chappager}
5595 \global\let\contentsalignmacro = \chappager
5596 \global\let\pchapsepmacro=\chappager
5597 \global\let\pagealignmacro=\chappager
5598 \global\def\HEADINGSon{\HEADINGSsingle}}
5601 \global\let\contentsalignmacro = \chapoddpage
5602 \global\let\pchapsepmacro=\chapoddpage
5603 \global\let\pagealignmacro=\chapoddpage
5604 \global\def\HEADINGSon{\HEADINGSdouble}}
5610 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5611 % Yappendix, Yomitfromtoc), #3 the chapter number.
5613 % To test against our argument.
5614 \def\Ynothingkeyword{Ynothing}
5615 \def\Yomitfromtockeyword{Yomitfromtoc}
5616 \def\Yappendixkeyword{Yappendix}
5618 \def\chapmacro#1#2#3{%
5619 % Insert the first mark before the heading break (see notes for \domark).
5620 \let\prevchapterdefs=\lastchapterdefs
5621 \let\prevsectiondefs=\lastsectiondefs
5622 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5623 \gdef\thissection{}}%
5626 \ifx\temptype\Ynothingkeyword
5627 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5628 \gdef\thischapter{\thischaptername}}%
5629 \else\ifx\temptype\Yomitfromtockeyword
5630 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5631 \gdef\thischapter{}}%
5632 \else\ifx\temptype\Yappendixkeyword
5634 \xdef\lastchapterdefs{%
5635 \gdef\noexpand\thischaptername{\the\toks0}%
5636 \gdef\noexpand\thischapternum{\appendixletter}%
5637 % \noexpand\putwordAppendix avoids expanding indigestible
5638 % commands in some of the translations.
5639 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5640 \noexpand\thischapternum:
5641 \noexpand\thischaptername}%
5645 \xdef\lastchapterdefs{%
5646 \gdef\noexpand\thischaptername{\the\toks0}%
5647 \gdef\noexpand\thischapternum{\the\chapno}%
5648 % \noexpand\putwordChapter avoids expanding indigestible
5649 % commands in some of the translations.
5650 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5651 \noexpand\thischapternum:
5652 \noexpand\thischaptername}%
5656 % Output the mark. Pass it through \safewhatsit, to take care of
5657 % the preceding space.
5660 % Insert the chapter heading break.
5663 % Now the second mark, after the heading break. No break points
5664 % between here and the heading.
5665 \let\prevchapterdefs=\lastchapterdefs
5666 \let\prevsectiondefs=\lastsectiondefs
5670 \chapfonts \rmisbold
5672 % Have to define \lastsection before calling \donoderef, because the
5673 % xref code eventually uses it. On the other hand, it has to be called
5674 % after \pchapsepmacro, or the headline will change too soon.
5675 \gdef\lastsection{#1}%
5677 % Only insert the separating space if we have a chapter/appendix
5678 % number, and don't print the unnumbered ``number''.
5679 \ifx\temptype\Ynothingkeyword
5681 \def\toctype{unnchap}%
5682 \else\ifx\temptype\Yomitfromtockeyword
5683 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5685 \else\ifx\temptype\Yappendixkeyword
5686 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5689 \setbox0 = \hbox{#3\enspace}%
5690 \def\toctype{numchap}%
5693 % Write the toc entry for this chapter. Must come before the
5694 % \donoderef, because we include the current node name in the toc
5695 % entry, and \donoderef resets it to empty.
5696 \writetocentry{\toctype}{#1}{#3}%
5698 % For pdftex, we have to write out the node definition (aka, make
5699 % the pdfdest) after any page break, but before the actual text has
5700 % been typeset. If the destination for the pdf outline is after the
5701 % text, then jumping from the outline may wind up with the text not
5702 % being visible, for instance under high magnification.
5705 % Typeset the actual heading.
5706 \nobreak % Avoid page breaks at the interline glue.
5707 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5708 \hangindent=\wd0 \centerparametersmaybe
5711 \nobreak\bigskip % no page break after a chapter title
5715 % @centerchap -- centered and unnumbered.
5716 \let\centerparametersmaybe = \relax
5717 \def\centerparameters{%
5718 \advance\rightskip by 3\rightskip
5719 \leftskip = \rightskip
5724 % I don't think this chapter style is supported any more, so I'm not
5725 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5727 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5729 \def\unnchfopen #1{%
5730 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5731 \parindent=0pt\ptexraggedright
5732 \rmisbold #1\hfill}}\bigskip \par\nobreak
5734 \def\chfopen #1#2{\chapoddpage {\chapfonts
5735 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5738 \def\centerchfopen #1{%
5739 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5741 \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
5744 \global\let\chapmacro=\chfopen
5745 \global\let\centerchapmacro=\centerchfopen}
5748 % Section titles. These macros combine the section number parts and
5749 % call the generic \sectionheading to do the printing.
5751 \newskip\secheadingskip
5752 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5754 % Subsection titles.
5755 \newskip\subsecheadingskip
5756 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5758 % Subsubsection titles.
5759 \def\subsubsecheadingskip{\subsecheadingskip}
5760 \def\subsubsecheadingbreak{\subsecheadingbreak}
5763 % Print any size, any type, section title.
5765 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5766 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5769 \def\seckeyword{sec}
5771 \def\sectionheading#1#2#3#4{%
5773 \checkenv{}% should not be in an environment.
5775 % Switch to the right set of fonts.
5776 \csname #2fonts\endcsname \rmisbold
5778 \def\sectionlevel{#2}%
5781 % Insert first mark before the heading break (see notes for \domark).
5782 \let\prevsectiondefs=\lastsectiondefs
5783 \ifx\temptype\Ynothingkeyword
5784 \ifx\sectionlevel\seckeyword
5785 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5786 \gdef\thissection{\thissectionname}}%
5788 \else\ifx\temptype\Yomitfromtockeyword
5789 % Don't redefine \thissection.
5790 \else\ifx\temptype\Yappendixkeyword
5791 \ifx\sectionlevel\seckeyword
5793 \xdef\lastsectiondefs{%
5794 \gdef\noexpand\thissectionname{\the\toks0}%
5795 \gdef\noexpand\thissectionnum{#4}%
5796 % \noexpand\putwordSection avoids expanding indigestible
5797 % commands in some of the translations.
5798 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5799 \noexpand\thissectionnum:
5800 \noexpand\thissectionname}%
5804 \ifx\sectionlevel\seckeyword
5806 \xdef\lastsectiondefs{%
5807 \gdef\noexpand\thissectionname{\the\toks0}%
5808 \gdef\noexpand\thissectionnum{#4}%
5809 % \noexpand\putwordSection avoids expanding indigestible
5810 % commands in some of the translations.
5811 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5812 \noexpand\thissectionnum:
5813 \noexpand\thissectionname}%
5818 % Go into vertical mode. Usually we'll already be there, but we
5819 % don't want the following whatsit to end up in a preceding paragraph
5820 % if the document didn't happen to have a blank line.
5823 % Output the mark. Pass it through \safewhatsit, to take care of
5824 % the preceding space.
5827 % Insert space above the heading.
5828 \csname #2headingbreak\endcsname
5830 % Now the second mark, after the heading break. No break points
5831 % between here and the heading.
5832 \let\prevsectiondefs=\lastsectiondefs
5835 % Only insert the space after the number if we have a section number.
5836 \ifx\temptype\Ynothingkeyword
5839 \gdef\lastsection{#1}%
5840 \else\ifx\temptype\Yomitfromtockeyword
5841 % for @headings -- no section number, don't include in toc,
5842 % and don't redefine \lastsection.
5845 \let\sectionlevel=\empty
5846 \else\ifx\temptype\Yappendixkeyword
5847 \setbox0 = \hbox{#4\enspace}%
5849 \gdef\lastsection{#1}%
5851 \setbox0 = \hbox{#4\enspace}%
5853 \gdef\lastsection{#1}%
5856 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5857 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5859 % Write the node reference (= pdf destination for pdftex).
5860 % Again, see comments in \chapmacro.
5863 % Interline glue will be inserted when the vbox is completed.
5864 % That glue will be a valid breakpoint for the page, since it'll be
5865 % preceded by a whatsit (usually from the \donoderef, or from the
5866 % \writetocentry if there was no node). We don't want to allow that
5867 % break, since then the whatsits could end up on page n while the
5868 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5871 % Output the actual section heading.
5872 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5873 \hangindent=\wd0 % zero if no section number
5876 % Add extra space after the heading -- half of whatever came above it.
5877 % Don't allow stretch, though.
5878 \kern .5 \csname #2headingskip\endcsname
5880 % Do not let the kern be a potential breakpoint, as it would be if it
5881 % was followed by glue.
5884 % We'll almost certainly start a paragraph next, so don't let that
5885 % glue accumulate. (Not a breakpoint because it's preceded by a
5886 % discardable item.) However, when a paragraph is not started next
5887 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
5888 % or the negative glue will cause weirdly wrong output, typically
5889 % obscuring the section heading with something else.
5892 % This is so the last item on the main vertical list is a known
5893 % \penalty > 10000, so \startdefun, etc., can recognize the situation
5894 % and do the needful.
5900 % Table of contents.
5903 % Write an entry to the toc file, opening it if necessary.
5904 % Called from @chapter, etc.
5906 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5907 % We append the current node name (if any) and page number as additional
5908 % arguments for the \{chap,sec,...}entry macros which will eventually
5909 % read this. The node name is used in the pdf outlines as the
5910 % destination to jump to.
5912 % We open the .toc file for writing here instead of at @setfilename (or
5913 % any other fixed time) so that @contents can be anywhere in the document.
5914 % But if #1 is `omit', then we don't do anything. This is used for the
5915 % table of contents chapter openings themselves.
5917 \newif\iftocfileopened
5918 \def\omitkeyword{omit}%
5920 \def\writetocentry#1#2#3{%
5921 \edef\writetoctype{#1}%
5922 \ifx\writetoctype\omitkeyword \else
5923 \iftocfileopened\else
5924 \immediate\openout\tocfile = \jobname.toc
5925 \global\tocfileopenedtrue
5931 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5937 % Tell \shipout to create a pdf destination on each page, if we're
5938 % writing pdf. These are used in the table of contents. We can't
5939 % just write one on every page because the title pages are numbered
5940 % 1 and 2 (the page numbers aren't printed), and so are the first
5941 % two pages of the document. Thus, we'd have two destinations named
5942 % `1', and two named `2'.
5943 \ifpdf \global\pdfmakepagedesttrue \fi
5947 % These characters do not print properly in the Computer Modern roman
5948 % fonts, so we must take special care. This is more or less redundant
5949 % with the Texinfo input format setup at the end of this file.
5951 \def\activecatcodes{%
5964 % Read the toc file, which is essentially Texinfo input.
5968 \input \tocreadfilename
5971 \newskip\contentsrightmargin \contentsrightmargin=1in
5972 \newcount\savepageno
5973 \newcount\lastnegativepageno \lastnegativepageno = -1
5975 % Prepare to read what we've written to \tocfile.
5977 \def\startcontents#1{%
5978 % If @setchapternewpage on, and @headings double, the contents should
5979 % start on an odd page, unlike chapters. Thus, we maintain
5980 % \contentsalignmacro in parallel with \pagealignmacro.
5981 % From: Torbjorn Granlund <tege@matematik.su.se>
5983 \immediate\closeout\tocfile
5985 % Don't need to put `Contents' or `Short Contents' in the headline.
5986 % It is abundantly clear what they are.
5987 \chapmacro{#1}{Yomitfromtoc}{}%
5989 \savepageno = \pageno
5990 \begingroup % Set up to handle contents files properly.
5991 \raggedbottom % Worry more about breakpoints than the bottom.
5992 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5994 % Roman numerals for page numbers.
5995 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5998 % redefined for the two-volume lispref. We always output on
5999 % \jobname.toc even if this is redefined.
6001 \def\tocreadfilename{\jobname.toc}
6003 % Normal (long) toc.
6006 \startcontents{\putwordTOC}%
6007 \openin 1 \tocreadfilename\space
6012 \contentsalignmacro % in case @setchapternewpage odd is in effect
6018 \lastnegativepageno = \pageno
6019 \global\pageno = \savepageno
6022 % And just the chapters.
6023 \def\summarycontents{%
6024 \startcontents{\putwordShortTOC}%
6026 \let\partentry = \shortpartentry
6027 \let\numchapentry = \shortchapentry
6028 \let\appentry = \shortchapentry
6029 \let\unnchapentry = \shortunnchapentry
6030 % We want a true roman here for the page numbers.
6032 \let\rm=\shortcontrm \let\bf=\shortcontbf
6033 \let\sl=\shortcontsl \let\tt=\shortconttt
6035 \hyphenpenalty = 10000
6036 \advance\baselineskip by 1pt % Open it up a little.
6037 \def\numsecentry##1##2##3##4{}
6038 \let\appsecentry = \numsecentry
6039 \let\unnsecentry = \numsecentry
6040 \let\numsubsecentry = \numsecentry
6041 \let\appsubsecentry = \numsecentry
6042 \let\unnsubsecentry = \numsecentry
6043 \let\numsubsubsecentry = \numsecentry
6044 \let\appsubsubsecentry = \numsecentry
6045 \let\unnsubsubsecentry = \numsecentry
6046 \openin 1 \tocreadfilename\space
6052 \contentsalignmacro % in case @setchapternewpage odd is in effect
6054 \lastnegativepageno = \pageno
6055 \global\pageno = \savepageno
6057 \let\shortcontents = \summarycontents
6059 % Typeset the label for a chapter or appendix for the short contents.
6060 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6062 \def\shortchaplabel#1{%
6063 % This space should be enough, since a single number is .5em, and the
6064 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6065 % But use \hss just in case.
6066 % (This space doesn't include the extra space that gets added after
6067 % the label; that gets put in by \shortchapentry above.)
6069 % We'd like to right-justify chapter numbers, but that looks strange
6070 % with appendix letters. And right-justifying numbers and
6071 % left-justifying letters looks strange when there is less than 10
6072 % chapters. Have to read the whole toc once to know how many chapters
6073 % there are before deciding ...
6074 \hbox to 1em{#1\hss}%
6077 % These macros generate individual entries in the table of contents.
6078 % The first argument is the chapter or section name.
6079 % The last argument is the page number.
6080 % The arguments in between are the chapter number, section number, ...
6082 % Parts, in the main contents. Replace the part number, which doesn't
6083 % exist, with an empty box. Let's hope all the numbers have the same width.
6084 % Also ignore the page number, which is conventionally not printed.
6085 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6086 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6088 % Parts, in the short toc.
6089 \def\shortpartentry#1#2#3#4{%
6091 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6092 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6095 % Chapters, in the main contents.
6096 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6098 % Chapters, in the short toc.
6099 % See comments in \dochapentry re vbox and related settings.
6100 \def\shortchapentry#1#2#3#4{%
6101 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6104 % Appendices, in the main contents.
6105 % Need the word Appendix, and a fixed-size box.
6107 \def\appendixbox#1{%
6108 % We use M since it's probably the widest letter.
6109 \setbox0 = \hbox{\putwordAppendix{} M}%
6110 \hbox to \wd0{\putwordAppendix{} #1\hss}}
6112 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6114 % Unnumbered chapters.
6115 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6116 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6119 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6120 \let\appsecentry=\numsecentry
6121 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6124 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6125 \let\appsubsecentry=\numsubsecentry
6126 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6128 % And subsubsections.
6129 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6130 \let\appsubsubsecentry=\numsubsubsecentry
6131 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6133 % This parameter controls the indentation of the various levels.
6134 % Same as \defaultparindent.
6135 \newdimen\tocindent \tocindent = 15pt
6137 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6140 % If the toc has to be broken over pages, we want it to be at chapters
6141 % if at all possible; hence the \penalty.
6142 \def\dochapentry#1#2{%
6143 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6146 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6148 \nobreak\vskip .25\baselineskip plus.1\baselineskip
6151 \def\dosecentry#1#2{\begingroup
6152 \secentryfonts \leftskip=\tocindent
6153 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6156 \def\dosubsecentry#1#2{\begingroup
6157 \subsecentryfonts \leftskip=2\tocindent
6158 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6161 \def\dosubsubsecentry#1#2{\begingroup
6162 \subsubsecentryfonts \leftskip=3\tocindent
6163 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6166 % We use the same \entry macro as for the index entries.
6167 \let\tocentry = \entry
6169 % Space between chapter (or whatever) number and the title.
6170 \def\labelspace{\hskip1em \relax}
6172 \def\dopageno#1{{\rm #1}}
6173 \def\doshortpageno#1{{\rm #1}}
6175 \def\chapentryfonts{\secfonts \rm}
6176 \def\secentryfonts{\textfonts}
6177 \def\subsecentryfonts{\textfonts}
6178 \def\subsubsecentryfonts{\textfonts}
6181 \message{environments,}
6182 % @foo ... @end foo.
6184 % @tex ... @end tex escapes into raw TeX temporarily.
6185 % One exception: @ is still an escape character, so that @end tex works.
6186 % But \@ or @@ will get a plain @ character.
6189 \setupmarkupstyle{tex}%
6190 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6191 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6192 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6203 % ' is active in math mode (mathcode"8000). So reset it, and all our
6204 % other math active characters (just in case), to plain's definitions.
6208 \let\bullet=\ptexbullet
6213 \let\equiv=\ptexequiv
6216 \let\indent=\ptexindent
6217 \let\noindent=\ptexnoindent
6224 \expandafter \let\csname top\endcsname=\ptextop % outer
6225 \let\frenchspacing=\plainfrenchspacing
6227 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6228 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6231 % There is no need to define \Etex.
6233 % Define @lisp ... @end lisp.
6234 % @lisp environment forms a group so it can rebind things,
6235 % including the definition of @end lisp (which normally is erroneous).
6237 % Amount to narrow the margins by for @lisp.
6238 \newskip\lispnarrowing \lispnarrowing=0.4in
6240 % This is the definition that ^^M gets inside @lisp, @example, and other
6241 % such environments. \null is better than a space, since it doesn't
6243 \def\lisppar{\null\endgraf}
6245 % This space is always present above and below environments.
6246 \newskip\envskipamount \envskipamount = 0pt
6248 % Make spacing and below environment symmetrical. We use \parskip here
6249 % to help in doing that, since in @example-like environments \parskip
6250 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6251 % start of the next paragraph will insert \parskip.
6253 \def\aboveenvbreak{{%
6254 % =10000 instead of <10000 because of a special case in \itemzzz and
6255 % \sectionheading, q.v.
6256 \ifnum \lastpenalty=10000 \else
6257 \advance\envskipamount by \parskip
6259 \ifdim\lastskip<\envskipamount
6261 % it's not a good place to break if the last penalty was \nobreak
6263 \ifnum\lastpenalty<10000 \penalty-50 \fi
6264 \vskip\envskipamount
6269 \let\afterenvbreak = \aboveenvbreak
6271 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6272 % also clear it, so that its embedded environments do the narrowing again.
6273 \let\nonarrowing=\relax
6275 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6276 % environment contents.
6277 \font\circle=lcircle10
6279 \newdimen\cartouter\newdimen\cartinner
6280 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6281 \circthick=\fontdimen8\circle
6283 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6284 \def\ctr{{\hskip 6pt\circle\char'010}}
6285 \def\cbl{{\circle\char'012\hskip -6pt}}
6286 \def\cbr{{\hskip 6pt\circle\char'011}}
6287 \def\carttop{\hbox to \cartouter{\hskip\lskip
6288 \ctl\leaders\hrule height\circthick\hfil\ctr
6290 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6291 \cbl\leaders\hrule height\circthick\hfil\cbr
6294 \newskip\lskip\newskip\rskip
6297 \ifhmode\par\fi % can't be in the midst of a paragraph.
6299 \lskip=\leftskip \rskip=\rightskip
6300 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6301 \cartinner=\hsize \advance\cartinner by-\lskip
6302 \advance\cartinner by-\rskip
6304 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6305 % side, and for 6pt waste from
6306 % each corner char, and rule thickness
6307 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6308 % Flag to tell @lisp, etc., not to narrow margin.
6309 \let\nonarrowing = t%
6311 % If this cartouche directly follows a sectioning command, we need the
6312 % \parskip glue (backspaced over by default) or the cartouche can
6313 % collide with the section heading.
6314 \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
6317 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6325 \baselineskip=\normbskip
6326 \lineskip=\normlskip
6329 \comment % For explanation, see the end of def\group.
6344 % This macro is called at the beginning of all the @example variants,
6346 \newdimen\nonfillparindent
6349 \hfuzz = 12pt % Don't be fussy
6350 \sepspaces % Make spaces be word-separators rather than space tokens.
6351 \let\par = \lisppar % don't ignore blank lines
6352 \obeylines % each line of input is a line of output
6354 % Turn off paragraph indentation but redefine \indent to emulate
6355 % the normal \indent.
6356 \nonfillparindent=\parindent
6358 \let\indent\nonfillindent
6360 \emergencystretch = 0pt % don't try to avoid overfull boxes
6361 \ifx\nonarrowing\relax
6362 \advance \leftskip by \lispnarrowing
6363 \exdentamount=\lispnarrowing
6365 \let\nonarrowing = \relax
6367 \let\exdent=\nofillexdent
6372 % We want to swallow spaces (but not other tokens) after the fake
6373 % @indent in our nonfill-environments, where spaces are normally
6374 % active and set to @tie, resulting in them not being ignored after
6376 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6377 \gdef\nonfillindentcheck{%
6379 \expandafter\nonfillindentgobble%
6381 \leavevmode\nonfillindentbox%
6385 \def\nonfillindentgobble#1{\nonfillindent}
6386 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6388 % If you want all examples etc. small: @set dispenvsize small.
6389 % If you want even small examples the full size: @set dispenvsize nosmall.
6390 % This affects the following displayed environments:
6391 % @example, @display, @format, @lisp
6393 \def\smallword{small}
6394 \def\nosmallword{nosmall}
6395 \let\SETdispenvsize\relax
6396 \def\setnormaldispenv{%
6397 \ifx\SETdispenvsize\smallword
6398 % end paragraph for sake of leading, in case document has no blank
6399 % line. This is redundant with what happens in \aboveenvbreak, but
6400 % we need to do it before changing the fonts, and it's inconvenient
6401 % to change the fonts afterward.
6402 \ifnum \lastpenalty=10000 \else \endgraf \fi
6403 \smallexamplefonts \rm
6406 \def\setsmalldispenv{%
6407 \ifx\SETdispenvsize\nosmallword
6409 \ifnum \lastpenalty=10000 \else \endgraf \fi
6410 \smallexamplefonts \rm
6414 % We often define two environments, @foo and @smallfoo.
6415 % Let's do it in one command. #1 is the env name, #2 the definition.
6416 \def\makedispenvdef#1#2{%
6417 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6418 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6419 \expandafter\let\csname E#1\endcsname \afterenvbreak
6420 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6423 % Define two environment synonyms (#1 and #2) for an environment.
6424 \def\maketwodispenvdef#1#2#3{%
6425 \makedispenvdef{#1}{#3}%
6426 \makedispenvdef{#2}{#3}%
6429 % @lisp: indented, narrowed, typewriter font;
6430 % @example: same as @lisp.
6432 % @smallexample and @smalllisp: use smaller fonts.
6433 % Originally contributed by Pavel@xerox.
6435 \maketwodispenvdef{lisp}{example}{%
6437 \tt\setupmarkupstyle{example}%
6438 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6439 \gobble % eat return
6441 % @display/@smalldisplay: same as @lisp except keep current font.
6443 \makedispenvdef{display}{%
6448 % @format/@smallformat: same as @display except don't narrow margins.
6450 \makedispenvdef{format}{%
6451 \let\nonarrowing = t%
6456 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6458 \let\nonarrowing = t%
6462 \let\Eflushleft = \afterenvbreak
6466 \envdef\flushright{%
6467 \let\nonarrowing = t%
6469 \advance\leftskip by 0pt plus 1fill\relax
6472 \let\Eflushright = \afterenvbreak
6475 % @raggedright does more-or-less normal line breaking but no right
6476 % justification. From plain.tex.
6477 \envdef\raggedright{%
6478 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6480 \let\Eraggedright\par
6482 \envdef\raggedleft{%
6483 \parindent=0pt \leftskip0pt plus2em
6484 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6485 \hbadness=10000 % Last line will usually be underfull, so turn off
6486 % badness reporting.
6488 \let\Eraggedleft\par
6490 \envdef\raggedcenter{%
6491 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6492 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6493 \hbadness=10000 % Last line will usually be underfull, so turn off
6494 % badness reporting.
6496 \let\Eraggedcenter\par
6499 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6500 % and narrows the margins. We keep \parskip nonzero in general, since
6501 % we're doing normal filling. So, when using \aboveenvbreak and
6502 % \afterenvbreak, temporarily make \parskip 0.
6504 \makedispenvdef{quotation}{\quotationstart}
6506 \def\quotationstart{%
6507 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6510 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6511 \ifx\nonarrowing\relax
6512 \advance\leftskip by \lispnarrowing
6513 \advance\rightskip by \lispnarrowing
6514 \exdentamount = \lispnarrowing
6516 \let\nonarrowing = \relax
6518 \parsearg\quotationlabel
6521 % We have retained a nonzero parskip for the environment, since we're
6522 % doing normal filling.
6526 \ifx\quotationauthor\thisisundefined\else
6528 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6530 {\parskip=0pt \afterenvbreak}%
6532 \def\Esmallquotation{\Equotation}
6534 % If we're given an argument, typeset it in bold with a colon after.
6535 \def\quotationlabel#1{%
6537 \ifx\temp\empty \else
6543 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6544 % If we want to allow any <char> as delimiter,
6545 % we need the curly braces so that makeinfo sees the @verb command, eg:
6546 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6548 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6550 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6551 % active too. Otherwise, they get lost as the first character on a
6554 \do\ \do\\\do\{\do\}\do\$\do\&%
6555 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6556 \do\<\do\>\do\|\do\@\do+\do\"%
6557 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6558 % @set txicodequotebacktick will not have effect on @verb and
6559 % @verbatim, and ?` and !` ligatures won't get disabled.
6564 \def\uncatcodespecials{%
6565 \def\do##1{\catcode`##1=\other}\dospecials}
6567 % Setup for the @verb command.
6569 % Eight spaces for a tab
6571 \catcode`\^^I=\active
6572 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6576 \tt % easiest (and conventionally used) font for verbatim
6577 \def\par{\leavevmode\endgraf}%
6578 \setupmarkupstyle{verb}%
6580 % Respect line breaks,
6581 % print special symbols as themselves, and
6582 % make each space count
6583 % must do in this order:
6584 \obeylines \uncatcodespecials \sepspaces
6587 % Setup for the @verbatim environment
6589 % Real tab expansion.
6590 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6592 % We typeset each line of the verbatim in an \hbox, so we can handle
6593 % tabs. The \global is in case the verbatim line starts with an accent,
6594 % or some other command that starts with a begin-group. Otherwise, the
6595 % entire \verbbox would disappear at the corresponding end-group, before
6596 % it is typeset. Meanwhile, we can't have nested verbatim commands
6597 % (can we?), so the \global won't be overwriting itself.
6599 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
6602 \catcode`\^^I=\active
6604 \catcode`\^^I=\active
6605 \def^^I{\leavevmode\egroup
6606 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
6607 \divide\dimen\verbbox by\tabw
6608 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
6609 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
6610 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
6615 % start the verbatim environment.
6616 \def\setupverbatim{%
6617 \let\nonarrowing = t%
6619 \tt % easiest (and conventionally used) font for verbatim
6620 % The \leavevmode here is for blank lines. Otherwise, we would
6621 % never \starttabox and the \egroup would end verbatim mode.
6622 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6624 \setupmarkupstyle{verbatim}%
6625 % Respect line breaks,
6626 % print special symbols as themselves, and
6627 % make each space count.
6628 % Must do in this order:
6629 \obeylines \uncatcodespecials \sepspaces
6630 \everypar{\starttabbox}%
6633 % Do the @verb magic: verbatim text is quoted by unique
6634 % delimiter characters. Before first delimiter expect a
6635 % right brace, after last delimiter expect closing brace:
6637 % \def\doverb'{'<char>#1<char>'}'{#1}
6639 % [Knuth] p. 382; only eat outer {}
6641 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6642 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6645 \def\verb{\begingroup\setupverb\doverb}
6648 % Do the @verbatim magic: define the macro \doverbatim so that
6649 % the (first) argument ends when '@end verbatim' is reached, ie:
6651 % \def\doverbatim#1@end verbatim{#1}
6653 % For Texinfo it's a lot easier than for LaTeX,
6654 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6655 % we need not redefine '\', '{' and '}'.
6657 % Inspired by LaTeX's verbatim command set [latex.ltx]
6662 % ignore everything up to the first ^^M, that's the newline at the end
6663 % of the @verbatim input line itself. Otherwise we get an extra blank
6664 % line in the output.
6665 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6666 % We really want {...\end verbatim} in the body of the macro, but
6667 % without the active space; thus we have to use \xdef and \gobble.
6671 \setupverbatim\doverbatim
6673 \let\Everbatim = \afterenvbreak
6676 % @verbatiminclude FILE - insert text of file in verbatim environment.
6678 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6680 \def\doverbatiminclude#1{%
6682 \makevalueexpandable
6684 \indexnofonts % Allow `@@' and other weird things in file names.
6685 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
6691 % @copying ... @end copying.
6692 % Save the text away for @insertcopying later.
6694 % We save the uninterpreted tokens, rather than creating a box.
6695 % Saving the text in a box would be much easier, but then all the
6696 % typesetting commands (@smallbook, font changes, etc.) have to be done
6697 % beforehand -- and a) we want @copying to be done first in the source
6698 % file; b) letting users define the frontmatter in as flexible order as
6699 % possible is very desirable.
6701 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6702 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6704 \def\insertcopying{%
6706 \parindent = 0pt % paragraph indentation looks wrong on title page
6707 \scanexp\copyingtext
6715 \newskip\defbodyindent \defbodyindent=.4in
6716 \newskip\defargsindent \defargsindent=50pt
6717 \newskip\deflastargmargin \deflastargmargin=18pt
6718 \newcount\defunpenalty
6720 % Start the processing of @deffn:
6722 \ifnum\lastpenalty<10000
6724 \defunpenalty=10003 % Will keep this @deffn together with the
6725 % following @def command, see below.
6727 % If there are two @def commands in a row, we'll have a \nobreak,
6728 % which is there to keep the function description together with its
6729 % header. But if there's nothing but headers, we need to allow a
6730 % break somewhere. Check specifically for penalty 10002, inserted
6731 % by \printdefunline, instead of 10000, since the sectioning
6732 % commands also insert a nobreak penalty, and we don't want to allow
6733 % a break between a section heading and a defun.
6735 % As a further refinement, we avoid "club" headers by signalling
6736 % with penalty of 10003 after the very first @deffn in the
6737 % sequence (see above), and penalty of 10002 after any following
6739 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6741 % Similarly, after a section heading, do not allow a break.
6742 % But do insert the glue.
6743 \medskip % preceded by discardable penalty, so not a breakpoint
6747 \advance\leftskip by \defbodyindent
6748 \exdentamount=\defbodyindent
6752 % First, check whether we are in the right environment:
6755 % As above, allow line break if we have multiple x headers in a row.
6756 % It's not a great place, though.
6757 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6759 % And now, it's time to reuse the body of the original defun:
6760 \expandafter\gobbledefun#1%
6762 \def\gobbledefun#1\startdefun{}
6764 % \printdefunline \deffnheader{text}
6766 \def\printdefunline#1#2{%
6768 % call \deffnheader:
6771 \interlinepenalty = 10000
6772 \advance\rightskip by 0pt plus 1fil\relax
6774 \nobreak\vskip -\parskip
6775 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6776 % Some of the @defun-type tags do not enable magic parentheses,
6777 % rendering the following check redundant. But we don't optimize.
6782 \def\Edefun{\endgraf\medbreak}
6784 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6785 % the only thing remaining is to define \deffnheader.
6788 \expandafter\let\csname E#1\endcsname = \Edefun
6789 \edef\temp{\noexpand\domakedefun
6790 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6794 % \domakedefun \deffn \deffnx \deffnheader
6796 % Define \deffn and \deffnx, without parameters.
6797 % \deffnheader has to be defined explicitly.
6799 \def\domakedefun#1#2#3{%
6802 \doingtypefnfalse % distinguish typed functions from all else
6803 \parseargusing\activeparens{\printdefunline#3}%
6805 \def#2{\dodefunx#1}%
6809 \newif\ifdoingtypefn % doing typed function?
6810 \newif\ifrettypeownline % typeset return type on its own line?
6812 % @deftypefnnewline on|off says whether the return type of typed functions
6813 % are printed on their own line. This affects @deftypefn, @deftypefun,
6814 % @deftypeop, and @deftypemethod.
6816 \parseargdef\deftypefnnewline{%
6819 \expandafter\let\csname SETtxideftypefnnl\endcsname
6821 \else\ifx\temp\offword
6822 \expandafter\let\csname SETtxideftypefnnl\endcsname
6825 \errhelp = \EMsimple
6826 \errmessage{Unknown @txideftypefnnl value `\temp',
6831 % Untyped functions:
6833 % @deffn category name args
6834 \makedefun{deffn}{\deffngeneral{}}
6836 % @deffn category class name args
6837 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6839 % \defopon {category on}class name args
6840 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6842 % \deffngeneral {subind}category name args
6844 \def\deffngeneral#1#2 #3 #4\endheader{%
6845 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6846 \dosubind{fn}{\code{#3}}{#1}%
6847 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6852 % @deftypefn category type name args
6853 \makedefun{deftypefn}{\deftypefngeneral{}}
6855 % @deftypeop category class type name args
6856 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6858 % \deftypeopon {category on}class type name args
6859 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6861 % \deftypefngeneral {subind}category type name args
6863 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6864 \dosubind{fn}{\code{#4}}{#1}%
6866 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6871 % @deftypevr category type var args
6872 \makedefun{deftypevr}{\deftypecvgeneral{}}
6874 % @deftypecv category class type var args
6875 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6877 % \deftypecvof {category of}class type var args
6878 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6880 % \deftypecvgeneral {subind}category type var args
6882 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6883 \dosubind{vr}{\code{#4}}{#1}%
6884 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6887 % Untyped variables:
6889 % @defvr category var args
6890 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6892 % @defcv category class var args
6893 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6895 % \defcvof {category of}class var args
6896 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6900 % @deftp category name args
6901 \makedefun{deftp}#1 #2 #3\endheader{%
6902 \doind{tp}{\code{#2}}%
6903 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6906 % Remaining @defun-like shortcuts:
6907 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6908 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6909 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6910 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6911 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6912 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6913 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6914 \makedefun{defmethod}{\defopon\putwordMethodon}
6915 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6916 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6917 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6919 % \defname, which formats the name of the @def (not the args).
6920 % #1 is the category, such as "Function".
6921 % #2 is the return type, if any.
6922 % #3 is the function name.
6924 % We are followed by (but not passed) the arguments, if any.
6926 \def\defname#1#2#3{%
6928 % Get the values of \leftskip and \rightskip as they were outside the @def...
6929 \advance\leftskip by -\defbodyindent
6931 % Determine if we are typesetting the return type of a typed function
6932 % on a line by itself.
6933 \rettypeownlinefalse
6934 \ifdoingtypefn % doing a typed function specifically?
6935 % then check user option for putting return type on its own line:
6936 \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
6941 % How we'll format the category name. Putting it in brackets helps
6942 % distinguish it from the body text that may end up on the next line
6945 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6947 % Figure out line sizes for the paragraph shape. We'll always have at
6951 % The first line needs space for \box0; but if \rightskip is nonzero,
6952 % we need only space for the part of \box0 which exceeds it:
6953 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6955 % If doing a return type on its own line, we'll have another line.
6957 \advance\tempnum by 1
6958 \def\maybeshapeline{0in \hsize}%
6960 \def\maybeshapeline{}%
6963 % The continuations:
6964 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6966 % The final paragraph shape:
6967 \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2
6969 % Put the category name at the right margin.
6972 \hfil\box0 \kern-\hsize
6973 % \hsize has to be shortened this way:
6975 % Intentionally do not respect \rightskip, since we need the space.
6978 % Allow all lines to be underfull without complaint:
6979 \tolerance=10000 \hbadness=10000
6980 \exdentamount=\defbodyindent
6982 % defun fonts. We use typewriter by default (used to be bold) because:
6983 % . we're printing identifiers, they should be in tt in principle.
6984 % . in languages with many accents, such as Czech or French, it's
6985 % common to leave accents off identifiers. The result looks ok in
6986 % tt, but exceedingly strange in rm.
6987 % . we don't want -- and --- to be treated as ligatures.
6988 % . this still does not fix the ?` and !` ligatures, but so far no
6989 % one has made identifiers using them :).
6991 \def\temp{#2}% text of the return type
6992 \ifx\temp\empty\else
6993 \tclose{\temp}% typeset the return type
6995 % put return type on its own line; prohibit line break following:
6996 \hfil\vadjust{\nobreak}\break
6998 \space % type on same line, so just followed by a space
7000 \fi % no return type
7001 #3% output function name
7003 {\rm\enskip}% hskip 0.5 em of \tenrm
7006 % arguments will be output next, if any.
7009 % Print arguments in slanted roman (not ttsl), inconsistently with using
7010 % tt for the name. This is because literal text is sometimes needed in
7011 % the argument list (groff manual), and ttsl and tt are not very
7012 % distinguishable. Prevent hyphenation at `-' chars.
7015 % use sl by default (not ttsl),
7017 \df \sl \hyphenchar\font=0
7019 % On the other hand, if an argument has two dashes (for instance), we
7020 % want a way to get ttsl. Let's try @var for that.
7021 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
7023 \sl\hyphenchar\font=45
7026 % We want ()&[] to print specially on the defun line.
7029 \catcode`\(=\active \catcode`\)=\active
7030 \catcode`\[=\active \catcode`\]=\active
7034 % Make control sequences which act like normal parenthesis chars.
7035 \let\lparen = ( \let\rparen = )
7037 % Be sure that we always have a definition for `(', etc. For example,
7038 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7039 % so TeX would otherwise complain about undefined control sequence.
7042 \global\let(=\lparen \global\let)=\rparen
7043 \global\let[=\lbrack \global\let]=\rbrack
7046 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7047 \gdef\magicamp{\let&=\amprm}
7050 \newcount\parencount
7052 % If we encounter &foo, then turn on ()-hacking afterwards
7054 \def\amprm#1 {\ampseentrue{\bf\ }}
7058 % At the first level, print parens in roman,
7059 % otherwise use the default font.
7060 \ifnum \parencount=1 \rm \fi
7062 % The \sf parens (in \boldbrax) actually are a little bolder than
7063 % the contained text. This is especially needed for [ and ] .
7067 \def\infirstlevel#1{%
7074 \def\bfafterword#1 {#1 \bf}
7077 \global\advance\parencount by 1
7079 \infirstlevel \bfafterword
7084 \global\advance\parencount by -1
7087 \newcount\brackcount
7089 \global\advance\brackcount by 1
7094 \global\advance\brackcount by -1
7097 \def\checkparencounts{%
7098 \ifnum\parencount=0 \else \badparencount \fi
7099 \ifnum\brackcount=0 \else \badbrackcount \fi
7101 % these should not use \errmessage; the glibc manual, at least, actually
7102 % has such constructs (when documenting function pointers).
7103 \def\badparencount{%
7104 \message{Warning: unbalanced parentheses in @def...}%
7105 \global\parencount=0
7107 \def\badbrackcount{%
7108 \message{Warning: unbalanced square brackets in @def...}%
7109 \global\brackcount=0
7116 % To do this right we need a feature of e-TeX, \scantokens,
7117 % which we arrange to emulate with a temporary file in ordinary TeX.
7118 \ifx\eTeXversion\thisisundefined
7119 \newwrite\macscribble
7122 \immediate\openout\macscribble=\jobname.tmp
7123 \immediate\write\macscribble{\the\toks0}%
7124 \immediate\closeout\macscribble
7129 \def\scanmacro#1{\begingroup
7131 \let\xeatspaces\eatspaces
7133 % Undo catcode changes of \startcontents and \doprintindex
7134 % When called from @insertcopying or (short)caption, we need active
7135 % backslash to get it printed correctly. Previously, we had
7136 % \catcode`\\=\other instead. We'll see whether a problem appears
7137 % with macro expansion. --kasal, 19aug04
7138 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
7140 % ... and for \example:
7143 % The \empty here causes a following catcode 5 newline to be eaten as
7144 % part of reading whitespace after a control sequence. It does not
7145 % eat a catcode 13 newline. There's no good way to handle the two
7146 % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
7147 % would then have different behavior). See the Macro Details node in
7148 % the manual for the workaround we recommend for macros and
7149 % line-oriented commands.
7151 \scantokens{#1\empty}%
7155 \edef\temp{\noexpand\scanmacro{#1}}%
7159 \newcount\paramno % Count of parameters
7160 \newtoks\macname % Macro name
7161 \newif\ifrecursive % Is it recursive?
7163 % List of all defined macros in the form
7164 % \definedummyword\macro1\definedummyword\macro2...
7165 % Currently is also contains all @aliases; the list can be split
7166 % if there is a need.
7169 % Add the macro to \macrolist
7170 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7171 \def\addtomacrolistxxx#1{%
7172 \toks0 = \expandafter{\macrolist\definedummyword#1}%
7173 \xdef\macrolist{\the\toks0}%
7177 % This does \let #1 = #2, with \csnames; that is,
7178 % \let \csname#1\endcsname = \csname#2\endcsname
7179 % (except of course we have to play expansion games).
7183 \csname#1\expandafter\endcsname
7187 % Trim leading and trailing spaces off a string.
7188 % Concepts from aro-bend problem 15 (see CTAN).
7190 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
7191 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
7192 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
7194 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
7197 % Trim a single trailing ^^M off a string.
7198 {\catcode`\^^M=\other \catcode`\Q=3%
7199 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
7200 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
7201 \gdef\eatcrb#1Q#2Q{#1}%
7204 % Macro bodies are absorbed as an argument in a context where
7205 % all characters are catcode 10, 11 or 12, except \ which is active
7206 % (as in normal texinfo). It is necessary to change the definition of \
7207 % to recognize macro arguments; this is the job of \mbodybackslash.
7209 % Non-ASCII encodings make 8-bit characters active, so un-activate
7210 % them to avoid their expansion. Must do this non-globally, to
7211 % confine the change to the current group.
7213 % It's necessary to have hard CRs when the macro is executed. This is
7214 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7215 % body, and then making it the \newlinechar in \scanmacro.
7217 \def\scanctxt{% used as subroutine
7227 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7230 \def\scanargctxt{% used for copying and captions, not macros.
7233 \catcode`\^^M=\other
7236 \def\macrobodyctxt{% used for @macro definitions
7240 \catcode`\^^M=\other
7244 \def\macroargctxt{% used when scanning invocations
7248 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
7249 % for the single characters \ { }. Thus, we end up with the "commands"
7250 % that would be written @\ @{ @} in a Texinfo document.
7252 % We already have @{ and @}. For @\, we define it here, and only for
7253 % this purpose, to produce a typewriter backslash (so, the @\ that we
7254 % define for @math can't be used with @macro calls):
7256 \def\\{\normalbackslash}%
7258 % We would like to do this for \, too, since that is what makeinfo does.
7259 % But it is not possible, because Texinfo already has a command @, for a
7260 % cedilla accent. Documents must use @comma{} instead.
7262 % \anythingelse will almost certainly be an error of some kind.
7265 % \mbodybackslash is the definition of \ in @macro bodies.
7266 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7267 % where N is the macro parameter number.
7268 % We define \csname macarg.\endcsname to be \realbackslash, so
7269 % \\ in macro replacement text gets you a backslash.
7271 {\catcode`@=0 @catcode`@\=@active
7272 @gdef@usembodybackslash{@let\=@mbodybackslash}
7273 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
7275 \expandafter\def\csname macarg.\endcsname{\realbackslash}
7277 \def\margbackslash#1{\char`\#1 }
7279 \def\macro{\recursivefalse\parsearg\macroxxx}
7280 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7283 \getargs{#1}% now \macname is the macname and \argl the arglist
7284 \ifx\argl\empty % no arguments
7287 \expandafter\parsemargdef \argl;%
7288 \if\paramno>256\relax
7289 \ifx\eTeXversion\thisisundefined
7290 \errhelp = \EMsimple
7291 \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
7295 \if1\csname ismacro.\the\macname\endcsname
7296 \message{Warning: redefining \the\macname}%
7298 \expandafter\ifx\csname \the\macname\endcsname \relax
7299 \else \errmessage{Macro name \the\macname\space already defined}\fi
7300 \global\cslet{macsave.\the\macname}{\the\macname}%
7301 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7302 \addtomacrolist{\the\macname}%
7304 \begingroup \macrobodyctxt
7305 \ifrecursive \expandafter\parsermacbody
7306 \else \expandafter\parsemacbody
7309 \parseargdef\unmacro{%
7310 \if1\csname ismacro.#1\endcsname
7311 \global\cslet{#1}{macsave.#1}%
7312 \global\expandafter\let \csname ismacro.#1\endcsname=0%
7313 % Remove the macro name from \macrolist:
7315 \expandafter\let\csname#1\endcsname \relax
7316 \let\definedummyword\unmacrodo
7317 \xdef\macrolist{\macrolist}%
7320 \errmessage{Macro #1 not defined}%
7324 % Called by \do from \dounmacro on each macro. The idea is to omit any
7325 % macro definitions that have been changed to \relax.
7331 \noexpand\definedummyword \noexpand#1%
7335 % This makes use of the obscure feature that if the last token of a
7336 % <parameter list> is #, then the preceding argument is delimited by
7337 % an opening brace, and that opening brace is not consumed.
7338 \def\getargs#1{\getargsxxx#1{}}
7339 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7340 \def\getmacname#1 #2\relax{\macname={#1}}
7341 \def\getmacargs#1{\def\argl{#1}}
7343 % For macro processing make @ a letter so that we can make Texinfo private macro names.
7344 \edef\texiatcatcode{\the\catcode`\@}
7345 \catcode `@=11\relax
7347 % Parse the optional {params} list. Set up \paramno and \paramlist
7348 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
7349 % in the params list to some hook where the argument si to be expanded. If
7350 % there are less than 10 arguments that hook is to be replaced by ##N where N
7351 % is the position in that list, that is to say the macro arguments are to be
7352 % defined `a la TeX in the macro body.
7354 % That gets used by \mbodybackslash (above).
7356 % We need to get `macro parameter char #' into several definitions.
7357 % The technique used is stolen from LaTeX: let \hash be something
7358 % unexpandable, insert that wherever you need a #, and then redefine
7359 % it to # just before using the token list produced.
7361 % The same technique is used to protect \eatspaces till just before
7362 % the macro is used.
7364 % If there are 10 or more arguments, a different technique is used, where the
7365 % hook remains in the body, and when macro is to be expanded the body is
7366 % processed again to replace the arguments.
7368 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7369 % argument N value and then \edef the body (nothing else will expand because of
7370 % the catcode regime underwhich the body was input).
7372 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7373 % arguments, you need that no macro has more than 256 arguments, otherwise an
7374 % error is produced.
7375 \def\parsemargdef#1;{%
7376 \paramno=0\def\paramlist{}%
7378 \let\xeatspaces\relax
7379 \parsemargdefxxx#1,;,%
7380 % In case that there are 10 or more arguments we parse again the arguments
7381 % list to set new definitions for the \macarg.BLAH macros corresponding to
7382 % each BLAH argument. It was anyhow needed to parse already once this list
7383 % in order to count the arguments, and as macros with at most 9 arguments
7384 % are by far more frequent than macro with 10 or more arguments, defining
7385 % twice the \macarg.BLAH macros does not cost too much processing power.
7386 \ifnum\paramno<10\relax\else
7388 \parsemmanyargdef@@#1,;,% 10 or more arguments
7391 \def\parsemargdefxxx#1,{%
7392 \if#1;\let\next=\relax
7393 \else \let\next=\parsemargdefxxx
7394 \advance\paramno by 1
7395 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7396 {\xeatspaces{\hash\the\paramno}}%
7397 \edef\paramlist{\paramlist\hash\the\paramno,}%
7400 \def\parsemmanyargdef@@#1,{%
7401 \if#1;\let\next=\relax
7403 \let\next=\parsemmanyargdef@@
7404 \edef\tempb{\eatspaces{#1}}%
7405 \expandafter\def\expandafter\tempa
7406 \expandafter{\csname macarg.\tempb\endcsname}%
7407 % Note that we need some extra \noexpand\noexpand, this is because we
7408 % don't want \the to be expanded in the \parsermacbody as it uses an
7410 \expandafter\edef\tempa
7411 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7412 \advance\paramno by 1\relax
7415 % These two commands read recursive and nonrecursive macro bodies.
7416 % (They're different since rec and nonrec macros end differently.)
7419 \catcode `\@\texiatcatcode
7420 \long\def\parsemacbody#1@end macro%
7421 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7422 \long\def\parsermacbody#1@end rmacro%
7423 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7424 \catcode `\@=11\relax
7429 \long\def\nillm@{\nil@}%
7431 % This macro is expanded during the Texinfo macro expansion, not during its
7432 % definition. It gets all the arguments values and assigns them to macros
7435 % #1 is the macro name
7436 % #2 is the list of argument names
7437 % #3 is the list of argument values
7438 \def\getargvals@#1#2#3{%
7439 \def\macargdeflist@{}%
7440 \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
7441 \def\paramlist{#2,\nil@}%
7445 \def\argvaluelist{#3,\nil@}%
7456 \ifx\paramlist\nilm@
7457 % Some sanity check needed here that \argvaluelist is also empty.
7458 \ifx\argvaluelist\nillm@
7460 \errhelp = \EMsimple
7461 \errmessage{Too many arguments in macro `\macroname'!}%
7463 \let\next\macargexpandinbody@
7465 \ifx\argvaluelist\nillm@
7466 % No more arguments values passed to macro. Set remaining named-arg
7468 \let\next\setemptyargvalues@
7470 % pop current arg name into \@tempb
7471 \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
7472 \expandafter\@tempa\expandafter{\paramlist}%
7473 % pop current argument value into \@tempc
7474 \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
7475 \expandafter\@tempa\expandafter{\argvaluelist}%
7476 % Here \@tempb is the current arg name and \@tempc is the current arg value.
7477 % First place the new argument macro definition into \@tempd
7478 \expandafter\macname\expandafter{\@tempc}%
7479 \expandafter\let\csname macarg.\@tempb\endcsname\relax
7480 \expandafter\def\expandafter\@tempe\expandafter{%
7481 \csname macarg.\@tempb\endcsname}%
7482 \edef\@tempd{\long\def\@tempe{\the\macname}}%
7483 \push@\@tempd\macargdeflist@
7484 \let\next\getargvals@@
7491 \expandafter\expandafter\expandafter\def
7492 \expandafter\expandafter\expandafter#2%
7493 \expandafter\expandafter\expandafter{%
7497 % Replace arguments by their values in the macro body, and place the result
7499 \def\macvalstoargs@{%
7500 % To do this we use the property that token registers that are \the'ed
7501 % within an \edef expand only once. So we are going to place all argument
7502 % values into respective token registers.
7504 % First we save the token context, and initialize argument numbering.
7507 % Then, for each argument number #N, we place the corresponding argument
7508 % value into a new token list register \toks#N
7509 \expandafter\putargsintokens@\saveparamlist@,;,%
7510 % Then, we expand the body so that argument are replaced by their
7511 % values. The trick for values not to be expanded themselves is that they
7512 % are within tokens and that tokens expand only once in an \edef .
7513 \edef\@tempc{\csname mac.\macroname .body\endcsname}%
7514 % Now we restore the token stack pointer to free the token list registers
7515 % which we have used, but we make sure that expanded body is saved after
7519 \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
7522 \def\macargexpandinbody@{%
7523 %% Define the named-macro outside of this group and then close this group.
7527 % First the replace in body the macro arguments by their values, the result
7530 % Then we point at the \norecurse or \gobble (for recursive) macro value
7532 \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
7533 % Depending on whether it is recursive or not, we need some tailing
7540 % And now we do the real job:
7541 \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
7545 \def\putargsintokens@#1,{%
7546 \if#1;\let\next\relax
7548 \let\next\putargsintokens@
7549 % First we allocate the new token list register, and give it a temporary
7551 \toksdef\@tempb\the\paramno
7552 % Then we place the argument value into that token list register.
7553 \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
7554 \expandafter\@tempb\expandafter{\@tempa}%
7555 \advance\paramno by 1\relax
7560 % Save the token stack pointer into macro #1
7561 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}}
7562 % Restore the token stack pointer from number in macro #1
7563 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax}
7564 % newtoks that can be used non \outer .
7565 \def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi}
7567 % Tailing missing arguments are set to empty
7568 \def\setemptyargvalues@{%
7569 \ifx\paramlist\nilm@
7570 \let\next\macargexpandinbody@
7572 \expandafter\setemptyargvaluesparser@\paramlist\endargs@
7573 \let\next\setemptyargvalues@
7578 \def\setemptyargvaluesparser@#1,#2\endargs@{%
7579 \expandafter\def\expandafter\@tempa\expandafter{%
7580 \expandafter\def\csname macarg.#1\endcsname{}}%
7581 \push@\@tempa\macargdeflist@
7585 % #1 is the element target macro
7586 % #2 is the list macro
7587 % #3,#4\endargs@ is the list value
7588 \def\pop@#1#2#3,#4\endargs@{%
7592 \long\def\longpop@#1#2#3,#4\endargs@{%
7597 % This defines a Texinfo @macro. There are eight cases: recursive and
7598 % nonrecursive macros of zero, one, up to nine, and many arguments.
7599 % Much magic with \expandafter here.
7600 % \xdef is used so that macro definitions will survive the file
7601 % they're defined in; @include reads the file inside a group.
7604 \let\hash=##% convert placeholders to macro parameter chars
7608 \expandafter\xdef\csname\the\macname\endcsname{%
7609 \noexpand\scanmacro{\temp}}%
7611 \expandafter\xdef\csname\the\macname\endcsname{%
7612 \bgroup\noexpand\macroargctxt
7613 \noexpand\braceorline
7614 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7615 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7616 \egroup\noexpand\scanmacro{\temp}}%
7618 \ifnum\paramno<10\relax % at most 9
7619 \expandafter\xdef\csname\the\macname\endcsname{%
7620 \bgroup\noexpand\macroargctxt
7621 \noexpand\csname\the\macname xx\endcsname}%
7622 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7623 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7624 \expandafter\expandafter
7626 \expandafter\expandafter
7627 \csname\the\macname xxx\endcsname
7628 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7630 \expandafter\xdef\csname\the\macname\endcsname{%
7631 \noexpand\getargvals@{\the\macname}{\argl}%
7633 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7634 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
7640 \expandafter\xdef\csname\the\macname\endcsname{%
7641 \noexpand\norecurse{\the\macname}%
7642 \noexpand\scanmacro{\temp}\egroup}%
7644 \expandafter\xdef\csname\the\macname\endcsname{%
7645 \bgroup\noexpand\macroargctxt
7646 \noexpand\braceorline
7647 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7648 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7650 \noexpand\norecurse{\the\macname}%
7651 \noexpand\scanmacro{\temp}\egroup}%
7653 \ifnum\paramno<10\relax
7654 \expandafter\xdef\csname\the\macname\endcsname{%
7655 \bgroup\noexpand\macroargctxt
7656 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7657 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7658 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7659 \expandafter\expandafter
7661 \expandafter\expandafter
7662 \csname\the\macname xxx\endcsname
7665 \noexpand\norecurse{\the\macname}%
7666 \noexpand\scanmacro{\temp}\egroup}%
7668 \expandafter\xdef\csname\the\macname\endcsname{%
7669 \noexpand\getargvals@{\the\macname}{\argl}%
7671 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7672 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
7677 \catcode `\@\texiatcatcode\relax
7679 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7681 % \braceorline decides whether the next nonwhitespace character is a
7682 % {. If so it reads up to the closing }, if not, it reads the whole
7683 % line. Whatever was read is then fed to the next control sequence
7684 % as an argument (by \parsebrace or \parsearg).
7686 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7687 \def\braceorlinexxx{%
7688 \ifx\nchar\bgroup\else
7689 \expandafter\parsearg
7694 % We need some trickery to remove the optional spaces around the equal
7695 % sign. Make them active and then expand them all to nothing.
7697 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7698 \def\aliasxxx #1{\aliasyyy#1\relax}
7699 \def\aliasyyy #1=#2\relax{%
7701 \expandafter\let\obeyedspace=\empty
7702 \addtomacrolist{#1}%
7703 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7709 \message{cross references,}
7712 \newif\ifhavexrefs % True if xref values are known.
7713 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7715 % @inforef is relatively simple.
7716 \def\inforef #1{\inforefzzz #1,,,,**}
7717 \def\inforefzzz #1,#2,#3,#4**{%
7718 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7719 node \samp{\ignorespaces#1{}}}
7721 % @node's only job in TeX is to define \lastnode, which is used in
7722 % cross-references. The @node line might or might not have commas, and
7723 % might or might not have spaces before the first comma, like:
7724 % @node foo , bar , ...
7725 % We don't want such trailing spaces in the node name.
7727 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7729 % also remove a trailing comma, in case of something like this:
7730 % @node Help-Cross, , , Cross-refs
7731 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7732 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7735 \let\lastnode=\empty
7737 % Write a cross-reference definition for the current node. #1 is the
7738 % type (Ynumbered, Yappendix, Ynothing).
7741 \ifx\lastnode\empty\else
7742 \setref{\lastnode}{#1}%
7743 \global\let\lastnode=\empty
7747 % @anchor{NAME} -- define xref target at arbitrary point.
7749 \newcount\savesfregister
7751 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7752 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7753 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7755 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7756 % anchor), which consists of three parts:
7757 % 1) NAME-title - the current sectioning name taken from \lastsection,
7758 % or the anchor name.
7759 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7760 % empty for anchors.
7761 % 3) NAME-pg - the page number.
7763 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7764 % floats, there is an additional part, which is not written here:
7765 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7771 \atdummies % preserve commands, but don't expand them
7772 \edef\writexrdef##1##2{%
7773 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7774 ##1}{##2}}% these are parameters of \writexrdef
7776 \toks0 = \expandafter{\lastsection}%
7777 \immediate \writexrdef{title}{\the\toks0 }%
7778 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7779 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
7784 % @xrefautosectiontitle on|off says whether @section(ing) names are used
7785 % automatically in xrefs, if the third arg is not explicitly specified.
7786 % This was provided as a "secret" @set xref-automatic-section-title
7787 % variable, now it's official.
7789 \parseargdef\xrefautomaticsectiontitle{%
7792 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7794 \else\ifx\temp\offword
7795 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7798 \errhelp = \EMsimple
7799 \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
7805 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7806 % the node name, #2 the name of the Info cross-reference, #3 the printed
7807 % node name, #4 the name of the Info file, #5 the name of the printed
7808 % manual. All but the node name can be omitted.
7810 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7811 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7812 \def\ref#1{\xrefX[#1,,,,,,,]}
7815 \newbox\printedrefnamebox
7816 \newbox\printedmanualbox
7818 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7821 \def\printedrefname{\ignorespaces #3}%
7822 \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
7824 \def\printedmanual{\ignorespaces #5}%
7825 \setbox\printedmanualbox = \hbox{\printedmanual\unskip}%
7827 % If the printed reference name (arg #3) was not explicitly given in
7828 % the @xref, figure out what we want to use.
7829 \ifdim \wd\printedrefnamebox = 0pt
7830 % No printed node name was explicitly given.
7831 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
7832 % Not auto section-title: use node name inside the square brackets.
7833 \def\printedrefname{\ignorespaces #1}%
7835 % Auto section-title: use chapter/section title inside
7836 % the square brackets if we have it.
7837 \ifdim \wd\printedmanualbox > 0pt
7838 % It is in another manual, so we don't have it; use node name.
7839 \def\printedrefname{\ignorespaces #1}%
7842 % We (should) know the real title if we have the xref values.
7843 \def\printedrefname{\refx{#1-title}{}}%
7845 % Otherwise just copy the Info node name.
7846 \def\printedrefname{\ignorespaces #1}%
7852 % Make link in pdf output.
7856 % This expands tokens, so do it after making catcode changes, so _
7857 % etc. don't get their TeX definitions.
7860 \edef\pdfxrefdest{#1}%
7861 \txiescapepdf\pdfxrefdest
7864 \startlink attr{/Border [0 0 0]}%
7865 \ifnum\filenamelength>0
7866 goto file{\the\filename.pdf} name{\pdfxrefdest}%
7868 goto name{\pdfmkpgn{\pdfxrefdest}}%
7871 \setcolor{\linkcolor}%
7874 % Float references are printed completely differently: "Figure 1.2"
7875 % instead of "[somenode], p.3". We distinguish them by the
7876 % LABEL-title being set to a magic string.
7878 % Have to otherify everything special to allow the \csname to
7879 % include an _ in the xref name, etc.
7882 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7883 \csname XR#1-title\endcsname
7885 \iffloat\Xthisreftitle
7886 % If the user specified the print name (third arg) to the ref,
7887 % print it instead of our usual "Figure 1.2".
7888 \ifdim\wd\printedrefnamebox = 0pt
7894 % if the user also gave the printed manual name (fifth arg), append
7896 \ifdim \wd\printedmanualbox > 0pt
7897 \space \putwordin{} \cite{\printedmanual}%
7900 % node/anchor (non-float) references.
7902 % If we use \unhbox to print the node names, TeX does not insert
7903 % empty discretionaries after hyphens, which means that it will not
7904 % find a line break at a hyphen in a node names. Since some manuals
7905 % are best written with fairly long node names, containing hyphens,
7906 % this is a loss. Therefore, we give the text of the node name
7907 % again, so it is as if TeX is seeing it for the first time.
7909 % Cross-manual reference. Only include the "Section ``foo'' in" if
7910 % the foo is neither missing or Top. Thus, @xref{,,,foo,The Foo Manual}
7911 % outputs simply "see The Foo Manual".
7912 \ifdim \wd\printedmanualbox > 0pt
7913 % What is the 7sp about? The idea is that we also want to omit
7914 % the Section part if we would be printing "Top", since they are
7915 % clearly trying to refer to the whole manual. But, this being
7916 % TeX, we can't easily compare strings while ignoring the possible
7917 % spaces before and after in the input. By adding the arbitrary
7918 % 7sp, we make it much less likely that a real node name would
7919 % happen to have the same width as "Top" (e.g., in a monospaced font).
7920 % I hope it will never happen in practice.
7922 % For the same basic reason, we retypeset the "Top" at every
7923 % reference, since the current font is indeterminate.
7925 \setbox\topbox = \hbox{Top\kern7sp}%
7926 \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
7928 \ifdim \wd2 = \wd\topbox \else
7929 \putwordSection{} ``\printedrefname'' \putwordin{}\space
7932 \cite{\printedmanual}%
7934 % Reference in this manual.
7936 % _ (for example) has to be the character _ for the purposes of the
7937 % control sequence corresponding to the node, but it has to expand
7938 % into the usual \leavevmode...\vrule stuff for purposes of
7939 % printing. So we \turnoffactive for the \refx-snt, back on for the
7940 % printing, back off for the \refx-pg.
7942 % Only output a following space if the -snt ref is nonempty; for
7943 % @unnumbered and @anchor, it won't be.
7944 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7945 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7947 % output the `[mynode]' via the macro below so it can be overridden.
7948 \xrefprintnodename\printedrefname
7950 % But we always want a comma and a space:
7953 % output the `page 3'.
7954 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7960 % This macro is called from \xrefX for the `[nodename]' part of xref
7961 % output. It's a separate macro only so it can be changed more easily,
7962 % since square brackets don't work well in some documents. Particularly
7963 % one that Bob is working on :).
7965 \def\xrefprintnodename#1{[#1]}
7967 % Things referred to by \setref.
7973 \putwordChapter@tie \the\chapno
7974 \else \ifnum\subsecno=0
7975 \putwordSection@tie \the\chapno.\the\secno
7976 \else \ifnum\subsubsecno=0
7977 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7979 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7984 \putwordAppendix@tie @char\the\appendixno{}%
7985 \else \ifnum\subsecno=0
7986 \putwordSection@tie @char\the\appendixno.\the\secno
7987 \else \ifnum\subsubsecno=0
7988 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7991 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7995 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7996 % If its value is nonempty, SUFFIX is output afterward.
8002 \expandafter\global\expandafter\let\expandafter\thisrefX
8003 \csname XR#1\endcsname
8006 % If not defined, say something at least.
8007 \angleleft un\-de\-fined\angleright
8010 {\toks0 = {#1}% avoid expansion of possibly-complex value
8011 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
8014 \global\warnedxrefstrue
8015 \message{Cross reference values unknown; you must run TeX again.}%
8020 % It's defined, so just use it.
8023 #2% Output the suffix in any case.
8026 % This is the macro invoked by entries in the aux file. Usually it's
8027 % just a \def (we prepend XR to the control sequence name to avoid
8028 % collisions). But if this is a float type, we have more work to do.
8031 {% The node name might contain 8-bit characters, which in our current
8032 % implementation are changed to commands like @'e. Don't let these
8033 % mess up the control sequence name.
8036 \xdef\safexrefname{#1}%
8039 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
8041 % Was that xref control sequence that we just defined for a float?
8042 \expandafter\iffloat\csname XR\safexrefname\endcsname
8043 % it was a float, and we have the (safe) float type in \iffloattype.
8044 \expandafter\let\expandafter\floatlist
8045 \csname floatlist\iffloattype\endcsname
8047 % Is this the first time we've seen this float type?
8048 \expandafter\ifx\floatlist\relax
8049 \toks0 = {\do}% yes, so just \do
8051 % had it before, so preserve previous elements in list.
8052 \toks0 = \expandafter{\floatlist\do}%
8055 % Remember this xref in the control sequence \floatlistFLOATTYPE,
8056 % for later use in \listoffloats.
8057 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
8062 % Read the last existing aux file, if any. No error if none exists.
8065 \openin 1 \jobname.aux
8068 \global\havexrefstrue
8073 \def\setupdatafile{%
8074 \catcode`\^^@=\other
8075 \catcode`\^^A=\other
8076 \catcode`\^^B=\other
8077 \catcode`\^^C=\other
8078 \catcode`\^^D=\other
8079 \catcode`\^^E=\other
8080 \catcode`\^^F=\other
8081 \catcode`\^^G=\other
8082 \catcode`\^^H=\other
8083 \catcode`\^^K=\other
8084 \catcode`\^^L=\other
8085 \catcode`\^^N=\other
8086 \catcode`\^^P=\other
8087 \catcode`\^^Q=\other
8088 \catcode`\^^R=\other
8089 \catcode`\^^S=\other
8090 \catcode`\^^T=\other
8091 \catcode`\^^U=\other
8092 \catcode`\^^V=\other
8093 \catcode`\^^W=\other
8094 \catcode`\^^X=\other
8095 \catcode`\^^Z=\other
8096 \catcode`\^^[=\other
8097 \catcode`\^^\=\other
8098 \catcode`\^^]=\other
8099 \catcode`\^^^=\other
8100 \catcode`\^^_=\other
8101 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8102 % in xref tags, i.e., node names. But since ^^e4 notation isn't
8103 % supported in the main text, it doesn't seem desirable. Furthermore,
8104 % that is not enough: for node names that actually contain a ^
8105 % character, we would end up writing a line like this: 'xrdef {'hat
8106 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8107 % argument, and \hat is not an expandable control sequence. It could
8108 % all be worked out, but why? Either we support ^^ or we don't.
8110 % The other change necessary for this was to define \auxhat:
8111 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8112 % and then to call \auxhat in \setq.
8116 % Special characters. Should be turned off anyway, but...
8129 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
8131 % This is to support \ in node names and titles, since the \
8132 % characters end up in a \csname. It's easier than
8133 % leaving it active and making its active definition an actual \
8134 % character. What I don't understand is why it works in the *value*
8135 % of the xrdef. Seems like it should be a catcode12 \, and that
8136 % should not typeset properly. But it works, so I'm moving on for
8137 % now. --karl, 15jan04.
8140 % Make the characters 128-255 be printing characters.
8144 \catcode\count1=\other
8145 \advance\count1 by 1
8146 \ifnum \count1<256 \loop \fi
8150 % @ is our escape character in .aux files, and we need braces.
8156 \def\readdatafile#1{%
8163 \message{insertions,}
8164 % including footnotes.
8166 \newcount \footnoteno
8168 % The trailing space in the following definition for supereject is
8169 % vital for proper filling; pages come out unaligned when you do a
8170 % pagealignmacro call if that space before the closing brace is
8171 % removed. (Generally, numeric constants should always be followed by a
8172 % space to prevent strange expansion errors.)
8173 \def\supereject{\par\penalty -20000\footnoteno =0 }
8175 % @footnotestyle is meaningful for Info output only.
8176 \let\footnotestyle=\comment
8180 % Auto-number footnotes. Otherwise like plain.
8182 \let\indent=\ptexindent
8183 \let\noindent=\ptexnoindent
8184 \global\advance\footnoteno by \@ne
8185 \edef\thisfootno{$^{\the\footnoteno}$}%
8187 % In case the footnote comes at the end of a sentence, preserve the
8188 % extra spacing after we do the footnote number.
8190 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
8192 % Remove inadvertent blank space before typesetting the footnote number.
8198 % Don't bother with the trickery in plain.tex to not require the
8199 % footnote text as a parameter. Our footnotes don't need to be so general.
8201 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8202 % \parseargline) fails inside footnotes because the tokens are fixed when
8203 % the footnote is read. --karl, 16nov96.
8206 \insert\footins\bgroup
8207 % We want to typeset this text as a normal paragraph, even if the
8208 % footnote reference occurs in (for example) a display environment.
8209 % So reset some parameters.
8211 \interlinepenalty\interfootnotelinepenalty
8212 \splittopskip\ht\strutbox % top baseline for broken footnotes
8213 \splitmaxdepth\dp\strutbox
8214 \floatingpenalty\@MM
8219 \parindent\defaultparindent
8223 % Because we use hanging indentation in footnotes, a @noindent appears
8224 % to exdent this text, so make it be a no-op. makeinfo does not use
8225 % hanging indentation so @noindent can still be needed within footnote
8226 % text after an @example or the like (not that this is good style).
8227 \let\noindent = \relax
8229 % Hang the footnote text off the number. Use \everypar in case the
8230 % footnote extends for more than one paragraph.
8231 \everypar = {\hang}%
8232 \textindent{\thisfootno}%
8234 % Don't crash into the line above the footnote text. Since this
8235 % expands into a box, it must come within the paragraph, lest it
8236 % provide a place where TeX can split the footnote.
8239 % Invoke rest of plain TeX footnote routine.
8240 \futurelet\next\fo@t
8242 }%end \catcode `\@=11
8244 % In case a @footnote appears in a vbox, save the footnote text and create
8245 % the real \insert just after the vbox finished. Otherwise, the insertion
8247 % Similarly, if a @footnote appears inside an alignment, save the footnote
8248 % text to a box and make the \insert when a row of the table is finished.
8249 % And the same can be done for other insert classes. --kasal, 16nov03.
8251 % Replace the \insert primitive by a cheating macro.
8252 % Deeper inside, just make sure that the saved insertions are not spilled
8255 \def\startsavinginserts{%
8256 \ifx \insert\ptexinsert
8257 \let\insert\saveinsert
8259 \let\checkinserts\relax
8263 % This \insert replacement works for both \insert\footins{foo} and
8264 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8267 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8268 \afterassignment\next
8269 % swallow the left brace
8272 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
8273 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
8275 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8277 \def\placesaveins#1{%
8278 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8282 % eat @SAVE -- beware, all of them have catcode \other:
8284 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
8285 \gdef\gobblesave @SAVE{}
8289 \def\newsaveins #1{%
8290 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8293 \def\newsaveinsX #1{%
8294 \csname newbox\endcsname #1%
8295 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8300 \let\checkinserts\empty
8305 % @image. We use the macros from epsf.tex to support this.
8306 % If epsf.tex is not installed and @image is used, we complain.
8308 % Check for and read epsf.tex up front. If we read it only at @image
8309 % time, we might be inside a group, and then its definitions would get
8310 % undone and the next image would fail.
8311 \openin 1 = epsf.tex
8313 % Do not bother showing banner with epsf.tex v2.7k (available in
8314 % doc/epsf.tex and on ctan).
8315 \def\epsfannounce{\toks0 = }%
8320 % We will only complain once about lack of epsf.tex.
8321 \newif\ifwarnednoepsf
8322 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8323 work. It is also included in the Texinfo distribution, or you can get
8324 it from ftp://tug.org/tex/epsf.tex.}
8327 \ifx\epsfbox\thisisundefined
8328 \ifwarnednoepsf \else
8329 \errhelp = \noepsfhelp
8330 \errmessage{epsf.tex not found, images will be ignored}%
8331 \global\warnednoepsftrue
8334 \imagexxx #1,,,,,\finish
8338 % Arguments to @image:
8339 % #1 is (mandatory) image filename; we tack on .eps extension.
8340 % #2 is (optional) width, #3 is (optional) height.
8341 % #4 is (ignored optional) html alt text.
8342 % #5 is (ignored optional) extension.
8343 % #6 is just the usual extra ignored arg for parsing stuff.
8345 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
8346 \catcode`\^^M = 5 % in case we're inside an example
8347 \normalturnoffactive % allow _ et al. in names
8348 % If the image is by itself, center it.
8351 \else \ifx\centersub\centerV
8352 % for @center @image, we need a vbox so we can have our vertical space
8354 \vbox\bgroup % vbox has better behavior than vtop herev
8359 % Usually we'll have text after the image which will insert
8360 % \parskip glue, so insert it here too to equalize the space
8362 \nobreak\vskip\parskip
8366 % Leave vertical mode so that indentation from an enclosing
8367 % environment such as @quotation is respected.
8368 % However, if we're at the top level, we don't want the
8369 % normal paragraph indentation.
8370 % On the other hand, if we are in the case of @center @image, we don't
8371 % want to start a paragraph, which will create a hsize-width box and
8372 % eradicate the centering.
8373 \ifx\centersub\centerV\else \noindent \fi
8377 \dopdfimage{#1}{#2}{#3}%
8379 % \epsfbox itself resets \epsf?size at each figure.
8380 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
8381 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
8386 \medskip % space after a standalone image
8388 \ifx\centersub\centerV \egroup \fi
8392 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8393 % etc. We don't actually implement floating yet, we always include the
8394 % float "here". But it seemed the best name for the future.
8396 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
8398 % There may be a space before second and/or third parameter; delete it.
8399 \def\eatcommaspace#1, {#1,}
8401 % #1 is the optional FLOATTYPE, the text label for this float, typically
8402 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
8403 % this float will not be numbered and cannot be referred to.
8405 % #2 is the optional xref label. Also must be present for the float to
8408 % #3 is the optional positioning argument; for now, it is ignored. It
8409 % will somehow specify the positions allowed to float to (here, top, bottom).
8411 % We keep a separate counter for each FLOATTYPE, which we reset at each
8412 % chapter-level command.
8413 \let\resetallfloatnos=\empty
8415 \def\dofloat#1,#2,#3,#4\finish{%
8416 \let\thiscaption=\empty
8417 \let\thisshortcaption=\empty
8419 % don't lose footnotes inside @float.
8421 % BEWARE: when the floats start float, we have to issue warning whenever an
8422 % insert appears inside a float which could possibly float. --kasal, 26may04
8426 % We can't be used inside a paragraph.
8431 \def\floatlabel{#2}%
8432 \def\floatloc{#3}% we do nothing with this yet.
8434 \ifx\floattype\empty
8435 \let\safefloattype=\empty
8438 % the floattype might have accents or other special characters,
8439 % but we need to use it in a control sequence name.
8442 \xdef\safefloattype{\floattype}%
8446 % If label is given but no type, we handle that as the empty type.
8447 \ifx\floatlabel\empty \else
8448 % We want each FLOATTYPE to be numbered separately (Figure 1,
8449 % Table 1, Figure 2, ...). (And if no label, no number.)
8451 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
8452 \global\advance\floatno by 1
8455 % This magic value for \lastsection is output by \setref as the
8456 % XREFLABEL-title value. \xrefX uses it to distinguish float
8457 % labels (which have a completely different output format) from
8458 % node and anchor labels. And \xrdef uses it to construct the
8461 \edef\lastsection{\floatmagic=\safefloattype}%
8462 \setref{\floatlabel}{Yfloat}%
8466 % start with \parskip glue, I guess.
8469 % Don't suppress indentation if a float happens to start a section.
8470 \restorefirstparagraphindent
8473 % we have these possibilities:
8474 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8475 % @float Foo,lbl & no caption: Foo 1.1
8476 % @float Foo & @caption{Cap}: Foo: Cap
8477 % @float Foo & no caption: Foo
8478 % @float ,lbl & Caption{Cap}: 1.1: Cap
8479 % @float ,lbl & no caption: 1.1
8480 % @float & @caption{Cap}: Cap
8481 % @float & no caption:
8484 \let\floatident = \empty
8486 % In all cases, if we have a float type, it comes first.
8487 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8489 % If we have an xref label, the number comes next.
8490 \ifx\floatlabel\empty \else
8491 \ifx\floattype\empty \else % if also had float type, need tie first.
8492 \appendtomacro\floatident{\tie}%
8495 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8498 % Start the printed caption with what we've constructed in
8499 % \floatident, but keep it separate; we need \floatident again.
8500 \let\captionline = \floatident
8502 \ifx\thiscaption\empty \else
8503 \ifx\floatident\empty \else
8504 \appendtomacro\captionline{: }% had ident, so need a colon between
8508 \appendtomacro\captionline{\scanexp\thiscaption}%
8511 % If we have anything to print, print it, with space before.
8512 % Eventually this needs to become an \insert.
8513 \ifx\captionline\empty \else
8517 % Space below caption.
8521 % If have an xref label, write the list of floats info. Do this
8522 % after the caption, to avoid chance of it being a breakpoint.
8523 \ifx\floatlabel\empty \else
8524 % Write the text that goes in the lof to the aux file as
8525 % \floatlabel-lof. Besides \floatident, we include the short
8526 % caption if specified, else the full caption if specified, else nothing.
8530 % since we read the caption text in the macro world, where ^^M
8531 % is turned into a normal character, we have to scan it back, so
8532 % we don't write the literal three characters "^^M" into the aux file.
8534 \xdef\noexpand\gtemp{%
8535 \ifx\thisshortcaption\empty
8542 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
8543 \ifx\gtemp\empty \else : \gtemp \fi}}%
8546 \egroup % end of \vtop
8548 % place the captured inserts
8550 % BEWARE: when the floats start floating, we have to issue warning
8551 % whenever an insert appears inside a float which could possibly
8552 % float. --kasal, 26may04
8557 % Append the tokens #2 to the definition of macro #1, not expanding either.
8559 \def\appendtomacro#1#2{%
8560 \expandafter\def\expandafter#1\expandafter{#1#2}%
8563 % @caption, @shortcaption
8565 \def\caption{\docaption\thiscaption}
8566 \def\shortcaption{\docaption\thisshortcaption}
8567 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8568 \def\defcaption#1#2{\egroup \def#1{#2}}
8570 % The parameter is the control sequence identifying the counter we are
8571 % going to use. Create it if it doesn't exist and assign it to \floatno.
8574 % Haven't seen this figure type before.
8575 \csname newcount\endcsname #1%
8577 % Remember to reset this floatno at the next chap.
8578 \expandafter\gdef\expandafter\resetallfloatnos
8579 \expandafter{\resetallfloatnos #1=0 }%
8584 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8585 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8586 % first read the @float command.
8588 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
8590 % Magic string used for the XREFLABEL-title value, so \xrefX can
8591 % distinguish floats from other xref types.
8592 \def\floatmagic{!!float!!}
8594 % #1 is the control sequence we are passed; we expand into a conditional
8595 % which is true if #1 represents a float ref. That is, the magic
8596 % \lastsection value which we \setref above.
8598 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
8600 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8601 % (safe) float type for this float. We set \iffloattype to #2.
8603 \def\doiffloat#1=#2=#3\finish{%
8605 \def\iffloattype{#2}%
8606 \ifx\temp\floatmagic
8609 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8611 \parseargdef\listoffloats{%
8612 \def\floattype{#1}% floattype
8614 % the floattype might have accents or other special characters,
8615 % but we need to use it in a control sequence name.
8618 \xdef\safefloattype{\floattype}%
8621 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8622 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8624 % if the user said @listoffloats foo but never @float foo.
8625 \message{\linenumber No `\safefloattype' floats to list.}%
8629 \leftskip=\tocindent % indent these entries like a toc
8630 \let\do=\listoffloatsdo
8631 \csname floatlist\safefloattype\endcsname
8636 % This is called on each entry in a list of floats. We're passed the
8637 % xref label, in the form LABEL-title, which is how we save it in the
8638 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8639 % has the text we're supposed to typeset here.
8641 % Figures without xref labels will not be included in the list (since
8642 % they won't appear in the aux file).
8644 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8645 \def\listoffloatsdoentry#1-title\finish{{%
8646 % Can't fully expand XR#1-lof because it can contain anything. Just
8647 % pass the control sequence. On the other hand, XR#1-pg is just the
8648 % page number, and we want to fully expand that so we can get a link
8650 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8652 % use the same \entry macro we use to generate the TOC and index.
8653 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8658 \message{localization,}
8660 % For single-language documents, @documentlanguage is usually given very
8661 % early, just after @documentencoding. Single argument is the language
8662 % (de) or locale (de_DE) abbreviation.
8665 \catcode`\_ = \active
8667 \parseargdef\documentlanguage{\begingroup
8668 \let_=\normalunderscore % normal _ character for filenames
8669 \tex % read txi-??.tex file in plain TeX.
8670 % Read the file by the name they passed if it exists.
8671 \openin 1 txi-#1.tex
8673 \documentlanguagetrywithoutunderscore{#1_\finish}%
8675 \globaldefs = 1 % everything in the txi-LL files needs to persist
8679 \endgroup % end raw TeX
8682 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8685 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8686 \openin 1 txi-#1.tex
8688 \errhelp = \nolanghelp
8689 \errmessage{Cannot read language file txi-#1.tex}%
8691 \globaldefs = 1 % everything in the txi-LL files needs to persist
8696 }% end of special _ catcode
8698 \newhelp\nolanghelp{The given language definition file cannot be found or
8699 is empty. Maybe you need to install it? Putting it in the current
8700 directory should work if nowhere else does.}
8702 % This macro is called from txi-??.tex files; the first argument is the
8703 % \language name to set (without the "\lang@" prefix), the second and
8704 % third args are \{left,right}hyphenmin.
8706 % The language names to pass are determined when the format is built.
8707 % See the etex.log file created at that time, e.g.,
8708 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8710 % With TeX Live 2008, etex now includes hyphenation patterns for all
8711 % available languages. This means we can support hyphenation in
8712 % Texinfo, at least to some extent. (This still doesn't solve the
8713 % accented characters problem.)
8716 \def\txisetlanguage#1#2#3{%
8717 % do not set the language if the name is undefined in the current TeX.
8718 \expandafter\ifx\csname lang@#1\endcsname \relax
8719 \message{no patterns for #1}%
8721 \global\language = \csname lang@#1\endcsname
8723 % but there is no harm in adjusting the hyphenmin values regardless.
8724 \global\lefthyphenmin = #2\relax
8725 \global\righthyphenmin = #3\relax
8728 % Helpers for encodings.
8729 % Set the catcode of characters 128 through 255 to the specified number.
8731 \def\setnonasciicharscatcode#1{%
8733 \loop\ifnum\count255<256
8734 \global\catcode\count255=#1\relax
8735 \advance\count255 by 1
8739 \def\setnonasciicharscatcodenonglobal#1{%
8741 \loop\ifnum\count255<256
8742 \catcode\count255=#1\relax
8743 \advance\count255 by 1
8747 % @documentencoding sets the definition of non-ASCII characters
8748 % according to the specified encoding.
8750 \parseargdef\documentencoding{%
8751 % Encoding being declared for the document.
8752 \def\declaredencoding{\csname #1.enc\endcsname}%
8754 % Supported encodings: names converted to tokens in order to be able
8755 % to compare them with \ifx.
8756 \def\ascii{\csname US-ASCII.enc\endcsname}%
8757 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8758 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8759 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8760 \def\utfeight{\csname UTF-8.enc\endcsname}%
8762 \ifx \declaredencoding \ascii
8765 \else \ifx \declaredencoding \lattwo
8766 \setnonasciicharscatcode\active
8769 \else \ifx \declaredencoding \latone
8770 \setnonasciicharscatcode\active
8773 \else \ifx \declaredencoding \latnine
8774 \setnonasciicharscatcode\active
8777 \else \ifx \declaredencoding \utfeight
8778 \setnonasciicharscatcode\active
8782 \message{Unknown document encoding #1, ignoring.}%
8791 % A message to be logged when using a character that isn't available
8792 % the default font encoding (OT1).
8794 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8796 % Take account of \c (plain) vs. \, (Texinfo) difference.
8797 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8799 % First, make active non-ASCII characters in order for them to be
8800 % correctly categorized when TeX reads the replacement text of
8801 % macros containing the character definitions.
8802 \setnonasciicharscatcode\active
8804 % Latin1 (ISO-8859-1) character definitions.
8805 \def\latonechardefs{%
8807 \gdef^^a1{\exclamdown}
8808 \gdef^^a2{\missingcharmsg{CENT SIGN}}
8809 \gdef^^a3{{\pounds}}
8810 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8811 \gdef^^a5{\missingcharmsg{YEN SIGN}}
8812 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8815 \gdef^^a9{\copyright}
8817 \gdef^^ab{\guillemetleft}
8820 \gdef^^ae{\registeredsymbol}
8823 \gdef^^b0{\textdegree}
8832 \gdef^^b8{\cedilla\ }
8836 \gdef^^bb{\guillemetright}
8837 \gdef^^bc{$1\over4$}
8838 \gdef^^bd{$1\over2$}
8839 \gdef^^be{$3\over4$}
8840 \gdef^^bf{\questiondown}
8847 \gdef^^c5{\ringaccent A}
8849 \gdef^^c7{\cedilla C}
8881 \gdef^^e5{\ringaccent a}
8883 \gdef^^e7{\cedilla c}
8888 \gdef^^ec{\`{\dotless i}}
8889 \gdef^^ed{\'{\dotless i}}
8890 \gdef^^ee{\^{\dotless i}}
8891 \gdef^^ef{\"{\dotless i}}
8911 % Latin9 (ISO-8859-15) encoding character definitions.
8912 \def\latninechardefs{%
8913 % Encoding is almost identical to Latin1.
8926 % Latin2 (ISO-8859-2) character definitions.
8927 \def\lattwochardefs{%
8929 \gdef^^a1{\ogonek{A}}
8932 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8938 \gdef^^aa{\cedilla S}
8943 \gdef^^af{\dotaccent Z}
8945 \gdef^^b0{\textdegree}
8946 \gdef^^b1{\ogonek{a}}
8947 \gdef^^b2{\ogonek{ }}
8953 \gdef^^b8{\cedilla\ }
8955 \gdef^^ba{\cedilla s}
8960 \gdef^^bf{\dotaccent z}
8969 \gdef^^c7{\cedilla C}
8972 \gdef^^ca{\ogonek{E}}
8988 \gdef^^d9{\ringaccent U}
8993 \gdef^^de{\cedilla T}
9003 \gdef^^e7{\cedilla c}
9006 \gdef^^ea{\ogonek{e}}
9009 \gdef^^ed{\'{\dotless{i}}}
9010 \gdef^^ee{\^{\dotless{i}}}
9022 \gdef^^f9{\ringaccent u}
9027 \gdef^^fe{\cedilla t}
9028 \gdef^^ff{\dotaccent{}}
9031 % UTF-8 character definitions.
9033 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
9034 % changes for Texinfo conventions. It is included here under the GPL by
9035 % permission from Frank Mittelbach and the LaTeX team.
9041 \gdef\UTFviiiTwoOctets#1#2{\expandafter
9042 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
9044 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
9045 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
9047 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
9048 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
9050 \gdef\UTFviiiDefined#1{%
9052 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
9063 \global\catcode\countUTFx\active
9064 \uccode`\~\countUTFx
9065 \uppercase\expandafter{\UTFviiiTmp}%
9066 \advance\countUTFx by 1
9067 \ifnum\countUTFx < \countUTFy
9068 \expandafter\UTFviiiLoop
9074 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
9080 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
9086 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
9099 \gdef\DeclareUnicodeCharacter#1#2{%
9100 \countUTFz = "#1\relax
9101 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9104 \def\UTFviiiTwoOctets##1##2{%
9105 \csname u8:##1\string ##2\endcsname}%
9106 \def\UTFviiiThreeOctets##1##2##3{%
9107 \csname u8:##1\string ##2\string ##3\endcsname}%
9108 \def\UTFviiiFourOctets##1##2##3##4{%
9109 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
9110 \expandafter\expandafter\expandafter\expandafter
9111 \expandafter\expandafter\expandafter
9112 \gdef\UTFviiiTmp{#2}%
9115 \gdef\parseXMLCharref{%
9116 \ifnum\countUTFz < "A0\relax
9117 \errhelp = \EMsimple
9118 \errmessage{Cannot define Unicode char value < 00A0}%
9119 \else\ifnum\countUTFz < "800\relax
9121 \parseUTFviiiB C\UTFviiiTwoOctets.,%
9122 \else\ifnum\countUTFz < "10000\relax
9125 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
9130 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
9134 \gdef\parseUTFviiiA#1{%
9135 \countUTFx = \countUTFz
9136 \divide\countUTFz by 64
9137 \countUTFy = \countUTFz
9138 \multiply\countUTFz by 64
9139 \advance\countUTFx by -\countUTFz
9140 \advance\countUTFx by 128
9141 \uccode `#1\countUTFx
9142 \countUTFz = \countUTFy}
9144 \gdef\parseUTFviiiB#1#2#3#4{%
9145 \advance\countUTFz by "#10\relax
9146 \uccode `#3\countUTFz
9147 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9150 \def\utfeightchardefs{%
9151 \DeclareUnicodeCharacter{00A0}{\tie}
9152 \DeclareUnicodeCharacter{00A1}{\exclamdown}
9153 \DeclareUnicodeCharacter{00A3}{\pounds}
9154 \DeclareUnicodeCharacter{00A8}{\"{ }}
9155 \DeclareUnicodeCharacter{00A9}{\copyright}
9156 \DeclareUnicodeCharacter{00AA}{\ordf}
9157 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
9158 \DeclareUnicodeCharacter{00AD}{\-}
9159 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
9160 \DeclareUnicodeCharacter{00AF}{\={ }}
9162 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
9163 \DeclareUnicodeCharacter{00B4}{\'{ }}
9164 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
9165 \DeclareUnicodeCharacter{00BA}{\ordm}
9166 \DeclareUnicodeCharacter{00BB}{\guillemetright}
9167 \DeclareUnicodeCharacter{00BF}{\questiondown}
9169 \DeclareUnicodeCharacter{00C0}{\`A}
9170 \DeclareUnicodeCharacter{00C1}{\'A}
9171 \DeclareUnicodeCharacter{00C2}{\^A}
9172 \DeclareUnicodeCharacter{00C3}{\~A}
9173 \DeclareUnicodeCharacter{00C4}{\"A}
9174 \DeclareUnicodeCharacter{00C5}{\AA}
9175 \DeclareUnicodeCharacter{00C6}{\AE}
9176 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
9177 \DeclareUnicodeCharacter{00C8}{\`E}
9178 \DeclareUnicodeCharacter{00C9}{\'E}
9179 \DeclareUnicodeCharacter{00CA}{\^E}
9180 \DeclareUnicodeCharacter{00CB}{\"E}
9181 \DeclareUnicodeCharacter{00CC}{\`I}
9182 \DeclareUnicodeCharacter{00CD}{\'I}
9183 \DeclareUnicodeCharacter{00CE}{\^I}
9184 \DeclareUnicodeCharacter{00CF}{\"I}
9186 \DeclareUnicodeCharacter{00D0}{\DH}
9187 \DeclareUnicodeCharacter{00D1}{\~N}
9188 \DeclareUnicodeCharacter{00D2}{\`O}
9189 \DeclareUnicodeCharacter{00D3}{\'O}
9190 \DeclareUnicodeCharacter{00D4}{\^O}
9191 \DeclareUnicodeCharacter{00D5}{\~O}
9192 \DeclareUnicodeCharacter{00D6}{\"O}
9193 \DeclareUnicodeCharacter{00D8}{\O}
9194 \DeclareUnicodeCharacter{00D9}{\`U}
9195 \DeclareUnicodeCharacter{00DA}{\'U}
9196 \DeclareUnicodeCharacter{00DB}{\^U}
9197 \DeclareUnicodeCharacter{00DC}{\"U}
9198 \DeclareUnicodeCharacter{00DD}{\'Y}
9199 \DeclareUnicodeCharacter{00DE}{\TH}
9200 \DeclareUnicodeCharacter{00DF}{\ss}
9202 \DeclareUnicodeCharacter{00E0}{\`a}
9203 \DeclareUnicodeCharacter{00E1}{\'a}
9204 \DeclareUnicodeCharacter{00E2}{\^a}
9205 \DeclareUnicodeCharacter{00E3}{\~a}
9206 \DeclareUnicodeCharacter{00E4}{\"a}
9207 \DeclareUnicodeCharacter{00E5}{\aa}
9208 \DeclareUnicodeCharacter{00E6}{\ae}
9209 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
9210 \DeclareUnicodeCharacter{00E8}{\`e}
9211 \DeclareUnicodeCharacter{00E9}{\'e}
9212 \DeclareUnicodeCharacter{00EA}{\^e}
9213 \DeclareUnicodeCharacter{00EB}{\"e}
9214 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
9215 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
9216 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
9217 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
9219 \DeclareUnicodeCharacter{00F0}{\dh}
9220 \DeclareUnicodeCharacter{00F1}{\~n}
9221 \DeclareUnicodeCharacter{00F2}{\`o}
9222 \DeclareUnicodeCharacter{00F3}{\'o}
9223 \DeclareUnicodeCharacter{00F4}{\^o}
9224 \DeclareUnicodeCharacter{00F5}{\~o}
9225 \DeclareUnicodeCharacter{00F6}{\"o}
9226 \DeclareUnicodeCharacter{00F8}{\o}
9227 \DeclareUnicodeCharacter{00F9}{\`u}
9228 \DeclareUnicodeCharacter{00FA}{\'u}
9229 \DeclareUnicodeCharacter{00FB}{\^u}
9230 \DeclareUnicodeCharacter{00FC}{\"u}
9231 \DeclareUnicodeCharacter{00FD}{\'y}
9232 \DeclareUnicodeCharacter{00FE}{\th}
9233 \DeclareUnicodeCharacter{00FF}{\"y}
9235 \DeclareUnicodeCharacter{0100}{\=A}
9236 \DeclareUnicodeCharacter{0101}{\=a}
9237 \DeclareUnicodeCharacter{0102}{\u{A}}
9238 \DeclareUnicodeCharacter{0103}{\u{a}}
9239 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
9240 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
9241 \DeclareUnicodeCharacter{0106}{\'C}
9242 \DeclareUnicodeCharacter{0107}{\'c}
9243 \DeclareUnicodeCharacter{0108}{\^C}
9244 \DeclareUnicodeCharacter{0109}{\^c}
9245 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
9246 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
9247 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
9248 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
9249 \DeclareUnicodeCharacter{010C}{\v{C}}
9250 \DeclareUnicodeCharacter{010D}{\v{c}}
9251 \DeclareUnicodeCharacter{010E}{\v{D}}
9253 \DeclareUnicodeCharacter{0112}{\=E}
9254 \DeclareUnicodeCharacter{0113}{\=e}
9255 \DeclareUnicodeCharacter{0114}{\u{E}}
9256 \DeclareUnicodeCharacter{0115}{\u{e}}
9257 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
9258 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
9259 \DeclareUnicodeCharacter{011A}{\v{E}}
9260 \DeclareUnicodeCharacter{011B}{\v{e}}
9261 \DeclareUnicodeCharacter{011C}{\^G}
9262 \DeclareUnicodeCharacter{011D}{\^g}
9263 \DeclareUnicodeCharacter{011E}{\u{G}}
9264 \DeclareUnicodeCharacter{011F}{\u{g}}
9266 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
9267 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
9268 \DeclareUnicodeCharacter{0124}{\^H}
9269 \DeclareUnicodeCharacter{0125}{\^h}
9270 \DeclareUnicodeCharacter{0128}{\~I}
9271 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
9272 \DeclareUnicodeCharacter{012A}{\=I}
9273 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
9274 \DeclareUnicodeCharacter{012C}{\u{I}}
9275 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
9277 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
9278 \DeclareUnicodeCharacter{0131}{\dotless{i}}
9279 \DeclareUnicodeCharacter{0132}{IJ}
9280 \DeclareUnicodeCharacter{0133}{ij}
9281 \DeclareUnicodeCharacter{0134}{\^J}
9282 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
9283 \DeclareUnicodeCharacter{0139}{\'L}
9284 \DeclareUnicodeCharacter{013A}{\'l}
9286 \DeclareUnicodeCharacter{0141}{\L}
9287 \DeclareUnicodeCharacter{0142}{\l}
9288 \DeclareUnicodeCharacter{0143}{\'N}
9289 \DeclareUnicodeCharacter{0144}{\'n}
9290 \DeclareUnicodeCharacter{0147}{\v{N}}
9291 \DeclareUnicodeCharacter{0148}{\v{n}}
9292 \DeclareUnicodeCharacter{014C}{\=O}
9293 \DeclareUnicodeCharacter{014D}{\=o}
9294 \DeclareUnicodeCharacter{014E}{\u{O}}
9295 \DeclareUnicodeCharacter{014F}{\u{o}}
9297 \DeclareUnicodeCharacter{0150}{\H{O}}
9298 \DeclareUnicodeCharacter{0151}{\H{o}}
9299 \DeclareUnicodeCharacter{0152}{\OE}
9300 \DeclareUnicodeCharacter{0153}{\oe}
9301 \DeclareUnicodeCharacter{0154}{\'R}
9302 \DeclareUnicodeCharacter{0155}{\'r}
9303 \DeclareUnicodeCharacter{0158}{\v{R}}
9304 \DeclareUnicodeCharacter{0159}{\v{r}}
9305 \DeclareUnicodeCharacter{015A}{\'S}
9306 \DeclareUnicodeCharacter{015B}{\'s}
9307 \DeclareUnicodeCharacter{015C}{\^S}
9308 \DeclareUnicodeCharacter{015D}{\^s}
9309 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
9310 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
9312 \DeclareUnicodeCharacter{0160}{\v{S}}
9313 \DeclareUnicodeCharacter{0161}{\v{s}}
9314 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
9315 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
9316 \DeclareUnicodeCharacter{0164}{\v{T}}
9318 \DeclareUnicodeCharacter{0168}{\~U}
9319 \DeclareUnicodeCharacter{0169}{\~u}
9320 \DeclareUnicodeCharacter{016A}{\=U}
9321 \DeclareUnicodeCharacter{016B}{\=u}
9322 \DeclareUnicodeCharacter{016C}{\u{U}}
9323 \DeclareUnicodeCharacter{016D}{\u{u}}
9324 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
9325 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
9327 \DeclareUnicodeCharacter{0170}{\H{U}}
9328 \DeclareUnicodeCharacter{0171}{\H{u}}
9329 \DeclareUnicodeCharacter{0174}{\^W}
9330 \DeclareUnicodeCharacter{0175}{\^w}
9331 \DeclareUnicodeCharacter{0176}{\^Y}
9332 \DeclareUnicodeCharacter{0177}{\^y}
9333 \DeclareUnicodeCharacter{0178}{\"Y}
9334 \DeclareUnicodeCharacter{0179}{\'Z}
9335 \DeclareUnicodeCharacter{017A}{\'z}
9336 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
9337 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
9338 \DeclareUnicodeCharacter{017D}{\v{Z}}
9339 \DeclareUnicodeCharacter{017E}{\v{z}}
9341 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
9342 \DeclareUnicodeCharacter{01C5}{D\v{z}}
9343 \DeclareUnicodeCharacter{01C6}{d\v{z}}
9344 \DeclareUnicodeCharacter{01C7}{LJ}
9345 \DeclareUnicodeCharacter{01C8}{Lj}
9346 \DeclareUnicodeCharacter{01C9}{lj}
9347 \DeclareUnicodeCharacter{01CA}{NJ}
9348 \DeclareUnicodeCharacter{01CB}{Nj}
9349 \DeclareUnicodeCharacter{01CC}{nj}
9350 \DeclareUnicodeCharacter{01CD}{\v{A}}
9351 \DeclareUnicodeCharacter{01CE}{\v{a}}
9352 \DeclareUnicodeCharacter{01CF}{\v{I}}
9354 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
9355 \DeclareUnicodeCharacter{01D1}{\v{O}}
9356 \DeclareUnicodeCharacter{01D2}{\v{o}}
9357 \DeclareUnicodeCharacter{01D3}{\v{U}}
9358 \DeclareUnicodeCharacter{01D4}{\v{u}}
9360 \DeclareUnicodeCharacter{01E2}{\={\AE}}
9361 \DeclareUnicodeCharacter{01E3}{\={\ae}}
9362 \DeclareUnicodeCharacter{01E6}{\v{G}}
9363 \DeclareUnicodeCharacter{01E7}{\v{g}}
9364 \DeclareUnicodeCharacter{01E8}{\v{K}}
9365 \DeclareUnicodeCharacter{01E9}{\v{k}}
9367 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
9368 \DeclareUnicodeCharacter{01F1}{DZ}
9369 \DeclareUnicodeCharacter{01F2}{Dz}
9370 \DeclareUnicodeCharacter{01F3}{dz}
9371 \DeclareUnicodeCharacter{01F4}{\'G}
9372 \DeclareUnicodeCharacter{01F5}{\'g}
9373 \DeclareUnicodeCharacter{01F8}{\`N}
9374 \DeclareUnicodeCharacter{01F9}{\`n}
9375 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
9376 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
9377 \DeclareUnicodeCharacter{01FE}{\'{\O}}
9378 \DeclareUnicodeCharacter{01FF}{\'{\o}}
9380 \DeclareUnicodeCharacter{021E}{\v{H}}
9381 \DeclareUnicodeCharacter{021F}{\v{h}}
9383 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
9384 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
9385 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
9386 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
9387 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
9388 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
9390 \DeclareUnicodeCharacter{0232}{\=Y}
9391 \DeclareUnicodeCharacter{0233}{\=y}
9392 \DeclareUnicodeCharacter{0237}{\dotless{j}}
9394 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
9396 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
9397 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
9398 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
9399 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
9400 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
9401 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
9402 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
9403 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
9404 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
9405 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
9406 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
9407 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
9409 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
9410 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
9412 \DeclareUnicodeCharacter{1E20}{\=G}
9413 \DeclareUnicodeCharacter{1E21}{\=g}
9414 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
9415 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
9416 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
9417 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
9418 \DeclareUnicodeCharacter{1E26}{\"H}
9419 \DeclareUnicodeCharacter{1E27}{\"h}
9421 \DeclareUnicodeCharacter{1E30}{\'K}
9422 \DeclareUnicodeCharacter{1E31}{\'k}
9423 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
9424 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
9425 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
9426 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
9427 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
9428 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
9429 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
9430 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
9431 \DeclareUnicodeCharacter{1E3E}{\'M}
9432 \DeclareUnicodeCharacter{1E3F}{\'m}
9434 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
9435 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
9436 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
9437 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
9438 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
9439 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
9440 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
9441 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
9442 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
9443 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
9445 \DeclareUnicodeCharacter{1E54}{\'P}
9446 \DeclareUnicodeCharacter{1E55}{\'p}
9447 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
9448 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
9449 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
9450 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
9451 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
9452 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
9453 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
9454 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
9456 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
9457 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
9458 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
9459 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
9460 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
9461 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
9462 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
9463 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
9464 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
9465 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
9467 \DeclareUnicodeCharacter{1E7C}{\~V}
9468 \DeclareUnicodeCharacter{1E7D}{\~v}
9469 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
9470 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
9472 \DeclareUnicodeCharacter{1E80}{\`W}
9473 \DeclareUnicodeCharacter{1E81}{\`w}
9474 \DeclareUnicodeCharacter{1E82}{\'W}
9475 \DeclareUnicodeCharacter{1E83}{\'w}
9476 \DeclareUnicodeCharacter{1E84}{\"W}
9477 \DeclareUnicodeCharacter{1E85}{\"w}
9478 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
9479 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
9480 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
9481 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
9482 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
9483 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
9484 \DeclareUnicodeCharacter{1E8C}{\"X}
9485 \DeclareUnicodeCharacter{1E8D}{\"x}
9486 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
9487 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
9489 \DeclareUnicodeCharacter{1E90}{\^Z}
9490 \DeclareUnicodeCharacter{1E91}{\^z}
9491 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
9492 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
9493 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
9494 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
9495 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
9496 \DeclareUnicodeCharacter{1E97}{\"t}
9497 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
9498 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
9500 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
9501 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
9503 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
9504 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
9505 \DeclareUnicodeCharacter{1EBC}{\~E}
9506 \DeclareUnicodeCharacter{1EBD}{\~e}
9508 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
9509 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
9510 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
9511 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
9513 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
9514 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
9516 \DeclareUnicodeCharacter{1EF2}{\`Y}
9517 \DeclareUnicodeCharacter{1EF3}{\`y}
9518 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
9520 \DeclareUnicodeCharacter{1EF8}{\~Y}
9521 \DeclareUnicodeCharacter{1EF9}{\~y}
9523 \DeclareUnicodeCharacter{2013}{--}
9524 \DeclareUnicodeCharacter{2014}{---}
9525 \DeclareUnicodeCharacter{2018}{\quoteleft}
9526 \DeclareUnicodeCharacter{2019}{\quoteright}
9527 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
9528 \DeclareUnicodeCharacter{201C}{\quotedblleft}
9529 \DeclareUnicodeCharacter{201D}{\quotedblright}
9530 \DeclareUnicodeCharacter{201E}{\quotedblbase}
9531 \DeclareUnicodeCharacter{2022}{\bullet}
9532 \DeclareUnicodeCharacter{2026}{\dots}
9533 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9534 \DeclareUnicodeCharacter{203A}{\guilsinglright}
9535 \DeclareUnicodeCharacter{20AC}{\euro}
9537 \DeclareUnicodeCharacter{2192}{\expansion}
9538 \DeclareUnicodeCharacter{21D2}{\result}
9540 \DeclareUnicodeCharacter{2212}{\minus}
9541 \DeclareUnicodeCharacter{2217}{\point}
9542 \DeclareUnicodeCharacter{2261}{\equiv}
9543 }% end of \utfeightchardefs
9546 % US-ASCII character definitions.
9547 \def\asciichardefs{% nothing need be done
9551 % Make non-ASCII characters printable again for compatibility with
9552 % existing Texinfo documents that may use them, even without declaring a
9553 % document encoding.
9555 \setnonasciicharscatcode \other
9558 \message{formatting,}
9560 \newdimen\defaultparindent \defaultparindent = 15pt
9562 \chapheadingskip = 15pt plus 4pt minus 2pt
9563 \secheadingskip = 12pt plus 3pt minus 2pt
9564 \subsecheadingskip = 9pt plus 2pt minus 2pt
9566 % Prevent underfull vbox error messages.
9569 % Don't be very finicky about underfull hboxes, either.
9572 % Following George Bush, get rid of widows and orphans.
9576 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9577 % using an old version of TeX, don't do anything. We want the amount of
9578 % stretch added to depend on the line length, hence the dependence on
9579 % \hsize. We call this whenever the paper size is set.
9581 \def\setemergencystretch{%
9582 \ifx\emergencystretch\thisisundefined
9583 % Allow us to assign to \emergencystretch anyway.
9584 \def\emergencystretch{\dimen0}%
9586 \emergencystretch = .15\hsize
9590 % Parameters in order: 1) textheight; 2) textwidth;
9591 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9592 % 7) physical page height; 8) physical page width.
9594 % We also call \setleading{\textleading}, so the caller should define
9595 % \textleading. The caller should also set \parskip.
9597 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9600 \splittopskip = \topskip
9603 \advance\vsize by \topskip
9604 \outervsize = \vsize
9605 \advance\outervsize by 2\topandbottommargin
9606 \pageheight = \vsize
9609 \outerhsize = \hsize
9610 \advance\outerhsize by 0.5in
9613 \normaloffset = #4\relax
9614 \bindingoffset = #5\relax
9617 \pdfpageheight #7\relax
9618 \pdfpagewidth #8\relax
9619 % if we don't reset these, they will remain at "1 true in" of
9620 % whatever layout pdftex was dumped with.
9621 \pdfhorigin = 1 true in
9622 \pdfvorigin = 1 true in
9625 \setleading{\textleading}
9627 \parindent = \defaultparindent
9628 \setemergencystretch
9631 % @letterpaper (the default).
9632 \def\letterpaper{{\globaldefs = 1
9633 \parskip = 3pt plus 2pt minus 1pt
9634 \textleading = 13.2pt
9636 % If page is nothing but text, make it come out even.
9637 \internalpagesizes{607.2pt}{6in}% that's 46 lines
9639 {\bindingoffset}{36pt}%
9643 % Use @smallbook to reset parameters for 7x9.25 trim size.
9644 \def\smallbook{{\globaldefs = 1
9645 \parskip = 2pt plus 1pt
9648 \internalpagesizes{7.5in}{5in}%
9650 {\bindingoffset}{16pt}%
9653 \lispnarrowing = 0.3in
9656 \contentsrightmargin = 0pt
9657 \defbodyindent = .5cm
9660 % Use @smallerbook to reset parameters for 6x9 trim size.
9661 % (Just testing, parameters still in flux.)
9662 \def\smallerbook{{\globaldefs = 1
9663 \parskip = 1.5pt plus 1pt
9666 \internalpagesizes{7.4in}{4.8in}%
9671 \lispnarrowing = 0.25in
9674 \contentsrightmargin = 0pt
9675 \defbodyindent = .4cm
9678 % Use @afourpaper to print on European A4 paper.
9679 \def\afourpaper{{\globaldefs = 1
9680 \parskip = 3pt plus 2pt minus 1pt
9681 \textleading = 13.2pt
9683 % Double-side printing via postscript on Laserjet 4050
9684 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9685 % To change the settings for a different printer or situation, adjust
9686 % \normaloffset until the front-side and back-side texts align. Then
9687 % do the same for \bindingoffset. You can set these for testing in
9688 % your texinfo source file like this:
9690 % \global\normaloffset = -6mm
9691 % \global\bindingoffset = 10mm
9693 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9694 {\voffset}{\hoffset}%
9695 {\bindingoffset}{44pt}%
9700 \contentsrightmargin = 0pt
9701 \defbodyindent = 5mm
9704 % Use @afivepaper to print on European A5 paper.
9705 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9706 % He also recommends making @example and @lisp be small.
9707 \def\afivepaper{{\globaldefs = 1
9708 \parskip = 2pt plus 1pt minus 0.1pt
9709 \textleading = 12.5pt
9711 \internalpagesizes{160mm}{120mm}%
9712 {\voffset}{\hoffset}%
9713 {\bindingoffset}{8pt}%
9716 \lispnarrowing = 0.2in
9719 \contentsrightmargin = 0pt
9720 \defbodyindent = 2mm
9724 % A specific text layout, 24x15cm overall, intended for A4 paper.
9725 \def\afourlatex{{\globaldefs = 1
9727 \internalpagesizes{237mm}{150mm}%
9729 {\bindingoffset}{7mm}%
9732 % Must explicitly reset to 0 because we call \afourpaper.
9736 % Use @afourwide to print on A4 paper in landscape format.
9737 \def\afourwide{{\globaldefs = 1
9739 \internalpagesizes{241mm}{165mm}%
9740 {\voffset}{-2.95mm}%
9741 {\bindingoffset}{7mm}%
9746 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9747 % Perhaps we should allow setting the margins, \topskip, \parskip,
9748 % and/or leading, also. Or perhaps we should compute them somehow.
9750 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9751 \def\pagesizesyyy#1,#2,#3\finish{{%
9752 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9755 \parskip = 3pt plus 2pt minus 1pt
9756 \setleading{\textleading}%
9759 \advance\dimen0 by \voffset
9762 \advance\dimen2 by \normaloffset
9764 \internalpagesizes{#1}{\hsize}%
9765 {\voffset}{\normaloffset}%
9766 {\bindingoffset}{44pt}%
9770 % Set default to letter.
9775 \message{and turning on texinfo input format.}
9777 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
9779 % DEL is a comment character, in case @c does not suffice.
9782 % Define macros to output various characters with catcode for normal text.
9783 \catcode`\"=\other \def\normaldoublequote{"}
9784 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
9785 \catcode`\+=\other \def\normalplus{+}
9786 \catcode`\<=\other \def\normalless{<}
9787 \catcode`\>=\other \def\normalgreater{>}
9788 \catcode`\^=\other \def\normalcaret{^}
9789 \catcode`\_=\other \def\normalunderscore{_}
9790 \catcode`\|=\other \def\normalverticalbar{|}
9791 \catcode`\~=\other \def\normaltilde{~}
9793 % This macro is used to make a character print one way in \tt
9794 % (where it can probably be output as-is), and another way in other fonts,
9795 % where something hairier probably needs to be done.
9797 % #1 is what to print if we are indeed using \tt; #2 is what to print
9798 % otherwise. Since all the Computer Modern typewriter fonts have zero
9799 % interword stretch (and shrink), and it is reasonable to expect all
9800 % typewriter fonts to have this, we can check that font parameter.
9802 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9804 % Same as above, but check for italic font. Actually this also catches
9805 % non-italic slanted fonts since it is impossible to distinguish them from
9806 % italic fonts. But since this is only used by $ and it uses \sl anyway
9807 % this is not a problem.
9808 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9810 % Turn off all special characters except @
9811 % (and those which the user can use as if they were ordinary).
9812 % Most of these we simply print from the \tt font, but for some, we can
9813 % use math or other variants that look better in normal text.
9816 \def\activedoublequote{{\tt\char34}}
9817 \let"=\activedoublequote
9819 \def~{{\tt\char126}}
9825 \def_{\ifusingtt\normalunderscore\_}
9827 % Subroutine for the previous macro.
9828 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9831 \def|{{\tt\char124}}
9839 \def+{{\tt \char 43}}
9841 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9843 % If a .fmt file is being used, characters that might appear in a file
9844 % name cannot be active until we have parsed the command line.
9845 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9846 % \otherifyactive is called near the end of this file.
9847 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9849 % Used sometimes to turn off (effectively) the active characters even after
9851 \def\turnoffactive{%
9852 \normalturnoffactive
9858 % \backslashcurfont outputs one backslash character in current font,
9860 \global\chardef\backslashcurfont=`\\
9861 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
9863 % \realbackslash is an actual character `\' with catcode other, and
9864 % \doublebackslash is two of them (for the pdf outlines).
9865 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9867 % In texinfo, backslash is an active character; it prints the backslash
9868 % in fixed width font.
9869 \catcode`\\=\active % @ for escape char from now on.
9871 % The story here is that in math mode, the \char of \backslashcurfont
9872 % ends up printing the roman \ from the math symbol font (because \char
9873 % in math mode uses the \mathcode, and plain.tex sets
9874 % \mathcode`\\="026E). It seems better for @backslashchar{} to always
9875 % print a typewriter backslash, hence we use an explicit \mathchar,
9876 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
9877 % ignored family value; char position "5C). We can't use " for the
9878 % usual hex value because it has already been made active.
9879 @def@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
9880 @let@backslashchar = @normalbackslash % @backslashchar{} is for user documents.
9882 % On startup, @fixbackslash assigns:
9883 % @let \ = @normalbackslash
9884 % \rawbackslash defines an active \ to do \backslashcurfont.
9885 % \otherbackslash defines an active \ to be a literal `\' character with
9886 % catcode other. We switch back and forth between these.
9887 @gdef@rawbackslash{@let\=@backslashcurfont}
9888 @gdef@otherbackslash{@let\=@realbackslash}
9890 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9891 % the literal character `\'.
9893 @def@normalturnoffactive{%
9894 @let"=@normaldoublequote
9895 @let$=@normaldollar %$ font-lock fix
9898 @let>=@normalgreater
9899 @let\=@normalbackslash
9901 @let_=@normalunderscore
9902 @let|=@normalverticalbar
9904 @markupsetuplqdefault
9905 @markupsetuprqdefault
9909 % Make _ and + \other characters, temporarily.
9910 % This is canceled by @fixbackslash.
9913 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9914 % That is what \eatinput is for; after that, the `\' should revert to printing
9917 @gdef@eatinput input texinfo{@fixbackslash}
9918 @global@let\ = @eatinput
9920 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
9921 % the first `\' in the file would cause an error. This macro tries to fix
9922 % that, assuming it is called before the first `\' could plausibly occur.
9923 % Also turn back on active characters that might appear in the input
9924 % file name, in case not using a pre-dumped format.
9926 @gdef@fixbackslash{%
9927 @ifx\@eatinput @let\ = @normalbackslash @fi
9932 % Say @foo, not \foo, in error messages.
9935 % These (along with & and #) are made active for url-breaking, so need
9936 % active definitions as the normal characters.
9941 % These look ok in all fonts, so just make them not special.
9942 % @hashchar{} gets its own user-level command, because of #line.
9943 @catcode`@& = @other @def@normalamp{&}
9944 @catcode`@# = @other @def@normalhash{#}
9945 @catcode`@% = @other @def@normalpercent{%}
9947 @let @hashchar = @normalhash
9949 @c Finally, make ` and ' active, so that txicodequoteundirected and
9950 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
9951 @c don't make ` and ' active, @code will not get them as active chars.
9952 @c Do this last of all since we use ` in the previous @catcode assignments.
9955 @markupsetuplqdefault
9956 @markupsetuprqdefault
9959 @c eval: (add-hook 'write-file-hooks 'time-stamp)
9960 @c page-delimiter: "^\\\\message"
9961 @c time-stamp-start: "def\\\\texinfoversion{"
9962 @c time-stamp-format: "%:y-%02m-%02d.%02H"
9963 @c time-stamp-end: "}"
9969 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115