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-07-03.16@LP}
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 % Modified version used in LilyPond, changed in 2012.
14 % This texinfo.tex file is free software: you can redistribute it and/or
15 % modify it under the terms of the GNU General Public License as
16 % published by the Free Software Foundation, either version 3 of the
17 % License, or (at your option) any later version.
19 % This texinfo.tex file is distributed in the hope that it will be
20 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
21 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 % General Public License for more details.
24 % You should have received a copy of the GNU General Public License
25 % along with this program. If not, see <http://www.gnu.org/licenses/>.
27 % As a special exception, when this file is read by TeX when processing
28 % a Texinfo source document, you may use the result without
29 % restriction. (This has been our intent since Texinfo was invented.)
31 % Please try the latest version of texinfo.tex before submitting bug
32 % reports; you can get the latest version from:
33 % http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
34 % http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
35 % http://www.gnu.org/software/texinfo/ (the Texinfo home page)
36 % The texinfo.tex in any given distribution could well be out
37 % of date, so if that's what you're using, please check.
39 % Send bug reports to bug-texinfo@gnu.org. Please include including a
40 % complete document in each bug report with which we can reproduce the
41 % problem. Patches are, of course, greatly appreciated.
43 % To process a Texinfo manual with TeX, it's most reliable to use the
44 % texi2dvi shell script that comes with the distribution. For a simple
45 % manual foo.texi, however, you can get away with this:
50 % dvips foo.dvi -o # or whatever; this makes foo.ps.
51 % The extra TeX runs get the cross-reference information correct.
52 % Sometimes one run after texindex suffices, and sometimes you need more
53 % than two; texi2dvi does it as many times as necessary.
55 % It is possible to adapt texinfo.tex for other languages, to some
56 % extent. You can get the existing language-specific files from the
57 % full Texinfo distribution.
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
62 \message{Loading texinfo [version \texinfoversion]:}
64 % If in a .fmt file, print the version number
65 % and turn on active characters that we couldn't do earlier because
66 % they might have appeared in the input file name.
67 \everyjob{\message{[Texinfo version \texinfoversion]}%
68 \catcode`+=\active \catcode`\_=\active}
72 % We never want plain's \outer definition of \+ in Texinfo.
73 % For @tex, we can use \tabalign.
76 % Save some plain tex macros whose names we will redefine.
78 \let\ptexbullet=\bullet
86 \let\ptexfootnote=\footnote
90 \let\ptexindent=\indent
91 \let\ptexinsert=\insert
94 \let\ptexnewwrite\newwrite
95 \let\ptexnoindent=\noindent
97 \let\ptexraggedright=\raggedright
103 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
105 % If this character appears in an error message or help string, it
106 % starts a new line in the output.
109 % Use TeX 3.0's \inputlineno to get the line number, for better error
110 % messages, but if we're using an old version of TeX, don't do anything.
112 \ifx\inputlineno\thisisundefined
113 \let\linenumber = \empty % Pre-3.0.
115 \def\linenumber{l.\the\inputlineno:\space}
118 % Set up fixed words for English if not already set.
119 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
120 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
121 \ifx\putworderror\undefined \gdef\putworderror{error}\fi
122 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
123 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
124 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
125 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
126 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
127 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
128 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
129 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
130 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
131 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
132 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
133 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
134 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
135 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
136 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
137 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
138 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
140 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
141 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
142 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
143 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
144 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
145 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
146 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
147 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
148 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
149 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
150 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
151 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
153 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
154 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
155 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
156 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
157 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
159 % Since the category of space is not known, we have to be careful.
160 \chardef\spacecat = 10
161 \def\spaceisspace{\catcode`\ =\spacecat}
163 % sometimes characters are active, so we need control sequences.
164 \chardef\ampChar = `\&
165 \chardef\colonChar = `\:
166 \chardef\commaChar = `\,
167 \chardef\dashChar = `\-
168 \chardef\dotChar = `\.
169 \chardef\exclamChar= `\!
170 \chardef\hashChar = `\#
171 \chardef\lquoteChar= `\`
172 \chardef\questChar = `\?
173 \chardef\rquoteChar= `\'
174 \chardef\semiChar = `\;
175 \chardef\slashChar = `\/
176 \chardef\underChar = `\_
182 % The following is used inside several \edef's.
183 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
187 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
188 ap-pen-dix bit-map bit-maps
189 data-base data-bases eshell fall-ing half-way long-est man-u-script
190 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
191 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
193 stand-alone strong-est time-stamp time-stamps which-ever white-space
194 wide-spread wrap-around
197 % Margin to add to right of even pages, to left of odd pages.
198 \newdimen\bindingoffset
199 \newdimen\normaloffset
200 \newdimen\pagewidth \newdimen\pageheight
202 % For a final copy, take out the rectangles
203 % that mark overfull boxes (in case you have decided
204 % that the text looks ok even though it passes the margin).
206 \def\finalout{\overfullrule=0pt }
208 % Sometimes it is convenient to have everything in the transcript file
209 % and nothing on the terminal. We don't just call \tracingall here,
210 % since that produces some useless output on the terminal. We also make
211 % some effort to order the tracing commands to reduce output in the log
212 % file; cf. trace.sty in LaTeX.
214 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
218 \tracinglostchars2 % 2 gives us more in etex
223 \showboxbreadth\maxdimen \showboxdepth\maxdimen
224 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
231 \tracingcommands3 % 3 gives us more in etex
235 % @errormsg{MSG}. Do the index-like expansions on MSG, but if things
236 % aren't perfect, it's not the end of the world, being an error message,
239 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
240 \def\doerrormsg#1{\errmessage{#1}}
242 % add check for \lastpenalty to plain's definitions. If the last thing
243 % we did was a \nobreak, we don't want to insert more space.
245 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
246 \removelastskip\penalty-50\smallskip\fi\fi}
247 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
248 \removelastskip\penalty-100\medskip\fi\fi}
249 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
250 \removelastskip\penalty-200\bigskip\fi\fi}
252 % Do @cropmarks to get crop marks.
255 \let\cropmarks = \cropmarkstrue
257 % Dimensions to add cropmarks at corners.
258 % Added by P. A. MacKay, 12 Nov. 1986
260 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
261 \newdimen\cornerlong \cornerlong=1pc
262 \newdimen\cornerthick \cornerthick=.3pt
263 \newdimen\topandbottommargin \topandbottommargin=.75in
265 % Output a mark which sets \thischapter, \thissection and \thiscolor.
266 % We dump everything together because we only have one kind of mark.
267 % This works because we only use \botmark / \topmark, not \firstmark.
269 % A mark contains a subexpression of the \ifcase ... \fi construct.
270 % \get*marks macros below extract the needed part using \ifcase.
272 % Another complication is to let the user choose whether \thischapter
273 % (\thissection) refers to the chapter (section) in effect at the top
274 % of a page, or that at the bottom of a page. The solution is
275 % described on page 260 of The TeXbook. It involves outputting two
276 % marks for the sectioning macros, one before the section break, and
277 % one after. I won't pretend I can describe this better than DEK...
279 \toks0=\expandafter{\lastchapterdefs}%
280 \toks2=\expandafter{\lastsectiondefs}%
281 \toks4=\expandafter{\prevchapterdefs}%
282 \toks6=\expandafter{\prevsectiondefs}%
283 \toks8=\expandafter{\lastcolordefs}%
285 \the\toks0 \the\toks2
286 \noexpand\or \the\toks4 \the\toks6
287 \noexpand\else \the\toks8
290 % \topmark doesn't work for the very first chapter (after the title
291 % page or the contents), so we use \firstmark there -- this gets us
292 % the mark with the chapter defs, unless the user sneaks in, e.g.,
293 % @setcolor (or @url, or @link, etc.) between @contents and the very
295 \def\gettopheadingmarks{%
297 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
299 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
300 \def\getcolormarks{\ifcase2\topmark\fi}
302 % Avoid "undefined control sequence" errors.
303 \def\lastchapterdefs{}
304 \def\lastsectiondefs{}
305 \def\prevchapterdefs{}
306 \def\prevsectiondefs{}
309 % Main output routine.
311 \output = {\onepageout{\pagecontents\PAGE}}
316 % \onepageout takes a vbox as an argument. Note that \pagecontents
317 % does insertions, but you have to call it yourself.
319 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
321 \ifodd\pageno \advance\hoffset by \bindingoffset
322 \else \advance\hoffset by -\bindingoffset\fi
324 % Do this outside of the \shipout so @code etc. will be expanded in
325 % the headline as they should be, not taken literally (outputting ''code).
326 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
327 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
328 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
329 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
332 % Have to do this stuff outside the \shipout because we want it to
333 % take effect in \write's, yet the group defined by the \vbox ends
334 % before the \shipout runs.
336 \indexdummies % don't expand commands in the output.
337 \normalturnoffactive % \ in index entries must not stay \, e.g., if
338 % the page break happens to be in the middle of an example.
339 % We don't want .vr (or whatever) entries like this:
340 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
341 % "\acronym" won't work when it's read back in;
343 % {\code {{\tt \backslashcurfont }acronym}
345 % Do this early so pdf references go to the beginning of the page.
346 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
348 \ifcropmarks \vbox to \outervsize\bgroup
350 \vskip-\topandbottommargin
352 \line{\ewtop\hfil\ewtop}%
355 \vbox{\moveleft\cornerthick\nstop}%
357 \vbox{\moveright\cornerthick\nstop}%
360 \vskip\topandbottommargin
362 \hfil % center the page within the outer (page) hsize.
363 \ifodd\pageno\hskip\bindingoffset\fi
369 \ifdim\ht\footlinebox > 0pt
370 % Only leave this space if the footline is nonempty.
371 % (We lessened \vsize for it in \oddfootingyyy.)
372 % The \baselineskip=24pt in plain's \makefootline has no effect.
378 \egroup % end of \vbox\bgroup
379 \hfil\egroup % end of (centering) \line\bgroup
380 \vskip\topandbottommargin plus1fill minus1fill
381 \boxmaxdepth = \cornerthick
384 \vbox{\moveleft\cornerthick\nsbot}%
386 \vbox{\moveright\cornerthick\nsbot}%
389 \line{\ewbot\hfil\ewbot}%
391 \egroup % \vbox from first cropmarks clause
393 }% end of \shipout\vbox
394 }% end of group with \indexdummies
396 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
399 \newinsert\margin \dimen\margin=\maxdimen
401 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
403 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
404 % marginal hacks, juha@viisa.uucp (Juha Takala)
405 \ifvoid\margin\else % marginal info is present
406 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
407 \dimen@=\dp#1\relax \unvbox#1\relax
408 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
409 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
412 % Here are the rules for the cropmarks. Note that they are
413 % offset so that the space between them is truly \outerhsize or \outervsize
414 % (P. A. MacKay, 12 November, 1986)
416 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
418 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
419 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
421 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
423 % Parse an argument, then pass it to #1. The argument is the rest of
424 % the input line (except we remove a trailing comment). #1 should be a
425 % macro which expects an ordinary undelimited TeX argument.
427 \def\parsearg{\parseargusing{}}
428 \def\parseargusing#1#2{%
434 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
438 \gdef\parseargline#1^^M{%
439 \endgroup % End of the group started in \parsearg.
440 \argremovecomment #1\comment\ArgTerm%
444 % First remove any @comment, then any @c comment.
445 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
446 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
448 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
450 % \argremovec might leave us with trailing space, e.g.,
451 % @end itemize @c foo
452 % This space token undergoes the same procedure and is eventually removed
453 % by \finishparsearg.
455 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
456 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
457 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
460 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
461 \let\temp\finishparsearg
463 \let\temp\argcheckspaces
465 % Put the space token in:
469 % If a _delimited_ argument is enclosed in braces, they get stripped; so
470 % to get _exactly_ the rest of the line, we had to prevent such situation.
471 % We prepended an \empty token at the very beginning and we expand it now,
472 % just before passing the control to \argtorun.
473 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
474 % either the null string, or it ends with \^^M---thus there is no danger
475 % that a pair of braces would be stripped.
477 % But first, we have to remove the trailing space token.
479 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
481 % \parseargdef\foo{...}
482 % is roughly equivalent to
483 % \def\foo{\parsearg\Xfoo}
486 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
487 % favourite TeX trick. --kasal, 16nov03
490 \expandafter \doparseargdef \csname\string#1\endcsname #1%
492 \def\doparseargdef#1#2{%
497 % Several utility definitions with active space:
502 % Make each space character in the input produce a normal interword
503 % space in the output. Don't allow a line break at this space, as this
504 % is used only in environments like @example, where each line of input
505 % should produce a line of output anyway.
507 \gdef\sepspaces{\obeyspaces\let =\tie}
509 % If an index command is used in an @example environment, any spaces
510 % therein should become regular spaces in the raw index file, not the
511 % expansion of \tie (\leavevmode \penalty \@M \ ).
512 \gdef\unsepspaces{\let =\space}
516 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
518 % Define the framework for environments in texinfo.tex. It's used like this:
523 % It's the responsibility of \envdef to insert \begingroup before the
524 % actual body; @end closes the group after calling \Efoo. \envdef also
525 % defines \thisenv, so the current environment is known; @end checks
526 % whether the environment name matches. The \checkenv macro can also be
527 % used to check whether the current environment is the one expected.
529 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
530 % are not treated as environments; they don't open a group. (The
531 % implementation of @end takes care not to call \endgroup in this
535 % At run-time, environments start with this:
536 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
540 % ... but they get defined via ``\envdef\foo{...}'':
541 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
542 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
544 % Check whether we're in the right environment:
553 % Environment mismatch, #1 expected:
556 \errmessage{This command can appear only \inenvironment\temp,
557 not \inenvironment\thisenv}%
559 \def\inenvironment#1{%
561 outside of any environment%
563 in environment \expandafter\string#1%
567 % @end foo executes the definition of \Efoo.
568 % But first, it executes a specialized version of \checkenv
571 \if 1\csname iscond.#1\endcsname
573 % The general wording of \badenverr may not be ideal.
574 \expandafter\checkenv\csname#1\endcsname
575 \csname E#1\endcsname
580 \newhelp\EMsimple{Press RETURN to continue.}
583 % Be sure we're in horizontal mode when doing a tie, since we make space
584 % equivalent to this in @example-like environments. Otherwise, a space
585 % at the beginning of a line will start with \penalty -- and
586 % since \penalty is valid in vertical mode, we'd end up putting the
587 % penalty on the vertical list instead of in the new paragraph.
589 % Avoid using \@M directly, because that causes trouble
590 % if the definition is written into an index file.
591 \global\let\tiepenalty = \@M
592 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
595 % @: forces normal size whitespace following.
596 \def\:{\spacefactor=1000 }
598 % @* forces a line break.
599 \def\*{\hfil\break\hbox{}\ignorespaces}
601 % @/ allows a line break.
604 % @. is an end-of-sentence period.
605 \def\.{.\spacefactor=\endofsentencespacefactor\space}
607 % @! is an end-of-sentence bang.
608 \def\!{!\spacefactor=\endofsentencespacefactor\space}
610 % @? is an end-of-sentence query.
611 \def\?{?\spacefactor=\endofsentencespacefactor\space}
613 % @frenchspacing on|off says whether to put extra space after punctuation.
618 \parseargdef\frenchspacing{%
620 \ifx\temp\onword \plainfrenchspacing
621 \else\ifx\temp\offword \plainnonfrenchspacing
624 \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
628 % @w prevents a word break. Without the \leavevmode, @w at the
629 % beginning of a paragraph, when TeX is still in vertical mode, would
630 % produce a whole line of output instead of starting the paragraph.
631 \def\w#1{\leavevmode\hbox{#1}}
633 % @group ... @end group forces ... to be all on one page, by enclosing
634 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
635 % to keep its height that of a normal line. According to the rules for
636 % \topskip (p.114 of the TeXbook), the glue inserted is
637 % max (\topskip - \ht (first item), 0). If that height is large,
638 % therefore, no glue is inserted, and the space between the headline and
639 % the text is small, which looks bad.
641 % Another complication is that the group might be very large. This can
642 % cause the glue on the previous page to be unduly stretched, because it
643 % does not have much material. In this case, it's better to add an
644 % explicit \vfill so that the extra space is at the bottom. The
645 % threshold for doing this is if the group is more than \vfilllimit
646 % percent of a page (\vfilllimit can be changed inside of @tex).
652 \ifnum\catcode`\^^M=\active \else
653 \errhelp = \groupinvalidhelp
654 \errmessage{@group invalid in context where filling is enabled}%
658 \setbox\groupbox = \vtop\bgroup
659 % Do @comment since we are called inside an environment such as
660 % @example, where each end-of-line in the input causes an
661 % end-of-line in the output. We don't want the end-of-line after
662 % the `@group' to put extra space in the output. Since @group
663 % should appear on a line by itself (according to the Texinfo
664 % manual), we don't worry about eating any user text.
668 % The \vtop produces a box with normal height and large depth; thus, TeX puts
669 % \baselineskip glue before it, and (when the next line of text is done)
670 % \lineskip glue after it. Thus, space below is not quite equal to space
671 % above. But it's pretty close.
673 % To get correct interline space between the last line of the group
674 % and the first line afterwards, we have to propagate \prevdepth.
675 \endgraf % Not \par, as it may have been set to \lisppar.
676 \global\dimen1 = \prevdepth
677 \egroup % End the \vtop.
678 % \dimen0 is the vertical size of the group's box.
679 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
680 % \dimen2 is how much space is left on the page (more or less).
681 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
682 % if the group doesn't fit on the current page, and it's a big big
683 % group, force a page break.
684 \ifdim \dimen0 > \dimen2
685 \ifdim \pagetotal < \vfilllimit\pageheight
694 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
695 % message, so this ends up printing `@group can only ...'.
697 \newhelp\groupinvalidhelp{%
698 group can only be used in environments such as @example,^^J%
699 where each line of input produces a line of output.}
701 % @need space-in-mils
702 % forces a page break if there is not space-in-mils remaining.
704 \newdimen\mil \mil=0.001in
707 % Ensure vertical mode, so we don't make a big box in the middle of a
711 % If the @need value is less than one line space, it's useless.
713 \dimen2 = \ht\strutbox
714 \advance\dimen2 by \dp\strutbox
715 \ifdim\dimen0 > \dimen2
717 % Do a \strut just to make the height of this box be normal, so the
718 % normal leading is inserted relative to the preceding line.
719 % And a page break here is fine.
720 \vtop to #1\mil{\strut\vfil}%
722 % TeX does not even consider page breaks if a penalty added to the
723 % main vertical list is 10000 or more. But in order to see if the
724 % empty box we just added fits on the page, we must make it consider
725 % page breaks. On the other hand, we don't want to actually break the
726 % page after the empty box. So we use a penalty of 9999.
728 % There is an extremely small chance that TeX will actually break the
729 % page at this \penalty, if there are no other feasible breakpoints in
730 % sight. (If the user is using lots of big @group commands, which
731 % almost-but-not-quite fill up a page, TeX will have a hard time doing
732 % good page breaking, for example.) However, I could not construct an
733 % example where a page broke at this \penalty; if it happens in a real
734 % document, then we can reconsider our strategy.
737 % Back up by the size of the box, whether we did a page break or not.
740 % Do not allow a page break right after this kern.
745 % @br forces paragraph break (and is undocumented).
749 % @page forces the start of a new page.
751 \def\page{\par\vfill\supereject}
754 % outputs text on separate line in roman font, starting at standard page margin
756 % This records the amount of indent in the innermost environment.
757 % That's how much \exdent should take out.
758 \newskip\exdentamount
760 % This defn is used inside fill environments such as @defun.
761 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
763 % This defn is used inside nofill environments such as @example.
764 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
765 \leftline{\hskip\leftskip{\rm#1}}}}
767 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
768 % paragraph. For more general purposes, use the \margin insertion
769 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
771 \newskip\inmarginspacing \inmarginspacing=1cm
772 \def\strutdepth{\dp\strutbox}
774 \def\doinmargin#1#2{\strut\vadjust{%
777 \vtop to \strutdepth{%
778 \baselineskip=\strutdepth
780 % if you have multiple lines of stuff to put here, you'll need to
781 % make the vbox yourself of the appropriate size.
783 \llap{\ignorespaces #2\hskip\inmarginspacing}%
785 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
790 \def\inleftmargin{\doinmargin l}
791 \def\inrightmargin{\doinmargin r}
793 % @inmargin{TEXT [, RIGHT-TEXT]}
794 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
795 % else use TEXT for both).
797 \def\inmargin#1{\parseinmargin #1,,\finish}
798 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
799 \setbox0 = \hbox{\ignorespaces #2}%
801 \def\lefttext{#1}% have both texts
804 \def\lefttext{#1}% have only one text
809 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
811 \def\temp{\inleftmargin\lefttext}%
816 % @| inserts a changebar to the left of the current line. It should
817 % surround any changed text. This approach does *not* work if the
818 % change spans more than two lines of output. To handle that, we would
819 % have adopt a much more difficult approach (putting marks into the main
820 % vertical list for the beginning and end of each change). This command
821 % is not documented, not supported, and doesn't work.
824 % \vadjust can only be used in horizontal mode.
827 % Append this vertical mode material after the current line in the output.
829 % We want to insert a rule with the height and depth of the current
830 % leading; that is exactly what \strutbox is supposed to record.
833 % \vadjust-items are inserted at the left edge of the type. So
834 % the \llap here moves out into the left-hand margin.
837 % For a thicker or thinner bar, change the `1pt'.
838 \vrule height\baselineskip width1pt
840 % This is the space between the bar and the text.
846 % @include FILE -- \input text of FILE.
848 \def\include{\parseargusing\filenamecatcodes\includezzz}
853 \makevalueexpandable % we want to expand any @value in FILE.
854 \turnoffactive % and allow special characters in the expansion
855 \indexnofonts % Allow `@@' and other weird things in file names.
856 \wlog{texinfo.tex: doing @include of #1^^J}%
857 \edef\temp{\noexpand\input #1 }%
859 % This trickery is to read FILE outside of a group, in case it makes
865 \def\filenamecatcodes{%
879 \def\pushthisfilestack{%
880 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
882 \def\pushthisfilestackX{%
883 \expandafter\pushthisfilestackY\thisfile\StackTerm
885 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
886 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
889 \def\popthisfilestack{\errthisfilestackempty}
890 \def\errthisfilestackempty{\errmessage{Internal error:
891 the stack of filenames is empty.}}
896 % outputs that line, centered.
898 \parseargdef\center{%
900 \let\centersub\centerH
902 \let\centersub\centerV
904 \centersub{\hfil \ignorespaces#1\unskip \hfil}%
905 \let\centersub\relax % don't let the definition persist, just in case
909 \advance\hsize by -\leftskip
910 \advance\hsize by -\rightskip
915 \newcount\centerpenalty
917 % The idea here is the same as in \startdefun, \cartouche, etc.: if
918 % @center is the first thing after a section heading, we need to wipe
919 % out the negative parskip inserted by \sectionheading, but still
920 % prevent a page break here.
921 \centerpenalty = \lastpenalty
922 \ifnum\centerpenalty>10000 \vskip\parskip \fi
923 \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi
924 \line{\kern\leftskip #1\kern\rightskip}%
927 % @sp n outputs n lines of vertical space
929 \parseargdef\sp{\vskip #1\baselineskip}
931 % @comment ...line which is ignored...
932 % @c is the same as @comment
933 % @ignore ... @end ignore is another way to write a comment
935 \def\comment{\begingroup \catcode`\^^M=\other%
936 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
938 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
942 % @paragraphindent NCHARS
943 % We'll use ems for NCHARS, close enough.
944 % NCHARS can also be the word `asis' or `none'.
945 % We cannot feasibly implement @paragraphindent asis, though.
947 \def\asisword{asis} % no translation, these are keywords
950 \parseargdef\paragraphindent{%
955 \defaultparindent = 0pt
957 \defaultparindent = #1em
960 \parindent = \defaultparindent
963 % @exampleindent NCHARS
964 % We'll use ems for NCHARS like @paragraphindent.
965 % It seems @exampleindent asis isn't necessary, but
966 % I preserve it to make it similar to @paragraphindent.
967 \parseargdef\exampleindent{%
974 \lispnarrowing = #1em
979 % @firstparagraphindent WORD
980 % If WORD is `none', then suppress indentation of the first paragraph
981 % after a section heading. If WORD is `insert', then do indent at such
984 % The paragraph indentation is suppressed or not by calling
985 % \suppressfirstparagraphindent, which the sectioning commands do.
986 % We switch the definition of this back and forth according to WORD.
987 % By default, we suppress indentation.
989 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
990 \def\insertword{insert}
992 \parseargdef\firstparagraphindent{%
995 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
996 \else\ifx\temp\insertword
997 \let\suppressfirstparagraphindent = \relax
1000 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1004 % Here is how we actually suppress indentation. Redefine \everypar to
1005 % \kern backwards by \parindent, and then reset itself to empty.
1007 % We also make \indent itself not actually do anything until the next
1010 \gdef\dosuppressfirstparagraphindent{%
1012 \restorefirstparagraphindent
1016 \restorefirstparagraphindent
1019 \global\everypar = {%
1021 \restorefirstparagraphindent
1025 \gdef\restorefirstparagraphindent{%
1026 \global \let \indent = \ptexindent
1027 \global \let \noindent = \ptexnoindent
1028 \global \everypar = {}%
1032 % @refill is a no-op.
1035 % If working on a large document in chapters, it is convenient to
1036 % be able to disable indexing, cross-referencing, and contents, for test runs.
1037 % This is done with @novalidate (before @setfilename).
1039 \newif\iflinks \linkstrue % by default we want the aux files.
1040 \let\novalidate = \linksfalse
1042 % @setfilename is done at the beginning of every texinfo file.
1043 % So open here the files we need to have open while reading the input.
1044 % This makes it possible to make a .fmt file for texinfo.
1046 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1049 % Open the new aux file. TeX will close it automatically at exit.
1050 \immediate\openout\auxfile=\jobname.aux
1051 \fi % \openindices needs to do some work in any case.
1053 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1055 % If texinfo.cnf is present on the system, read it.
1056 % Useful for site-wide @afourpaper, etc.
1057 \openin 1 texinfo.cnf
1058 \ifeof 1 \else \input texinfo.cnf \fi
1061 \comment % Ignore the actual filename.
1064 % Called from \setfilename.
1076 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1080 % adobe `portable' document format
1084 \newcount\filenamelength
1093 \newif\ifpdfmakepagedest
1095 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1096 % can be set). So we test for \relax and 0 as well as being undefined.
1097 \ifx\pdfoutput\thisisundefined
1099 \ifx\pdfoutput\relax
1108 % PDF uses PostScript string constants for the names of xref targets,
1109 % for display in the outlines, and in other places. Thus, we have to
1110 % double any backslashes. Otherwise, a name like "\node" will be
1111 % interpreted as a newline (\n), followed by o, d, e. Not good.
1113 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1114 % related messages. The final outcome is that it is up to the TeX user
1115 % to double the backslashes and otherwise make the string valid, so
1116 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1117 % do this reliably, so we use it.
1119 % #1 is a control sequence in which to do the replacements,
1121 \def\txiescapepdf#1{%
1122 \ifx\pdfescapestring\thisisundefined
1123 % No primitive available; should we give a warning or log?
1124 % Many times it won't matter.
1126 % The expandable \pdfescapestring primitive escapes parentheses,
1127 % backslashes, and other special chars.
1128 \xdef#1{\pdfescapestring{#1}}%
1132 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1133 with PDF output, and none of those formats could be found. (.eps cannot
1134 be supported due to the design of the PDF format; use regular TeX (DVI
1139 % Color manipulation macros based on pdfcolor.tex,
1140 % except using rgb instead of cmyk; the latter is said to render as a
1141 % very dark gray on-screen and a very dark halftone in print, instead
1143 \def\rgbDarkRed{0.50 0.09 0.12}
1144 \def\rgbBlack{0 0 0}
1146 % k sets the color for filling (usual text, etc.);
1147 % K sets the color for stroking (thin rules, e.g., normal _'s).
1148 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1150 % Set color, and create a mark which defines \thiscolor accordingly,
1151 % so that \makeheadline knows which color to restore.
1153 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1158 \def\maincolor{\rgbBlack}
1159 \pdfsetcolor{\maincolor}
1160 \edef\thiscolor{\maincolor}
1161 \def\lastcolordefs{}
1165 \line{\pdfsetcolor{\maincolor}\the\footline}%
1173 % Extract \thiscolor definition from the marks.
1175 % Typeset the headline with \maincolor, then restore the color.
1176 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1184 \pdfcatalog{/PageMode /UseOutlines}
1186 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1187 \def\dopdfimage#1#2#3{%
1188 \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1189 \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1191 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1192 % others). Let's try in that order, PDF first since if
1193 % someone has a scalable image, presumably better to use that than a
1195 \let\pdfimgext=\empty
1197 \openin 1 #1.pdf \ifeof 1
1198 \openin 1 #1.PDF \ifeof 1
1199 \openin 1 #1.png \ifeof 1
1200 \openin 1 #1.jpg \ifeof 1
1201 \openin 1 #1.jpeg \ifeof 1
1202 \openin 1 #1.JPG \ifeof 1
1203 \errhelp = \nopdfimagehelp
1204 \errmessage{Could not find image file #1 for pdf}%
1205 \else \gdef\pdfimgext{JPG}%
1207 \else \gdef\pdfimgext{jpeg}%
1209 \else \gdef\pdfimgext{jpg}%
1211 \else \gdef\pdfimgext{png}%
1213 \else \gdef\pdfimgext{PDF}%
1215 \else \gdef\pdfimgext{pdf}%
1220 % without \immediate, ancient pdftex seg faults when the same image is
1221 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1222 \ifnum\pdftexversion < 14
1225 \immediate\pdfximage
1227 \ifdim \wd0 >0pt width \pdfimagewidth \fi
1228 \ifdim \wd2 >0pt height \pdfimageheight \fi
1229 \ifnum\pdftexversion<13
1234 \ifnum\pdftexversion < 14 \else
1235 \pdfrefximage \pdflastximage
1239 % We have to set dummies so commands such as @code, and characters
1240 % such as \, aren't expanded when present in a section title.
1243 \makevalueexpandable
1244 \def\pdfdestname{#1}%
1245 \txiescapepdf\pdfdestname
1246 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1249 % used to mark target names; must be expandable.
1252 % by default, use a color that is dark enough to print on paper as
1253 % nearly black, but still distinguishable for online viewing.
1254 \def\urlcolor{\rgbDarkRed}
1255 \def\linkcolor{\rgbDarkRed}
1256 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1258 % Adding outlines to PDF; macros for calculating structure of outlines
1259 % come from Petr Olsak
1260 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1261 \else \csname#1\endcsname \fi}
1262 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1263 \advance\tempnum by 1
1264 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1266 % #1 is the section text, which is what will be displayed in the
1267 % outline by the pdf viewer. #2 is the pdf expression for the number
1268 % of subentries (or empty, for subsubsections). #3 is the node text,
1269 % which might be empty if this toc entry had no corresponding node.
1270 % #4 is the page number
1272 \def\dopdfoutline#1#2#3#4{%
1273 % Generate a link to the node text if that exists; else, use the
1274 % page number. We could generate a destination for the section
1275 % text in the case where a section has no node, but it doesn't
1276 % seem worth the trouble, since most documents are normally structured.
1277 \edef\pdfoutlinedest{#3}%
1278 \ifx\pdfoutlinedest\empty
1279 \def\pdfoutlinedest{#4}%
1281 \txiescapepdf\pdfoutlinedest
1284 % Also escape PDF chars in the display string.
1285 \edef\pdfoutlinetext{#1}%
1286 \txiescapepdf\pdfoutlinetext
1288 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1291 \def\pdfmakeoutlines{%
1293 % Read toc silently, to get counts of subentries for \pdfoutline.
1294 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1295 \def\numchapentry##1##2##3##4{%
1296 \def\thischapnum{##2}%
1298 \def\thissubsecnum{0}%
1300 \def\numsecentry##1##2##3##4{%
1301 \advancenumber{chap\thischapnum}%
1302 \def\thissecnum{##2}%
1303 \def\thissubsecnum{0}%
1305 \def\numsubsecentry##1##2##3##4{%
1306 \advancenumber{sec\thissecnum}%
1307 \def\thissubsecnum{##2}%
1309 \def\numsubsubsecentry##1##2##3##4{%
1310 \advancenumber{subsec\thissubsecnum}%
1312 \def\thischapnum{0}%
1314 \def\thissubsecnum{0}%
1316 % use \def rather than \let here because we redefine \chapentry et
1317 % al. a second time, below.
1318 \def\appentry{\numchapentry}%
1319 \def\appsecentry{\numsecentry}%
1320 \def\appsubsecentry{\numsubsecentry}%
1321 \def\appsubsubsecentry{\numsubsubsecentry}%
1322 \def\unnchapentry{\numchapentry}%
1323 \def\unnsecentry{\numsecentry}%
1324 \def\unnsubsecentry{\numsubsecentry}%
1325 \def\unnsubsubsecentry{\numsubsubsecentry}%
1328 % Read toc second time, this time actually producing the outlines.
1329 % The `-' means take the \expnumber as the absolute number of
1330 % subentries, which we calculated on our first read of the .toc above.
1332 % We use the node names as the destinations.
1333 \def\numchapentry##1##2##3##4{%
1334 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1335 \def\numsecentry##1##2##3##4{%
1336 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1337 \def\numsubsecentry##1##2##3##4{%
1338 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1339 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1340 \dopdfoutline{##1}{}{##3}{##4}}%
1342 % PDF outlines are displayed using system fonts, instead of
1343 % document fonts. Therefore we cannot use special characters,
1344 % since the encoding is unknown. For example, the eogonek from
1345 % Latin 2 (0xea) gets translated to a | character. Info from
1346 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1348 % TODO this right, we have to translate 8-bit characters to
1349 % their "best" equivalent, based on the @documentencoding. Too
1350 % much work for too little return. Just use the ASCII equivalents
1351 % we use for the index sort strings.
1355 % We can have normal brace characters in the PDF outlines, unlike
1356 % Texinfo index files. So set that up.
1357 \def\{{\lbracecharliteral}%
1358 \def\}{\rbracecharliteral}%
1359 \catcode`\\=\active \otherbackslash
1360 \input \tocreadfilename
1363 {\catcode`[=1 \catcode`]=2
1364 \catcode`{=\other \catcode`}=\other
1365 \gdef\lbracecharliteral[{]%
1366 \gdef\rbracecharliteral[}]%
1369 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1370 \ifx\PP\D\let\nextsp\relax
1371 \else\let\nextsp\skipspaces
1372 \addtokens{\filename}{\PP}%
1373 \advance\filenamelength by 1
1376 \def\getfilename#1{%
1378 % If we don't expand the argument now, \skipspaces will get
1379 % snagged on things like "@value{foo}".
1381 \expandafter\skipspaces\temp|\relax
1383 \ifnum\pdftexversion < 14
1384 \let \startlink \pdfannotlink
1386 \let \startlink \pdfstartlink
1388 % make a live url in pdf output.
1391 % it seems we really need yet another set of dummies; have not
1392 % tried to figure out what each command should do in the context
1393 % of @url. for now, just make @/ a no-op, that's the only one
1394 % people have actually reported a problem with.
1396 \normalturnoffactive
1399 \makevalueexpandable
1400 % do we want to go so far as to use \indexnofonts instead of just
1401 % special-casing \var here?
1404 \leavevmode\setcolor{\urlcolor}%
1405 \startlink attr{/Border [0 0 0]}%
1406 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1408 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1409 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1410 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1411 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1413 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1415 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1416 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1417 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1419 \ifnum0=\countA\else\makelink\fi
1420 \ifx\first.\let\next=\done\else
1422 \addtokens{\toksB}{\the\toksD}
1423 \ifx\first,\addtokens{\toksB}{\space}\fi
1425 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1427 \def\makelink{\addtokens{\toksB}%
1428 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1430 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1431 \setcolor{\linkcolor}#1\endlink}
1432 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1435 \let\pdfmkdest = \gobble
1436 \let\pdfurl = \gobble
1437 \let\endlink = \relax
1438 \let\setcolor = \gobble
1439 \let\pdfsetcolor = \gobble
1440 \let\pdfmakeoutlines = \relax
1441 \fi % \ifx\pdfoutput
1446 % Change the current font style to #1, remembering it in \curfontstyle.
1447 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1448 % italics, not bold italics.
1450 \def\setfontstyle#1{%
1451 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1452 \csname ten#1\endcsname % change the current font
1455 % Select #1 fonts with the current style.
1457 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1459 \def\rm{\fam=0 \setfontstyle{rm}}
1460 \def\it{\fam=\itfam \setfontstyle{it}}
1461 \def\sl{\fam=\slfam \setfontstyle{sl}}
1462 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1463 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1465 % Unfortunately, we have to override this for titles and the like, since
1466 % in those cases "rm" is bold. Sigh.
1467 \def\rmisbold{\rm\def\curfontstyle{bf}}
1469 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1470 % So we set up a \sf.
1472 \def\sf{\fam=\sffam \setfontstyle{sf}}
1473 \let\li = \sf % Sometimes we call it \li, not \sf.
1475 % We don't need math for this font style.
1476 \def\ttsl{\setfontstyle{ttsl}}
1479 % Set the baselineskip to #1, and the lineskip and strut size
1480 % correspondingly. There is no deep meaning behind these magic numbers
1481 % used as factors; they just match (closely enough) what Knuth defined.
1483 \def\lineskipfactor{.08333}
1484 \def\strutheightpercent{.70833}
1485 \def\strutdepthpercent {.29167}
1487 % can get a sort of poor man's double spacing by redefining this.
1488 \def\baselinefactor{1}
1490 \newdimen\textleading
1493 \normalbaselineskip = \baselinefactor\dimen0
1494 \normallineskip = \lineskipfactor\normalbaselineskip
1496 \setbox\strutbox =\hbox{%
1497 \vrule width0pt height\strutheightpercent\baselineskip
1498 depth \strutdepthpercent \baselineskip
1502 % PDF CMaps. See also LaTeX's t1.cmap.
1504 % do nothing with this by default.
1505 \expandafter\let\csname cmapOT1\endcsname\gobble
1506 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1507 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1509 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1510 % (\pdffontattr was introduced many years ago, but people still run
1511 % older pdftex's; it's easy to conditionalize, so we do.)
1512 \ifpdf \ifx\pdffontattr\thisisundefined \else
1514 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1515 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1516 %%DocumentNeededResources: ProcSet (CIDInit)
1517 %%IncludeResource: ProcSet (CIDInit)
1518 %%BeginResource: CMap (TeX-OT1-0)
1519 %%Title: (TeX-OT1-0 TeX OT1 0)
1522 /CIDInit /ProcSet findresource begin
1530 /CMapName /TeX-OT1-0 def
1532 1 begincodespacerange
1588 CMapName currentdict /CMap defineresource pop
1594 \expandafter\edef\csname cmapOT1\endcsname#1{%
1595 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1600 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1601 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1602 %%DocumentNeededResources: ProcSet (CIDInit)
1603 %%IncludeResource: ProcSet (CIDInit)
1604 %%BeginResource: CMap (TeX-OT1IT-0)
1605 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1608 /CIDInit /ProcSet findresource begin
1616 /CMapName /TeX-OT1IT-0 def
1618 1 begincodespacerange
1676 CMapName currentdict /CMap defineresource pop
1682 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1683 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1688 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1689 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1690 %%DocumentNeededResources: ProcSet (CIDInit)
1691 %%IncludeResource: ProcSet (CIDInit)
1692 %%BeginResource: CMap (TeX-OT1TT-0)
1693 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1696 /CIDInit /ProcSet findresource begin
1704 /CMapName /TeX-OT1TT-0 def
1706 1 begincodespacerange
1751 CMapName currentdict /CMap defineresource pop
1757 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1758 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1763 % Set the font macro #1 to the font named \fontprefix#2.
1764 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1765 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
1773 \def\setfont#1#2#3#4#5{%
1774 \font#1=\fontprefix#2#3 scaled #4
1775 \csname cmap#5\endcsname#1%
1777 % This is what gets called when #5 of \setfont is empty.
1782 % Use cm as the default font prefix.
1783 % To specify the font prefix, you must define \fontprefix
1784 % before you read in texinfo.tex.
1785 \ifx\fontprefix\thisisundefined
1788 % Support font families that don't use the same naming scheme as CM.
1790 \def\rmbshape{bx} % where the normal face is bold
1795 \def\ttslshape{sltt}
1805 % Definitions for a main text size of 11pt. (The default in Texinfo.)
1807 \def\definetextfontsizexi{%
1808 % Text fonts (11.2pt, magstep1).
1809 \def\textnominalsize{11pt}
1810 \edef\mainmagstep{\magstephalf}
1811 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1812 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1813 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1814 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1815 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1816 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1817 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1818 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1819 \font\texti=cmmi10 scaled \mainmagstep
1820 \font\textsy=cmsy10 scaled \mainmagstep
1821 \def\textecsize{1095}
1823 % A few fonts for @defun names and args.
1824 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1825 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1826 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1827 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1829 % Fonts for indices, footnotes, small examples (9pt).
1830 \def\smallnominalsize{9pt}
1831 \setfont\smallrm\rmshape{9}{1000}{OT1}
1832 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1833 \setfont\smallbf\bfshape{10}{900}{OT1}
1834 \setfont\smallit\itshape{9}{1000}{OT1IT}
1835 \setfont\smallsl\slshape{9}{1000}{OT1}
1836 \setfont\smallsf\sfshape{9}{1000}{OT1}
1837 \setfont\smallsc\scshape{10}{900}{OT1}
1838 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1841 \def\smallecsize{0900}
1843 % Fonts for small examples (8pt).
1844 \def\smallernominalsize{8pt}
1845 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1846 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1847 \setfont\smallerbf\bfshape{10}{800}{OT1}
1848 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1849 \setfont\smallersl\slshape{8}{1000}{OT1}
1850 \setfont\smallersf\sfshape{8}{1000}{OT1}
1851 \setfont\smallersc\scshape{10}{800}{OT1}
1852 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1853 \font\smalleri=cmmi8
1854 \font\smallersy=cmsy8
1855 \def\smallerecsize{0800}
1857 % Fonts for title page (20.4pt):
1858 \def\titlenominalsize{20pt}
1859 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1860 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1861 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1862 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1863 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1864 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1865 \let\titlebf=\titlerm
1866 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1867 \font\titlei=cmmi12 scaled \magstep3
1868 \font\titlesy=cmsy10 scaled \magstep4
1869 \def\titleecsize{2074}
1871 % Chapter (and unnumbered) fonts (17.28pt).
1872 \def\chapnominalsize{17pt}
1873 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1874 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1875 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1876 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1877 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1878 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1880 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1881 \font\chapi=cmmi12 scaled \magstep2
1882 \font\chapsy=cmsy10 scaled \magstep3
1883 \def\chapecsize{1728}
1885 % Section fonts (14.4pt).
1886 \def\secnominalsize{14pt}
1887 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1888 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1889 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1890 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1891 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1892 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1894 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1895 \font\seci=cmmi12 scaled \magstep1
1896 \font\secsy=cmsy10 scaled \magstep2
1897 \def\sececsize{1440}
1899 % Subsection fonts (13.15pt).
1900 \def\ssecnominalsize{13pt}
1901 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1902 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1903 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1904 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1905 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1906 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1908 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1909 \font\sseci=cmmi12 scaled \magstephalf
1910 \font\ssecsy=cmsy10 scaled 1315
1911 \def\ssececsize{1200}
1913 % Reduced fonts for @acro in text (10pt).
1914 \def\reducednominalsize{10pt}
1915 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1916 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1917 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1918 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1919 \setfont\reducedsl\slshape{10}{1000}{OT1}
1920 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1921 \setfont\reducedsc\scshape{10}{1000}{OT1}
1922 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1923 \font\reducedi=cmmi10
1924 \font\reducedsy=cmsy10
1925 \def\reducedecsize{1000}
1927 \textleading = 13.2pt % line spacing for 11pt CM
1928 \textfonts % reset the current fonts
1930 } % end of 11pt text font size definitions, \definetextfontsizexi
1933 % Definitions to make the main text be 10pt Computer Modern, with
1934 % section, chapter, etc., sizes following suit. This is for the GNU
1935 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1936 % future. Used with @smallbook, which sets the leading to 12pt.
1938 \def\definetextfontsizex{%
1939 % Text fonts (10pt).
1940 \def\textnominalsize{10pt}
1941 \edef\mainmagstep{1000}
1942 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1943 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1944 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1945 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1946 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1947 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1948 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1949 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1950 \font\texti=cmmi10 scaled \mainmagstep
1951 \font\textsy=cmsy10 scaled \mainmagstep
1952 \def\textecsize{1000}
1954 % A few fonts for @defun names and args.
1955 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
1956 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
1957 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
1958 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1960 % Fonts for indices, footnotes, small examples (9pt).
1961 \def\smallnominalsize{9pt}
1962 \setfont\smallrm\rmshape{9}{1000}{OT1}
1963 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1964 \setfont\smallbf\bfshape{10}{900}{OT1}
1965 \setfont\smallit\itshape{9}{1000}{OT1IT}
1966 \setfont\smallsl\slshape{9}{1000}{OT1}
1967 \setfont\smallsf\sfshape{9}{1000}{OT1}
1968 \setfont\smallsc\scshape{10}{900}{OT1}
1969 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1972 \def\smallecsize{0900}
1974 % Fonts for small examples (8pt).
1975 \def\smallernominalsize{8pt}
1976 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1977 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1978 \setfont\smallerbf\bfshape{10}{800}{OT1}
1979 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1980 \setfont\smallersl\slshape{8}{1000}{OT1}
1981 \setfont\smallersf\sfshape{8}{1000}{OT1}
1982 \setfont\smallersc\scshape{10}{800}{OT1}
1983 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1984 \font\smalleri=cmmi8
1985 \font\smallersy=cmsy8
1986 \def\smallerecsize{0800}
1988 % Fonts for title page (20.4pt):
1989 \def\titlenominalsize{20pt}
1990 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1991 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1992 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1993 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1994 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1995 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1996 \let\titlebf=\titlerm
1997 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1998 \font\titlei=cmmi12 scaled \magstep3
1999 \font\titlesy=cmsy10 scaled \magstep4
2000 \def\titleecsize{2074}
2002 % Chapter fonts (14.4pt).
2003 \def\chapnominalsize{14pt}
2004 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2005 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2006 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2007 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2008 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2009 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2011 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2012 \font\chapi=cmmi12 scaled \magstep1
2013 \font\chapsy=cmsy10 scaled \magstep2
2014 \def\chapecsize{1440}
2016 % Section fonts (12pt).
2017 \def\secnominalsize{12pt}
2018 \setfont\secrm\rmbshape{12}{1000}{OT1}
2019 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2020 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2021 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2022 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2023 \setfont\secsf\sfbshape{12}{1000}{OT1}
2025 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2027 \font\secsy=cmsy10 scaled \magstep1
2028 \def\sececsize{1200}
2030 % Subsection fonts (10pt).
2031 \def\ssecnominalsize{10pt}
2032 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2033 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2034 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2035 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2036 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2037 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2039 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2042 \def\ssececsize{1000}
2044 % Reduced fonts for @acro in text (9pt).
2045 \def\reducednominalsize{9pt}
2046 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2047 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2048 \setfont\reducedbf\bfshape{10}{900}{OT1}
2049 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2050 \setfont\reducedsl\slshape{9}{1000}{OT1}
2051 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2052 \setfont\reducedsc\scshape{10}{900}{OT1}
2053 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2054 \font\reducedi=cmmi9
2055 \font\reducedsy=cmsy9
2056 \def\reducedecsize{0900}
2058 \divide\parskip by 2 % reduce space between paragraphs
2059 \textleading = 12pt % line spacing for 10pt CM
2060 \textfonts % reset the current fonts
2062 } % end of 10pt text font size definitions, \definetextfontsizex
2065 % We provide the user-level command
2067 % (or 11) to redefine the text font size. pt is assumed.
2073 \parseargdef\fonttextsize{%
2074 \def\textsizearg{#1}%
2075 %\wlog{doing @fonttextsize \textsizearg}%
2077 % Set \globaldefs so that documents can use this inside @tex, since
2078 % makeinfo 4.8 does not support it, but we need it nonetheless.
2080 \begingroup \globaldefs=1
2081 \ifx\textsizearg\xword \definetextfontsizex
2082 \else \ifx\textsizearg\xiword \definetextfontsizexi
2085 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2091 % In order for the font changes to affect most math symbols and letters,
2092 % we have to define the \textfont of the standard families. Since
2093 % texinfo doesn't allow for producing subscripts and superscripts except
2094 % in the main text, we don't bother to reset \scriptfont and
2095 % \scriptscriptfont (which would also require loading a lot more fonts).
2097 \def\resetmathfonts{%
2098 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2099 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2100 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2103 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2104 % of just \STYLE. We do this because \STYLE needs to also set the
2105 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2106 % \tenSTYLE to set the current font.
2108 % Each font-changing command also sets the names \lsize (one size lower)
2109 % and \lllsize (three sizes lower). These relative commands are used in
2110 % the LaTeX logo and acronyms.
2112 % This all needs generalizing, badly.
2115 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2116 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2117 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2118 \let\tenttsl=\textttsl
2119 \def\curfontsize{text}%
2120 \def\lsize{reduced}\def\lllsize{smaller}%
2121 \resetmathfonts \setleading{\textleading}}
2123 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2124 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2125 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2126 \let\tenttsl=\titlettsl
2127 \def\curfontsize{title}%
2128 \def\lsize{chap}\def\lllsize{subsec}%
2129 \resetmathfonts \setleading{27pt}}
2130 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2132 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2133 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2134 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2135 \let\tenttsl=\chapttsl
2136 \def\curfontsize{chap}%
2137 \def\lsize{sec}\def\lllsize{text}%
2138 \resetmathfonts \setleading{19pt}}
2140 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2141 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2142 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2143 \let\tenttsl=\secttsl
2144 \def\curfontsize{sec}%
2145 \def\lsize{subsec}\def\lllsize{reduced}%
2146 \resetmathfonts \setleading{16pt}}
2148 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2149 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2150 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2151 \let\tenttsl=\ssecttsl
2152 \def\curfontsize{ssec}%
2153 \def\lsize{text}\def\lllsize{small}%
2154 \resetmathfonts \setleading{15pt}}
2155 \let\subsubsecfonts = \subsecfonts
2157 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2158 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2159 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2160 \let\tenttsl=\reducedttsl
2161 \def\curfontsize{reduced}%
2162 \def\lsize{small}\def\lllsize{smaller}%
2163 \resetmathfonts \setleading{10.5pt}}
2165 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2166 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2167 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2168 \let\tenttsl=\smallttsl
2169 \def\curfontsize{small}%
2170 \def\lsize{smaller}\def\lllsize{smaller}%
2171 \resetmathfonts \setleading{10.5pt}}
2173 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2174 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2175 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2176 \let\tenttsl=\smallerttsl
2177 \def\curfontsize{smaller}%
2178 \def\lsize{smaller}\def\lllsize{smaller}%
2179 \resetmathfonts \setleading{9.5pt}}
2181 % Fonts for short table of contents.
2182 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2183 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2184 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2185 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2187 % Define these just so they can be easily changed for other fonts.
2188 \def\angleleft{$\langle$}
2189 \def\angleright{$\rangle$}
2191 % Set the fonts to use with the @small... environments.
2192 \let\smallexamplefonts = \smallfonts
2194 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2195 % can fit this many characters:
2196 % 8.5x11=86 smallbook=72 a4=90 a5=69
2197 % If we use \scriptfonts (8pt), then we can fit this many characters:
2198 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2199 % For me, subjectively, the few extra characters that fit aren't worth
2200 % the additional smallness of 8pt. So I'm making the default 9pt.
2202 % By the way, for comparison, here's what fits with @example (10pt):
2203 % 8.5x11=71 smallbook=60 a4=75 a5=58
2206 % Set up the default fonts, so we can use them for creating boxes.
2208 \definetextfontsizexi
2213 % Check if we are currently using a typewriter font. Since all the
2214 % Computer Modern typewriter fonts have zero interword stretch (and
2215 % shrink), and it is reasonable to expect all typewriter fonts to have
2216 % this property, we can check that font parameter.
2218 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2220 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2221 % define and register \INITMACRO to be called on markup style changes.
2222 % \INITMACRO can check \currentmarkupstyle for the innermost
2223 % style and the set of \ifmarkupSTYLE switches for all styles
2224 % currently in effect.
2228 %\newif\ifmarkupfile % @file == @samp.
2229 %\newif\ifmarkupoption % @option == @samp.
2232 %\newif\ifmarkupenv % @env == @code.
2233 %\newif\ifmarkupcommand % @command == @code.
2234 \newif\ifmarkuptex % @tex (and part of @math, for now).
2235 \newif\ifmarkupexample
2237 \newif\ifmarkupverbatim
2239 \let\currentmarkupstyle\empty
2241 \def\setupmarkupstyle#1{%
2242 \csname markup#1true\endcsname
2243 \def\currentmarkupstyle{#1}%
2247 \let\markupstylesetup\empty
2249 \def\defmarkupstylesetup#1{%
2250 \expandafter\def\expandafter\markupstylesetup
2251 \expandafter{\markupstylesetup #1}%
2255 % Markup style setup for left and right quotes.
2256 \defmarkupstylesetup\markupsetuplq{%
2257 \expandafter\let\expandafter \temp
2258 \csname markupsetuplq\currentmarkupstyle\endcsname
2259 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2262 \defmarkupstylesetup\markupsetuprq{%
2263 \expandafter\let\expandafter \temp
2264 \csname markupsetuprq\currentmarkupstyle\endcsname
2265 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2272 \gdef\markupsetuplqdefault{\let`\lq}
2273 \gdef\markupsetuprqdefault{\let'\rq}
2275 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2276 \gdef\markupsetcodequoteright{\let'\codequoteright}
2278 \gdef\markupsetnoligaturesquoteleft{\let`\noligaturesquoteleft}
2281 \let\markupsetuplqcode \markupsetcodequoteleft
2282 \let\markupsetuprqcode \markupsetcodequoteright
2284 \let\markupsetuplqexample \markupsetcodequoteleft
2285 \let\markupsetuprqexample \markupsetcodequoteright
2287 \let\markupsetuplqsamp \markupsetcodequoteleft
2288 \let\markupsetuprqsamp \markupsetcodequoteright
2290 \let\markupsetuplqverb \markupsetcodequoteleft
2291 \let\markupsetuprqverb \markupsetcodequoteright
2293 \let\markupsetuplqverbatim \markupsetcodequoteleft
2294 \let\markupsetuprqverbatim \markupsetcodequoteright
2296 \let\markupsetuplqkbd \markupsetnoligaturesquoteleft
2298 % Allow an option to not use regular directed right quote/apostrophe
2299 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2300 % The undirected quote is ugly, so don't make it the default, but it
2301 % works for pasting with more pdf viewers (at least evince), the
2302 % lilypond developers report. xpdf does work with the regular 0x27.
2304 \def\codequoteright{%
2305 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2306 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2312 % and a similar option for the left quote char vs. a grave accent.
2313 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2314 % the code environments to do likewise.
2316 \def\codequoteleft{%
2317 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2318 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2319 % [Knuth] pp. 380,381,391
2320 % \relax disables Spanish ligatures ?` and !` of \tt font.
2326 % Commands to set the quote options.
2328 \parseargdef\codequoteundirected{%
2331 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2333 \else\ifx\temp\offword
2334 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2337 \errhelp = \EMsimple
2338 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2342 \parseargdef\codequotebacktick{%
2345 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2347 \else\ifx\temp\offword
2348 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2351 \errhelp = \EMsimple
2352 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2356 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2357 \def\noligaturesquoteleft{\relax\lq}
2359 % Count depth in font-changes, for error checks
2360 \newcount\fontdepth \fontdepth=0
2364 % #1 is the font command (\sl or \it), #2 is the text to slant.
2365 % If we are in a monospaced environment, however, 1) always use \ttsl,
2366 % and 2) do not add an italic correction.
2367 \def\dosmartslant#1#2{%
2369 {{\ttsl #2}\let\next=\relax}%
2370 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2373 \def\smartslanted{\dosmartslant\sl}
2374 \def\smartitalic{\dosmartslant\it}
2376 % Output an italic correction unless \next (presumed to be the following
2377 % character) is such as not to need one.
2378 \def\smartitaliccorrection{%
2387 % like \smartslanted except unconditionally uses \ttsl, and no ic.
2388 % @var is set to this for defun arguments.
2389 \def\ttslanted#1{{\ttsl #1}}
2391 % @cite is like \smartslanted except unconditionally use \sl. We never want
2392 % ttsl for book titles, do we?
2393 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2397 \let\saveaftersmartic = \aftersmartic
2398 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2403 \let\slanted=\smartslanted
2404 \let\dfn=\smartslanted
2405 \let\emph=\smartitalic
2407 % Explicit font changes: @r, @sc, undocumented @ii.
2408 \def\r#1{{\rm #1}} % roman font
2409 \def\sc#1{{\smallcaps#1}} % smallcaps font
2410 \def\ii#1{{\it #1}} % italic font
2412 % @b, explicit bold. Also @strong.
2416 % @sansserif, explicit sans.
2417 \def\sansserif#1{{\sf #1}}
2419 % We can't just use \exhyphenpenalty, because that only has effect at
2420 % the end of a paragraph. Restore normal hyphenation at the end of the
2421 % group within which \nohyphenation is presumably called.
2423 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2424 \def\restorehyphenation{\hyphenchar\font = `- }
2426 % Set sfcode to normal for the chars that usually have another value.
2427 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2428 % sometimes \x has an active definition that messes things up.
2431 \def\plainfrenchspacing{%
2432 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2433 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2434 \def\endofsentencespacefactor{1000}% for @. and friends
2436 \def\plainnonfrenchspacing{%
2437 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2438 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2439 \def\endofsentencespacefactor{3000}% for @. and friends
2442 \def\endofsentencespacefactor{3000}% default
2444 % @t, explicit typewriter.
2446 {\tt \rawbackslash \plainfrenchspacing #1}%
2451 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2453 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2454 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2456 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2457 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2458 % \vbox{\hrule\kern-0.4pt
2459 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2460 % \kern-0.4pt\hrule}%
2461 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2463 % definition of @key with no lozenge. If the current font is already
2464 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2465 % if it isn't monospace, then use \tt.
2467 \def\key#1{{\setupmarkupstyle{key}%
2469 \ifmonospace\else\tt\fi
2472 % ctrl is no longer a Texinfo command.
2473 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2475 % @file, @option are the same as @samp.
2479 % @code is a modification of @t,
2480 % which makes spaces the same size as normal in the surrounding text.
2483 % Change normal interword space to be same as for the current font.
2484 \spaceskip = \fontdimen2\font
2486 % Switch to typewriter.
2489 % But `\ ' produces the large typewriter interword space.
2490 \def\ {{\spaceskip = 0pt{} }}%
2492 % Turn off hyphenation.
2499 \null % reset spacefactor to 1000
2502 % We *must* turn on hyphenation at `-' and `_' in @code.
2503 % Otherwise, it is too hard to avoid overfull hboxes
2504 % in the Emacs manual, the Library manual, etc.
2506 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2507 % both hyphenation at - and hyphenation within words.
2508 % We must therefore turn them both off (\tclose does that)
2509 % and arrange explicitly to hyphenate at a dash.
2512 \catcode`\-=\active \catcode`\_=\active
2513 \catcode`\'=\active \catcode`\`=\active
2514 \global\let'=\rq \global\let`=\lq % default definitions
2516 \global\def\code{\begingroup
2517 \setupmarkupstyle{code}%
2518 % The following should really be moved into \setupmarkupstyle handlers.
2519 \catcode\dashChar=\active \catcode\underChar=\active
2531 \def\codex #1{\tclose{#1}\endgroup}
2534 \def\codedash{-\discretionary{}{}{}}
2536 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2537 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2538 % will therefore expand the active definition of _, which is us
2539 % (inside @code that is), therefore an endless loop.
2541 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2542 \else\normalunderscore \fi
2543 \discretionary{}{}{}}%
2547 % An additional complication: the above will allow breaks after, e.g.,
2548 % each of the four underscores in __typeof__. This is undesirable in
2549 % some manuals, especially if they don't have long identifiers in
2550 % general. @allowcodebreaks provides a way to control this.
2552 \newif\ifallowcodebreaks \allowcodebreakstrue
2554 \def\keywordtrue{true}
2555 \def\keywordfalse{false}
2557 \parseargdef\allowcodebreaks{%
2559 \ifx\txiarg\keywordtrue
2560 \allowcodebreakstrue
2561 \else\ifx\txiarg\keywordfalse
2562 \allowcodebreaksfalse
2564 \errhelp = \EMsimple
2565 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2569 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2570 % second argument specifying the text to display and an optional third
2571 % arg as text to display instead of (rather than in addition to) the url
2572 % itself. First (mandatory) arg is the url.
2573 % (This \urefnobreak definition isn't used now, leaving it for a while
2575 \def\urefnobreak#1{\dourefnobreak #1,,,\finish}
2576 \def\dourefnobreak#1,#2,#3,#4\finish{\begingroup
2579 \setbox0 = \hbox{\ignorespaces #3}%
2581 \unhbox0 % third arg given, show only that
2583 \setbox0 = \hbox{\ignorespaces #2}%
2586 \unhbox0 % PDF: 2nd arg given, show only it
2588 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2591 \code{#1}% only url given, so show it
2597 % This \urefbreak definition is the active one.
2598 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2599 \let\uref=\urefbreak
2600 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
2601 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
2604 \setbox0 = \hbox{\ignorespaces #3}%
2606 \unhbox0 % third arg given, show only that
2608 \setbox0 = \hbox{\ignorespaces #2}%
2611 \unhbox0 % PDF: 2nd arg given, show only it
2613 \unhbox0\ (\urefcode{#1})% DVI: 2nd arg given, show both it and url
2616 \urefcode{#1}% only url given, so show it
2622 % Allow line breaks around only a few characters (only).
2624 \catcode\ampChar=\active \catcode\dotChar=\active
2625 \catcode\hashChar=\active \catcode\questChar=\active
2626 \catcode\slashChar=\active
2631 \global\def\urefcode{\begingroup
2632 \setupmarkupstyle{code}%
2642 % By default, they are just regular characters.
2643 \global\def&{\normalamp}
2644 \global\def.{\normaldot}
2645 \global\def#{\normalhash}
2646 \global\def?{\normalquest}
2647 \global\def/{\normalslash}
2650 % we put a little stretch before and after the breakable chars, to help
2651 % line breaking of long url's. The unequal skips make look better in
2652 % cmtt at least, especially for dots.
2653 \def\urefprestretch{\urefprebreak \hskip0pt plus.13em }
2654 \def\urefpoststretch{\urefpostbreak \hskip0pt plus.1em }
2656 \def\urefcodeamp{\urefprestretch \&\urefpoststretch}
2657 \def\urefcodedot{\urefprestretch .\urefpoststretch}
2658 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
2659 \def\urefcodequest{\urefprestretch ?\urefpoststretch}
2660 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2663 \global\def\urefcodeslashfinish{%
2664 \urefprestretch \slashChar
2665 % Allow line break only after the final / in a sequence of
2666 % slashes, to avoid line break between the slashes in http://.
2667 \ifx\next/\else \urefpoststretch \fi
2671 % One more complication: by default we'll break after the special
2672 % characters, but some people like to break before the special chars, so
2673 % allow that. Also allow no breaking at all, for manual control.
2675 \parseargdef\urefbreakstyle{%
2677 \ifx\txiarg\wordnone
2678 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2679 \else\ifx\txiarg\wordbefore
2680 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2681 \else\ifx\txiarg\wordafter
2682 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2684 \errhelp = \EMsimple
2685 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
2688 \def\wordafter{after}
2689 \def\wordbefore{before}
2692 \urefbreakstyle after
2694 % @url synonym for @uref, since that's how everyone uses it.
2698 % rms does not like angle brackets --karl, 17may97.
2699 % So now @email is just like @uref, unless we are pdf.
2701 %\def\email#1{\angleleft{\tt #1}\angleright}
2703 \def\email#1{\doemail#1,,\finish}
2704 \def\doemail#1,#2,#3\finish{\begingroup
2707 \setbox0 = \hbox{\ignorespaces #2}%
2708 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2715 % @kbd is like @code, except that if the argument is just one @key command,
2716 % then @kbd has no effect.
2717 \def\kbd#1{{\setupmarkupstyle{kbd}\def\look{#1}\expandafter\kbdfoo\look??\par}}
2719 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2720 % `example' (@kbd uses ttsl only inside of @example and friends),
2721 % or `code' (@kbd uses normal tty font always).
2722 \parseargdef\kbdinputstyle{%
2724 \ifx\txiarg\worddistinct
2725 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2726 \else\ifx\txiarg\wordexample
2727 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2728 \else\ifx\txiarg\wordcode
2729 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2731 \errhelp = \EMsimple
2732 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
2735 \def\worddistinct{distinct}
2736 \def\wordexample{example}
2739 % Default is `distinct'.
2740 \kbdinputstyle distinct
2743 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2744 \ifx\one\xkey\ifx\threex\three \key{#2}%
2745 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2746 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi}
2748 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2749 \let\indicateurl=\code
2753 % @clicksequence{File @click{} Open ...}
2754 \def\clicksequence#1{\begingroup #1\endgroup}
2756 % @clickstyle @arrow (by default)
2757 \parseargdef\clickstyle{\def\click{#1}}
2760 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2761 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2763 \def\dmn#1{\thinspace #1}
2765 % @l was never documented to mean ``switch to the Lisp font'',
2766 % and it is not used as such in any manual I can find. We need it for
2767 % Polish suppressed-l. --karl, 22sep96.
2768 %\def\l#1{{\li #1}\null}
2770 % @acronym for "FBI", "NATO", and the like.
2771 % We print this one point size smaller, since it's intended for
2774 \def\acronym#1{\doacronym #1,,\finish}
2775 \def\doacronym#1,#2,#3\finish{%
2776 {\selectfonts\lsize #1}%
2778 \ifx\temp\empty \else
2779 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2781 \null % reset \spacefactor=1000
2784 % @abbr for "Comput. J." and the like.
2785 % No font change, but don't do end-of-sentence spacing.
2787 \def\abbr#1{\doabbr #1,,\finish}
2788 \def\doabbr#1,#2,#3\finish{%
2789 {\plainfrenchspacing #1}%
2791 \ifx\temp\empty \else
2792 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2794 \null % reset \spacefactor=1000
2797 % @asis just yields its argument. Used with @table, for example.
2801 % @math outputs its argument in math mode.
2803 % One complication: _ usually means subscripts, but it could also mean
2804 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2805 % _ active, and distinguish by seeing if the current family is \slfam,
2806 % which is what @var uses.
2808 \catcode`\_ = \active
2809 \gdef\mathunderscore{%
2811 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
2814 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2815 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2816 % particular reason), but this is not advertised and we don't care.
2818 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2819 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
2824 \let\\ = \mathbackslash
2826 % make the texinfo accent commands work in math mode
2838 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
2840 % Some active characters (such as <) are spaced differently in math.
2841 % We have to reset their definitions in case the @math was an argument
2842 % to a command which sets the catcodes (such as @item or @section).
2845 \catcode`^ = \active
2846 \catcode`< = \active
2847 \catcode`> = \active
2848 \catcode`+ = \active
2849 \catcode`' = \active
2855 \let' = \ptexquoteright
2859 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
2860 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
2861 % except specified as a normal braced arg, so no newlines to worry about.
2863 \def\outfmtnametex{tex}
2865 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
2866 \long\def\doinlinefmt#1,#2,\finish{%
2867 \def\inlinefmtname{#1}%
2868 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
2870 % For raw, must switch into @tex before parsing the argument, to avoid
2871 % setting catcodes prematurely. Doing it this way means that, for
2872 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
2873 % ignored. But this isn't important because if people want a literal
2874 % *right* brace they would have to use a command anyway, so they may as
2875 % well use a command to get a left brace too. We could re-use the
2876 % delimiter character idea from \verb, but it seems like overkill.
2878 \long\def\inlineraw{\tex \doinlineraw}
2879 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
2880 \def\doinlinerawtwo#1,#2,\finish{%
2881 \def\inlinerawname{#1}%
2882 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
2883 \endgroup % close group opened by \tex.
2890 % @@ prints an @, as does @atchar{}.
2894 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
2895 % Unless we're in typewriter, use \ecfont because the CM text fonts do
2896 % not have braces, and we don't want to switch into math.
2897 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2898 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2899 \let\{=\mylbrace \let\lbracechar=\{
2900 \let\}=\myrbrace \let\rbracechar=\}
2902 % Definitions to produce \{ and \} commands for indices,
2903 % and @{ and @} for the aux/toc files.
2904 \catcode`\{ = \other \catcode`\} = \other
2905 \catcode`\[ = 1 \catcode`\] = 2
2906 \catcode`\! = 0 \catcode`\\ = \other
2907 !gdef!lbracecmd[\{]%
2908 !gdef!rbracecmd[\}]%
2909 !gdef!lbraceatcmd[@{]%
2910 !gdef!rbraceatcmd[@}]%
2913 % @comma{} to avoid , parsing problems.
2916 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2917 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2919 \let\dotaccent = \ptexdot
2920 \def\ringaccent#1{{\accent23 #1}}
2921 \let\tieaccent = \ptext
2922 \let\ubaraccent = \ptexb
2923 \let\udotaccent = \d
2925 % Other special characters: @questiondown @exclamdown @ordf @ordm
2926 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2927 \def\questiondown{?`}
2929 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
2930 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
2932 % Dotless i and dotless j, used for accents.
2937 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2938 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2939 \else \errmessage{@dotless can be used only with i or j}%
2943 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2944 % period following counts as ending a sentence. (Idea found in latex.)
2946 \edef\TeX{\TeX \spacefactor=1000 }
2948 % @LaTeX{} logo. Not quite the same results as the definition in
2949 % latex.ltx, since we use a different font for the raised A; it's most
2950 % convenient for us to use an explicitly smaller font, rather than using
2951 % the \scriptstyle font (since we don't reset \scriptstyle and
2952 % \scriptscriptstyle).
2957 \vbox to \ht0{\hbox{%
2958 \ifx\textnominalsize\xwordpt
2959 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
2960 % Revert to plain's \scriptsize, which is 7pt.
2961 \count255=\the\fam $\fam\count255 \scriptstyle A$%
2963 % For 11pt, we can use our lllsize.
2964 \selectfonts\lllsize A%
2973 % Some math mode symbols.
2974 \def\bullet{$\ptexbullet$}
2975 \def\geq{\ifmmode \ge\else $\ge$\fi}
2976 \def\leq{\ifmmode \le\else $\le$\fi}
2977 \def\minus{\ifmmode -\else $-$\fi}
2979 % @dots{} outputs an ellipsis using the current font.
2980 % We do .5em per period so that it has the same spacing in the cm
2981 % typewriter fonts as three actual period characters; on the other hand,
2982 % in other typewriter fonts three periods are wider than 1.5em. So do
2983 % whichever is larger.
2987 \setbox0=\hbox{...}% get width of three periods
2994 \hskip 0pt plus.25fil
2995 .\hskip 0pt plus1fil
2996 .\hskip 0pt plus1fil
2997 .\hskip 0pt plus.5fil
3001 % @enddots{} is an end-of-sentence ellipsis.
3005 \spacefactor=\endofsentencespacefactor
3008 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3010 % Since these characters are used in examples, they should be an even number of
3011 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3014 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3015 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3016 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3017 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3018 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3020 % The @error{} command.
3021 % Adapted from the TeXbook's \boxit.
3025 {\tentt \global\dimen0 = 3em}% Width of the box.
3026 \dimen2 = .55pt % Thickness of rules
3027 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3028 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
3030 \setbox\errorbox=\hbox to \dimen0{\hfil
3031 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3032 \advance\hsize by -2\dimen2 % Rules.
3034 \hrule height\dimen2
3035 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3036 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3037 \kern3pt\vrule width\dimen2}% Space to right.
3038 \hrule height\dimen2}
3041 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3043 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3045 \def\pounds{{\it\$}}
3047 % @euro{} comes from a separate font, depending on the current style.
3048 % We use the free feym* fonts from the eurosym package by Henrik
3049 % Theiling, which support regular, slanted, bold and bold slanted (and
3050 % "outlined" (blackboard board, sort of) versions, which we don't need).
3051 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3053 % Although only regular is the truly official Euro symbol, we ignore
3054 % that. The Euro is designed to be slightly taller than the regular
3060 % feybo - bold slanted
3062 % There is no good (free) typewriter version, to my knowledge.
3063 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3066 % Also doesn't work in math. Do we need to do math with euro symbols?
3070 \def\euro{{\eurofont e}}
3072 % We set the font at each command, rather than predefining it in
3073 % \textfonts and the other font-switching commands, so that
3074 % installations which never need the symbol don't have to have the
3077 % There is only one designed size (nominal 10pt), so we always scale
3078 % that to the current nominal size.
3080 % By the way, simply using "at 1em" works for cmr10 and the like, but
3081 % does not work for cmbx10 and other extended/shrunken fonts.
3083 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3085 \ifx\curfontstyle\bfstylename
3087 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3090 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3095 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3096 % sometimes we redefine the original macro, and the alias should reflect
3099 % Use LaTeX names for the Icelandic letters.
3100 \def\DH{{\ecfont \char"D0}} % Eth
3101 \def\dh{{\ecfont \char"F0}} % eth
3102 \def\TH{{\ecfont \char"DE}} % Thorn
3103 \def\th{{\ecfont \char"FE}} % thorn
3105 \def\guillemetleft{{\ecfont \char"13}}
3106 \def\guillemotleft{\guillemetleft}
3107 \def\guillemetright{{\ecfont \char"14}}
3108 \def\guillemotright{\guillemetright}
3109 \def\guilsinglleft{{\ecfont \char"0E}}
3110 \def\guilsinglright{{\ecfont \char"0F}}
3111 \def\quotedblbase{{\ecfont \char"12}}
3112 \def\quotesinglbase{{\ecfont \char"0D}}
3114 % This positioning is not perfect (see the ogonek LaTeX package), but
3115 % we have the precomposed glyphs for the most common cases. We put the
3116 % tests to use those glyphs in the single \ogonek macro so we have fewer
3117 % dummy definitions to worry about for index entries, etc.
3119 % ogonek is also used with other letters in Lithuanian (IOU), but using
3120 % the precomposed glyphs for those is not so easy since they aren't in
3124 \ifx\temp\macrocharA\Aogonek
3125 \else\ifx\temp\macrochara\aogonek
3126 \else\ifx\temp\macrocharE\Eogonek
3127 \else\ifx\temp\macrochare\eogonek
3129 \ecfont \setbox0=\hbox{#1}%
3130 \ifdim\ht0=1ex\accent"0C #1%
3131 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3136 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3137 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3138 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3139 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3141 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
3143 % We can't distinguish serif/sans and italic/slanted, but this
3144 % is used for crude hacks anyway (like adding French and German
3145 % quotes to documents typeset with CM, where we lose kerning), so
3146 % hopefully nobody will notice/care.
3147 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3148 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3149 \ifx\curfontstyle\bfstylename
3151 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
3154 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3159 % @registeredsymbol - R in a circle. The font for the R should really
3160 % be smaller yet, but lllsize is the best we can do for now.
3161 % Adapted from the plain.tex definition of \copyright.
3163 \def\registeredsymbol{%
3164 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
3169 % @textdegree - the normal degrees sign.
3171 \def\textdegree{$^\circ$}
3173 % Laurent Siebenmann reports \Orb undefined with:
3174 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3175 % so we'll define it if necessary.
3177 \ifx\Orb\thisisundefined
3178 \def\Orb{\mathhexbox20D}
3182 \chardef\quotedblleft="5C
3183 \chardef\quotedblright=`\"
3184 \chardef\quoteleft=`\`
3185 \chardef\quoteright=`\'
3188 \message{page headings,}
3190 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3191 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3193 % First the title page. Must do @settitle before @titlepage.
3195 \newif\iffinishedtitlepage
3197 % Do an implicit @contents or @shortcontents after @end titlepage if the
3198 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3200 \newif\ifsetcontentsaftertitlepage
3201 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3202 \newif\ifsetshortcontentsaftertitlepage
3203 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3205 \parseargdef\shorttitlepage{%
3206 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3207 \endgroup\page\hbox{}\page}
3210 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3212 \parindent=0pt \textfonts
3213 % Leave some space at the very top of the page.
3214 \vglue\titlepagetopglue
3215 % No rule at page bottom unless we print one at the top with @title.
3216 \finishedtitlepagetrue
3218 % Most title ``pages'' are actually two pages long, with space
3219 % at the top of the second. We don't want the ragged left on the second.
3220 \let\oldpage = \page
3222 \iffinishedtitlepage\else
3225 \let\page = \oldpage
3232 \iffinishedtitlepage\else
3235 % It is important to do the page break before ending the group,
3236 % because the headline and footline are only empty inside the group.
3237 % If we use the new definition of \page, we always get a blank page
3238 % after the title page, which we certainly don't want.
3242 % Need this before the \...aftertitlepage checks so that if they are
3243 % in effect the toc pages will come out with page numbers.
3246 % If they want short, they certainly want long too.
3247 \ifsetshortcontentsaftertitlepage
3250 \global\let\shortcontents = \relax
3251 \global\let\contents = \relax
3254 \ifsetcontentsaftertitlepage
3256 \global\let\contents = \relax
3257 \global\let\shortcontents = \relax
3261 \def\finishtitlepage{%
3262 \vskip4pt \hrule height 2pt width \hsize
3263 \vskip\titlepagebottomglue
3264 \finishedtitlepagetrue
3267 % Macros to be used within @titlepage:
3269 \let\subtitlerm=\tenrm
3270 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3272 \parseargdef\title{%
3274 \leftline{\titlefonts\rmisbold #1}
3275 % print a rule at the page bottom also.
3276 \finishedtitlepagefalse
3277 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3280 \parseargdef\subtitle{%
3282 {\subtitlefont \rightline{#1}}%
3285 % @author should come last, but may come many times.
3286 % It can also be used inside @quotation.
3288 \parseargdef\author{%
3289 \def\temp{\quotation}%
3291 \def\quotationauthor{#1}% printed in \Equotation.
3294 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3295 {\secfonts\rmisbold \leftline{#1}}%
3300 % Set up page headings and footings.
3302 \let\thispage=\folio
3304 \newtoks\evenheadline % headline on even pages
3305 \newtoks\oddheadline % headline on odd pages
3306 \newtoks\evenfootline % footline on even pages
3307 \newtoks\oddfootline % footline on odd pages
3309 % Now make TeX use those variables
3310 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3311 \else \the\evenheadline \fi}}
3312 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3313 \else \the\evenfootline \fi}\HEADINGShook}
3314 \let\HEADINGShook=\relax
3316 % Commands to set those variables.
3317 % For example, this is what @headings on does
3318 % @evenheading @thistitle|@thispage|@thischapter
3319 % @oddheading @thischapter|@thispage|@thistitle
3320 % @evenfooting @thisfile||
3321 % @oddfooting ||@thisfile
3324 \def\evenheading{\parsearg\evenheadingxxx}
3325 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3326 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3327 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3329 \def\oddheading{\parsearg\oddheadingxxx}
3330 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3331 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3332 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3334 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3336 \def\evenfooting{\parsearg\evenfootingxxx}
3337 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3338 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3339 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3341 \def\oddfooting{\parsearg\oddfootingxxx}
3342 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3343 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3344 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3346 % Leave some space for the footline. Hopefully ok to assume
3347 % @evenfooting will not be used by itself.
3348 \global\advance\pageheight by -12pt
3349 \global\advance\vsize by -12pt
3352 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3354 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3355 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3357 % The same set of arguments for:
3362 % @everyheadingmarks
3363 % @everyfootingmarks
3365 \def\evenheadingmarks{\headingmarks{even}{heading}}
3366 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3367 \def\evenfootingmarks{\headingmarks{even}{footing}}
3368 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3369 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3370 \headingmarks{odd}{heading}{#1} }
3371 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3372 \headingmarks{odd}{footing}{#1} }
3373 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3374 \def\headingmarks#1#2#3 {%
3375 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3376 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3379 \everyheadingmarks bottom
3380 \everyfootingmarks bottom
3382 % @headings double turns headings on for double-sided printing.
3383 % @headings single turns headings on for single-sided printing.
3384 % @headings off turns them off.
3385 % @headings on same as @headings double, retained for compatibility.
3386 % @headings after turns on double-sided headings after this page.
3387 % @headings doubleafter turns on double-sided headings after this page.
3388 % @headings singleafter turns on single-sided headings after this page.
3389 % By default, they are off at the start of a document,
3390 % and turned `on' after @end titlepage.
3392 \def\headings #1 {\csname HEADINGS#1\endcsname}
3394 \def\headingsoff{% non-global headings elimination
3395 \evenheadline={\hfil}\evenfootline={\hfil}%
3396 \oddheadline={\hfil}\oddfootline={\hfil}%
3399 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3400 \HEADINGSoff % it's the default
3402 % When we turn headings on, set the page number to 1.
3403 % For double-sided printing, put current file name in lower left corner,
3404 % chapter name on inside top of right hand pages, document
3405 % title on inside top of left hand pages, and page numbers on outside top
3406 % edge of all pages.
3407 \def\HEADINGSdouble{%
3409 \global\evenfootline={\hfil}
3410 \global\oddfootline={\hfil}
3411 \global\evenheadline={\line{\folio\hfil\thistitle}}
3412 \global\oddheadline={\line{\thischapter\hfil\folio}}
3413 \global\let\contentsalignmacro = \chapoddpage
3415 \let\contentsalignmacro = \chappager
3417 % For single-sided printing, chapter title goes across top left of page,
3418 % page number on top right.
3419 \def\HEADINGSsingle{%
3421 \global\evenfootline={\hfil}
3422 \global\oddfootline={\hfil}
3423 \global\evenheadline={\line{\thischapter\hfil\folio}}
3424 \global\oddheadline={\line{\thischapter\hfil\folio}}
3425 \global\let\contentsalignmacro = \chappager
3427 \def\HEADINGSon{\HEADINGSdouble}
3429 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3430 \let\HEADINGSdoubleafter=\HEADINGSafter
3431 \def\HEADINGSdoublex{%
3432 \global\evenfootline={\hfil}
3433 \global\oddfootline={\hfil}
3434 \global\evenheadline={\line{\folio\hfil\thistitle}}
3435 \global\oddheadline={\line{\thischapter\hfil\folio}}
3436 \global\let\contentsalignmacro = \chapoddpage
3439 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3440 \def\HEADINGSsinglex{%
3441 \global\evenfootline={\hfil}
3442 \global\oddfootline={\hfil}
3443 \global\evenheadline={\line{\thischapter\hfil\folio}}
3444 \global\oddheadline={\line{\thischapter\hfil\folio}}
3445 \global\let\contentsalignmacro = \chappager
3448 % Subroutines used in generating headings
3449 % This produces Day Month Year style of output.
3450 % Only define if not already defined, in case a txi-??.tex file has set
3451 % up a different format (e.g., txi-cs.tex does this).
3452 \ifx\today\thisisundefined
3456 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3457 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3458 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3463 % @settitle line... specifies the title of the document, for headings.
3464 % It generates no output of its own.
3465 \def\thistitle{\putwordNoTitle}
3466 \def\settitle{\parsearg{\gdef\thistitle}}
3470 % Tables -- @table, @ftable, @vtable, @item(x).
3472 % default indentation of table text
3473 \newdimen\tableindent \tableindent=.8in
3474 % default indentation of @itemize and @enumerate text
3475 \newdimen\itemindent \itemindent=.3in
3476 % margin between end of table item and start of table text.
3477 \newdimen\itemmargin \itemmargin=.1in
3479 % used internally for \itemindent minus \itemmargin
3482 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3484 % They also define \itemindex
3485 % to index the item name in whatever manner is desired (perhaps none).
3487 \newif\ifitemxneedsnegativevskip
3489 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3491 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3492 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3494 \def\itemzzz #1{\begingroup %
3495 \advance\hsize by -\rightskip
3496 \advance\hsize by -\tableindent
3497 \setbox0=\hbox{\itemindicate{#1}}%
3499 \nobreak % This prevents a break before @itemx.
3501 % If the item text does not fit in the space we have, put it on a line
3502 % by itself, and do not allow a page break either before or after that
3503 % line. We do not start a paragraph here because then if the next
3504 % command is, e.g., @kindex, the whatsit would get put into the
3505 % horizontal list on a line by itself, resulting in extra blank space.
3506 \ifdim \wd0>\itemmax
3508 % Make this a paragraph so we get the \parskip glue and wrapping,
3509 % but leave it ragged-right.
3511 \advance\leftskip by-\tableindent
3512 \advance\hsize by\tableindent
3513 \advance\rightskip by0pt plus1fil\relax
3514 \leavevmode\unhbox0\par
3517 % We're going to be starting a paragraph, but we don't want the
3518 % \parskip glue -- logically it's part of the @item we just started.
3519 \nobreak \vskip-\parskip
3521 % Stop a page break at the \parskip glue coming up. However, if
3522 % what follows is an environment such as @example, there will be no
3523 % \parskip glue; then the negative vskip we just inserted would
3524 % cause the example and the item to crash together. So we use this
3525 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3526 % \parskip glue after all. Section titles are handled this way also.
3530 \itemxneedsnegativevskipfalse
3532 % The item text fits into the space. Start a paragraph, so that the
3533 % following text (if any) will end up on the same line.
3535 % Do this with kerns and \unhbox so that if there is a footnote in
3536 % the item text, it can migrate to the main vertical list and
3537 % eventually be printed.
3538 \nobreak\kern-\tableindent
3539 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3541 \nobreak\kern\dimen0
3543 \itemxneedsnegativevskiptrue
3547 \def\item{\errmessage{@item while not in a list environment}}
3548 \def\itemx{\errmessage{@itemx while not in a list environment}}
3550 % @table, @ftable, @vtable.
3552 \let\itemindex\gobble
3556 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3557 \tablecheck{ftable}%
3560 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3561 \tablecheck{vtable}%
3564 \ifnum \the\catcode`\^^M=\active
3566 \errmessage{This command won't work in this context; perhaps the problem is
3567 that we are \inenvironment\thisenv}%
3568 \def\next{\doignore{#1}}%
3575 \def\itemindicate{#1}%
3580 \makevalueexpandable
3581 \edef\temp{\noexpand\tablez #1\space\space\space}%
3585 \def\tablez #1 #2 #3 #4\endtablez{%
3587 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3588 \ifnum 0#2>0 \tableindent=#2\mil \fi
3589 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3590 \itemmax=\tableindent
3591 \advance \itemmax by -\itemmargin
3592 \advance \leftskip by \tableindent
3593 \exdentamount=\tableindent
3595 \parskip = \smallskipamount
3596 \ifdim \parskip=0pt \parskip=2pt \fi
3597 \let\item = \internalBitem
3598 \let\itemx = \internalBitemx
3600 \def\Etable{\endgraf\afterenvbreak}
3603 \let\Eitemize\Etable
3604 \let\Eenumerate\Etable
3606 % This is the counter used by @enumerate, which is really @itemize
3610 \envdef\itemize{\parsearg\doitemize}
3614 \itemmax=\itemindent
3615 \advance\itemmax by -\itemmargin
3616 \advance\leftskip by \itemindent
3617 \exdentamount=\itemindent
3619 \parskip=\smallskipamount
3620 \ifdim\parskip=0pt \parskip=2pt \fi
3622 % Try typesetting the item mark that if the document erroneously says
3623 % something like @itemize @samp (intending @table), there's an error
3624 % right away at the @itemize. It's not the best error message in the
3625 % world, but it's better than leaving it to the @item. This means if
3626 % the user wants an empty mark, they have to say @w{} not just @w.
3627 \def\itemcontents{#1}%
3628 \setbox0 = \hbox{\itemcontents}%
3630 % @itemize with no arg is equivalent to @itemize @bullet.
3631 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3633 \let\item=\itemizeitem
3636 % Definition of @item while inside @itemize and @enumerate.
3639 \advance\itemno by 1 % for enumerations
3640 {\let\par=\endgraf \smallbreak}% reasonable place to break
3642 % If the document has an @itemize directly after a section title, a
3643 % \nobreak will be last on the list, and \sectionheading will have
3644 % done a \vskip-\parskip. In that case, we don't want to zero
3645 % parskip, or the item text will crash with the heading. On the
3646 % other hand, when there is normal text preceding the item (as there
3647 % usually is), we do want to zero parskip, or there would be too much
3648 % space. In that case, we won't have a \nobreak before. At least
3649 % that's the theory.
3650 \ifnum\lastpenalty<10000 \parskip=0in \fi
3652 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3654 \vadjust{\penalty 1200}}% not good to break after first line of item.
3658 % \splitoff TOKENS\endmark defines \first to be the first token in
3659 % TOKENS, and \rest to be the remainder.
3661 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3663 % Allow an optional argument of an uppercase letter, lowercase letter,
3664 % or number, to specify the first label in the enumerated list. No
3665 % argument is the same as `1'.
3667 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3668 \def\enumeratey #1 #2\endenumeratey{%
3669 % If we were given no argument, pretend we were given `1'.
3671 \ifx\thearg\empty \def\thearg{1}\fi
3673 % Detect if the argument is a single token. If so, it might be a
3674 % letter. Otherwise, the only valid thing it can be is a number.
3675 % (We will always have one token, because of the test we just made.
3676 % This is a good thing, since \splitoff doesn't work given nothing at
3677 % all -- the first parameter is undelimited.)
3678 \expandafter\splitoff\thearg\endmark
3680 % Only one token in the argument. It could still be anything.
3681 % A ``lowercase letter'' is one whose \lccode is nonzero.
3682 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3683 % not equal to itself.
3684 % Otherwise, we assume it's a number.
3686 % We need the \relax at the end of the \ifnum lines to stop TeX from
3687 % continuing to look for a <number>.
3689 \ifnum\lccode\expandafter`\thearg=0\relax
3690 \numericenumerate % a number (we hope)
3693 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3694 \lowercaseenumerate % lowercase letter
3696 \uppercaseenumerate % uppercase letter
3700 % Multiple tokens in the argument. We hope it's a number.
3705 % An @enumerate whose labels are integers. The starting integer is
3708 \def\numericenumerate{%
3710 \startenumeration{\the\itemno}%
3713 % The starting (lowercase) letter is in \thearg.
3714 \def\lowercaseenumerate{%
3715 \itemno = \expandafter`\thearg
3717 % Be sure we're not beyond the end of the alphabet.
3719 \errmessage{No more lowercase letters in @enumerate; get a bigger
3726 % The starting (uppercase) letter is in \thearg.
3727 \def\uppercaseenumerate{%
3728 \itemno = \expandafter`\thearg
3730 % Be sure we're not beyond the end of the alphabet.
3732 \errmessage{No more uppercase letters in @enumerate; get a bigger
3739 % Call \doitemize, adding a period to the first argument and supplying the
3740 % common last two arguments. Also subtract one from the initial value in
3741 % \itemno, since @item increments \itemno.
3743 \def\startenumeration#1{%
3744 \advance\itemno by -1
3745 \doitemize{#1.}\flushcr
3748 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3751 \def\alphaenumerate{\enumerate{a}}
3752 \def\capsenumerate{\enumerate{A}}
3753 \def\Ealphaenumerate{\Eenumerate}
3754 \def\Ecapsenumerate{\Eenumerate}
3757 % @multitable macros
3758 % Amy Hendrickson, 8/18/94, 3/6/96
3760 % @multitable ... @end multitable will make as many columns as desired.
3761 % Contents of each column will wrap at width given in preamble. Width
3762 % can be specified either with sample text given in a template line,
3763 % or in percent of \hsize, the current width of text on page.
3765 % Table can continue over pages but will only break between lines.
3769 % Either define widths of columns in terms of percent of \hsize:
3770 % @multitable @columnfractions .25 .3 .45
3773 % Numbers following @columnfractions are the percent of the total
3774 % current hsize to be used for each column. You may use as many
3775 % columns as desired.
3778 % Or use a template:
3779 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3781 % using the widest term desired in each column.
3783 % Each new table line starts with @item, each subsequent new column
3784 % starts with @tab. Empty columns may be produced by supplying @tab's
3785 % with nothing between them for as many times as empty columns are needed,
3786 % ie, @tab@tab@tab will produce two empty columns.
3788 % @item, @tab do not need to be on their own lines, but it will not hurt
3791 % Sample multitable:
3793 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3794 % @item first col stuff @tab second col stuff @tab third col
3801 % @item first col stuff @tab second col stuff
3802 % @tab Many paragraphs of text may be used in any column.
3804 % They will wrap at the width determined by the template.
3805 % @item@tab@tab This will be in third column.
3808 % Default dimensions may be reset by user.
3809 % @multitableparskip is vertical space between paragraphs in table.
3810 % @multitableparindent is paragraph indent in table.
3811 % @multitablecolmargin is horizontal space to be left between columns.
3812 % @multitablelinespace is space to leave between table items, baseline
3814 % 0pt means it depends on current normal line spacing.
3816 \newskip\multitableparskip
3817 \newskip\multitableparindent
3818 \newdimen\multitablecolspace
3819 \newskip\multitablelinespace
3820 \multitableparskip=0pt
3821 \multitableparindent=6pt
3822 \multitablecolspace=12pt
3823 \multitablelinespace=0pt
3825 % Macros used to set up halign preamble:
3827 \let\endsetuptable\relax
3828 \def\xendsetuptable{\endsetuptable}
3829 \let\columnfractions\relax
3830 \def\xcolumnfractions{\columnfractions}
3833 % #1 is the @columnfraction, usually a decimal number like .5, but might
3834 % be just 1. We just use it, whatever it is.
3836 \def\pickupwholefraction#1 {%
3837 \global\advance\colcount by 1
3838 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3845 \ifx\firstarg\xendsetuptable
3848 \ifx\firstarg\xcolumnfractions
3849 \global\setpercenttrue
3852 \let\go\pickupwholefraction
3854 \global\advance\colcount by 1
3855 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3856 % separator; typically that is always in the input, anyway.
3857 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3860 \ifx\go\pickupwholefraction
3861 % Put the argument back for the \pickupwholefraction call, so
3862 % we'll always have a period there to be parsed.
3863 \def\go{\pickupwholefraction#1}%
3865 \let\go = \setuptable
3871 % multitable-only commands.
3873 % @headitem starts a heading row, which we typeset in bold.
3874 % Assignments have to be global since we are inside the implicit group
3875 % of an alignment entry. \everycr resets \everytab so we don't have to
3876 % undo it ourselves.
3877 \def\headitemfont{\b}% for people to use in the template row; not changeable
3879 \checkenv\multitable
3881 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3882 \the\everytab % for the first item
3885 % A \tab used to include \hskip1sp. But then the space in a template
3886 % line is not enough. That is bad. So let's go back to just `&' until
3887 % we again encounter the problem the 1sp was intended to solve.
3888 % --karl, nathan@acm.org, 20apr99.
3889 \def\tab{\checkenv\multitable &\the\everytab}%
3891 % @multitable ... @end multitable definitions:
3893 \newtoks\everytab % insert after every tab.
3895 \envdef\multitable{%
3899 % @item within a multitable starts a normal row.
3900 % We use \def instead of \let so that if one of the multitable entries
3901 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3902 % \endtemplate) expanding \doitemize.
3907 \setmultitablespacing
3908 \parskip=\multitableparskip
3909 \parindent=\multitableparindent
3915 \global\everytab={}%
3916 \global\colcount=0 % Reset the column counter.
3917 % Check for saved footnotes, etc.
3919 % Keeps underfull box messages off when table breaks over pages.
3921 % Maybe so, but it also creates really weird page breaks when the
3922 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3923 % problem manifests itself, so it can be fixed for real --karl.
3927 \parsearg\domultitable
3929 \def\domultitable#1{%
3930 % To parse everything between @multitable and @item:
3931 \setuptable#1 \endsetuptable
3933 % This preamble sets up a generic column definition, which will
3934 % be used as many times as user calls for columns.
3935 % \vtop will set a single line and will also let text wrap and
3936 % continue for many paragraphs if desired.
3938 \global\advance\colcount by 1
3941 % Use the current \colcount to find the correct column width:
3942 \hsize=\expandafter\csname col\the\colcount\endcsname
3944 % In order to keep entries from bumping into each other
3945 % we will add a \leftskip of \multitablecolspace to all columns after
3948 % If a template has been used, we will add \multitablecolspace
3949 % to the width of each template entry.
3951 % If the user has set preamble in terms of percent of \hsize we will
3952 % use that dimension as the width of the column, and the \leftskip
3953 % will keep entries from bumping into each other. Table will start at
3954 % left margin and final column will justify at right margin.
3956 % Make sure we don't inherit \rightskip from the outer environment.
3959 % The first column will be indented with the surrounding text.
3960 \advance\hsize by\leftskip
3963 % If user has not set preamble in terms of percent of \hsize
3964 % we will advance \hsize by \multitablecolspace.
3965 \advance\hsize by \multitablecolspace
3967 % In either case we will make \leftskip=\multitablecolspace:
3968 \leftskip=\multitablecolspace
3970 % Ignoring space at the beginning and end avoids an occasional spurious
3971 % blank line, when TeX decides to break the line at the space before the
3972 % box from the multistrut, so the strut ends up on a line by itself.
3974 % @multitable @columnfractions .11 .89
3976 % @tab Legal holiday which is valid in major parts of the whole country.
3977 % Is automatically provided with highlighting sequences respectively
3978 % marking characters.
3979 \noindent\ignorespaces##\unskip\multistrut
3984 \egroup % end the \halign
3985 \global\setpercentfalse
3988 \def\setmultitablespacing{%
3989 \def\multistrut{\strut}% just use the standard line spacing
3991 % Compute \multitablelinespace (if not defined by user) for use in
3992 % \multitableparskip calculation. We used define \multistrut based on
3993 % this, but (ironically) that caused the spacing to be off.
3994 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3995 \ifdim\multitablelinespace=0pt
3996 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3997 \global\advance\multitablelinespace by-\ht0
3999 % Test to see if parskip is larger than space between lines of
4000 % table. If not, do nothing.
4001 % If so, set to same dimension as multitablelinespace.
4002 \ifdim\multitableparskip>\multitablelinespace
4003 \global\multitableparskip=\multitablelinespace
4004 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4005 % than skip between lines in the table.
4007 \ifdim\multitableparskip=0pt
4008 \global\multitableparskip=\multitablelinespace
4009 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4010 % than skip between lines in the table.
4014 \message{conditionals,}
4016 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4017 % @ifnotxml always succeed. They currently do nothing; we don't
4018 % attempt to check whether the conditionals are properly nested. But we
4019 % have to remember that they are conditionals, so that @end doesn't
4020 % attempt to close an environment group.
4023 \expandafter\let\csname #1\endcsname = \relax
4024 \expandafter\let\csname iscond.#1\endcsname = 1
4027 \makecond{ifnotdocbook}
4028 \makecond{ifnothtml}
4029 \makecond{ifnotinfo}
4030 \makecond{ifnotplaintext}
4033 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4035 \def\direntry{\doignore{direntry}}
4036 \def\documentdescription{\doignore{documentdescription}}
4037 \def\docbook{\doignore{docbook}}
4038 \def\html{\doignore{html}}
4039 \def\ifdocbook{\doignore{ifdocbook}}
4040 \def\ifhtml{\doignore{ifhtml}}
4041 \def\ifinfo{\doignore{ifinfo}}
4042 \def\ifnottex{\doignore{ifnottex}}
4043 \def\ifplaintext{\doignore{ifplaintext}}
4044 \def\ifxml{\doignore{ifxml}}
4045 \def\ignore{\doignore{ignore}}
4046 \def\menu{\doignore{menu}}
4047 \def\xml{\doignore{xml}}
4049 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4051 % A count to remember the depth of nesting.
4052 \newcount\doignorecount
4054 \def\doignore#1{\begingroup
4055 % Scan in ``verbatim'' mode:
4057 \catcode`\@ = \other
4058 \catcode`\{ = \other
4059 \catcode`\} = \other
4061 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4064 % Count number of #1's that we've seen.
4067 % Swallow text until we reach the matching `@end #1'.
4071 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4074 \gdef\dodoignore#1{%
4075 % #1 contains the command name as a string, e.g., `ifinfo'.
4077 % Define a command to find the next `@end #1'.
4078 \long\def\doignoretext##1^^M@end #1{%
4079 \doignoretextyyy##1^^M@#1\_STOP_}%
4081 % And this command to find another #1 command, at the beginning of a
4082 % line. (Otherwise, we would consider a line `@c @ifset', for
4083 % example, to count as an @ifset for nesting.)
4084 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4086 % And now expand that command.
4091 \def\doignoreyyy#1{%
4093 \ifx\temp\empty % Nothing found.
4094 \let\next\doignoretextzzz
4095 \else % Found a nested condition, ...
4096 \advance\doignorecount by 1
4097 \let\next\doignoretextyyy % ..., look for another.
4098 % If we're here, #1 ends with ^^M\ifinfo (for example).
4100 \next #1% the token \_STOP_ is present just after this macro.
4103 % We have to swallow the remaining "\_STOP_".
4105 \def\doignoretextzzz#1{%
4106 \ifnum\doignorecount = 0 % We have just found the outermost @end.
4107 \let\next\enddoignore
4108 \else % Still inside a nested condition.
4109 \advance\doignorecount by -1
4110 \let\next\doignoretext % Look for the next @end.
4115 % Finish off ignored text.
4117 % Ignore anything after the last `@end #1'; this matters in verbatim
4118 % environments, where otherwise the newline after an ignored conditional
4119 % would result in a blank line in the output.
4120 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4124 % @set VAR sets the variable VAR to an empty value.
4125 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4127 % Since we want to separate VAR from REST-OF-LINE (which might be
4128 % empty), we can't just use \parsearg; we have to insert a space of our
4129 % own to delimit the rest of the line, and then take it out again if we
4131 % We rely on the fact that \parsearg sets \catcode`\ =10.
4133 \parseargdef\set{\setyyy#1 \endsetyyy}
4134 \def\setyyy#1 #2\endsetyyy{%
4136 \makevalueexpandable
4138 \edef\next{\gdef\makecsname{SET#1}}%
4146 % Remove the trailing space \setxxx inserted.
4147 \def\setzzz#1 \endsetzzz{\next{#1}}
4149 % @clear VAR clears (i.e., unsets) the variable VAR.
4151 \parseargdef\clear{%
4153 \makevalueexpandable
4154 \global\expandafter\let\csname SET#1\endcsname=\relax
4158 % @value{foo} gets the text saved in variable foo.
4159 \def\value{\begingroup\makevalueexpandable\valuexxx}
4160 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4162 \catcode`\- = \active \catcode`\_ = \active
4164 \gdef\makevalueexpandable{%
4165 \let\value = \expandablevalue
4166 % We don't want these characters active, ...
4167 \catcode`\-=\other \catcode`\_=\other
4168 % ..., but we might end up with active ones in the argument if
4169 % we're called from @code, as @code{@value{foo-bar_}}, though.
4170 % So \let them to their normal equivalents.
4171 \let-\realdash \let_\normalunderscore
4175 % We have this subroutine so that we can handle at least some @value's
4176 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4177 % The command has to be fully expandable (if the variable is set), since
4178 % the result winds up in the index file. This means that if the
4179 % variable's value contains other Texinfo commands, it's almost certain
4180 % it will fail (although perhaps we could fix that with sufficient work
4181 % to do a one-level expansion on the result, instead of complete).
4183 \def\expandablevalue#1{%
4184 \expandafter\ifx\csname SET#1\endcsname\relax
4185 {[No value for ``#1'']}%
4186 \message{Variable `#1', used in @value, is not set.}%
4188 \csname SET#1\endcsname
4192 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4195 % To get special treatment of `@end ifset,' call \makeond and the redefine.
4198 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4201 \makevalueexpandable
4203 \expandafter\ifx\csname SET#2\endcsname\relax
4204 #1% If not set, redefine \next.
4209 \def\ifsetfail{\doignore{ifset}}
4211 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4212 % defined with @set, or has been undefined with @clear.
4214 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4215 % above code: if the variable is not set, do nothing, if it is set,
4216 % then redefine \next to \ifclearfail.
4219 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4220 \def\ifclearfail{\doignore{ifclear}}
4222 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4223 % without the @) is in fact defined. We can only feasibly check at the
4224 % TeX level, so something like `mathcode' is going to considered
4225 % defined even though it is not a Texinfo command.
4227 \makecond{ifcommanddefined}
4228 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
4230 \def\doifcmddefined#1#2{{%
4231 \makevalueexpandable
4233 \expandafter\ifx\csname #2\endcsname\relax
4234 #1% If not defined, \let\next as above.
4239 \def\ifcmddefinedfail{\doignore{ifcommanddefined}}
4241 % @ifcommandnotdefined CMD ... handlded similar to @ifclear above.
4242 \makecond{ifcommandnotdefined}
4243 \def\ifcommandnotdefined{%
4244 \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
4245 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
4247 % Set the `txicommandconditionals' variable, so documents have a way to
4248 % test if the @ifcommand...defined conditionals are available.
4249 \set txicommandconditionals
4251 % @dircategory CATEGORY -- specify a category of the dir file
4252 % which this file should belong to. Ignore this in TeX.
4253 \let\dircategory=\comment
4255 % @defininfoenclose.
4256 \let\definfoenclose=\comment
4260 % Index generation facilities
4262 % Define \newwrite to be identical to plain tex's \newwrite
4263 % except not \outer, so it can be used within macros and \if's.
4264 \edef\newwrite{\makecsname{ptexnewwrite}}
4266 % \newindex {foo} defines an index named foo.
4267 % It automatically defines \fooindex such that
4268 % \fooindex ...rest of line... puts an entry in the index foo.
4269 % It also defines \fooindfile to be the number of the output channel for
4270 % the file that accumulates this index. The file's extension is foo.
4271 % The name of an index should be no more than 2 characters long
4272 % for the sake of vms.
4276 \expandafter\newwrite \csname#1indfile\endcsname
4277 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4279 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4280 \noexpand\doindex{#1}}
4283 % @defindex foo == \newindex{foo}
4285 \def\defindex{\parsearg\newindex}
4287 % Define @defcodeindex, like @defindex except put all entries in @code.
4289 \def\defcodeindex{\parsearg\newcodeindex}
4291 \def\newcodeindex#1{%
4293 \expandafter\newwrite \csname#1indfile\endcsname
4294 \openout \csname#1indfile\endcsname \jobname.#1
4296 \expandafter\xdef\csname#1index\endcsname{%
4297 \noexpand\docodeindex{#1}}%
4301 % @synindex foo bar makes index foo feed into index bar.
4302 % Do this instead of @defindex foo if you don't want it as a separate index.
4304 % @syncodeindex foo bar similar, but put all entries made for index foo
4307 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4308 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4310 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4311 % #3 the target index (bar).
4312 \def\dosynindex#1#2#3{%
4313 % Only do \closeout if we haven't already done it, else we'll end up
4314 % closing the target index.
4315 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4316 % The \closeout helps reduce unnecessary open files; the limit on the
4317 % Acorn RISC OS is a mere 16 files.
4318 \expandafter\closeout\csname#2indfile\endcsname
4319 \expandafter\let\csname donesynindex#2\endcsname = 1
4321 % redefine \fooindfile:
4322 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4323 \expandafter\let\csname#2indfile\endcsname=\temp
4324 % redefine \fooindex:
4325 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4328 % Define \doindex, the driver for all \fooindex macros.
4329 % Argument #1 is generated by the calling \fooindex macro,
4330 % and it is "foo", the name of the index.
4332 % \doindex just uses \parsearg; it calls \doind for the actual work.
4333 % This is because \doind is more useful to call from other macros.
4335 % There is also \dosubind {index}{topic}{subtopic}
4336 % which makes an entry in a two-level index such as the operation index.
4338 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4339 \def\singleindexer #1{\doind{\indexname}{#1}}
4341 % like the previous two, but they put @code around the argument.
4342 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4343 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4345 % Take care of Texinfo commands that can appear in an index entry.
4346 % Since there are some commands we want to expand, and others we don't,
4347 % we have to laboriously prevent expansion for those that we don't.
4350 \escapechar = `\\ % use backslash in output files.
4351 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4352 \def\ {\realbackslash\space }%
4354 % Need these unexpandable (because we define \tt as a dummy)
4355 % definitions when @{ or @} appear in index entry text. Also, more
4356 % complicated, when \tex is in effect and \{ is a \delimiter again.
4357 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4358 % braces and backslashes are used only as delimiters. Perhaps we
4359 % should define @lbrace and @rbrace commands a la @comma.
4360 \def\{{{\tt\char123}}%
4361 \def\}{{\tt\char125}}%
4363 % I don't entirely understand this, but when an index entry is
4364 % generated from a macro call, the \endinput which \scanmacro inserts
4365 % causes processing to be prematurely terminated. This is,
4366 % apparently, because \indexsorttmp is fully expanded, and \endinput
4367 % is an expandable command. The redefinition below makes \endinput
4368 % disappear altogether for that purpose -- although logging shows that
4369 % processing continues to some further point. On the other hand, it
4370 % seems \endinput does not hurt in the printed index arg, since that
4371 % is still getting written without apparent harm.
4373 % Sample source (mac-idx3.tex, reported by Graham Percival to
4374 % help-texinfo, 22may06):
4375 % @macro funindex {WORD}
4379 % @funindex commtest
4381 % The above is not enough to reproduce the bug, but it gives the flavor.
4383 % Sample whatsit resulting:
4384 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4387 \let\endinput = \empty
4389 % Do the redefinitions.
4393 % For the aux and toc files, @ is the escape character. So we want to
4394 % redefine everything using @ as the escape character (instead of
4395 % \realbackslash, still used for index files). When everything uses @,
4396 % this will be simpler.
4401 \let\{ = \lbraceatcmd
4402 \let\} = \rbraceatcmd
4404 % Do the redefinitions.
4409 % Called from \indexdummies and \atdummies.
4411 \def\commondummies{%
4413 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4414 % preventing its expansion. This is used only for control words,
4415 % not control letters, because the \space would be incorrect for
4416 % control characters, but is needed to separate the control word
4417 % from whatever follows.
4419 % For control letters, we have \definedummyletter, which omits the
4422 % These can be used both for control words that take an argument and
4423 % those that do not. If it is followed by {arg} in the input, then
4424 % that will dutifully get written to the index (or wherever).
4426 \def\definedummyword ##1{\def##1{\string##1\space}}%
4427 \def\definedummyletter##1{\def##1{\string##1}}%
4428 \let\definedummyaccent\definedummyletter
4430 \commondummiesnofonts
4432 \definedummyletter\_%
4433 \definedummyletter\-%
4435 % Non-English letters.
4446 \definedummyword\exclamdown
4450 \definedummyword\ordf
4451 \definedummyword\ordm
4452 \definedummyword\questiondown
4456 % Although these internal commands shouldn't show up, sometimes they do.
4458 \definedummyword\gtr
4459 \definedummyword\hat
4460 \definedummyword\less
4463 \definedummyword\tclose
4466 \definedummyword\LaTeX
4467 \definedummyword\TeX
4469 % Assorted special characters.
4470 \definedummyword\arrow
4471 \definedummyword\bullet
4472 \definedummyword\comma
4473 \definedummyword\copyright
4474 \definedummyword\registeredsymbol
4475 \definedummyword\dots
4476 \definedummyword\enddots
4477 \definedummyword\entrybreak
4478 \definedummyword\equiv
4479 \definedummyword\error
4480 \definedummyword\euro
4481 \definedummyword\expansion
4482 \definedummyword\geq
4483 \definedummyword\guillemetleft
4484 \definedummyword\guillemetright
4485 \definedummyword\guilsinglleft
4486 \definedummyword\guilsinglright
4487 \definedummyword\lbracechar
4488 \definedummyword\leq
4489 \definedummyword\minus
4490 \definedummyword\ogonek
4491 \definedummyword\pounds
4492 \definedummyword\point
4493 \definedummyword\print
4494 \definedummyword\quotedblbase
4495 \definedummyword\quotedblleft
4496 \definedummyword\quotedblright
4497 \definedummyword\quoteleft
4498 \definedummyword\quoteright
4499 \definedummyword\quotesinglbase
4500 \definedummyword\rbracechar
4501 \definedummyword\result
4502 \definedummyword\textdegree
4504 % We want to disable all macros so that they are not expanded by \write.
4507 \normalturnoffactive
4509 % Handle some cases of @value -- where it does not contain any
4510 % (non-fully-expandable) commands.
4511 \makevalueexpandable
4514 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4516 \def\commondummiesnofonts{%
4517 % Control letters and accents.
4518 \definedummyletter\!%
4519 \definedummyaccent\"%
4520 \definedummyaccent\'%
4521 \definedummyletter\*%
4522 \definedummyaccent\,%
4523 \definedummyletter\.%
4524 \definedummyletter\/%
4525 \definedummyletter\:%
4526 \definedummyaccent\=%
4527 \definedummyletter\?%
4528 \definedummyaccent\^%
4529 \definedummyaccent\`%
4530 \definedummyaccent\~%
4534 \definedummyword\dotaccent
4535 \definedummyword\ogonek
4536 \definedummyword\ringaccent
4537 \definedummyword\tieaccent
4538 \definedummyword\ubaraccent
4539 \definedummyword\udotaccent
4540 \definedummyword\dotless
4542 % Texinfo font commands.
4546 \definedummyword\sansserif
4548 \definedummyword\slanted
4551 % Commands that take arguments.
4552 \definedummyword\abbr
4553 \definedummyword\acronym
4554 \definedummyword\anchor
4555 \definedummyword\cite
4556 \definedummyword\code
4557 \definedummyword\command
4558 \definedummyword\dfn
4559 \definedummyword\dmn
4560 \definedummyword\email
4561 \definedummyword\emph
4562 \definedummyword\env
4563 \definedummyword\file
4564 \definedummyword\image
4565 \definedummyword\indicateurl
4566 \definedummyword\inforef
4567 \definedummyword\kbd
4568 \definedummyword\key
4569 \definedummyword\math
4570 \definedummyword\option
4571 \definedummyword\pxref
4572 \definedummyword\ref
4573 \definedummyword\samp
4574 \definedummyword\strong
4575 \definedummyword\tie
4576 \definedummyword\uref
4577 \definedummyword\url
4578 \definedummyword\var
4579 \definedummyword\verb
4581 \definedummyword\xref
4584 % \indexnofonts is used when outputting the strings to sort the index
4585 % by, and when constructing control sequence names. It eliminates all
4586 % control sequences and just writes whatever the best ASCII sort string
4587 % would be for a given command (usually its argument).
4590 % Accent commands should become @asis.
4591 \def\definedummyaccent##1{\let##1\asis}%
4592 % We can just ignore other control letters.
4593 \def\definedummyletter##1{\let##1\empty}%
4594 % All control words become @asis by default; overrides below.
4595 \let\definedummyword\definedummyaccent
4597 \commondummiesnofonts
4599 % Don't no-op \tt, since it isn't a user-level command
4600 % and is used in the definitions of the active chars like <, >, |, etc.
4601 % Likewise with the other plain tex font commands.
4606 \def\_{\normalunderscore}%
4607 \def\-{}% @- shouldn't affect sorting
4609 % Unfortunately, texindex is not prepared to handle braces in the
4610 % content at all. So for index sorting, we map @{ and @} to strings
4611 % starting with |, since that ASCII character is between ASCII { and }.
4613 \def\lbracechar{|a}%
4616 \def\rbracechar{|b}%
4618 % Non-English letters.
4635 \def\questiondown{?}%
4642 % Assorted special characters.
4643 % (The following {} will end up in the sort string, but that's ok.)
4645 \def\bullet{bullet}%
4647 \def\copyright{copyright}%
4653 \def\expansion{==>}%
4655 \def\guillemetleft{<<}%
4656 \def\guillemetright{>>}%
4657 \def\guilsinglleft{<}%
4658 \def\guilsinglright{>}%
4662 \def\pounds{pounds}%
4664 \def\quotedblbase{"}%
4665 \def\quotedblleft{"}%
4666 \def\quotedblright{"}%
4669 \def\quotesinglbase{,}%
4670 \def\registeredsymbol{R}%
4674 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4675 \else \indexlquoteignore \fi
4677 % We need to get rid of all macros, leaving only the arguments (if present).
4678 % Of course this is not nearly correct, but it is the best we can do for now.
4679 % makeinfo does not expand macros in the argument to @deffn, which ends up
4680 % writing an index entry, and texindex isn't prepared for an index sort entry
4681 % that starts with \.
4683 % Since macro invocations are followed by braces, we can just redefine them
4684 % to take a single TeX argument. The case of a macro invocation that
4685 % goes to end-of-line is not handled.
4690 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4691 % ignore left quotes in the sort term.
4692 {\catcode`\`=\active
4693 \gdef\indexlquoteignore{\let`=\empty}}
4695 \let\indexbackslash=0 %overridden during \printindex.
4696 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4698 % Most index entries go through here, but \dosubind is the general case.
4699 % #1 is the index name, #2 is the entry text.
4700 \def\doind#1#2{\dosubind{#1}{#2}{}}
4702 % Workhorse for all \fooindexes.
4703 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4704 % empty if called from \doind, as we usually are (the main exception
4705 % is with most defuns, which call us directly).
4707 \def\dosubind#1#2#3{%
4710 % Store the main index entry text (including the third arg).
4712 % If third arg is present, precede it with a space.
4714 \ifx\thirdarg\empty \else
4715 \toks0 = \expandafter{\the\toks0 \space #3}%
4718 \edef\writeto{\csname#1indfile\endcsname}%
4720 \safewhatsit\dosubindwrite
4725 % Write the entry in \toks0 to the index file:
4727 \def\dosubindwrite{%
4728 % Put the index entry in the margin if desired.
4729 \ifx\SETmarginindex\relax\else
4730 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4733 % Remember, we are within a group.
4734 \indexdummies % Must do this here, since \bf, etc expand at this stage
4735 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4736 % so it will be output as is; and it will print as backslash.
4738 % Process the index entry with all font commands turned off, to
4739 % get the string to sort by.
4741 \edef\temp{\the\toks0}% need full expansion
4742 \xdef\indexsorttmp{\temp}%
4745 % Set up the complete index entry, with both the sort key and
4746 % the original text, including any font commands. We write
4747 % three arguments to \entry to the .?? file (four in the
4748 % subentry case), texindex reduces to two when writing the .??s
4752 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4757 % Take care of unwanted page breaks/skips around a whatsit:
4759 % If a skip is the last thing on the list now, preserve it
4760 % by backing up by \lastskip, doing the \write, then inserting
4761 % the skip again. Otherwise, the whatsit generated by the
4762 % \write or \pdfdest will make \lastskip zero. The result is that
4763 % sequences like this:
4767 % will have extra space inserted, because the \medbreak in the
4768 % start of the @defun won't see the skip inserted by the @end of
4769 % the previous defun.
4771 % But don't do any of this if we're not in vertical mode. We
4772 % don't want to do a \vskip and prematurely end a paragraph.
4774 % Avoid page breaks due to these extra skips, too.
4776 % But wait, there is a catch there:
4777 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4778 % sufficient for this purpose, as it ignores stretch and shrink parts
4779 % of the skip. The only way seems to be to check the textual
4780 % representation of the skip.
4782 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4783 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4785 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4787 \newskip\whatsitskip
4788 \newcount\whatsitpenalty
4792 \def\safewhatsit#1{\ifhmode
4795 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4796 \whatsitskip = \lastskip
4797 \edef\lastskipmacro{\the\lastskip}%
4798 \whatsitpenalty = \lastpenalty
4800 % If \lastskip is nonzero, that means the last item was a
4801 % skip. And since a skip is discardable, that means this
4802 % -\whatsitskip glue we're inserting is preceded by a
4803 % non-discardable item, therefore it is not a potential
4804 % breakpoint, therefore no \nobreak needed.
4805 \ifx\lastskipmacro\zeroskipmacro
4812 \ifx\lastskipmacro\zeroskipmacro
4813 % If \lastskip was zero, perhaps the last item was a penalty, and
4814 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4815 % to re-insert the same penalty (values >10000 are used for various
4816 % signals); since we just inserted a non-discardable item, any
4817 % following glue (such as a \parskip) would be a breakpoint. For example:
4818 % @deffn deffn-whatever
4819 % @vindex index-whatever
4821 % would allow a break between the index-whatever whatsit
4822 % and the "Description." paragraph.
4823 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4825 % On the other hand, if we had a nonzero \lastskip,
4826 % this make-up glue would be preceded by a non-discardable item
4827 % (the whatsit from the \write), so we must insert a \nobreak.
4828 \nobreak\vskip\whatsitskip
4832 % The index entry written in the file actually looks like
4833 % \entry {sortstring}{page}{topic}
4835 % \entry {sortstring}{page}{topic}{subtopic}
4836 % The texindex program reads in these files and writes files
4837 % containing these kinds of lines:
4839 % before the first topic whose initial is c
4840 % \entry {topic}{pagelist}
4841 % for a topic that is used without subtopics
4843 % for the beginning of a topic that is used with subtopics
4844 % \secondary {subtopic}{pagelist}
4845 % for each subtopic.
4847 % Define the user-accessible indexing commands
4848 % @findex, @vindex, @kindex, @cindex.
4850 \def\findex {\fnindex}
4851 \def\kindex {\kyindex}
4852 \def\cindex {\cpindex}
4853 \def\vindex {\vrindex}
4854 \def\tindex {\tpindex}
4855 \def\pindex {\pgindex}
4857 \def\cindexsub {\begingroup\obeylines\cindexsub}
4859 \gdef\cindexsub "#1" #2^^M{\endgroup %
4860 \dosubind{cp}{#2}{#1}}}
4862 % Define the macros used in formatting output of the sorted index material.
4864 % @printindex causes a particular index (the ??s file) to get printed.
4865 % It does not print any chapter heading (usually an @unnumbered).
4867 \parseargdef\printindex{\begingroup
4868 \dobreak \chapheadingskip{10000}%
4873 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4875 % See if the index file exists and is nonempty.
4876 % Change catcode of @ here so that if the index file contains
4878 % as its first line, TeX doesn't complain about mismatched braces
4879 % (because it thinks @} is a control sequence).
4881 \openin 1 \jobname.#1s
4883 % \enddoublecolumns gets confused if there is no text in the index,
4884 % and it loses the chapter title and the aux file entries for the
4885 % index. The easiest way to prevent this problem is to make sure
4886 % there is some text.
4887 \putwordIndexNonexistent
4890 % If the index file exists but is empty, then \openin leaves \ifeof
4891 % false. We have to make TeX try to read something from the file, so
4892 % it can discover if there is anything in it.
4895 \putwordIndexIsEmpty
4897 % Index files are almost Texinfo source, but we use \ as the escape
4898 % character. It would be better to use @, but that's too big a change
4899 % to make right now.
4900 \def\indexbackslash{\backslashcurfont}%
4911 % These macros are used by the sorted index file itself.
4912 % Change them to control the appearance of the index.
4915 % Some minor font changes for the special characters.
4916 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4918 % Remove any glue we may have, we'll be inserting our own.
4921 % We like breaks before the index initials, so insert a bonus.
4923 \vskip 0pt plus 3\baselineskip
4925 \vskip 0pt plus -3\baselineskip
4927 % Typeset the initial. Making this add up to a whole number of
4928 % baselineskips increases the chance of the dots lining up from column
4929 % to column. It still won't often be perfect, because of the stretch
4930 % we need before each entry, but it's better.
4932 % No shrink because it confuses \balancecolumns.
4933 \vskip 1.67\baselineskip plus .5\baselineskip
4934 \leftline{\secbf #1}%
4935 % Do our best not to break after the initial.
4937 \vskip .33\baselineskip plus .1\baselineskip
4940 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4941 % then page number (#2) flushed to the right margin. It is used for index
4942 % and table of contents entries. The paragraph is indented by \leftskip.
4944 % A straightforward implementation would start like this:
4945 % \def\entry#1#2{...
4946 % But this freezes the catcodes in the argument, and can cause problems to
4947 % @code, which sets - active. This problem was fixed by a kludge---
4948 % ``-'' was active throughout whole index, but this isn't really right.
4949 % The right solution is to prevent \entry from swallowing the whole text.
4954 % Start a new paragraph if necessary, so our assignments below can't
4955 % affect previous text.
4958 % Do not fill out the last line with white space.
4961 % No extra space above this paragraph.
4964 % Do not prefer a separate line ending with a hyphen to fewer lines.
4965 \finalhyphendemerits = 0
4967 % \hangindent is only relevant when the entry text and page number
4968 % don't both fit on one line. In that case, bob suggests starting the
4969 % dots pretty far over on the line. Unfortunately, a large
4970 % indentation looks wrong when the entry text itself is broken across
4971 % lines. So we use a small indentation and put up with long leaders.
4973 % \hangafter is reset to 1 (which is the value we want) at the start
4974 % of each paragraph, so we need not do anything with that.
4977 % When the entry text needs to be broken, just fill out the first line
4979 \rightskip = 0pt plus1fil
4981 % A bit of stretch before each entry for the benefit of balancing
4985 % When reading the text of entry, convert explicit line breaks
4986 % from @* into spaces. The user might give these in long section
4987 % titles, for instance.
4988 \def\*{\unskip\space\ignorespaces}%
4989 \def\entrybreak{\hfil\break}%
4991 % Swallow the left brace of the text (first parameter):
4992 \afterassignment\doentry
4995 \def\entrybreak{\unskip\space\ignorespaces}%
4997 \bgroup % Instead of the swallowed brace.
4999 \aftergroup\finishentry
5000 % And now comes the text of the entry.
5002 \def\finishentry#1{%
5003 % #1 is the page number.
5005 % The following is kludged to not output a line of dots in the index if
5006 % there are no page numbers. The next person who breaks this will be
5007 % cursed by a Unix daemon.
5008 \setbox\boxA = \hbox{#1}%
5009 \ifdim\wd\boxA = 0pt
5013 % If we must, put the page number on a line of its own, and fill out
5014 % this line with blank space. (The \hfil is overwhelmed with the
5015 % fill leaders glue in \indexdotfill if the page number does fit.)
5017 \null\nobreak\indexdotfill % Have leaders before the page number.
5019 % The `\ ' here is removed by the implicit \unskip that TeX does as
5020 % part of (the primitive) \par. Without it, a spurious underfull
5033 % Like plain.tex's \dotfill, except uses up at least 1 em.
5034 \def\indexdotfill{\cleaders
5035 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
5037 \def\primary #1{\line{#1\hfil}}
5039 \newskip\secondaryindent \secondaryindent=0.5cm
5040 \def\secondary#1#2{{%
5045 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5047 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
5054 % Define two-column mode, which we use to typeset indexes.
5055 % Adapted from the TeXbook, page 416, which is to say,
5056 % the manmac.tex format used to print the TeXbook itself.
5060 \newdimen\doublecolumnhsize
5062 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5063 % Grab any single-column material above us.
5066 % Here is a possibility not foreseen in manmac: if we accumulate a
5067 % whole lot of material, we might end up calling this \output
5068 % routine twice in a row (see the doublecol-lose test, which is
5069 % essentially a couple of indexes with @setchapternewpage off). In
5070 % that case we just ship out what is in \partialpage with the normal
5071 % output routine. Generally, \partialpage will be empty when this
5072 % runs and this will be a no-op. See the indexspread.tex test case.
5073 \ifvoid\partialpage \else
5074 \onepageout{\pagecontents\partialpage}%
5077 \global\setbox\partialpage = \vbox{%
5078 % Unvbox the main output page.
5080 \kern-\topskip \kern\baselineskip
5083 \eject % run that output routine to set \partialpage
5085 % Use the double-column output routine for subsequent pages.
5086 \output = {\doublecolumnout}%
5088 % Change the page size parameters. We could do this once outside this
5089 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5090 % format, but then we repeat the same computation. Repeating a couple
5091 % of assignments once per index is clearly meaningless for the
5092 % execution time, so we may as well do it in one place.
5094 % First we halve the line length, less a little for the gutter between
5095 % the columns. We compute the gutter based on the line length, so it
5096 % changes automatically with the paper format. The magic constant
5097 % below is chosen so that the gutter has the same value (well, +-<1pt)
5098 % as it did when we hard-coded it.
5100 % We put the result in a separate register, \doublecolumhsize, so we
5101 % can restore it in \pagesofar, after \hsize itself has (potentially)
5104 \doublecolumnhsize = \hsize
5105 \advance\doublecolumnhsize by -.04154\hsize
5106 \divide\doublecolumnhsize by 2
5107 \hsize = \doublecolumnhsize
5109 % Double the \vsize as well. (We don't need a separate register here,
5110 % since nobody clobbers \vsize.)
5114 % The double-column output routine for all double-column pages except
5117 \def\doublecolumnout{%
5118 \splittopskip=\topskip \splitmaxdepth=\maxdepth
5119 % Get the available space for the double columns -- the normal
5120 % (undoubled) page height minus any material left over from the
5124 \advance\dimen@ by -\ht\partialpage
5126 % box0 will be the left-hand column, box2 the right.
5127 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
5128 \onepageout\pagesofar
5130 \penalty\outputpenalty
5133 % Re-output the contents of the output page -- any previous material,
5134 % followed by the two boxes we just split, in box0 and box2.
5138 \hsize = \doublecolumnhsize
5139 \wd0=\hsize \wd2=\hsize
5140 \hbox to\pagewidth{\box0\hfil\box2}%
5143 % All done with double columns.
5144 \def\enddoublecolumns{%
5145 % The following penalty ensures that the page builder is exercised
5146 % _before_ we change the output routine. This is necessary in the
5147 % following situation:
5149 % The last section of the index consists only of a single entry.
5150 % Before this section, \pagetotal is less than \pagegoal, so no
5151 % break occurs before the last section starts. However, the last
5152 % section, consisting of \initial and the single \entry, does not
5153 % fit on the page and has to be broken off. Without the following
5154 % penalty the page builder will not be exercised until \eject
5155 % below, and by that time we'll already have changed the output
5156 % routine to the \balancecolumns version, so the next-to-last
5157 % double-column page will be processed with \balancecolumns, which
5158 % is wrong: The two columns will go to the main vertical list, with
5159 % the broken-off section in the recent contributions. As soon as
5160 % the output routine finishes, TeX starts reconsidering the page
5161 % break. The two columns and the broken-off section both fit on the
5162 % page, because the two columns now take up only half of the page
5163 % goal. When TeX sees \eject from below which follows the final
5164 % section, it invokes the new output routine that we've set after
5165 % \balancecolumns below; \onepageout will try to fit the two columns
5166 % and the final section into the vbox of \pageheight (see
5167 % \pagebody), causing an overfull box.
5169 % Note that glue won't work here, because glue does not exercise the
5170 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5174 % Split the last of the double-column material. Leave it on the
5175 % current page, no automatic page break.
5178 % If we end up splitting too much material for the current page,
5179 % though, there will be another page break right after this \output
5180 % invocation ends. Having called \balancecolumns once, we do not
5181 % want to call it again. Therefore, reset \output to its normal
5182 % definition right away. (We hope \balancecolumns will never be
5183 % called on to balance too much material, but if it is, this makes
5184 % the output somewhat more palatable.)
5185 \global\output = {\onepageout{\pagecontents\PAGE}}%
5188 \endgroup % started in \begindoublecolumns
5190 % \pagegoal was set to the doubled \vsize above, since we restarted
5191 % the current page. We're now back to normal single-column
5192 % typesetting, so reset \pagegoal to the normal \vsize (after the
5193 % \endgroup where \vsize got restored).
5197 % Called at the end of the double column material.
5198 \def\balancecolumns{%
5199 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5201 \advance\dimen@ by \topskip
5202 \advance\dimen@ by-\baselineskip
5203 \divide\dimen@ by 2 % target to split to
5204 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5205 \splittopskip = \topskip
5206 % Loop until we get a decent breakpoint.
5210 \global\setbox3 = \copy0
5211 \global\setbox1 = \vsplit3 to \dimen@
5213 \global\advance\dimen@ by 1pt
5216 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5217 \setbox0=\vbox to\dimen@{\unvbox1}%
5218 \setbox2=\vbox to\dimen@{\unvbox3}%
5222 \catcode`\@ = \other
5225 \message{sectioning,}
5226 % Chapters, sections, etc.
5228 % Let's start with @part.
5229 \outer\parseargdef\part{\partzzz{#1}}
5233 \vskip.3\vsize % move it down on the page a bit
5235 \noindent \titlefonts\rmisbold #1\par % the text
5236 \let\lastnode=\empty % no node to associate with
5237 \writetocentry{part}{#1}{}% but put it in the toc
5238 \headingsoff % no headline or footline on the part page
5243 % \unnumberedno is an oxymoron. But we count the unnumbered
5244 % sections so that we can refer to them unambiguously in the pdf
5245 % outlines by their "section number". We avoid collisions with chapter
5246 % numbers by starting them at 10000. (If a document ever has 10000
5247 % chapters, we're in trouble anyway, I'm sure.)
5248 \newcount\unnumberedno \unnumberedno = 10000
5250 \newcount\secno \secno=0
5251 \newcount\subsecno \subsecno=0
5252 \newcount\subsubsecno \subsubsecno=0
5254 % This counter is funny since it counts through charcodes of letters A, B, ...
5255 \newcount\appendixno \appendixno = `\@
5257 % \def\appendixletter{\char\the\appendixno}
5258 % We do the following ugly conditional instead of the above simple
5259 % construct for the sake of pdftex, which needs the actual
5260 % letter in the expansion, not just typeset.
5262 \def\appendixletter{%
5263 \ifnum\appendixno=`A A%
5264 \else\ifnum\appendixno=`B B%
5265 \else\ifnum\appendixno=`C C%
5266 \else\ifnum\appendixno=`D D%
5267 \else\ifnum\appendixno=`E E%
5268 \else\ifnum\appendixno=`F F%
5269 \else\ifnum\appendixno=`G G%
5270 \else\ifnum\appendixno=`H H%
5271 \else\ifnum\appendixno=`I I%
5272 \else\ifnum\appendixno=`J J%
5273 \else\ifnum\appendixno=`K K%
5274 \else\ifnum\appendixno=`L L%
5275 \else\ifnum\appendixno=`M M%
5276 \else\ifnum\appendixno=`N N%
5277 \else\ifnum\appendixno=`O O%
5278 \else\ifnum\appendixno=`P P%
5279 \else\ifnum\appendixno=`Q Q%
5280 \else\ifnum\appendixno=`R R%
5281 \else\ifnum\appendixno=`S S%
5282 \else\ifnum\appendixno=`T T%
5283 \else\ifnum\appendixno=`U U%
5284 \else\ifnum\appendixno=`V V%
5285 \else\ifnum\appendixno=`W W%
5286 \else\ifnum\appendixno=`X X%
5287 \else\ifnum\appendixno=`Y Y%
5288 \else\ifnum\appendixno=`Z Z%
5289 % The \the is necessary, despite appearances, because \appendixletter is
5290 % expanded while writing the .toc file. \char\appendixno is not
5291 % expandable, thus it is written literally, thus all appendixes come out
5292 % with the same letter (or @) in the toc without it.
5293 \else\char\the\appendixno
5294 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5295 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5297 % Each @chapter defines these (using marks) as the number+name, number
5298 % and name of the chapter. Page headings and footings can use
5299 % these. @section does likewise.
5301 \def\thischapternum{}
5302 \def\thischaptername{}
5304 \def\thissectionnum{}
5305 \def\thissectionname{}
5307 \newcount\absseclevel % used to calculate proper heading level
5308 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5310 % @raisesections: treat @section as chapter, @subsection as section, etc.
5311 \def\raisesections{\global\advance\secbase by -1}
5312 \let\up=\raisesections % original BFox name
5314 % @lowersections: treat @chapter as section, @section as subsection, etc.
5315 \def\lowersections{\global\advance\secbase by 1}
5316 \let\down=\lowersections % original BFox name
5318 % we only have subsub.
5319 \chardef\maxseclevel = 3
5321 % A numbered section within an unnumbered changes to unnumbered too.
5322 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5323 \chardef\unnlevel = \maxseclevel
5325 % Trace whether the current chapter is an appendix or not:
5326 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5327 \def\chapheadtype{N}
5329 % Choose a heading macro
5330 % #1 is heading type
5331 % #2 is heading level
5332 % #3 is text for heading
5333 \def\genhead#1#2#3{%
5334 % Compute the abs. sec. level:
5336 \advance\absseclevel by \secbase
5337 % Make sure \absseclevel doesn't fall outside the range:
5338 \ifnum \absseclevel < 0
5341 \ifnum \absseclevel > 3
5348 \ifnum \absseclevel < \unnlevel
5349 \chardef\unnlevel = \absseclevel
5352 % Check for appendix sections:
5353 \ifnum \absseclevel = 0
5354 \edef\chapheadtype{\headtype}%
5356 \if \headtype A\if \chapheadtype N%
5357 \errmessage{@appendix... within a non-appendix chapter}%
5360 % Check for numbered within unnumbered:
5361 \ifnum \absseclevel > \unnlevel
5364 \chardef\unnlevel = 3
5367 % Now print the heading:
5371 \or \unnumberedseczzz{#3}%
5372 \or \unnumberedsubseczzz{#3}%
5373 \or \unnumberedsubsubseczzz{#3}%
5379 \or \appendixsectionzzz{#3}%
5380 \or \appendixsubseczzz{#3}%
5381 \or \appendixsubsubseczzz{#3}%
5387 \or \numberedsubseczzz{#3}%
5388 \or \numberedsubsubseczzz{#3}%
5392 \suppressfirstparagraphindent
5396 \def\numhead{\genhead N}
5397 \def\apphead{\genhead A}
5398 \def\unnmhead{\genhead U}
5400 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5401 % all lower-level sectioning counters to zero.
5403 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5404 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5405 \let\chaplevelprefix = \empty
5407 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5409 % section resetting is \global in case the chapter is in a group, such
5410 % as an @include file.
5411 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5412 \global\advance\chapno by 1
5415 \gdef\chaplevelprefix{\the\chapno.}%
5418 % \putwordChapter can contain complex things in translations.
5419 \toks0=\expandafter{\putwordChapter}%
5420 \message{\the\toks0 \space \the\chapno}%
5422 % Write the actual heading.
5423 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5425 % So @section and the like are numbered underneath this chapter.
5426 \global\let\section = \numberedsec
5427 \global\let\subsection = \numberedsubsec
5428 \global\let\subsubsection = \numberedsubsubsec
5431 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5433 \def\appendixzzz#1{%
5434 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5435 \global\advance\appendixno by 1
5436 \gdef\chaplevelprefix{\appendixletter.}%
5439 % \putwordAppendix can contain complex things in translations.
5440 \toks0=\expandafter{\putwordAppendix}%
5441 \message{\the\toks0 \space \appendixletter}%
5443 \chapmacro{#1}{Yappendix}{\appendixletter}%
5445 \global\let\section = \appendixsec
5446 \global\let\subsection = \appendixsubsec
5447 \global\let\subsubsection = \appendixsubsubsec
5450 % normally unnmhead0 calls unnumberedzzz:
5451 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5452 \def\unnumberedzzz#1{%
5453 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5454 \global\advance\unnumberedno by 1
5456 % Since an unnumbered has no number, no prefix for figures.
5457 \global\let\chaplevelprefix = \empty
5460 % This used to be simply \message{#1}, but TeX fully expands the
5461 % argument to \message. Therefore, if #1 contained @-commands, TeX
5462 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5463 % expanded @cite (which turns out to cause errors because \cite is meant
5464 % to be executed, not expanded).
5466 % Anyway, we don't want the fully-expanded definition of @cite to appear
5467 % as a result of the \message, we just want `@cite' itself. We use
5468 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5469 % simply yielding the contents of <toks register>. (We also do this for
5472 \message{(\the\toks0)}%
5474 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5476 \global\let\section = \unnumberedsec
5477 \global\let\subsection = \unnumberedsubsec
5478 \global\let\subsubsection = \unnumberedsubsubsec
5481 % @centerchap is like @unnumbered, but the heading is centered.
5482 \outer\parseargdef\centerchap{%
5483 % Well, we could do the following in a group, but that would break
5484 % an assumption that \chapmacro is called at the outermost level.
5485 % Thus we are safer this way: --kasal, 24feb04
5486 \let\centerparametersmaybe = \centerparameters
5488 \let\centerparametersmaybe = \relax
5491 % @top is like @unnumbered.
5496 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5498 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5499 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5502 % normally calls appendixsectionzzz:
5503 \outer\parseargdef\appendixsection{\apphead1{#1}}
5504 \def\appendixsectionzzz#1{%
5505 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5506 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5508 \let\appendixsec\appendixsection
5510 % normally calls unnumberedseczzz:
5511 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5512 \def\unnumberedseczzz#1{%
5513 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5514 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5519 % normally calls numberedsubseczzz:
5520 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5521 \def\numberedsubseczzz#1{%
5522 \global\subsubsecno=0 \global\advance\subsecno by 1
5523 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5526 % normally calls appendixsubseczzz:
5527 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5528 \def\appendixsubseczzz#1{%
5529 \global\subsubsecno=0 \global\advance\subsecno by 1
5530 \sectionheading{#1}{subsec}{Yappendix}%
5531 {\appendixletter.\the\secno.\the\subsecno}%
5534 % normally calls unnumberedsubseczzz:
5535 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5536 \def\unnumberedsubseczzz#1{%
5537 \global\subsubsecno=0 \global\advance\subsecno by 1
5538 \sectionheading{#1}{subsec}{Ynothing}%
5539 {\the\unnumberedno.\the\secno.\the\subsecno}%
5544 % normally numberedsubsubseczzz:
5545 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5546 \def\numberedsubsubseczzz#1{%
5547 \global\advance\subsubsecno by 1
5548 \sectionheading{#1}{subsubsec}{Ynumbered}%
5549 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5552 % normally appendixsubsubseczzz:
5553 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5554 \def\appendixsubsubseczzz#1{%
5555 \global\advance\subsubsecno by 1
5556 \sectionheading{#1}{subsubsec}{Yappendix}%
5557 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5560 % normally unnumberedsubsubseczzz:
5561 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5562 \def\unnumberedsubsubseczzz#1{%
5563 \global\advance\subsubsecno by 1
5564 \sectionheading{#1}{subsubsec}{Ynothing}%
5565 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5568 % These macros control what the section commands do, according
5569 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5570 % Define them by default for a numbered chapter.
5571 \let\section = \numberedsec
5572 \let\subsection = \numberedsubsec
5573 \let\subsubsection = \numberedsubsubsec
5575 % Define @majorheading, @heading and @subheading
5577 % NOTE on use of \vbox for chapter headings, section headings, and such:
5578 % 1) We use \vbox rather than the earlier \line to permit
5579 % overlong headings to fold.
5580 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5581 % heading is obnoxious; this forbids it.
5582 % 3) Likewise, headings look best if no \parindent is used, and
5583 % if justification is not attempted. Hence \raggedright.
5586 {\advance\chapheadingskip by 10pt \chapbreak }%
5587 \parsearg\chapheadingzzz
5590 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5591 \def\chapheadingzzz#1{%
5592 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5593 \parindent=0pt\ptexraggedright
5594 \rmisbold #1\hfill}}%
5595 \bigskip \par\penalty 200\relax
5596 \suppressfirstparagraphindent
5599 % @heading, @subheading, @subsubheading.
5600 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5601 \suppressfirstparagraphindent}
5602 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5603 \suppressfirstparagraphindent}
5604 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5605 \suppressfirstparagraphindent}
5607 % These macros generate a chapter, section, etc. heading only
5608 % (including whitespace, linebreaking, etc. around it),
5609 % given all the information in convenient, parsed form.
5611 % Args are the skip and penalty (usually negative)
5612 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5614 % Parameter controlling skip before chapter headings (if needed)
5615 \newskip\chapheadingskip
5617 % Define plain chapter starts, and page on/off switching for it.
5618 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5619 \def\chappager{\par\vfill\supereject}
5620 % Because \domark is called before \chapoddpage, the filler page will
5621 % get the headings for the next chapter, which is wrong. But we don't
5622 % care -- we just disable all headings on the filler page.
5634 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5637 \global\let\contentsalignmacro = \chappager
5638 \global\let\pchapsepmacro=\chapbreak
5639 \global\let\pagealignmacro=\chappager}
5642 \global\let\contentsalignmacro = \chappager
5643 \global\let\pchapsepmacro=\chappager
5644 \global\let\pagealignmacro=\chappager
5645 \global\def\HEADINGSon{\HEADINGSsingle}}
5648 \global\let\contentsalignmacro = \chapoddpage
5649 \global\let\pchapsepmacro=\chapoddpage
5650 \global\let\pagealignmacro=\chapoddpage
5651 \global\def\HEADINGSon{\HEADINGSdouble}}
5657 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5658 % Yappendix, Yomitfromtoc), #3 the chapter number.
5660 % To test against our argument.
5661 \def\Ynothingkeyword{Ynothing}
5662 \def\Yomitfromtockeyword{Yomitfromtoc}
5663 \def\Yappendixkeyword{Yappendix}
5665 \def\chapmacro#1#2#3{%
5666 % Insert the first mark before the heading break (see notes for \domark).
5667 \let\prevchapterdefs=\lastchapterdefs
5668 \let\prevsectiondefs=\lastsectiondefs
5669 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5670 \gdef\thissection{}}%
5673 \ifx\temptype\Ynothingkeyword
5674 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5675 \gdef\thischapter{\thischaptername}}%
5676 \else\ifx\temptype\Yomitfromtockeyword
5677 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5678 \gdef\thischapter{}}%
5679 \else\ifx\temptype\Yappendixkeyword
5681 \xdef\lastchapterdefs{%
5682 \gdef\noexpand\thischaptername{\the\toks0}%
5683 \gdef\noexpand\thischapternum{\appendixletter}%
5684 % \noexpand\putwordAppendix avoids expanding indigestible
5685 % commands in some of the translations.
5686 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5687 \noexpand\thischapternum:
5688 \noexpand\thischaptername}%
5692 \xdef\lastchapterdefs{%
5693 \gdef\noexpand\thischaptername{\the\toks0}%
5694 \gdef\noexpand\thischapternum{\the\chapno}%
5695 % \noexpand\putwordChapter avoids expanding indigestible
5696 % commands in some of the translations.
5697 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5698 \noexpand\thischapternum:
5699 \noexpand\thischaptername}%
5703 % Output the mark. Pass it through \safewhatsit, to take care of
5704 % the preceding space.
5707 % Insert the chapter heading break.
5710 % Now the second mark, after the heading break. No break points
5711 % between here and the heading.
5712 \let\prevchapterdefs=\lastchapterdefs
5713 \let\prevsectiondefs=\lastsectiondefs
5717 \chapfonts \rmisbold
5719 % Have to define \lastsection before calling \donoderef, because the
5720 % xref code eventually uses it. On the other hand, it has to be called
5721 % after \pchapsepmacro, or the headline will change too soon.
5722 \gdef\lastsection{#1}%
5724 % Only insert the separating space if we have a chapter/appendix
5725 % number, and don't print the unnumbered ``number''.
5726 \ifx\temptype\Ynothingkeyword
5728 \def\toctype{unnchap}%
5729 \else\ifx\temptype\Yomitfromtockeyword
5730 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5732 \else\ifx\temptype\Yappendixkeyword
5733 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5736 \setbox0 = \hbox{#3\enspace}%
5737 \def\toctype{numchap}%
5740 % Write the toc entry for this chapter. Must come before the
5741 % \donoderef, because we include the current node name in the toc
5742 % entry, and \donoderef resets it to empty.
5743 \writetocentry{\toctype}{#1}{#3}%
5745 % For pdftex, we have to write out the node definition (aka, make
5746 % the pdfdest) after any page break, but before the actual text has
5747 % been typeset. If the destination for the pdf outline is after the
5748 % text, then jumping from the outline may wind up with the text not
5749 % being visible, for instance under high magnification.
5752 % Typeset the actual heading.
5753 \nobreak % Avoid page breaks at the interline glue.
5754 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5755 \hangindent=\wd0 \centerparametersmaybe
5758 \nobreak\bigskip % no page break after a chapter title
5762 % @centerchap -- centered and unnumbered.
5763 \let\centerparametersmaybe = \relax
5764 \def\centerparameters{%
5765 \advance\rightskip by 3\rightskip
5766 \leftskip = \rightskip
5771 % I don't think this chapter style is supported any more, so I'm not
5772 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5774 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5776 \def\unnchfopen #1{%
5777 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5778 \parindent=0pt\ptexraggedright
5779 \rmisbold #1\hfill}}\bigskip \par\nobreak
5781 \def\chfopen #1#2{\chapoddpage {\chapfonts
5782 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5785 \def\centerchfopen #1{%
5786 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5788 \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
5791 \global\let\chapmacro=\chfopen
5792 \global\let\centerchapmacro=\centerchfopen}
5795 % Section titles. These macros combine the section number parts and
5796 % call the generic \sectionheading to do the printing.
5798 \newskip\secheadingskip
5799 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5801 % Subsection titles.
5802 \newskip\subsecheadingskip
5803 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5805 % Subsubsection titles.
5806 \def\subsubsecheadingskip{\subsecheadingskip}
5807 \def\subsubsecheadingbreak{\subsecheadingbreak}
5810 % Print any size, any type, section title.
5812 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5813 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5816 \def\seckeyword{sec}
5818 \def\sectionheading#1#2#3#4{%
5820 \checkenv{}% should not be in an environment.
5822 % Switch to the right set of fonts.
5823 \csname #2fonts\endcsname \rmisbold
5825 \def\sectionlevel{#2}%
5828 % Insert first mark before the heading break (see notes for \domark).
5829 \let\prevsectiondefs=\lastsectiondefs
5830 \ifx\temptype\Ynothingkeyword
5831 \ifx\sectionlevel\seckeyword
5832 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5833 \gdef\thissection{\thissectionname}}%
5835 \else\ifx\temptype\Yomitfromtockeyword
5836 % Don't redefine \thissection.
5837 \else\ifx\temptype\Yappendixkeyword
5838 \ifx\sectionlevel\seckeyword
5840 \xdef\lastsectiondefs{%
5841 \gdef\noexpand\thissectionname{\the\toks0}%
5842 \gdef\noexpand\thissectionnum{#4}%
5843 % \noexpand\putwordSection avoids expanding indigestible
5844 % commands in some of the translations.
5845 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5846 \noexpand\thissectionnum:
5847 \noexpand\thissectionname}%
5851 \ifx\sectionlevel\seckeyword
5853 \xdef\lastsectiondefs{%
5854 \gdef\noexpand\thissectionname{\the\toks0}%
5855 \gdef\noexpand\thissectionnum{#4}%
5856 % \noexpand\putwordSection avoids expanding indigestible
5857 % commands in some of the translations.
5858 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5859 \noexpand\thissectionnum:
5860 \noexpand\thissectionname}%
5865 % Go into vertical mode. Usually we'll already be there, but we
5866 % don't want the following whatsit to end up in a preceding paragraph
5867 % if the document didn't happen to have a blank line.
5870 % Output the mark. Pass it through \safewhatsit, to take care of
5871 % the preceding space.
5874 % Insert space above the heading.
5875 \csname #2headingbreak\endcsname
5877 % Now the second mark, after the heading break. No break points
5878 % between here and the heading.
5879 \let\prevsectiondefs=\lastsectiondefs
5882 % Only insert the space after the number if we have a section number.
5883 \ifx\temptype\Ynothingkeyword
5886 \gdef\lastsection{#1}%
5887 \else\ifx\temptype\Yomitfromtockeyword
5888 % for @headings -- no section number, don't include in toc,
5889 % and don't redefine \lastsection.
5892 \let\sectionlevel=\empty
5893 \else\ifx\temptype\Yappendixkeyword
5894 \setbox0 = \hbox{#4\enspace}%
5896 \gdef\lastsection{#1}%
5898 \setbox0 = \hbox{#4\enspace}%
5900 \gdef\lastsection{#1}%
5903 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5904 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5906 % Write the node reference (= pdf destination for pdftex).
5907 % Again, see comments in \chapmacro.
5910 % Interline glue will be inserted when the vbox is completed.
5911 % That glue will be a valid breakpoint for the page, since it'll be
5912 % preceded by a whatsit (usually from the \donoderef, or from the
5913 % \writetocentry if there was no node). We don't want to allow that
5914 % break, since then the whatsits could end up on page n while the
5915 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5918 % Output the actual section heading.
5919 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5920 \hangindent=\wd0 % zero if no section number
5923 % Add extra space after the heading -- half of whatever came above it.
5924 % Don't allow stretch, though.
5925 \kern .5 \csname #2headingskip\endcsname
5927 % Do not let the kern be a potential breakpoint, as it would be if it
5928 % was followed by glue.
5931 % We'll almost certainly start a paragraph next, so don't let that
5932 % glue accumulate. (Not a breakpoint because it's preceded by a
5933 % discardable item.) However, when a paragraph is not started next
5934 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
5935 % or the negative glue will cause weirdly wrong output, typically
5936 % obscuring the section heading with something else.
5939 % This is so the last item on the main vertical list is a known
5940 % \penalty > 10000, so \startdefun, etc., can recognize the situation
5941 % and do the needful.
5947 % Table of contents.
5950 % Write an entry to the toc file, opening it if necessary.
5951 % Called from @chapter, etc.
5953 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5954 % We append the current node name (if any) and page number as additional
5955 % arguments for the \{chap,sec,...}entry macros which will eventually
5956 % read this. The node name is used in the pdf outlines as the
5957 % destination to jump to.
5959 % We open the .toc file for writing here instead of at @setfilename (or
5960 % any other fixed time) so that @contents can be anywhere in the document.
5961 % But if #1 is `omit', then we don't do anything. This is used for the
5962 % table of contents chapter openings themselves.
5964 \newif\iftocfileopened
5965 \def\omitkeyword{omit}%
5967 \def\writetocentry#1#2#3{%
5968 \edef\writetoctype{#1}%
5969 \ifx\writetoctype\omitkeyword \else
5970 \iftocfileopened\else
5971 \immediate\openout\tocfile = \jobname.toc
5972 \global\tocfileopenedtrue
5978 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5984 % Tell \shipout to create a pdf destination on each page, if we're
5985 % writing pdf. These are used in the table of contents. We can't
5986 % just write one on every page because the title pages are numbered
5987 % 1 and 2 (the page numbers aren't printed), and so are the first
5988 % two pages of the document. Thus, we'd have two destinations named
5989 % `1', and two named `2'.
5990 \ifpdf \global\pdfmakepagedesttrue \fi
5994 % These characters do not print properly in the Computer Modern roman
5995 % fonts, so we must take special care. This is more or less redundant
5996 % with the Texinfo input format setup at the end of this file.
5998 \def\activecatcodes{%
6011 % Read the toc file, which is essentially Texinfo input.
6015 \input \tocreadfilename
6018 \newskip\contentsrightmargin \contentsrightmargin=1in
6019 \newcount\savepageno
6020 \newcount\lastnegativepageno \lastnegativepageno = -1
6022 % Prepare to read what we've written to \tocfile.
6024 \def\startcontents#1{%
6025 % If @setchapternewpage on, and @headings double, the contents should
6026 % start on an odd page, unlike chapters. Thus, we maintain
6027 % \contentsalignmacro in parallel with \pagealignmacro.
6028 % From: Torbjorn Granlund <tege@matematik.su.se>
6030 \immediate\closeout\tocfile
6032 % Don't need to put `Contents' or `Short Contents' in the headline.
6033 % It is abundantly clear what they are.
6034 \chapmacro{#1}{Yomitfromtoc}{}%
6036 \savepageno = \pageno
6037 \begingroup % Set up to handle contents files properly.
6038 \raggedbottom % Worry more about breakpoints than the bottom.
6039 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
6041 % Roman numerals for page numbers.
6042 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
6045 % redefined for the two-volume lispref. We always output on
6046 % \jobname.toc even if this is redefined.
6048 \def\tocreadfilename{\jobname.toc}
6050 % Normal (long) toc.
6053 \startcontents{\putwordTOC}%
6054 \openin 1 \tocreadfilename\space
6059 \contentsalignmacro % in case @setchapternewpage odd is in effect
6065 \lastnegativepageno = \pageno
6066 \global\pageno = \savepageno
6069 % And just the chapters.
6070 \def\summarycontents{%
6071 \startcontents{\putwordShortTOC}%
6073 \let\partentry = \shortpartentry
6074 \let\numchapentry = \shortchapentry
6075 \let\appentry = \shortchapentry
6076 \let\unnchapentry = \shortunnchapentry
6077 % We want a true roman here for the page numbers.
6079 \let\rm=\shortcontrm \let\bf=\shortcontbf
6080 \let\sl=\shortcontsl \let\tt=\shortconttt
6082 \hyphenpenalty = 10000
6083 \advance\baselineskip by 1pt % Open it up a little.
6084 \def\numsecentry##1##2##3##4{}
6085 \let\appsecentry = \numsecentry
6086 \let\unnsecentry = \numsecentry
6087 \let\numsubsecentry = \numsecentry
6088 \let\appsubsecentry = \numsecentry
6089 \let\unnsubsecentry = \numsecentry
6090 \let\numsubsubsecentry = \numsecentry
6091 \let\appsubsubsecentry = \numsecentry
6092 \let\unnsubsubsecentry = \numsecentry
6093 \openin 1 \tocreadfilename\space
6099 \contentsalignmacro % in case @setchapternewpage odd is in effect
6101 \lastnegativepageno = \pageno
6102 \global\pageno = \savepageno
6104 \let\shortcontents = \summarycontents
6106 % Typeset the label for a chapter or appendix for the short contents.
6107 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6109 \def\shortchaplabel#1{%
6110 % This space should be enough, since a single number is .5em, and the
6111 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6112 % But use \hss just in case.
6113 % (This space doesn't include the extra space that gets added after
6114 % the label; that gets put in by \shortchapentry above.)
6116 % We'd like to right-justify chapter numbers, but that looks strange
6117 % with appendix letters. And right-justifying numbers and
6118 % left-justifying letters looks strange when there is less than 10
6119 % chapters. Have to read the whole toc once to know how many chapters
6120 % there are before deciding ...
6121 \hbox to 1em{#1\hss}%
6124 % These macros generate individual entries in the table of contents.
6125 % The first argument is the chapter or section name.
6126 % The last argument is the page number.
6127 % The arguments in between are the chapter number, section number, ...
6129 % Parts, in the main contents. Replace the part number, which doesn't
6130 % exist, with an empty box. Let's hope all the numbers have the same width.
6131 % Also ignore the page number, which is conventionally not printed.
6132 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6133 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6135 % Parts, in the short toc.
6136 \def\shortpartentry#1#2#3#4{%
6138 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6139 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6142 % Chapters, in the main contents.
6143 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6145 % Chapters, in the short toc.
6146 % See comments in \dochapentry re vbox and related settings.
6147 \def\shortchapentry#1#2#3#4{%
6148 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6151 % Appendices, in the main contents.
6152 % Need the word Appendix, and a fixed-size box.
6154 \def\appendixbox#1{%
6155 % We use M since it's probably the widest letter.
6156 \setbox0 = \hbox{\putwordAppendix{} M}%
6157 \hbox to \wd0{\putwordAppendix{} #1\hss}}
6159 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6161 % Unnumbered chapters.
6162 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6163 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6166 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6167 \let\appsecentry=\numsecentry
6168 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6171 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6172 \let\appsubsecentry=\numsubsecentry
6173 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6175 % And subsubsections.
6176 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6177 \let\appsubsubsecentry=\numsubsubsecentry
6178 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6180 % This parameter controls the indentation of the various levels.
6181 % Same as \defaultparindent.
6182 \newdimen\tocindent \tocindent = 15pt
6184 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6187 % If the toc has to be broken over pages, we want it to be at chapters
6188 % if at all possible; hence the \penalty.
6189 \def\dochapentry#1#2{%
6190 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6193 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6195 \nobreak\vskip .25\baselineskip plus.1\baselineskip
6198 \def\dosecentry#1#2{\begingroup
6199 \secentryfonts \leftskip=\tocindent
6200 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6203 \def\dosubsecentry#1#2{\begingroup
6204 \subsecentryfonts \leftskip=2\tocindent
6205 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6208 \def\dosubsubsecentry#1#2{\begingroup
6209 \subsubsecentryfonts \leftskip=3\tocindent
6210 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6213 % We use the same \entry macro as for the index entries.
6214 \let\tocentry = \entry
6216 % Space between chapter (or whatever) number and the title.
6217 \def\labelspace{\hskip1em \relax}
6219 \def\dopageno#1{{\rm #1}}
6220 \def\doshortpageno#1{{\rm #1}}
6222 \def\chapentryfonts{\secfonts \rm}
6223 \def\secentryfonts{\textfonts}
6224 \def\subsecentryfonts{\textfonts}
6225 \def\subsubsecentryfonts{\textfonts}
6228 \message{environments,}
6229 % @foo ... @end foo.
6231 % @tex ... @end tex escapes into raw TeX temporarily.
6232 % One exception: @ is still an escape character, so that @end tex works.
6233 % But \@ or @@ will get a plain @ character.
6236 \setupmarkupstyle{tex}%
6237 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6238 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6239 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6250 % ' is active in math mode (mathcode"8000). So reset it, and all our
6251 % other math active characters (just in case), to plain's definitions.
6255 \let\bullet=\ptexbullet
6260 \let\equiv=\ptexequiv
6263 \let\indent=\ptexindent
6264 \let\noindent=\ptexnoindent
6271 \expandafter \let\csname top\endcsname=\ptextop % outer
6272 \let\frenchspacing=\plainfrenchspacing
6274 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6275 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6278 % There is no need to define \Etex.
6280 % Define @lisp ... @end lisp.
6281 % @lisp environment forms a group so it can rebind things,
6282 % including the definition of @end lisp (which normally is erroneous).
6284 % Amount to narrow the margins by for @lisp.
6285 \newskip\lispnarrowing \lispnarrowing=0.4in
6287 % This is the definition that ^^M gets inside @lisp, @example, and other
6288 % such environments. \null is better than a space, since it doesn't
6290 \def\lisppar{\null\endgraf}
6292 % This space is always present above and below environments.
6293 \newskip\envskipamount \envskipamount = 0pt
6295 % Make spacing and below environment symmetrical. We use \parskip here
6296 % to help in doing that, since in @example-like environments \parskip
6297 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6298 % start of the next paragraph will insert \parskip.
6300 \def\aboveenvbreak{{%
6301 % =10000 instead of <10000 because of a special case in \itemzzz and
6302 % \sectionheading, q.v.
6303 \ifnum \lastpenalty=10000 \else
6304 \advance\envskipamount by \parskip
6306 \ifdim\lastskip<\envskipamount
6308 % it's not a good place to break if the last penalty was \nobreak
6310 \ifnum\lastpenalty<10000 \penalty-50 \fi
6311 \vskip\envskipamount
6316 \let\afterenvbreak = \aboveenvbreak
6318 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6319 % also clear it, so that its embedded environments do the narrowing again.
6320 \let\nonarrowing=\relax
6322 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6323 % environment contents.
6324 \font\circle=lcircle10
6326 \newdimen\cartouter\newdimen\cartinner
6327 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6328 \circthick=\fontdimen8\circle
6330 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6331 \def\ctr{{\hskip 6pt\circle\char'010}}
6332 \def\cbl{{\circle\char'012\hskip -6pt}}
6333 \def\cbr{{\hskip 6pt\circle\char'011}}
6334 \def\carttop{\hbox to \cartouter{\hskip\lskip
6335 \ctl\leaders\hrule height\circthick\hfil\ctr
6337 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6338 \cbl\leaders\hrule height\circthick\hfil\cbr
6341 \newskip\lskip\newskip\rskip
6344 \ifhmode\par\fi % can't be in the midst of a paragraph.
6346 \lskip=\leftskip \rskip=\rightskip
6347 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6348 \cartinner=\hsize \advance\cartinner by-\lskip
6349 \advance\cartinner by-\rskip
6351 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6352 % side, and for 6pt waste from
6353 % each corner char, and rule thickness
6354 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6355 % Flag to tell @lisp, etc., not to narrow margin.
6356 \let\nonarrowing = t%
6358 % If this cartouche directly follows a sectioning command, we need the
6359 % \parskip glue (backspaced over by default) or the cartouche can
6360 % collide with the section heading.
6361 \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
6364 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6372 \baselineskip=\normbskip
6373 \lineskip=\normlskip
6376 \comment % For explanation, see the end of def\group.
6391 % This macro is called at the beginning of all the @example variants,
6393 \newdimen\nonfillparindent
6396 \hfuzz = 12pt % Don't be fussy
6397 \sepspaces % Make spaces be word-separators rather than space tokens.
6398 \let\par = \lisppar % don't ignore blank lines
6399 \obeylines % each line of input is a line of output
6401 % Turn off paragraph indentation but redefine \indent to emulate
6402 % the normal \indent.
6403 \nonfillparindent=\parindent
6405 \let\indent\nonfillindent
6407 \emergencystretch = 0pt % don't try to avoid overfull boxes
6408 \ifx\nonarrowing\relax
6409 \advance \leftskip by \lispnarrowing
6410 \exdentamount=\lispnarrowing
6412 \let\nonarrowing = \relax
6414 \let\exdent=\nofillexdent
6419 % We want to swallow spaces (but not other tokens) after the fake
6420 % @indent in our nonfill-environments, where spaces are normally
6421 % active and set to @tie, resulting in them not being ignored after
6423 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6424 \gdef\nonfillindentcheck{%
6426 \expandafter\nonfillindentgobble%
6428 \leavevmode\nonfillindentbox%
6432 \def\nonfillindentgobble#1{\nonfillindent}
6433 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6435 % If you want all examples etc. small: @set dispenvsize small.
6436 % If you want even small examples the full size: @set dispenvsize nosmall.
6437 % This affects the following displayed environments:
6438 % @example, @display, @format, @lisp
6440 \def\smallword{small}
6441 \def\nosmallword{nosmall}
6442 \let\SETdispenvsize\relax
6443 \def\setnormaldispenv{%
6444 \ifx\SETdispenvsize\smallword
6445 % end paragraph for sake of leading, in case document has no blank
6446 % line. This is redundant with what happens in \aboveenvbreak, but
6447 % we need to do it before changing the fonts, and it's inconvenient
6448 % to change the fonts afterward.
6449 \ifnum \lastpenalty=10000 \else \endgraf \fi
6450 \smallexamplefonts \rm
6453 \def\setsmalldispenv{%
6454 \ifx\SETdispenvsize\nosmallword
6456 \ifnum \lastpenalty=10000 \else \endgraf \fi
6457 \smallexamplefonts \rm
6461 % We often define two environments, @foo and @smallfoo.
6462 % Let's do it in one command. #1 is the env name, #2 the definition.
6463 \def\makedispenvdef#1#2{%
6464 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6465 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6466 \expandafter\let\csname E#1\endcsname \afterenvbreak
6467 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6470 % Define two environment synonyms (#1 and #2) for an environment.
6471 \def\maketwodispenvdef#1#2#3{%
6472 \makedispenvdef{#1}{#3}%
6473 \makedispenvdef{#2}{#3}%
6476 % @lisp: indented, narrowed, typewriter font;
6477 % @example: same as @lisp.
6479 % @smallexample and @smalllisp: use smaller fonts.
6480 % Originally contributed by Pavel@xerox.
6482 \maketwodispenvdef{lisp}{example}{%
6484 \tt\setupmarkupstyle{example}%
6485 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6486 \gobble % eat return
6488 % @display/@smalldisplay: same as @lisp except keep current font.
6490 \makedispenvdef{display}{%
6495 % @format/@smallformat: same as @display except don't narrow margins.
6497 \makedispenvdef{format}{%
6498 \let\nonarrowing = t%
6503 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6505 \let\nonarrowing = t%
6509 \let\Eflushleft = \afterenvbreak
6513 \envdef\flushright{%
6514 \let\nonarrowing = t%
6516 \advance\leftskip by 0pt plus 1fill\relax
6519 \let\Eflushright = \afterenvbreak
6522 % @raggedright does more-or-less normal line breaking but no right
6523 % justification. From plain.tex.
6524 \envdef\raggedright{%
6525 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6527 \let\Eraggedright\par
6529 \envdef\raggedleft{%
6530 \parindent=0pt \leftskip0pt plus2em
6531 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6532 \hbadness=10000 % Last line will usually be underfull, so turn off
6533 % badness reporting.
6535 \let\Eraggedleft\par
6537 \envdef\raggedcenter{%
6538 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6539 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6540 \hbadness=10000 % Last line will usually be underfull, so turn off
6541 % badness reporting.
6543 \let\Eraggedcenter\par
6546 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6547 % and narrows the margins. We keep \parskip nonzero in general, since
6548 % we're doing normal filling. So, when using \aboveenvbreak and
6549 % \afterenvbreak, temporarily make \parskip 0.
6551 \makedispenvdef{quotation}{\quotationstart}
6553 \def\quotationstart{%
6554 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6557 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6558 \ifx\nonarrowing\relax
6559 \advance\leftskip by \lispnarrowing
6560 \advance\rightskip by \lispnarrowing
6561 \exdentamount = \lispnarrowing
6563 \let\nonarrowing = \relax
6565 \parsearg\quotationlabel
6568 % We have retained a nonzero parskip for the environment, since we're
6569 % doing normal filling.
6573 \ifx\quotationauthor\thisisundefined\else
6575 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6577 {\parskip=0pt \afterenvbreak}%
6579 \def\Esmallquotation{\Equotation}
6581 % If we're given an argument, typeset it in bold with a colon after.
6582 \def\quotationlabel#1{%
6584 \ifx\temp\empty \else
6590 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6591 % If we want to allow any <char> as delimiter,
6592 % we need the curly braces so that makeinfo sees the @verb command, eg:
6593 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6595 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6597 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6598 % active too. Otherwise, they get lost as the first character on a
6601 \do\ \do\\\do\{\do\}\do\$\do\&%
6602 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6603 \do\<\do\>\do\|\do\@\do+\do\"%
6604 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6605 % @set txicodequotebacktick will not have effect on @verb and
6606 % @verbatim, and ?` and !` ligatures won't get disabled.
6611 \def\uncatcodespecials{%
6612 \def\do##1{\catcode`##1=\other}\dospecials}
6614 % Setup for the @verb command.
6616 % Eight spaces for a tab
6618 \catcode`\^^I=\active
6619 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6623 \tt % easiest (and conventionally used) font for verbatim
6624 \def\par{\leavevmode\endgraf}%
6625 \setupmarkupstyle{verb}%
6627 % Respect line breaks,
6628 % print special symbols as themselves, and
6629 % make each space count
6630 % must do in this order:
6631 \obeylines \uncatcodespecials \sepspaces
6634 % Setup for the @verbatim environment
6636 % Real tab expansion.
6637 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6639 % We typeset each line of the verbatim in an \hbox, so we can handle
6640 % tabs. The \global is in case the verbatim line starts with an accent,
6641 % or some other command that starts with a begin-group. Otherwise, the
6642 % entire \verbbox would disappear at the corresponding end-group, before
6643 % it is typeset. Meanwhile, we can't have nested verbatim commands
6644 % (can we?), so the \global won't be overwriting itself.
6646 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
6649 \catcode`\^^I=\active
6651 \catcode`\^^I=\active
6652 \def^^I{\leavevmode\egroup
6653 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
6654 \divide\dimen\verbbox by\tabw
6655 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
6656 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
6657 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
6662 % start the verbatim environment.
6663 \def\setupverbatim{%
6664 \let\nonarrowing = t%
6666 \tt % easiest (and conventionally used) font for verbatim
6667 % The \leavevmode here is for blank lines. Otherwise, we would
6668 % never \starttabox and the \egroup would end verbatim mode.
6669 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6671 \setupmarkupstyle{verbatim}%
6672 % Respect line breaks,
6673 % print special symbols as themselves, and
6674 % make each space count.
6675 % Must do in this order:
6676 \obeylines \uncatcodespecials \sepspaces
6677 \everypar{\starttabbox}%
6680 % Do the @verb magic: verbatim text is quoted by unique
6681 % delimiter characters. Before first delimiter expect a
6682 % right brace, after last delimiter expect closing brace:
6684 % \def\doverb'{'<char>#1<char>'}'{#1}
6686 % [Knuth] p. 382; only eat outer {}
6688 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6689 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6692 \def\verb{\begingroup\setupverb\doverb}
6695 % Do the @verbatim magic: define the macro \doverbatim so that
6696 % the (first) argument ends when '@end verbatim' is reached, ie:
6698 % \def\doverbatim#1@end verbatim{#1}
6700 % For Texinfo it's a lot easier than for LaTeX,
6701 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6702 % we need not redefine '\', '{' and '}'.
6704 % Inspired by LaTeX's verbatim command set [latex.ltx]
6709 % ignore everything up to the first ^^M, that's the newline at the end
6710 % of the @verbatim input line itself. Otherwise we get an extra blank
6711 % line in the output.
6712 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6713 % We really want {...\end verbatim} in the body of the macro, but
6714 % without the active space; thus we have to use \xdef and \gobble.
6718 \setupverbatim\doverbatim
6720 \let\Everbatim = \afterenvbreak
6723 % @verbatiminclude FILE - insert text of file in verbatim environment.
6725 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6727 \def\doverbatiminclude#1{%
6729 \makevalueexpandable
6731 \indexnofonts % Allow `@@' and other weird things in file names.
6732 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
6738 % @copying ... @end copying.
6739 % Save the text away for @insertcopying later.
6741 % We save the uninterpreted tokens, rather than creating a box.
6742 % Saving the text in a box would be much easier, but then all the
6743 % typesetting commands (@smallbook, font changes, etc.) have to be done
6744 % beforehand -- and a) we want @copying to be done first in the source
6745 % file; b) letting users define the frontmatter in as flexible order as
6746 % possible is very desirable.
6748 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6749 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6751 \def\insertcopying{%
6753 \parindent = 0pt % paragraph indentation looks wrong on title page
6754 \scanexp\copyingtext
6762 \newskip\defbodyindent \defbodyindent=.4in
6763 \newskip\defargsindent \defargsindent=50pt
6764 \newskip\deflastargmargin \deflastargmargin=18pt
6765 \newcount\defunpenalty
6767 % Start the processing of @deffn:
6769 \ifnum\lastpenalty<10000
6771 \defunpenalty=10003 % Will keep this @deffn together with the
6772 % following @def command, see below.
6774 % If there are two @def commands in a row, we'll have a \nobreak,
6775 % which is there to keep the function description together with its
6776 % header. But if there's nothing but headers, we need to allow a
6777 % break somewhere. Check specifically for penalty 10002, inserted
6778 % by \printdefunline, instead of 10000, since the sectioning
6779 % commands also insert a nobreak penalty, and we don't want to allow
6780 % a break between a section heading and a defun.
6782 % As a further refinement, we avoid "club" headers by signalling
6783 % with penalty of 10003 after the very first @deffn in the
6784 % sequence (see above), and penalty of 10002 after any following
6786 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6788 % Similarly, after a section heading, do not allow a break.
6789 % But do insert the glue.
6790 \medskip % preceded by discardable penalty, so not a breakpoint
6794 \advance\leftskip by \defbodyindent
6795 \exdentamount=\defbodyindent
6799 % First, check whether we are in the right environment:
6802 % As above, allow line break if we have multiple x headers in a row.
6803 % It's not a great place, though.
6804 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6806 % And now, it's time to reuse the body of the original defun:
6807 \expandafter\gobbledefun#1%
6809 \def\gobbledefun#1\startdefun{}
6811 % \printdefunline \deffnheader{text}
6813 \def\printdefunline#1#2{%
6815 % call \deffnheader:
6818 \interlinepenalty = 10000
6819 \advance\rightskip by 0pt plus 1fil\relax
6821 \nobreak\vskip -\parskip
6822 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6823 % Some of the @defun-type tags do not enable magic parentheses,
6824 % rendering the following check redundant. But we don't optimize.
6829 \def\Edefun{\endgraf\medbreak}
6831 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6832 % the only thing remaining is to define \deffnheader.
6835 \expandafter\let\csname E#1\endcsname = \Edefun
6836 \edef\temp{\noexpand\domakedefun
6837 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6841 % \domakedefun \deffn \deffnx \deffnheader
6843 % Define \deffn and \deffnx, without parameters.
6844 % \deffnheader has to be defined explicitly.
6846 \def\domakedefun#1#2#3{%
6849 \doingtypefnfalse % distinguish typed functions from all else
6850 \parseargusing\activeparens{\printdefunline#3}%
6852 \def#2{\dodefunx#1}%
6856 \newif\ifdoingtypefn % doing typed function?
6857 \newif\ifrettypeownline % typeset return type on its own line?
6859 % @deftypefnnewline on|off says whether the return type of typed functions
6860 % are printed on their own line. This affects @deftypefn, @deftypefun,
6861 % @deftypeop, and @deftypemethod.
6863 \parseargdef\deftypefnnewline{%
6866 \expandafter\let\csname SETtxideftypefnnl\endcsname
6868 \else\ifx\temp\offword
6869 \expandafter\let\csname SETtxideftypefnnl\endcsname
6872 \errhelp = \EMsimple
6873 \errmessage{Unknown @txideftypefnnl value `\temp',
6878 % Untyped functions:
6880 % @deffn category name args
6881 \makedefun{deffn}{\deffngeneral{}}
6883 % @deffn category class name args
6884 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6886 % \defopon {category on}class name args
6887 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6889 % \deffngeneral {subind}category name args
6891 \def\deffngeneral#1#2 #3 #4\endheader{%
6892 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6893 \dosubind{fn}{\code{#3}}{#1}%
6894 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6899 % @deftypefn category type name args
6900 \makedefun{deftypefn}{\deftypefngeneral{}}
6902 % @deftypeop category class type name args
6903 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6905 % \deftypeopon {category on}class type name args
6906 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6908 % \deftypefngeneral {subind}category type name args
6910 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6911 \dosubind{fn}{\code{#4}}{#1}%
6913 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6918 % @deftypevr category type var args
6919 \makedefun{deftypevr}{\deftypecvgeneral{}}
6921 % @deftypecv category class type var args
6922 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6924 % \deftypecvof {category of}class type var args
6925 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6927 % \deftypecvgeneral {subind}category type var args
6929 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6930 \dosubind{vr}{\code{#4}}{#1}%
6931 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6934 % Untyped variables:
6936 % @defvr category var args
6937 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6939 % @defcv category class var args
6940 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6942 % \defcvof {category of}class var args
6943 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6947 % @deftp category name args
6948 \makedefun{deftp}#1 #2 #3\endheader{%
6949 \doind{tp}{\code{#2}}%
6950 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6953 % Remaining @defun-like shortcuts:
6954 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6955 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6956 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6957 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6958 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6959 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6960 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6961 \makedefun{defmethod}{\defopon\putwordMethodon}
6962 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6963 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6964 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6966 % \defname, which formats the name of the @def (not the args).
6967 % #1 is the category, such as "Function".
6968 % #2 is the return type, if any.
6969 % #3 is the function name.
6971 % We are followed by (but not passed) the arguments, if any.
6973 \def\defname#1#2#3{%
6975 % Get the values of \leftskip and \rightskip as they were outside the @def...
6976 \advance\leftskip by -\defbodyindent
6978 % Determine if we are typesetting the return type of a typed function
6979 % on a line by itself.
6980 \rettypeownlinefalse
6981 \ifdoingtypefn % doing a typed function specifically?
6982 % then check user option for putting return type on its own line:
6983 \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
6988 % How we'll format the category name. Putting it in brackets helps
6989 % distinguish it from the body text that may end up on the next line
6992 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6994 % Figure out line sizes for the paragraph shape. We'll always have at
6998 % The first line needs space for \box0; but if \rightskip is nonzero,
6999 % we need only space for the part of \box0 which exceeds it:
7000 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
7002 % If doing a return type on its own line, we'll have another line.
7004 \advance\tempnum by 1
7005 \def\maybeshapeline{0in \hsize}%
7007 \def\maybeshapeline{}%
7010 % The continuations:
7011 \dimen2=\hsize \advance\dimen2 by -\defargsindent
7013 % The final paragraph shape:
7014 \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2
7016 % Put the category name at the right margin.
7019 \hfil\box0 \kern-\hsize
7020 % \hsize has to be shortened this way:
7022 % Intentionally do not respect \rightskip, since we need the space.
7025 % Allow all lines to be underfull without complaint:
7026 \tolerance=10000 \hbadness=10000
7027 \exdentamount=\defbodyindent
7029 % defun fonts. We use typewriter by default (used to be bold) because:
7030 % . we're printing identifiers, they should be in tt in principle.
7031 % . in languages with many accents, such as Czech or French, it's
7032 % common to leave accents off identifiers. The result looks ok in
7033 % tt, but exceedingly strange in rm.
7034 % . we don't want -- and --- to be treated as ligatures.
7035 % . this still does not fix the ?` and !` ligatures, but so far no
7036 % one has made identifiers using them :).
7038 \def\temp{#2}% text of the return type
7039 \ifx\temp\empty\else
7040 \tclose{\temp}% typeset the return type
7042 % put return type on its own line; prohibit line break following:
7043 \hfil\vadjust{\nobreak}\break
7045 \space % type on same line, so just followed by a space
7047 \fi % no return type
7048 #3% output function name
7050 {\rm\enskip}% hskip 0.5 em of \tenrm
7053 % arguments will be output next, if any.
7056 % Print arguments in slanted roman (not ttsl), inconsistently with using
7057 % tt for the name. This is because literal text is sometimes needed in
7058 % the argument list (groff manual), and ttsl and tt are not very
7059 % distinguishable. Prevent hyphenation at `-' chars.
7062 % use sl by default (not ttsl),
7064 \df \sl \hyphenchar\font=0
7066 % On the other hand, if an argument has two dashes (for instance), we
7067 % want a way to get ttsl. Let's try @var for that.
7068 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
7070 \sl\hyphenchar\font=45
7073 % We want ()&[] to print specially on the defun line.
7076 \catcode`\(=\active \catcode`\)=\active
7077 \catcode`\[=\active \catcode`\]=\active
7081 % Make control sequences which act like normal parenthesis chars.
7082 \let\lparen = ( \let\rparen = )
7084 % Be sure that we always have a definition for `(', etc. For example,
7085 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7086 % so TeX would otherwise complain about undefined control sequence.
7089 \global\let(=\lparen \global\let)=\rparen
7090 \global\let[=\lbrack \global\let]=\rbrack
7093 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7094 \gdef\magicamp{\let&=\amprm}
7097 \newcount\parencount
7099 % If we encounter &foo, then turn on ()-hacking afterwards
7101 \def\amprm#1 {\ampseentrue{\bf\ }}
7105 % At the first level, print parens in roman,
7106 % otherwise use the default font.
7107 \ifnum \parencount=1 \rm \fi
7109 % The \sf parens (in \boldbrax) actually are a little bolder than
7110 % the contained text. This is especially needed for [ and ] .
7114 \def\infirstlevel#1{%
7121 \def\bfafterword#1 {#1 \bf}
7124 \global\advance\parencount by 1
7126 \infirstlevel \bfafterword
7131 \global\advance\parencount by -1
7134 \newcount\brackcount
7136 \global\advance\brackcount by 1
7141 \global\advance\brackcount by -1
7144 \def\checkparencounts{%
7145 \ifnum\parencount=0 \else \badparencount \fi
7146 \ifnum\brackcount=0 \else \badbrackcount \fi
7148 % these should not use \errmessage; the glibc manual, at least, actually
7149 % has such constructs (when documenting function pointers).
7150 \def\badparencount{%
7151 \message{Warning: unbalanced parentheses in @def...}%
7152 \global\parencount=0
7154 \def\badbrackcount{%
7155 \message{Warning: unbalanced square brackets in @def...}%
7156 \global\brackcount=0
7163 % To do this right we need a feature of e-TeX, \scantokens,
7164 % which we arrange to emulate with a temporary file in ordinary TeX.
7165 \ifx\eTeXversion\thisisundefined
7166 \newwrite\macscribble
7169 \immediate\openout\macscribble=\jobname.tmp
7170 \immediate\write\macscribble{\the\toks0}%
7171 \immediate\closeout\macscribble
7176 \def\scanmacro#1{\begingroup
7178 \let\xeatspaces\eatspaces
7180 % Undo catcode changes of \startcontents and \doprintindex
7181 % When called from @insertcopying or (short)caption, we need active
7182 % backslash to get it printed correctly. Previously, we had
7183 % \catcode`\\=\other instead. We'll see whether a problem appears
7184 % with macro expansion. --kasal, 19aug04
7185 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
7187 % ... and for \example:
7190 % The \empty here causes a following catcode 5 newline to be eaten as
7191 % part of reading whitespace after a control sequence. It does not
7192 % eat a catcode 13 newline. There's no good way to handle the two
7193 % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
7194 % would then have different behavior). See the Macro Details node in
7195 % the manual for the workaround we recommend for macros and
7196 % line-oriented commands.
7198 \scantokens{#1\empty}%
7202 \edef\temp{\noexpand\scanmacro{#1}}%
7206 \newcount\paramno % Count of parameters
7207 \newtoks\macname % Macro name
7208 \newif\ifrecursive % Is it recursive?
7210 % List of all defined macros in the form
7211 % \definedummyword\macro1\definedummyword\macro2...
7212 % Currently is also contains all @aliases; the list can be split
7213 % if there is a need.
7216 % Add the macro to \macrolist
7217 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7218 \def\addtomacrolistxxx#1{%
7219 \toks0 = \expandafter{\macrolist\definedummyword#1}%
7220 \xdef\macrolist{\the\toks0}%
7224 % This does \let #1 = #2, with \csnames; that is,
7225 % \let \csname#1\endcsname = \csname#2\endcsname
7226 % (except of course we have to play expansion games).
7230 \csname#1\expandafter\endcsname
7234 % Trim leading and trailing spaces off a string.
7235 % Concepts from aro-bend problem 15 (see CTAN).
7237 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
7238 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
7239 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
7241 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
7244 % Trim a single trailing ^^M off a string.
7245 {\catcode`\^^M=\other \catcode`\Q=3%
7246 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
7247 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
7248 \gdef\eatcrb#1Q#2Q{#1}%
7251 % Macro bodies are absorbed as an argument in a context where
7252 % all characters are catcode 10, 11 or 12, except \ which is active
7253 % (as in normal texinfo). It is necessary to change the definition of \
7254 % to recognize macro arguments; this is the job of \mbodybackslash.
7256 % Non-ASCII encodings make 8-bit characters active, so un-activate
7257 % them to avoid their expansion. Must do this non-globally, to
7258 % confine the change to the current group.
7260 % It's necessary to have hard CRs when the macro is executed. This is
7261 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7262 % body, and then making it the \newlinechar in \scanmacro.
7264 \def\scanctxt{% used as subroutine
7274 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7277 \def\scanargctxt{% used for copying and captions, not macros.
7280 \catcode`\^^M=\other
7283 \def\macrobodyctxt{% used for @macro definitions
7287 \catcode`\^^M=\other
7291 % LilyPond CHANGE: The following definition has been reverted to the
7292 % original definition since it was problematic in the context of
7295 \def\macroargctxt{% used when scanning invocations
7300 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
7301 % for the single characters \ { }. Thus, we end up with the "commands"
7302 % that would be written @\ @{ @} in a Texinfo document.
7304 % We already have @{ and @}. For @\, we define it here, and only for
7305 % this purpose, to produce a typewriter backslash (so, the @\ that we
7306 % define for @math can't be used with @macro calls):
7308 \def\\{\normalbackslash}%
7310 % We would like to do this for \, too, since that is what makeinfo does.
7311 % But it is not possible, because Texinfo already has a command @, for a
7312 % cedilla accent. Documents must use @comma{} instead.
7314 % \anythingelse will almost certainly be an error of some kind.
7317 % \mbodybackslash is the definition of \ in @macro bodies.
7318 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7319 % where N is the macro parameter number.
7320 % We define \csname macarg.\endcsname to be \realbackslash, so
7321 % \\ in macro replacement text gets you a backslash.
7323 {\catcode`@=0 @catcode`@\=@active
7324 @gdef@usembodybackslash{@let\=@mbodybackslash}
7325 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
7327 \expandafter\def\csname macarg.\endcsname{\realbackslash}
7329 \def\margbackslash#1{\char`\#1 }
7331 \def\macro{\recursivefalse\parsearg\macroxxx}
7332 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7335 \getargs{#1}% now \macname is the macname and \argl the arglist
7336 \ifx\argl\empty % no arguments
7339 \expandafter\parsemargdef \argl;%
7340 \if\paramno>256\relax
7341 \ifx\eTeXversion\thisisundefined
7342 \errhelp = \EMsimple
7343 \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
7347 \if1\csname ismacro.\the\macname\endcsname
7348 \message{Warning: redefining \the\macname}%
7350 \expandafter\ifx\csname \the\macname\endcsname \relax
7351 \else \errmessage{Macro name \the\macname\space already defined}\fi
7352 \global\cslet{macsave.\the\macname}{\the\macname}%
7353 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7354 \addtomacrolist{\the\macname}%
7356 \begingroup \macrobodyctxt
7357 \ifrecursive \expandafter\parsermacbody
7358 \else \expandafter\parsemacbody
7361 \parseargdef\unmacro{%
7362 \if1\csname ismacro.#1\endcsname
7363 \global\cslet{#1}{macsave.#1}%
7364 \global\expandafter\let \csname ismacro.#1\endcsname=0%
7365 % Remove the macro name from \macrolist:
7367 \expandafter\let\csname#1\endcsname \relax
7368 \let\definedummyword\unmacrodo
7369 \xdef\macrolist{\macrolist}%
7372 \errmessage{Macro #1 not defined}%
7376 % Called by \do from \dounmacro on each macro. The idea is to omit any
7377 % macro definitions that have been changed to \relax.
7383 \noexpand\definedummyword \noexpand#1%
7387 % This makes use of the obscure feature that if the last token of a
7388 % <parameter list> is #, then the preceding argument is delimited by
7389 % an opening brace, and that opening brace is not consumed.
7390 \def\getargs#1{\getargsxxx#1{}}
7391 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7392 \def\getmacname#1 #2\relax{\macname={#1}}
7393 \def\getmacargs#1{\def\argl{#1}}
7395 % For macro processing make @ a letter so that we can make Texinfo private macro names.
7396 \edef\texiatcatcode{\the\catcode`\@}
7397 \catcode `@=11\relax
7399 % Parse the optional {params} list. Set up \paramno and \paramlist
7400 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
7401 % in the params list to some hook where the argument si to be expanded. If
7402 % there are less than 10 arguments that hook is to be replaced by ##N where N
7403 % is the position in that list, that is to say the macro arguments are to be
7404 % defined `a la TeX in the macro body.
7406 % That gets used by \mbodybackslash (above).
7408 % We need to get `macro parameter char #' into several definitions.
7409 % The technique used is stolen from LaTeX: let \hash be something
7410 % unexpandable, insert that wherever you need a #, and then redefine
7411 % it to # just before using the token list produced.
7413 % The same technique is used to protect \eatspaces till just before
7414 % the macro is used.
7416 % If there are 10 or more arguments, a different technique is used, where the
7417 % hook remains in the body, and when macro is to be expanded the body is
7418 % processed again to replace the arguments.
7420 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7421 % argument N value and then \edef the body (nothing else will expand because of
7422 % the catcode regime underwhich the body was input).
7424 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7425 % arguments, you need that no macro has more than 256 arguments, otherwise an
7426 % error is produced.
7427 \def\parsemargdef#1;{%
7428 \paramno=0\def\paramlist{}%
7430 \let\xeatspaces\relax
7431 \parsemargdefxxx#1,;,%
7432 % In case that there are 10 or more arguments we parse again the arguments
7433 % list to set new definitions for the \macarg.BLAH macros corresponding to
7434 % each BLAH argument. It was anyhow needed to parse already once this list
7435 % in order to count the arguments, and as macros with at most 9 arguments
7436 % are by far more frequent than macro with 10 or more arguments, defining
7437 % twice the \macarg.BLAH macros does not cost too much processing power.
7438 \ifnum\paramno<10\relax\else
7440 \parsemmanyargdef@@#1,;,% 10 or more arguments
7443 \def\parsemargdefxxx#1,{%
7444 \if#1;\let\next=\relax
7445 \else \let\next=\parsemargdefxxx
7446 \advance\paramno by 1
7447 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7448 {\xeatspaces{\hash\the\paramno}}%
7449 \edef\paramlist{\paramlist\hash\the\paramno,}%
7452 \def\parsemmanyargdef@@#1,{%
7453 \if#1;\let\next=\relax
7455 \let\next=\parsemmanyargdef@@
7456 \edef\tempb{\eatspaces{#1}}%
7457 \expandafter\def\expandafter\tempa
7458 \expandafter{\csname macarg.\tempb\endcsname}%
7459 % Note that we need some extra \noexpand\noexpand, this is because we
7460 % don't want \the to be expanded in the \parsermacbody as it uses an
7462 \expandafter\edef\tempa
7463 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7464 \advance\paramno by 1\relax
7467 % These two commands read recursive and nonrecursive macro bodies.
7468 % (They're different since rec and nonrec macros end differently.)
7471 \catcode `\@\texiatcatcode
7472 \long\def\parsemacbody#1@end macro%
7473 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7474 \long\def\parsermacbody#1@end rmacro%
7475 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7476 \catcode `\@=11\relax
7481 \long\def\nillm@{\nil@}%
7483 % This macro is expanded during the Texinfo macro expansion, not during its
7484 % definition. It gets all the arguments values and assigns them to macros
7487 % #1 is the macro name
7488 % #2 is the list of argument names
7489 % #3 is the list of argument values
7490 \def\getargvals@#1#2#3{%
7491 \def\macargdeflist@{}%
7492 \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
7493 \def\paramlist{#2,\nil@}%
7497 \def\argvaluelist{#3,\nil@}%
7508 \ifx\paramlist\nilm@
7509 % Some sanity check needed here that \argvaluelist is also empty.
7510 \ifx\argvaluelist\nillm@
7512 \errhelp = \EMsimple
7513 \errmessage{Too many arguments in macro `\macroname'!}%
7515 \let\next\macargexpandinbody@
7517 \ifx\argvaluelist\nillm@
7518 % No more arguments values passed to macro. Set remaining named-arg
7520 \let\next\setemptyargvalues@
7522 % pop current arg name into \@tempb
7523 \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
7524 \expandafter\@tempa\expandafter{\paramlist}%
7525 % pop current argument value into \@tempc
7526 \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
7527 \expandafter\@tempa\expandafter{\argvaluelist}%
7528 % Here \@tempb is the current arg name and \@tempc is the current arg value.
7529 % First place the new argument macro definition into \@tempd
7530 \expandafter\macname\expandafter{\@tempc}%
7531 \expandafter\let\csname macarg.\@tempb\endcsname\relax
7532 \expandafter\def\expandafter\@tempe\expandafter{%
7533 \csname macarg.\@tempb\endcsname}%
7534 \edef\@tempd{\long\def\@tempe{\the\macname}}%
7535 \push@\@tempd\macargdeflist@
7536 \let\next\getargvals@@
7543 \expandafter\expandafter\expandafter\def
7544 \expandafter\expandafter\expandafter#2%
7545 \expandafter\expandafter\expandafter{%
7549 % Replace arguments by their values in the macro body, and place the result
7551 \def\macvalstoargs@{%
7552 % To do this we use the property that token registers that are \the'ed
7553 % within an \edef expand only once. So we are going to place all argument
7554 % values into respective token registers.
7556 % First we save the token context, and initialize argument numbering.
7559 % Then, for each argument number #N, we place the corresponding argument
7560 % value into a new token list register \toks#N
7561 \expandafter\putargsintokens@\saveparamlist@,;,%
7562 % Then, we expand the body so that argument are replaced by their
7563 % values. The trick for values not to be expanded themselves is that they
7564 % are within tokens and that tokens expand only once in an \edef .
7565 \edef\@tempc{\csname mac.\macroname .body\endcsname}%
7566 % Now we restore the token stack pointer to free the token list registers
7567 % which we have used, but we make sure that expanded body is saved after
7571 \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
7574 \def\macargexpandinbody@{%
7575 %% Define the named-macro outside of this group and then close this group.
7579 % First the replace in body the macro arguments by their values, the result
7582 % Then we point at the \norecurse or \gobble (for recursive) macro value
7584 \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
7585 % Depending on whether it is recursive or not, we need some tailing
7592 % And now we do the real job:
7593 \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
7597 \def\putargsintokens@#1,{%
7598 \if#1;\let\next\relax
7600 \let\next\putargsintokens@
7601 % First we allocate the new token list register, and give it a temporary
7603 \toksdef\@tempb\the\paramno
7604 % Then we place the argument value into that token list register.
7605 \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
7606 \expandafter\@tempb\expandafter{\@tempa}%
7607 \advance\paramno by 1\relax
7612 % Save the token stack pointer into macro #1
7613 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}}
7614 % Restore the token stack pointer from number in macro #1
7615 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax}
7616 % newtoks that can be used non \outer .
7617 \def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi}
7619 % Tailing missing arguments are set to empty
7620 \def\setemptyargvalues@{%
7621 \ifx\paramlist\nilm@
7622 \let\next\macargexpandinbody@
7624 \expandafter\setemptyargvaluesparser@\paramlist\endargs@
7625 \let\next\setemptyargvalues@
7630 \def\setemptyargvaluesparser@#1,#2\endargs@{%
7631 \expandafter\def\expandafter\@tempa\expandafter{%
7632 \expandafter\def\csname macarg.#1\endcsname{}}%
7633 \push@\@tempa\macargdeflist@
7637 % #1 is the element target macro
7638 % #2 is the list macro
7639 % #3,#4\endargs@ is the list value
7640 \def\pop@#1#2#3,#4\endargs@{%
7644 \long\def\longpop@#1#2#3,#4\endargs@{%
7649 % This defines a Texinfo @macro. There are eight cases: recursive and
7650 % nonrecursive macros of zero, one, up to nine, and many arguments.
7651 % Much magic with \expandafter here.
7652 % \xdef is used so that macro definitions will survive the file
7653 % they're defined in; @include reads the file inside a group.
7656 \let\hash=##% convert placeholders to macro parameter chars
7660 \expandafter\xdef\csname\the\macname\endcsname{%
7661 \noexpand\scanmacro{\temp}}%
7663 \expandafter\xdef\csname\the\macname\endcsname{%
7664 \bgroup\noexpand\macroargctxt
7665 \noexpand\braceorline
7666 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7667 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7668 \egroup\noexpand\scanmacro{\temp}}%
7670 \ifnum\paramno<10\relax % at most 9
7671 \expandafter\xdef\csname\the\macname\endcsname{%
7672 \bgroup\noexpand\macroargctxt
7673 \noexpand\csname\the\macname xx\endcsname}%
7674 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7675 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7676 \expandafter\expandafter
7678 \expandafter\expandafter
7679 \csname\the\macname xxx\endcsname
7680 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7682 \expandafter\xdef\csname\the\macname\endcsname{%
7683 \noexpand\getargvals@{\the\macname}{\argl}%
7685 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7686 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
7692 \expandafter\xdef\csname\the\macname\endcsname{%
7693 \noexpand\norecurse{\the\macname}%
7694 \noexpand\scanmacro{\temp}\egroup}%
7696 \expandafter\xdef\csname\the\macname\endcsname{%
7697 \bgroup\noexpand\macroargctxt
7698 \noexpand\braceorline
7699 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7700 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7702 \noexpand\norecurse{\the\macname}%
7703 \noexpand\scanmacro{\temp}\egroup}%
7705 \ifnum\paramno<10\relax
7706 \expandafter\xdef\csname\the\macname\endcsname{%
7707 \bgroup\noexpand\macroargctxt
7708 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7709 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7710 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7711 \expandafter\expandafter
7713 \expandafter\expandafter
7714 \csname\the\macname xxx\endcsname
7717 \noexpand\norecurse{\the\macname}%
7718 \noexpand\scanmacro{\temp}\egroup}%
7720 \expandafter\xdef\csname\the\macname\endcsname{%
7721 \noexpand\getargvals@{\the\macname}{\argl}%
7723 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7724 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
7729 \catcode `\@\texiatcatcode\relax
7731 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7733 % \braceorline decides whether the next nonwhitespace character is a
7734 % {. If so it reads up to the closing }, if not, it reads the whole
7735 % line. Whatever was read is then fed to the next control sequence
7736 % as an argument (by \parsebrace or \parsearg).
7738 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7739 \def\braceorlinexxx{%
7740 \ifx\nchar\bgroup\else
7741 \expandafter\parsearg
7746 % We need some trickery to remove the optional spaces around the equal
7747 % sign. Make them active and then expand them all to nothing.
7749 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7750 \def\aliasxxx #1{\aliasyyy#1\relax}
7751 \def\aliasyyy #1=#2\relax{%
7753 \expandafter\let\obeyedspace=\empty
7754 \addtomacrolist{#1}%
7755 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7761 \message{cross references,}
7764 \newif\ifhavexrefs % True if xref values are known.
7765 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7767 % @inforef is relatively simple.
7768 \def\inforef #1{\inforefzzz #1,,,,**}
7769 \def\inforefzzz #1,#2,#3,#4**{%
7770 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7771 node \samp{\ignorespaces#1{}}}
7773 % @node's only job in TeX is to define \lastnode, which is used in
7774 % cross-references. The @node line might or might not have commas, and
7775 % might or might not have spaces before the first comma, like:
7776 % @node foo , bar , ...
7777 % We don't want such trailing spaces in the node name.
7779 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7781 % also remove a trailing comma, in case of something like this:
7782 % @node Help-Cross, , , Cross-refs
7783 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7784 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7787 \let\lastnode=\empty
7789 % Write a cross-reference definition for the current node. #1 is the
7790 % type (Ynumbered, Yappendix, Ynothing).
7793 \ifx\lastnode\empty\else
7794 \setref{\lastnode}{#1}%
7795 \global\let\lastnode=\empty
7799 % @anchor{NAME} -- define xref target at arbitrary point.
7801 \newcount\savesfregister
7803 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7804 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7805 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7807 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7808 % anchor), which consists of three parts:
7809 % 1) NAME-title - the current sectioning name taken from \lastsection,
7810 % or the anchor name.
7811 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7812 % empty for anchors.
7813 % 3) NAME-pg - the page number.
7815 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7816 % floats, there is an additional part, which is not written here:
7817 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7823 \atdummies % preserve commands, but don't expand them
7824 \edef\writexrdef##1##2{%
7825 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7826 ##1}{##2}}% these are parameters of \writexrdef
7828 \toks0 = \expandafter{\lastsection}%
7829 \immediate \writexrdef{title}{\the\toks0 }%
7830 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7831 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
7836 % @xrefautosectiontitle on|off says whether @section(ing) names are used
7837 % automatically in xrefs, if the third arg is not explicitly specified.
7838 % This was provided as a "secret" @set xref-automatic-section-title
7839 % variable, now it's official.
7841 \parseargdef\xrefautomaticsectiontitle{%
7844 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7846 \else\ifx\temp\offword
7847 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7850 \errhelp = \EMsimple
7851 \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
7857 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7858 % the node name, #2 the name of the Info cross-reference, #3 the printed
7859 % node name, #4 the name of the Info file, #5 the name of the printed
7860 % manual. All but the node name can be omitted.
7862 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7863 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7864 \def\ref#1{\xrefX[#1,,,,,,,]}
7867 \newbox\printedrefnamebox
7868 \newbox\infofilenamebox
7869 \newbox\printedmanualbox
7871 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7874 % Get args without leading/trailing spaces.
7875 \def\printedrefname{\ignorespaces #3}%
7876 \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
7878 \def\infofilename{\ignorespaces #4}%
7879 \setbox\infofilenamebox = \hbox{\infofilename\unskip}%
7881 \def\printedmanual{\ignorespaces #5}%
7882 \setbox\printedmanualbox = \hbox{\printedmanual\unskip}%
7884 % If the printed reference name (arg #3) was not explicitly given in
7885 % the @xref, figure out what we want to use.
7886 \ifdim \wd\printedrefnamebox = 0pt
7887 % No printed node name was explicitly given.
7888 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
7889 % Not auto section-title: use node name inside the square brackets.
7890 \def\printedrefname{\ignorespaces #1}%
7892 % Auto section-title: use chapter/section title inside
7893 % the square brackets if we have it.
7894 \ifdim \wd\printedmanualbox > 0pt
7895 % It is in another manual, so we don't have it; use node name.
7896 \def\printedrefname{\ignorespaces #1}%
7899 % We (should) know the real title if we have the xref values.
7900 \def\printedrefname{\refx{#1-title}{}}%
7902 % Otherwise just copy the Info node name.
7903 \def\printedrefname{\ignorespaces #1}%
7909 % Make link in pdf output.
7913 \makevalueexpandable
7914 % This expands tokens, so do it after making catcode changes, so _
7915 % etc. don't get their TeX definitions. This ignores all spaces in
7916 % #4, including (wrongly) those in the middle of the filename.
7919 % This (wrongly) does not take account of leading or trailing
7920 % spaces in #1, which should be ignored.
7921 \edef\pdfxrefdest{#1}%
7922 \ifx\pdfxrefdest\empty
7923 \def\pdfxrefdest{Top}% no empty targets
7925 \txiescapepdf\pdfxrefdest % escape PDF special chars
7929 \startlink attr{/Border [0 0 0]}%
7930 \ifnum\filenamelength>0
7931 goto file{\the\filename.pdf} name{\pdfxrefdest}%
7933 goto name{\pdfmkpgn{\pdfxrefdest}}%
7936 \setcolor{\linkcolor}%
7939 % Float references are printed completely differently: "Figure 1.2"
7940 % instead of "[somenode], p.3". We distinguish them by the
7941 % LABEL-title being set to a magic string.
7943 % Have to otherify everything special to allow the \csname to
7944 % include an _ in the xref name, etc.
7947 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7948 \csname XR#1-title\endcsname
7950 \iffloat\Xthisreftitle
7951 % If the user specified the print name (third arg) to the ref,
7952 % print it instead of our usual "Figure 1.2".
7953 \ifdim\wd\printedrefnamebox = 0pt
7959 % If the user also gave the printed manual name (fifth arg), append
7961 \ifdim \wd\printedmanualbox > 0pt
7962 \space \putwordin{} \cite{\printedmanual}%
7965 % node/anchor (non-float) references.
7967 % If we use \unhbox to print the node names, TeX does not insert
7968 % empty discretionaries after hyphens, which means that it will not
7969 % find a line break at a hyphen in a node names. Since some manuals
7970 % are best written with fairly long node names, containing hyphens,
7971 % this is a loss. Therefore, we give the text of the node name
7972 % again, so it is as if TeX is seeing it for the first time.
7974 \ifdim \wd\printedmanualbox > 0pt
7975 % Cross-manual reference with a printed manual name.
7977 \crossmanualxref{\cite{\printedmanual\unskip}}%
7979 \else\ifdim \wd\infofilenamebox > 0pt
7980 % Cross-manual reference with only an info filename (arg 4), no
7981 % printed manual name (arg 5). This is essentially the same as
7982 % the case above; we output the filename, since we have nothing else.
7984 \crossmanualxref{\code{\infofilename\unskip}}%
7987 % Reference within this manual.
7989 % _ (for example) has to be the character _ for the purposes of the
7990 % control sequence corresponding to the node, but it has to expand
7991 % into the usual \leavevmode...\vrule stuff for purposes of
7992 % printing. So we \turnoffactive for the \refx-snt, back on for the
7993 % printing, back off for the \refx-pg.
7995 % Only output a following space if the -snt ref is nonempty; for
7996 % @unnumbered and @anchor, it won't be.
7997 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7998 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
8000 % output the `[mynode]' via the macro below so it can be overridden.
8001 \xrefprintnodename\printedrefname
8003 % But we always want a comma and a space:
8006 % output the `page 3'.
8007 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
8013 % Output a cross-manual xref to #1. Used just above (twice).
8015 % Only include the text "Section ``foo'' in" if the foo is neither
8016 % missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply
8017 % "see The Foo Manual", the idea being to refer to the whole manual.
8019 % But, this being TeX, we can't easily compare our node name against the
8020 % string "Top" while ignoring the possible spaces before and after in
8021 % the input. By adding the arbitrary 7sp below, we make it much less
8022 % likely that a real node name would have the same width as "Top" (e.g.,
8023 % in a monospaced font). Hopefully it will never happen in practice.
8025 % For the same basic reason, we retypeset the "Top" at every
8026 % reference, since the current font is indeterminate.
8028 \def\crossmanualxref#1{%
8029 \setbox\toprefbox = \hbox{Top\kern7sp}%
8030 \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8031 \ifdim \wd2 > 7sp % nonempty?
8032 \ifdim \wd2 = \wd\toprefbox \else % same as Top?
8033 \putwordSection{} ``\printedrefname'' \putwordin{}\space
8039 % This macro is called from \xrefX for the `[nodename]' part of xref
8040 % output. It's a separate macro only so it can be changed more easily,
8041 % since square brackets don't work well in some documents. Particularly
8042 % one that Bob is working on :).
8044 \def\xrefprintnodename#1{[#1]}
8046 % Things referred to by \setref.
8052 \putwordChapter@tie \the\chapno
8053 \else \ifnum\subsecno=0
8054 \putwordSection@tie \the\chapno.\the\secno
8055 \else \ifnum\subsubsecno=0
8056 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
8058 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
8063 \putwordAppendix@tie @char\the\appendixno{}%
8064 \else \ifnum\subsecno=0
8065 \putwordSection@tie @char\the\appendixno.\the\secno
8066 \else \ifnum\subsubsecno=0
8067 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
8070 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
8074 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
8075 % If its value is nonempty, SUFFIX is output afterward.
8081 \expandafter\global\expandafter\let\expandafter\thisrefX
8082 \csname XR#1\endcsname
8085 % If not defined, say something at least.
8086 \angleleft un\-de\-fined\angleright
8089 {\toks0 = {#1}% avoid expansion of possibly-complex value
8090 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
8093 \global\warnedxrefstrue
8094 \message{Cross reference values unknown; you must run TeX again.}%
8099 % It's defined, so just use it.
8102 #2% Output the suffix in any case.
8105 % This is the macro invoked by entries in the aux file. Usually it's
8106 % just a \def (we prepend XR to the control sequence name to avoid
8107 % collisions). But if this is a float type, we have more work to do.
8110 {% The node name might contain 8-bit characters, which in our current
8111 % implementation are changed to commands like @'e. Don't let these
8112 % mess up the control sequence name.
8115 \xdef\safexrefname{#1}%
8118 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
8120 % Was that xref control sequence that we just defined for a float?
8121 \expandafter\iffloat\csname XR\safexrefname\endcsname
8122 % it was a float, and we have the (safe) float type in \iffloattype.
8123 \expandafter\let\expandafter\floatlist
8124 \csname floatlist\iffloattype\endcsname
8126 % Is this the first time we've seen this float type?
8127 \expandafter\ifx\floatlist\relax
8128 \toks0 = {\do}% yes, so just \do
8130 % had it before, so preserve previous elements in list.
8131 \toks0 = \expandafter{\floatlist\do}%
8134 % Remember this xref in the control sequence \floatlistFLOATTYPE,
8135 % for later use in \listoffloats.
8136 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
8141 % Read the last existing aux file, if any. No error if none exists.
8144 \openin 1 \jobname.aux
8147 \global\havexrefstrue
8152 \def\setupdatafile{%
8153 \catcode`\^^@=\other
8154 \catcode`\^^A=\other
8155 \catcode`\^^B=\other
8156 \catcode`\^^C=\other
8157 \catcode`\^^D=\other
8158 \catcode`\^^E=\other
8159 \catcode`\^^F=\other
8160 \catcode`\^^G=\other
8161 \catcode`\^^H=\other
8162 \catcode`\^^K=\other
8163 \catcode`\^^L=\other
8164 \catcode`\^^N=\other
8165 \catcode`\^^P=\other
8166 \catcode`\^^Q=\other
8167 \catcode`\^^R=\other
8168 \catcode`\^^S=\other
8169 \catcode`\^^T=\other
8170 \catcode`\^^U=\other
8171 \catcode`\^^V=\other
8172 \catcode`\^^W=\other
8173 \catcode`\^^X=\other
8174 \catcode`\^^Z=\other
8175 \catcode`\^^[=\other
8176 \catcode`\^^\=\other
8177 \catcode`\^^]=\other
8178 \catcode`\^^^=\other
8179 \catcode`\^^_=\other
8180 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8181 % in xref tags, i.e., node names. But since ^^e4 notation isn't
8182 % supported in the main text, it doesn't seem desirable. Furthermore,
8183 % that is not enough: for node names that actually contain a ^
8184 % character, we would end up writing a line like this: 'xrdef {'hat
8185 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8186 % argument, and \hat is not an expandable control sequence. It could
8187 % all be worked out, but why? Either we support ^^ or we don't.
8189 % The other change necessary for this was to define \auxhat:
8190 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8191 % and then to call \auxhat in \setq.
8195 % Special characters. Should be turned off anyway, but...
8208 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
8210 % This is to support \ in node names and titles, since the \
8211 % characters end up in a \csname. It's easier than
8212 % leaving it active and making its active definition an actual \
8213 % character. What I don't understand is why it works in the *value*
8214 % of the xrdef. Seems like it should be a catcode12 \, and that
8215 % should not typeset properly. But it works, so I'm moving on for
8216 % now. --karl, 15jan04.
8219 % Make the characters 128-255 be printing characters.
8223 \catcode\count1=\other
8224 \advance\count1 by 1
8225 \ifnum \count1<256 \loop \fi
8229 % @ is our escape character in .aux files, and we need braces.
8235 \def\readdatafile#1{%
8242 \message{insertions,}
8243 % including footnotes.
8245 \newcount \footnoteno
8247 % The trailing space in the following definition for supereject is
8248 % vital for proper filling; pages come out unaligned when you do a
8249 % pagealignmacro call if that space before the closing brace is
8250 % removed. (Generally, numeric constants should always be followed by a
8251 % space to prevent strange expansion errors.)
8252 \def\supereject{\par\penalty -20000\footnoteno =0 }
8254 % @footnotestyle is meaningful for Info output only.
8255 \let\footnotestyle=\comment
8259 % Auto-number footnotes. Otherwise like plain.
8261 \let\indent=\ptexindent
8262 \let\noindent=\ptexnoindent
8263 \global\advance\footnoteno by \@ne
8264 \edef\thisfootno{$^{\the\footnoteno}$}%
8266 % In case the footnote comes at the end of a sentence, preserve the
8267 % extra spacing after we do the footnote number.
8269 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
8271 % Remove inadvertent blank space before typesetting the footnote number.
8277 % Don't bother with the trickery in plain.tex to not require the
8278 % footnote text as a parameter. Our footnotes don't need to be so general.
8280 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8281 % \parseargline) fails inside footnotes because the tokens are fixed when
8282 % the footnote is read. --karl, 16nov96.
8285 \insert\footins\bgroup
8286 % We want to typeset this text as a normal paragraph, even if the
8287 % footnote reference occurs in (for example) a display environment.
8288 % So reset some parameters.
8290 \interlinepenalty\interfootnotelinepenalty
8291 \splittopskip\ht\strutbox % top baseline for broken footnotes
8292 \splitmaxdepth\dp\strutbox
8293 \floatingpenalty\@MM
8298 \parindent\defaultparindent
8302 % Because we use hanging indentation in footnotes, a @noindent appears
8303 % to exdent this text, so make it be a no-op. makeinfo does not use
8304 % hanging indentation so @noindent can still be needed within footnote
8305 % text after an @example or the like (not that this is good style).
8306 \let\noindent = \relax
8308 % Hang the footnote text off the number. Use \everypar in case the
8309 % footnote extends for more than one paragraph.
8310 \everypar = {\hang}%
8311 \textindent{\thisfootno}%
8313 % Don't crash into the line above the footnote text. Since this
8314 % expands into a box, it must come within the paragraph, lest it
8315 % provide a place where TeX can split the footnote.
8318 % Invoke rest of plain TeX footnote routine.
8319 \futurelet\next\fo@t
8321 }%end \catcode `\@=11
8323 % In case a @footnote appears in a vbox, save the footnote text and create
8324 % the real \insert just after the vbox finished. Otherwise, the insertion
8326 % Similarly, if a @footnote appears inside an alignment, save the footnote
8327 % text to a box and make the \insert when a row of the table is finished.
8328 % And the same can be done for other insert classes. --kasal, 16nov03.
8330 % Replace the \insert primitive by a cheating macro.
8331 % Deeper inside, just make sure that the saved insertions are not spilled
8334 \def\startsavinginserts{%
8335 \ifx \insert\ptexinsert
8336 \let\insert\saveinsert
8338 \let\checkinserts\relax
8342 % This \insert replacement works for both \insert\footins{foo} and
8343 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8346 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8347 \afterassignment\next
8348 % swallow the left brace
8351 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
8352 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
8354 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8356 \def\placesaveins#1{%
8357 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8361 % eat @SAVE -- beware, all of them have catcode \other:
8363 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
8364 \gdef\gobblesave @SAVE{}
8368 \def\newsaveins #1{%
8369 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8372 \def\newsaveinsX #1{%
8373 \csname newbox\endcsname #1%
8374 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8379 \let\checkinserts\empty
8384 % @image. We use the macros from epsf.tex to support this.
8385 % If epsf.tex is not installed and @image is used, we complain.
8387 % Check for and read epsf.tex up front. If we read it only at @image
8388 % time, we might be inside a group, and then its definitions would get
8389 % undone and the next image would fail.
8390 \openin 1 = epsf.tex
8392 % Do not bother showing banner with epsf.tex v2.7k (available in
8393 % doc/epsf.tex and on ctan).
8394 \def\epsfannounce{\toks0 = }%
8399 % We will only complain once about lack of epsf.tex.
8400 \newif\ifwarnednoepsf
8401 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8402 work. It is also included in the Texinfo distribution, or you can get
8403 it from ftp://tug.org/tex/epsf.tex.}
8406 \ifx\epsfbox\thisisundefined
8407 \ifwarnednoepsf \else
8408 \errhelp = \noepsfhelp
8409 \errmessage{epsf.tex not found, images will be ignored}%
8410 \global\warnednoepsftrue
8413 \imagexxx #1,,,,,\finish
8417 % Arguments to @image:
8418 % #1 is (mandatory) image filename; we tack on .eps extension.
8419 % #2 is (optional) width, #3 is (optional) height.
8420 % #4 is (ignored optional) html alt text.
8421 % #5 is (ignored optional) extension.
8422 % #6 is just the usual extra ignored arg for parsing stuff.
8424 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
8425 \catcode`\^^M = 5 % in case we're inside an example
8426 \normalturnoffactive % allow _ et al. in names
8427 % If the image is by itself, center it.
8430 \else \ifx\centersub\centerV
8431 % for @center @image, we need a vbox so we can have our vertical space
8433 \vbox\bgroup % vbox has better behavior than vtop herev
8438 % Usually we'll have text after the image which will insert
8439 % \parskip glue, so insert it here too to equalize the space
8441 \nobreak\vskip\parskip
8445 % Leave vertical mode so that indentation from an enclosing
8446 % environment such as @quotation is respected.
8447 % However, if we're at the top level, we don't want the
8448 % normal paragraph indentation.
8449 % On the other hand, if we are in the case of @center @image, we don't
8450 % want to start a paragraph, which will create a hsize-width box and
8451 % eradicate the centering.
8452 \ifx\centersub\centerV\else \noindent \fi
8456 \dopdfimage{#1}{#2}{#3}%
8458 % \epsfbox itself resets \epsf?size at each figure.
8459 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
8460 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
8465 \medskip % space after a standalone image
8467 \ifx\centersub\centerV \egroup \fi
8471 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8472 % etc. We don't actually implement floating yet, we always include the
8473 % float "here". But it seemed the best name for the future.
8475 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
8477 % There may be a space before second and/or third parameter; delete it.
8478 \def\eatcommaspace#1, {#1,}
8480 % #1 is the optional FLOATTYPE, the text label for this float, typically
8481 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
8482 % this float will not be numbered and cannot be referred to.
8484 % #2 is the optional xref label. Also must be present for the float to
8487 % #3 is the optional positioning argument; for now, it is ignored. It
8488 % will somehow specify the positions allowed to float to (here, top, bottom).
8490 % We keep a separate counter for each FLOATTYPE, which we reset at each
8491 % chapter-level command.
8492 \let\resetallfloatnos=\empty
8494 \def\dofloat#1,#2,#3,#4\finish{%
8495 \let\thiscaption=\empty
8496 \let\thisshortcaption=\empty
8498 % don't lose footnotes inside @float.
8500 % BEWARE: when the floats start float, we have to issue warning whenever an
8501 % insert appears inside a float which could possibly float. --kasal, 26may04
8505 % We can't be used inside a paragraph.
8510 \def\floatlabel{#2}%
8511 \def\floatloc{#3}% we do nothing with this yet.
8513 \ifx\floattype\empty
8514 \let\safefloattype=\empty
8517 % the floattype might have accents or other special characters,
8518 % but we need to use it in a control sequence name.
8521 \xdef\safefloattype{\floattype}%
8525 % If label is given but no type, we handle that as the empty type.
8526 \ifx\floatlabel\empty \else
8527 % We want each FLOATTYPE to be numbered separately (Figure 1,
8528 % Table 1, Figure 2, ...). (And if no label, no number.)
8530 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
8531 \global\advance\floatno by 1
8534 % This magic value for \lastsection is output by \setref as the
8535 % XREFLABEL-title value. \xrefX uses it to distinguish float
8536 % labels (which have a completely different output format) from
8537 % node and anchor labels. And \xrdef uses it to construct the
8540 \edef\lastsection{\floatmagic=\safefloattype}%
8541 \setref{\floatlabel}{Yfloat}%
8545 % start with \parskip glue, I guess.
8548 % Don't suppress indentation if a float happens to start a section.
8549 \restorefirstparagraphindent
8552 % we have these possibilities:
8553 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8554 % @float Foo,lbl & no caption: Foo 1.1
8555 % @float Foo & @caption{Cap}: Foo: Cap
8556 % @float Foo & no caption: Foo
8557 % @float ,lbl & Caption{Cap}: 1.1: Cap
8558 % @float ,lbl & no caption: 1.1
8559 % @float & @caption{Cap}: Cap
8560 % @float & no caption:
8563 \let\floatident = \empty
8565 % In all cases, if we have a float type, it comes first.
8566 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8568 % If we have an xref label, the number comes next.
8569 \ifx\floatlabel\empty \else
8570 \ifx\floattype\empty \else % if also had float type, need tie first.
8571 \appendtomacro\floatident{\tie}%
8574 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8577 % Start the printed caption with what we've constructed in
8578 % \floatident, but keep it separate; we need \floatident again.
8579 \let\captionline = \floatident
8581 \ifx\thiscaption\empty \else
8582 \ifx\floatident\empty \else
8583 \appendtomacro\captionline{: }% had ident, so need a colon between
8587 \appendtomacro\captionline{\scanexp\thiscaption}%
8590 % If we have anything to print, print it, with space before.
8591 % Eventually this needs to become an \insert.
8592 \ifx\captionline\empty \else
8596 % Space below caption.
8600 % If have an xref label, write the list of floats info. Do this
8601 % after the caption, to avoid chance of it being a breakpoint.
8602 \ifx\floatlabel\empty \else
8603 % Write the text that goes in the lof to the aux file as
8604 % \floatlabel-lof. Besides \floatident, we include the short
8605 % caption if specified, else the full caption if specified, else nothing.
8609 % since we read the caption text in the macro world, where ^^M
8610 % is turned into a normal character, we have to scan it back, so
8611 % we don't write the literal three characters "^^M" into the aux file.
8613 \xdef\noexpand\gtemp{%
8614 \ifx\thisshortcaption\empty
8621 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
8622 \ifx\gtemp\empty \else : \gtemp \fi}}%
8625 \egroup % end of \vtop
8627 % place the captured inserts
8629 % BEWARE: when the floats start floating, we have to issue warning
8630 % whenever an insert appears inside a float which could possibly
8631 % float. --kasal, 26may04
8636 % Append the tokens #2 to the definition of macro #1, not expanding either.
8638 \def\appendtomacro#1#2{%
8639 \expandafter\def\expandafter#1\expandafter{#1#2}%
8642 % @caption, @shortcaption
8644 \def\caption{\docaption\thiscaption}
8645 \def\shortcaption{\docaption\thisshortcaption}
8646 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8647 \def\defcaption#1#2{\egroup \def#1{#2}}
8649 % The parameter is the control sequence identifying the counter we are
8650 % going to use. Create it if it doesn't exist and assign it to \floatno.
8653 % Haven't seen this figure type before.
8654 \csname newcount\endcsname #1%
8656 % Remember to reset this floatno at the next chap.
8657 \expandafter\gdef\expandafter\resetallfloatnos
8658 \expandafter{\resetallfloatnos #1=0 }%
8663 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8664 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8665 % first read the @float command.
8667 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
8669 % Magic string used for the XREFLABEL-title value, so \xrefX can
8670 % distinguish floats from other xref types.
8671 \def\floatmagic{!!float!!}
8673 % #1 is the control sequence we are passed; we expand into a conditional
8674 % which is true if #1 represents a float ref. That is, the magic
8675 % \lastsection value which we \setref above.
8677 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
8679 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8680 % (safe) float type for this float. We set \iffloattype to #2.
8682 \def\doiffloat#1=#2=#3\finish{%
8684 \def\iffloattype{#2}%
8685 \ifx\temp\floatmagic
8688 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8690 \parseargdef\listoffloats{%
8691 \def\floattype{#1}% floattype
8693 % the floattype might have accents or other special characters,
8694 % but we need to use it in a control sequence name.
8697 \xdef\safefloattype{\floattype}%
8700 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8701 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8703 % if the user said @listoffloats foo but never @float foo.
8704 \message{\linenumber No `\safefloattype' floats to list.}%
8708 \leftskip=\tocindent % indent these entries like a toc
8709 \let\do=\listoffloatsdo
8710 \csname floatlist\safefloattype\endcsname
8715 % This is called on each entry in a list of floats. We're passed the
8716 % xref label, in the form LABEL-title, which is how we save it in the
8717 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8718 % has the text we're supposed to typeset here.
8720 % Figures without xref labels will not be included in the list (since
8721 % they won't appear in the aux file).
8723 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8724 \def\listoffloatsdoentry#1-title\finish{{%
8725 % Can't fully expand XR#1-lof because it can contain anything. Just
8726 % pass the control sequence. On the other hand, XR#1-pg is just the
8727 % page number, and we want to fully expand that so we can get a link
8729 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8731 % use the same \entry macro we use to generate the TOC and index.
8732 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8737 \message{localization,}
8739 % For single-language documents, @documentlanguage is usually given very
8740 % early, just after @documentencoding. Single argument is the language
8741 % (de) or locale (de_DE) abbreviation.
8744 \catcode`\_ = \active
8746 \parseargdef\documentlanguage{\begingroup
8747 \let_=\normalunderscore % normal _ character for filenames
8748 \tex % read txi-??.tex file in plain TeX.
8749 % Read the file by the name they passed if it exists.
8750 \openin 1 txi-#1.tex
8752 \documentlanguagetrywithoutunderscore{#1_\finish}%
8754 \globaldefs = 1 % everything in the txi-LL files needs to persist
8758 \endgroup % end raw TeX
8761 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8764 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8765 \openin 1 txi-#1.tex
8767 \errhelp = \nolanghelp
8768 \errmessage{Cannot read language file txi-#1.tex}%
8770 \globaldefs = 1 % everything in the txi-LL files needs to persist
8775 }% end of special _ catcode
8777 \newhelp\nolanghelp{The given language definition file cannot be found or
8778 is empty. Maybe you need to install it? Putting it in the current
8779 directory should work if nowhere else does.}
8781 % This macro is called from txi-??.tex files; the first argument is the
8782 % \language name to set (without the "\lang@" prefix), the second and
8783 % third args are \{left,right}hyphenmin.
8785 % The language names to pass are determined when the format is built.
8786 % See the etex.log file created at that time, e.g.,
8787 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8789 % With TeX Live 2008, etex now includes hyphenation patterns for all
8790 % available languages. This means we can support hyphenation in
8791 % Texinfo, at least to some extent. (This still doesn't solve the
8792 % accented characters problem.)
8795 \def\txisetlanguage#1#2#3{%
8796 % do not set the language if the name is undefined in the current TeX.
8797 \expandafter\ifx\csname lang@#1\endcsname \relax
8798 \message{no patterns for #1}%
8800 \global\language = \csname lang@#1\endcsname
8802 % but there is no harm in adjusting the hyphenmin values regardless.
8803 \global\lefthyphenmin = #2\relax
8804 \global\righthyphenmin = #3\relax
8807 % Helpers for encodings.
8808 % Set the catcode of characters 128 through 255 to the specified number.
8810 \def\setnonasciicharscatcode#1{%
8812 \loop\ifnum\count255<256
8813 \global\catcode\count255=#1\relax
8814 \advance\count255 by 1
8818 \def\setnonasciicharscatcodenonglobal#1{%
8820 \loop\ifnum\count255<256
8821 \catcode\count255=#1\relax
8822 \advance\count255 by 1
8826 % @documentencoding sets the definition of non-ASCII characters
8827 % according to the specified encoding.
8829 \parseargdef\documentencoding{%
8830 % Encoding being declared for the document.
8831 \def\declaredencoding{\csname #1.enc\endcsname}%
8833 % Supported encodings: names converted to tokens in order to be able
8834 % to compare them with \ifx.
8835 \def\ascii{\csname US-ASCII.enc\endcsname}%
8836 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8837 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8838 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8839 \def\utfeight{\csname UTF-8.enc\endcsname}%
8841 \ifx \declaredencoding \ascii
8844 \else \ifx \declaredencoding \lattwo
8845 \setnonasciicharscatcode\active
8848 \else \ifx \declaredencoding \latone
8849 \setnonasciicharscatcode\active
8852 \else \ifx \declaredencoding \latnine
8853 \setnonasciicharscatcode\active
8856 \else \ifx \declaredencoding \utfeight
8857 \setnonasciicharscatcode\active
8861 \message{Unknown document encoding #1, ignoring.}%
8870 % A message to be logged when using a character that isn't available
8871 % the default font encoding (OT1).
8873 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8875 % Take account of \c (plain) vs. \, (Texinfo) difference.
8876 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8878 % First, make active non-ASCII characters in order for them to be
8879 % correctly categorized when TeX reads the replacement text of
8880 % macros containing the character definitions.
8881 \setnonasciicharscatcode\active
8883 % Latin1 (ISO-8859-1) character definitions.
8884 \def\latonechardefs{%
8886 \gdef^^a1{\exclamdown}
8887 \gdef^^a2{\missingcharmsg{CENT SIGN}}
8888 \gdef^^a3{{\pounds}}
8889 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8890 \gdef^^a5{\missingcharmsg{YEN SIGN}}
8891 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8894 \gdef^^a9{\copyright}
8896 \gdef^^ab{\guillemetleft}
8899 \gdef^^ae{\registeredsymbol}
8902 \gdef^^b0{\textdegree}
8911 \gdef^^b8{\cedilla\ }
8915 \gdef^^bb{\guillemetright}
8916 \gdef^^bc{$1\over4$}
8917 \gdef^^bd{$1\over2$}
8918 \gdef^^be{$3\over4$}
8919 \gdef^^bf{\questiondown}
8926 \gdef^^c5{\ringaccent A}
8928 \gdef^^c7{\cedilla C}
8960 \gdef^^e5{\ringaccent a}
8962 \gdef^^e7{\cedilla c}
8967 \gdef^^ec{\`{\dotless i}}
8968 \gdef^^ed{\'{\dotless i}}
8969 \gdef^^ee{\^{\dotless i}}
8970 \gdef^^ef{\"{\dotless i}}
8990 % Latin9 (ISO-8859-15) encoding character definitions.
8991 \def\latninechardefs{%
8992 % Encoding is almost identical to Latin1.
9005 % Latin2 (ISO-8859-2) character definitions.
9006 \def\lattwochardefs{%
9008 \gdef^^a1{\ogonek{A}}
9011 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
9017 \gdef^^aa{\cedilla S}
9022 \gdef^^af{\dotaccent Z}
9024 \gdef^^b0{\textdegree}
9025 \gdef^^b1{\ogonek{a}}
9026 \gdef^^b2{\ogonek{ }}
9032 \gdef^^b8{\cedilla\ }
9034 \gdef^^ba{\cedilla s}
9039 \gdef^^bf{\dotaccent z}
9048 \gdef^^c7{\cedilla C}
9051 \gdef^^ca{\ogonek{E}}
9067 \gdef^^d9{\ringaccent U}
9072 \gdef^^de{\cedilla T}
9082 \gdef^^e7{\cedilla c}
9085 \gdef^^ea{\ogonek{e}}
9088 \gdef^^ed{\'{\dotless{i}}}
9089 \gdef^^ee{\^{\dotless{i}}}
9101 \gdef^^f9{\ringaccent u}
9106 \gdef^^fe{\cedilla t}
9107 \gdef^^ff{\dotaccent{}}
9110 % UTF-8 character definitions.
9112 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
9113 % changes for Texinfo conventions. It is included here under the GPL by
9114 % permission from Frank Mittelbach and the LaTeX team.
9120 \gdef\UTFviiiTwoOctets#1#2{\expandafter
9121 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
9123 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
9124 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
9126 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
9127 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
9129 \gdef\UTFviiiDefined#1{%
9131 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
9142 \global\catcode\countUTFx\active
9143 \uccode`\~\countUTFx
9144 \uppercase\expandafter{\UTFviiiTmp}%
9145 \advance\countUTFx by 1
9146 \ifnum\countUTFx < \countUTFy
9147 \expandafter\UTFviiiLoop
9153 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
9159 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
9165 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
9178 \gdef\DeclareUnicodeCharacter#1#2{%
9179 \countUTFz = "#1\relax
9180 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9183 \def\UTFviiiTwoOctets##1##2{%
9184 \csname u8:##1\string ##2\endcsname}%
9185 \def\UTFviiiThreeOctets##1##2##3{%
9186 \csname u8:##1\string ##2\string ##3\endcsname}%
9187 \def\UTFviiiFourOctets##1##2##3##4{%
9188 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
9189 \expandafter\expandafter\expandafter\expandafter
9190 \expandafter\expandafter\expandafter
9191 \gdef\UTFviiiTmp{#2}%
9194 \gdef\parseXMLCharref{%
9195 \ifnum\countUTFz < "A0\relax
9196 \errhelp = \EMsimple
9197 \errmessage{Cannot define Unicode char value < 00A0}%
9198 \else\ifnum\countUTFz < "800\relax
9200 \parseUTFviiiB C\UTFviiiTwoOctets.,%
9201 \else\ifnum\countUTFz < "10000\relax
9204 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
9209 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
9213 \gdef\parseUTFviiiA#1{%
9214 \countUTFx = \countUTFz
9215 \divide\countUTFz by 64
9216 \countUTFy = \countUTFz
9217 \multiply\countUTFz by 64
9218 \advance\countUTFx by -\countUTFz
9219 \advance\countUTFx by 128
9220 \uccode `#1\countUTFx
9221 \countUTFz = \countUTFy}
9223 \gdef\parseUTFviiiB#1#2#3#4{%
9224 \advance\countUTFz by "#10\relax
9225 \uccode `#3\countUTFz
9226 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9229 \def\utfeightchardefs{%
9230 \DeclareUnicodeCharacter{00A0}{\tie}
9231 \DeclareUnicodeCharacter{00A1}{\exclamdown}
9232 \DeclareUnicodeCharacter{00A3}{\pounds}
9233 \DeclareUnicodeCharacter{00A8}{\"{ }}
9234 \DeclareUnicodeCharacter{00A9}{\copyright}
9235 \DeclareUnicodeCharacter{00AA}{\ordf}
9236 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
9237 \DeclareUnicodeCharacter{00AD}{\-}
9238 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
9239 \DeclareUnicodeCharacter{00AF}{\={ }}
9241 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
9242 \DeclareUnicodeCharacter{00B4}{\'{ }}
9243 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
9244 \DeclareUnicodeCharacter{00BA}{\ordm}
9245 \DeclareUnicodeCharacter{00BB}{\guillemetright}
9246 \DeclareUnicodeCharacter{00BF}{\questiondown}
9248 \DeclareUnicodeCharacter{00C0}{\`A}
9249 \DeclareUnicodeCharacter{00C1}{\'A}
9250 \DeclareUnicodeCharacter{00C2}{\^A}
9251 \DeclareUnicodeCharacter{00C3}{\~A}
9252 \DeclareUnicodeCharacter{00C4}{\"A}
9253 \DeclareUnicodeCharacter{00C5}{\AA}
9254 \DeclareUnicodeCharacter{00C6}{\AE}
9255 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
9256 \DeclareUnicodeCharacter{00C8}{\`E}
9257 \DeclareUnicodeCharacter{00C9}{\'E}
9258 \DeclareUnicodeCharacter{00CA}{\^E}
9259 \DeclareUnicodeCharacter{00CB}{\"E}
9260 \DeclareUnicodeCharacter{00CC}{\`I}
9261 \DeclareUnicodeCharacter{00CD}{\'I}
9262 \DeclareUnicodeCharacter{00CE}{\^I}
9263 \DeclareUnicodeCharacter{00CF}{\"I}
9265 \DeclareUnicodeCharacter{00D0}{\DH}
9266 \DeclareUnicodeCharacter{00D1}{\~N}
9267 \DeclareUnicodeCharacter{00D2}{\`O}
9268 \DeclareUnicodeCharacter{00D3}{\'O}
9269 \DeclareUnicodeCharacter{00D4}{\^O}
9270 \DeclareUnicodeCharacter{00D5}{\~O}
9271 \DeclareUnicodeCharacter{00D6}{\"O}
9272 \DeclareUnicodeCharacter{00D8}{\O}
9273 \DeclareUnicodeCharacter{00D9}{\`U}
9274 \DeclareUnicodeCharacter{00DA}{\'U}
9275 \DeclareUnicodeCharacter{00DB}{\^U}
9276 \DeclareUnicodeCharacter{00DC}{\"U}
9277 \DeclareUnicodeCharacter{00DD}{\'Y}
9278 \DeclareUnicodeCharacter{00DE}{\TH}
9279 \DeclareUnicodeCharacter{00DF}{\ss}
9281 \DeclareUnicodeCharacter{00E0}{\`a}
9282 \DeclareUnicodeCharacter{00E1}{\'a}
9283 \DeclareUnicodeCharacter{00E2}{\^a}
9284 \DeclareUnicodeCharacter{00E3}{\~a}
9285 \DeclareUnicodeCharacter{00E4}{\"a}
9286 \DeclareUnicodeCharacter{00E5}{\aa}
9287 \DeclareUnicodeCharacter{00E6}{\ae}
9288 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
9289 \DeclareUnicodeCharacter{00E8}{\`e}
9290 \DeclareUnicodeCharacter{00E9}{\'e}
9291 \DeclareUnicodeCharacter{00EA}{\^e}
9292 \DeclareUnicodeCharacter{00EB}{\"e}
9293 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
9294 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
9295 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
9296 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
9298 \DeclareUnicodeCharacter{00F0}{\dh}
9299 \DeclareUnicodeCharacter{00F1}{\~n}
9300 \DeclareUnicodeCharacter{00F2}{\`o}
9301 \DeclareUnicodeCharacter{00F3}{\'o}
9302 \DeclareUnicodeCharacter{00F4}{\^o}
9303 \DeclareUnicodeCharacter{00F5}{\~o}
9304 \DeclareUnicodeCharacter{00F6}{\"o}
9305 \DeclareUnicodeCharacter{00F8}{\o}
9306 \DeclareUnicodeCharacter{00F9}{\`u}
9307 \DeclareUnicodeCharacter{00FA}{\'u}
9308 \DeclareUnicodeCharacter{00FB}{\^u}
9309 \DeclareUnicodeCharacter{00FC}{\"u}
9310 \DeclareUnicodeCharacter{00FD}{\'y}
9311 \DeclareUnicodeCharacter{00FE}{\th}
9312 \DeclareUnicodeCharacter{00FF}{\"y}
9314 \DeclareUnicodeCharacter{0100}{\=A}
9315 \DeclareUnicodeCharacter{0101}{\=a}
9316 \DeclareUnicodeCharacter{0102}{\u{A}}
9317 \DeclareUnicodeCharacter{0103}{\u{a}}
9318 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
9319 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
9320 \DeclareUnicodeCharacter{0106}{\'C}
9321 \DeclareUnicodeCharacter{0107}{\'c}
9322 \DeclareUnicodeCharacter{0108}{\^C}
9323 \DeclareUnicodeCharacter{0109}{\^c}
9324 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
9325 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
9326 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
9327 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
9328 \DeclareUnicodeCharacter{010C}{\v{C}}
9329 \DeclareUnicodeCharacter{010D}{\v{c}}
9330 \DeclareUnicodeCharacter{010E}{\v{D}}
9332 \DeclareUnicodeCharacter{0112}{\=E}
9333 \DeclareUnicodeCharacter{0113}{\=e}
9334 \DeclareUnicodeCharacter{0114}{\u{E}}
9335 \DeclareUnicodeCharacter{0115}{\u{e}}
9336 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
9337 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
9338 \DeclareUnicodeCharacter{011A}{\v{E}}
9339 \DeclareUnicodeCharacter{011B}{\v{e}}
9340 \DeclareUnicodeCharacter{011C}{\^G}
9341 \DeclareUnicodeCharacter{011D}{\^g}
9342 \DeclareUnicodeCharacter{011E}{\u{G}}
9343 \DeclareUnicodeCharacter{011F}{\u{g}}
9345 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
9346 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
9347 \DeclareUnicodeCharacter{0124}{\^H}
9348 \DeclareUnicodeCharacter{0125}{\^h}
9349 \DeclareUnicodeCharacter{0128}{\~I}
9350 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
9351 \DeclareUnicodeCharacter{012A}{\=I}
9352 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
9353 \DeclareUnicodeCharacter{012C}{\u{I}}
9354 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
9356 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
9357 \DeclareUnicodeCharacter{0131}{\dotless{i}}
9358 \DeclareUnicodeCharacter{0132}{IJ}
9359 \DeclareUnicodeCharacter{0133}{ij}
9360 \DeclareUnicodeCharacter{0134}{\^J}
9361 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
9362 \DeclareUnicodeCharacter{0139}{\'L}
9363 \DeclareUnicodeCharacter{013A}{\'l}
9365 \DeclareUnicodeCharacter{0141}{\L}
9366 \DeclareUnicodeCharacter{0142}{\l}
9367 \DeclareUnicodeCharacter{0143}{\'N}
9368 \DeclareUnicodeCharacter{0144}{\'n}
9369 \DeclareUnicodeCharacter{0147}{\v{N}}
9370 \DeclareUnicodeCharacter{0148}{\v{n}}
9371 \DeclareUnicodeCharacter{014C}{\=O}
9372 \DeclareUnicodeCharacter{014D}{\=o}
9373 \DeclareUnicodeCharacter{014E}{\u{O}}
9374 \DeclareUnicodeCharacter{014F}{\u{o}}
9376 \DeclareUnicodeCharacter{0150}{\H{O}}
9377 \DeclareUnicodeCharacter{0151}{\H{o}}
9378 \DeclareUnicodeCharacter{0152}{\OE}
9379 \DeclareUnicodeCharacter{0153}{\oe}
9380 \DeclareUnicodeCharacter{0154}{\'R}
9381 \DeclareUnicodeCharacter{0155}{\'r}
9382 \DeclareUnicodeCharacter{0158}{\v{R}}
9383 \DeclareUnicodeCharacter{0159}{\v{r}}
9384 \DeclareUnicodeCharacter{015A}{\'S}
9385 \DeclareUnicodeCharacter{015B}{\'s}
9386 \DeclareUnicodeCharacter{015C}{\^S}
9387 \DeclareUnicodeCharacter{015D}{\^s}
9388 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
9389 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
9391 \DeclareUnicodeCharacter{0160}{\v{S}}
9392 \DeclareUnicodeCharacter{0161}{\v{s}}
9393 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
9394 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
9395 \DeclareUnicodeCharacter{0164}{\v{T}}
9397 \DeclareUnicodeCharacter{0168}{\~U}
9398 \DeclareUnicodeCharacter{0169}{\~u}
9399 \DeclareUnicodeCharacter{016A}{\=U}
9400 \DeclareUnicodeCharacter{016B}{\=u}
9401 \DeclareUnicodeCharacter{016C}{\u{U}}
9402 \DeclareUnicodeCharacter{016D}{\u{u}}
9403 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
9404 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
9406 \DeclareUnicodeCharacter{0170}{\H{U}}
9407 \DeclareUnicodeCharacter{0171}{\H{u}}
9408 \DeclareUnicodeCharacter{0174}{\^W}
9409 \DeclareUnicodeCharacter{0175}{\^w}
9410 \DeclareUnicodeCharacter{0176}{\^Y}
9411 \DeclareUnicodeCharacter{0177}{\^y}
9412 \DeclareUnicodeCharacter{0178}{\"Y}
9413 \DeclareUnicodeCharacter{0179}{\'Z}
9414 \DeclareUnicodeCharacter{017A}{\'z}
9415 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
9416 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
9417 \DeclareUnicodeCharacter{017D}{\v{Z}}
9418 \DeclareUnicodeCharacter{017E}{\v{z}}
9420 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
9421 \DeclareUnicodeCharacter{01C5}{D\v{z}}
9422 \DeclareUnicodeCharacter{01C6}{d\v{z}}
9423 \DeclareUnicodeCharacter{01C7}{LJ}
9424 \DeclareUnicodeCharacter{01C8}{Lj}
9425 \DeclareUnicodeCharacter{01C9}{lj}
9426 \DeclareUnicodeCharacter{01CA}{NJ}
9427 \DeclareUnicodeCharacter{01CB}{Nj}
9428 \DeclareUnicodeCharacter{01CC}{nj}
9429 \DeclareUnicodeCharacter{01CD}{\v{A}}
9430 \DeclareUnicodeCharacter{01CE}{\v{a}}
9431 \DeclareUnicodeCharacter{01CF}{\v{I}}
9433 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
9434 \DeclareUnicodeCharacter{01D1}{\v{O}}
9435 \DeclareUnicodeCharacter{01D2}{\v{o}}
9436 \DeclareUnicodeCharacter{01D3}{\v{U}}
9437 \DeclareUnicodeCharacter{01D4}{\v{u}}
9439 \DeclareUnicodeCharacter{01E2}{\={\AE}}
9440 \DeclareUnicodeCharacter{01E3}{\={\ae}}
9441 \DeclareUnicodeCharacter{01E6}{\v{G}}
9442 \DeclareUnicodeCharacter{01E7}{\v{g}}
9443 \DeclareUnicodeCharacter{01E8}{\v{K}}
9444 \DeclareUnicodeCharacter{01E9}{\v{k}}
9446 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
9447 \DeclareUnicodeCharacter{01F1}{DZ}
9448 \DeclareUnicodeCharacter{01F2}{Dz}
9449 \DeclareUnicodeCharacter{01F3}{dz}
9450 \DeclareUnicodeCharacter{01F4}{\'G}
9451 \DeclareUnicodeCharacter{01F5}{\'g}
9452 \DeclareUnicodeCharacter{01F8}{\`N}
9453 \DeclareUnicodeCharacter{01F9}{\`n}
9454 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
9455 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
9456 \DeclareUnicodeCharacter{01FE}{\'{\O}}
9457 \DeclareUnicodeCharacter{01FF}{\'{\o}}
9459 \DeclareUnicodeCharacter{021E}{\v{H}}
9460 \DeclareUnicodeCharacter{021F}{\v{h}}
9462 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
9463 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
9464 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
9465 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
9466 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
9467 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
9469 \DeclareUnicodeCharacter{0232}{\=Y}
9470 \DeclareUnicodeCharacter{0233}{\=y}
9471 \DeclareUnicodeCharacter{0237}{\dotless{j}}
9473 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
9475 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
9476 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
9477 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
9478 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
9479 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
9480 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
9481 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
9482 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
9483 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
9484 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
9485 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
9486 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
9488 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
9489 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
9491 \DeclareUnicodeCharacter{1E20}{\=G}
9492 \DeclareUnicodeCharacter{1E21}{\=g}
9493 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
9494 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
9495 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
9496 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
9497 \DeclareUnicodeCharacter{1E26}{\"H}
9498 \DeclareUnicodeCharacter{1E27}{\"h}
9500 \DeclareUnicodeCharacter{1E30}{\'K}
9501 \DeclareUnicodeCharacter{1E31}{\'k}
9502 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
9503 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
9504 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
9505 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
9506 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
9507 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
9508 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
9509 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
9510 \DeclareUnicodeCharacter{1E3E}{\'M}
9511 \DeclareUnicodeCharacter{1E3F}{\'m}
9513 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
9514 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
9515 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
9516 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
9517 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
9518 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
9519 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
9520 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
9521 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
9522 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
9524 \DeclareUnicodeCharacter{1E54}{\'P}
9525 \DeclareUnicodeCharacter{1E55}{\'p}
9526 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
9527 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
9528 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
9529 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
9530 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
9531 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
9532 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
9533 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
9535 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
9536 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
9537 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
9538 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
9539 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
9540 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
9541 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
9542 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
9543 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
9544 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
9546 \DeclareUnicodeCharacter{1E7C}{\~V}
9547 \DeclareUnicodeCharacter{1E7D}{\~v}
9548 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
9549 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
9551 \DeclareUnicodeCharacter{1E80}{\`W}
9552 \DeclareUnicodeCharacter{1E81}{\`w}
9553 \DeclareUnicodeCharacter{1E82}{\'W}
9554 \DeclareUnicodeCharacter{1E83}{\'w}
9555 \DeclareUnicodeCharacter{1E84}{\"W}
9556 \DeclareUnicodeCharacter{1E85}{\"w}
9557 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
9558 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
9559 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
9560 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
9561 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
9562 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
9563 \DeclareUnicodeCharacter{1E8C}{\"X}
9564 \DeclareUnicodeCharacter{1E8D}{\"x}
9565 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
9566 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
9568 \DeclareUnicodeCharacter{1E90}{\^Z}
9569 \DeclareUnicodeCharacter{1E91}{\^z}
9570 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
9571 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
9572 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
9573 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
9574 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
9575 \DeclareUnicodeCharacter{1E97}{\"t}
9576 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
9577 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
9579 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
9580 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
9582 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
9583 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
9584 \DeclareUnicodeCharacter{1EBC}{\~E}
9585 \DeclareUnicodeCharacter{1EBD}{\~e}
9587 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
9588 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
9589 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
9590 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
9592 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
9593 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
9595 \DeclareUnicodeCharacter{1EF2}{\`Y}
9596 \DeclareUnicodeCharacter{1EF3}{\`y}
9597 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
9599 \DeclareUnicodeCharacter{1EF8}{\~Y}
9600 \DeclareUnicodeCharacter{1EF9}{\~y}
9602 \DeclareUnicodeCharacter{2013}{--}
9603 \DeclareUnicodeCharacter{2014}{---}
9604 \DeclareUnicodeCharacter{2018}{\quoteleft}
9605 \DeclareUnicodeCharacter{2019}{\quoteright}
9606 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
9607 \DeclareUnicodeCharacter{201C}{\quotedblleft}
9608 \DeclareUnicodeCharacter{201D}{\quotedblright}
9609 \DeclareUnicodeCharacter{201E}{\quotedblbase}
9610 \DeclareUnicodeCharacter{2022}{\bullet}
9611 \DeclareUnicodeCharacter{2026}{\dots}
9612 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9613 \DeclareUnicodeCharacter{203A}{\guilsinglright}
9614 \DeclareUnicodeCharacter{20AC}{\euro}
9616 \DeclareUnicodeCharacter{2192}{\expansion}
9617 \DeclareUnicodeCharacter{21D2}{\result}
9619 \DeclareUnicodeCharacter{2212}{\minus}
9620 \DeclareUnicodeCharacter{2217}{\point}
9621 \DeclareUnicodeCharacter{2261}{\equiv}
9622 }% end of \utfeightchardefs
9625 % US-ASCII character definitions.
9626 \def\asciichardefs{% nothing need be done
9630 % Make non-ASCII characters printable again for compatibility with
9631 % existing Texinfo documents that may use them, even without declaring a
9632 % document encoding.
9634 \setnonasciicharscatcode \other
9637 \message{formatting,}
9639 \newdimen\defaultparindent \defaultparindent = 15pt
9641 \chapheadingskip = 15pt plus 4pt minus 2pt
9642 \secheadingskip = 12pt plus 3pt minus 2pt
9643 \subsecheadingskip = 9pt plus 2pt minus 2pt
9645 % Prevent underfull vbox error messages.
9648 % Don't be very finicky about underfull hboxes, either.
9651 % Following George Bush, get rid of widows and orphans.
9655 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9656 % using an old version of TeX, don't do anything. We want the amount of
9657 % stretch added to depend on the line length, hence the dependence on
9658 % \hsize. We call this whenever the paper size is set.
9660 \def\setemergencystretch{%
9661 \ifx\emergencystretch\thisisundefined
9662 % Allow us to assign to \emergencystretch anyway.
9663 \def\emergencystretch{\dimen0}%
9665 \emergencystretch = .15\hsize
9669 % Parameters in order: 1) textheight; 2) textwidth;
9670 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9671 % 7) physical page height; 8) physical page width.
9673 % We also call \setleading{\textleading}, so the caller should define
9674 % \textleading. The caller should also set \parskip.
9676 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9679 \splittopskip = \topskip
9682 \advance\vsize by \topskip
9683 \outervsize = \vsize
9684 \advance\outervsize by 2\topandbottommargin
9685 \pageheight = \vsize
9688 \outerhsize = \hsize
9689 \advance\outerhsize by 0.5in
9692 \normaloffset = #4\relax
9693 \bindingoffset = #5\relax
9696 \pdfpageheight #7\relax
9697 \pdfpagewidth #8\relax
9698 % if we don't reset these, they will remain at "1 true in" of
9699 % whatever layout pdftex was dumped with.
9700 \pdfhorigin = 1 true in
9701 \pdfvorigin = 1 true in
9704 \setleading{\textleading}
9706 \parindent = \defaultparindent
9707 \setemergencystretch
9710 % @letterpaper (the default).
9711 \def\letterpaper{{\globaldefs = 1
9712 \parskip = 3pt plus 2pt minus 1pt
9713 \textleading = 13.2pt
9715 % If page is nothing but text, make it come out even.
9716 \internalpagesizes{607.2pt}{6in}% that's 46 lines
9718 {\bindingoffset}{36pt}%
9722 % Use @smallbook to reset parameters for 7x9.25 trim size.
9723 \def\smallbook{{\globaldefs = 1
9724 \parskip = 2pt plus 1pt
9727 \internalpagesizes{7.5in}{5in}%
9729 {\bindingoffset}{16pt}%
9732 \lispnarrowing = 0.3in
9735 \contentsrightmargin = 0pt
9736 \defbodyindent = .5cm
9739 % Use @smallerbook to reset parameters for 6x9 trim size.
9740 % (Just testing, parameters still in flux.)
9741 \def\smallerbook{{\globaldefs = 1
9742 \parskip = 1.5pt plus 1pt
9745 \internalpagesizes{7.4in}{4.8in}%
9750 \lispnarrowing = 0.25in
9753 \contentsrightmargin = 0pt
9754 \defbodyindent = .4cm
9757 % Use @afourpaper to print on European A4 paper.
9758 \def\afourpaper{{\globaldefs = 1
9759 \parskip = 3pt plus 2pt minus 1pt
9760 \textleading = 13.2pt
9762 % Double-side printing via postscript on Laserjet 4050
9763 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9764 % To change the settings for a different printer or situation, adjust
9765 % \normaloffset until the front-side and back-side texts align. Then
9766 % do the same for \bindingoffset. You can set these for testing in
9767 % your texinfo source file like this:
9769 % \global\normaloffset = -6mm
9770 % \global\bindingoffset = 10mm
9772 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9773 {\voffset}{\hoffset}%
9774 {\bindingoffset}{44pt}%
9779 \contentsrightmargin = 0pt
9780 \defbodyindent = 5mm
9783 % Use @afivepaper to print on European A5 paper.
9784 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9785 % He also recommends making @example and @lisp be small.
9786 \def\afivepaper{{\globaldefs = 1
9787 \parskip = 2pt plus 1pt minus 0.1pt
9788 \textleading = 12.5pt
9790 \internalpagesizes{160mm}{120mm}%
9791 {\voffset}{\hoffset}%
9792 {\bindingoffset}{8pt}%
9795 \lispnarrowing = 0.2in
9798 \contentsrightmargin = 0pt
9799 \defbodyindent = 2mm
9803 % A specific text layout, 24x15cm overall, intended for A4 paper.
9804 \def\afourlatex{{\globaldefs = 1
9806 \internalpagesizes{237mm}{150mm}%
9808 {\bindingoffset}{7mm}%
9811 % Must explicitly reset to 0 because we call \afourpaper.
9815 % Use @afourwide to print on A4 paper in landscape format.
9816 \def\afourwide{{\globaldefs = 1
9818 \internalpagesizes{241mm}{165mm}%
9819 {\voffset}{-2.95mm}%
9820 {\bindingoffset}{7mm}%
9825 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9826 % Perhaps we should allow setting the margins, \topskip, \parskip,
9827 % and/or leading, also. Or perhaps we should compute them somehow.
9829 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9830 \def\pagesizesyyy#1,#2,#3\finish{{%
9831 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9834 \parskip = 3pt plus 2pt minus 1pt
9835 \setleading{\textleading}%
9838 \advance\dimen0 by \voffset
9841 \advance\dimen2 by \normaloffset
9843 \internalpagesizes{#1}{\hsize}%
9844 {\voffset}{\normaloffset}%
9845 {\bindingoffset}{44pt}%
9849 % Set default to letter.
9854 \message{and turning on texinfo input format.}
9856 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
9858 % DEL is a comment character, in case @c does not suffice.
9861 % Define macros to output various characters with catcode for normal text.
9862 \catcode`\"=\other \def\normaldoublequote{"}
9863 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
9864 \catcode`\+=\other \def\normalplus{+}
9865 \catcode`\<=\other \def\normalless{<}
9866 \catcode`\>=\other \def\normalgreater{>}
9867 \catcode`\^=\other \def\normalcaret{^}
9868 \catcode`\_=\other \def\normalunderscore{_}
9869 \catcode`\|=\other \def\normalverticalbar{|}
9870 \catcode`\~=\other \def\normaltilde{~}
9872 % This macro is used to make a character print one way in \tt
9873 % (where it can probably be output as-is), and another way in other fonts,
9874 % where something hairier probably needs to be done.
9876 % #1 is what to print if we are indeed using \tt; #2 is what to print
9877 % otherwise. Since all the Computer Modern typewriter fonts have zero
9878 % interword stretch (and shrink), and it is reasonable to expect all
9879 % typewriter fonts to have this, we can check that font parameter.
9881 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9883 % Same as above, but check for italic font. Actually this also catches
9884 % non-italic slanted fonts since it is impossible to distinguish them from
9885 % italic fonts. But since this is only used by $ and it uses \sl anyway
9886 % this is not a problem.
9887 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9889 % Turn off all special characters except @
9890 % (and those which the user can use as if they were ordinary).
9891 % Most of these we simply print from the \tt font, but for some, we can
9892 % use math or other variants that look better in normal text.
9895 \def\activedoublequote{{\tt\char34}}
9896 \let"=\activedoublequote
9898 \def~{{\tt\char126}}
9904 \def_{\ifusingtt\normalunderscore\_}
9906 % Subroutine for the previous macro.
9907 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9910 \def|{{\tt\char124}}
9918 \def+{{\tt \char 43}}
9920 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9922 % If a .fmt file is being used, characters that might appear in a file
9923 % name cannot be active until we have parsed the command line.
9924 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9925 % \otherifyactive is called near the end of this file.
9926 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9928 % Used sometimes to turn off (effectively) the active characters even after
9930 \def\turnoffactive{%
9931 \normalturnoffactive
9937 % \backslashcurfont outputs one backslash character in current font,
9939 \global\chardef\backslashcurfont=`\\
9940 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
9942 % \realbackslash is an actual character `\' with catcode other, and
9943 % \doublebackslash is two of them (for the pdf outlines).
9944 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9946 % In texinfo, backslash is an active character; it prints the backslash
9947 % in fixed width font.
9948 \catcode`\\=\active % @ for escape char from now on.
9950 % The story here is that in math mode, the \char of \backslashcurfont
9951 % ends up printing the roman \ from the math symbol font (because \char
9952 % in math mode uses the \mathcode, and plain.tex sets
9953 % \mathcode`\\="026E). It seems better for @backslashchar{} to always
9954 % print a typewriter backslash, hence we use an explicit \mathchar,
9955 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
9956 % ignored family value; char position "5C). We can't use " for the
9957 % usual hex value because it has already been made active.
9958 @def@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
9959 @let@backslashchar = @normalbackslash % @backslashchar{} is for user documents.
9961 % On startup, @fixbackslash assigns:
9962 % @let \ = @normalbackslash
9963 % \rawbackslash defines an active \ to do \backslashcurfont.
9964 % \otherbackslash defines an active \ to be a literal `\' character with
9965 % catcode other. We switch back and forth between these.
9966 @gdef@rawbackslash{@let\=@backslashcurfont}
9967 @gdef@otherbackslash{@let\=@realbackslash}
9969 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9970 % the literal character `\'.
9972 @def@normalturnoffactive{%
9973 @let"=@normaldoublequote
9974 @let$=@normaldollar %$ font-lock fix
9977 @let>=@normalgreater
9978 @let\=@normalbackslash
9980 @let_=@normalunderscore
9981 @let|=@normalverticalbar
9983 @markupsetuplqdefault
9984 @markupsetuprqdefault
9988 % Make _ and + \other characters, temporarily.
9989 % This is canceled by @fixbackslash.
9992 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9993 % That is what \eatinput is for; after that, the `\' should revert to printing
9996 @gdef@eatinput input texinfo{@fixbackslash}
9997 @global@let\ = @eatinput
9999 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
10000 % the first `\' in the file would cause an error. This macro tries to fix
10001 % that, assuming it is called before the first `\' could plausibly occur.
10002 % Also turn back on active characters that might appear in the input
10003 % file name, in case not using a pre-dumped format.
10005 @gdef@fixbackslash{%
10006 @ifx\@eatinput @let\ = @normalbackslash @fi
10008 @catcode`@_=@active
10011 % Say @foo, not \foo, in error messages.
10014 % These (along with & and #) are made active for url-breaking, so need
10015 % active definitions as the normal characters.
10017 @def@normalquest{?}
10018 @def@normalslash{/}
10020 % These look ok in all fonts, so just make them not special.
10021 % @hashchar{} gets its own user-level command, because of #line.
10022 @catcode`@& = @other @def@normalamp{&}
10023 @catcode`@# = @other @def@normalhash{#}
10024 @catcode`@% = @other @def@normalpercent{%}
10026 @let @hashchar = @normalhash
10028 @c Finally, make ` and ' active, so that txicodequoteundirected and
10029 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
10030 @c don't make ` and ' active, @code will not get them as active chars.
10031 @c Do this last of all since we use ` in the previous @catcode assignments.
10032 @catcode`@'=@active
10033 @catcode`@`=@active
10034 @markupsetuplqdefault
10035 @markupsetuprqdefault
10037 @c Local variables:
10038 @c page-delimiter: "^\\\\message"