1 % texinfo.tex -- TeX macros to handle Texinfo files.
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
6 \def\texinfoversion{2015-04-30.19}
8 % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
11 % Free Software Foundation, Inc.
13 % Modified version used in LilyPond, changed in 2012.
15 % This texinfo.tex file is free software: you can redistribute it and/or
16 % modify it under the terms of the GNU General Public License as
17 % published by the Free Software Foundation, either version 3 of the
18 % License, or (at your option) any later version.
20 % This texinfo.tex file is distributed in the hope that it will be
21 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
22 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 % General Public License for more details.
25 % You should have received a copy of the GNU General Public License
26 % along with this program. If not, see <http://www.gnu.org/licenses/>.
28 % As a special exception, when this file is read by TeX when processing
29 % a Texinfo source document, you may use the result without
30 % restriction. This Exception is an additional permission under section 7
31 % of the GNU General Public License, version 3 ("GPLv3").
33 % Please try the latest version of texinfo.tex before submitting bug
34 % reports; you can get the latest version from:
35 % http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
36 % http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
37 % http://www.gnu.org/software/texinfo/ (the Texinfo home page)
38 % The texinfo.tex in any given distribution could well be out
39 % of date, so if that's what you're using, please check.
41 % Send bug reports to bug-texinfo@gnu.org. Please include including a
42 % complete document in each bug report with which we can reproduce the
43 % problem. Patches are, of course, greatly appreciated.
45 % To process a Texinfo manual with TeX, it's most reliable to use the
46 % texi2dvi shell script that comes with the distribution. For a simple
47 % manual foo.texi, however, you can get away with this:
52 % dvips foo.dvi -o # or whatever; this makes foo.ps.
53 % The extra TeX runs get the cross-reference information correct.
54 % Sometimes one run after texindex suffices, and sometimes you need more
55 % than two; texi2dvi does it as many times as necessary.
57 % It is possible to adapt texinfo.tex for other languages, to some
58 % extent. You can get the existing language-specific files from the
59 % full Texinfo distribution.
61 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
64 \message{Loading texinfo [version \texinfoversion]:}
66 % If in a .fmt file, print the version number
67 % and turn on active characters that we couldn't do earlier because
68 % they might have appeared in the input file name.
69 \everyjob{\message{[Texinfo version \texinfoversion]}%
70 \catcode`+=\active \catcode`\_=\active}
74 % We never want plain's \outer definition of \+ in Texinfo.
75 % For @tex, we can use \tabalign.
78 % Save some plain tex macros whose names we will redefine.
80 \let\ptexbullet=\bullet
88 \let\ptexfootnote=\footnote
92 \let\ptexindent=\indent
93 \let\ptexinsert=\insert
96 \let\ptexnewwrite\newwrite
97 \let\ptexnoindent=\noindent
99 \let\ptexraggedright=\raggedright
107 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
109 % If this character appears in an error message or help string, it
110 % starts a new line in the output.
113 % Use TeX 3.0's \inputlineno to get the line number, for better error
114 % messages, but if we're using an old version of TeX, don't do anything.
116 \ifx\inputlineno\thisisundefined
117 \let\linenumber = \empty % Pre-3.0.
119 \def\linenumber{l.\the\inputlineno:\space}
122 % Set up fixed words for English if not already set.
123 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
124 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
125 \ifx\putworderror\undefined \gdef\putworderror{error}\fi
126 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
127 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
128 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
129 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
130 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
131 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
132 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
133 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
134 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
135 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
136 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
137 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
138 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
139 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
140 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
141 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
142 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
144 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
145 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
146 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
147 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
148 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
149 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
150 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
151 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
152 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
153 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
154 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
155 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
157 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
158 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
159 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
160 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
161 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
163 % Since the category of space is not known, we have to be careful.
164 \chardef\spacecat = 10
165 \def\spaceisspace{\catcode`\ =\spacecat}
167 % sometimes characters are active, so we need control sequences.
168 \chardef\ampChar = `\&
169 \chardef\colonChar = `\:
170 \chardef\commaChar = `\,
171 \chardef\dashChar = `\-
172 \chardef\dotChar = `\.
173 \chardef\exclamChar= `\!
174 \chardef\hashChar = `\#
175 \chardef\lquoteChar= `\`
176 \chardef\questChar = `\?
177 \chardef\rquoteChar= `\'
178 \chardef\semiChar = `\;
179 \chardef\slashChar = `\/
180 \chardef\underChar = `\_
186 % The following is used inside several \edef's.
187 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
191 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
192 ap-pen-dix bit-map bit-maps
193 data-base data-bases eshell fall-ing half-way long-est man-u-script
194 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
195 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
197 stand-alone strong-est time-stamp time-stamps which-ever white-space
198 wide-spread wrap-around
201 % Margin to add to right of even pages, to left of odd pages.
202 \newdimen\bindingoffset
203 \newdimen\normaloffset
204 \newdimen\pagewidth \newdimen\pageheight
206 % For a final copy, take out the rectangles
207 % that mark overfull boxes (in case you have decided
208 % that the text looks ok even though it passes the margin).
210 \def\finalout{\overfullrule=0pt }
212 % Sometimes it is convenient to have everything in the transcript file
213 % and nothing on the terminal. We don't just call \tracingall here,
214 % since that produces some useless output on the terminal. We also make
215 % some effort to order the tracing commands to reduce output in the log
216 % file; cf. trace.sty in LaTeX.
218 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
222 \tracinglostchars2 % 2 gives us more in etex
227 \showboxbreadth\maxdimen \showboxdepth\maxdimen
228 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
235 \tracingcommands3 % 3 gives us more in etex
239 % @errormsg{MSG}. Do the index-like expansions on MSG, but if things
240 % aren't perfect, it's not the end of the world, being an error message,
243 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
244 \def\doerrormsg#1{\errmessage{#1}}
246 % add check for \lastpenalty to plain's definitions. If the last thing
247 % we did was a \nobreak, we don't want to insert more space.
249 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
250 \removelastskip\penalty-50\smallskip\fi\fi}
251 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
252 \removelastskip\penalty-100\medskip\fi\fi}
253 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
254 \removelastskip\penalty-200\bigskip\fi\fi}
256 % Do @cropmarks to get crop marks.
259 \let\cropmarks = \cropmarkstrue
261 % Dimensions to add cropmarks at corners.
262 % Added by P. A. MacKay, 12 Nov. 1986
264 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
265 \newdimen\cornerlong \cornerlong=1pc
266 \newdimen\cornerthick \cornerthick=.3pt
267 \newdimen\topandbottommargin \topandbottommargin=.75in
269 % Output a mark which sets \thischapter, \thissection and \thiscolor.
270 % We dump everything together because we only have one kind of mark.
271 % This works because we only use \botmark / \topmark, not \firstmark.
273 % A mark contains a subexpression of the \ifcase ... \fi construct.
274 % \get*marks macros below extract the needed part using \ifcase.
276 % Another complication is to let the user choose whether \thischapter
277 % (\thissection) refers to the chapter (section) in effect at the top
278 % of a page, or that at the bottom of a page. The solution is
279 % described on page 260 of The TeXbook. It involves outputting two
280 % marks for the sectioning macros, one before the section break, and
281 % one after. I won't pretend I can describe this better than DEK...
283 \toks0=\expandafter{\lastchapterdefs}%
284 \toks2=\expandafter{\lastsectiondefs}%
285 \toks4=\expandafter{\prevchapterdefs}%
286 \toks6=\expandafter{\prevsectiondefs}%
287 \toks8=\expandafter{\lastcolordefs}%
289 \the\toks0 \the\toks2 % 0: top marks (\last...)
290 \noexpand\or \the\toks4 \the\toks6 % 1: bottom marks (default, \prev...)
291 \noexpand\else \the\toks8 % 2: color marks
294 % \topmark doesn't work for the very first chapter (after the title
295 % page or the contents), so we use \firstmark there -- this gets us
296 % the mark with the chapter defs, unless the user sneaks in, e.g.,
297 % @setcolor (or @url, or @link, etc.) between @contents and the very
299 \def\gettopheadingmarks{%
301 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
303 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
304 \def\getcolormarks{\ifcase2\topmark\fi}
306 % Avoid "undefined control sequence" errors.
307 \def\lastchapterdefs{}
308 \def\lastsectiondefs{}
309 \def\prevchapterdefs{}
310 \def\prevsectiondefs{}
313 % Main output routine.
315 \output = {\onepageout{\pagecontents\PAGE}}
320 % \onepageout takes a vbox as an argument. Note that \pagecontents
321 % does insertions, but you have to call it yourself.
323 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
325 \ifodd\pageno \advance\hoffset by \bindingoffset
326 \else \advance\hoffset by -\bindingoffset\fi
328 % Do this outside of the \shipout so @code etc. will be expanded in
329 % the headline as they should be, not taken literally (outputting ''code).
330 \def\commmonheadfootline{\let\hsize=\pagewidth \texinfochars}
332 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
333 \global\setbox\headlinebox = \vbox{\commmonheadfootline \makeheadline}%
335 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
336 \global\setbox\footlinebox = \vbox{\commmonheadfootline \makefootline}%
339 % Have to do this stuff outside the \shipout because we want it to
340 % take effect in \write's, yet the group defined by the \vbox ends
341 % before the \shipout runs.
343 \indexdummies % don't expand commands in the output.
344 \normalturnoffactive % \ in index entries must not stay \, e.g., if
345 % the page break happens to be in the middle of an example.
346 % We don't want .vr (or whatever) entries like this:
347 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
348 % "\acronym" won't work when it's read back in;
350 % {\code {{\tt \backslashcurfont }acronym}
352 % Do this early so pdf references go to the beginning of the page.
353 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
355 \ifcropmarks \vbox to \outervsize\bgroup
357 \vskip-\topandbottommargin
359 \line{\ewtop\hfil\ewtop}%
362 \vbox{\moveleft\cornerthick\nstop}%
364 \vbox{\moveright\cornerthick\nstop}%
367 \vskip\topandbottommargin
369 \hfil % center the page within the outer (page) hsize.
370 \ifodd\pageno\hskip\bindingoffset\fi
376 \ifdim\ht\footlinebox > 0pt
377 % Only leave this space if the footline is nonempty.
378 % (We lessened \vsize for it in \oddfootingyyy.)
379 % The \baselineskip=24pt in plain's \makefootline has no effect.
385 \egroup % end of \vbox\bgroup
386 \hfil\egroup % end of (centering) \line\bgroup
387 \vskip\topandbottommargin plus1fill minus1fill
388 \boxmaxdepth = \cornerthick
391 \vbox{\moveleft\cornerthick\nsbot}%
393 \vbox{\moveright\cornerthick\nsbot}%
396 \line{\ewbot\hfil\ewbot}%
398 \egroup % \vbox from first cropmarks clause
400 }% end of \shipout\vbox
401 }% end of group with \indexdummies
403 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
406 \newinsert\margin \dimen\margin=\maxdimen
408 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
410 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
411 % marginal hacks, juha@viisa.uucp (Juha Takala)
412 \ifvoid\margin\else % marginal info is present
413 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
414 \dimen@=\dp#1\relax \unvbox#1\relax
415 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
416 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
419 % Here are the rules for the cropmarks. Note that they are
420 % offset so that the space between them is truly \outerhsize or \outervsize
421 % (P. A. MacKay, 12 November, 1986)
423 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
425 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
426 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
428 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
430 % Parse an argument, then pass it to #1. The argument is the rest of
431 % the input line (except we remove a trailing comment). #1 should be a
432 % macro which expects an ordinary undelimited TeX argument.
434 \def\parsearg{\parseargusing{}}
435 \def\parseargusing#1#2{%
441 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
445 \gdef\parseargline#1^^M{%
446 \endgroup % End of the group started in \parsearg.
447 \argremovecomment #1\comment\ArgTerm%
451 % First remove any @comment, then any @c comment.
452 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
453 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
455 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
457 % \argremovec might leave us with trailing space, e.g.,
458 % @end itemize @c foo
459 % This space token undergoes the same procedure and is eventually removed
460 % by \finishparsearg.
462 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
463 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
464 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
467 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
468 \let\temp\finishparsearg
470 \let\temp\argcheckspaces
472 % Put the space token in:
476 % If a _delimited_ argument is enclosed in braces, they get stripped; so
477 % to get _exactly_ the rest of the line, we had to prevent such situation.
478 % We prepended an \empty token at the very beginning and we expand it now,
479 % just before passing the control to \argtorun.
480 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
481 % either the null string, or it ends with \^^M---thus there is no danger
482 % that a pair of braces would be stripped.
484 % But first, we have to remove the trailing space token.
486 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
488 % \parseargdef\foo{...}
489 % is roughly equivalent to
490 % \def\foo{\parsearg\Xfoo}
493 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
494 % favourite TeX trick. --kasal, 16nov03
497 \expandafter \doparseargdef \csname\string#1\endcsname #1%
499 \def\doparseargdef#1#2{%
504 % Several utility definitions with active space:
509 % Make each space character in the input produce a normal interword
510 % space in the output. Don't allow a line break at this space, as this
511 % is used only in environments like @example, where each line of input
512 % should produce a line of output anyway.
514 \gdef\sepspaces{\obeyspaces\let =\tie}
516 % If an index command is used in an @example environment, any spaces
517 % therein should become regular spaces in the raw index file, not the
518 % expansion of \tie (\leavevmode \penalty \@M \ ).
519 \gdef\unsepspaces{\let =\space}
523 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
525 % Define the framework for environments in texinfo.tex. It's used like this:
530 % It's the responsibility of \envdef to insert \begingroup before the
531 % actual body; @end closes the group after calling \Efoo. \envdef also
532 % defines \thisenv, so the current environment is known; @end checks
533 % whether the environment name matches. The \checkenv macro can also be
534 % used to check whether the current environment is the one expected.
536 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
537 % are not treated as environments; they don't open a group. (The
538 % implementation of @end takes care not to call \endgroup in this
542 % At run-time, environments start with this:
543 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
547 % ... but they get defined via ``\envdef\foo{...}'':
548 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
549 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
551 % Check whether we're in the right environment:
560 % Environment mismatch, #1 expected:
563 \errmessage{This command can appear only \inenvironment\temp,
564 not \inenvironment\thisenv}%
566 \def\inenvironment#1{%
568 outside of any environment%
570 in environment \expandafter\string#1%
574 % @end foo executes the definition of \Efoo.
575 % But first, it executes a specialized version of \checkenv
578 \if 1\csname iscond.#1\endcsname
580 % The general wording of \badenverr may not be ideal.
581 \expandafter\checkenv\csname#1\endcsname
582 \csname E#1\endcsname
587 \newhelp\EMsimple{Press RETURN to continue.}
590 % Be sure we're in horizontal mode when doing a tie, since we make space
591 % equivalent to this in @example-like environments. Otherwise, a space
592 % at the beginning of a line will start with \penalty -- and
593 % since \penalty is valid in vertical mode, we'd end up putting the
594 % penalty on the vertical list instead of in the new paragraph.
596 % Avoid using \@M directly, because that causes trouble
597 % if the definition is written into an index file.
598 \global\let\tiepenalty = \@M
599 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
602 % @: forces normal size whitespace following.
603 \def\:{\spacefactor=1000 }
605 % @* forces a line break.
606 \def\*{\unskip\hfil\break\hbox{}\ignorespaces}
608 % @/ allows a line break.
611 % @. is an end-of-sentence period.
612 \def\.{.\spacefactor=\endofsentencespacefactor\space}
614 % @! is an end-of-sentence bang.
615 \def\!{!\spacefactor=\endofsentencespacefactor\space}
617 % @? is an end-of-sentence query.
618 \def\?{?\spacefactor=\endofsentencespacefactor\space}
620 % @frenchspacing on|off says whether to put extra space after punctuation.
625 \parseargdef\frenchspacing{%
627 \ifx\temp\onword \plainfrenchspacing
628 \else\ifx\temp\offword \plainnonfrenchspacing
631 \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
635 % @w prevents a word break. Without the \leavevmode, @w at the
636 % beginning of a paragraph, when TeX is still in vertical mode, would
637 % produce a whole line of output instead of starting the paragraph.
638 \def\w#1{\leavevmode\hbox{#1}}
640 % @group ... @end group forces ... to be all on one page, by enclosing
641 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
642 % to keep its height that of a normal line. According to the rules for
643 % \topskip (p.114 of the TeXbook), the glue inserted is
644 % max (\topskip - \ht (first item), 0). If that height is large,
645 % therefore, no glue is inserted, and the space between the headline and
646 % the text is small, which looks bad.
648 % Another complication is that the group might be very large. This can
649 % cause the glue on the previous page to be unduly stretched, because it
650 % does not have much material. In this case, it's better to add an
651 % explicit \vfill so that the extra space is at the bottom. The
652 % threshold for doing this is if the group is more than \vfilllimit
653 % percent of a page (\vfilllimit can be changed inside of @tex).
659 \ifnum\catcode`\^^M=\active \else
660 \errhelp = \groupinvalidhelp
661 \errmessage{@group invalid in context where filling is enabled}%
665 \setbox\groupbox = \vtop\bgroup
666 % Do @comment since we are called inside an environment such as
667 % @example, where each end-of-line in the input causes an
668 % end-of-line in the output. We don't want the end-of-line after
669 % the `@group' to put extra space in the output. Since @group
670 % should appear on a line by itself (according to the Texinfo
671 % manual), we don't worry about eating any user text.
675 % The \vtop produces a box with normal height and large depth; thus, TeX puts
676 % \baselineskip glue before it, and (when the next line of text is done)
677 % \lineskip glue after it. Thus, space below is not quite equal to space
678 % above. But it's pretty close.
680 % To get correct interline space between the last line of the group
681 % and the first line afterwards, we have to propagate \prevdepth.
682 \endgraf % Not \par, as it may have been set to \lisppar.
683 \global\dimen1 = \prevdepth
684 \egroup % End the \vtop.
685 % \dimen0 is the vertical size of the group's box.
686 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
687 % \dimen2 is how much space is left on the page (more or less).
688 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
689 % if the group doesn't fit on the current page, and it's a big big
690 % group, force a page break.
691 \ifdim \dimen0 > \dimen2
692 \ifdim \pagetotal < \vfilllimit\pageheight
701 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
702 % message, so this ends up printing `@group can only ...'.
704 \newhelp\groupinvalidhelp{%
705 group can only be used in environments such as @example,^^J%
706 where each line of input produces a line of output.}
708 % @need space-in-mils
709 % forces a page break if there is not space-in-mils remaining.
711 \newdimen\mil \mil=0.001in
714 % Ensure vertical mode, so we don't make a big box in the middle of a
718 % If the @need value is less than one line space, it's useless.
720 \dimen2 = \ht\strutbox
721 \advance\dimen2 by \dp\strutbox
722 \ifdim\dimen0 > \dimen2
724 % Do a \strut just to make the height of this box be normal, so the
725 % normal leading is inserted relative to the preceding line.
726 % And a page break here is fine.
727 \vtop to #1\mil{\strut\vfil}%
729 % TeX does not even consider page breaks if a penalty added to the
730 % main vertical list is 10000 or more. But in order to see if the
731 % empty box we just added fits on the page, we must make it consider
732 % page breaks. On the other hand, we don't want to actually break the
733 % page after the empty box. So we use a penalty of 9999.
735 % There is an extremely small chance that TeX will actually break the
736 % page at this \penalty, if there are no other feasible breakpoints in
737 % sight. (If the user is using lots of big @group commands, which
738 % almost-but-not-quite fill up a page, TeX will have a hard time doing
739 % good page breaking, for example.) However, I could not construct an
740 % example where a page broke at this \penalty; if it happens in a real
741 % document, then we can reconsider our strategy.
744 % Back up by the size of the box, whether we did a page break or not.
747 % Do not allow a page break right after this kern.
752 % @br forces paragraph break (and is undocumented).
756 % @page forces the start of a new page.
758 \def\page{\par\vfill\supereject}
761 % outputs text on separate line in roman font, starting at standard page margin
763 % This records the amount of indent in the innermost environment.
764 % That's how much \exdent should take out.
765 \newskip\exdentamount
767 % This defn is used inside fill environments such as @defun.
768 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
770 % This defn is used inside nofill environments such as @example.
771 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
772 \leftline{\hskip\leftskip{\rm#1}}}}
774 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
775 % paragraph. For more general purposes, use the \margin insertion
776 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
778 \newskip\inmarginspacing \inmarginspacing=1cm
779 \def\strutdepth{\dp\strutbox}
781 \def\doinmargin#1#2{\strut\vadjust{%
784 \vtop to \strutdepth{%
785 \baselineskip=\strutdepth
787 % if you have multiple lines of stuff to put here, you'll need to
788 % make the vbox yourself of the appropriate size.
790 \llap{\ignorespaces #2\hskip\inmarginspacing}%
792 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
797 \def\inleftmargin{\doinmargin l}
798 \def\inrightmargin{\doinmargin r}
800 % @inmargin{TEXT [, RIGHT-TEXT]}
801 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
802 % else use TEXT for both).
804 \def\inmargin#1{\parseinmargin #1,,\finish}
805 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
806 \setbox0 = \hbox{\ignorespaces #2}%
808 \def\lefttext{#1}% have both texts
811 \def\lefttext{#1}% have only one text
816 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
818 \def\temp{\inleftmargin\lefttext}%
823 % @| inserts a changebar to the left of the current line. It should
824 % surround any changed text. This approach does *not* work if the
825 % change spans more than two lines of output. To handle that, we would
826 % have adopt a much more difficult approach (putting marks into the main
827 % vertical list for the beginning and end of each change). This command
828 % is not documented, not supported, and doesn't work.
831 % \vadjust can only be used in horizontal mode.
834 % Append this vertical mode material after the current line in the output.
836 % We want to insert a rule with the height and depth of the current
837 % leading; that is exactly what \strutbox is supposed to record.
840 % \vadjust-items are inserted at the left edge of the type. So
841 % the \llap here moves out into the left-hand margin.
844 % For a thicker or thinner bar, change the `1pt'.
845 \vrule height\baselineskip width1pt
847 % This is the space between the bar and the text.
853 % @include FILE -- \input text of FILE.
855 \def\include{\parseargusing\filenamecatcodes\includezzz}
860 \makevalueexpandable % we want to expand any @value in FILE.
861 \turnoffactive % and allow special characters in the expansion
862 \indexnofonts % Allow `@@' and other weird things in file names.
863 \wlog{texinfo.tex: doing @include of #1^^J}%
864 \edef\temp{\noexpand\input #1 }%
866 % This trickery is to read FILE outside of a group, in case it makes
872 \def\filenamecatcodes{%
886 \def\pushthisfilestack{%
887 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
889 \def\pushthisfilestackX{%
890 \expandafter\pushthisfilestackY\thisfile\StackTerm
892 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
893 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
896 \def\popthisfilestack{\errthisfilestackempty}
897 \def\errthisfilestackempty{\errmessage{Internal error:
898 the stack of filenames is empty.}}
903 % outputs that line, centered.
905 \parseargdef\center{%
907 \let\centersub\centerH
909 \let\centersub\centerV
911 \centersub{\hfil \ignorespaces#1\unskip \hfil}%
912 \let\centersub\relax % don't let the definition persist, just in case
916 \advance\hsize by -\leftskip
917 \advance\hsize by -\rightskip
922 \newcount\centerpenalty
924 % The idea here is the same as in \startdefun, \cartouche, etc.: if
925 % @center is the first thing after a section heading, we need to wipe
926 % out the negative parskip inserted by \sectionheading, but still
927 % prevent a page break here.
928 \centerpenalty = \lastpenalty
929 \ifnum\centerpenalty>10000 \vskip\parskip \fi
930 \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi
931 \line{\kern\leftskip #1\kern\rightskip}%
934 % @sp n outputs n lines of vertical space
936 \parseargdef\sp{\vskip #1\baselineskip}
938 % @comment ...line which is ignored...
939 % @c is the same as @comment
940 % @ignore ... @end ignore is another way to write a comment
942 \def\comment{\begingroup \catcode`\^^M=\other%
943 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
945 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
949 % @paragraphindent NCHARS
950 % We'll use ems for NCHARS, close enough.
951 % NCHARS can also be the word `asis' or `none'.
952 % We cannot feasibly implement @paragraphindent asis, though.
954 \def\asisword{asis} % no translation, these are keywords
957 \parseargdef\paragraphindent{%
962 \defaultparindent = 0pt
964 \defaultparindent = #1em
967 \parindent = \defaultparindent
970 % @exampleindent NCHARS
971 % We'll use ems for NCHARS like @paragraphindent.
972 % It seems @exampleindent asis isn't necessary, but
973 % I preserve it to make it similar to @paragraphindent.
974 \parseargdef\exampleindent{%
981 \lispnarrowing = #1em
986 % @firstparagraphindent WORD
987 % If WORD is `none', then suppress indentation of the first paragraph
988 % after a section heading. If WORD is `insert', then do indent at such
991 % The paragraph indentation is suppressed or not by calling
992 % \suppressfirstparagraphindent, which the sectioning commands do.
993 % We switch the definition of this back and forth according to WORD.
994 % By default, we suppress indentation.
996 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
997 \def\insertword{insert}
999 \parseargdef\firstparagraphindent{%
1002 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1003 \else\ifx\temp\insertword
1004 \let\suppressfirstparagraphindent = \relax
1006 \errhelp = \EMsimple
1007 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1011 % Here is how we actually suppress indentation. Redefine \everypar to
1012 % \kern backwards by \parindent, and then reset itself to empty.
1014 % We also make \indent itself not actually do anything until the next
1017 \gdef\dosuppressfirstparagraphindent{%
1018 \gdef\indent {\restorefirstparagraphindent \indent}%
1019 \gdef\noindent{\restorefirstparagraphindent \noindent}%
1020 \global\everypar = {\kern -\parindent \restorefirstparagraphindent}%
1023 \gdef\restorefirstparagraphindent{%
1024 \global\let\indent = \ptexindent
1025 \global\let\noindent = \ptexnoindent
1026 \global\everypar = {}%
1030 % @refill is a no-op.
1033 % If working on a large document in chapters, it is convenient to
1034 % be able to disable indexing, cross-referencing, and contents, for test runs.
1035 % This is done with @novalidate (before @setfilename).
1037 \newif\iflinks \linkstrue % by default we want the aux files.
1038 \let\novalidate = \linksfalse
1040 % @setfilename is done at the beginning of every texinfo file.
1041 % So open here the files we need to have open while reading the input.
1042 % This makes it possible to make a .fmt file for texinfo.
1044 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1047 % Open the new aux file. TeX will close it automatically at exit.
1048 \immediate\openout\auxfile=\jobname.aux
1049 \fi % \openindices needs to do some work in any case.
1051 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1053 % If texinfo.cnf is present on the system, read it.
1054 % Useful for site-wide @afourpaper, etc.
1055 \openin 1 texinfo.cnf
1056 \ifeof 1 \else \input texinfo.cnf \fi
1059 \comment % Ignore the actual filename.
1062 % Called from \setfilename.
1074 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1078 % adobe `portable' document format
1082 \newcount\filenamelength
1091 \newif\ifpdfmakepagedest
1093 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1094 % can be set). So we test for \relax and 0 as well as being undefined.
1095 \ifx\pdfoutput\thisisundefined
1097 \ifx\pdfoutput\relax
1106 % PDF uses PostScript string constants for the names of xref targets,
1107 % for display in the outlines, and in other places. Thus, we have to
1108 % double any backslashes. Otherwise, a name like "\node" will be
1109 % interpreted as a newline (\n), followed by o, d, e. Not good.
1111 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1112 % related messages. The final outcome is that it is up to the TeX user
1113 % to double the backslashes and otherwise make the string valid, so
1114 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1115 % do this reliably, so we use it.
1117 % #1 is a control sequence in which to do the replacements,
1119 \def\txiescapepdf#1{%
1120 \ifx\pdfescapestring\thisisundefined
1121 % No primitive available; should we give a warning or log?
1122 % Many times it won't matter.
1124 % The expandable \pdfescapestring primitive escapes parentheses,
1125 % backslashes, and other special chars.
1126 \xdef#1{\pdfescapestring{#1}}%
1130 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1131 with PDF output, and none of those formats could be found. (.eps cannot
1132 be supported due to the design of the PDF format; use regular TeX (DVI
1137 % Color manipulation macros using ideas from pdfcolor.tex,
1138 % except using rgb instead of cmyk; the latter is said to render as a
1139 % very dark gray on-screen and a very dark halftone in print, instead
1140 % of actual black. The dark red here is dark enough to print on paper as
1141 % nearly black, but still distinguishable for online viewing. We use
1142 % black by default, though.
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 black for everything.
1253 \def\urlcolor{\rgbBlack}
1254 \def\linkcolor{\rgbBlack}
1255 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1257 % Adding outlines to PDF; macros for calculating structure of outlines
1258 % come from Petr Olsak
1259 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1260 \else \csname#1\endcsname \fi}
1261 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1262 \advance\tempnum by 1
1263 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1265 % #1 is the section text, which is what will be displayed in the
1266 % outline by the pdf viewer. #2 is the pdf expression for the number
1267 % of subentries (or empty, for subsubsections). #3 is the node text,
1268 % which might be empty if this toc entry had no corresponding node.
1269 % #4 is the page number
1271 \def\dopdfoutline#1#2#3#4{%
1272 % Generate a link to the node text if that exists; else, use the
1273 % page number. We could generate a destination for the section
1274 % text in the case where a section has no node, but it doesn't
1275 % seem worth the trouble, since most documents are normally structured.
1276 \edef\pdfoutlinedest{#3}%
1277 \ifx\pdfoutlinedest\empty
1278 \def\pdfoutlinedest{#4}%
1280 \txiescapepdf\pdfoutlinedest
1283 % Also escape PDF chars in the display string.
1284 \edef\pdfoutlinetext{#1}%
1285 \txiescapepdf\pdfoutlinetext
1287 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1290 \def\pdfmakeoutlines{%
1292 % Read toc silently, to get counts of subentries for \pdfoutline.
1293 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1294 \def\numchapentry##1##2##3##4{%
1295 \def\thischapnum{##2}%
1297 \def\thissubsecnum{0}%
1299 \def\numsecentry##1##2##3##4{%
1300 \advancenumber{chap\thischapnum}%
1301 \def\thissecnum{##2}%
1302 \def\thissubsecnum{0}%
1304 \def\numsubsecentry##1##2##3##4{%
1305 \advancenumber{sec\thissecnum}%
1306 \def\thissubsecnum{##2}%
1308 \def\numsubsubsecentry##1##2##3##4{%
1309 \advancenumber{subsec\thissubsecnum}%
1311 \def\thischapnum{0}%
1313 \def\thissubsecnum{0}%
1315 % use \def rather than \let here because we redefine \chapentry et
1316 % al. a second time, below.
1317 \def\appentry{\numchapentry}%
1318 \def\appsecentry{\numsecentry}%
1319 \def\appsubsecentry{\numsubsecentry}%
1320 \def\appsubsubsecentry{\numsubsubsecentry}%
1321 \def\unnchapentry{\numchapentry}%
1322 \def\unnsecentry{\numsecentry}%
1323 \def\unnsubsecentry{\numsubsecentry}%
1324 \def\unnsubsubsecentry{\numsubsubsecentry}%
1327 % Read toc second time, this time actually producing the outlines.
1328 % The `-' means take the \expnumber as the absolute number of
1329 % subentries, which we calculated on our first read of the .toc above.
1331 % We use the node names as the destinations.
1332 \def\numchapentry##1##2##3##4{%
1333 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1334 \def\numsecentry##1##2##3##4{%
1335 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1336 \def\numsubsecentry##1##2##3##4{%
1337 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1338 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1339 \dopdfoutline{##1}{}{##3}{##4}}%
1341 % PDF outlines are displayed using system fonts, instead of
1342 % document fonts. Therefore we cannot use special characters,
1343 % since the encoding is unknown. For example, the eogonek from
1344 % Latin 2 (0xea) gets translated to a | character. Info from
1345 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1347 % TODO this right, we have to translate 8-bit characters to
1348 % their "best" equivalent, based on the @documentencoding. Too
1349 % much work for too little return. Just use the ASCII equivalents
1350 % we use for the index sort strings.
1354 % We can have normal brace characters in the PDF outlines, unlike
1355 % Texinfo index files. So set that up.
1356 \def\{{\lbracecharliteral}%
1357 \def\}{\rbracecharliteral}%
1358 \catcode`\\=\active \otherbackslash
1359 \input \tocreadfilename
1362 {\catcode`[=1 \catcode`]=2
1363 \catcode`{=\other \catcode`}=\other
1364 \gdef\lbracecharliteral[{]%
1365 \gdef\rbracecharliteral[}]%
1368 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1369 \ifx\PP\D\let\nextsp\relax
1370 \else\let\nextsp\skipspaces
1371 \addtokens{\filename}{\PP}%
1372 \advance\filenamelength by 1
1375 \def\getfilename#1{%
1377 % If we don't expand the argument now, \skipspaces will get
1378 % snagged on things like "@value{foo}".
1380 \expandafter\skipspaces\temp|\relax
1382 \ifnum\pdftexversion < 14
1383 \let \startlink \pdfannotlink
1385 \let \startlink \pdfstartlink
1387 % make a live url in pdf output.
1390 % it seems we really need yet another set of dummies; have not
1391 % tried to figure out what each command should do in the context
1392 % of @url. for now, just make @/ a no-op, that's the only one
1393 % people have actually reported a problem with.
1395 \normalturnoffactive
1398 \makevalueexpandable
1399 % do we want to go so far as to use \indexnofonts instead of just
1400 % special-casing \var here?
1403 \leavevmode\setcolor{\urlcolor}%
1404 \startlink attr{/Border [0 0 0]}%
1405 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1407 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1408 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1409 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1410 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1412 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1414 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1415 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1416 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1418 \ifnum0=\countA\else\makelink\fi
1419 \ifx\first.\let\next=\done\else
1421 \addtokens{\toksB}{\the\toksD}
1422 \ifx\first,\addtokens{\toksB}{\space}\fi
1424 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1426 \def\makelink{\addtokens{\toksB}%
1427 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1429 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1430 \setcolor{\linkcolor}#1\endlink}
1431 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1434 \let\pdfmkdest = \gobble
1435 \let\pdfurl = \gobble
1436 \let\endlink = \relax
1437 \let\setcolor = \gobble
1438 \let\pdfsetcolor = \gobble
1439 \let\pdfmakeoutlines = \relax
1440 \fi % \ifx\pdfoutput
1445 % Change the current font style to #1, remembering it in \curfontstyle.
1446 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1447 % italics, not bold italics.
1449 \def\setfontstyle#1{%
1450 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1451 \csname ten#1\endcsname % change the current font
1454 % Select #1 fonts with the current style.
1456 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1458 \def\rm{\fam=0 \setfontstyle{rm}}
1459 \def\it{\fam=\itfam \setfontstyle{it}}
1460 \def\sl{\fam=\slfam \setfontstyle{sl}}
1461 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1462 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1464 % Unfortunately, we have to override this for titles and the like, since
1465 % in those cases "rm" is bold. Sigh.
1466 \def\rmisbold{\rm\def\curfontstyle{bf}}
1468 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1469 % So we set up a \sf.
1471 \def\sf{\fam=\sffam \setfontstyle{sf}}
1472 \let\li = \sf % Sometimes we call it \li, not \sf.
1474 % We don't need math for this font style.
1475 \def\ttsl{\setfontstyle{ttsl}}
1478 % Set the baselineskip to #1, and the lineskip and strut size
1479 % correspondingly. There is no deep meaning behind these magic numbers
1480 % used as factors; they just match (closely enough) what Knuth defined.
1482 \def\lineskipfactor{.08333}
1483 \def\strutheightpercent{.70833}
1484 \def\strutdepthpercent {.29167}
1486 % can get a sort of poor man's double spacing by redefining this.
1487 \def\baselinefactor{1}
1489 \newdimen\textleading
1492 \normalbaselineskip = \baselinefactor\dimen0
1493 \normallineskip = \lineskipfactor\normalbaselineskip
1495 \setbox\strutbox =\hbox{%
1496 \vrule width0pt height\strutheightpercent\baselineskip
1497 depth \strutdepthpercent \baselineskip
1501 % PDF CMaps. See also LaTeX's t1.cmap.
1503 % do nothing with this by default.
1504 \expandafter\let\csname cmapOT1\endcsname\gobble
1505 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1506 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1508 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1509 % (\pdffontattr was introduced many years ago, but people still run
1510 % older pdftex's; it's easy to conditionalize, so we do.)
1511 \ifpdf \ifx\pdffontattr\thisisundefined \else
1513 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1514 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1515 %%DocumentNeededResources: ProcSet (CIDInit)
1516 %%IncludeResource: ProcSet (CIDInit)
1517 %%BeginResource: CMap (TeX-OT1-0)
1518 %%Title: (TeX-OT1-0 TeX OT1 0)
1521 /CIDInit /ProcSet findresource begin
1529 /CMapName /TeX-OT1-0 def
1531 1 begincodespacerange
1587 CMapName currentdict /CMap defineresource pop
1593 \expandafter\edef\csname cmapOT1\endcsname#1{%
1594 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1599 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1600 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1601 %%DocumentNeededResources: ProcSet (CIDInit)
1602 %%IncludeResource: ProcSet (CIDInit)
1603 %%BeginResource: CMap (TeX-OT1IT-0)
1604 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1607 /CIDInit /ProcSet findresource begin
1615 /CMapName /TeX-OT1IT-0 def
1617 1 begincodespacerange
1675 CMapName currentdict /CMap defineresource pop
1681 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1682 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1687 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1688 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1689 %%DocumentNeededResources: ProcSet (CIDInit)
1690 %%IncludeResource: ProcSet (CIDInit)
1691 %%BeginResource: CMap (TeX-OT1TT-0)
1692 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1695 /CIDInit /ProcSet findresource begin
1703 /CMapName /TeX-OT1TT-0 def
1705 1 begincodespacerange
1750 CMapName currentdict /CMap defineresource pop
1756 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1757 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1762 % Set the font macro #1 to the font named \fontprefix#2.
1763 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1764 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
1772 \def\setfont#1#2#3#4#5{%
1773 \font#1=\fontprefix#2#3 scaled #4
1774 \csname cmap#5\endcsname#1%
1776 % This is what gets called when #5 of \setfont is empty.
1781 % Use cm as the default font prefix.
1782 % To specify the font prefix, you must define \fontprefix
1783 % before you read in texinfo.tex.
1784 \ifx\fontprefix\thisisundefined
1787 % Support font families that don't use the same naming scheme as CM.
1789 \def\rmbshape{bx} % where the normal face is bold
1794 \def\ttslshape{sltt}
1804 % Definitions for a main text size of 11pt. (The default in Texinfo.)
1806 \def\definetextfontsizexi{%
1807 % Text fonts (11.2pt, magstep1).
1808 \def\textnominalsize{11pt}
1809 \edef\mainmagstep{\magstephalf}
1810 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1811 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1812 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1813 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1814 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1815 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1816 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1817 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1818 \font\texti=cmmi10 scaled \mainmagstep
1819 \font\textsy=cmsy10 scaled \mainmagstep
1820 \def\textecsize{1095}
1822 % A few fonts for @defun names and args.
1823 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1824 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1825 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1826 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1828 % Fonts for indices, footnotes, small examples (9pt).
1829 \def\smallnominalsize{9pt}
1830 \setfont\smallrm\rmshape{9}{1000}{OT1}
1831 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1832 \setfont\smallbf\bfshape{10}{900}{OT1}
1833 \setfont\smallit\itshape{9}{1000}{OT1IT}
1834 \setfont\smallsl\slshape{9}{1000}{OT1}
1835 \setfont\smallsf\sfshape{9}{1000}{OT1}
1836 \setfont\smallsc\scshape{10}{900}{OT1}
1837 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1840 \def\smallecsize{0900}
1842 % Fonts for small examples (8pt).
1843 \def\smallernominalsize{8pt}
1844 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1845 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1846 \setfont\smallerbf\bfshape{10}{800}{OT1}
1847 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1848 \setfont\smallersl\slshape{8}{1000}{OT1}
1849 \setfont\smallersf\sfshape{8}{1000}{OT1}
1850 \setfont\smallersc\scshape{10}{800}{OT1}
1851 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1852 \font\smalleri=cmmi8
1853 \font\smallersy=cmsy8
1854 \def\smallerecsize{0800}
1856 % Fonts for title page (20.4pt):
1857 \def\titlenominalsize{20pt}
1858 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1859 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1860 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1861 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1862 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1863 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1864 \let\titlebf=\titlerm
1865 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1866 \font\titlei=cmmi12 scaled \magstep3
1867 \font\titlesy=cmsy10 scaled \magstep4
1868 \def\titleecsize{2074}
1870 % Chapter (and unnumbered) fonts (17.28pt).
1871 \def\chapnominalsize{17pt}
1872 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
1873 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
1874 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
1875 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
1876 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
1877 \setfont\chapsf\sfbshape{17}{1000}{OT1}
1879 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
1880 \font\chapi=cmmi12 scaled \magstep2
1881 \font\chapsy=cmsy10 scaled \magstep3
1882 \def\chapecsize{1728}
1884 % Section fonts (14.4pt).
1885 \def\secnominalsize{14pt}
1886 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
1887 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
1888 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
1889 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
1890 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
1891 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
1893 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
1894 \font\seci=cmmi12 scaled \magstep1
1895 \font\secsy=cmsy10 scaled \magstep2
1896 \def\sececsize{1440}
1898 % Subsection fonts (13.15pt).
1899 \def\ssecnominalsize{13pt}
1900 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
1901 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
1902 \setfont\ssecsl\slbshape{10}{1315}{OT1}
1903 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
1904 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
1905 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
1907 \setfont\ssecsc\scbshape{10}{1315}{OT1}
1908 \font\sseci=cmmi12 scaled \magstephalf
1909 \font\ssecsy=cmsy10 scaled 1315
1910 \def\ssececsize{1200}
1912 % Reduced fonts for @acro in text (10pt).
1913 \def\reducednominalsize{10pt}
1914 \setfont\reducedrm\rmshape{10}{1000}{OT1}
1915 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
1916 \setfont\reducedbf\bfshape{10}{1000}{OT1}
1917 \setfont\reducedit\itshape{10}{1000}{OT1IT}
1918 \setfont\reducedsl\slshape{10}{1000}{OT1}
1919 \setfont\reducedsf\sfshape{10}{1000}{OT1}
1920 \setfont\reducedsc\scshape{10}{1000}{OT1}
1921 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
1922 \font\reducedi=cmmi10
1923 \font\reducedsy=cmsy10
1924 \def\reducedecsize{1000}
1926 \textleading = 13.2pt % line spacing for 11pt CM
1927 \textfonts % reset the current fonts
1929 } % end of 11pt text font size definitions, \definetextfontsizexi
1932 % Definitions to make the main text be 10pt Computer Modern, with
1933 % section, chapter, etc., sizes following suit. This is for the GNU
1934 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1935 % future. Used with @smallbook, which sets the leading to 12pt.
1937 \def\definetextfontsizex{%
1938 % Text fonts (10pt).
1939 \def\textnominalsize{10pt}
1940 \edef\mainmagstep{1000}
1941 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1942 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1943 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1944 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1945 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1946 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1947 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1948 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1949 \font\texti=cmmi10 scaled \mainmagstep
1950 \font\textsy=cmsy10 scaled \mainmagstep
1951 \def\textecsize{1000}
1953 % A few fonts for @defun names and args.
1954 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
1955 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
1956 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
1957 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
1959 % Fonts for indices, footnotes, small examples (9pt).
1960 \def\smallnominalsize{9pt}
1961 \setfont\smallrm\rmshape{9}{1000}{OT1}
1962 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
1963 \setfont\smallbf\bfshape{10}{900}{OT1}
1964 \setfont\smallit\itshape{9}{1000}{OT1IT}
1965 \setfont\smallsl\slshape{9}{1000}{OT1}
1966 \setfont\smallsf\sfshape{9}{1000}{OT1}
1967 \setfont\smallsc\scshape{10}{900}{OT1}
1968 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
1971 \def\smallecsize{0900}
1973 % Fonts for small examples (8pt).
1974 \def\smallernominalsize{8pt}
1975 \setfont\smallerrm\rmshape{8}{1000}{OT1}
1976 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
1977 \setfont\smallerbf\bfshape{10}{800}{OT1}
1978 \setfont\smallerit\itshape{8}{1000}{OT1IT}
1979 \setfont\smallersl\slshape{8}{1000}{OT1}
1980 \setfont\smallersf\sfshape{8}{1000}{OT1}
1981 \setfont\smallersc\scshape{10}{800}{OT1}
1982 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
1983 \font\smalleri=cmmi8
1984 \font\smallersy=cmsy8
1985 \def\smallerecsize{0800}
1987 % Fonts for title page (20.4pt):
1988 \def\titlenominalsize{20pt}
1989 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
1990 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
1991 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
1992 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
1993 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
1994 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
1995 \let\titlebf=\titlerm
1996 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
1997 \font\titlei=cmmi12 scaled \magstep3
1998 \font\titlesy=cmsy10 scaled \magstep4
1999 \def\titleecsize{2074}
2001 % Chapter fonts (14.4pt).
2002 \def\chapnominalsize{14pt}
2003 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2004 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2005 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2006 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2007 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2008 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2010 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2011 \font\chapi=cmmi12 scaled \magstep1
2012 \font\chapsy=cmsy10 scaled \magstep2
2013 \def\chapecsize{1440}
2015 % Section fonts (12pt).
2016 \def\secnominalsize{12pt}
2017 \setfont\secrm\rmbshape{12}{1000}{OT1}
2018 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2019 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2020 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2021 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2022 \setfont\secsf\sfbshape{12}{1000}{OT1}
2024 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2026 \font\secsy=cmsy10 scaled \magstep1
2027 \def\sececsize{1200}
2029 % Subsection fonts (10pt).
2030 \def\ssecnominalsize{10pt}
2031 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2032 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2033 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2034 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2035 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2036 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2038 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2041 \def\ssececsize{1000}
2043 % Reduced fonts for @acro in text (9pt).
2044 \def\reducednominalsize{9pt}
2045 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2046 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2047 \setfont\reducedbf\bfshape{10}{900}{OT1}
2048 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2049 \setfont\reducedsl\slshape{9}{1000}{OT1}
2050 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2051 \setfont\reducedsc\scshape{10}{900}{OT1}
2052 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2053 \font\reducedi=cmmi9
2054 \font\reducedsy=cmsy9
2055 \def\reducedecsize{0900}
2057 \divide\parskip by 2 % reduce space between paragraphs
2058 \textleading = 12pt % line spacing for 10pt CM
2059 \textfonts % reset the current fonts
2061 } % end of 10pt text font size definitions, \definetextfontsizex
2064 % We provide the user-level command
2066 % (or 11) to redefine the text font size. pt is assumed.
2072 \parseargdef\fonttextsize{%
2073 \def\textsizearg{#1}%
2074 %\wlog{doing @fonttextsize \textsizearg}%
2076 % Set \globaldefs so that documents can use this inside @tex, since
2077 % makeinfo 4.8 does not support it, but we need it nonetheless.
2079 \begingroup \globaldefs=1
2080 \ifx\textsizearg\xword \definetextfontsizex
2081 \else \ifx\textsizearg\xiword \definetextfontsizexi
2084 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2089 % In order for the font changes to affect most math symbols and letters,
2090 % we have to define the \textfont of the standard families. We don't
2091 % bother to reset \scriptfont and \scriptscriptfont; awaiting user need.
2093 \def\resetmathfonts{%
2094 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2095 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2096 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2099 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2100 % of just \STYLE. We do this because \STYLE needs to also set the
2101 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2102 % \tenSTYLE to set the current font.
2104 % Each font-changing command also sets the names \lsize (one size lower)
2105 % and \lllsize (three sizes lower). These relative commands are used
2106 % in, e.g., the LaTeX logo and acronyms.
2108 % This all needs generalizing, badly.
2111 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2112 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2113 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2114 \let\tenttsl=\textttsl
2115 \def\curfontsize{text}%
2116 \def\lsize{reduced}\def\lllsize{smaller}%
2117 \resetmathfonts \setleading{\textleading}}
2119 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2120 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2121 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2122 \let\tenttsl=\titlettsl
2123 \def\curfontsize{title}%
2124 \def\lsize{chap}\def\lllsize{subsec}%
2125 \resetmathfonts \setleading{27pt}}
2126 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2128 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2129 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2130 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2131 \let\tenttsl=\chapttsl
2132 \def\curfontsize{chap}%
2133 \def\lsize{sec}\def\lllsize{text}%
2134 \resetmathfonts \setleading{19pt}}
2136 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2137 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2138 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2139 \let\tenttsl=\secttsl
2140 \def\curfontsize{sec}%
2141 \def\lsize{subsec}\def\lllsize{reduced}%
2142 \resetmathfonts \setleading{17pt}}
2144 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2145 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2146 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2147 \let\tenttsl=\ssecttsl
2148 \def\curfontsize{ssec}%
2149 \def\lsize{text}\def\lllsize{small}%
2150 \resetmathfonts \setleading{15pt}}
2151 \let\subsubsecfonts = \subsecfonts
2153 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2154 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2155 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2156 \let\tenttsl=\reducedttsl
2157 \def\curfontsize{reduced}%
2158 \def\lsize{small}\def\lllsize{smaller}%
2159 \resetmathfonts \setleading{10.5pt}}
2161 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2162 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2163 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2164 \let\tenttsl=\smallttsl
2165 \def\curfontsize{small}%
2166 \def\lsize{smaller}\def\lllsize{smaller}%
2167 \resetmathfonts \setleading{10.5pt}}
2169 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2170 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2171 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2172 \let\tenttsl=\smallerttsl
2173 \def\curfontsize{smaller}%
2174 \def\lsize{smaller}\def\lllsize{smaller}%
2175 \resetmathfonts \setleading{9.5pt}}
2177 % Fonts for short table of contents.
2178 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2179 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2180 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2181 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2183 % Define these just so they can be easily changed for other fonts.
2184 \def\angleleft{$\langle$}
2185 \def\angleright{$\rangle$}
2187 % Set the fonts to use with the @small... environments.
2188 \let\smallexamplefonts = \smallfonts
2190 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2191 % can fit this many characters:
2192 % 8.5x11=86 smallbook=72 a4=90 a5=69
2193 % If we use \scriptfonts (8pt), then we can fit this many characters:
2194 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2195 % For me, subjectively, the few extra characters that fit aren't worth
2196 % the additional smallness of 8pt. So I'm making the default 9pt.
2198 % By the way, for comparison, here's what fits with @example (10pt):
2199 % 8.5x11=71 smallbook=60 a4=75 a5=58
2202 % Set up the default fonts, so we can use them for creating boxes.
2204 \definetextfontsizexi
2209 % Check if we are currently using a typewriter font. Since all the
2210 % Computer Modern typewriter fonts have zero interword stretch (and
2211 % shrink), and it is reasonable to expect all typewriter fonts to have
2212 % this property, we can check that font parameter.
2214 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2216 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2217 % define and register \INITMACRO to be called on markup style changes.
2218 % \INITMACRO can check \currentmarkupstyle for the innermost
2219 % style and the set of \ifmarkupSTYLE switches for all styles
2220 % currently in effect.
2224 %\newif\ifmarkupfile % @file == @samp.
2225 %\newif\ifmarkupoption % @option == @samp.
2228 %\newif\ifmarkupenv % @env == @code.
2229 %\newif\ifmarkupcommand % @command == @code.
2230 \newif\ifmarkuptex % @tex (and part of @math, for now).
2231 \newif\ifmarkupexample
2233 \newif\ifmarkupverbatim
2235 \let\currentmarkupstyle\empty
2237 \def\setupmarkupstyle#1{%
2238 \csname markup#1true\endcsname
2239 \def\currentmarkupstyle{#1}%
2243 \let\markupstylesetup\empty
2245 \def\defmarkupstylesetup#1{%
2246 \expandafter\def\expandafter\markupstylesetup
2247 \expandafter{\markupstylesetup #1}%
2251 % Markup style setup for left and right quotes.
2252 \defmarkupstylesetup\markupsetuplq{%
2253 \expandafter\let\expandafter \temp
2254 \csname markupsetuplq\currentmarkupstyle\endcsname
2255 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2258 \defmarkupstylesetup\markupsetuprq{%
2259 \expandafter\let\expandafter \temp
2260 \csname markupsetuprq\currentmarkupstyle\endcsname
2261 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2268 \gdef\markupsetuplqdefault{\let`\lq}
2269 \gdef\markupsetuprqdefault{\let'\rq}
2271 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2272 \gdef\markupsetcodequoteright{\let'\codequoteright}
2275 \let\markupsetuplqcode \markupsetcodequoteleft
2276 \let\markupsetuprqcode \markupsetcodequoteright
2278 \let\markupsetuplqexample \markupsetcodequoteleft
2279 \let\markupsetuprqexample \markupsetcodequoteright
2281 \let\markupsetuplqkbd \markupsetcodequoteleft
2282 \let\markupsetuprqkbd \markupsetcodequoteright
2284 \let\markupsetuplqsamp \markupsetcodequoteleft
2285 \let\markupsetuprqsamp \markupsetcodequoteright
2287 \let\markupsetuplqverb \markupsetcodequoteleft
2288 \let\markupsetuprqverb \markupsetcodequoteright
2290 \let\markupsetuplqverbatim \markupsetcodequoteleft
2291 \let\markupsetuprqverbatim \markupsetcodequoteright
2293 % Allow an option to not use regular directed right quote/apostrophe
2294 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2295 % The undirected quote is ugly, so don't make it the default, but it
2296 % works for pasting with more pdf viewers (at least evince), the
2297 % lilypond developers report. xpdf does work with the regular 0x27.
2299 \def\codequoteright{%
2300 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2301 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2307 % and a similar option for the left quote char vs. a grave accent.
2308 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2309 % the code environments to do likewise.
2311 \def\codequoteleft{%
2312 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2313 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2314 % [Knuth] pp. 380,381,391
2315 % \relax disables Spanish ligatures ?` and !` of \tt font.
2321 % Commands to set the quote options.
2323 \parseargdef\codequoteundirected{%
2326 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2328 \else\ifx\temp\offword
2329 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2332 \errhelp = \EMsimple
2333 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2337 \parseargdef\codequotebacktick{%
2340 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2342 \else\ifx\temp\offword
2343 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2346 \errhelp = \EMsimple
2347 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2351 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2352 \def\noligaturesquoteleft{\relax\lq}
2354 % Count depth in font-changes, for error checks
2355 \newcount\fontdepth \fontdepth=0
2359 % #1 is the font command (\sl or \it), #2 is the text to slant.
2360 % If we are in a monospaced environment, however, 1) always use \ttsl,
2361 % and 2) do not add an italic correction.
2362 \def\dosmartslant#1#2{%
2364 {{\ttsl #2}\let\next=\relax}%
2365 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2368 \def\smartslanted{\dosmartslant\sl}
2369 \def\smartitalic{\dosmartslant\it}
2371 % Output an italic correction unless \next (presumed to be the following
2372 % character) is such as not to need one.
2373 \def\smartitaliccorrection{%
2378 \else\ifx\next\comma%
2384 % Unconditional use \ttsl, and no ic. @var is set to this for defuns.
2385 \def\ttslanted#1{{\ttsl #1}}
2387 % @cite is like \smartslanted except unconditionally use \sl. We never want
2388 % ttsl for book titles, do we?
2389 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2393 \let\saveaftersmartic = \aftersmartic
2394 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2399 \let\slanted=\smartslanted
2400 \let\dfn=\smartslanted
2401 \let\emph=\smartitalic
2403 % Explicit font changes: @r, @sc, undocumented @ii.
2404 \def\r#1{{\rm #1}} % roman font
2405 \def\sc#1{{\smallcaps#1}} % smallcaps font
2406 \def\ii#1{{\it #1}} % italic font
2408 % @b, explicit bold. Also @strong.
2412 % @sansserif, explicit sans.
2413 \def\sansserif#1{{\sf #1}}
2415 % We can't just use \exhyphenpenalty, because that only has effect at
2416 % the end of a paragraph. Restore normal hyphenation at the end of the
2417 % group within which \nohyphenation is presumably called.
2419 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2420 \def\restorehyphenation{\hyphenchar\font = `- }
2422 % Set sfcode to normal for the chars that usually have another value.
2423 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2424 % sometimes \x has an active definition that messes things up.
2427 \def\plainfrenchspacing{%
2428 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2429 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2430 \def\endofsentencespacefactor{1000}% for @. and friends
2432 \def\plainnonfrenchspacing{%
2433 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2434 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2435 \def\endofsentencespacefactor{3000}% for @. and friends
2438 \def\endofsentencespacefactor{3000}% default
2440 % @t, explicit typewriter.
2442 {\tt \rawbackslash \plainfrenchspacing #1}%
2447 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2449 % @indicateurl is \samp, that is, with quotes.
2450 \let\indicateurl=\samp
2452 % @code (and similar) prints in typewriter, but with spaces the same
2453 % size as normal in the surrounding text, without hyphenation, etc.
2454 % This is a subroutine for that.
2457 % Change normal interword space to be same as for the current font.
2458 \spaceskip = \fontdimen2\font
2460 % Switch to typewriter.
2463 % But `\ ' produces the large typewriter interword space.
2464 \def\ {{\spaceskip = 0pt{} }}%
2466 % Turn off hyphenation.
2473 \null % reset spacefactor to 1000
2476 % We *must* turn on hyphenation at `-' and `_' in @code.
2477 % (But see \codedashfinish below.)
2478 % Otherwise, it is too hard to avoid overfull hboxes
2479 % in the Emacs manual, the Library manual, etc.
2481 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2482 % both hyphenation at - and hyphenation within words.
2483 % We must therefore turn them both off (\tclose does that)
2484 % and arrange explicitly to hyphenate at a dash. -- rms.
2486 \catcode`\-=\active \catcode`\_=\active
2487 \catcode`\'=\active \catcode`\`=\active
2488 \global\let'=\rq \global\let`=\lq % default definitions
2490 \global\def\code{\begingroup
2491 \setupmarkupstyle{code}%
2492 % The following should really be moved into \setupmarkupstyle handlers.
2493 \catcode\dashChar=\active \catcode\underChar=\active
2501 % Given -foo (with a single dash), we do not want to allow a break
2503 \global\let\codedashprev=\codedash
2508 \gdef\codedash{\futurelet\next\codedashfinish}
2509 \gdef\codedashfinish{%
2510 \normaldash % always output the dash character itself.
2512 % Now, output a discretionary to allow a line break, unless
2513 % (a) the next character is a -, or
2514 % (b) the preceding character is a -.
2515 % E.g., given --posix, we do not want to allow a break after either -.
2516 % Given --foo-bar, we do want to allow a break between the - and the b.
2517 \ifx\next\codedash \else
2518 \ifx\codedashprev\codedash
2519 \else \discretionary{}{}{}\fi
2521 % we need the space after the = for the case when \next itself is a
2522 % space token; it would get swallowed otherwise. As in @code{- a}.
2523 \global\let\codedashprev= \next
2528 \def\codex #1{\tclose{#1}\endgroup}
2531 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2532 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2533 % will therefore expand the active definition of _, which is us
2534 % (inside @code that is), therefore an endless loop.
2536 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2537 \else\normalunderscore \fi
2538 \discretionary{}{}{}}%
2542 % An additional complication: the above will allow breaks after, e.g.,
2543 % each of the four underscores in __typeof__. This is bad.
2544 % @allowcodebreaks provides a document-level way to turn breaking at -
2547 \newif\ifallowcodebreaks \allowcodebreakstrue
2549 \def\keywordtrue{true}
2550 \def\keywordfalse{false}
2552 \parseargdef\allowcodebreaks{%
2554 \ifx\txiarg\keywordtrue
2555 \allowcodebreakstrue
2556 \else\ifx\txiarg\keywordfalse
2557 \allowcodebreaksfalse
2559 \errhelp = \EMsimple
2560 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2564 % For @command, @env, @file, @option quotes seem unnecessary,
2565 % so use \code rather than \samp.
2571 % @uref (abbreviation for `urlref') aka @url takes an optional
2572 % (comma-separated) second argument specifying the text to display and
2573 % an optional third arg as text to display instead of (rather than in
2574 % addition to) the url itself. First (mandatory) arg is the url.
2576 % TeX-only option to allow changing PDF output to show only the second
2577 % arg (if given), and not the url (which is then just the link target).
2578 \newif\ifurefurlonlylink
2580 % The main macro is \urefbreak, which allows breaking at expected
2581 % places within the url. (There used to be another version, which
2582 % didn't support automatic breaking.)
2583 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2584 \let\uref=\urefbreak
2586 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
2587 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
2590 \setbox0 = \hbox{\ignorespaces #3}%
2592 \unhbox0 % third arg given, show only that
2594 \setbox0 = \hbox{\ignorespaces #2}% look for second arg
2598 % PDF plus option to not display url, show just arg
2601 % PDF, normally display both arg and url for consistency,
2602 % visibility, if the pdf is eventually used to print, etc.
2603 \unhbox0\ (\urefcode{#1})%
2606 \unhbox0\ (\urefcode{#1})% DVI, always show arg and url
2609 \urefcode{#1}% only url given, so show it
2615 % Allow line breaks around only a few characters (only).
2617 \catcode\ampChar=\active \catcode\dotChar=\active
2618 \catcode\hashChar=\active \catcode\questChar=\active
2619 \catcode\slashChar=\active
2624 \global\def\urefcode{\begingroup
2625 \setupmarkupstyle{code}%
2635 % By default, they are just regular characters.
2636 \global\def&{\normalamp}
2637 \global\def.{\normaldot}
2638 \global\def#{\normalhash}
2639 \global\def?{\normalquest}
2640 \global\def/{\normalslash}
2643 % we put a little stretch before and after the breakable chars, to help
2644 % line breaking of long url's. The unequal skips make look better in
2645 % cmtt at least, especially for dots.
2646 \def\urefprestretchamount{.13em}
2647 \def\urefpoststretchamount{.1em}
2648 \def\urefprestretch{\urefprebreak \hskip0pt plus\urefprestretchamount\relax}
2649 \def\urefpoststretch{\urefpostbreak \hskip0pt plus\urefprestretchamount\relax}
2651 \def\urefcodeamp{\urefprestretch \&\urefpoststretch}
2652 \def\urefcodedot{\urefprestretch .\urefpoststretch}
2653 \def\urefcodehash{\urefprestretch \#\urefpoststretch}
2654 \def\urefcodequest{\urefprestretch ?\urefpoststretch}
2655 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2658 \global\def\urefcodeslashfinish{%
2659 \urefprestretch \slashChar
2660 % Allow line break only after the final / in a sequence of
2661 % slashes, to avoid line break between the slashes in http://.
2662 \ifx\next/\else \urefpoststretch \fi
2666 % One more complication: by default we'll break after the special
2667 % characters, but some people like to break before the special chars, so
2668 % allow that. Also allow no breaking at all, for manual control.
2670 \parseargdef\urefbreakstyle{%
2672 \ifx\txiarg\wordnone
2673 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2674 \else\ifx\txiarg\wordbefore
2675 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2676 \else\ifx\txiarg\wordafter
2677 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2679 \errhelp = \EMsimple
2680 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
2683 \def\wordafter{after}
2684 \def\wordbefore{before}
2687 \urefbreakstyle after
2689 % @url synonym for @uref, since that's how everyone uses it.
2693 % rms does not like angle brackets --karl, 17may97.
2694 % So now @email is just like @uref, unless we are pdf.
2696 %\def\email#1{\angleleft{\tt #1}\angleright}
2698 \def\email#1{\doemail#1,,\finish}
2699 \def\doemail#1,#2,#3\finish{\begingroup
2702 \setbox0 = \hbox{\ignorespaces #2}%
2703 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2710 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2711 % `example' (@kbd uses ttsl only inside of @example and friends),
2712 % or `code' (@kbd uses normal tty font always).
2713 \parseargdef\kbdinputstyle{%
2715 \ifx\txiarg\worddistinct
2716 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2717 \else\ifx\txiarg\wordexample
2718 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2719 \else\ifx\txiarg\wordcode
2720 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2722 \errhelp = \EMsimple
2723 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
2726 \def\worddistinct{distinct}
2727 \def\wordexample{example}
2730 % Default is `distinct'.
2731 \kbdinputstyle distinct
2733 % @kbd is like @code, except that if the argument is just one @key command,
2734 % then @kbd has no effect.
2735 \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}}
2738 \def\kbdsub#1#2#3\par{%
2739 \def\one{#1}\def\three{#3}\def\threex{??}%
2740 \ifx\one\xkey\ifx\threex\three \key{#2}%
2741 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2742 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2745 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2746 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2748 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2749 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2750 % \vbox{\hrule\kern-0.4pt
2751 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2752 % \kern-0.4pt\hrule}%
2753 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2755 % definition of @key with no lozenge. If the current font is already
2756 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2757 % if it isn't monospace, then use \tt.
2759 \def\key#1{{\setupmarkupstyle{key}%
2761 \ifmonospace\else\tt\fi
2764 % @clicksequence{File @click{} Open ...}
2765 \def\clicksequence#1{\begingroup #1\endgroup}
2767 % @clickstyle @arrow (by default)
2768 \parseargdef\clickstyle{\def\click{#1}}
2771 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2772 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2774 \def\dmn#1{\thinspace #1}
2776 % @l was never documented to mean ``switch to the Lisp font'',
2777 % and it is not used as such in any manual I can find. We need it for
2778 % Polish suppressed-l. --karl, 22sep96.
2779 %\def\l#1{{\li #1}\null}
2781 % @acronym for "FBI", "NATO", and the like.
2782 % We print this one point size smaller, since it's intended for
2785 \def\acronym#1{\doacronym #1,,\finish}
2786 \def\doacronym#1,#2,#3\finish{%
2787 {\selectfonts\lsize #1}%
2789 \ifx\temp\empty \else
2790 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2792 \null % reset \spacefactor=1000
2795 % @abbr for "Comput. J." and the like.
2796 % No font change, but don't do end-of-sentence spacing.
2798 \def\abbr#1{\doabbr #1,,\finish}
2799 \def\doabbr#1,#2,#3\finish{%
2800 {\plainfrenchspacing #1}%
2802 \ifx\temp\empty \else
2803 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2805 \null % reset \spacefactor=1000
2808 % @asis just yields its argument. Used with @table, for example.
2812 % @math outputs its argument in math mode.
2814 % One complication: _ usually means subscripts, but it could also mean
2815 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2816 % _ active, and distinguish by seeing if the current family is \slfam,
2817 % which is what @var uses.
2819 \catcode`\_ = \active
2820 \gdef\mathunderscore{%
2822 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
2825 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2826 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2827 % particular reason), but this is not advertised and we don't care.
2829 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2830 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
2835 \let\\ = \mathbackslash
2837 % make the texinfo accent commands work in math mode
2847 % have to provide another name for sup operator
2851 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
2853 % Some active characters (such as <) are spaced differently in math.
2854 % We have to reset their definitions in case the @math was an argument
2855 % to a command which sets the catcodes (such as @item or @section).
2858 \catcode`^ = \active
2859 \catcode`< = \active
2860 \catcode`> = \active
2861 \catcode`+ = \active
2862 \catcode`' = \active
2868 \let' = \ptexquoteright
2872 % for @sub and @sup, if in math mode, just do a normal sub/superscript.
2873 % If in text, use math to place as sub/superscript, but switch
2874 % into text mode, with smaller fonts. This is a different font than the
2875 % one used for real math sub/superscripts (8pt vs. 7pt), but let's not
2876 % fix it (significant additions to font machinery) until someone notices.
2878 \def\sub{\ifmmode \expandafter\sb \else \expandafter\finishsub\fi}
2879 \def\finishsub#1{$\sb{\hbox{\selectfonts\lllsize #1}}$}%
2881 \def\sup{\ifmmode \expandafter\ptexsp \else \expandafter\finishsup\fi}
2882 \def\finishsup#1{$\ptexsp{\hbox{\selectfonts\lllsize #1}}$}%
2884 % ctrl is no longer a Texinfo command, but leave this definition for fun.
2885 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2887 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
2888 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
2889 % except specified as a normal braced arg, so no newlines to worry about.
2891 \def\outfmtnametex{tex}
2893 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
2894 \long\def\doinlinefmt#1,#2,\finish{%
2895 \def\inlinefmtname{#1}%
2896 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
2899 % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
2900 % FMTNAME is tex, else ELSE-TEXT.
2901 \long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,\finish}
2902 \long\def\doinlinefmtifelse#1,#2,#3,#4,\finish{%
2903 \def\inlinefmtname{#1}%
2904 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
2907 % For raw, must switch into @tex before parsing the argument, to avoid
2908 % setting catcodes prematurely. Doing it this way means that, for
2909 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
2910 % ignored. But this isn't important because if people want a literal
2911 % *right* brace they would have to use a command anyway, so they may as
2912 % well use a command to get a left brace too. We could re-use the
2913 % delimiter character idea from \verb, but it seems like overkill.
2915 \long\def\inlineraw{\tex \doinlineraw}
2916 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
2917 \def\doinlinerawtwo#1,#2,\finish{%
2918 \def\inlinerawname{#1}%
2919 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
2920 \endgroup % close group opened by \tex.
2923 % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
2925 \long\def\inlineifset#1{\doinlineifset #1,\finish}
2926 \long\def\doinlineifset#1,#2,\finish{%
2927 \def\inlinevarname{#1}%
2928 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax
2929 \else\ignorespaces#2\fi
2932 % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
2934 \long\def\inlineifclear#1{\doinlineifclear #1,\finish}
2935 \long\def\doinlineifclear#1,#2,\finish{%
2936 \def\inlinevarname{#1}%
2937 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \ignorespaces#2\fi
2944 % @@ prints an @, as does @atchar{}.
2948 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
2949 % Unless we're in typewriter, use \ecfont because the CM text fonts do
2950 % not have braces, and we don't want to switch into math.
2951 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2952 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2953 \let\{=\mylbrace \let\lbracechar=\{
2954 \let\}=\myrbrace \let\rbracechar=\}
2956 % Definitions to produce \{ and \} commands for indices,
2957 % and @{ and @} for the aux/toc files.
2958 \catcode`\{ = \other \catcode`\} = \other
2959 \catcode`\[ = 1 \catcode`\] = 2
2960 \catcode`\! = 0 \catcode`\\ = \other
2961 !gdef!lbracecmd[\{]%
2962 !gdef!rbracecmd[\}]%
2963 !gdef!lbraceatcmd[@{]%
2964 !gdef!rbraceatcmd[@}]%
2967 % @comma{} to avoid , parsing problems.
2970 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2971 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2973 \let\dotaccent = \ptexdot
2974 \def\ringaccent#1{{\accent23 #1}}
2975 \let\tieaccent = \ptext
2976 \let\ubaraccent = \ptexb
2977 \let\udotaccent = \d
2979 % Other special characters: @questiondown @exclamdown @ordf @ordm
2980 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2981 \def\questiondown{?`}
2983 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
2984 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
2986 % Dotless i and dotless j, used for accents.
2991 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2992 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2993 \else \errmessage{@dotless can be used only with i or j}%
2997 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2998 % period following counts as ending a sentence. (Idea found in latex.)
3000 \edef\TeX{\TeX \spacefactor=1000 }
3002 % @LaTeX{} logo. Not quite the same results as the definition in
3003 % latex.ltx, since we use a different font for the raised A; it's most
3004 % convenient for us to use an explicitly smaller font, rather than using
3005 % the \scriptstyle font (since we don't reset \scriptstyle and
3006 % \scriptscriptstyle).
3011 \vbox to \ht0{\hbox{%
3012 \ifx\textnominalsize\xwordpt
3013 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
3014 % Revert to plain's \scriptsize, which is 7pt.
3015 \count255=\the\fam $\fam\count255 \scriptstyle A$%
3017 % For 11pt, we can use our lllsize.
3018 \selectfonts\lllsize A%
3027 % Some math mode symbols.
3028 \def\bullet{$\ptexbullet$}
3029 \def\geq{\ifmmode \ge\else $\ge$\fi}
3030 \def\leq{\ifmmode \le\else $\le$\fi}
3031 \def\minus{\ifmmode -\else $-$\fi}
3033 % @dots{} outputs an ellipsis using the current font.
3034 % We do .5em per period so that it has the same spacing in the cm
3035 % typewriter fonts as three actual period characters; on the other hand,
3036 % in other typewriter fonts three periods are wider than 1.5em. So do
3037 % whichever is larger.
3041 \setbox0=\hbox{...}% get width of three periods
3048 \hskip 0pt plus.25fil
3049 .\hskip 0pt plus1fil
3050 .\hskip 0pt plus1fil
3051 .\hskip 0pt plus.5fil
3055 % @enddots{} is an end-of-sentence ellipsis.
3059 \spacefactor=\endofsentencespacefactor
3062 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3064 % Since these characters are used in examples, they should be an even number of
3065 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3068 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3069 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3070 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3071 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3072 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3074 % The @error{} command.
3075 % Adapted from the TeXbook's \boxit.
3079 {\tentt \global\dimen0 = 3em}% Width of the box.
3080 \dimen2 = .55pt % Thickness of rules
3081 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3082 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
3084 \setbox\errorbox=\hbox to \dimen0{\hfil
3085 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3086 \advance\hsize by -2\dimen2 % Rules.
3088 \hrule height\dimen2
3089 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3090 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3091 \kern3pt\vrule width\dimen2}% Space to right.
3092 \hrule height\dimen2}
3095 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3097 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3099 \def\pounds{{\it\$}}
3101 % @euro{} comes from a separate font, depending on the current style.
3102 % We use the free feym* fonts from the eurosym package by Henrik
3103 % Theiling, which support regular, slanted, bold and bold slanted (and
3104 % "outlined" (blackboard board, sort of) versions, which we don't need).
3105 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3107 % Although only regular is the truly official Euro symbol, we ignore
3108 % that. The Euro is designed to be slightly taller than the regular
3114 % feybo - bold slanted
3116 % There is no good (free) typewriter version, to my knowledge.
3117 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3120 % Also doesn't work in math. Do we need to do math with euro symbols?
3124 \def\euro{{\eurofont e}}
3126 % We set the font at each command, rather than predefining it in
3127 % \textfonts and the other font-switching commands, so that
3128 % installations which never need the symbol don't have to have the
3131 % There is only one designed size (nominal 10pt), so we always scale
3132 % that to the current nominal size.
3134 % By the way, simply using "at 1em" works for cmr10 and the like, but
3135 % does not work for cmbx10 and other extended/shrunken fonts.
3137 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3139 \ifx\curfontstyle\bfstylename
3141 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3144 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3149 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3150 % sometimes we redefine the original macro, and the alias should reflect
3153 % Use LaTeX names for the Icelandic letters.
3154 \def\DH{{\ecfont \char"D0}} % Eth
3155 \def\dh{{\ecfont \char"F0}} % eth
3156 \def\TH{{\ecfont \char"DE}} % Thorn
3157 \def\th{{\ecfont \char"FE}} % thorn
3159 \def\guillemetleft{{\ecfont \char"13}}
3160 \def\guillemotleft{\guillemetleft}
3161 \def\guillemetright{{\ecfont \char"14}}
3162 \def\guillemotright{\guillemetright}
3163 \def\guilsinglleft{{\ecfont \char"0E}}
3164 \def\guilsinglright{{\ecfont \char"0F}}
3165 \def\quotedblbase{{\ecfont \char"12}}
3166 \def\quotesinglbase{{\ecfont \char"0D}}
3168 % This positioning is not perfect (see the ogonek LaTeX package), but
3169 % we have the precomposed glyphs for the most common cases. We put the
3170 % tests to use those glyphs in the single \ogonek macro so we have fewer
3171 % dummy definitions to worry about for index entries, etc.
3173 % ogonek is also used with other letters in Lithuanian (IOU), but using
3174 % the precomposed glyphs for those is not so easy since they aren't in
3178 \ifx\temp\macrocharA\Aogonek
3179 \else\ifx\temp\macrochara\aogonek
3180 \else\ifx\temp\macrocharE\Eogonek
3181 \else\ifx\temp\macrochare\eogonek
3183 \ecfont \setbox0=\hbox{#1}%
3184 \ifdim\ht0=1ex\accent"0C #1%
3185 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3190 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3191 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3192 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3193 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3195 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
3197 % We can't distinguish serif/sans and italic/slanted, but this
3198 % is used for crude hacks anyway (like adding French and German
3199 % quotes to documents typeset with CM, where we lose kerning), so
3200 % hopefully nobody will notice/care.
3201 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3202 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3205 \font\thisecfont = ectt\ecsize \space at \nominalsize
3207 \ifx\curfontstyle\bfstylename
3209 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
3212 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3218 % @registeredsymbol - R in a circle. The font for the R should really
3219 % be smaller yet, but lllsize is the best we can do for now.
3220 % Adapted from the plain.tex definition of \copyright.
3222 \def\registeredsymbol{%
3223 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
3228 % @textdegree - the normal degrees sign.
3230 \def\textdegree{$^\circ$}
3232 % Laurent Siebenmann reports \Orb undefined with:
3233 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3234 % so we'll define it if necessary.
3236 \ifx\Orb\thisisundefined
3237 \def\Orb{\mathhexbox20D}
3241 \chardef\quotedblleft="5C
3242 \chardef\quotedblright=`\"
3243 \chardef\quoteleft=`\`
3244 \chardef\quoteright=`\'
3247 \message{page headings,}
3249 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3250 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3252 % First the title page. Must do @settitle before @titlepage.
3254 \newif\iffinishedtitlepage
3256 % Do an implicit @contents or @shortcontents after @end titlepage if the
3257 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3259 \newif\ifsetcontentsaftertitlepage
3260 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3261 \newif\ifsetshortcontentsaftertitlepage
3262 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3264 \parseargdef\shorttitlepage{%
3265 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3266 \endgroup\page\hbox{}\page}
3269 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3271 \parindent=0pt \textfonts
3272 % Leave some space at the very top of the page.
3273 \vglue\titlepagetopglue
3274 % No rule at page bottom unless we print one at the top with @title.
3275 \finishedtitlepagetrue
3277 % Most title ``pages'' are actually two pages long, with space
3278 % at the top of the second. We don't want the ragged left on the second.
3279 \let\oldpage = \page
3281 \iffinishedtitlepage\else
3284 \let\page = \oldpage
3291 \iffinishedtitlepage\else
3294 % It is important to do the page break before ending the group,
3295 % because the headline and footline are only empty inside the group.
3296 % If we use the new definition of \page, we always get a blank page
3297 % after the title page, which we certainly don't want.
3301 % Need this before the \...aftertitlepage checks so that if they are
3302 % in effect the toc pages will come out with page numbers.
3305 % If they want short, they certainly want long too.
3306 \ifsetshortcontentsaftertitlepage
3309 \global\let\shortcontents = \relax
3310 \global\let\contents = \relax
3313 \ifsetcontentsaftertitlepage
3315 \global\let\contents = \relax
3316 \global\let\shortcontents = \relax
3320 \def\finishtitlepage{%
3321 \vskip4pt \hrule height 2pt width \hsize
3322 \vskip\titlepagebottomglue
3323 \finishedtitlepagetrue
3326 % Settings used for typesetting titles: no hyphenation, no indentation,
3327 % don't worry much about spacing, ragged right. This should be used
3328 % inside a \vbox, and fonts need to be set appropriately first. Because
3329 % it is always used for titles, nothing else, we call \rmisbold. \par
3330 % should be specified before the end of the \vbox, since a vbox is a group.
3332 \def\raggedtitlesettings{%
3334 \hyphenpenalty=10000
3340 % Macros to be used within @titlepage:
3342 \let\subtitlerm=\tenrm
3343 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3345 \parseargdef\title{%
3347 \vbox{\titlefonts \raggedtitlesettings #1\par}%
3348 % print a rule at the page bottom also.
3349 \finishedtitlepagefalse
3350 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3353 \parseargdef\subtitle{%
3355 {\subtitlefont \rightline{#1}}%
3358 % @author should come last, but may come many times.
3359 % It can also be used inside @quotation.
3361 \parseargdef\author{%
3362 \def\temp{\quotation}%
3364 \def\quotationauthor{#1}% printed in \Equotation.
3367 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3368 {\secfonts\rmisbold \leftline{#1}}%
3373 % Set up page headings and footings.
3375 \let\thispage=\folio
3377 \newtoks\evenheadline % headline on even pages
3378 \newtoks\oddheadline % headline on odd pages
3379 \newtoks\evenfootline % footline on even pages
3380 \newtoks\oddfootline % footline on odd pages
3382 % Now make TeX use those variables
3383 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3384 \else \the\evenheadline \fi}}
3385 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3386 \else \the\evenfootline \fi}\HEADINGShook}
3387 \let\HEADINGShook=\relax
3389 % Commands to set those variables.
3390 % For example, this is what @headings on does
3391 % @evenheading @thistitle|@thispage|@thischapter
3392 % @oddheading @thischapter|@thispage|@thistitle
3393 % @evenfooting @thisfile||
3394 % @oddfooting ||@thisfile
3397 \def\evenheading{\parsearg\evenheadingxxx}
3398 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3399 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3400 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3402 \def\oddheading{\parsearg\oddheadingxxx}
3403 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3404 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3405 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3407 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3409 \def\evenfooting{\parsearg\evenfootingxxx}
3410 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3411 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3412 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3414 \def\oddfooting{\parsearg\oddfootingxxx}
3415 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3416 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3417 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3419 % Leave some space for the footline. Hopefully ok to assume
3420 % @evenfooting will not be used by itself.
3421 \global\advance\pageheight by -12pt
3422 \global\advance\vsize by -12pt
3425 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3427 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3428 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3430 % The same set of arguments for:
3435 % @everyheadingmarks
3436 % @everyfootingmarks
3438 \def\evenheadingmarks{\headingmarks{even}{heading}}
3439 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3440 \def\evenfootingmarks{\headingmarks{even}{footing}}
3441 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3442 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3443 \headingmarks{odd}{heading}{#1} }
3444 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3445 \headingmarks{odd}{footing}{#1} }
3446 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3447 \def\headingmarks#1#2#3 {%
3448 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3449 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3452 \everyheadingmarks bottom
3453 \everyfootingmarks bottom
3455 % @headings double turns headings on for double-sided printing.
3456 % @headings single turns headings on for single-sided printing.
3457 % @headings off turns them off.
3458 % @headings on same as @headings double, retained for compatibility.
3459 % @headings after turns on double-sided headings after this page.
3460 % @headings doubleafter turns on double-sided headings after this page.
3461 % @headings singleafter turns on single-sided headings after this page.
3462 % By default, they are off at the start of a document,
3463 % and turned `on' after @end titlepage.
3465 \def\headings #1 {\csname HEADINGS#1\endcsname}
3467 \def\headingsoff{% non-global headings elimination
3468 \evenheadline={\hfil}\evenfootline={\hfil}%
3469 \oddheadline={\hfil}\oddfootline={\hfil}%
3472 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3473 \HEADINGSoff % it's the default
3475 % When we turn headings on, set the page number to 1.
3476 % For double-sided printing, put current file name in lower left corner,
3477 % chapter name on inside top of right hand pages, document
3478 % title on inside top of left hand pages, and page numbers on outside top
3479 % edge of all pages.
3480 \def\HEADINGSdouble{%
3482 \global\evenfootline={\hfil}
3483 \global\oddfootline={\hfil}
3484 \global\evenheadline={\line{\folio\hfil\thistitle}}
3485 \global\oddheadline={\line{\thischapter\hfil\folio}}
3486 \global\let\contentsalignmacro = \chapoddpage
3488 \let\contentsalignmacro = \chappager
3490 % For single-sided printing, chapter title goes across top left of page,
3491 % page number on top right.
3492 \def\HEADINGSsingle{%
3494 \global\evenfootline={\hfil}
3495 \global\oddfootline={\hfil}
3496 \global\evenheadline={\line{\thischapter\hfil\folio}}
3497 \global\oddheadline={\line{\thischapter\hfil\folio}}
3498 \global\let\contentsalignmacro = \chappager
3500 \def\HEADINGSon{\HEADINGSdouble}
3502 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3503 \let\HEADINGSdoubleafter=\HEADINGSafter
3504 \def\HEADINGSdoublex{%
3505 \global\evenfootline={\hfil}
3506 \global\oddfootline={\hfil}
3507 \global\evenheadline={\line{\folio\hfil\thistitle}}
3508 \global\oddheadline={\line{\thischapter\hfil\folio}}
3509 \global\let\contentsalignmacro = \chapoddpage
3512 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3513 \def\HEADINGSsinglex{%
3514 \global\evenfootline={\hfil}
3515 \global\oddfootline={\hfil}
3516 \global\evenheadline={\line{\thischapter\hfil\folio}}
3517 \global\oddheadline={\line{\thischapter\hfil\folio}}
3518 \global\let\contentsalignmacro = \chappager
3521 % Subroutines used in generating headings
3522 % This produces Day Month Year style of output.
3523 % Only define if not already defined, in case a txi-??.tex file has set
3524 % up a different format (e.g., txi-cs.tex does this).
3525 \ifx\today\thisisundefined
3529 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3530 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3531 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3536 % @settitle line... specifies the title of the document, for headings.
3537 % It generates no output of its own.
3538 \def\thistitle{\putwordNoTitle}
3539 \def\settitle{\parsearg{\gdef\thistitle}}
3543 % Tables -- @table, @ftable, @vtable, @item(x).
3545 % default indentation of table text
3546 \newdimen\tableindent \tableindent=.8in
3547 % default indentation of @itemize and @enumerate text
3548 \newdimen\itemindent \itemindent=.3in
3549 % margin between end of table item and start of table text.
3550 \newdimen\itemmargin \itemmargin=.1in
3552 % used internally for \itemindent minus \itemmargin
3555 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3557 % They also define \itemindex
3558 % to index the item name in whatever manner is desired (perhaps none).
3560 \newif\ifitemxneedsnegativevskip
3562 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3564 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3565 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3567 \def\itemzzz #1{\begingroup %
3568 \advance\hsize by -\rightskip
3569 \advance\hsize by -\tableindent
3570 \setbox0=\hbox{\itemindicate{#1}}%
3572 \nobreak % This prevents a break before @itemx.
3574 % If the item text does not fit in the space we have, put it on a line
3575 % by itself, and do not allow a page break either before or after that
3576 % line. We do not start a paragraph here because then if the next
3577 % command is, e.g., @kindex, the whatsit would get put into the
3578 % horizontal list on a line by itself, resulting in extra blank space.
3579 \ifdim \wd0>\itemmax
3581 % Make this a paragraph so we get the \parskip glue and wrapping,
3582 % but leave it ragged-right.
3584 \advance\leftskip by-\tableindent
3585 \advance\hsize by\tableindent
3586 \advance\rightskip by0pt plus1fil\relax
3587 \leavevmode\unhbox0\par
3590 % We're going to be starting a paragraph, but we don't want the
3591 % \parskip glue -- logically it's part of the @item we just started.
3592 \nobreak \vskip-\parskip
3594 % Stop a page break at the \parskip glue coming up. However, if
3595 % what follows is an environment such as @example, there will be no
3596 % \parskip glue; then the negative vskip we just inserted would
3597 % cause the example and the item to crash together. So we use this
3598 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3599 % \parskip glue after all. Section titles are handled this way also.
3603 \itemxneedsnegativevskipfalse
3605 % The item text fits into the space. Start a paragraph, so that the
3606 % following text (if any) will end up on the same line.
3608 % Do this with kerns and \unhbox so that if there is a footnote in
3609 % the item text, it can migrate to the main vertical list and
3610 % eventually be printed.
3611 \nobreak\kern-\tableindent
3612 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3614 \nobreak\kern\dimen0
3616 \itemxneedsnegativevskiptrue
3620 \def\item{\errmessage{@item while not in a list environment}}
3621 \def\itemx{\errmessage{@itemx while not in a list environment}}
3623 % @table, @ftable, @vtable.
3625 \let\itemindex\gobble
3629 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3630 \tablecheck{ftable}%
3633 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3634 \tablecheck{vtable}%
3637 \ifnum \the\catcode`\^^M=\active
3639 \errmessage{This command won't work in this context; perhaps the problem is
3640 that we are \inenvironment\thisenv}%
3641 \def\next{\doignore{#1}}%
3648 \def\itemindicate{#1}%
3653 \makevalueexpandable
3654 \edef\temp{\noexpand\tablez #1\space\space\space}%
3658 \def\tablez #1 #2 #3 #4\endtablez{%
3660 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3661 \ifnum 0#2>0 \tableindent=#2\mil \fi
3662 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3663 \itemmax=\tableindent
3664 \advance \itemmax by -\itemmargin
3665 \advance \leftskip by \tableindent
3666 \exdentamount=\tableindent
3668 \parskip = \smallskipamount
3669 \ifdim \parskip=0pt \parskip=2pt \fi
3670 \let\item = \internalBitem
3671 \let\itemx = \internalBitemx
3673 \def\Etable{\endgraf\afterenvbreak}
3676 \let\Eitemize\Etable
3677 \let\Eenumerate\Etable
3679 % This is the counter used by @enumerate, which is really @itemize
3683 \envdef\itemize{\parsearg\doitemize}
3687 \itemmax=\itemindent
3688 \advance\itemmax by -\itemmargin
3689 \advance\leftskip by \itemindent
3690 \exdentamount=\itemindent
3692 \parskip=\smallskipamount
3693 \ifdim\parskip=0pt \parskip=2pt \fi
3695 % Try typesetting the item mark so that if the document erroneously says
3696 % something like @itemize @samp (intending @table), there's an error
3697 % right away at the @itemize. It's not the best error message in the
3698 % world, but it's better than leaving it to the @item. This means if
3699 % the user wants an empty mark, they have to say @w{} not just @w.
3700 \def\itemcontents{#1}%
3701 \setbox0 = \hbox{\itemcontents}%
3703 % @itemize with no arg is equivalent to @itemize @bullet.
3704 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3706 \let\item=\itemizeitem
3709 % Definition of @item while inside @itemize and @enumerate.
3712 \advance\itemno by 1 % for enumerations
3713 {\let\par=\endgraf \smallbreak}% reasonable place to break
3715 % If the document has an @itemize directly after a section title, a
3716 % \nobreak will be last on the list, and \sectionheading will have
3717 % done a \vskip-\parskip. In that case, we don't want to zero
3718 % parskip, or the item text will crash with the heading. On the
3719 % other hand, when there is normal text preceding the item (as there
3720 % usually is), we do want to zero parskip, or there would be too much
3721 % space. In that case, we won't have a \nobreak before. At least
3722 % that's the theory.
3723 \ifnum\lastpenalty<10000 \parskip=0in \fi
3725 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3727 \vadjust{\penalty 1200}}% not good to break after first line of item.
3731 % \splitoff TOKENS\endmark defines \first to be the first token in
3732 % TOKENS, and \rest to be the remainder.
3734 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3736 % Allow an optional argument of an uppercase letter, lowercase letter,
3737 % or number, to specify the first label in the enumerated list. No
3738 % argument is the same as `1'.
3740 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3741 \def\enumeratey #1 #2\endenumeratey{%
3742 % If we were given no argument, pretend we were given `1'.
3744 \ifx\thearg\empty \def\thearg{1}\fi
3746 % Detect if the argument is a single token. If so, it might be a
3747 % letter. Otherwise, the only valid thing it can be is a number.
3748 % (We will always have one token, because of the test we just made.
3749 % This is a good thing, since \splitoff doesn't work given nothing at
3750 % all -- the first parameter is undelimited.)
3751 \expandafter\splitoff\thearg\endmark
3753 % Only one token in the argument. It could still be anything.
3754 % A ``lowercase letter'' is one whose \lccode is nonzero.
3755 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3756 % not equal to itself.
3757 % Otherwise, we assume it's a number.
3759 % We need the \relax at the end of the \ifnum lines to stop TeX from
3760 % continuing to look for a <number>.
3762 \ifnum\lccode\expandafter`\thearg=0\relax
3763 \numericenumerate % a number (we hope)
3766 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3767 \lowercaseenumerate % lowercase letter
3769 \uppercaseenumerate % uppercase letter
3773 % Multiple tokens in the argument. We hope it's a number.
3778 % An @enumerate whose labels are integers. The starting integer is
3781 \def\numericenumerate{%
3783 \startenumeration{\the\itemno}%
3786 % The starting (lowercase) letter is in \thearg.
3787 \def\lowercaseenumerate{%
3788 \itemno = \expandafter`\thearg
3790 % Be sure we're not beyond the end of the alphabet.
3792 \errmessage{No more lowercase letters in @enumerate; get a bigger
3799 % The starting (uppercase) letter is in \thearg.
3800 \def\uppercaseenumerate{%
3801 \itemno = \expandafter`\thearg
3803 % Be sure we're not beyond the end of the alphabet.
3805 \errmessage{No more uppercase letters in @enumerate; get a bigger
3812 % Call \doitemize, adding a period to the first argument and supplying the
3813 % common last two arguments. Also subtract one from the initial value in
3814 % \itemno, since @item increments \itemno.
3816 \def\startenumeration#1{%
3817 \advance\itemno by -1
3818 \doitemize{#1.}\flushcr
3821 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3824 \def\alphaenumerate{\enumerate{a}}
3825 \def\capsenumerate{\enumerate{A}}
3826 \def\Ealphaenumerate{\Eenumerate}
3827 \def\Ecapsenumerate{\Eenumerate}
3830 % @multitable macros
3831 % Amy Hendrickson, 8/18/94, 3/6/96
3833 % @multitable ... @end multitable will make as many columns as desired.
3834 % Contents of each column will wrap at width given in preamble. Width
3835 % can be specified either with sample text given in a template line,
3836 % or in percent of \hsize, the current width of text on page.
3838 % Table can continue over pages but will only break between lines.
3842 % Either define widths of columns in terms of percent of \hsize:
3843 % @multitable @columnfractions .25 .3 .45
3846 % Numbers following @columnfractions are the percent of the total
3847 % current hsize to be used for each column. You may use as many
3848 % columns as desired.
3851 % Or use a template:
3852 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3854 % using the widest term desired in each column.
3856 % Each new table line starts with @item, each subsequent new column
3857 % starts with @tab. Empty columns may be produced by supplying @tab's
3858 % with nothing between them for as many times as empty columns are needed,
3859 % ie, @tab@tab@tab will produce two empty columns.
3861 % @item, @tab do not need to be on their own lines, but it will not hurt
3864 % Sample multitable:
3866 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3867 % @item first col stuff @tab second col stuff @tab third col
3874 % @item first col stuff @tab second col stuff
3875 % @tab Many paragraphs of text may be used in any column.
3877 % They will wrap at the width determined by the template.
3878 % @item@tab@tab This will be in third column.
3881 % Default dimensions may be reset by user.
3882 % @multitableparskip is vertical space between paragraphs in table.
3883 % @multitableparindent is paragraph indent in table.
3884 % @multitablecolmargin is horizontal space to be left between columns.
3885 % @multitablelinespace is space to leave between table items, baseline
3887 % 0pt means it depends on current normal line spacing.
3889 \newskip\multitableparskip
3890 \newskip\multitableparindent
3891 \newdimen\multitablecolspace
3892 \newskip\multitablelinespace
3893 \multitableparskip=0pt
3894 \multitableparindent=6pt
3895 \multitablecolspace=12pt
3896 \multitablelinespace=0pt
3898 % Macros used to set up halign preamble:
3900 \let\endsetuptable\relax
3901 \def\xendsetuptable{\endsetuptable}
3902 \let\columnfractions\relax
3903 \def\xcolumnfractions{\columnfractions}
3906 % #1 is the @columnfraction, usually a decimal number like .5, but might
3907 % be just 1. We just use it, whatever it is.
3909 \def\pickupwholefraction#1 {%
3910 \global\advance\colcount by 1
3911 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3918 \ifx\firstarg\xendsetuptable
3921 \ifx\firstarg\xcolumnfractions
3922 \global\setpercenttrue
3925 \let\go\pickupwholefraction
3927 \global\advance\colcount by 1
3928 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3929 % separator; typically that is always in the input, anyway.
3930 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3933 \ifx\go\pickupwholefraction
3934 % Put the argument back for the \pickupwholefraction call, so
3935 % we'll always have a period there to be parsed.
3936 \def\go{\pickupwholefraction#1}%
3938 \let\go = \setuptable
3944 % multitable-only commands.
3946 % @headitem starts a heading row, which we typeset in bold. Assignments
3947 % have to be global since we are inside the implicit group of an
3948 % alignment entry. \everycr below resets \everytab so we don't have to
3949 % undo it ourselves.
3950 \def\headitemfont{\b}% for people to use in the template row; not changeable
3952 \checkenv\multitable
3954 \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings
3955 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3956 \the\everytab % for the first item
3959 % default for tables with no headings.
3960 \let\headitemcrhook=\relax
3962 % A \tab used to include \hskip1sp. But then the space in a template
3963 % line is not enough. That is bad. So let's go back to just `&' until
3964 % we again encounter the problem the 1sp was intended to solve.
3965 % --karl, nathan@acm.org, 20apr99.
3966 \def\tab{\checkenv\multitable &\the\everytab}%
3968 % @multitable ... @end multitable definitions:
3970 \newtoks\everytab % insert after every tab.
3972 \envdef\multitable{%
3976 % @item within a multitable starts a normal row.
3977 % We use \def instead of \let so that if one of the multitable entries
3978 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3979 % \endtemplate) expanding \doitemize.
3984 \setmultitablespacing
3985 \parskip=\multitableparskip
3986 \parindent=\multitableparindent
3992 \global\everytab={}% Reset from possible headitem.
3993 \global\colcount=0 % Reset the column counter.
3995 % Check for saved footnotes, etc.:
3998 % Perhaps a \nobreak, then reset:
4000 \global\let\headitemcrhook=\relax
4004 \parsearg\domultitable
4006 \def\domultitable#1{%
4007 % To parse everything between @multitable and @item:
4008 \setuptable#1 \endsetuptable
4010 % This preamble sets up a generic column definition, which will
4011 % be used as many times as user calls for columns.
4012 % \vtop will set a single line and will also let text wrap and
4013 % continue for many paragraphs if desired.
4015 \global\advance\colcount by 1
4018 % Use the current \colcount to find the correct column width:
4019 \hsize=\expandafter\csname col\the\colcount\endcsname
4021 % In order to keep entries from bumping into each other
4022 % we will add a \leftskip of \multitablecolspace to all columns after
4025 % If a template has been used, we will add \multitablecolspace
4026 % to the width of each template entry.
4028 % If the user has set preamble in terms of percent of \hsize we will
4029 % use that dimension as the width of the column, and the \leftskip
4030 % will keep entries from bumping into each other. Table will start at
4031 % left margin and final column will justify at right margin.
4033 % Make sure we don't inherit \rightskip from the outer environment.
4036 % The first column will be indented with the surrounding text.
4037 \advance\hsize by\leftskip
4040 % If user has not set preamble in terms of percent of \hsize
4041 % we will advance \hsize by \multitablecolspace.
4042 \advance\hsize by \multitablecolspace
4044 % In either case we will make \leftskip=\multitablecolspace:
4045 \leftskip=\multitablecolspace
4047 % Ignoring space at the beginning and end avoids an occasional spurious
4048 % blank line, when TeX decides to break the line at the space before the
4049 % box from the multistrut, so the strut ends up on a line by itself.
4051 % @multitable @columnfractions .11 .89
4053 % @tab Legal holiday which is valid in major parts of the whole country.
4054 % Is automatically provided with highlighting sequences respectively
4055 % marking characters.
4056 \noindent\ignorespaces##\unskip\multistrut
4061 \egroup % end the \halign
4062 \global\setpercentfalse
4065 \def\setmultitablespacing{%
4066 \def\multistrut{\strut}% just use the standard line spacing
4068 % Compute \multitablelinespace (if not defined by user) for use in
4069 % \multitableparskip calculation. We used define \multistrut based on
4070 % this, but (ironically) that caused the spacing to be off.
4071 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
4072 \ifdim\multitablelinespace=0pt
4073 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
4074 \global\advance\multitablelinespace by-\ht0
4076 % Test to see if parskip is larger than space between lines of
4077 % table. If not, do nothing.
4078 % If so, set to same dimension as multitablelinespace.
4079 \ifdim\multitableparskip>\multitablelinespace
4080 \global\multitableparskip=\multitablelinespace
4081 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4082 % than skip between lines in the table.
4084 \ifdim\multitableparskip=0pt
4085 \global\multitableparskip=\multitablelinespace
4086 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4087 % than skip between lines in the table.
4091 \message{conditionals,}
4093 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4094 % @ifnotxml always succeed. They currently do nothing; we don't
4095 % attempt to check whether the conditionals are properly nested. But we
4096 % have to remember that they are conditionals, so that @end doesn't
4097 % attempt to close an environment group.
4100 \expandafter\let\csname #1\endcsname = \relax
4101 \expandafter\let\csname iscond.#1\endcsname = 1
4104 \makecond{ifnotdocbook}
4105 \makecond{ifnothtml}
4106 \makecond{ifnotinfo}
4107 \makecond{ifnotplaintext}
4110 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4112 \def\direntry{\doignore{direntry}}
4113 \def\documentdescription{\doignore{documentdescription}}
4114 \def\docbook{\doignore{docbook}}
4115 \def\html{\doignore{html}}
4116 \def\ifdocbook{\doignore{ifdocbook}}
4117 \def\ifhtml{\doignore{ifhtml}}
4118 \def\ifinfo{\doignore{ifinfo}}
4119 \def\ifnottex{\doignore{ifnottex}}
4120 \def\ifplaintext{\doignore{ifplaintext}}
4121 \def\ifxml{\doignore{ifxml}}
4122 \def\ignore{\doignore{ignore}}
4123 \def\menu{\doignore{menu}}
4124 \def\xml{\doignore{xml}}
4126 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4128 % A count to remember the depth of nesting.
4129 \newcount\doignorecount
4131 \def\doignore#1{\begingroup
4132 % Scan in ``verbatim'' mode:
4134 \catcode`\@ = \other
4135 \catcode`\{ = \other
4136 \catcode`\} = \other
4138 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4141 % Count number of #1's that we've seen.
4144 % Swallow text until we reach the matching `@end #1'.
4148 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4151 \gdef\dodoignore#1{%
4152 % #1 contains the command name as a string, e.g., `ifinfo'.
4154 % Define a command to find the next `@end #1'.
4155 \long\def\doignoretext##1^^M@end #1{%
4156 \doignoretextyyy##1^^M@#1\_STOP_}%
4158 % And this command to find another #1 command, at the beginning of a
4159 % line. (Otherwise, we would consider a line `@c @ifset', for
4160 % example, to count as an @ifset for nesting.)
4161 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4163 % And now expand that command.
4168 \def\doignoreyyy#1{%
4170 \ifx\temp\empty % Nothing found.
4171 \let\next\doignoretextzzz
4172 \else % Found a nested condition, ...
4173 \advance\doignorecount by 1
4174 \let\next\doignoretextyyy % ..., look for another.
4175 % If we're here, #1 ends with ^^M\ifinfo (for example).
4177 \next #1% the token \_STOP_ is present just after this macro.
4180 % We have to swallow the remaining "\_STOP_".
4182 \def\doignoretextzzz#1{%
4183 \ifnum\doignorecount = 0 % We have just found the outermost @end.
4184 \let\next\enddoignore
4185 \else % Still inside a nested condition.
4186 \advance\doignorecount by -1
4187 \let\next\doignoretext % Look for the next @end.
4192 % Finish off ignored text.
4194 % Ignore anything after the last `@end #1'; this matters in verbatim
4195 % environments, where otherwise the newline after an ignored conditional
4196 % would result in a blank line in the output.
4197 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4201 % @set VAR sets the variable VAR to an empty value.
4202 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4204 % Since we want to separate VAR from REST-OF-LINE (which might be
4205 % empty), we can't just use \parsearg; we have to insert a space of our
4206 % own to delimit the rest of the line, and then take it out again if we
4208 % We rely on the fact that \parsearg sets \catcode`\ =10.
4210 \parseargdef\set{\setyyy#1 \endsetyyy}
4211 \def\setyyy#1 #2\endsetyyy{%
4213 \makevalueexpandable
4215 \edef\next{\gdef\makecsname{SET#1}}%
4223 % Remove the trailing space \setxxx inserted.
4224 \def\setzzz#1 \endsetzzz{\next{#1}}
4226 % @clear VAR clears (i.e., unsets) the variable VAR.
4228 \parseargdef\clear{%
4230 \makevalueexpandable
4231 \global\expandafter\let\csname SET#1\endcsname=\relax
4235 % @value{foo} gets the text saved in variable foo.
4236 \def\value{\begingroup\makevalueexpandable\valuexxx}
4237 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4239 \catcode`\-=\active \catcode`\_=\active
4241 \gdef\makevalueexpandable{%
4242 \let\value = \expandablevalue
4243 % We don't want these characters active, ...
4244 \catcode`\-=\other \catcode`\_=\other
4245 % ..., but we might end up with active ones in the argument if
4246 % we're called from @code, as @code{@value{foo-bar_}}, though.
4247 % So \let them to their normal equivalents.
4248 \let-\normaldash \let_\normalunderscore
4252 % We have this subroutine so that we can handle at least some @value's
4253 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4254 % The command has to be fully expandable (if the variable is set), since
4255 % the result winds up in the index file. This means that if the
4256 % variable's value contains other Texinfo commands, it's almost certain
4257 % it will fail (although perhaps we could fix that with sufficient work
4258 % to do a one-level expansion on the result, instead of complete).
4260 % Unfortunately, this has the consequence that when _ is in the *value*
4261 % of an @set, it does not print properly in the roman fonts (get the cmr
4262 % dot accent at position 126 instead). No fix comes to mind, and it's
4263 % been this way since 2003 or earlier, so just ignore it.
4265 \def\expandablevalue#1{%
4266 \expandafter\ifx\csname SET#1\endcsname\relax
4267 {[No value for ``#1'']}%
4268 \message{Variable `#1', used in @value, is not set.}%
4270 \csname SET#1\endcsname
4274 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4277 % To get the special treatment we need for `@end ifset,' we call
4278 % \makecond and then redefine.
4281 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4284 \makevalueexpandable
4286 \expandafter\ifx\csname SET#2\endcsname\relax
4287 #1% If not set, redefine \next.
4292 \def\ifsetfail{\doignore{ifset}}
4294 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4295 % defined with @set, or has been undefined with @clear.
4297 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4298 % above code: if the variable is not set, do nothing, if it is set,
4299 % then redefine \next to \ifclearfail.
4302 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4303 \def\ifclearfail{\doignore{ifclear}}
4305 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4306 % without the @) is in fact defined. We can only feasibly check at the
4307 % TeX level, so something like `mathcode' is going to considered
4308 % defined even though it is not a Texinfo command.
4310 \makecond{ifcommanddefined}
4311 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
4313 \def\doifcmddefined#1#2{{%
4314 \makevalueexpandable
4316 \expandafter\ifx\csname #2\endcsname\relax
4317 #1% If not defined, \let\next as above.
4322 \def\ifcmddefinedfail{\doignore{ifcommanddefined}}
4324 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4325 \makecond{ifcommandnotdefined}
4326 \def\ifcommandnotdefined{%
4327 \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
4328 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
4330 % Set the `txicommandconditionals' variable, so documents have a way to
4331 % test if the @ifcommand...defined conditionals are available.
4332 \set txicommandconditionals
4334 % @dircategory CATEGORY -- specify a category of the dir file
4335 % which this file should belong to. Ignore this in TeX.
4336 \let\dircategory=\comment
4338 % @defininfoenclose.
4339 \let\definfoenclose=\comment
4343 % Index generation facilities
4345 % Define \newwrite to be identical to plain tex's \newwrite
4346 % except not \outer, so it can be used within macros and \if's.
4347 \edef\newwrite{\makecsname{ptexnewwrite}}
4349 % \newindex {foo} defines an index named foo.
4350 % It automatically defines \fooindex such that
4351 % \fooindex ...rest of line... puts an entry in the index foo.
4352 % It also defines \fooindfile to be the number of the output channel for
4353 % the file that accumulates this index. The file's extension is foo.
4354 % The name of an index should be no more than 2 characters long
4355 % for the sake of vms.
4359 \expandafter\newwrite \csname#1indfile\endcsname
4360 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4362 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4363 \noexpand\doindex{#1}}
4366 % @defindex foo == \newindex{foo}
4368 \def\defindex{\parsearg\newindex}
4370 % Define @defcodeindex, like @defindex except put all entries in @code.
4372 \def\defcodeindex{\parsearg\newcodeindex}
4374 \def\newcodeindex#1{%
4376 \expandafter\newwrite \csname#1indfile\endcsname
4377 \openout \csname#1indfile\endcsname \jobname.#1
4379 \expandafter\xdef\csname#1index\endcsname{%
4380 \noexpand\docodeindex{#1}}%
4384 % @synindex foo bar makes index foo feed into index bar.
4385 % Do this instead of @defindex foo if you don't want it as a separate index.
4387 % @syncodeindex foo bar similar, but put all entries made for index foo
4390 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4391 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4393 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4394 % #3 the target index (bar).
4395 \def\dosynindex#1#2#3{%
4396 % Only do \closeout if we haven't already done it, else we'll end up
4397 % closing the target index.
4398 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4399 % The \closeout helps reduce unnecessary open files; the limit on the
4400 % Acorn RISC OS is a mere 16 files.
4401 \expandafter\closeout\csname#2indfile\endcsname
4402 \expandafter\let\csname donesynindex#2\endcsname = 1
4404 % redefine \fooindfile:
4405 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4406 \expandafter\let\csname#2indfile\endcsname=\temp
4407 % redefine \fooindex:
4408 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4411 % Define \doindex, the driver for all \fooindex macros.
4412 % Argument #1 is generated by the calling \fooindex macro,
4413 % and it is "foo", the name of the index.
4415 % \doindex just uses \parsearg; it calls \doind for the actual work.
4416 % This is because \doind is more useful to call from other macros.
4418 % There is also \dosubind {index}{topic}{subtopic}
4419 % which makes an entry in a two-level index such as the operation index.
4421 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4422 \def\singleindexer #1{\doind{\indexname}{#1}}
4424 % like the previous two, but they put @code around the argument.
4425 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4426 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4428 % Take care of Texinfo commands that can appear in an index entry.
4429 % Since there are some commands we want to expand, and others we don't,
4430 % we have to laboriously prevent expansion for those that we don't.
4433 \escapechar = `\\ % use backslash in output files.
4434 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4435 \def\ {\realbackslash\space }%
4437 % Need these unexpandable (because we define \tt as a dummy)
4438 % definitions when @{ or @} appear in index entry text. Also, more
4439 % complicated, when \tex is in effect and \{ is a \delimiter again.
4440 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4441 % braces and backslashes are used only as delimiters. Perhaps we
4442 % should use @lbracechar and @rbracechar?
4443 \def\{{{\tt\char123}}%
4444 \def\}{{\tt\char125}}%
4446 % I don't entirely understand this, but when an index entry is
4447 % generated from a macro call, the \endinput which \scanmacro inserts
4448 % causes processing to be prematurely terminated. This is,
4449 % apparently, because \indexsorttmp is fully expanded, and \endinput
4450 % is an expandable command. The redefinition below makes \endinput
4451 % disappear altogether for that purpose -- although logging shows that
4452 % processing continues to some further point. On the other hand, it
4453 % seems \endinput does not hurt in the printed index arg, since that
4454 % is still getting written without apparent harm.
4456 % Sample source (mac-idx3.tex, reported by Graham Percival to
4457 % help-texinfo, 22may06):
4458 % @macro funindex {WORD}
4462 % @funindex commtest
4463 % This is not enough to reproduce the bug, but it gives the flavor.
4465 % Sample whatsit resulting:
4466 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4469 \let\endinput = \empty
4471 % Do the redefinitions.
4475 % For the aux and toc files, @ is the escape character. So we want to
4476 % redefine everything using @ as the escape character (instead of
4477 % \realbackslash, still used for index files). When everything uses @,
4478 % this will be simpler.
4483 \let\{ = \lbraceatcmd
4484 \let\} = \rbraceatcmd
4486 % Do the redefinitions.
4491 % Called from \indexdummies and \atdummies.
4493 \def\commondummies{%
4494 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4495 % preventing its expansion. This is used only for control words,
4496 % not control letters, because the \space would be incorrect for
4497 % control characters, but is needed to separate the control word
4498 % from whatever follows.
4500 % For control letters, we have \definedummyletter, which omits the
4503 % These can be used both for control words that take an argument and
4504 % those that do not. If it is followed by {arg} in the input, then
4505 % that will dutifully get written to the index (or wherever).
4507 \def\definedummyword ##1{\def##1{\string##1\space}}%
4508 \def\definedummyletter##1{\def##1{\string##1}}%
4509 \let\definedummyaccent\definedummyletter
4511 \commondummiesnofonts
4513 \definedummyletter\_%
4514 \definedummyletter\-%
4516 % Non-English letters.
4527 \definedummyword\exclamdown
4531 \definedummyword\ordf
4532 \definedummyword\ordm
4533 \definedummyword\questiondown
4537 % Although these internal commands shouldn't show up, sometimes they do.
4539 \definedummyword\gtr
4540 \definedummyword\hat
4541 \definedummyword\less
4544 \definedummyword\tclose
4547 \definedummyword\LaTeX
4548 \definedummyword\TeX
4550 % Assorted special characters.
4551 \definedummyword\arrow
4552 \definedummyword\bullet
4553 \definedummyword\comma
4554 \definedummyword\copyright
4555 \definedummyword\registeredsymbol
4556 \definedummyword\dots
4557 \definedummyword\enddots
4558 \definedummyword\entrybreak
4559 \definedummyword\equiv
4560 \definedummyword\error
4561 \definedummyword\euro
4562 \definedummyword\expansion
4563 \definedummyword\geq
4564 \definedummyword\guillemetleft
4565 \definedummyword\guillemetright
4566 \definedummyword\guilsinglleft
4567 \definedummyword\guilsinglright
4568 \definedummyword\lbracechar
4569 \definedummyword\leq
4570 \definedummyword\mathopsup
4571 \definedummyword\minus
4572 \definedummyword\ogonek
4573 \definedummyword\pounds
4574 \definedummyword\point
4575 \definedummyword\print
4576 \definedummyword\quotedblbase
4577 \definedummyword\quotedblleft
4578 \definedummyword\quotedblright
4579 \definedummyword\quoteleft
4580 \definedummyword\quoteright
4581 \definedummyword\quotesinglbase
4582 \definedummyword\rbracechar
4583 \definedummyword\result
4584 \definedummyword\sub
4585 \definedummyword\sup
4586 \definedummyword\textdegree
4588 % We want to disable all macros so that they are not expanded by \write.
4591 \normalturnoffactive
4593 % Handle some cases of @value -- where it does not contain any
4594 % (non-fully-expandable) commands.
4595 \makevalueexpandable
4598 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4600 \def\commondummiesnofonts{%
4601 % Control letters and accents.
4602 \definedummyletter\!%
4603 \definedummyaccent\"%
4604 \definedummyaccent\'%
4605 \definedummyletter\*%
4606 \definedummyaccent\,%
4607 \definedummyletter\.%
4608 \definedummyletter\/%
4609 \definedummyletter\:%
4610 \definedummyaccent\=%
4611 \definedummyletter\?%
4612 \definedummyaccent\^%
4613 \definedummyaccent\`%
4614 \definedummyaccent\~%
4618 \definedummyword\dotaccent
4619 \definedummyword\ogonek
4620 \definedummyword\ringaccent
4621 \definedummyword\tieaccent
4622 \definedummyword\ubaraccent
4623 \definedummyword\udotaccent
4624 \definedummyword\dotless
4626 % Texinfo font commands.
4630 \definedummyword\sansserif
4632 \definedummyword\slanted
4635 % Commands that take arguments.
4636 \definedummyword\abbr
4637 \definedummyword\acronym
4638 \definedummyword\anchor
4639 \definedummyword\cite
4640 \definedummyword\code
4641 \definedummyword\command
4642 \definedummyword\dfn
4643 \definedummyword\dmn
4644 \definedummyword\email
4645 \definedummyword\emph
4646 \definedummyword\env
4647 \definedummyword\file
4648 \definedummyword\image
4649 \definedummyword\indicateurl
4650 \definedummyword\inforef
4651 \definedummyword\kbd
4652 \definedummyword\key
4653 \definedummyword\math
4654 \definedummyword\option
4655 \definedummyword\pxref
4656 \definedummyword\ref
4657 \definedummyword\samp
4658 \definedummyword\strong
4659 \definedummyword\tie
4661 \definedummyword\uref
4662 \definedummyword\url
4663 \definedummyword\var
4664 \definedummyword\verb
4666 \definedummyword\xref
4669 % @macro mkind{arg1,arg2}
4673 % The space after the comma will end up in the temporary definition
4674 % that we make for arg2 (see \parsemargdef ff.). We want all this to be
4675 % expanded for the sake of the index, so we end up just seeing "bar".
4676 \let\xeatspaces = \eatspaces
4679 % For testing: output @{ and @} in index sort strings as \{ and \}.
4680 \newif\ifusebracesinindexes
4682 % \indexnofonts is used when outputting the strings to sort the index
4683 % by, and when constructing control sequence names. It eliminates all
4684 % control sequences and just writes whatever the best ASCII sort string
4685 % would be for a given command (usually its argument).
4688 % Accent commands should become @asis.
4689 \def\definedummyaccent##1{\let##1\asis}%
4690 % We can just ignore other control letters.
4691 \def\definedummyletter##1{\let##1\empty}%
4692 % All control words become @asis by default; overrides below.
4693 \let\definedummyword\definedummyaccent
4695 \commondummiesnofonts
4697 % Don't no-op \tt, since it isn't a user-level command
4698 % and is used in the definitions of the active chars like <, >, |, etc.
4699 % Likewise with the other plain tex font commands.
4704 \def\_{\normalunderscore}%
4705 \def\-{}% @- shouldn't affect sorting
4707 % Unfortunately, texindex is not prepared to handle braces in the
4708 % content at all. So for index sorting, we map @{ and @} to strings
4709 % starting with |, since that ASCII character is between ASCII { and }.
4710 \ifusebracesinindexes
4711 \def\lbracechar{\lbracecmd}%
4712 \def\rbracechar{\rbracecmd}%
4714 \def\lbracechar{|a}%
4715 \def\rbracechar{|b}%
4721 % Non-English letters.
4738 \def\questiondown{?}%
4745 % Assorted special characters.
4746 % (The following {} will end up in the sort string, but that's ok.)
4748 \def\bullet{bullet}%
4750 \def\copyright{copyright}%
4756 \def\expansion{==>}%
4758 \def\guillemetleft{<<}%
4759 \def\guillemetright{>>}%
4760 \def\guilsinglleft{<}%
4761 \def\guilsinglright{>}%
4765 \def\pounds{pounds}%
4767 \def\quotedblbase{"}%
4768 \def\quotedblleft{"}%
4769 \def\quotedblright{"}%
4772 \def\quotesinglbase{,}%
4773 \def\registeredsymbol{R}%
4777 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax
4778 \else \indexlquoteignore \fi
4780 % We need to get rid of all macros, leaving only the arguments (if present).
4781 % Of course this is not nearly correct, but it is the best we can do for now.
4782 % makeinfo does not expand macros in the argument to @deffn, which ends up
4783 % writing an index entry, and texindex isn't prepared for an index sort entry
4784 % that starts with \.
4786 % Since macro invocations are followed by braces, we can just redefine them
4787 % to take a single TeX argument. The case of a macro invocation that
4788 % goes to end-of-line is not handled.
4793 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4794 % ignore left quotes in the sort term.
4795 {\catcode`\`=\active
4796 \gdef\indexlquoteignore{\let`=\empty}}
4798 \let\indexbackslash=0 %overridden during \printindex.
4799 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4801 % Most index entries go through here, but \dosubind is the general case.
4802 % #1 is the index name, #2 is the entry text.
4803 \def\doind#1#2{\dosubind{#1}{#2}{}}
4805 % Workhorse for all \fooindexes.
4806 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4807 % empty if called from \doind, as we usually are (the main exception
4808 % is with most defuns, which call us directly).
4810 \def\dosubind#1#2#3{%
4813 % Store the main index entry text (including the third arg).
4815 % If third arg is present, precede it with a space.
4817 \ifx\thirdarg\empty \else
4818 \toks0 = \expandafter{\the\toks0 \space #3}%
4821 \edef\writeto{\csname#1indfile\endcsname}%
4823 \safewhatsit\dosubindwrite
4828 % Write the entry in \toks0 to the index file:
4830 \def\dosubindwrite{%
4831 % Put the index entry in the margin if desired.
4832 \ifx\SETmarginindex\relax\else
4833 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4836 % Remember, we are within a group.
4837 \indexdummies % Must do this here, since \bf, etc expand at this stage
4838 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4839 % so it will be output as is; and it will print as backslash.
4841 % Process the index entry with all font commands turned off, to
4842 % get the string to sort by.
4844 \edef\temp{\the\toks0}% need full expansion
4845 \xdef\indexsorttmp{\temp}%
4848 % Set up the complete index entry, with both the sort key and
4849 % the original text, including any font commands. We write
4850 % three arguments to \entry to the .?? file (four in the
4851 % subentry case), texindex reduces to two when writing the .??s
4855 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4860 % Take care of unwanted page breaks/skips around a whatsit:
4862 % If a skip is the last thing on the list now, preserve it
4863 % by backing up by \lastskip, doing the \write, then inserting
4864 % the skip again. Otherwise, the whatsit generated by the
4865 % \write or \pdfdest will make \lastskip zero. The result is that
4866 % sequences like this:
4870 % will have extra space inserted, because the \medbreak in the
4871 % start of the @defun won't see the skip inserted by the @end of
4872 % the previous defun.
4874 % But don't do any of this if we're not in vertical mode. We
4875 % don't want to do a \vskip and prematurely end a paragraph.
4877 % Avoid page breaks due to these extra skips, too.
4879 % But wait, there is a catch there:
4880 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4881 % sufficient for this purpose, as it ignores stretch and shrink parts
4882 % of the skip. The only way seems to be to check the textual
4883 % representation of the skip.
4885 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4886 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4888 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4890 \newskip\whatsitskip
4891 \newcount\whatsitpenalty
4895 \def\safewhatsit#1{\ifhmode
4898 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4899 \whatsitskip = \lastskip
4900 \edef\lastskipmacro{\the\lastskip}%
4901 \whatsitpenalty = \lastpenalty
4903 % If \lastskip is nonzero, that means the last item was a
4904 % skip. And since a skip is discardable, that means this
4905 % -\whatsitskip glue we're inserting is preceded by a
4906 % non-discardable item, therefore it is not a potential
4907 % breakpoint, therefore no \nobreak needed.
4908 \ifx\lastskipmacro\zeroskipmacro
4915 \ifx\lastskipmacro\zeroskipmacro
4916 % If \lastskip was zero, perhaps the last item was a penalty, and
4917 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4918 % to re-insert the same penalty (values >10000 are used for various
4919 % signals); since we just inserted a non-discardable item, any
4920 % following glue (such as a \parskip) would be a breakpoint. For example:
4921 % @deffn deffn-whatever
4922 % @vindex index-whatever
4924 % would allow a break between the index-whatever whatsit
4925 % and the "Description." paragraph.
4926 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4928 % On the other hand, if we had a nonzero \lastskip,
4929 % this make-up glue would be preceded by a non-discardable item
4930 % (the whatsit from the \write), so we must insert a \nobreak.
4931 \nobreak\vskip\whatsitskip
4935 % The index entry written in the file actually looks like
4936 % \entry {sortstring}{page}{topic}
4938 % \entry {sortstring}{page}{topic}{subtopic}
4939 % The texindex program reads in these files and writes files
4940 % containing these kinds of lines:
4942 % before the first topic whose initial is c
4943 % \entry {topic}{pagelist}
4944 % for a topic that is used without subtopics
4946 % for the beginning of a topic that is used with subtopics
4947 % \secondary {subtopic}{pagelist}
4948 % for each subtopic.
4950 % Define the user-accessible indexing commands
4951 % @findex, @vindex, @kindex, @cindex.
4953 \def\findex {\fnindex}
4954 \def\kindex {\kyindex}
4955 \def\cindex {\cpindex}
4956 \def\vindex {\vrindex}
4957 \def\tindex {\tpindex}
4958 \def\pindex {\pgindex}
4960 \def\cindexsub {\begingroup\obeylines\cindexsub}
4962 \gdef\cindexsub "#1" #2^^M{\endgroup %
4963 \dosubind{cp}{#2}{#1}}}
4965 % Define the macros used in formatting output of the sorted index material.
4967 % @printindex causes a particular index (the ??s file) to get printed.
4968 % It does not print any chapter heading (usually an @unnumbered).
4970 \parseargdef\printindex{\begingroup
4971 \dobreak \chapheadingskip{10000}%
4976 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4978 % See if the index file exists and is nonempty.
4979 % Change catcode of @ here so that if the index file contains
4981 % as its first line, TeX doesn't complain about mismatched braces
4982 % (because it thinks @} is a control sequence).
4984 \openin 1 \jobname.#1s
4986 % \enddoublecolumns gets confused if there is no text in the index,
4987 % and it loses the chapter title and the aux file entries for the
4988 % index. The easiest way to prevent this problem is to make sure
4989 % there is some text.
4990 \putwordIndexNonexistent
4993 % If the index file exists but is empty, then \openin leaves \ifeof
4994 % false. We have to make TeX try to read something from the file, so
4995 % it can discover if there is anything in it.
4998 \putwordIndexIsEmpty
5000 % Index files are almost Texinfo source, but we use \ as the escape
5001 % character. It would be better to use @, but that's too big a change
5002 % to make right now.
5003 \def\indexbackslash{\backslashcurfont}%
5014 % These macros are used by the sorted index file itself.
5015 % Change them to control the appearance of the index.
5018 % Some minor font changes for the special characters.
5019 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
5021 % Remove any glue we may have, we'll be inserting our own.
5024 % We like breaks before the index initials, so insert a bonus.
5026 \vskip 0pt plus 3\baselineskip
5028 \vskip 0pt plus -3\baselineskip
5030 % Typeset the initial. Making this add up to a whole number of
5031 % baselineskips increases the chance of the dots lining up from column
5032 % to column. It still won't often be perfect, because of the stretch
5033 % we need before each entry, but it's better.
5035 % No shrink because it confuses \balancecolumns.
5036 \vskip 1.67\baselineskip plus .5\baselineskip
5037 \leftline{\secbf #1}%
5038 % Do our best not to break after the initial.
5040 \vskip .33\baselineskip plus .1\baselineskip
5043 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
5044 % then page number (#2) flushed to the right margin. It is used for index
5045 % and table of contents entries. The paragraph is indented by \leftskip.
5047 % A straightforward implementation would start like this:
5048 % \def\entry#1#2{...
5049 % But this freezes the catcodes in the argument, and can cause problems to
5050 % @code, which sets - active. This problem was fixed by a kludge---
5051 % ``-'' was active throughout whole index, but this isn't really right.
5052 % The right solution is to prevent \entry from swallowing the whole text.
5057 % Start a new paragraph if necessary, so our assignments below can't
5058 % affect previous text.
5061 % Do not fill out the last line with white space.
5064 % No extra space above this paragraph.
5067 % Do not prefer a separate line ending with a hyphen to fewer lines.
5068 \finalhyphendemerits = 0
5070 % \hangindent is only relevant when the entry text and page number
5071 % don't both fit on one line. In that case, bob suggests starting the
5072 % dots pretty far over on the line. Unfortunately, a large
5073 % indentation looks wrong when the entry text itself is broken across
5074 % lines. So we use a small indentation and put up with long leaders.
5076 % \hangafter is reset to 1 (which is the value we want) at the start
5077 % of each paragraph, so we need not do anything with that.
5080 % When the entry text needs to be broken, just fill out the first line
5082 \rightskip = 0pt plus1fil
5084 % A bit of stretch before each entry for the benefit of balancing
5088 % When reading the text of entry, convert explicit line breaks
5089 % from @* into spaces. The user might give these in long section
5090 % titles, for instance.
5091 \def\*{\unskip\space\ignorespaces}%
5092 \def\entrybreak{\hfil\break}%
5094 % Swallow the left brace of the text (first parameter):
5095 \afterassignment\doentry
5098 \def\entrybreak{\unskip\space\ignorespaces}%
5100 \bgroup % Instead of the swallowed brace.
5102 \aftergroup\finishentry
5103 % And now comes the text of the entry.
5105 \def\finishentry#1{%
5106 % #1 is the page number.
5108 % The following is kludged to not output a line of dots in the index if
5109 % there are no page numbers. The next person who breaks this will be
5110 % cursed by a Unix daemon.
5111 \setbox\boxA = \hbox{#1}%
5112 \ifdim\wd\boxA = 0pt
5116 % If we must, put the page number on a line of its own, and fill out
5117 % this line with blank space. (The \hfil is overwhelmed with the
5118 % fill leaders glue in \indexdotfill if the page number does fit.)
5120 \null\nobreak\indexdotfill % Have leaders before the page number.
5122 % The `\ ' here is removed by the implicit \unskip that TeX does as
5123 % part of (the primitive) \par. Without it, a spurious underfull
5136 % Like plain.tex's \dotfill, except uses up at least 1 em.
5137 \def\indexdotfill{\cleaders
5138 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
5140 \def\primary #1{\line{#1\hfil}}
5142 \newskip\secondaryindent \secondaryindent=0.5cm
5143 \def\secondary#1#2{{%
5148 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5150 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
5157 % Define two-column mode, which we use to typeset indexes.
5158 % Adapted from the TeXbook, page 416, which is to say,
5159 % the manmac.tex format used to print the TeXbook itself.
5163 \newdimen\doublecolumnhsize
5165 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5166 % Grab any single-column material above us.
5169 % Here is a possibility not foreseen in manmac: if we accumulate a
5170 % whole lot of material, we might end up calling this \output
5171 % routine twice in a row (see the doublecol-lose test, which is
5172 % essentially a couple of indexes with @setchapternewpage off). In
5173 % that case we just ship out what is in \partialpage with the normal
5174 % output routine. Generally, \partialpage will be empty when this
5175 % runs and this will be a no-op. See the indexspread.tex test case.
5176 \ifvoid\partialpage \else
5177 \onepageout{\pagecontents\partialpage}%
5180 \global\setbox\partialpage = \vbox{%
5181 % Unvbox the main output page.
5183 \kern-\topskip \kern\baselineskip
5186 \eject % run that output routine to set \partialpage
5188 % Use the double-column output routine for subsequent pages.
5189 \output = {\doublecolumnout}%
5191 % Change the page size parameters. We could do this once outside this
5192 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5193 % format, but then we repeat the same computation. Repeating a couple
5194 % of assignments once per index is clearly meaningless for the
5195 % execution time, so we may as well do it in one place.
5197 % First we halve the line length, less a little for the gutter between
5198 % the columns. We compute the gutter based on the line length, so it
5199 % changes automatically with the paper format. The magic constant
5200 % below is chosen so that the gutter has the same value (well, +-<1pt)
5201 % as it did when we hard-coded it.
5203 % We put the result in a separate register, \doublecolumhsize, so we
5204 % can restore it in \pagesofar, after \hsize itself has (potentially)
5207 \doublecolumnhsize = \hsize
5208 \advance\doublecolumnhsize by -.04154\hsize
5209 \divide\doublecolumnhsize by 2
5210 \hsize = \doublecolumnhsize
5212 % Double the \vsize as well. (We don't need a separate register here,
5213 % since nobody clobbers \vsize.)
5217 % The double-column output routine for all double-column pages except
5220 \def\doublecolumnout{%
5221 \splittopskip=\topskip \splitmaxdepth=\maxdepth
5222 % Get the available space for the double columns -- the normal
5223 % (undoubled) page height minus any material left over from the
5227 \advance\dimen@ by -\ht\partialpage
5229 % box0 will be the left-hand column, box2 the right.
5230 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
5231 \onepageout\pagesofar
5233 \penalty\outputpenalty
5236 % Re-output the contents of the output page -- any previous material,
5237 % followed by the two boxes we just split, in box0 and box2.
5241 \hsize = \doublecolumnhsize
5242 \wd0=\hsize \wd2=\hsize
5243 \hbox to\pagewidth{\box0\hfil\box2}%
5246 % All done with double columns.
5247 \def\enddoublecolumns{%
5248 % The following penalty ensures that the page builder is exercised
5249 % _before_ we change the output routine. This is necessary in the
5250 % following situation:
5252 % The last section of the index consists only of a single entry.
5253 % Before this section, \pagetotal is less than \pagegoal, so no
5254 % break occurs before the last section starts. However, the last
5255 % section, consisting of \initial and the single \entry, does not
5256 % fit on the page and has to be broken off. Without the following
5257 % penalty the page builder will not be exercised until \eject
5258 % below, and by that time we'll already have changed the output
5259 % routine to the \balancecolumns version, so the next-to-last
5260 % double-column page will be processed with \balancecolumns, which
5261 % is wrong: The two columns will go to the main vertical list, with
5262 % the broken-off section in the recent contributions. As soon as
5263 % the output routine finishes, TeX starts reconsidering the page
5264 % break. The two columns and the broken-off section both fit on the
5265 % page, because the two columns now take up only half of the page
5266 % goal. When TeX sees \eject from below which follows the final
5267 % section, it invokes the new output routine that we've set after
5268 % \balancecolumns below; \onepageout will try to fit the two columns
5269 % and the final section into the vbox of \pageheight (see
5270 % \pagebody), causing an overfull box.
5272 % Note that glue won't work here, because glue does not exercise the
5273 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5277 % Split the last of the double-column material. Leave it on the
5278 % current page, no automatic page break.
5281 % If we end up splitting too much material for the current page,
5282 % though, there will be another page break right after this \output
5283 % invocation ends. Having called \balancecolumns once, we do not
5284 % want to call it again. Therefore, reset \output to its normal
5285 % definition right away. (We hope \balancecolumns will never be
5286 % called on to balance too much material, but if it is, this makes
5287 % the output somewhat more palatable.)
5288 \global\output = {\onepageout{\pagecontents\PAGE}}%
5291 \endgroup % started in \begindoublecolumns
5293 % \pagegoal was set to the doubled \vsize above, since we restarted
5294 % the current page. We're now back to normal single-column
5295 % typesetting, so reset \pagegoal to the normal \vsize (after the
5296 % \endgroup where \vsize got restored).
5300 % Called at the end of the double column material.
5301 \def\balancecolumns{%
5302 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5304 \advance\dimen@ by \topskip
5305 \advance\dimen@ by-\baselineskip
5306 \divide\dimen@ by 2 % target to split to
5307 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5308 \splittopskip = \topskip
5309 % Loop until we get a decent breakpoint.
5313 \global\setbox3 = \copy0
5314 \global\setbox1 = \vsplit3 to \dimen@
5316 \global\advance\dimen@ by 1pt
5319 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5320 \setbox0=\vbox to\dimen@{\unvbox1}%
5321 \setbox2=\vbox to\dimen@{\unvbox3}%
5325 \catcode`\@ = \other
5328 \message{sectioning,}
5329 % Chapters, sections, etc.
5331 % Let's start with @part.
5332 \outer\parseargdef\part{\partzzz{#1}}
5336 \vskip.3\vsize % move it down on the page a bit
5338 \noindent \titlefonts\rmisbold #1\par % the text
5339 \let\lastnode=\empty % no node to associate with
5340 \writetocentry{part}{#1}{}% but put it in the toc
5341 \headingsoff % no headline or footline on the part page
5346 % \unnumberedno is an oxymoron. But we count the unnumbered
5347 % sections so that we can refer to them unambiguously in the pdf
5348 % outlines by their "section number". We avoid collisions with chapter
5349 % numbers by starting them at 10000. (If a document ever has 10000
5350 % chapters, we're in trouble anyway, I'm sure.)
5351 \newcount\unnumberedno \unnumberedno = 10000
5353 \newcount\secno \secno=0
5354 \newcount\subsecno \subsecno=0
5355 \newcount\subsubsecno \subsubsecno=0
5357 % This counter is funny since it counts through charcodes of letters A, B, ...
5358 \newcount\appendixno \appendixno = `\@
5360 % \def\appendixletter{\char\the\appendixno}
5361 % We do the following ugly conditional instead of the above simple
5362 % construct for the sake of pdftex, which needs the actual
5363 % letter in the expansion, not just typeset.
5365 \def\appendixletter{%
5366 \ifnum\appendixno=`A A%
5367 \else\ifnum\appendixno=`B B%
5368 \else\ifnum\appendixno=`C C%
5369 \else\ifnum\appendixno=`D D%
5370 \else\ifnum\appendixno=`E E%
5371 \else\ifnum\appendixno=`F F%
5372 \else\ifnum\appendixno=`G G%
5373 \else\ifnum\appendixno=`H H%
5374 \else\ifnum\appendixno=`I I%
5375 \else\ifnum\appendixno=`J J%
5376 \else\ifnum\appendixno=`K K%
5377 \else\ifnum\appendixno=`L L%
5378 \else\ifnum\appendixno=`M M%
5379 \else\ifnum\appendixno=`N N%
5380 \else\ifnum\appendixno=`O O%
5381 \else\ifnum\appendixno=`P P%
5382 \else\ifnum\appendixno=`Q Q%
5383 \else\ifnum\appendixno=`R R%
5384 \else\ifnum\appendixno=`S S%
5385 \else\ifnum\appendixno=`T T%
5386 \else\ifnum\appendixno=`U U%
5387 \else\ifnum\appendixno=`V V%
5388 \else\ifnum\appendixno=`W W%
5389 \else\ifnum\appendixno=`X X%
5390 \else\ifnum\appendixno=`Y Y%
5391 \else\ifnum\appendixno=`Z Z%
5392 % The \the is necessary, despite appearances, because \appendixletter is
5393 % expanded while writing the .toc file. \char\appendixno is not
5394 % expandable, thus it is written literally, thus all appendixes come out
5395 % with the same letter (or @) in the toc without it.
5396 \else\char\the\appendixno
5397 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5398 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5400 % Each @chapter defines these (using marks) as the number+name, number
5401 % and name of the chapter. Page headings and footings can use
5402 % these. @section does likewise.
5404 \def\thischapternum{}
5405 \def\thischaptername{}
5407 \def\thissectionnum{}
5408 \def\thissectionname{}
5410 \newcount\absseclevel % used to calculate proper heading level
5411 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5413 % @raisesections: treat @section as chapter, @subsection as section, etc.
5414 \def\raisesections{\global\advance\secbase by -1}
5415 \let\up=\raisesections % original BFox name
5417 % @lowersections: treat @chapter as section, @section as subsection, etc.
5418 \def\lowersections{\global\advance\secbase by 1}
5419 \let\down=\lowersections % original BFox name
5421 % we only have subsub.
5422 \chardef\maxseclevel = 3
5424 % A numbered section within an unnumbered changes to unnumbered too.
5425 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5426 \chardef\unnlevel = \maxseclevel
5428 % Trace whether the current chapter is an appendix or not:
5429 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5430 \def\chapheadtype{N}
5432 % Choose a heading macro
5433 % #1 is heading type
5434 % #2 is heading level
5435 % #3 is text for heading
5436 \def\genhead#1#2#3{%
5437 % Compute the abs. sec. level:
5439 \advance\absseclevel by \secbase
5440 % Make sure \absseclevel doesn't fall outside the range:
5441 \ifnum \absseclevel < 0
5444 \ifnum \absseclevel > 3
5451 \ifnum \absseclevel < \unnlevel
5452 \chardef\unnlevel = \absseclevel
5455 % Check for appendix sections:
5456 \ifnum \absseclevel = 0
5457 \edef\chapheadtype{\headtype}%
5459 \if \headtype A\if \chapheadtype N%
5460 \errmessage{@appendix... within a non-appendix chapter}%
5463 % Check for numbered within unnumbered:
5464 \ifnum \absseclevel > \unnlevel
5467 \chardef\unnlevel = 3
5470 % Now print the heading:
5474 \or \unnumberedseczzz{#3}%
5475 \or \unnumberedsubseczzz{#3}%
5476 \or \unnumberedsubsubseczzz{#3}%
5482 \or \appendixsectionzzz{#3}%
5483 \or \appendixsubseczzz{#3}%
5484 \or \appendixsubsubseczzz{#3}%
5490 \or \numberedsubseczzz{#3}%
5491 \or \numberedsubsubseczzz{#3}%
5495 \suppressfirstparagraphindent
5499 \def\numhead{\genhead N}
5500 \def\apphead{\genhead A}
5501 \def\unnmhead{\genhead U}
5503 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5504 % all lower-level sectioning counters to zero.
5506 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5507 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5508 \let\chaplevelprefix = \empty
5510 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5512 % section resetting is \global in case the chapter is in a group, such
5513 % as an @include file.
5514 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5515 \global\advance\chapno by 1
5518 \gdef\chaplevelprefix{\the\chapno.}%
5521 % \putwordChapter can contain complex things in translations.
5522 \toks0=\expandafter{\putwordChapter}%
5523 \message{\the\toks0 \space \the\chapno}%
5525 % Write the actual heading.
5526 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5528 % So @section and the like are numbered underneath this chapter.
5529 \global\let\section = \numberedsec
5530 \global\let\subsection = \numberedsubsec
5531 \global\let\subsubsection = \numberedsubsubsec
5534 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5536 \def\appendixzzz#1{%
5537 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5538 \global\advance\appendixno by 1
5539 \gdef\chaplevelprefix{\appendixletter.}%
5542 % \putwordAppendix can contain complex things in translations.
5543 \toks0=\expandafter{\putwordAppendix}%
5544 \message{\the\toks0 \space \appendixletter}%
5546 \chapmacro{#1}{Yappendix}{\appendixletter}%
5548 \global\let\section = \appendixsec
5549 \global\let\subsection = \appendixsubsec
5550 \global\let\subsubsection = \appendixsubsubsec
5553 % normally unnmhead0 calls unnumberedzzz:
5554 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5555 \def\unnumberedzzz#1{%
5556 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5557 \global\advance\unnumberedno by 1
5559 % Since an unnumbered has no number, no prefix for figures.
5560 \global\let\chaplevelprefix = \empty
5563 % This used to be simply \message{#1}, but TeX fully expands the
5564 % argument to \message. Therefore, if #1 contained @-commands, TeX
5565 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5566 % expanded @cite (which turns out to cause errors because \cite is meant
5567 % to be executed, not expanded).
5569 % Anyway, we don't want the fully-expanded definition of @cite to appear
5570 % as a result of the \message, we just want `@cite' itself. We use
5571 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5572 % simply yielding the contents of <toks register>. (We also do this for
5575 \message{(\the\toks0)}%
5577 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5579 \global\let\section = \unnumberedsec
5580 \global\let\subsection = \unnumberedsubsec
5581 \global\let\subsubsection = \unnumberedsubsubsec
5584 % @centerchap is like @unnumbered, but the heading is centered.
5585 \outer\parseargdef\centerchap{%
5586 % Well, we could do the following in a group, but that would break
5587 % an assumption that \chapmacro is called at the outermost level.
5588 % Thus we are safer this way: --kasal, 24feb04
5589 \let\centerparametersmaybe = \centerparameters
5591 \let\centerparametersmaybe = \relax
5594 % @top is like @unnumbered.
5599 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5601 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5602 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5605 % normally calls appendixsectionzzz:
5606 \outer\parseargdef\appendixsection{\apphead1{#1}}
5607 \def\appendixsectionzzz#1{%
5608 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5609 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5611 \let\appendixsec\appendixsection
5613 % normally calls unnumberedseczzz:
5614 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5615 \def\unnumberedseczzz#1{%
5616 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5617 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5622 % normally calls numberedsubseczzz:
5623 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5624 \def\numberedsubseczzz#1{%
5625 \global\subsubsecno=0 \global\advance\subsecno by 1
5626 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5629 % normally calls appendixsubseczzz:
5630 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5631 \def\appendixsubseczzz#1{%
5632 \global\subsubsecno=0 \global\advance\subsecno by 1
5633 \sectionheading{#1}{subsec}{Yappendix}%
5634 {\appendixletter.\the\secno.\the\subsecno}%
5637 % normally calls unnumberedsubseczzz:
5638 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5639 \def\unnumberedsubseczzz#1{%
5640 \global\subsubsecno=0 \global\advance\subsecno by 1
5641 \sectionheading{#1}{subsec}{Ynothing}%
5642 {\the\unnumberedno.\the\secno.\the\subsecno}%
5647 % normally numberedsubsubseczzz:
5648 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5649 \def\numberedsubsubseczzz#1{%
5650 \global\advance\subsubsecno by 1
5651 \sectionheading{#1}{subsubsec}{Ynumbered}%
5652 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5655 % normally appendixsubsubseczzz:
5656 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5657 \def\appendixsubsubseczzz#1{%
5658 \global\advance\subsubsecno by 1
5659 \sectionheading{#1}{subsubsec}{Yappendix}%
5660 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5663 % normally unnumberedsubsubseczzz:
5664 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5665 \def\unnumberedsubsubseczzz#1{%
5666 \global\advance\subsubsecno by 1
5667 \sectionheading{#1}{subsubsec}{Ynothing}%
5668 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5671 % These macros control what the section commands do, according
5672 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5673 % Define them by default for a numbered chapter.
5674 \let\section = \numberedsec
5675 \let\subsection = \numberedsubsec
5676 \let\subsubsection = \numberedsubsubsec
5678 % Define @majorheading, @heading and @subheading
5681 {\advance\chapheadingskip by 10pt \chapbreak }%
5682 \parsearg\chapheadingzzz
5685 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5686 \def\chapheadingzzz#1{%
5687 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5688 \nobreak\bigskip \nobreak
5689 \suppressfirstparagraphindent
5692 % @heading, @subheading, @subsubheading.
5693 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5694 \suppressfirstparagraphindent}
5695 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5696 \suppressfirstparagraphindent}
5697 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5698 \suppressfirstparagraphindent}
5700 % These macros generate a chapter, section, etc. heading only
5701 % (including whitespace, linebreaking, etc. around it),
5702 % given all the information in convenient, parsed form.
5704 % Args are the skip and penalty (usually negative)
5705 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5707 % Parameter controlling skip before chapter headings (if needed)
5708 \newskip\chapheadingskip
5710 % Define plain chapter starts, and page on/off switching for it.
5711 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5712 \def\chappager{\par\vfill\supereject}
5713 % Because \domark is called before \chapoddpage, the filler page will
5714 % get the headings for the next chapter, which is wrong. But we don't
5715 % care -- we just disable all headings on the filler page.
5727 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5730 \global\let\contentsalignmacro = \chappager
5731 \global\let\pchapsepmacro=\chapbreak
5732 \global\let\pagealignmacro=\chappager}
5735 \global\let\contentsalignmacro = \chappager
5736 \global\let\pchapsepmacro=\chappager
5737 \global\let\pagealignmacro=\chappager
5738 \global\def\HEADINGSon{\HEADINGSsingle}}
5741 \global\let\contentsalignmacro = \chapoddpage
5742 \global\let\pchapsepmacro=\chapoddpage
5743 \global\let\pagealignmacro=\chapoddpage
5744 \global\def\HEADINGSon{\HEADINGSdouble}}
5750 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5751 % Yappendix, Yomitfromtoc), #3 the chapter number.
5752 % Not used for @heading series.
5754 % To test against our argument.
5755 \def\Ynothingkeyword{Ynothing}
5756 \def\Yappendixkeyword{Yappendix}
5757 \def\Yomitfromtockeyword{Yomitfromtoc}
5759 \def\chapmacro#1#2#3{%
5760 \checkenv{}% chapters, etc., should not start inside an environment.
5762 % Insert the first mark before the heading break (see notes for \domark).
5763 \let\prevchapterdefs=\lastchapterdefs
5764 \let\prevsectiondefs=\lastsectiondefs
5765 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5766 \gdef\thissection{}}%
5769 \ifx\temptype\Ynothingkeyword
5770 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5771 \gdef\thischapter{\thischaptername}}%
5772 \else\ifx\temptype\Yomitfromtockeyword
5773 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5774 \gdef\thischapter{}}%
5775 \else\ifx\temptype\Yappendixkeyword
5777 \xdef\lastchapterdefs{%
5778 \gdef\noexpand\thischaptername{\the\toks0}%
5779 \gdef\noexpand\thischapternum{\appendixletter}%
5780 % \noexpand\putwordAppendix avoids expanding indigestible
5781 % commands in some of the translations.
5782 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5783 \noexpand\thischapternum:
5784 \noexpand\thischaptername}%
5788 \xdef\lastchapterdefs{%
5789 \gdef\noexpand\thischaptername{\the\toks0}%
5790 \gdef\noexpand\thischapternum{\the\chapno}%
5791 % \noexpand\putwordChapter avoids expanding indigestible
5792 % commands in some of the translations.
5793 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5794 \noexpand\thischapternum:
5795 \noexpand\thischaptername}%
5799 % Output the mark. Pass it through \safewhatsit, to take care of
5800 % the preceding space.
5803 % Insert the chapter heading break.
5806 % Now the second mark, after the heading break. No break points
5807 % between here and the heading.
5808 \let\prevchapterdefs=\lastchapterdefs
5809 \let\prevsectiondefs=\lastsectiondefs
5813 \chapfonts \rmisbold
5814 \let\footnote=\errfootnoteheading % give better error message
5816 % Have to define \lastsection before calling \donoderef, because the
5817 % xref code eventually uses it. On the other hand, it has to be called
5818 % after \pchapsepmacro, or the headline will change too soon.
5819 \gdef\lastsection{#1}%
5821 % Only insert the separating space if we have a chapter/appendix
5822 % number, and don't print the unnumbered ``number''.
5823 \ifx\temptype\Ynothingkeyword
5825 \def\toctype{unnchap}%
5826 \else\ifx\temptype\Yomitfromtockeyword
5827 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5829 \else\ifx\temptype\Yappendixkeyword
5830 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5833 \setbox0 = \hbox{#3\enspace}%
5834 \def\toctype{numchap}%
5837 % Write the toc entry for this chapter. Must come before the
5838 % \donoderef, because we include the current node name in the toc
5839 % entry, and \donoderef resets it to empty.
5840 \writetocentry{\toctype}{#1}{#3}%
5842 % For pdftex, we have to write out the node definition (aka, make
5843 % the pdfdest) after any page break, but before the actual text has
5844 % been typeset. If the destination for the pdf outline is after the
5845 % text, then jumping from the outline may wind up with the text not
5846 % being visible, for instance under high magnification.
5849 % Typeset the actual heading.
5850 \nobreak % Avoid page breaks at the interline glue.
5851 \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe
5854 \nobreak\bigskip % no page break after a chapter title
5858 % @centerchap -- centered and unnumbered.
5859 \let\centerparametersmaybe = \relax
5860 \def\centerparameters{%
5861 \advance\rightskip by 3\rightskip
5862 \leftskip = \rightskip
5867 % I don't think this chapter style is supported any more, so I'm not
5868 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5870 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5872 \def\unnchfopen #1{%
5874 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5875 \nobreak\bigskip\nobreak
5877 \def\chfopen #1#2{\chapoddpage {\chapfonts
5878 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5881 \def\centerchfopen #1{%
5883 \vbox{\chapfonts \raggedtitlesettings \hfill #1\hfill}%
5884 \nobreak\bigskip \nobreak
5887 \global\let\chapmacro=\chfopen
5888 \global\let\centerchapmacro=\centerchfopen}
5891 % Section titles. These macros combine the section number parts and
5892 % call the generic \sectionheading to do the printing.
5894 \newskip\secheadingskip
5895 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5897 % Subsection titles.
5898 \newskip\subsecheadingskip
5899 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5901 % Subsubsection titles.
5902 \def\subsubsecheadingskip{\subsecheadingskip}
5903 \def\subsubsecheadingbreak{\subsecheadingbreak}
5906 % Print any size, any type, section title.
5908 % #1 is the text of the title,
5909 % #2 is the section level (sec/subsec/subsubsec),
5910 % #3 is the section type (Ynumbered, Ynothing, Yappendix, Yomitfromtoc),
5911 % #4 is the section number.
5913 \def\seckeyword{sec}
5915 \def\sectionheading#1#2#3#4{%
5917 \def\sectionlevel{#2}%
5920 % It is ok for the @heading series commands to appear inside an
5921 % environment (it's been historically allowed, though the logic is
5922 % dubious), but not the others.
5923 \ifx\temptype\Yomitfromtockeyword\else
5924 \checkenv{}% non-@*heading should not be in an environment.
5926 \let\footnote=\errfootnoteheading
5928 % Switch to the right set of fonts.
5929 \csname #2fonts\endcsname \rmisbold
5931 % Insert first mark before the heading break (see notes for \domark).
5932 \let\prevsectiondefs=\lastsectiondefs
5933 \ifx\temptype\Ynothingkeyword
5934 \ifx\sectionlevel\seckeyword
5935 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5936 \gdef\thissection{\thissectionname}}%
5938 \else\ifx\temptype\Yomitfromtockeyword
5939 % Don't redefine \thissection.
5940 \else\ifx\temptype\Yappendixkeyword
5941 \ifx\sectionlevel\seckeyword
5943 \xdef\lastsectiondefs{%
5944 \gdef\noexpand\thissectionname{\the\toks0}%
5945 \gdef\noexpand\thissectionnum{#4}%
5946 % \noexpand\putwordSection avoids expanding indigestible
5947 % commands in some of the translations.
5948 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5949 \noexpand\thissectionnum:
5950 \noexpand\thissectionname}%
5954 \ifx\sectionlevel\seckeyword
5956 \xdef\lastsectiondefs{%
5957 \gdef\noexpand\thissectionname{\the\toks0}%
5958 \gdef\noexpand\thissectionnum{#4}%
5959 % \noexpand\putwordSection avoids expanding indigestible
5960 % commands in some of the translations.
5961 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5962 \noexpand\thissectionnum:
5963 \noexpand\thissectionname}%
5968 % Go into vertical mode. Usually we'll already be there, but we
5969 % don't want the following whatsit to end up in a preceding paragraph
5970 % if the document didn't happen to have a blank line.
5973 % Output the mark. Pass it through \safewhatsit, to take care of
5974 % the preceding space.
5977 % Insert space above the heading.
5978 \csname #2headingbreak\endcsname
5980 % Now the second mark, after the heading break. No break points
5981 % between here and the heading.
5982 \global\let\prevsectiondefs=\lastsectiondefs
5985 % Only insert the space after the number if we have a section number.
5986 \ifx\temptype\Ynothingkeyword
5989 \gdef\lastsection{#1}%
5990 \else\ifx\temptype\Yomitfromtockeyword
5991 % for @headings -- no section number, don't include in toc,
5992 % and don't redefine \lastsection.
5995 \let\sectionlevel=\empty
5996 \else\ifx\temptype\Yappendixkeyword
5997 \setbox0 = \hbox{#4\enspace}%
5999 \gdef\lastsection{#1}%
6001 \setbox0 = \hbox{#4\enspace}%
6003 \gdef\lastsection{#1}%
6006 % Write the toc entry (before \donoderef). See comments in \chapmacro.
6007 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
6009 % Write the node reference (= pdf destination for pdftex).
6010 % Again, see comments in \chapmacro.
6013 % Interline glue will be inserted when the vbox is completed.
6014 % That glue will be a valid breakpoint for the page, since it'll be
6015 % preceded by a whatsit (usually from the \donoderef, or from the
6016 % \writetocentry if there was no node). We don't want to allow that
6017 % break, since then the whatsits could end up on page n while the
6018 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
6021 % Output the actual section heading.
6022 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
6023 \hangindent=\wd0 % zero if no section number
6026 % Add extra space after the heading -- half of whatever came above it.
6027 % Don't allow stretch, though.
6028 \kern .5 \csname #2headingskip\endcsname
6030 % Do not let the kern be a potential breakpoint, as it would be if it
6031 % was followed by glue.
6034 % We'll almost certainly start a paragraph next, so don't let that
6035 % glue accumulate. (Not a breakpoint because it's preceded by a
6036 % discardable item.) However, when a paragraph is not started next
6037 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
6038 % or the negative glue will cause weirdly wrong output, typically
6039 % obscuring the section heading with something else.
6042 % This is so the last item on the main vertical list is a known
6043 % \penalty > 10000, so \startdefun, etc., can recognize the situation
6044 % and do the needful.
6050 % Table of contents.
6053 % Write an entry to the toc file, opening it if necessary.
6054 % Called from @chapter, etc.
6056 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
6057 % We append the current node name (if any) and page number as additional
6058 % arguments for the \{chap,sec,...}entry macros which will eventually
6059 % read this. The node name is used in the pdf outlines as the
6060 % destination to jump to.
6062 % We open the .toc file for writing here instead of at @setfilename (or
6063 % any other fixed time) so that @contents can be anywhere in the document.
6064 % But if #1 is `omit', then we don't do anything. This is used for the
6065 % table of contents chapter openings themselves.
6067 \newif\iftocfileopened
6068 \def\omitkeyword{omit}%
6070 \def\writetocentry#1#2#3{%
6071 \edef\writetoctype{#1}%
6072 \ifx\writetoctype\omitkeyword \else
6073 \iftocfileopened\else
6074 \immediate\openout\tocfile = \jobname.toc
6075 \global\tocfileopenedtrue
6081 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
6087 % Tell \shipout to create a pdf destination on each page, if we're
6088 % writing pdf. These are used in the table of contents. We can't
6089 % just write one on every page because the title pages are numbered
6090 % 1 and 2 (the page numbers aren't printed), and so are the first
6091 % two pages of the document. Thus, we'd have two destinations named
6092 % `1', and two named `2'.
6093 \ifpdf \global\pdfmakepagedesttrue \fi
6097 % These characters do not print properly in the Computer Modern roman
6098 % fonts, so we must take special care. This is more or less redundant
6099 % with the Texinfo input format setup at the end of this file.
6101 \def\activecatcodes{%
6114 % Read the toc file, which is essentially Texinfo input.
6118 \input \tocreadfilename
6121 \newskip\contentsrightmargin \contentsrightmargin=1in
6122 \newcount\savepageno
6123 \newcount\lastnegativepageno \lastnegativepageno = -1
6125 % Prepare to read what we've written to \tocfile.
6127 \def\startcontents#1{%
6128 % If @setchapternewpage on, and @headings double, the contents should
6129 % start on an odd page, unlike chapters. Thus, we maintain
6130 % \contentsalignmacro in parallel with \pagealignmacro.
6131 % From: Torbjorn Granlund <tege@matematik.su.se>
6133 \immediate\closeout\tocfile
6135 % Don't need to put `Contents' or `Short Contents' in the headline.
6136 % It is abundantly clear what they are.
6137 \chapmacro{#1}{Yomitfromtoc}{}%
6139 \savepageno = \pageno
6140 \begingroup % Set up to handle contents files properly.
6141 \raggedbottom % Worry more about breakpoints than the bottom.
6142 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
6144 % Roman numerals for page numbers.
6145 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
6148 % redefined for the two-volume lispref. We always output on
6149 % \jobname.toc even if this is redefined.
6151 \def\tocreadfilename{\jobname.toc}
6153 % Normal (long) toc.
6156 \startcontents{\putwordTOC}%
6157 \openin 1 \tocreadfilename\space
6162 \contentsalignmacro % in case @setchapternewpage odd is in effect
6168 \lastnegativepageno = \pageno
6169 \global\pageno = \savepageno
6172 % And just the chapters.
6173 \def\summarycontents{%
6174 \startcontents{\putwordShortTOC}%
6176 \let\partentry = \shortpartentry
6177 \let\numchapentry = \shortchapentry
6178 \let\appentry = \shortchapentry
6179 \let\unnchapentry = \shortunnchapentry
6180 % We want a true roman here for the page numbers.
6182 \let\rm=\shortcontrm \let\bf=\shortcontbf
6183 \let\sl=\shortcontsl \let\tt=\shortconttt
6185 \hyphenpenalty = 10000
6186 \advance\baselineskip by 1pt % Open it up a little.
6187 \def\numsecentry##1##2##3##4{}
6188 \let\appsecentry = \numsecentry
6189 \let\unnsecentry = \numsecentry
6190 \let\numsubsecentry = \numsecentry
6191 \let\appsubsecentry = \numsecentry
6192 \let\unnsubsecentry = \numsecentry
6193 \let\numsubsubsecentry = \numsecentry
6194 \let\appsubsubsecentry = \numsecentry
6195 \let\unnsubsubsecentry = \numsecentry
6196 \openin 1 \tocreadfilename\space
6202 \contentsalignmacro % in case @setchapternewpage odd is in effect
6204 \lastnegativepageno = \pageno
6205 \global\pageno = \savepageno
6207 \let\shortcontents = \summarycontents
6209 % Typeset the label for a chapter or appendix for the short contents.
6210 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6212 \def\shortchaplabel#1{%
6213 % This space should be enough, since a single number is .5em, and the
6214 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6215 % But use \hss just in case.
6216 % (This space doesn't include the extra space that gets added after
6217 % the label; that gets put in by \shortchapentry above.)
6219 % We'd like to right-justify chapter numbers, but that looks strange
6220 % with appendix letters. And right-justifying numbers and
6221 % left-justifying letters looks strange when there is less than 10
6222 % chapters. Have to read the whole toc once to know how many chapters
6223 % there are before deciding ...
6224 \hbox to 1em{#1\hss}%
6227 % These macros generate individual entries in the table of contents.
6228 % The first argument is the chapter or section name.
6229 % The last argument is the page number.
6230 % The arguments in between are the chapter number, section number, ...
6232 % Parts, in the main contents. Replace the part number, which doesn't
6233 % exist, with an empty box. Let's hope all the numbers have the same width.
6234 % Also ignore the page number, which is conventionally not printed.
6235 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6236 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6238 % Parts, in the short toc.
6239 \def\shortpartentry#1#2#3#4{%
6241 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6242 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6245 % Chapters, in the main contents.
6246 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6248 % Chapters, in the short toc.
6249 % See comments in \dochapentry re vbox and related settings.
6250 \def\shortchapentry#1#2#3#4{%
6251 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6254 % Appendices, in the main contents.
6255 % Need the word Appendix, and a fixed-size box.
6257 \def\appendixbox#1{%
6258 % We use M since it's probably the widest letter.
6259 \setbox0 = \hbox{\putwordAppendix{} M}%
6260 \hbox to \wd0{\putwordAppendix{} #1\hss}}
6262 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6264 % Unnumbered chapters.
6265 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6266 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6269 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6270 \let\appsecentry=\numsecentry
6271 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6274 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6275 \let\appsubsecentry=\numsubsecentry
6276 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6278 % And subsubsections.
6279 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6280 \let\appsubsubsecentry=\numsubsubsecentry
6281 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6283 % This parameter controls the indentation of the various levels.
6284 % Same as \defaultparindent.
6285 \newdimen\tocindent \tocindent = 15pt
6287 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6290 % If the toc has to be broken over pages, we want it to be at chapters
6291 % if at all possible; hence the \penalty.
6292 \def\dochapentry#1#2{%
6293 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6296 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6298 \nobreak\vskip .25\baselineskip plus.1\baselineskip
6301 \def\dosecentry#1#2{\begingroup
6302 \secentryfonts \leftskip=\tocindent
6303 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6306 \def\dosubsecentry#1#2{\begingroup
6307 \subsecentryfonts \leftskip=2\tocindent
6308 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6311 \def\dosubsubsecentry#1#2{\begingroup
6312 \subsubsecentryfonts \leftskip=3\tocindent
6313 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6316 % We use the same \entry macro as for the index entries.
6317 \let\tocentry = \entry
6319 % Space between chapter (or whatever) number and the title.
6320 \def\labelspace{\hskip1em \relax}
6322 \def\dopageno#1{{\rm #1}}
6323 \def\doshortpageno#1{{\rm #1}}
6325 \def\chapentryfonts{\secfonts \rm}
6326 \def\secentryfonts{\textfonts}
6327 \def\subsecentryfonts{\textfonts}
6328 \def\subsubsecentryfonts{\textfonts}
6331 \message{environments,}
6332 % @foo ... @end foo.
6334 % @tex ... @end tex escapes into raw TeX temporarily.
6335 % One exception: @ is still an escape character, so that @end tex works.
6336 % But \@ or @@ will get a plain @ character.
6339 \setupmarkupstyle{tex}%
6340 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6341 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6342 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6353 % ' is active in math mode (mathcode"8000). So reset it, and all our
6354 % other math active characters (just in case), to plain's definitions.
6357 % Inverse of the list at the beginning of the file.
6359 \let\bullet=\ptexbullet
6364 \let\equiv=\ptexequiv
6367 \let\indent=\ptexindent
6368 \let\noindent=\ptexnoindent
6375 %\let\sup=\ptexsup % do not redefine, we want @sup to work in math mode
6377 \expandafter \let\csname top\endcsname=\ptextop % we've made it outer
6378 \let\frenchspacing=\plainfrenchspacing
6380 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6381 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6384 % There is no need to define \Etex.
6386 % Define @lisp ... @end lisp.
6387 % @lisp environment forms a group so it can rebind things,
6388 % including the definition of @end lisp (which normally is erroneous).
6390 % Amount to narrow the margins by for @lisp.
6391 \newskip\lispnarrowing \lispnarrowing=0.4in
6393 % This is the definition that ^^M gets inside @lisp, @example, and other
6394 % such environments. \null is better than a space, since it doesn't
6396 \def\lisppar{\null\endgraf}
6398 % This space is always present above and below environments.
6399 \newskip\envskipamount \envskipamount = 0pt
6401 % Make spacing and below environment symmetrical. We use \parskip here
6402 % to help in doing that, since in @example-like environments \parskip
6403 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6404 % start of the next paragraph will insert \parskip.
6406 \def\aboveenvbreak{{%
6407 % =10000 instead of <10000 because of a special case in \itemzzz and
6408 % \sectionheading, q.v.
6409 \ifnum \lastpenalty=10000 \else
6410 \advance\envskipamount by \parskip
6412 \ifdim\lastskip<\envskipamount
6414 % it's not a good place to break if the last penalty was \nobreak
6416 \ifnum\lastpenalty<10000 \penalty-50 \fi
6417 \vskip\envskipamount
6422 \let\afterenvbreak = \aboveenvbreak
6424 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6425 % also clear it, so that its embedded environments do the narrowing again.
6426 \let\nonarrowing=\relax
6428 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6429 % environment contents.
6430 \font\circle=lcircle10
6432 \newdimen\cartouter\newdimen\cartinner
6433 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6434 \circthick=\fontdimen8\circle
6436 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6437 \def\ctr{{\hskip 6pt\circle\char'010}}
6438 \def\cbl{{\circle\char'012\hskip -6pt}}
6439 \def\cbr{{\hskip 6pt\circle\char'011}}
6440 \def\carttop{\hbox to \cartouter{\hskip\lskip
6441 \ctl\leaders\hrule height\circthick\hfil\ctr
6443 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6444 \cbl\leaders\hrule height\circthick\hfil\cbr
6447 \newskip\lskip\newskip\rskip
6450 \ifhmode\par\fi % can't be in the midst of a paragraph.
6452 \lskip=\leftskip \rskip=\rightskip
6453 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6454 \cartinner=\hsize \advance\cartinner by-\lskip
6455 \advance\cartinner by-\rskip
6457 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6458 % side, and for 6pt waste from
6459 % each corner char, and rule thickness
6460 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6462 % If this cartouche directly follows a sectioning command, we need the
6463 % \parskip glue (backspaced over by default) or the cartouche can
6464 % collide with the section heading.
6465 \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
6468 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6476 \baselineskip=\normbskip
6477 \lineskip=\normlskip
6480 \comment % For explanation, see the end of def\group.
6495 % This macro is called at the beginning of all the @example variants,
6497 \newdimen\nonfillparindent
6500 \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy
6501 \sepspaces % Make spaces be word-separators rather than space tokens.
6502 \let\par = \lisppar % don't ignore blank lines
6503 \obeylines % each line of input is a line of output
6505 % Turn off paragraph indentation but redefine \indent to emulate
6506 % the normal \indent.
6507 \nonfillparindent=\parindent
6509 \let\indent\nonfillindent
6511 \emergencystretch = 0pt % don't try to avoid overfull boxes
6512 \ifx\nonarrowing\relax
6513 \advance \leftskip by \lispnarrowing
6514 \exdentamount=\lispnarrowing
6516 \let\nonarrowing = \relax
6518 \let\exdent=\nofillexdent
6523 % We want to swallow spaces (but not other tokens) after the fake
6524 % @indent in our nonfill-environments, where spaces are normally
6525 % active and set to @tie, resulting in them not being ignored after
6527 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6528 \gdef\nonfillindentcheck{%
6530 \expandafter\nonfillindentgobble%
6532 \leavevmode\nonfillindentbox%
6536 \def\nonfillindentgobble#1{\nonfillindent}
6537 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6539 % If you want all examples etc. small: @set dispenvsize small.
6540 % If you want even small examples the full size: @set dispenvsize nosmall.
6541 % This affects the following displayed environments:
6542 % @example, @display, @format, @lisp
6544 \def\smallword{small}
6545 \def\nosmallword{nosmall}
6546 \let\SETdispenvsize\relax
6547 \def\setnormaldispenv{%
6548 \ifx\SETdispenvsize\smallword
6549 % end paragraph for sake of leading, in case document has no blank
6550 % line. This is redundant with what happens in \aboveenvbreak, but
6551 % we need to do it before changing the fonts, and it's inconvenient
6552 % to change the fonts afterward.
6553 \ifnum \lastpenalty=10000 \else \endgraf \fi
6554 \smallexamplefonts \rm
6557 \def\setsmalldispenv{%
6558 \ifx\SETdispenvsize\nosmallword
6560 \ifnum \lastpenalty=10000 \else \endgraf \fi
6561 \smallexamplefonts \rm
6565 % We often define two environments, @foo and @smallfoo.
6566 % Let's do it in one command. #1 is the env name, #2 the definition.
6567 \def\makedispenvdef#1#2{%
6568 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6569 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
6570 \expandafter\let\csname E#1\endcsname \afterenvbreak
6571 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6574 % Define two environment synonyms (#1 and #2) for an environment.
6575 \def\maketwodispenvdef#1#2#3{%
6576 \makedispenvdef{#1}{#3}%
6577 \makedispenvdef{#2}{#3}%
6580 % @lisp: indented, narrowed, typewriter font;
6581 % @example: same as @lisp.
6583 % @smallexample and @smalllisp: use smaller fonts.
6584 % Originally contributed by Pavel@xerox.
6586 \maketwodispenvdef{lisp}{example}{%
6588 \tt\setupmarkupstyle{example}%
6589 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6590 \gobble % eat return
6592 % @display/@smalldisplay: same as @lisp except keep current font.
6594 \makedispenvdef{display}{%
6599 % @format/@smallformat: same as @display except don't narrow margins.
6601 \makedispenvdef{format}{%
6602 \let\nonarrowing = t%
6607 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6609 \let\nonarrowing = t%
6613 \let\Eflushleft = \afterenvbreak
6617 \envdef\flushright{%
6618 \let\nonarrowing = t%
6620 \advance\leftskip by 0pt plus 1fill\relax
6623 \let\Eflushright = \afterenvbreak
6626 % @raggedright does more-or-less normal line breaking but no right
6627 % justification. From plain.tex. Don't stretch around special
6628 % characters in urls in this environment, since the stretch at the right
6630 \envdef\raggedright{%
6631 \rightskip0pt plus2.4em \spaceskip.3333em \xspaceskip.5em\relax
6632 \def\urefprestretchamount{0pt}%
6633 \def\urefpoststretchamount{0pt}%
6635 \let\Eraggedright\par
6637 \envdef\raggedleft{%
6638 \parindent=0pt \leftskip0pt plus2em
6639 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6640 \hbadness=10000 % Last line will usually be underfull, so turn off
6641 % badness reporting.
6643 \let\Eraggedleft\par
6645 \envdef\raggedcenter{%
6646 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6647 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6648 \hbadness=10000 % Last line will usually be underfull, so turn off
6649 % badness reporting.
6651 \let\Eraggedcenter\par
6654 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6655 % and narrows the margins. We keep \parskip nonzero in general, since
6656 % we're doing normal filling. So, when using \aboveenvbreak and
6657 % \afterenvbreak, temporarily make \parskip 0.
6659 \makedispenvdef{quotation}{\quotationstart}
6661 \def\quotationstart{%
6662 \indentedblockstart % same as \indentedblock, but increase right margin too.
6663 \ifx\nonarrowing\relax
6664 \advance\rightskip by \lispnarrowing
6666 \parsearg\quotationlabel
6669 % We have retained a nonzero parskip for the environment, since we're
6670 % doing normal filling.
6674 \ifx\quotationauthor\thisisundefined\else
6676 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6678 {\parskip=0pt \afterenvbreak}%
6680 \def\Esmallquotation{\Equotation}
6682 % If we're given an argument, typeset it in bold with a colon after.
6683 \def\quotationlabel#1{%
6685 \ifx\temp\empty \else
6690 % @indentedblock is like @quotation, but indents only on the left and
6691 % has no optional argument.
6693 \makedispenvdef{indentedblock}{\indentedblockstart}
6695 \def\indentedblockstart{%
6696 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6699 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6700 \ifx\nonarrowing\relax
6701 \advance\leftskip by \lispnarrowing
6702 \exdentamount = \lispnarrowing
6704 \let\nonarrowing = \relax
6708 % Keep a nonzero parskip for the environment, since we're doing normal filling.
6710 \def\Eindentedblock{%
6712 {\parskip=0pt \afterenvbreak}%
6714 \def\Esmallindentedblock{\Eindentedblock}
6717 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6718 % If we want to allow any <char> as delimiter,
6719 % we need the curly braces so that makeinfo sees the @verb command, eg:
6720 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6722 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6724 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6725 % active too. Otherwise, they get lost as the first character on a
6728 \do\ \do\\\do\{\do\}\do\$\do\&%
6729 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6730 \do\<\do\>\do\|\do\@\do+\do\"%
6731 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6732 % @set txicodequotebacktick will not have effect on @verb and
6733 % @verbatim, and ?` and !` ligatures won't get disabled.
6738 \def\uncatcodespecials{%
6739 \def\do##1{\catcode`##1=\other}\dospecials}
6741 % Setup for the @verb command.
6743 % Eight spaces for a tab
6745 \catcode`\^^I=\active
6746 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6750 \tt % easiest (and conventionally used) font for verbatim
6751 \def\par{\leavevmode\endgraf}%
6752 \setupmarkupstyle{verb}%
6754 % Respect line breaks,
6755 % print special symbols as themselves, and
6756 % make each space count
6757 % must do in this order:
6758 \obeylines \uncatcodespecials \sepspaces
6761 % Setup for the @verbatim environment
6763 % Real tab expansion.
6764 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6766 % We typeset each line of the verbatim in an \hbox, so we can handle
6767 % tabs. The \global is in case the verbatim line starts with an accent,
6768 % or some other command that starts with a begin-group. Otherwise, the
6769 % entire \verbbox would disappear at the corresponding end-group, before
6770 % it is typeset. Meanwhile, we can't have nested verbatim commands
6771 % (can we?), so the \global won't be overwriting itself.
6773 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
6776 \catcode`\^^I=\active
6778 \catcode`\^^I=\active
6779 \def^^I{\leavevmode\egroup
6780 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
6781 \divide\dimen\verbbox by\tabw
6782 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
6783 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
6784 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
6789 % start the verbatim environment.
6790 \def\setupverbatim{%
6791 \let\nonarrowing = t%
6793 \tt % easiest (and conventionally used) font for verbatim
6794 % The \leavevmode here is for blank lines. Otherwise, we would
6795 % never \starttabox and the \egroup would end verbatim mode.
6796 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6798 \setupmarkupstyle{verbatim}%
6799 % Respect line breaks,
6800 % print special symbols as themselves, and
6801 % make each space count.
6802 % Must do in this order:
6803 \obeylines \uncatcodespecials \sepspaces
6804 \everypar{\starttabbox}%
6807 % Do the @verb magic: verbatim text is quoted by unique
6808 % delimiter characters. Before first delimiter expect a
6809 % right brace, after last delimiter expect closing brace:
6811 % \def\doverb'{'<char>#1<char>'}'{#1}
6813 % [Knuth] p. 382; only eat outer {}
6815 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6816 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6819 \def\verb{\begingroup\setupverb\doverb}
6822 % Do the @verbatim magic: define the macro \doverbatim so that
6823 % the (first) argument ends when '@end verbatim' is reached, ie:
6825 % \def\doverbatim#1@end verbatim{#1}
6827 % For Texinfo it's a lot easier than for LaTeX,
6828 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6829 % we need not redefine '\', '{' and '}'.
6831 % Inspired by LaTeX's verbatim command set [latex.ltx]
6836 % ignore everything up to the first ^^M, that's the newline at the end
6837 % of the @verbatim input line itself. Otherwise we get an extra blank
6838 % line in the output.
6839 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6840 % We really want {...\end verbatim} in the body of the macro, but
6841 % without the active space; thus we have to use \xdef and \gobble.
6845 \setupverbatim\doverbatim
6847 \let\Everbatim = \afterenvbreak
6850 % @verbatiminclude FILE - insert text of file in verbatim environment.
6852 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6854 \def\doverbatiminclude#1{%
6856 \makevalueexpandable
6858 \indexnofonts % Allow `@@' and other weird things in file names.
6859 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
6865 % @copying ... @end copying.
6866 % Save the text away for @insertcopying later.
6868 % We save the uninterpreted tokens, rather than creating a box.
6869 % Saving the text in a box would be much easier, but then all the
6870 % typesetting commands (@smallbook, font changes, etc.) have to be done
6871 % beforehand -- and a) we want @copying to be done first in the source
6872 % file; b) letting users define the frontmatter in as flexible order as
6873 % possible is very desirable.
6875 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6876 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6878 \def\insertcopying{%
6880 \parindent = 0pt % paragraph indentation looks wrong on title page
6881 \scanexp\copyingtext
6889 \newskip\defbodyindent \defbodyindent=.4in
6890 \newskip\defargsindent \defargsindent=50pt
6891 \newskip\deflastargmargin \deflastargmargin=18pt
6892 \newcount\defunpenalty
6894 % Start the processing of @deffn:
6896 \ifnum\lastpenalty<10000
6898 \defunpenalty=10003 % Will keep this @deffn together with the
6899 % following @def command, see below.
6901 % If there are two @def commands in a row, we'll have a \nobreak,
6902 % which is there to keep the function description together with its
6903 % header. But if there's nothing but headers, we need to allow a
6904 % break somewhere. Check specifically for penalty 10002, inserted
6905 % by \printdefunline, instead of 10000, since the sectioning
6906 % commands also insert a nobreak penalty, and we don't want to allow
6907 % a break between a section heading and a defun.
6909 % As a further refinement, we avoid "club" headers by signalling
6910 % with penalty of 10003 after the very first @deffn in the
6911 % sequence (see above), and penalty of 10002 after any following
6913 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6915 % Similarly, after a section heading, do not allow a break.
6916 % But do insert the glue.
6917 \medskip % preceded by discardable penalty, so not a breakpoint
6921 \advance\leftskip by \defbodyindent
6922 \exdentamount=\defbodyindent
6926 % First, check whether we are in the right environment:
6929 % As above, allow line break if we have multiple x headers in a row.
6930 % It's not a great place, though.
6931 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6933 % And now, it's time to reuse the body of the original defun:
6934 \expandafter\gobbledefun#1%
6936 \def\gobbledefun#1\startdefun{}
6938 % \printdefunline \deffnheader{text}
6940 \def\printdefunline#1#2{%
6942 % call \deffnheader:
6945 \interlinepenalty = 10000
6946 \advance\rightskip by 0pt plus 1fil\relax
6948 \nobreak\vskip -\parskip
6949 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6950 % Some of the @defun-type tags do not enable magic parentheses,
6951 % rendering the following check redundant. But we don't optimize.
6956 \def\Edefun{\endgraf\medbreak}
6958 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6959 % the only thing remaining is to define \deffnheader.
6962 \expandafter\let\csname E#1\endcsname = \Edefun
6963 \edef\temp{\noexpand\domakedefun
6964 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6968 % \domakedefun \deffn \deffnx \deffnheader
6970 % Define \deffn and \deffnx, without parameters.
6971 % \deffnheader has to be defined explicitly.
6973 \def\domakedefun#1#2#3{%
6976 \doingtypefnfalse % distinguish typed functions from all else
6977 \parseargusing\activeparens{\printdefunline#3}%
6979 \def#2{\dodefunx#1}%
6983 \newif\ifdoingtypefn % doing typed function?
6984 \newif\ifrettypeownline % typeset return type on its own line?
6986 % @deftypefnnewline on|off says whether the return type of typed functions
6987 % are printed on their own line. This affects @deftypefn, @deftypefun,
6988 % @deftypeop, and @deftypemethod.
6990 \parseargdef\deftypefnnewline{%
6993 \expandafter\let\csname SETtxideftypefnnl\endcsname
6995 \else\ifx\temp\offword
6996 \expandafter\let\csname SETtxideftypefnnl\endcsname
6999 \errhelp = \EMsimple
7000 \errmessage{Unknown @txideftypefnnl value `\temp',
7005 % Untyped functions:
7007 % @deffn category name args
7008 \makedefun{deffn}{\deffngeneral{}}
7010 % @deffn category class name args
7011 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
7013 % \defopon {category on}class name args
7014 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7016 % \deffngeneral {subind}category name args
7018 \def\deffngeneral#1#2 #3 #4\endheader{%
7019 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
7020 \dosubind{fn}{\code{#3}}{#1}%
7021 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
7026 % @deftypefn category type name args
7027 \makedefun{deftypefn}{\deftypefngeneral{}}
7029 % @deftypeop category class type name args
7030 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
7032 % \deftypeopon {category on}class type name args
7033 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7035 % \deftypefngeneral {subind}category type name args
7037 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
7038 \dosubind{fn}{\code{#4}}{#1}%
7040 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7045 % @deftypevr category type var args
7046 \makedefun{deftypevr}{\deftypecvgeneral{}}
7048 % @deftypecv category class type var args
7049 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
7051 % \deftypecvof {category of}class type var args
7052 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
7054 % \deftypecvgeneral {subind}category type var args
7056 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
7057 \dosubind{vr}{\code{#4}}{#1}%
7058 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7061 % Untyped variables:
7063 % @defvr category var args
7064 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
7066 % @defcv category class var args
7067 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
7069 % \defcvof {category of}class var args
7070 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
7074 % @deftp category name args
7075 \makedefun{deftp}#1 #2 #3\endheader{%
7076 \doind{tp}{\code{#2}}%
7077 \defname{#1}{}{#2}\defunargs{#3\unskip}%
7080 % Remaining @defun-like shortcuts:
7081 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
7082 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
7083 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
7084 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
7085 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
7086 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
7087 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
7088 \makedefun{defmethod}{\defopon\putwordMethodon}
7089 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
7090 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
7091 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
7093 % \defname, which formats the name of the @def (not the args).
7094 % #1 is the category, such as "Function".
7095 % #2 is the return type, if any.
7096 % #3 is the function name.
7098 % We are followed by (but not passed) the arguments, if any.
7100 \def\defname#1#2#3{%
7102 % Get the values of \leftskip and \rightskip as they were outside the @def...
7103 \advance\leftskip by -\defbodyindent
7105 % Determine if we are typesetting the return type of a typed function
7106 % on a line by itself.
7107 \rettypeownlinefalse
7108 \ifdoingtypefn % doing a typed function specifically?
7109 % then check user option for putting return type on its own line:
7110 \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
7115 % How we'll format the category name. Putting it in brackets helps
7116 % distinguish it from the body text that may end up on the next line
7119 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7121 % Figure out line sizes for the paragraph shape. We'll always have at
7125 % The first line needs space for \box0; but if \rightskip is nonzero,
7126 % we need only space for the part of \box0 which exceeds it:
7127 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
7129 % If doing a return type on its own line, we'll have another line.
7131 \advance\tempnum by 1
7132 \def\maybeshapeline{0in \hsize}%
7134 \def\maybeshapeline{}%
7137 % The continuations:
7138 \dimen2=\hsize \advance\dimen2 by -\defargsindent
7140 % The final paragraph shape:
7141 \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2
7143 % Put the category name at the right margin.
7146 \hfil\box0 \kern-\hsize
7147 % \hsize has to be shortened this way:
7149 % Intentionally do not respect \rightskip, since we need the space.
7152 % Allow all lines to be underfull without complaint:
7153 \tolerance=10000 \hbadness=10000
7154 \exdentamount=\defbodyindent
7156 % defun fonts. We use typewriter by default (used to be bold) because:
7157 % . we're printing identifiers, they should be in tt in principle.
7158 % . in languages with many accents, such as Czech or French, it's
7159 % common to leave accents off identifiers. The result looks ok in
7160 % tt, but exceedingly strange in rm.
7161 % . we don't want -- and --- to be treated as ligatures.
7162 % . this still does not fix the ?` and !` ligatures, but so far no
7163 % one has made identifiers using them :).
7165 \def\temp{#2}% text of the return type
7166 \ifx\temp\empty\else
7167 \tclose{\temp}% typeset the return type
7169 % put return type on its own line; prohibit line break following:
7170 \hfil\vadjust{\nobreak}\break
7172 \space % type on same line, so just followed by a space
7174 \fi % no return type
7175 #3% output function name
7177 {\rm\enskip}% hskip 0.5 em of \tenrm
7180 % arguments will be output next, if any.
7183 % Print arguments in slanted roman (not ttsl), inconsistently with using
7184 % tt for the name. This is because literal text is sometimes needed in
7185 % the argument list (groff manual), and ttsl and tt are not very
7186 % distinguishable. Prevent hyphenation at `-' chars.
7189 % use sl by default (not ttsl),
7191 \df \sl \hyphenchar\font=0
7193 % On the other hand, if an argument has two dashes (for instance), we
7194 % want a way to get ttsl. We used to recommend @var for that, so
7195 % leave the code in, but it's strange for @var to lead to typewriter.
7196 % Nowadays we recommend @code, since the difference between a ttsl hyphen
7197 % and a tt hyphen is pretty tiny. @code also disables ?` !`.
7198 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
7200 \sl\hyphenchar\font=45
7203 % We want ()&[] to print specially on the defun line.
7206 \catcode`\(=\active \catcode`\)=\active
7207 \catcode`\[=\active \catcode`\]=\active
7211 % Make control sequences which act like normal parenthesis chars.
7212 \let\lparen = ( \let\rparen = )
7214 % Be sure that we always have a definition for `(', etc. For example,
7215 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7216 % so TeX would otherwise complain about undefined control sequence.
7219 \global\let(=\lparen \global\let)=\rparen
7220 \global\let[=\lbrack \global\let]=\rbrack
7223 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7224 \gdef\magicamp{\let&=\amprm}
7227 \newcount\parencount
7229 % If we encounter &foo, then turn on ()-hacking afterwards
7231 \def\amprm#1 {\ampseentrue{\bf\ }}
7235 % At the first level, print parens in roman,
7236 % otherwise use the default font.
7237 \ifnum \parencount=1 \rm \fi
7239 % The \sf parens (in \boldbrax) actually are a little bolder than
7240 % the contained text. This is especially needed for [ and ] .
7244 \def\infirstlevel#1{%
7251 \def\bfafterword#1 {#1 \bf}
7254 \global\advance\parencount by 1
7256 \infirstlevel \bfafterword
7261 \global\advance\parencount by -1
7264 \newcount\brackcount
7266 \global\advance\brackcount by 1
7271 \global\advance\brackcount by -1
7274 \def\checkparencounts{%
7275 \ifnum\parencount=0 \else \badparencount \fi
7276 \ifnum\brackcount=0 \else \badbrackcount \fi
7278 % these should not use \errmessage; the glibc manual, at least, actually
7279 % has such constructs (when documenting function pointers).
7280 \def\badparencount{%
7281 \message{Warning: unbalanced parentheses in @def...}%
7282 \global\parencount=0
7284 \def\badbrackcount{%
7285 \message{Warning: unbalanced square brackets in @def...}%
7286 \global\brackcount=0
7293 % To do this right we need a feature of e-TeX, \scantokens,
7294 % which we arrange to emulate with a temporary file in ordinary TeX.
7295 \ifx\eTeXversion\thisisundefined
7296 \newwrite\macscribble
7299 \immediate\openout\macscribble=\jobname.tmp
7300 \immediate\write\macscribble{\the\toks0}%
7301 \immediate\closeout\macscribble
7306 \def\scanmacro#1{\begingroup
7308 \let\xeatspaces\eatspaces
7310 % Undo catcode changes of \startcontents and \doprintindex
7311 % When called from @insertcopying or (short)caption, we need active
7312 % backslash to get it printed correctly. Previously, we had
7313 % \catcode`\\=\other instead. We'll see whether a problem appears
7314 % with macro expansion. --kasal, 19aug04
7315 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
7317 % ... and for \example:
7320 % The \empty here causes a following catcode 5 newline to be eaten as
7321 % part of reading whitespace after a control sequence. It does not
7322 % eat a catcode 13 newline. There's no good way to handle the two
7323 % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
7324 % would then have different behavior). See the Macro Details node in
7325 % the manual for the workaround we recommend for macros and
7326 % line-oriented commands.
7328 \scantokens{#1\empty}%
7332 \edef\temp{\noexpand\scanmacro{#1}}%
7336 \newcount\paramno % Count of parameters
7337 \newtoks\macname % Macro name
7338 \newif\ifrecursive % Is it recursive?
7340 % List of all defined macros in the form
7341 % \definedummyword\macro1\definedummyword\macro2...
7342 % Currently is also contains all @aliases; the list can be split
7343 % if there is a need.
7346 % Add the macro to \macrolist
7347 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7348 \def\addtomacrolistxxx#1{%
7349 \toks0 = \expandafter{\macrolist\definedummyword#1}%
7350 \xdef\macrolist{\the\toks0}%
7354 % This does \let #1 = #2, with \csnames; that is,
7355 % \let \csname#1\endcsname = \csname#2\endcsname
7356 % (except of course we have to play expansion games).
7360 \csname#1\expandafter\endcsname
7364 % Trim leading and trailing spaces off a string.
7365 % Concepts from aro-bend problem 15 (see CTAN).
7367 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
7368 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
7369 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
7371 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
7374 % Trim a single trailing ^^M off a string.
7375 {\catcode`\^^M=\other \catcode`\Q=3%
7376 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
7377 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
7378 \gdef\eatcrb#1Q#2Q{#1}%
7381 % Macro bodies are absorbed as an argument in a context where
7382 % all characters are catcode 10, 11 or 12, except \ which is active
7383 % (as in normal texinfo). It is necessary to change the definition of \
7384 % to recognize macro arguments; this is the job of \mbodybackslash.
7386 % Non-ASCII encodings make 8-bit characters active, so un-activate
7387 % them to avoid their expansion. Must do this non-globally, to
7388 % confine the change to the current group.
7390 % It's necessary to have hard CRs when the macro is executed. This is
7391 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7392 % body, and then making it the \newlinechar in \scanmacro.
7394 \def\scanctxt{% used as subroutine
7404 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7407 \def\scanargctxt{% used for copying and captions, not macros.
7410 \catcode`\^^M=\other
7413 \def\macrobodyctxt{% used for @macro definitions
7417 \catcode`\^^M=\other
7421 % LilyPond CHANGE: The following definition has been reverted to the
7422 % original definition since it was problematic in the context of
7425 \def\macroargctxt{% used when scanning invocations
7430 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
7431 % for the single characters \ { }. Thus, we end up with the "commands"
7432 % that would be written @\ @{ @} in a Texinfo document.
7434 % We already have @{ and @}. For @\, we define it here, and only for
7435 % this purpose, to produce a typewriter backslash (so, the @\ that we
7436 % define for @math can't be used with @macro calls):
7438 \def\\{\normalbackslash}%
7440 % We would like to do this for \, too, since that is what makeinfo does.
7441 % But it is not possible, because Texinfo already has a command @, for a
7442 % cedilla accent. Documents must use @comma{} instead.
7444 % \anythingelse will almost certainly be an error of some kind.
7446 % \mbodybackslash is the definition of \ in @macro bodies.
7447 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7448 % where N is the macro parameter number.
7449 % We define \csname macarg.\endcsname to be \realbackslash, so
7450 % \\ in macro replacement text gets you a backslash.
7452 {\catcode`@=0 @catcode`@\=@active
7453 @gdef@usembodybackslash{@let\=@mbodybackslash}
7454 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
7456 \expandafter\def\csname macarg.\endcsname{\realbackslash}
7458 \def\margbackslash#1{\char`\#1 }
7460 \def\macro{\recursivefalse\parsearg\macroxxx}
7461 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7464 \getargs{#1}% now \macname is the macname and \argl the arglist
7465 \ifx\argl\empty % no arguments
7468 \expandafter\parsemargdef \argl;%
7469 \if\paramno>256\relax
7470 \ifx\eTeXversion\thisisundefined
7471 \errhelp = \EMsimple
7472 \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
7476 \if1\csname ismacro.\the\macname\endcsname
7477 \message{Warning: redefining \the\macname}%
7479 \expandafter\ifx\csname \the\macname\endcsname \relax
7480 \else \errmessage{Macro name \the\macname\space already defined}\fi
7481 \global\cslet{macsave.\the\macname}{\the\macname}%
7482 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7483 \addtomacrolist{\the\macname}%
7485 \begingroup \macrobodyctxt
7486 \ifrecursive \expandafter\parsermacbody
7487 \else \expandafter\parsemacbody
7490 \parseargdef\unmacro{%
7491 \if1\csname ismacro.#1\endcsname
7492 \global\cslet{#1}{macsave.#1}%
7493 \global\expandafter\let \csname ismacro.#1\endcsname=0%
7494 % Remove the macro name from \macrolist:
7496 \expandafter\let\csname#1\endcsname \relax
7497 \let\definedummyword\unmacrodo
7498 \xdef\macrolist{\macrolist}%
7501 \errmessage{Macro #1 not defined}%
7505 % Called by \do from \dounmacro on each macro. The idea is to omit any
7506 % macro definitions that have been changed to \relax.
7512 \noexpand\definedummyword \noexpand#1%
7516 % This makes use of the obscure feature that if the last token of a
7517 % <parameter list> is #, then the preceding argument is delimited by
7518 % an opening brace, and that opening brace is not consumed.
7519 \def\getargs#1{\getargsxxx#1{}}
7520 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7521 \def\getmacname#1 #2\relax{\macname={#1}}
7522 \def\getmacargs#1{\def\argl{#1}}
7524 % For macro processing make @ a letter so that we can make Texinfo private macro names.
7525 \edef\texiatcatcode{\the\catcode`\@}
7526 \catcode `@=11\relax
7528 % Parse the optional {params} list. Set up \paramno and \paramlist
7529 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
7530 % in the params list to some hook where the argument is to be expanded. If
7531 % there are less than 10 arguments that hook is to be replaced by ##N where N
7532 % is the position in that list, that is to say the macro arguments are to be
7533 % defined `a la TeX in the macro body.
7535 % That gets used by \mbodybackslash (above).
7537 % We need to get `macro parameter char #' into several definitions.
7538 % The technique used is stolen from LaTeX: let \hash be something
7539 % unexpandable, insert that wherever you need a #, and then redefine
7540 % it to # just before using the token list produced.
7542 % The same technique is used to protect \eatspaces till just before
7543 % the macro is used.
7545 % If there are 10 or more arguments, a different technique is used, where the
7546 % hook remains in the body, and when macro is to be expanded the body is
7547 % processed again to replace the arguments.
7549 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7550 % argument N value and then \edef the body (nothing else will expand because of
7551 % the catcode regime underwhich the body was input).
7553 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7554 % arguments, no macro can have more than 256 arguments (else error).
7555 \def\parsemargdef#1;{%
7556 \paramno=0\def\paramlist{}%
7558 \let\xeatspaces\relax
7559 \parsemargdefxxx#1,;,%
7560 % In case that there are 10 or more arguments we parse again the arguments
7561 % list to set new definitions for the \macarg.BLAH macros corresponding to
7562 % each BLAH argument. It was anyhow needed to parse already once this list
7563 % in order to count the arguments, and as macros with at most 9 arguments
7564 % are by far more frequent than macro with 10 or more arguments, defining
7565 % twice the \macarg.BLAH macros does not cost too much processing power.
7566 \ifnum\paramno<10\relax\else
7568 \parsemmanyargdef@@#1,;,% 10 or more arguments
7571 \def\parsemargdefxxx#1,{%
7572 \if#1;\let\next=\relax
7573 \else \let\next=\parsemargdefxxx
7574 \advance\paramno by 1
7575 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7576 {\xeatspaces{\hash\the\paramno}}%
7577 \edef\paramlist{\paramlist\hash\the\paramno,}%
7580 \def\parsemmanyargdef@@#1,{%
7581 \if#1;\let\next=\relax
7583 \let\next=\parsemmanyargdef@@
7584 \edef\tempb{\eatspaces{#1}}%
7585 \expandafter\def\expandafter\tempa
7586 \expandafter{\csname macarg.\tempb\endcsname}%
7587 % Note that we need some extra \noexpand\noexpand, this is because we
7588 % don't want \the to be expanded in the \parsermacbody as it uses an
7590 \expandafter\edef\tempa
7591 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7592 \advance\paramno by 1\relax
7595 % These two commands read recursive and nonrecursive macro bodies.
7596 % (They're different since rec and nonrec macros end differently.)
7599 \catcode `\@\texiatcatcode
7600 \long\def\parsemacbody#1@end macro%
7601 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7602 \long\def\parsermacbody#1@end rmacro%
7603 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7604 \catcode `\@=11\relax
7609 \long\def\nillm@{\nil@}%
7611 % This macro is expanded during the Texinfo macro expansion, not during its
7612 % definition. It gets all the arguments values and assigns them to macros
7615 % #1 is the macro name
7616 % #2 is the list of argument names
7617 % #3 is the list of argument values
7618 \def\getargvals@#1#2#3{%
7619 \def\macargdeflist@{}%
7620 \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
7621 \def\paramlist{#2,\nil@}%
7625 \def\argvaluelist{#3,\nil@}%
7636 \ifx\paramlist\nilm@
7637 % Some sanity check needed here that \argvaluelist is also empty.
7638 \ifx\argvaluelist\nillm@
7640 \errhelp = \EMsimple
7641 \errmessage{Too many arguments in macro `\macroname'!}%
7643 \let\next\macargexpandinbody@
7645 \ifx\argvaluelist\nillm@
7646 % No more arguments values passed to macro. Set remaining named-arg
7648 \let\next\setemptyargvalues@
7650 % pop current arg name into \@tempb
7651 \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
7652 \expandafter\@tempa\expandafter{\paramlist}%
7653 % pop current argument value into \@tempc
7654 \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
7655 \expandafter\@tempa\expandafter{\argvaluelist}%
7656 % Here \@tempb is the current arg name and \@tempc is the current arg value.
7657 % First place the new argument macro definition into \@tempd
7658 \expandafter\macname\expandafter{\@tempc}%
7659 \expandafter\let\csname macarg.\@tempb\endcsname\relax
7660 \expandafter\def\expandafter\@tempe\expandafter{%
7661 \csname macarg.\@tempb\endcsname}%
7662 \edef\@tempd{\long\def\@tempe{\the\macname}}%
7663 \push@\@tempd\macargdeflist@
7664 \let\next\getargvals@@
7671 \expandafter\expandafter\expandafter\def
7672 \expandafter\expandafter\expandafter#2%
7673 \expandafter\expandafter\expandafter{%
7677 % Replace arguments by their values in the macro body, and place the result
7679 \def\macvalstoargs@{%
7680 % To do this we use the property that token registers that are \the'ed
7681 % within an \edef expand only once. So we are going to place all argument
7682 % values into respective token registers.
7684 % First we save the token context, and initialize argument numbering.
7687 % Then, for each argument number #N, we place the corresponding argument
7688 % value into a new token list register \toks#N
7689 \expandafter\putargsintokens@\saveparamlist@,;,%
7690 % Then, we expand the body so that argument are replaced by their
7691 % values. The trick for values not to be expanded themselves is that they
7692 % are within tokens and that tokens expand only once in an \edef .
7693 \edef\@tempc{\csname mac.\macroname .body\endcsname}%
7694 % Now we restore the token stack pointer to free the token list registers
7695 % which we have used, but we make sure that expanded body is saved after
7699 \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
7702 \def\macargexpandinbody@{%
7703 %% Define the named-macro outside of this group and then close this group.
7707 % First the replace in body the macro arguments by their values, the result
7710 % Then we point at the \norecurse or \gobble (for recursive) macro value
7712 \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
7713 % Depending on whether it is recursive or not, we need some tailing
7720 % And now we do the real job:
7721 \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
7725 \def\putargsintokens@#1,{%
7726 \if#1;\let\next\relax
7728 \let\next\putargsintokens@
7729 % First we allocate the new token list register, and give it a temporary
7731 \toksdef\@tempb\the\paramno
7732 % Then we place the argument value into that token list register.
7733 \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
7734 \expandafter\@tempb\expandafter{\@tempa}%
7735 \advance\paramno by 1\relax
7740 % Save the token stack pointer into macro #1
7741 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}}
7742 % Restore the token stack pointer from number in macro #1
7743 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax}
7744 % newtoks that can be used non \outer .
7745 \def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi}
7747 % Tailing missing arguments are set to empty
7748 \def\setemptyargvalues@{%
7749 \ifx\paramlist\nilm@
7750 \let\next\macargexpandinbody@
7752 \expandafter\setemptyargvaluesparser@\paramlist\endargs@
7753 \let\next\setemptyargvalues@
7758 \def\setemptyargvaluesparser@#1,#2\endargs@{%
7759 \expandafter\def\expandafter\@tempa\expandafter{%
7760 \expandafter\def\csname macarg.#1\endcsname{}}%
7761 \push@\@tempa\macargdeflist@
7765 % #1 is the element target macro
7766 % #2 is the list macro
7767 % #3,#4\endargs@ is the list value
7768 \def\pop@#1#2#3,#4\endargs@{%
7772 \long\def\longpop@#1#2#3,#4\endargs@{%
7777 % This defines a Texinfo @macro. There are eight cases: recursive and
7778 % nonrecursive macros of zero, one, up to nine, and many arguments.
7779 % Much magic with \expandafter here.
7780 % \xdef is used so that macro definitions will survive the file
7781 % they're defined in; @include reads the file inside a group.
7784 \let\hash=##% convert placeholders to macro parameter chars
7788 \expandafter\xdef\csname\the\macname\endcsname{%
7789 \noexpand\scanmacro{\temp}}%
7791 \expandafter\xdef\csname\the\macname\endcsname{%
7792 \bgroup\noexpand\macroargctxt
7793 \noexpand\braceorline
7794 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7795 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7796 \egroup\noexpand\scanmacro{\temp}}%
7798 \ifnum\paramno<10\relax % at most 9
7799 \expandafter\xdef\csname\the\macname\endcsname{%
7800 \bgroup\noexpand\macroargctxt
7801 \noexpand\csname\the\macname xx\endcsname}%
7802 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7803 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7804 \expandafter\expandafter
7806 \expandafter\expandafter
7807 \csname\the\macname xxx\endcsname
7808 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7810 \expandafter\xdef\csname\the\macname\endcsname{%
7811 \noexpand\getargvals@{\the\macname}{\argl}%
7813 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7814 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
7820 \expandafter\xdef\csname\the\macname\endcsname{%
7821 \noexpand\norecurse{\the\macname}%
7822 \noexpand\scanmacro{\temp}\egroup}%
7824 \expandafter\xdef\csname\the\macname\endcsname{%
7825 \bgroup\noexpand\macroargctxt
7826 \noexpand\braceorline
7827 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7828 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7830 \noexpand\norecurse{\the\macname}%
7831 \noexpand\scanmacro{\temp}\egroup}%
7833 \ifnum\paramno<10\relax
7834 \expandafter\xdef\csname\the\macname\endcsname{%
7835 \bgroup\noexpand\macroargctxt
7836 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7837 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7838 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7839 \expandafter\expandafter
7841 \expandafter\expandafter
7842 \csname\the\macname xxx\endcsname
7845 \noexpand\norecurse{\the\macname}%
7846 \noexpand\scanmacro{\temp}\egroup}%
7848 \expandafter\xdef\csname\the\macname\endcsname{%
7849 \noexpand\getargvals@{\the\macname}{\argl}%
7851 \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp
7852 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse
7857 \catcode `\@\texiatcatcode\relax
7859 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7861 % \braceorline decides whether the next nonwhitespace character is a
7862 % {. If so it reads up to the closing }, if not, it reads the whole
7863 % line. Whatever was read is then fed to the next control sequence
7864 % as an argument (by \parsebrace or \parsearg).
7866 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7867 \def\braceorlinexxx{%
7868 \ifx\nchar\bgroup\else
7869 \expandafter\parsearg
7874 % We need some trickery to remove the optional spaces around the equal
7875 % sign. Make them active and then expand them all to nothing.
7877 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7878 \def\aliasxxx #1{\aliasyyy#1\relax}
7879 \def\aliasyyy #1=#2\relax{%
7881 \expandafter\let\obeyedspace=\empty
7882 \addtomacrolist{#1}%
7883 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7889 \message{cross references,}
7892 \newif\ifhavexrefs % True if xref values are known.
7893 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7895 % @inforef is relatively simple.
7896 \def\inforef #1{\inforefzzz #1,,,,**}
7897 \def\inforefzzz #1,#2,#3,#4**{%
7898 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7899 node \samp{\ignorespaces#1{}}}
7901 % @node's only job in TeX is to define \lastnode, which is used in
7902 % cross-references. The @node line might or might not have commas, and
7903 % might or might not have spaces before the first comma, like:
7904 % @node foo , bar , ...
7905 % We don't want such trailing spaces in the node name.
7907 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7909 % also remove a trailing comma, in case of something like this:
7910 % @node Help-Cross, , , Cross-refs
7911 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7912 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7915 \let\lastnode=\empty
7917 % Write a cross-reference definition for the current node. #1 is the
7918 % type (Ynumbered, Yappendix, Ynothing).
7921 \ifx\lastnode\empty\else
7922 \setref{\lastnode}{#1}%
7923 \global\let\lastnode=\empty
7927 % @anchor{NAME} -- define xref target at arbitrary point.
7929 \newcount\savesfregister
7931 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7932 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7933 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7935 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7936 % anchor), which consists of three parts:
7937 % 1) NAME-title - the current sectioning name taken from \lastsection,
7938 % or the anchor name.
7939 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7940 % empty for anchors.
7941 % 3) NAME-pg - the page number.
7943 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7944 % floats, there is an additional part, which is not written here:
7945 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7951 \atdummies % preserve commands, but don't expand them
7952 \edef\writexrdef##1##2{%
7953 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7954 ##1}{##2}}% these are parameters of \writexrdef
7956 \toks0 = \expandafter{\lastsection}%
7957 \immediate \writexrdef{title}{\the\toks0 }%
7958 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7959 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
7964 % @xrefautosectiontitle on|off says whether @section(ing) names are used
7965 % automatically in xrefs, if the third arg is not explicitly specified.
7966 % This was provided as a "secret" @set xref-automatic-section-title
7967 % variable, now it's official.
7969 \parseargdef\xrefautomaticsectiontitle{%
7972 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7974 \else\ifx\temp\offword
7975 \expandafter\let\csname SETxref-automatic-section-title\endcsname
7978 \errhelp = \EMsimple
7979 \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
7985 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7986 % the node name, #2 the name of the Info cross-reference, #3 the printed
7987 % node name, #4 the name of the Info file, #5 the name of the printed
7988 % manual. All but the node name can be omitted.
7990 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7991 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7992 \def\ref#1{\xrefX[#1,,,,,,,]}
7995 \newbox\printedrefnamebox
7996 \newbox\infofilenamebox
7997 \newbox\printedmanualbox
7999 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
8002 % Get args without leading/trailing spaces.
8003 \def\printedrefname{\ignorespaces #3}%
8004 \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
8006 \def\infofilename{\ignorespaces #4}%
8007 \setbox\infofilenamebox = \hbox{\infofilename\unskip}%
8009 \def\printedmanual{\ignorespaces #5}%
8010 \setbox\printedmanualbox = \hbox{\printedmanual\unskip}%
8012 % If the printed reference name (arg #3) was not explicitly given in
8013 % the @xref, figure out what we want to use.
8014 \ifdim \wd\printedrefnamebox = 0pt
8015 % No printed node name was explicitly given.
8016 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
8017 % Not auto section-title: use node name inside the square brackets.
8018 \def\printedrefname{\ignorespaces #1}%
8020 % Auto section-title: use chapter/section title inside
8021 % the square brackets if we have it.
8022 \ifdim \wd\printedmanualbox > 0pt
8023 % It is in another manual, so we don't have it; use node name.
8024 \def\printedrefname{\ignorespaces #1}%
8027 % We (should) know the real title if we have the xref values.
8028 \def\printedrefname{\refx{#1-title}{}}%
8030 % Otherwise just copy the Info node name.
8031 \def\printedrefname{\ignorespaces #1}%
8037 % Make link in pdf output.
8041 \makevalueexpandable
8042 % This expands tokens, so do it after making catcode changes, so _
8043 % etc. don't get their TeX definitions. This ignores all spaces in
8044 % #4, including (wrongly) those in the middle of the filename.
8047 % This (wrongly) does not take account of leading or trailing
8048 % spaces in #1, which should be ignored.
8049 \edef\pdfxrefdest{#1}%
8050 \ifx\pdfxrefdest\empty
8051 \def\pdfxrefdest{Top}% no empty targets
8053 \txiescapepdf\pdfxrefdest % escape PDF special chars
8057 \startlink attr{/Border [0 0 0]}%
8058 \ifnum\filenamelength>0
8059 goto file{\the\filename.pdf} name{\pdfxrefdest}%
8061 goto name{\pdfmkpgn{\pdfxrefdest}}%
8064 \setcolor{\linkcolor}%
8067 % Float references are printed completely differently: "Figure 1.2"
8068 % instead of "[somenode], p.3". We distinguish them by the
8069 % LABEL-title being set to a magic string.
8071 % Have to otherify everything special to allow the \csname to
8072 % include an _ in the xref name, etc.
8075 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
8076 \csname XR#1-title\endcsname
8078 \iffloat\Xthisreftitle
8079 % If the user specified the print name (third arg) to the ref,
8080 % print it instead of our usual "Figure 1.2".
8081 \ifdim\wd\printedrefnamebox = 0pt
8087 % If the user also gave the printed manual name (fifth arg), append
8089 \ifdim \wd\printedmanualbox > 0pt
8090 \space \putwordin{} \cite{\printedmanual}%
8093 % node/anchor (non-float) references.
8095 % If we use \unhbox to print the node names, TeX does not insert
8096 % empty discretionaries after hyphens, which means that it will not
8097 % find a line break at a hyphen in a node names. Since some manuals
8098 % are best written with fairly long node names, containing hyphens,
8099 % this is a loss. Therefore, we give the text of the node name
8100 % again, so it is as if TeX is seeing it for the first time.
8102 \ifdim \wd\printedmanualbox > 0pt
8103 % Cross-manual reference with a printed manual name.
8105 \crossmanualxref{\cite{\printedmanual\unskip}}%
8107 \else\ifdim \wd\infofilenamebox > 0pt
8108 % Cross-manual reference with only an info filename (arg 4), no
8109 % printed manual name (arg 5). This is essentially the same as
8110 % the case above; we output the filename, since we have nothing else.
8112 \crossmanualxref{\code{\infofilename\unskip}}%
8115 % Reference within this manual.
8117 % _ (for example) has to be the character _ for the purposes of the
8118 % control sequence corresponding to the node, but it has to expand
8119 % into the usual \leavevmode...\vrule stuff for purposes of
8120 % printing. So we \turnoffactive for the \refx-snt, back on for the
8121 % printing, back off for the \refx-pg.
8123 % Only output a following space if the -snt ref is nonempty; for
8124 % @unnumbered and @anchor, it won't be.
8125 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
8126 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
8128 % output the `[mynode]' via the macro below so it can be overridden.
8129 \xrefprintnodename\printedrefname
8131 % But we always want a comma and a space:
8134 % output the `page 3'.
8135 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
8141 % Output a cross-manual xref to #1. Used just above (twice).
8143 % Only include the text "Section ``foo'' in" if the foo is neither
8144 % missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply
8145 % "see The Foo Manual", the idea being to refer to the whole manual.
8147 % But, this being TeX, we can't easily compare our node name against the
8148 % string "Top" while ignoring the possible spaces before and after in
8149 % the input. By adding the arbitrary 7sp below, we make it much less
8150 % likely that a real node name would have the same width as "Top" (e.g.,
8151 % in a monospaced font). Hopefully it will never happen in practice.
8153 % For the same basic reason, we retypeset the "Top" at every
8154 % reference, since the current font is indeterminate.
8156 \def\crossmanualxref#1{%
8157 \setbox\toprefbox = \hbox{Top\kern7sp}%
8158 \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8159 \ifdim \wd2 > 7sp % nonempty?
8160 \ifdim \wd2 = \wd\toprefbox \else % same as Top?
8161 \putwordSection{} ``\printedrefname'' \putwordin{}\space
8167 % This macro is called from \xrefX for the `[nodename]' part of xref
8168 % output. It's a separate macro only so it can be changed more easily,
8169 % since square brackets don't work well in some documents. Particularly
8170 % one that Bob is working on :).
8172 \def\xrefprintnodename#1{[#1]}
8174 % Things referred to by \setref.
8180 \putwordChapter@tie \the\chapno
8181 \else \ifnum\subsecno=0
8182 \putwordSection@tie \the\chapno.\the\secno
8183 \else \ifnum\subsubsecno=0
8184 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
8186 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
8191 \putwordAppendix@tie @char\the\appendixno{}%
8192 \else \ifnum\subsecno=0
8193 \putwordSection@tie @char\the\appendixno.\the\secno
8194 \else \ifnum\subsubsecno=0
8195 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
8198 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
8202 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
8203 % If its value is nonempty, SUFFIX is output afterward.
8209 \expandafter\global\expandafter\let\expandafter\thisrefX
8210 \csname XR#1\endcsname
8213 % If not defined, say something at least.
8214 \angleleft un\-de\-fined\angleright
8217 {\toks0 = {#1}% avoid expansion of possibly-complex value
8218 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
8221 \global\warnedxrefstrue
8222 \message{Cross reference values unknown; you must run TeX again.}%
8227 % It's defined, so just use it.
8230 #2% Output the suffix in any case.
8233 % This is the macro invoked by entries in the aux file. Usually it's
8234 % just a \def (we prepend XR to the control sequence name to avoid
8235 % collisions). But if this is a float type, we have more work to do.
8238 {% The node name might contain 8-bit characters, which in our current
8239 % implementation are changed to commands like @'e. Don't let these
8240 % mess up the control sequence name.
8243 \xdef\safexrefname{#1}%
8246 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
8248 % Was that xref control sequence that we just defined for a float?
8249 \expandafter\iffloat\csname XR\safexrefname\endcsname
8250 % it was a float, and we have the (safe) float type in \iffloattype.
8251 \expandafter\let\expandafter\floatlist
8252 \csname floatlist\iffloattype\endcsname
8254 % Is this the first time we've seen this float type?
8255 \expandafter\ifx\floatlist\relax
8256 \toks0 = {\do}% yes, so just \do
8258 % had it before, so preserve previous elements in list.
8259 \toks0 = \expandafter{\floatlist\do}%
8262 % Remember this xref in the control sequence \floatlistFLOATTYPE,
8263 % for later use in \listoffloats.
8264 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
8269 % Read the last existing aux file, if any. No error if none exists.
8272 \openin 1 \jobname.aux
8275 \global\havexrefstrue
8280 \def\setupdatafile{%
8281 \catcode`\^^@=\other
8282 \catcode`\^^A=\other
8283 \catcode`\^^B=\other
8284 \catcode`\^^C=\other
8285 \catcode`\^^D=\other
8286 \catcode`\^^E=\other
8287 \catcode`\^^F=\other
8288 \catcode`\^^G=\other
8289 \catcode`\^^H=\other
8290 \catcode`\^^K=\other
8291 \catcode`\^^L=\other
8292 \catcode`\^^N=\other
8293 \catcode`\^^P=\other
8294 \catcode`\^^Q=\other
8295 \catcode`\^^R=\other
8296 \catcode`\^^S=\other
8297 \catcode`\^^T=\other
8298 \catcode`\^^U=\other
8299 \catcode`\^^V=\other
8300 \catcode`\^^W=\other
8301 \catcode`\^^X=\other
8302 \catcode`\^^Z=\other
8303 \catcode`\^^[=\other
8304 \catcode`\^^\=\other
8305 \catcode`\^^]=\other
8306 \catcode`\^^^=\other
8307 \catcode`\^^_=\other
8308 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8309 % in xref tags, i.e., node names. But since ^^e4 notation isn't
8310 % supported in the main text, it doesn't seem desirable. Furthermore,
8311 % that is not enough: for node names that actually contain a ^
8312 % character, we would end up writing a line like this: 'xrdef {'hat
8313 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8314 % argument, and \hat is not an expandable control sequence. It could
8315 % all be worked out, but why? Either we support ^^ or we don't.
8317 % The other change necessary for this was to define \auxhat:
8318 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8319 % and then to call \auxhat in \setq.
8323 % Special characters. Should be turned off anyway, but...
8336 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
8338 % This is to support \ in node names and titles, since the \
8339 % characters end up in a \csname. It's easier than
8340 % leaving it active and making its active definition an actual \
8341 % character. What I don't understand is why it works in the *value*
8342 % of the xrdef. Seems like it should be a catcode12 \, and that
8343 % should not typeset properly. But it works, so I'm moving on for
8344 % now. --karl, 15jan04.
8347 % Make the characters 128-255 be printing characters.
8348 {\setnonasciicharscatcodenonglobal\other}%
8350 % @ is our escape character in .aux files, and we need braces.
8356 \def\readdatafile#1{%
8363 \message{insertions,}
8364 % including footnotes.
8366 \newcount \footnoteno
8368 % The trailing space in the following definition for supereject is
8369 % vital for proper filling; pages come out unaligned when you do a
8370 % pagealignmacro call if that space before the closing brace is
8371 % removed. (Generally, numeric constants should always be followed by a
8372 % space to prevent strange expansion errors.)
8373 \def\supereject{\par\penalty -20000\footnoteno =0 }
8375 % @footnotestyle is meaningful for Info output only.
8376 \let\footnotestyle=\comment
8380 % Auto-number footnotes. Otherwise like plain.
8382 \global\advance\footnoteno by \@ne
8383 \edef\thisfootno{$^{\the\footnoteno}$}%
8385 % In case the footnote comes at the end of a sentence, preserve the
8386 % extra spacing after we do the footnote number.
8388 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
8390 % Remove inadvertent blank space before typesetting the footnote number.
8396 % Don't bother with the trickery in plain.tex to not require the
8397 % footnote text as a parameter. Our footnotes don't need to be so general.
8399 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8400 % \parseargline) fails inside footnotes because the tokens are fixed when
8401 % the footnote is read. --karl, 16nov96.
8404 \insert\footins\bgroup
8406 % Nested footnotes are not supported in TeX, that would take a lot
8407 % more work. (\startsavinginserts does not suffice.)
8408 \let\footnote=\errfootnotenest
8410 % We want to typeset this text as a normal paragraph, even if the
8411 % footnote reference occurs in (for example) a display environment.
8412 % So reset some parameters.
8414 \interlinepenalty\interfootnotelinepenalty
8415 \splittopskip\ht\strutbox % top baseline for broken footnotes
8416 \splitmaxdepth\dp\strutbox
8417 \floatingpenalty\@MM
8422 \parindent\defaultparindent
8426 % Because we use hanging indentation in footnotes, a @noindent appears
8427 % to exdent this text, so make it be a no-op. makeinfo does not use
8428 % hanging indentation so @noindent can still be needed within footnote
8429 % text after an @example or the like (not that this is good style).
8430 \let\noindent = \relax
8432 % Hang the footnote text off the number. Use \everypar in case the
8433 % footnote extends for more than one paragraph.
8434 \everypar = {\hang}%
8435 \textindent{\thisfootno}%
8437 % Don't crash into the line above the footnote text. Since this
8438 % expands into a box, it must come within the paragraph, lest it
8439 % provide a place where TeX can split the footnote.
8442 % Invoke rest of plain TeX footnote routine.
8443 \futurelet\next\fo@t
8445 }%end \catcode `\@=11
8447 \def\errfootnotenest{%
8449 \errmessage{Nested footnotes not supported in texinfo.tex,
8450 even though they work in makeinfo; sorry}
8453 \def\errfootnoteheading{%
8455 \errmessage{Footnotes in chapters, sections, etc., are not supported}
8458 % In case a @footnote appears in a vbox, save the footnote text and create
8459 % the real \insert just after the vbox finished. Otherwise, the insertion
8461 % Similarly, if a @footnote appears inside an alignment, save the footnote
8462 % text to a box and make the \insert when a row of the table is finished.
8463 % And the same can be done for other insert classes. --kasal, 16nov03.
8465 % Replace the \insert primitive by a cheating macro.
8466 % Deeper inside, just make sure that the saved insertions are not spilled
8469 \def\startsavinginserts{%
8470 \ifx \insert\ptexinsert
8471 \let\insert\saveinsert
8473 \let\checkinserts\relax
8477 % This \insert replacement works for both \insert\footins{foo} and
8478 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8481 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8482 \afterassignment\next
8483 % swallow the left brace
8486 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
8487 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
8489 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8491 \def\placesaveins#1{%
8492 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8496 % eat @SAVE -- beware, all of them have catcode \other:
8498 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
8499 \gdef\gobblesave @SAVE{}
8503 \def\newsaveins #1{%
8504 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8507 \def\newsaveinsX #1{%
8508 \csname newbox\endcsname #1%
8509 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8514 \let\checkinserts\empty
8519 % @image. We use the macros from epsf.tex to support this.
8520 % If epsf.tex is not installed and @image is used, we complain.
8522 % Check for and read epsf.tex up front. If we read it only at @image
8523 % time, we might be inside a group, and then its definitions would get
8524 % undone and the next image would fail.
8525 \openin 1 = epsf.tex
8527 % Do not bother showing banner with epsf.tex v2.7k (available in
8528 % doc/epsf.tex and on ctan).
8529 \def\epsfannounce{\toks0 = }%
8534 % We will only complain once about lack of epsf.tex.
8535 \newif\ifwarnednoepsf
8536 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8537 work. It is also included in the Texinfo distribution, or you can get
8538 it from ftp://tug.org/tex/epsf.tex.}
8541 \ifx\epsfbox\thisisundefined
8542 \ifwarnednoepsf \else
8543 \errhelp = \noepsfhelp
8544 \errmessage{epsf.tex not found, images will be ignored}%
8545 \global\warnednoepsftrue
8548 \imagexxx #1,,,,,\finish
8552 % Arguments to @image:
8553 % #1 is (mandatory) image filename; we tack on .eps extension.
8554 % #2 is (optional) width, #3 is (optional) height.
8555 % #4 is (ignored optional) html alt text.
8556 % #5 is (ignored optional) extension.
8557 % #6 is just the usual extra ignored arg for parsing stuff.
8559 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
8560 \catcode`\^^M = 5 % in case we're inside an example
8561 \normalturnoffactive % allow _ et al. in names
8562 % If the image is by itself, center it.
8565 \else \ifx\centersub\centerV
8566 % for @center @image, we need a vbox so we can have our vertical space
8568 \vbox\bgroup % vbox has better behavior than vtop herev
8573 % Usually we'll have text after the image which will insert
8574 % \parskip glue, so insert it here too to equalize the space
8576 \nobreak\vskip\parskip
8580 % Leave vertical mode so that indentation from an enclosing
8581 % environment such as @quotation is respected.
8582 % However, if we're at the top level, we don't want the
8583 % normal paragraph indentation.
8584 % On the other hand, if we are in the case of @center @image, we don't
8585 % want to start a paragraph, which will create a hsize-width box and
8586 % eradicate the centering.
8587 \ifx\centersub\centerV\else \noindent \fi
8591 \dopdfimage{#1}{#2}{#3}%
8593 % \epsfbox itself resets \epsf?size at each figure.
8594 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
8595 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
8600 \medskip % space after a standalone image
8602 \ifx\centersub\centerV \egroup \fi
8606 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8607 % etc. We don't actually implement floating yet, we always include the
8608 % float "here". But it seemed the best name for the future.
8610 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
8612 % There may be a space before second and/or third parameter; delete it.
8613 \def\eatcommaspace#1, {#1,}
8615 % #1 is the optional FLOATTYPE, the text label for this float, typically
8616 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
8617 % this float will not be numbered and cannot be referred to.
8619 % #2 is the optional xref label. Also must be present for the float to
8622 % #3 is the optional positioning argument; for now, it is ignored. It
8623 % will somehow specify the positions allowed to float to (here, top, bottom).
8625 % We keep a separate counter for each FLOATTYPE, which we reset at each
8626 % chapter-level command.
8627 \let\resetallfloatnos=\empty
8629 \def\dofloat#1,#2,#3,#4\finish{%
8630 \let\thiscaption=\empty
8631 \let\thisshortcaption=\empty
8633 % don't lose footnotes inside @float.
8635 % BEWARE: when the floats start float, we have to issue warning whenever an
8636 % insert appears inside a float which could possibly float. --kasal, 26may04
8640 % We can't be used inside a paragraph.
8645 \def\floatlabel{#2}%
8646 \def\floatloc{#3}% we do nothing with this yet.
8648 \ifx\floattype\empty
8649 \let\safefloattype=\empty
8652 % the floattype might have accents or other special characters,
8653 % but we need to use it in a control sequence name.
8656 \xdef\safefloattype{\floattype}%
8660 % If label is given but no type, we handle that as the empty type.
8661 \ifx\floatlabel\empty \else
8662 % We want each FLOATTYPE to be numbered separately (Figure 1,
8663 % Table 1, Figure 2, ...). (And if no label, no number.)
8665 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
8666 \global\advance\floatno by 1
8669 % This magic value for \lastsection is output by \setref as the
8670 % XREFLABEL-title value. \xrefX uses it to distinguish float
8671 % labels (which have a completely different output format) from
8672 % node and anchor labels. And \xrdef uses it to construct the
8675 \edef\lastsection{\floatmagic=\safefloattype}%
8676 \setref{\floatlabel}{Yfloat}%
8680 % start with \parskip glue, I guess.
8683 % Don't suppress indentation if a float happens to start a section.
8684 \restorefirstparagraphindent
8687 % we have these possibilities:
8688 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8689 % @float Foo,lbl & no caption: Foo 1.1
8690 % @float Foo & @caption{Cap}: Foo: Cap
8691 % @float Foo & no caption: Foo
8692 % @float ,lbl & Caption{Cap}: 1.1: Cap
8693 % @float ,lbl & no caption: 1.1
8694 % @float & @caption{Cap}: Cap
8695 % @float & no caption:
8698 \let\floatident = \empty
8700 % In all cases, if we have a float type, it comes first.
8701 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8703 % If we have an xref label, the number comes next.
8704 \ifx\floatlabel\empty \else
8705 \ifx\floattype\empty \else % if also had float type, need tie first.
8706 \appendtomacro\floatident{\tie}%
8709 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8712 % Start the printed caption with what we've constructed in
8713 % \floatident, but keep it separate; we need \floatident again.
8714 \let\captionline = \floatident
8716 \ifx\thiscaption\empty \else
8717 \ifx\floatident\empty \else
8718 \appendtomacro\captionline{: }% had ident, so need a colon between
8722 \appendtomacro\captionline{\scanexp\thiscaption}%
8725 % If we have anything to print, print it, with space before.
8726 % Eventually this needs to become an \insert.
8727 \ifx\captionline\empty \else
8731 % Space below caption.
8735 % If have an xref label, write the list of floats info. Do this
8736 % after the caption, to avoid chance of it being a breakpoint.
8737 \ifx\floatlabel\empty \else
8738 % Write the text that goes in the lof to the aux file as
8739 % \floatlabel-lof. Besides \floatident, we include the short
8740 % caption if specified, else the full caption if specified, else nothing.
8744 % since we read the caption text in the macro world, where ^^M
8745 % is turned into a normal character, we have to scan it back, so
8746 % we don't write the literal three characters "^^M" into the aux file.
8748 \xdef\noexpand\gtemp{%
8749 \ifx\thisshortcaption\empty
8756 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
8757 \ifx\gtemp\empty \else : \gtemp \fi}}%
8760 \egroup % end of \vtop
8762 % place the captured inserts
8764 % BEWARE: when the floats start floating, we have to issue warning
8765 % whenever an insert appears inside a float which could possibly
8766 % float. --kasal, 26may04
8771 % Append the tokens #2 to the definition of macro #1, not expanding either.
8773 \def\appendtomacro#1#2{%
8774 \expandafter\def\expandafter#1\expandafter{#1#2}%
8777 % @caption, @shortcaption
8779 \def\caption{\docaption\thiscaption}
8780 \def\shortcaption{\docaption\thisshortcaption}
8781 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8782 \def\defcaption#1#2{\egroup \def#1{#2}}
8784 % The parameter is the control sequence identifying the counter we are
8785 % going to use. Create it if it doesn't exist and assign it to \floatno.
8788 % Haven't seen this figure type before.
8789 \csname newcount\endcsname #1%
8791 % Remember to reset this floatno at the next chap.
8792 \expandafter\gdef\expandafter\resetallfloatnos
8793 \expandafter{\resetallfloatnos #1=0 }%
8798 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8799 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8800 % first read the @float command.
8802 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
8804 % Magic string used for the XREFLABEL-title value, so \xrefX can
8805 % distinguish floats from other xref types.
8806 \def\floatmagic{!!float!!}
8808 % #1 is the control sequence we are passed; we expand into a conditional
8809 % which is true if #1 represents a float ref. That is, the magic
8810 % \lastsection value which we \setref above.
8812 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
8814 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8815 % (safe) float type for this float. We set \iffloattype to #2.
8817 \def\doiffloat#1=#2=#3\finish{%
8819 \def\iffloattype{#2}%
8820 \ifx\temp\floatmagic
8823 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8825 \parseargdef\listoffloats{%
8826 \def\floattype{#1}% floattype
8828 % the floattype might have accents or other special characters,
8829 % but we need to use it in a control sequence name.
8832 \xdef\safefloattype{\floattype}%
8835 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8836 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8838 % if the user said @listoffloats foo but never @float foo.
8839 \message{\linenumber No `\safefloattype' floats to list.}%
8843 \leftskip=\tocindent % indent these entries like a toc
8844 \let\do=\listoffloatsdo
8845 \csname floatlist\safefloattype\endcsname
8850 % This is called on each entry in a list of floats. We're passed the
8851 % xref label, in the form LABEL-title, which is how we save it in the
8852 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8853 % has the text we're supposed to typeset here.
8855 % Figures without xref labels will not be included in the list (since
8856 % they won't appear in the aux file).
8858 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8859 \def\listoffloatsdoentry#1-title\finish{{%
8860 % Can't fully expand XR#1-lof because it can contain anything. Just
8861 % pass the control sequence. On the other hand, XR#1-pg is just the
8862 % page number, and we want to fully expand that so we can get a link
8864 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8866 % use the same \entry macro we use to generate the TOC and index.
8867 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8872 \message{localization,}
8874 % For single-language documents, @documentlanguage is usually given very
8875 % early, just after @documentencoding. Single argument is the language
8876 % (de) or locale (de_DE) abbreviation.
8879 \catcode`\_ = \active
8881 \parseargdef\documentlanguage{%
8882 \tex % read txi-??.tex file in plain TeX.
8883 % Read the file by the name they passed if it exists.
8884 \let_ = \normalunderscore % normal _ character for filename test
8885 \openin 1 txi-#1.tex
8887 \documentlanguagetrywithoutunderscore #1_\finish
8889 \globaldefs = 1 % everything in the txi-LL files needs to persist
8893 \endgroup % end raw TeX
8896 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8899 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8900 \openin 1 txi-#1.tex
8902 \errhelp = \nolanghelp
8903 \errmessage{Cannot read language file txi-#1.tex}%
8905 \globaldefs = 1 % everything in the txi-LL files needs to persist
8910 }% end of special _ catcode
8912 \newhelp\nolanghelp{The given language definition file cannot be found or
8913 is empty. Maybe you need to install it? Putting it in the current
8914 directory should work if nowhere else does.}
8916 % This macro is called from txi-??.tex files; the first argument is the
8917 % \language name to set (without the "\lang@" prefix), the second and
8918 % third args are \{left,right}hyphenmin.
8920 % The language names to pass are determined when the format is built.
8921 % See the etex.log file created at that time, e.g.,
8922 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8924 % With TeX Live 2008, etex now includes hyphenation patterns for all
8925 % available languages. This means we can support hyphenation in
8926 % Texinfo, at least to some extent. (This still doesn't solve the
8927 % accented characters problem.)
8930 \def\txisetlanguage#1#2#3{%
8931 % do not set the language if the name is undefined in the current TeX.
8932 \expandafter\ifx\csname lang@#1\endcsname \relax
8933 \message{no patterns for #1}%
8935 \global\language = \csname lang@#1\endcsname
8937 % but there is no harm in adjusting the hyphenmin values regardless.
8938 \global\lefthyphenmin = #2\relax
8939 \global\righthyphenmin = #3\relax
8942 % Helpers for encodings.
8943 % Set the catcode of characters 128 through 255 to the specified number.
8945 \def\setnonasciicharscatcode#1{%
8947 \loop\ifnum\count255<256
8948 \global\catcode\count255=#1\relax
8949 \advance\count255 by 1
8953 \def\setnonasciicharscatcodenonglobal#1{%
8955 \loop\ifnum\count255<256
8956 \catcode\count255=#1\relax
8957 \advance\count255 by 1
8961 % @documentencoding sets the definition of non-ASCII characters
8962 % according to the specified encoding.
8964 \parseargdef\documentencoding{%
8965 % Encoding being declared for the document.
8966 \def\declaredencoding{\csname #1.enc\endcsname}%
8968 % Supported encodings: names converted to tokens in order to be able
8969 % to compare them with \ifx.
8970 \def\ascii{\csname US-ASCII.enc\endcsname}%
8971 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8972 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8973 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8974 \def\utfeight{\csname UTF-8.enc\endcsname}%
8976 \ifx \declaredencoding \ascii
8979 \else \ifx \declaredencoding \lattwo
8980 \setnonasciicharscatcode\active
8983 \else \ifx \declaredencoding \latone
8984 \setnonasciicharscatcode\active
8987 \else \ifx \declaredencoding \latnine
8988 \setnonasciicharscatcode\active
8991 \else \ifx \declaredencoding \utfeight
8992 \setnonasciicharscatcode\active
8993 % since we already invoked \utfeightchardefs at the top level
8994 % (below), do not re-invoke it, then our check for duplicated
8995 % definitions triggers. Making non-ascii chars active is enough.
8998 \message{Ignoring unknown document encoding: #1.}%
9008 % A message to be logged when using a character that isn't available
9009 % the default font encoding (OT1).
9011 \def\missingcharmsg#1{\message{Character missing, sorry: #1.}}
9013 % Take account of \c (plain) vs. \, (Texinfo) difference.
9014 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
9016 % First, make active non-ASCII characters in order for them to be
9017 % correctly categorized when TeX reads the replacement text of
9018 % macros containing the character definitions.
9019 \setnonasciicharscatcode\active
9021 % Latin1 (ISO-8859-1) character definitions.
9022 \def\latonechardefs{%
9024 \gdef^^a1{\exclamdown}
9025 \gdef^^a2{\missingcharmsg{CENT SIGN}}
9026 \gdef^^a3{{\pounds}}
9027 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
9028 \gdef^^a5{\missingcharmsg{YEN SIGN}}
9029 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
9032 \gdef^^a9{\copyright}
9034 \gdef^^ab{\guillemetleft}
9037 \gdef^^ae{\registeredsymbol}
9040 \gdef^^b0{\textdegree}
9047 \gdef^^b7{\ifmmode\cdot\else $\cdot$\fi}
9048 \gdef^^b8{\cedilla\ }
9051 \gdef^^bb{\guillemetright}
9052 \gdef^^bc{$1\over4$}
9053 \gdef^^bd{$1\over2$}
9054 \gdef^^be{$3\over4$}
9055 \gdef^^bf{\questiondown}
9062 \gdef^^c5{\ringaccent A}
9064 \gdef^^c7{\cedilla C}
9096 \gdef^^e5{\ringaccent a}
9098 \gdef^^e7{\cedilla c}
9103 \gdef^^ec{\`{\dotless i}}
9104 \gdef^^ed{\'{\dotless i}}
9105 \gdef^^ee{\^{\dotless i}}
9106 \gdef^^ef{\"{\dotless i}}
9126 % Latin9 (ISO-8859-15) encoding character definitions.
9127 \def\latninechardefs{%
9128 % Encoding is almost identical to Latin1.
9141 % Latin2 (ISO-8859-2) character definitions.
9142 \def\lattwochardefs{%
9144 \gdef^^a1{\ogonek{A}}
9147 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
9153 \gdef^^aa{\cedilla S}
9158 \gdef^^af{\dotaccent Z}
9160 \gdef^^b0{\textdegree}
9161 \gdef^^b1{\ogonek{a}}
9162 \gdef^^b2{\ogonek{ }}
9168 \gdef^^b8{\cedilla\ }
9170 \gdef^^ba{\cedilla s}
9175 \gdef^^bf{\dotaccent z}
9184 \gdef^^c7{\cedilla C}
9187 \gdef^^ca{\ogonek{E}}
9203 \gdef^^d9{\ringaccent U}
9208 \gdef^^de{\cedilla T}
9218 \gdef^^e7{\cedilla c}
9221 \gdef^^ea{\ogonek{e}}
9224 \gdef^^ed{\'{\dotless{i}}}
9225 \gdef^^ee{\^{\dotless{i}}}
9237 \gdef^^f9{\ringaccent u}
9242 \gdef^^fe{\cedilla t}
9243 \gdef^^ff{\dotaccent{}}
9246 % UTF-8 character definitions.
9248 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
9249 % changes for Texinfo conventions. It is included here under the GPL by
9250 % permission from Frank Mittelbach and the LaTeX team.
9256 \gdef\UTFviiiTwoOctets#1#2{\expandafter
9257 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
9259 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
9260 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
9262 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
9263 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
9265 \gdef\UTFviiiDefined#1{%
9267 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
9278 \global\catcode\countUTFx\active
9279 \uccode`\~\countUTFx
9280 \uppercase\expandafter{\UTFviiiTmp}%
9281 \advance\countUTFx by 1
9282 \ifnum\countUTFx < \countUTFy
9283 \expandafter\UTFviiiLoop
9289 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
9295 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
9301 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
9305 \def\globallet{\global\let} % save some \expandafter's below
9307 % @U{xxxx} to produce U+xxxx, if we support it.
9309 \expandafter\ifx\csname uni:#1\endcsname \relax
9310 \errhelp = \EMsimple
9311 \errmessage{Unicode character U+#1 not supported, sorry}%
9313 \csname uni:#1\endcsname
9325 \gdef\DeclareUnicodeCharacter#1#2{%
9326 \countUTFz = "#1\relax
9327 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9330 \def\UTFviiiTwoOctets##1##2{%
9331 \csname u8:##1\string ##2\endcsname}%
9332 \def\UTFviiiThreeOctets##1##2##3{%
9333 \csname u8:##1\string ##2\string ##3\endcsname}%
9334 \def\UTFviiiFourOctets##1##2##3##4{%
9335 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
9336 \expandafter\expandafter\expandafter\expandafter
9337 \expandafter\expandafter\expandafter
9338 \gdef\UTFviiiTmp{#2}%
9340 \expandafter\ifx\csname uni:#1\endcsname \relax \else
9341 \errmessage{Internal error, already defined: #1}%
9344 % define an additional control sequence for this code point.
9345 \expandafter\globallet\csname uni:#1\endcsname \UTFviiiTmp
9348 \gdef\parseXMLCharref{%
9349 \ifnum\countUTFz < "A0\relax
9350 \errhelp = \EMsimple
9351 \errmessage{Cannot define Unicode char value < 00A0}%
9352 \else\ifnum\countUTFz < "800\relax
9354 \parseUTFviiiB C\UTFviiiTwoOctets.,%
9355 \else\ifnum\countUTFz < "10000\relax
9358 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
9363 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
9367 \gdef\parseUTFviiiA#1{%
9368 \countUTFx = \countUTFz
9369 \divide\countUTFz by 64
9370 \countUTFy = \countUTFz
9371 \multiply\countUTFz by 64
9372 \advance\countUTFx by -\countUTFz
9373 \advance\countUTFx by 128
9374 \uccode `#1\countUTFx
9375 \countUTFz = \countUTFy}
9377 \gdef\parseUTFviiiB#1#2#3#4{%
9378 \advance\countUTFz by "#10\relax
9379 \uccode `#3\countUTFz
9380 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9383 % https://en.wikipedia.org/wiki/Plane_(Unicode)#Basic_M
9384 % U+0000..U+007F = https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)
9385 % U+0080..U+00FF = https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)
9386 % U+0100..U+017F = https://en.wikipedia.org/wiki/Latin_Extended-A
9387 % U+0180..U+024F = https://en.wikipedia.org/wiki/Latin_Extended-B
9389 % Many of our renditions are less than wonderful, and all the missing
9390 % characters are available somewhere. Loading the necessary fonts
9391 % awaits user request. We can't truly support Unicode without
9392 % reimplementing everything that's been done in LaTeX for many years,
9393 % plus probably using luatex or xetex, and who knows what else.
9394 % We won't be doing that here in this simple file. But we can try to at
9395 % least make most of the characters not bomb out.
9397 \def\utfeightchardefs{%
9398 \DeclareUnicodeCharacter{00A0}{\tie}
9399 \DeclareUnicodeCharacter{00A1}{\exclamdown}
9400 \DeclareUnicodeCharacter{00A3}{\pounds}
9401 \DeclareUnicodeCharacter{00A7}{\S}
9402 \DeclareUnicodeCharacter{00A8}{\"{ }}
9403 \DeclareUnicodeCharacter{00A9}{\copyright}
9404 \DeclareUnicodeCharacter{00AA}{\ordf}
9405 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
9406 \DeclareUnicodeCharacter{00AC}{\ifmmode\lnot\else $\lnot$\fi}
9407 \DeclareUnicodeCharacter{00AD}{\-}
9408 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
9409 \DeclareUnicodeCharacter{00AF}{\={ }}
9411 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
9412 \DeclareUnicodeCharacter{00B1}{\ifmmode\pm\else $\pm$\fi}
9413 \DeclareUnicodeCharacter{00B2}{$^2$}
9414 \DeclareUnicodeCharacter{00B3}{$^3$}
9415 \DeclareUnicodeCharacter{00B4}{\'{ }}
9416 \DeclareUnicodeCharacter{00B5}{$\mu$}
9417 \DeclareUnicodeCharacter{00B6}{\P}
9418 \DeclareUnicodeCharacter{00B7}{\ifmmode\cdot\else $\cdot$\fi}
9419 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
9420 \DeclareUnicodeCharacter{00B9}{$^1$}
9421 \DeclareUnicodeCharacter{00BA}{\ordm}
9422 \DeclareUnicodeCharacter{00BB}{\guillemetright}
9423 \DeclareUnicodeCharacter{00BC}{$1\over4$}
9424 \DeclareUnicodeCharacter{00BD}{$1\over2$}
9425 \DeclareUnicodeCharacter{00BE}{$3\over4$}
9426 \DeclareUnicodeCharacter{00BF}{\questiondown}
9428 \DeclareUnicodeCharacter{00C0}{\`A}
9429 \DeclareUnicodeCharacter{00C1}{\'A}
9430 \DeclareUnicodeCharacter{00C2}{\^A}
9431 \DeclareUnicodeCharacter{00C3}{\~A}
9432 \DeclareUnicodeCharacter{00C4}{\"A}
9433 \DeclareUnicodeCharacter{00C5}{\AA}
9434 \DeclareUnicodeCharacter{00C6}{\AE}
9435 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
9436 \DeclareUnicodeCharacter{00C8}{\`E}
9437 \DeclareUnicodeCharacter{00C9}{\'E}
9438 \DeclareUnicodeCharacter{00CA}{\^E}
9439 \DeclareUnicodeCharacter{00CB}{\"E}
9440 \DeclareUnicodeCharacter{00CC}{\`I}
9441 \DeclareUnicodeCharacter{00CD}{\'I}
9442 \DeclareUnicodeCharacter{00CE}{\^I}
9443 \DeclareUnicodeCharacter{00CF}{\"I}
9445 \DeclareUnicodeCharacter{00D0}{\DH}
9446 \DeclareUnicodeCharacter{00D1}{\~N}
9447 \DeclareUnicodeCharacter{00D2}{\`O}
9448 \DeclareUnicodeCharacter{00D3}{\'O}
9449 \DeclareUnicodeCharacter{00D4}{\^O}
9450 \DeclareUnicodeCharacter{00D5}{\~O}
9451 \DeclareUnicodeCharacter{00D6}{\"O}
9452 \DeclareUnicodeCharacter{00D7}{\ifmmode\times\else $\times$\fi}
9453 \DeclareUnicodeCharacter{00D8}{\O}
9454 \DeclareUnicodeCharacter{00D9}{\`U}
9455 \DeclareUnicodeCharacter{00DA}{\'U}
9456 \DeclareUnicodeCharacter{00DB}{\^U}
9457 \DeclareUnicodeCharacter{00DC}{\"U}
9458 \DeclareUnicodeCharacter{00DD}{\'Y}
9459 \DeclareUnicodeCharacter{00DE}{\TH}
9460 \DeclareUnicodeCharacter{00DF}{\ss}
9462 \DeclareUnicodeCharacter{00E0}{\`a}
9463 \DeclareUnicodeCharacter{00E1}{\'a}
9464 \DeclareUnicodeCharacter{00E2}{\^a}
9465 \DeclareUnicodeCharacter{00E3}{\~a}
9466 \DeclareUnicodeCharacter{00E4}{\"a}
9467 \DeclareUnicodeCharacter{00E5}{\aa}
9468 \DeclareUnicodeCharacter{00E6}{\ae}
9469 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
9470 \DeclareUnicodeCharacter{00E8}{\`e}
9471 \DeclareUnicodeCharacter{00E9}{\'e}
9472 \DeclareUnicodeCharacter{00EA}{\^e}
9473 \DeclareUnicodeCharacter{00EB}{\"e}
9474 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
9475 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
9476 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
9477 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
9479 \DeclareUnicodeCharacter{00F0}{\dh}
9480 \DeclareUnicodeCharacter{00F1}{\~n}
9481 \DeclareUnicodeCharacter{00F2}{\`o}
9482 \DeclareUnicodeCharacter{00F3}{\'o}
9483 \DeclareUnicodeCharacter{00F4}{\^o}
9484 \DeclareUnicodeCharacter{00F5}{\~o}
9485 \DeclareUnicodeCharacter{00F6}{\"o}
9486 \DeclareUnicodeCharacter{00F7}{\ifmmode\div\else $\div$\fi}
9487 \DeclareUnicodeCharacter{00F8}{\o}
9488 \DeclareUnicodeCharacter{00F9}{\`u}
9489 \DeclareUnicodeCharacter{00FA}{\'u}
9490 \DeclareUnicodeCharacter{00FB}{\^u}
9491 \DeclareUnicodeCharacter{00FC}{\"u}
9492 \DeclareUnicodeCharacter{00FD}{\'y}
9493 \DeclareUnicodeCharacter{00FE}{\th}
9494 \DeclareUnicodeCharacter{00FF}{\"y}
9496 \DeclareUnicodeCharacter{0100}{\=A}
9497 \DeclareUnicodeCharacter{0101}{\=a}
9498 \DeclareUnicodeCharacter{0102}{\u{A}}
9499 \DeclareUnicodeCharacter{0103}{\u{a}}
9500 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
9501 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
9502 \DeclareUnicodeCharacter{0106}{\'C}
9503 \DeclareUnicodeCharacter{0107}{\'c}
9504 \DeclareUnicodeCharacter{0108}{\^C}
9505 \DeclareUnicodeCharacter{0109}{\^c}
9506 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
9507 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
9508 \DeclareUnicodeCharacter{010C}{\v{C}}
9509 \DeclareUnicodeCharacter{010D}{\v{c}}
9510 \DeclareUnicodeCharacter{010E}{\v{D}}
9511 \DeclareUnicodeCharacter{010F}{d'}
9513 \DeclareUnicodeCharacter{0110}{\DH}
9514 \DeclareUnicodeCharacter{0111}{\dh}
9515 \DeclareUnicodeCharacter{0112}{\=E}
9516 \DeclareUnicodeCharacter{0113}{\=e}
9517 \DeclareUnicodeCharacter{0114}{\u{E}}
9518 \DeclareUnicodeCharacter{0115}{\u{e}}
9519 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
9520 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
9521 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
9522 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
9523 \DeclareUnicodeCharacter{011A}{\v{E}}
9524 \DeclareUnicodeCharacter{011B}{\v{e}}
9525 \DeclareUnicodeCharacter{011C}{\^G}
9526 \DeclareUnicodeCharacter{011D}{\^g}
9527 \DeclareUnicodeCharacter{011E}{\u{G}}
9528 \DeclareUnicodeCharacter{011F}{\u{g}}
9530 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
9531 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
9532 \DeclareUnicodeCharacter{0122}{\cedilla{G}}
9533 \DeclareUnicodeCharacter{0123}{\cedilla{g}}
9534 \DeclareUnicodeCharacter{0124}{\^H}
9535 \DeclareUnicodeCharacter{0125}{\^h}
9536 \DeclareUnicodeCharacter{0126}{\missingcharmsg{H WITH STROKE}}
9537 \DeclareUnicodeCharacter{0127}{\missingcharmsg{h WITH STROKE}}
9538 \DeclareUnicodeCharacter{0128}{\~I}
9539 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
9540 \DeclareUnicodeCharacter{012A}{\=I}
9541 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
9542 \DeclareUnicodeCharacter{012C}{\u{I}}
9543 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
9544 \DeclareUnicodeCharacter{012E}{\ogonek{I}}
9545 \DeclareUnicodeCharacter{012F}{\ogonek{i}}
9547 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
9548 \DeclareUnicodeCharacter{0131}{\dotless{i}}
9549 \DeclareUnicodeCharacter{0132}{IJ}
9550 \DeclareUnicodeCharacter{0133}{ij}
9551 \DeclareUnicodeCharacter{0134}{\^J}
9552 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
9553 \DeclareUnicodeCharacter{0136}{\cedilla{K}}
9554 \DeclareUnicodeCharacter{0137}{\cedilla{k}}
9555 \DeclareUnicodeCharacter{0138}{\ifmmode\kappa\else $\kappa$\fi}
9556 \DeclareUnicodeCharacter{0139}{\'L}
9557 \DeclareUnicodeCharacter{013A}{\'l}
9558 \DeclareUnicodeCharacter{013B}{\cedilla{L}}
9559 \DeclareUnicodeCharacter{013C}{\cedilla{l}}
9560 \DeclareUnicodeCharacter{013D}{L'}% should kern
9561 \DeclareUnicodeCharacter{013E}{l'}% should kern
9562 \DeclareUnicodeCharacter{013F}{L\U{00B7}}
9564 \DeclareUnicodeCharacter{0140}{l\U{00B7}}
9565 \DeclareUnicodeCharacter{0141}{\L}
9566 \DeclareUnicodeCharacter{0142}{\l}
9567 \DeclareUnicodeCharacter{0143}{\'N}
9568 \DeclareUnicodeCharacter{0144}{\'n}
9569 \DeclareUnicodeCharacter{0145}{\cedilla{N}}
9570 \DeclareUnicodeCharacter{0146}{\cedilla{n}}
9571 \DeclareUnicodeCharacter{0147}{\v{N}}
9572 \DeclareUnicodeCharacter{0148}{\v{n}}
9573 \DeclareUnicodeCharacter{0149}{'n}
9574 \DeclareUnicodeCharacter{014A}{\missingcharmsg{ENG}}
9575 \DeclareUnicodeCharacter{014B}{\missingcharmsg{eng}}
9576 \DeclareUnicodeCharacter{014C}{\=O}
9577 \DeclareUnicodeCharacter{014D}{\=o}
9578 \DeclareUnicodeCharacter{014E}{\u{O}}
9579 \DeclareUnicodeCharacter{014F}{\u{o}}
9581 \DeclareUnicodeCharacter{0150}{\H{O}}
9582 \DeclareUnicodeCharacter{0151}{\H{o}}
9583 \DeclareUnicodeCharacter{0152}{\OE}
9584 \DeclareUnicodeCharacter{0153}{\oe}
9585 \DeclareUnicodeCharacter{0154}{\'R}
9586 \DeclareUnicodeCharacter{0155}{\'r}
9587 \DeclareUnicodeCharacter{0156}{\cedilla{R}}
9588 \DeclareUnicodeCharacter{0157}{\cedilla{r}}
9589 \DeclareUnicodeCharacter{0158}{\v{R}}
9590 \DeclareUnicodeCharacter{0159}{\v{r}}
9591 \DeclareUnicodeCharacter{015A}{\'S}
9592 \DeclareUnicodeCharacter{015B}{\'s}
9593 \DeclareUnicodeCharacter{015C}{\^S}
9594 \DeclareUnicodeCharacter{015D}{\^s}
9595 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
9596 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
9598 \DeclareUnicodeCharacter{0160}{\v{S}}
9599 \DeclareUnicodeCharacter{0161}{\v{s}}
9600 \DeclareUnicodeCharacter{0162}{\cedilla{T}}
9601 \DeclareUnicodeCharacter{0163}{\cedilla{t}}
9602 \DeclareUnicodeCharacter{0164}{\v{T}}
9603 \DeclareUnicodeCharacter{0165}{\v{t}}
9604 \DeclareUnicodeCharacter{0166}{\missingcharmsg{H WITH STROKE}}
9605 \DeclareUnicodeCharacter{0167}{\missingcharmsg{h WITH STROKE}}
9606 \DeclareUnicodeCharacter{0168}{\~U}
9607 \DeclareUnicodeCharacter{0169}{\~u}
9608 \DeclareUnicodeCharacter{016A}{\=U}
9609 \DeclareUnicodeCharacter{016B}{\=u}
9610 \DeclareUnicodeCharacter{016C}{\u{U}}
9611 \DeclareUnicodeCharacter{016D}{\u{u}}
9612 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
9613 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
9615 \DeclareUnicodeCharacter{0170}{\H{U}}
9616 \DeclareUnicodeCharacter{0171}{\H{u}}
9617 \DeclareUnicodeCharacter{0172}{\ogonek{U}}
9618 \DeclareUnicodeCharacter{0173}{\ogonek{u}}
9619 \DeclareUnicodeCharacter{0174}{\^W}
9620 \DeclareUnicodeCharacter{0175}{\^w}
9621 \DeclareUnicodeCharacter{0176}{\^Y}
9622 \DeclareUnicodeCharacter{0177}{\^y}
9623 \DeclareUnicodeCharacter{0178}{\"Y}
9624 \DeclareUnicodeCharacter{0179}{\'Z}
9625 \DeclareUnicodeCharacter{017A}{\'z}
9626 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
9627 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
9628 \DeclareUnicodeCharacter{017D}{\v{Z}}
9629 \DeclareUnicodeCharacter{017E}{\v{z}}
9630 \DeclareUnicodeCharacter{017F}{\missingcharmsg{LONG S}}
9632 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
9633 \DeclareUnicodeCharacter{01C5}{D\v{z}}
9634 \DeclareUnicodeCharacter{01C6}{d\v{z}}
9635 \DeclareUnicodeCharacter{01C7}{LJ}
9636 \DeclareUnicodeCharacter{01C8}{Lj}
9637 \DeclareUnicodeCharacter{01C9}{lj}
9638 \DeclareUnicodeCharacter{01CA}{NJ}
9639 \DeclareUnicodeCharacter{01CB}{Nj}
9640 \DeclareUnicodeCharacter{01CC}{nj}
9641 \DeclareUnicodeCharacter{01CD}{\v{A}}
9642 \DeclareUnicodeCharacter{01CE}{\v{a}}
9643 \DeclareUnicodeCharacter{01CF}{\v{I}}
9645 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
9646 \DeclareUnicodeCharacter{01D1}{\v{O}}
9647 \DeclareUnicodeCharacter{01D2}{\v{o}}
9648 \DeclareUnicodeCharacter{01D3}{\v{U}}
9649 \DeclareUnicodeCharacter{01D4}{\v{u}}
9651 \DeclareUnicodeCharacter{01E2}{\={\AE}}
9652 \DeclareUnicodeCharacter{01E3}{\={\ae}}
9653 \DeclareUnicodeCharacter{01E6}{\v{G}}
9654 \DeclareUnicodeCharacter{01E7}{\v{g}}
9655 \DeclareUnicodeCharacter{01E8}{\v{K}}
9656 \DeclareUnicodeCharacter{01E9}{\v{k}}
9658 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
9659 \DeclareUnicodeCharacter{01F1}{DZ}
9660 \DeclareUnicodeCharacter{01F2}{Dz}
9661 \DeclareUnicodeCharacter{01F3}{dz}
9662 \DeclareUnicodeCharacter{01F4}{\'G}
9663 \DeclareUnicodeCharacter{01F5}{\'g}
9664 \DeclareUnicodeCharacter{01F8}{\`N}
9665 \DeclareUnicodeCharacter{01F9}{\`n}
9666 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
9667 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
9668 \DeclareUnicodeCharacter{01FE}{\'{\O}}
9669 \DeclareUnicodeCharacter{01FF}{\'{\o}}
9671 \DeclareUnicodeCharacter{021E}{\v{H}}
9672 \DeclareUnicodeCharacter{021F}{\v{h}}
9674 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
9675 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
9676 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
9677 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
9678 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
9679 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
9681 \DeclareUnicodeCharacter{0232}{\=Y}
9682 \DeclareUnicodeCharacter{0233}{\=y}
9683 \DeclareUnicodeCharacter{0237}{\dotless{j}}
9685 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
9687 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
9688 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
9689 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
9690 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
9691 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
9692 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
9693 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
9694 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
9695 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
9696 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
9697 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
9698 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
9700 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
9701 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
9703 \DeclareUnicodeCharacter{1E20}{\=G}
9704 \DeclareUnicodeCharacter{1E21}{\=g}
9705 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
9706 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
9707 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
9708 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
9709 \DeclareUnicodeCharacter{1E26}{\"H}
9710 \DeclareUnicodeCharacter{1E27}{\"h}
9712 \DeclareUnicodeCharacter{1E30}{\'K}
9713 \DeclareUnicodeCharacter{1E31}{\'k}
9714 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
9715 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
9716 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
9717 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
9718 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
9719 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
9720 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
9721 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
9722 \DeclareUnicodeCharacter{1E3E}{\'M}
9723 \DeclareUnicodeCharacter{1E3F}{\'m}
9725 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
9726 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
9727 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
9728 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
9729 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
9730 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
9731 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
9732 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
9733 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
9734 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
9736 \DeclareUnicodeCharacter{1E54}{\'P}
9737 \DeclareUnicodeCharacter{1E55}{\'p}
9738 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
9739 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
9740 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
9741 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
9742 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
9743 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
9744 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
9745 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
9747 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
9748 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
9749 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
9750 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
9751 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
9752 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
9753 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
9754 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
9755 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
9756 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
9758 \DeclareUnicodeCharacter{1E7C}{\~V}
9759 \DeclareUnicodeCharacter{1E7D}{\~v}
9760 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
9761 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
9763 \DeclareUnicodeCharacter{1E80}{\`W}
9764 \DeclareUnicodeCharacter{1E81}{\`w}
9765 \DeclareUnicodeCharacter{1E82}{\'W}
9766 \DeclareUnicodeCharacter{1E83}{\'w}
9767 \DeclareUnicodeCharacter{1E84}{\"W}
9768 \DeclareUnicodeCharacter{1E85}{\"w}
9769 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
9770 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
9771 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
9772 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
9773 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
9774 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
9775 \DeclareUnicodeCharacter{1E8C}{\"X}
9776 \DeclareUnicodeCharacter{1E8D}{\"x}
9777 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
9778 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
9780 \DeclareUnicodeCharacter{1E90}{\^Z}
9781 \DeclareUnicodeCharacter{1E91}{\^z}
9782 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
9783 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
9784 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
9785 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
9786 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
9787 \DeclareUnicodeCharacter{1E97}{\"t}
9788 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
9789 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
9791 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
9792 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
9794 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
9795 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
9796 \DeclareUnicodeCharacter{1EBC}{\~E}
9797 \DeclareUnicodeCharacter{1EBD}{\~e}
9799 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
9800 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
9801 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
9802 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
9804 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
9805 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
9807 \DeclareUnicodeCharacter{1EF2}{\`Y}
9808 \DeclareUnicodeCharacter{1EF3}{\`y}
9809 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
9811 \DeclareUnicodeCharacter{1EF8}{\~Y}
9812 \DeclareUnicodeCharacter{1EF9}{\~y}
9814 \DeclareUnicodeCharacter{2013}{--}
9815 \DeclareUnicodeCharacter{2014}{---}
9816 \DeclareUnicodeCharacter{2018}{\quoteleft}
9817 \DeclareUnicodeCharacter{2019}{\quoteright}
9818 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
9819 \DeclareUnicodeCharacter{201C}{\quotedblleft}
9820 \DeclareUnicodeCharacter{201D}{\quotedblright}
9821 \DeclareUnicodeCharacter{201E}{\quotedblbase}
9822 \DeclareUnicodeCharacter{2022}{\bullet}
9823 \DeclareUnicodeCharacter{2026}{\dots}
9824 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9825 \DeclareUnicodeCharacter{203A}{\guilsinglright}
9826 \DeclareUnicodeCharacter{20AC}{\euro}
9828 \DeclareUnicodeCharacter{2192}{\expansion}
9829 \DeclareUnicodeCharacter{21D2}{\result}
9831 \DeclareUnicodeCharacter{2212}{\minus}
9832 \DeclareUnicodeCharacter{2217}{\point}
9833 \DeclareUnicodeCharacter{2261}{\equiv}
9834 }% end of \utfeightchardefs
9836 % US-ASCII character definitions.
9837 \def\asciichardefs{% nothing need be done
9841 % Latin1 (ISO-8859-1) character definitions.
9842 \def\nonasciistringdefs{%
9843 \setnonasciicharscatcode\active
9844 \def\defstringchar##1{\def##1{\string##1}}%
9846 \defstringchar^^80\defstringchar^^81\defstringchar^^82\defstringchar^^83%
9847 \defstringchar^^84\defstringchar^^85\defstringchar^^86\defstringchar^^87%
9848 \defstringchar^^88\defstringchar^^89\defstringchar^^8a\defstringchar^^8b%
9849 \defstringchar^^8c\defstringchar^^8d\defstringchar^^8e\defstringchar^^8f%
9851 \defstringchar^^90\defstringchar^^91\defstringchar^^92\defstringchar^^93%
9852 \defstringchar^^94\defstringchar^^95\defstringchar^^96\defstringchar^^97%
9853 \defstringchar^^98\defstringchar^^99\defstringchar^^9a\defstringchar^^9b%
9854 \defstringchar^^9c\defstringchar^^9d\defstringchar^^9e\defstringchar^^9f%
9856 \defstringchar^^a0\defstringchar^^a1\defstringchar^^a2\defstringchar^^a3%
9857 \defstringchar^^a4\defstringchar^^a5\defstringchar^^a6\defstringchar^^a7%
9858 \defstringchar^^a8\defstringchar^^a9\defstringchar^^aa\defstringchar^^ab%
9859 \defstringchar^^ac\defstringchar^^ad\defstringchar^^ae\defstringchar^^af%
9861 \defstringchar^^b0\defstringchar^^b1\defstringchar^^b2\defstringchar^^b3%
9862 \defstringchar^^b4\defstringchar^^b5\defstringchar^^b6\defstringchar^^b7%
9863 \defstringchar^^b8\defstringchar^^b9\defstringchar^^ba\defstringchar^^bb%
9864 \defstringchar^^bc\defstringchar^^bd\defstringchar^^be\defstringchar^^bf%
9866 \defstringchar^^c0\defstringchar^^c1\defstringchar^^c2\defstringchar^^c3%
9867 \defstringchar^^c4\defstringchar^^c5\defstringchar^^c6\defstringchar^^c7%
9868 \defstringchar^^c8\defstringchar^^c9\defstringchar^^ca\defstringchar^^cb%
9869 \defstringchar^^cc\defstringchar^^cd\defstringchar^^ce\defstringchar^^cf%
9871 \defstringchar^^d0\defstringchar^^d1\defstringchar^^d2\defstringchar^^d3%
9872 \defstringchar^^d4\defstringchar^^d5\defstringchar^^d6\defstringchar^^d7%
9873 \defstringchar^^d8\defstringchar^^d9\defstringchar^^da\defstringchar^^db%
9874 \defstringchar^^dc\defstringchar^^dd\defstringchar^^de\defstringchar^^df%
9876 \defstringchar^^e0\defstringchar^^e1\defstringchar^^e2\defstringchar^^e3%
9877 \defstringchar^^e4\defstringchar^^e5\defstringchar^^e6\defstringchar^^e7%
9878 \defstringchar^^e8\defstringchar^^e9\defstringchar^^ea\defstringchar^^eb%
9879 \defstringchar^^ec\defstringchar^^ed\defstringchar^^ee\defstringchar^^ef%
9881 \defstringchar^^f0\defstringchar^^f1\defstringchar^^f2\defstringchar^^f3%
9882 \defstringchar^^f4\defstringchar^^f5\defstringchar^^f6\defstringchar^^f7%
9883 \defstringchar^^f8\defstringchar^^f9\defstringchar^^fa\defstringchar^^fb%
9884 \defstringchar^^fc\defstringchar^^fd\defstringchar^^fe\defstringchar^^ff%
9888 % define all the unicode characters we know about, for the sake of @U.
9892 % Make non-ASCII characters printable again for compatibility with
9893 % existing Texinfo documents that may use them, even without declaring a
9894 % document encoding.
9896 \setnonasciicharscatcode \other
9899 \message{formatting,}
9901 \newdimen\defaultparindent \defaultparindent = 15pt
9903 \chapheadingskip = 15pt plus 4pt minus 2pt
9904 \secheadingskip = 12pt plus 3pt minus 2pt
9905 \subsecheadingskip = 9pt plus 2pt minus 2pt
9907 % Prevent underfull vbox error messages.
9910 % Don't be very finicky about underfull hboxes, either.
9913 % Following George Bush, get rid of widows and orphans.
9917 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9918 % using an old version of TeX, don't do anything. We want the amount of
9919 % stretch added to depend on the line length, hence the dependence on
9920 % \hsize. We call this whenever the paper size is set.
9922 \def\setemergencystretch{%
9923 \ifx\emergencystretch\thisisundefined
9924 % Allow us to assign to \emergencystretch anyway.
9925 \def\emergencystretch{\dimen0}%
9927 \emergencystretch = .15\hsize
9931 % Parameters in order: 1) textheight; 2) textwidth;
9932 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9933 % 7) physical page height; 8) physical page width.
9935 % We also call \setleading{\textleading}, so the caller should define
9936 % \textleading. The caller should also set \parskip.
9938 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9941 \splittopskip = \topskip
9944 \advance\vsize by \topskip
9945 \outervsize = \vsize
9946 \advance\outervsize by 2\topandbottommargin
9947 \pageheight = \vsize
9950 \outerhsize = \hsize
9951 \advance\outerhsize by 0.5in
9954 \normaloffset = #4\relax
9955 \bindingoffset = #5\relax
9958 \pdfpageheight #7\relax
9959 \pdfpagewidth #8\relax
9960 % if we don't reset these, they will remain at "1 true in" of
9961 % whatever layout pdftex was dumped with.
9962 \pdfhorigin = 1 true in
9963 \pdfvorigin = 1 true in
9966 \setleading{\textleading}
9968 \parindent = \defaultparindent
9969 \setemergencystretch
9972 % @letterpaper (the default).
9973 \def\letterpaper{{\globaldefs = 1
9974 \parskip = 3pt plus 2pt minus 1pt
9975 \textleading = 13.2pt
9977 % If page is nothing but text, make it come out even.
9978 \internalpagesizes{607.2pt}{6in}% that's 46 lines
9980 {\bindingoffset}{36pt}%
9984 % Use @smallbook to reset parameters for 7x9.25 trim size.
9985 \def\smallbook{{\globaldefs = 1
9986 \parskip = 2pt plus 1pt
9989 \internalpagesizes{7.5in}{5in}%
9991 {\bindingoffset}{16pt}%
9994 \lispnarrowing = 0.3in
9997 \contentsrightmargin = 0pt
9998 \defbodyindent = .5cm
10001 % Use @smallerbook to reset parameters for 6x9 trim size.
10002 % (Just testing, parameters still in flux.)
10003 \def\smallerbook{{\globaldefs = 1
10004 \parskip = 1.5pt plus 1pt
10005 \textleading = 12pt
10007 \internalpagesizes{7.4in}{4.8in}%
10012 \lispnarrowing = 0.25in
10015 \contentsrightmargin = 0pt
10016 \defbodyindent = .4cm
10019 % Use @afourpaper to print on European A4 paper.
10020 \def\afourpaper{{\globaldefs = 1
10021 \parskip = 3pt plus 2pt minus 1pt
10022 \textleading = 13.2pt
10024 % Double-side printing via postscript on Laserjet 4050
10025 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
10026 % To change the settings for a different printer or situation, adjust
10027 % \normaloffset until the front-side and back-side texts align. Then
10028 % do the same for \bindingoffset. You can set these for testing in
10029 % your texinfo source file like this:
10031 % \global\normaloffset = -6mm
10032 % \global\bindingoffset = 10mm
10034 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
10035 {\voffset}{\hoffset}%
10036 {\bindingoffset}{44pt}%
10041 \contentsrightmargin = 0pt
10042 \defbodyindent = 5mm
10045 % Use @afivepaper to print on European A5 paper.
10046 % From romildo@urano.iceb.ufop.br, 2 July 2000.
10047 % He also recommends making @example and @lisp be small.
10048 \def\afivepaper{{\globaldefs = 1
10049 \parskip = 2pt plus 1pt minus 0.1pt
10050 \textleading = 12.5pt
10052 \internalpagesizes{160mm}{120mm}%
10053 {\voffset}{\hoffset}%
10054 {\bindingoffset}{8pt}%
10057 \lispnarrowing = 0.2in
10060 \contentsrightmargin = 0pt
10061 \defbodyindent = 2mm
10062 \tableindent = 12mm
10065 % A specific text layout, 24x15cm overall, intended for A4 paper.
10066 \def\afourlatex{{\globaldefs = 1
10068 \internalpagesizes{237mm}{150mm}%
10070 {\bindingoffset}{7mm}%
10073 % Must explicitly reset to 0 because we call \afourpaper.
10077 % Use @afourwide to print on A4 paper in landscape format.
10078 \def\afourwide{{\globaldefs = 1
10080 \internalpagesizes{241mm}{165mm}%
10081 {\voffset}{-2.95mm}%
10082 {\bindingoffset}{7mm}%
10087 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
10088 % Perhaps we should allow setting the margins, \topskip, \parskip,
10089 % and/or leading, also. Or perhaps we should compute them somehow.
10091 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
10092 \def\pagesizesyyy#1,#2,#3\finish{{%
10093 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
10096 \parskip = 3pt plus 2pt minus 1pt
10097 \setleading{\textleading}%
10100 \advance\dimen0 by \voffset
10103 \advance\dimen2 by \normaloffset
10105 \internalpagesizes{#1}{\hsize}%
10106 {\voffset}{\normaloffset}%
10107 {\bindingoffset}{44pt}%
10108 {\dimen0}{\dimen2}%
10111 % Set default to letter.
10116 \message{and turning on texinfo input format.}
10118 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
10120 % DEL is a comment character, in case @c does not suffice.
10123 % Define macros to output various characters with catcode for normal text.
10124 \catcode`\"=\other \def\normaldoublequote{"}
10125 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
10126 \catcode`\+=\other \def\normalplus{+}
10127 \catcode`\<=\other \def\normalless{<}
10128 \catcode`\>=\other \def\normalgreater{>}
10129 \catcode`\^=\other \def\normalcaret{^}
10130 \catcode`\_=\other \def\normalunderscore{_}
10131 \catcode`\|=\other \def\normalverticalbar{|}
10132 \catcode`\~=\other \def\normaltilde{~}
10134 % This macro is used to make a character print one way in \tt
10135 % (where it can probably be output as-is), and another way in other fonts,
10136 % where something hairier probably needs to be done.
10138 % #1 is what to print if we are indeed using \tt; #2 is what to print
10139 % otherwise. Since all the Computer Modern typewriter fonts have zero
10140 % interword stretch (and shrink), and it is reasonable to expect all
10141 % typewriter fonts to have this, we can check that font parameter.
10143 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
10145 % Same as above, but check for italic font. Actually this also catches
10146 % non-italic slanted fonts since it is impossible to distinguish them from
10147 % italic fonts. But since this is only used by $ and it uses \sl anyway
10148 % this is not a problem.
10149 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
10151 % Turn off all special characters except @
10152 % (and those which the user can use as if they were ordinary).
10153 % Most of these we simply print from the \tt font, but for some, we can
10154 % use math or other variants that look better in normal text.
10156 \catcode`\"=\active
10157 \def\activedoublequote{{\tt\char34}}
10158 \let"=\activedoublequote
10159 \catcode`\~=\active \def\activetilde{{\tt\char126}} \let~ = \activetilde
10161 \catcode`\^=\active \def\activehat{{\tt \hat}} \let^ = \activehat
10163 \catcode`\_=\active
10164 \def_{\ifusingtt\normalunderscore\_}
10166 % Subroutine for the previous macro.
10167 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
10169 \catcode`\|=\active
10170 \def|{{\tt\char124}}
10173 \catcode`\<=\active \def\activeless{{\tt \less}}\let< = \activeless
10175 \catcode`\>=\active \def\activegtr{{\tt \gtr}}\let> = \activegtr
10176 \catcode`\+=\active \def+{{\tt \char 43}}
10177 \catcode`\$=\active \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
10179 % used for headline/footline in the output routine, in case the page
10180 % breaks in the middle of an @tex block.
10181 \def\texinfochars{%
10182 \let< = \activeless
10184 \let~ = \activetilde
10186 \markupsetuplqdefault \markupsetuprqdefault
10188 \let\i = \smartitalic
10189 % in principle, all other definitions in \tex have to be undone too.
10192 % If a .fmt file is being used, characters that might appear in a file
10193 % name cannot be active until we have parsed the command line.
10194 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
10195 % \otherifyactive is called near the end of this file.
10196 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
10198 % Used sometimes to turn off (effectively) the active characters even after
10200 \def\turnoffactive{%
10201 \normalturnoffactive
10207 % \backslashcurfont outputs one backslash character in current font,
10209 \global\chardef\backslashcurfont=`\\
10210 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
10212 % \realbackslash is an actual character `\' with catcode other, and
10213 % \doublebackslash is two of them (for the pdf outlines).
10214 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
10216 % In texinfo, backslash is an active character; it prints the backslash
10217 % in fixed width font.
10218 \catcode`\\=\active % @ for escape char from now on.
10220 % The story here is that in math mode, the \char of \backslashcurfont
10221 % ends up printing the roman \ from the math symbol font (because \char
10222 % in math mode uses the \mathcode, and plain.tex sets
10223 % \mathcode`\\="026E). It seems better for @backslashchar{} to always
10224 % print a typewriter backslash, hence we use an explicit \mathchar,
10225 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
10226 % ignored family value; char position "5C). We can't use " for the
10227 % usual hex value because it has already been made active.
10228 @def@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
10229 @let@backslashchar = @normalbackslash % @backslashchar{} is for user documents.
10231 % On startup, @fixbackslash assigns:
10232 % @let \ = @normalbackslash
10233 % \rawbackslash defines an active \ to do \backslashcurfont.
10234 % \otherbackslash defines an active \ to be a literal `\' character with
10235 % catcode other. We switch back and forth between these.
10236 @gdef@rawbackslash{@let\=@backslashcurfont}
10237 @gdef@otherbackslash{@let\=@realbackslash}
10239 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
10240 % the literal character `\'. Also revert - to its normal character, in
10241 % case the active - from code has slipped in.
10243 {@catcode`- = @active
10244 @gdef@normalturnoffactive{%
10245 @nonasciistringdefs
10247 @let"=@normaldoublequote
10248 @let$=@normaldollar %$ font-lock fix
10251 @let>=@normalgreater
10252 @let\=@normalbackslash
10254 @let_=@normalunderscore
10255 @let|=@normalverticalbar
10257 @markupsetuplqdefault
10258 @markupsetuprqdefault
10263 % Make _ and + \other characters, temporarily.
10264 % This is canceled by @fixbackslash.
10267 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
10268 % That is what \eatinput is for; after that, the `\' should revert to printing
10271 @gdef@eatinput input texinfo{@fixbackslash}
10272 @global@let\ = @eatinput
10274 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
10275 % the first `\' in the file would cause an error. This macro tries to fix
10276 % that, assuming it is called before the first `\' could plausibly occur.
10277 % Also turn back on active characters that might appear in the input
10278 % file name, in case not using a pre-dumped format.
10280 @gdef@fixbackslash{%
10281 @ifx\@eatinput @let\ = @normalbackslash @fi
10283 @catcode`@_=@active
10286 % Say @foo, not \foo, in error messages.
10289 % These (along with & and #) are made active for url-breaking, so need
10290 % active definitions as the normal characters.
10292 @def@normalquest{?}
10293 @def@normalslash{/}
10295 % These look ok in all fonts, so just make them not special.
10296 % @hashchar{} gets its own user-level command, because of #line.
10297 @catcode`@& = @other @def@normalamp{&}
10298 @catcode`@# = @other @def@normalhash{#}
10299 @catcode`@% = @other @def@normalpercent{%}
10301 @let @hashchar = @normalhash
10303 @c Finally, make ` and ' active, so that txicodequoteundirected and
10304 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
10305 @c don't make ` and ' active, @code will not get them as active chars.
10306 @c Do this last of all since we use ` in the previous @catcode assignments.
10307 @catcode`@'=@active
10308 @catcode`@`=@active
10309 @markupsetuplqdefault
10310 @markupsetuprqdefault
10312 @c Local variables:
10313 @c eval: (add-hook 'write-file-hooks 'time-stamp)
10314 @c page-delimiter: "^\\\\message\\|emacs-page"
10315 @c time-stamp-start: "def\\\\texinfoversion{"
10316 @c time-stamp-format: "%:y-%02m-%02d.%02H"
10317 @c time-stamp-end: "}"
10323 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115