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{2008-11-25.16}
8 % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007, 2008 Free Software Foundation, Inc.
12 % This texinfo.tex file is free software: you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation, either version 3 of the
15 % License, or (at your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this program. If not, see <http://www.gnu.org/licenses/>.
25 % As a special exception, when this file is read by TeX when processing
26 % a Texinfo source document, you may use the result without
27 % restriction. (This has been our intent since Texinfo was invented.)
29 % Please try the latest version of texinfo.tex before submitting bug
30 % reports; you can get the latest version from:
31 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
32 % ftp://tug.org/tex/texinfo.tex
33 % (and all CTAN mirrors, see http://www.ctan.org).
34 % The texinfo.tex in any given distribution could well be out
35 % of date, so if that's what you're using, please check.
37 % Send bug reports to bug-texinfo@gnu.org. Please include including a
38 % complete document in each bug report with which we can reproduce the
39 % problem. Patches are, of course, greatly appreciated.
41 % To process a Texinfo manual with TeX, it's most reliable to use the
42 % texi2dvi shell script that comes with the distribution. For a simple
43 % manual foo.texi, however, you can get away with this:
48 % dvips foo.dvi -o # or whatever; this makes foo.ps.
49 % The extra TeX runs get the cross-reference information correct.
50 % Sometimes one run after texindex suffices, and sometimes you need more
51 % than two; texi2dvi does it as many times as necessary.
53 % It is possible to adapt texinfo.tex for other languages, to some
54 % extent. You can get the existing language-specific files from the
55 % full Texinfo distribution.
57 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60 \message{Loading texinfo [version \texinfoversion]:}
62 % If in a .fmt file, print the version number
63 % and turn on active characters that we couldn't do earlier because
64 % they might have appeared in the input file name.
65 \everyjob{\message{[Texinfo version \texinfoversion]}%
66 \catcode`+=\active \catcode`\_=\active}
71 % We never want plain's \outer definition of \+ in Texinfo.
72 % For @tex, we can use \tabalign.
75 % Save some plain tex macros whose names we will redefine.
77 \let\ptexbullet=\bullet
85 \let\ptexfootnote=\footnote
89 \let\ptexindent=\indent
90 \let\ptexinsert=\insert
93 \let\ptexnewwrite\newwrite
94 \let\ptexnoindent=\noindent
102 \global\let\ptexquoteright'}% Math-mode def from plain.tex.
104 % If this character appears in an error message or help string, it
105 % starts a new line in the output.
108 % Use TeX 3.0's \inputlineno to get the line number, for better error
109 % messages, but if we're using an old version of TeX, don't do anything.
111 \ifx\inputlineno\thisisundefined
112 \let\linenumber = \empty % Pre-3.0.
114 \def\linenumber{l.\the\inputlineno:\space}
117 % Set up fixed words for English if not already set.
118 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
119 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
120 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
121 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
122 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
123 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
124 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
125 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
126 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
127 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
128 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
129 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
130 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
131 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
132 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
133 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
134 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
135 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
136 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
138 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
139 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
140 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
141 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
142 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
143 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
144 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
145 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
146 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
147 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
148 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
149 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
151 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
152 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
153 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
154 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
155 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
157 % Since the category of space is not known, we have to be careful.
158 \chardef\spacecat = 10
159 \def\spaceisspace{\catcode`\ =\spacecat}
161 % sometimes characters are active, so we need control sequences.
162 \chardef\colonChar = `\:
163 \chardef\commaChar = `\,
164 \chardef\dashChar = `\-
165 \chardef\dotChar = `\.
166 \chardef\exclamChar= `\!
167 \chardef\lquoteChar= `\`
168 \chardef\questChar = `\?
169 \chardef\rquoteChar= `\'
170 \chardef\semiChar = `\;
171 \chardef\underChar = `\_
177 % The following is used inside several \edef's.
178 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
182 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
183 ap-pen-dix bit-map bit-maps
184 data-base data-bases eshell fall-ing half-way long-est man-u-script
185 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
186 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
188 stand-alone strong-est time-stamp time-stamps which-ever white-space
189 wide-spread wrap-around
192 % Margin to add to right of even pages, to left of odd pages.
193 \newdimen\bindingoffset
194 \newdimen\normaloffset
195 \newdimen\pagewidth \newdimen\pageheight
197 % For a final copy, take out the rectangles
198 % that mark overfull boxes (in case you have decided
199 % that the text looks ok even though it passes the margin).
201 \def\finalout{\overfullrule=0pt}
203 % @| inserts a changebar to the left of the current line. It should
204 % surround any changed text. This approach does *not* work if the
205 % change spans more than two lines of output. To handle that, we would
206 % have adopt a much more difficult approach (putting marks into the main
207 % vertical list for the beginning and end of each change).
210 % \vadjust can only be used in horizontal mode.
213 % Append this vertical mode material after the current line in the output.
215 % We want to insert a rule with the height and depth of the current
216 % leading; that is exactly what \strutbox is supposed to record.
219 % \vadjust-items are inserted at the left edge of the type. So
220 % the \llap here moves out into the left-hand margin.
223 % For a thicker or thinner bar, change the `1pt'.
224 \vrule height\baselineskip width1pt
226 % This is the space between the bar and the text.
232 % Sometimes it is convenient to have everything in the transcript file
233 % and nothing on the terminal. We don't just call \tracingall here,
234 % since that produces some useless output on the terminal. We also make
235 % some effort to order the tracing commands to reduce output in the log
236 % file; cf. trace.sty in LaTeX.
238 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
242 \tracinglostchars2 % 2 gives us more in etex
247 \showboxbreadth\maxdimen \showboxdepth\maxdimen
248 \ifx\eTeXversion\undefined\else % etex gives us more logging
255 \tracingcommands3 % 3 gives us more in etex
259 % add check for \lastpenalty to plain's definitions. If the last thing
260 % we did was a \nobreak, we don't want to insert more space.
262 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
263 \removelastskip\penalty-50\smallskip\fi\fi}
264 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
265 \removelastskip\penalty-100\medskip\fi\fi}
266 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
267 \removelastskip\penalty-200\bigskip\fi\fi}
269 % For @cropmarks command.
270 % Do @cropmarks to get crop marks.
273 \let\cropmarks = \cropmarkstrue
275 % Dimensions to add cropmarks at corners.
276 % Added by P. A. MacKay, 12 Nov. 1986
278 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
279 \newdimen\cornerlong \cornerlong=1pc
280 \newdimen\cornerthick \cornerthick=.3pt
281 \newdimen\topandbottommargin \topandbottommargin=.75in
283 % Output a mark which sets \thischapter, \thissection and \thiscolor.
284 % We dump everything together because we only have one kind of mark.
285 % This works because we only use \botmark / \topmark, not \firstmark.
287 % A mark contains a subexpression of the \ifcase ... \fi construct.
288 % \get*marks macros below extract the needed part using \ifcase.
290 % Another complication is to let the user choose whether \thischapter
291 % (\thissection) refers to the chapter (section) in effect at the top
292 % of a page, or that at the bottom of a page. The solution is
293 % described on page 260 of The TeXbook. It involves outputting two
294 % marks for the sectioning macros, one before the section break, and
295 % one after. I won't pretend I can describe this better than DEK...
297 \toks0=\expandafter{\lastchapterdefs}%
298 \toks2=\expandafter{\lastsectiondefs}%
299 \toks4=\expandafter{\prevchapterdefs}%
300 \toks6=\expandafter{\prevsectiondefs}%
301 \toks8=\expandafter{\lastcolordefs}%
303 \the\toks0 \the\toks2
304 \noexpand\or \the\toks4 \the\toks6
305 \noexpand\else \the\toks8
308 % \topmark doesn't work for the very first chapter (after the title
309 % page or the contents), so we use \firstmark there -- this gets us
310 % the mark with the chapter defs, unless the user sneaks in, e.g.,
311 % @setcolor (or @url, or @link, etc.) between @contents and the very
313 \def\gettopheadingmarks{%
315 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
317 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
318 \def\getcolormarks{\ifcase2\topmark\fi}
320 % Avoid "undefined control sequence" errors.
321 \def\lastchapterdefs{}
322 \def\lastsectiondefs{}
323 \def\prevchapterdefs{}
324 \def\prevsectiondefs{}
327 % Main output routine.
329 \output = {\onepageout{\pagecontents\PAGE}}
334 % \onepageout takes a vbox as an argument. Note that \pagecontents
335 % does insertions, but you have to call it yourself.
337 \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi
339 \ifodd\pageno \advance\hoffset by \bindingoffset
340 \else \advance\hoffset by -\bindingoffset\fi
342 % Do this outside of the \shipout so @code etc. will be expanded in
343 % the headline as they should be, not taken literally (outputting ''code).
344 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
345 \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}%
346 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
347 \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}%
350 % Have to do this stuff outside the \shipout because we want it to
351 % take effect in \write's, yet the group defined by the \vbox ends
352 % before the \shipout runs.
354 \indexdummies % don't expand commands in the output.
355 \normalturnoffactive % \ in index entries must not stay \, e.g., if
356 % the page break happens to be in the middle of an example.
357 % We don't want .vr (or whatever) entries like this:
358 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
359 % "\acronym" won't work when it's read back in;
361 % {\code {{\tt \backslashcurfont }acronym}
363 % Do this early so pdf references go to the beginning of the page.
364 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
366 \ifcropmarks \vbox to \outervsize\bgroup
368 \vskip-\topandbottommargin
370 \line{\ewtop\hfil\ewtop}%
373 \vbox{\moveleft\cornerthick\nstop}%
375 \vbox{\moveright\cornerthick\nstop}%
378 \vskip\topandbottommargin
380 \hfil % center the page within the outer (page) hsize.
381 \ifodd\pageno\hskip\bindingoffset\fi
387 \ifdim\ht\footlinebox > 0pt
388 % Only leave this space if the footline is nonempty.
389 % (We lessened \vsize for it in \oddfootingyyy.)
390 % The \baselineskip=24pt in plain's \makefootline has no effect.
396 \egroup % end of \vbox\bgroup
397 \hfil\egroup % end of (centering) \line\bgroup
398 \vskip\topandbottommargin plus1fill minus1fill
399 \boxmaxdepth = \cornerthick
402 \vbox{\moveleft\cornerthick\nsbot}%
404 \vbox{\moveright\cornerthick\nsbot}%
407 \line{\ewbot\hfil\ewbot}%
409 \egroup % \vbox from first cropmarks clause
411 }% end of \shipout\vbox
412 }% end of group with \indexdummies
414 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
417 \newinsert\margin \dimen\margin=\maxdimen
419 \def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}}
421 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
422 % marginal hacks, juha@viisa.uucp (Juha Takala)
423 \ifvoid\margin\else % marginal info is present
424 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
425 \dimen@=\dp#1\relax \unvbox#1\relax
426 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
427 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
430 % Here are the rules for the cropmarks. Note that they are
431 % offset so that the space between them is truly \outerhsize or \outervsize
432 % (P. A. MacKay, 12 November, 1986)
434 \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong}
436 {\hrule height\cornerthick depth\cornerlong width\cornerthick}}
437 \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong}
439 {\hrule height\cornerlong depth\cornerthick width\cornerthick}}
441 % Parse an argument, then pass it to #1. The argument is the rest of
442 % the input line (except we remove a trailing comment). #1 should be a
443 % macro which expects an ordinary undelimited TeX argument.
445 \def\parsearg{\parseargusing{}}
446 \def\parseargusing#1#2{%
452 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
456 \gdef\parseargline#1^^M{%
457 \endgroup % End of the group started in \parsearg.
458 \argremovecomment #1\comment\ArgTerm%
462 % First remove any @comment, then any @c comment.
463 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
464 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
466 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
468 % \argremovec might leave us with trailing space, e.g.,
469 % @end itemize @c foo
470 % This space token undergoes the same procedure and is eventually removed
471 % by \finishparsearg.
473 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
474 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
475 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
478 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
479 \let\temp\finishparsearg
481 \let\temp\argcheckspaces
483 % Put the space token in:
487 % If a _delimited_ argument is enclosed in braces, they get stripped; so
488 % to get _exactly_ the rest of the line, we had to prevent such situation.
489 % We prepended an \empty token at the very beginning and we expand it now,
490 % just before passing the control to \argtorun.
491 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
492 % either the null string, or it ends with \^^M---thus there is no danger
493 % that a pair of braces would be stripped.
495 % But first, we have to remove the trailing space token.
497 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
499 % \parseargdef\foo{...}
500 % is roughly equivalent to
501 % \def\foo{\parsearg\Xfoo}
504 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
505 % favourite TeX trick. --kasal, 16nov03
508 \expandafter \doparseargdef \csname\string#1\endcsname #1%
510 \def\doparseargdef#1#2{%
515 % Several utility definitions with active space:
520 % Make each space character in the input produce a normal interword
521 % space in the output. Don't allow a line break at this space, as this
522 % is used only in environments like @example, where each line of input
523 % should produce a line of output anyway.
525 \gdef\sepspaces{\obeyspaces\let =\tie}
527 % If an index command is used in an @example environment, any spaces
528 % therein should become regular spaces in the raw index file, not the
529 % expansion of \tie (\leavevmode \penalty \@M \ ).
530 \gdef\unsepspaces{\let =\space}
534 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
536 % Define the framework for environments in texinfo.tex. It's used like this:
541 % It's the responsibility of \envdef to insert \begingroup before the
542 % actual body; @end closes the group after calling \Efoo. \envdef also
543 % defines \thisenv, so the current environment is known; @end checks
544 % whether the environment name matches. The \checkenv macro can also be
545 % used to check whether the current environment is the one expected.
547 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
548 % are not treated as environments; they don't open a group. (The
549 % implementation of @end takes care not to call \endgroup in this
553 % At run-time, environments start with this:
554 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
558 % ... but they get defined via ``\envdef\foo{...}'':
559 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
560 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
562 % Check whether we're in the right environment:
571 % Environment mismatch, #1 expected:
574 \errmessage{This command can appear only \inenvironment\temp,
575 not \inenvironment\thisenv}%
577 \def\inenvironment#1{%
579 out of any environment%
581 in environment \expandafter\string#1%
585 % @end foo executes the definition of \Efoo.
586 % But first, it executes a specialized version of \checkenv
589 \if 1\csname iscond.#1\endcsname
591 % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03
592 \expandafter\checkenv\csname#1\endcsname
593 \csname E#1\endcsname
598 \newhelp\EMsimple{Press RETURN to continue.}
601 %% Simple single-character @ commands
604 % Kludge this until the fonts are right (grr).
607 % This is turned off because it was never documented
608 % and you can use @w{...} around a quote to suppress ligatures.
609 %% Define @` and @' to be the same as ` and '
610 %% but suppressing ligatures.
614 % Used to generate quoted braces.
615 \def\mylbrace {{\tt\char123}}
616 \def\myrbrace {{\tt\char125}}
620 % Definitions to produce \{ and \} commands for indices,
621 % and @{ and @} for the aux/toc files.
622 \catcode`\{ = \other \catcode`\} = \other
623 \catcode`\[ = 1 \catcode`\] = 2
624 \catcode`\! = 0 \catcode`\\ = \other
627 !gdef!lbraceatcmd[@{]%
628 !gdef!rbraceatcmd[@}]%
631 % @comma{} to avoid , parsing problems.
634 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
635 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
638 \def\ringaccent#1{{\accent23 #1}}
643 % Other special characters: @questiondown @exclamdown @ordf @ordm
644 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
645 \def\questiondown{?`}
647 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}}
648 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}}
650 % Dotless i and dotless j, used for accents.
655 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
656 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
657 \else \errmessage{@dotless can be used only with i or j}%
661 % The \TeX{} logo, as in plain, but resetting the spacing so that a
662 % period following counts as ending a sentence. (Idea found in latex.)
664 \edef\TeX{\TeX \spacefactor=1000 }
666 % @LaTeX{} logo. Not quite the same results as the definition in
667 % latex.ltx, since we use a different font for the raised A; it's most
668 % convenient for us to use an explicitly smaller font, rather than using
669 % the \scriptstyle font (since we don't reset \scriptstyle and
670 % \scriptscriptstyle).
675 \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}%
680 % Be sure we're in horizontal mode when doing a tie, since we make space
681 % equivalent to this in @example-like environments. Otherwise, a space
682 % at the beginning of a line will start with \penalty -- and
683 % since \penalty is valid in vertical mode, we'd end up putting the
684 % penalty on the vertical list instead of in the new paragraph.
686 % Avoid using \@M directly, because that causes trouble
687 % if the definition is written into an index file.
688 \global\let\tiepenalty = \@M
689 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
692 % @: forces normal size whitespace following.
693 \def\:{\spacefactor=1000 }
695 % @* forces a line break.
696 \def\*{\hfil\break\hbox{}\ignorespaces}
698 % @/ allows a line break.
701 % @. is an end-of-sentence period.
702 \def\.{.\spacefactor=\endofsentencespacefactor\space}
704 % @! is an end-of-sentence bang.
705 \def\!{!\spacefactor=\endofsentencespacefactor\space}
707 % @? is an end-of-sentence query.
708 \def\?{?\spacefactor=\endofsentencespacefactor\space}
710 % @frenchspacing on|off says whether to put extra space after punctuation.
715 \parseargdef\frenchspacing{%
717 \ifx\temp\onword \plainfrenchspacing
718 \else\ifx\temp\offword \plainnonfrenchspacing
721 \errmessage{Unknown @frenchspacing option `\temp', must be on/off}%
725 % @w prevents a word break. Without the \leavevmode, @w at the
726 % beginning of a paragraph, when TeX is still in vertical mode, would
727 % produce a whole line of output instead of starting the paragraph.
728 \def\w#1{\leavevmode\hbox{#1}}
730 % @group ... @end group forces ... to be all on one page, by enclosing
731 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
732 % to keep its height that of a normal line. According to the rules for
733 % \topskip (p.114 of the TeXbook), the glue inserted is
734 % max (\topskip - \ht (first item), 0). If that height is large,
735 % therefore, no glue is inserted, and the space between the headline and
736 % the text is small, which looks bad.
738 % Another complication is that the group might be very large. This can
739 % cause the glue on the previous page to be unduly stretched, because it
740 % does not have much material. In this case, it's better to add an
741 % explicit \vfill so that the extra space is at the bottom. The
742 % threshold for doing this is if the group is more than \vfilllimit
743 % percent of a page (\vfilllimit can be changed inside of @tex).
749 \ifnum\catcode`\^^M=\active \else
750 \errhelp = \groupinvalidhelp
751 \errmessage{@group invalid in context where filling is enabled}%
755 \setbox\groupbox = \vtop\bgroup
756 % Do @comment since we are called inside an environment such as
757 % @example, where each end-of-line in the input causes an
758 % end-of-line in the output. We don't want the end-of-line after
759 % the `@group' to put extra space in the output. Since @group
760 % should appear on a line by itself (according to the Texinfo
761 % manual), we don't worry about eating any user text.
765 % The \vtop produces a box with normal height and large depth; thus, TeX puts
766 % \baselineskip glue before it, and (when the next line of text is done)
767 % \lineskip glue after it. Thus, space below is not quite equal to space
768 % above. But it's pretty close.
770 % To get correct interline space between the last line of the group
771 % and the first line afterwards, we have to propagate \prevdepth.
772 \endgraf % Not \par, as it may have been set to \lisppar.
773 \global\dimen1 = \prevdepth
774 \egroup % End the \vtop.
775 % \dimen0 is the vertical size of the group's box.
776 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
777 % \dimen2 is how much space is left on the page (more or less).
778 \dimen2 = \pageheight \advance\dimen2 by -\pagetotal
779 % if the group doesn't fit on the current page, and it's a big big
780 % group, force a page break.
781 \ifdim \dimen0 > \dimen2
782 \ifdim \pagetotal < \vfilllimit\pageheight
791 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
792 % message, so this ends up printing `@group can only ...'.
794 \newhelp\groupinvalidhelp{%
795 group can only be used in environments such as @example,^^J%
796 where each line of input produces a line of output.}
798 % @need space-in-mils
799 % forces a page break if there is not space-in-mils remaining.
801 \newdimen\mil \mil=0.001in
803 % Old definition--didn't work.
804 %\parseargdef\need{\par %
805 %% This method tries to make TeX break the page naturally
806 %% if the depth of the box does not fit.
808 %\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak
813 % Ensure vertical mode, so we don't make a big box in the middle of a
817 % If the @need value is less than one line space, it's useless.
819 \dimen2 = \ht\strutbox
820 \advance\dimen2 by \dp\strutbox
821 \ifdim\dimen0 > \dimen2
823 % Do a \strut just to make the height of this box be normal, so the
824 % normal leading is inserted relative to the preceding line.
825 % And a page break here is fine.
826 \vtop to #1\mil{\strut\vfil}%
828 % TeX does not even consider page breaks if a penalty added to the
829 % main vertical list is 10000 or more. But in order to see if the
830 % empty box we just added fits on the page, we must make it consider
831 % page breaks. On the other hand, we don't want to actually break the
832 % page after the empty box. So we use a penalty of 9999.
834 % There is an extremely small chance that TeX will actually break the
835 % page at this \penalty, if there are no other feasible breakpoints in
836 % sight. (If the user is using lots of big @group commands, which
837 % almost-but-not-quite fill up a page, TeX will have a hard time doing
838 % good page breaking, for example.) However, I could not construct an
839 % example where a page broke at this \penalty; if it happens in a real
840 % document, then we can reconsider our strategy.
843 % Back up by the size of the box, whether we did a page break or not.
846 % Do not allow a page break right after this kern.
851 % @br forces paragraph break (and is undocumented).
855 % @page forces the start of a new page.
857 \def\page{\par\vfill\supereject}
860 % outputs text on separate line in roman font, starting at standard page margin
862 % This records the amount of indent in the innermost environment.
863 % That's how much \exdent should take out.
864 \newskip\exdentamount
866 % This defn is used inside fill environments such as @defun.
867 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
869 % This defn is used inside nofill environments such as @example.
870 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
871 \leftline{\hskip\leftskip{\rm#1}}}}
873 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
874 % paragraph. For more general purposes, use the \margin insertion
875 % class. WHICH is `l' or `r'.
877 \newskip\inmarginspacing \inmarginspacing=1cm
878 \def\strutdepth{\dp\strutbox}
880 \def\doinmargin#1#2{\strut\vadjust{%
883 \vtop to \strutdepth{%
884 \baselineskip=\strutdepth
886 % if you have multiple lines of stuff to put here, you'll need to
887 % make the vbox yourself of the appropriate size.
889 \llap{\ignorespaces #2\hskip\inmarginspacing}%
891 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
896 \def\inleftmargin{\doinmargin l}
897 \def\inrightmargin{\doinmargin r}
899 % @inmargin{TEXT [, RIGHT-TEXT]}
900 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
901 % else use TEXT for both).
903 \def\inmargin#1{\parseinmargin #1,,\finish}
904 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
905 \setbox0 = \hbox{\ignorespaces #2}%
907 \def\lefttext{#1}% have both texts
910 \def\lefttext{#1}% have only one text
915 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
917 \def\temp{\inleftmargin\lefttext}%
922 % @include FILE -- \input text of FILE.
924 \def\include{\parseargusing\filenamecatcodes\includezzz}
929 \makevalueexpandable % we want to expand any @value in FILE.
930 \turnoffactive % and allow special characters in the expansion
931 \indexnofonts % Allow `@@' and other weird things in file names.
932 \edef\temp{\noexpand\input #1 }%
934 % This trickery is to read FILE outside of a group, in case it makes
940 \def\filenamecatcodes{%
954 \def\pushthisfilestack{%
955 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
957 \def\pushthisfilestackX{%
958 \expandafter\pushthisfilestackY\thisfile\StackTerm
960 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
961 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
964 \def\popthisfilestack{\errthisfilestackempty}
965 \def\errthisfilestackempty{\errmessage{Internal error:
966 the stack of filenames is empty.}}
971 % outputs that line, centered.
973 \parseargdef\center{%
979 \next{\hfil \ignorespaces#1\unskip \hfil}%
984 \advance\hsize by -\leftskip
985 \advance\hsize by -\rightskip
990 \def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}}
992 % @sp n outputs n lines of vertical space
994 \parseargdef\sp{\vskip #1\baselineskip}
996 % @comment ...line which is ignored...
997 % @c is the same as @comment
998 % @ignore ... @end ignore is another way to write a comment
1000 \def\comment{\begingroup \catcode`\^^M=\other%
1001 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
1003 {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}}
1007 % @paragraphindent NCHARS
1008 % We'll use ems for NCHARS, close enough.
1009 % NCHARS can also be the word `asis' or `none'.
1010 % We cannot feasibly implement @paragraphindent asis, though.
1012 \def\asisword{asis} % no translation, these are keywords
1015 \parseargdef\paragraphindent{%
1020 \defaultparindent = 0pt
1022 \defaultparindent = #1em
1025 \parindent = \defaultparindent
1028 % @exampleindent NCHARS
1029 % We'll use ems for NCHARS like @paragraphindent.
1030 % It seems @exampleindent asis isn't necessary, but
1031 % I preserve it to make it similar to @paragraphindent.
1032 \parseargdef\exampleindent{%
1037 \lispnarrowing = 0pt
1039 \lispnarrowing = #1em
1044 % @firstparagraphindent WORD
1045 % If WORD is `none', then suppress indentation of the first paragraph
1046 % after a section heading. If WORD is `insert', then do indent at such
1049 % The paragraph indentation is suppressed or not by calling
1050 % \suppressfirstparagraphindent, which the sectioning commands do.
1051 % We switch the definition of this back and forth according to WORD.
1052 % By default, we suppress indentation.
1054 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
1055 \def\insertword{insert}
1057 \parseargdef\firstparagraphindent{%
1060 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
1061 \else\ifx\temp\insertword
1062 \let\suppressfirstparagraphindent = \relax
1064 \errhelp = \EMsimple
1065 \errmessage{Unknown @firstparagraphindent option `\temp'}%
1069 % Here is how we actually suppress indentation. Redefine \everypar to
1070 % \kern backwards by \parindent, and then reset itself to empty.
1072 % We also make \indent itself not actually do anything until the next
1075 \gdef\dosuppressfirstparagraphindent{%
1077 \restorefirstparagraphindent
1081 \restorefirstparagraphindent
1084 \global\everypar = {%
1086 \restorefirstparagraphindent
1090 \gdef\restorefirstparagraphindent{%
1091 \global \let \indent = \ptexindent
1092 \global \let \noindent = \ptexnoindent
1093 \global \everypar = {}%
1097 % @asis just yields its argument. Used with @table, for example.
1101 % @math outputs its argument in math mode.
1103 % One complication: _ usually means subscripts, but it could also mean
1104 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
1105 % _ active, and distinguish by seeing if the current family is \slfam,
1106 % which is what @var uses.
1108 \catcode`\_ = \active
1109 \gdef\mathunderscore{%
1111 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
1114 % Another complication: we want \\ (and @\) to output a \ character.
1115 % FYI, plain.tex uses \\ as a temporary control sequence (why?), but
1116 % this is not advertised and we don't care. Texinfo does not
1117 % otherwise define @\.
1119 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
1120 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
1125 \let\\ = \mathbackslash
1127 % make the texinfo accent commands work in math mode
1139 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
1141 % Some active characters (such as <) are spaced differently in math.
1142 % We have to reset their definitions in case the @math was an argument
1143 % to a command which sets the catcodes (such as @item or @section).
1146 \catcode`^ = \active
1147 \catcode`< = \active
1148 \catcode`> = \active
1149 \catcode`+ = \active
1150 \catcode`' = \active
1156 \let' = \ptexquoteright
1160 % Some math mode symbols.
1161 \def\bullet{$\ptexbullet$}
1162 \def\geq{\ifmmode \ge\else $\ge$\fi}
1163 \def\leq{\ifmmode \le\else $\le$\fi}
1164 \def\minus{\ifmmode -\else $-$\fi}
1166 % @dots{} outputs an ellipsis using the current font.
1167 % We do .5em per period so that it has the same spacing in the cm
1168 % typewriter fonts as three actual period characters; on the other hand,
1169 % in other typewriter fonts three periods are wider than 1.5em. So do
1170 % whichever is larger.
1174 \setbox0=\hbox{...}% get width of three periods
1181 \hskip 0pt plus.25fil
1182 .\hskip 0pt plus1fil
1183 .\hskip 0pt plus1fil
1184 .\hskip 0pt plus.5fil
1188 % @enddots{} is an end-of-sentence ellipsis.
1192 \spacefactor=\endofsentencespacefactor
1195 % @comma{} is so commas can be inserted into text without messing up
1196 % Texinfo's parsing.
1200 % @refill is a no-op.
1203 % If working on a large document in chapters, it is convenient to
1204 % be able to disable indexing, cross-referencing, and contents, for test runs.
1205 % This is done with @novalidate (before @setfilename).
1207 \newif\iflinks \linkstrue % by default we want the aux files.
1208 \let\novalidate = \linksfalse
1210 % @setfilename is done at the beginning of every texinfo file.
1211 % So open here the files we need to have open while reading the input.
1212 % This makes it possible to make a .fmt file for texinfo.
1214 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1217 % Open the new aux file. TeX will close it automatically at exit.
1218 \immediate\openout\auxfile=\jobname.aux
1219 \fi % \openindices needs to do some work in any case.
1221 \let\setfilename=\comment % Ignore extra @setfilename cmds.
1223 % If texinfo.cnf is present on the system, read it.
1224 % Useful for site-wide @afourpaper, etc.
1225 \openin 1 texinfo.cnf
1226 \ifeof 1 \else \input texinfo.cnf \fi
1229 \comment % Ignore the actual filename.
1232 % Called from \setfilename.
1244 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1248 % adobe `portable' document format
1252 \newcount\filenamelength
1261 \newif\ifpdfmakepagedest
1263 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1264 % can be set). So we test for \relax and 0 as well as \undefined,
1265 % borrowed from ifpdf.sty.
1266 \ifx\pdfoutput\undefined
1268 \ifx\pdfoutput\relax
1277 % PDF uses PostScript string constants for the names of xref targets,
1278 % for display in the outlines, and in other places. Thus, we have to
1279 % double any backslashes. Otherwise, a name like "\node" will be
1280 % interpreted as a newline (\n), followed by o, d, e. Not good.
1281 % http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html
1282 % (and related messages, the final outcome is that it is up to the TeX
1283 % user to double the backslashes and otherwise make the string valid, so
1284 % that's what we do).
1286 % double active backslashes.
1288 {\catcode`\@=0 \catcode`\\=\active
1289 @gdef@activebackslashdouble{%
1291 @let\=@doublebackslash}
1294 % To handle parens, we must adopt a different approach, since parens are
1295 % not active characters. hyperref.dtx (which has the same problem as
1296 % us) handles it with this amazing macro to replace tokens, with minor
1297 % changes for Texinfo. It is included here under the GPL by permission
1298 % from the author, Heiko Oberdiek.
1300 % #1 is the tokens to replace.
1301 % #2 is the replacement.
1302 % #3 is the control sequence with the string.
1304 \def\HyPsdSubst#1#2#3{%
1305 \def\HyPsdReplace##1#1##2\END{%
1311 \HyPsdReplace##2\END
1315 \xdef#3{\expandafter\HyPsdReplace#3#1\END}%
1317 \long\def\HyReturnAfterFi#1\fi{\fi#1}
1319 % #1 is a control sequence in which to do the replacements.
1320 \def\backslashparens#1{%
1321 \xdef#1{#1}% redefine it as its expansion; the definition is simply
1322 % \lastnode when called from \setref -> \pdfmkdest.
1323 \HyPsdSubst{(}{\realbackslash(}{#1}%
1324 \HyPsdSubst{)}{\realbackslash)}{#1}%
1327 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1328 with PDF output, and none of those formats could be found. (.eps cannot
1329 be supported due to the design of the PDF format; use regular TeX (DVI
1334 % Color manipulation macros based on pdfcolor.tex.
1335 \def\cmykDarkRed{0.28 1 1 0.35}
1336 \def\cmykBlack{0 0 0 1}
1338 \def\pdfsetcolor#1{\pdfliteral{#1 k}}
1339 % Set color, and create a mark which defines \thiscolor accordingly,
1340 % so that \makeheadline knows which color to restore.
1342 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1347 \def\maincolor{\cmykBlack}
1348 \pdfsetcolor{\maincolor}
1349 \edef\thiscolor{\maincolor}
1350 \def\lastcolordefs{}
1354 \line{\pdfsetcolor{\maincolor}\the\footline}%
1362 % Extract \thiscolor definition from the marks.
1364 % Typeset the headline with \maincolor, then restore the color.
1365 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1373 \pdfcatalog{/PageMode /UseOutlines}
1375 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1376 \def\dopdfimage#1#2#3{%
1377 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1378 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1380 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1381 % others). Let's try in that order.
1382 \let\pdfimgext=\empty
1384 \openin 1 #1.png \ifeof 1
1385 \openin 1 #1.jpg \ifeof 1
1386 \openin 1 #1.jpeg \ifeof 1
1387 \openin 1 #1.JPG \ifeof 1
1388 \openin 1 #1.pdf \ifeof 1
1389 \openin 1 #1.PDF \ifeof 1
1390 \errhelp = \nopdfimagehelp
1391 \errmessage{Could not find image file #1 for pdf}%
1392 \else \gdef\pdfimgext{PDF}%
1394 \else \gdef\pdfimgext{pdf}%
1396 \else \gdef\pdfimgext{JPG}%
1398 \else \gdef\pdfimgext{jpeg}%
1400 \else \gdef\pdfimgext{jpg}%
1402 \else \gdef\pdfimgext{png}%
1407 % without \immediate, ancient pdftex seg faults when the same image is
1408 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1409 \ifnum\pdftexversion < 14
1412 \immediate\pdfximage
1414 \ifdim \wd0 >0pt width \imagewidth \fi
1415 \ifdim \wd2 >0pt height \imageheight \fi
1416 \ifnum\pdftexversion<13
1421 \ifnum\pdftexversion < 14 \else
1422 \pdfrefximage \pdflastximage
1426 % We have to set dummies so commands such as @code, and characters
1427 % such as \, aren't expanded when present in a section title.
1430 \activebackslashdouble
1431 \makevalueexpandable
1432 \def\pdfdestname{#1}%
1433 \backslashparens\pdfdestname
1434 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1437 % used to mark target names; must be expandable.
1440 % by default, use a color that is dark enough to print on paper as
1441 % nearly black, but still distinguishable for online viewing.
1442 \def\urlcolor{\cmykDarkRed}
1443 \def\linkcolor{\cmykDarkRed}
1444 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1446 % Adding outlines to PDF; macros for calculating structure of outlines
1447 % come from Petr Olsak
1448 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1449 \else \csname#1\endcsname \fi}
1450 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1451 \advance\tempnum by 1
1452 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1454 % #1 is the section text, which is what will be displayed in the
1455 % outline by the pdf viewer. #2 is the pdf expression for the number
1456 % of subentries (or empty, for subsubsections). #3 is the node text,
1457 % which might be empty if this toc entry had no corresponding node.
1458 % #4 is the page number
1460 \def\dopdfoutline#1#2#3#4{%
1461 % Generate a link to the node text if that exists; else, use the
1462 % page number. We could generate a destination for the section
1463 % text in the case where a section has no node, but it doesn't
1464 % seem worth the trouble, since most documents are normally structured.
1465 \def\pdfoutlinedest{#3}%
1466 \ifx\pdfoutlinedest\empty
1467 \def\pdfoutlinedest{#4}%
1469 % Doubled backslashes in the name.
1470 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1471 \backslashparens\pdfoutlinedest}%
1474 % Also double the backslashes in the display string.
1475 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1476 \backslashparens\pdfoutlinetext}%
1478 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1481 \def\pdfmakeoutlines{%
1483 % Thanh's hack / proper braces in bookmarks
1484 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1485 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1487 % Read toc silently, to get counts of subentries for \pdfoutline.
1488 \def\numchapentry##1##2##3##4{%
1489 \def\thischapnum{##2}%
1491 \def\thissubsecnum{0}%
1493 \def\numsecentry##1##2##3##4{%
1494 \advancenumber{chap\thischapnum}%
1495 \def\thissecnum{##2}%
1496 \def\thissubsecnum{0}%
1498 \def\numsubsecentry##1##2##3##4{%
1499 \advancenumber{sec\thissecnum}%
1500 \def\thissubsecnum{##2}%
1502 \def\numsubsubsecentry##1##2##3##4{%
1503 \advancenumber{subsec\thissubsecnum}%
1505 \def\thischapnum{0}%
1507 \def\thissubsecnum{0}%
1509 % use \def rather than \let here because we redefine \chapentry et
1510 % al. a second time, below.
1511 \def\appentry{\numchapentry}%
1512 \def\appsecentry{\numsecentry}%
1513 \def\appsubsecentry{\numsubsecentry}%
1514 \def\appsubsubsecentry{\numsubsubsecentry}%
1515 \def\unnchapentry{\numchapentry}%
1516 \def\unnsecentry{\numsecentry}%
1517 \def\unnsubsecentry{\numsubsecentry}%
1518 \def\unnsubsubsecentry{\numsubsubsecentry}%
1521 % Read toc second time, this time actually producing the outlines.
1522 % The `-' means take the \expnumber as the absolute number of
1523 % subentries, which we calculated on our first read of the .toc above.
1525 % We use the node names as the destinations.
1526 \def\numchapentry##1##2##3##4{%
1527 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1528 \def\numsecentry##1##2##3##4{%
1529 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1530 \def\numsubsecentry##1##2##3##4{%
1531 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1532 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1533 \dopdfoutline{##1}{}{##3}{##4}}%
1535 % PDF outlines are displayed using system fonts, instead of
1536 % document fonts. Therefore we cannot use special characters,
1537 % since the encoding is unknown. For example, the eogonek from
1538 % Latin 2 (0xea) gets translated to a | character. Info from
1539 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1541 % xx to do this right, we have to translate 8-bit characters to
1542 % their "best" equivalent, based on the @documentencoding. Right
1543 % now, I guess we'll just let the pdf reader have its way.
1546 \catcode`\\=\active \otherbackslash
1547 \input \tocreadfilename
1551 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1552 \ifx\PP\D\let\nextsp\relax
1553 \else\let\nextsp\skipspaces
1554 \ifx\p\space\else\addtokens{\filename}{\PP}%
1555 \advance\filenamelength by 1
1559 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1560 \ifnum\pdftexversion < 14
1561 \let \startlink \pdfannotlink
1563 \let \startlink \pdfstartlink
1565 % make a live url in pdf output.
1568 % it seems we really need yet another set of dummies; have not
1569 % tried to figure out what each command should do in the context
1570 % of @url. for now, just make @/ a no-op, that's the only one
1571 % people have actually reported a problem with.
1573 \normalturnoffactive
1576 \makevalueexpandable
1577 \leavevmode\setcolor{\urlcolor}%
1578 \startlink attr{/Border [0 0 0]}%
1579 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1581 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1582 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1583 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1584 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1586 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1588 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1589 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1590 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1592 \ifnum0=\countA\else\makelink\fi
1593 \ifx\first.\let\next=\done\else
1595 \addtokens{\toksB}{\the\toksD}
1596 \ifx\first,\addtokens{\toksB}{\space}\fi
1598 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1600 \def\makelink{\addtokens{\toksB}%
1601 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1603 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1604 \setcolor{\linkcolor}#1\endlink}
1605 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1608 % \unskip in hmode, since that's what \safewhatsit does.
1609 \def\pdfmkdest{\ifhmode\unskip\fi\gobble}
1610 \let\pdfurl = \gobble
1611 \let\endlink = \relax
1612 \let\setcolor = \gobble
1613 \let\pdfsetcolor = \gobble
1614 \let\pdfmakeoutlines = \relax
1615 \fi % \ifx\pdfoutput
1620 % Change the current font style to #1, remembering it in \curfontstyle.
1621 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1622 % italics, not bold italics.
1624 \def\setfontstyle#1{%
1625 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1626 \csname ten#1\endcsname % change the current font
1629 % Select #1 fonts with the current style.
1631 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1633 \def\rm{\fam=0 \setfontstyle{rm}}
1634 \def\it{\fam=\itfam \setfontstyle{it}}
1635 \def\sl{\fam=\slfam \setfontstyle{sl}}
1636 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1637 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1639 % Unfortunately, we have to override this for titles and the like, since
1640 % in those cases "rm" is bold. Sigh.
1641 \def\rmisbold{\rm\def\curfontstyle{bf}}
1643 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1644 % So we set up a \sf.
1646 \def\sf{\fam=\sffam \setfontstyle{sf}}
1647 \let\li = \sf % Sometimes we call it \li, not \sf.
1649 % We don't need math for this font style.
1650 \def\ttsl{\setfontstyle{ttsl}}
1654 \newdimen\textleading \textleading = 13.2pt
1656 % Set the baselineskip to #1, and the lineskip and strut size
1657 % correspondingly. There is no deep meaning behind these magic numbers
1658 % used as factors; they just match (closely enough) what Knuth defined.
1660 \def\lineskipfactor{.08333}
1661 \def\strutheightpercent{.70833}
1662 \def\strutdepthpercent {.29167}
1664 % can get a sort of poor man's double spacing by redefining this.
1665 \def\baselinefactor{1}
1669 \normalbaselineskip = \baselinefactor\dimen0
1670 \normallineskip = \lineskipfactor\normalbaselineskip
1672 \setbox\strutbox =\hbox{%
1673 \vrule width0pt height\strutheightpercent\baselineskip
1674 depth \strutdepthpercent \baselineskip
1678 % PDF CMaps. See also LaTeX's t1.cmap.
1680 % do nothing with this by default.
1681 \expandafter\let\csname cmapOT1\endcsname\gobble
1682 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1683 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1685 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1686 % (\pdffontattr was introduced many years ago, but people still run
1687 % older pdftex's; it's easy to conditionalize, so we do.)
1688 \ifpdf \ifx\pdffontattr\undefined \else
1690 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1691 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1692 %%DocumentNeededResources: ProcSet (CIDInit)
1693 %%IncludeResource: ProcSet (CIDInit)
1694 %%BeginResource: CMap (TeX-OT1-0)
1695 %%Title: (TeX-OT1-0 TeX OT1 0)
1698 /CIDInit /ProcSet findresource begin
1706 /CMapName /TeX-OT1-0 def
1708 1 begincodespacerange
1764 CMapName currentdict /CMap defineresource pop
1770 \expandafter\edef\csname cmapOT1\endcsname#1{%
1771 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1776 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1777 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1778 %%DocumentNeededResources: ProcSet (CIDInit)
1779 %%IncludeResource: ProcSet (CIDInit)
1780 %%BeginResource: CMap (TeX-OT1IT-0)
1781 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1784 /CIDInit /ProcSet findresource begin
1792 /CMapName /TeX-OT1IT-0 def
1794 1 begincodespacerange
1852 CMapName currentdict /CMap defineresource pop
1858 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1859 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1864 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1865 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1866 %%DocumentNeededResources: ProcSet (CIDInit)
1867 %%IncludeResource: ProcSet (CIDInit)
1868 %%BeginResource: CMap (TeX-OT1TT-0)
1869 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1872 /CIDInit /ProcSet findresource begin
1880 /CMapName /TeX-OT1TT-0 def
1882 1 begincodespacerange
1927 CMapName currentdict /CMap defineresource pop
1933 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1934 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1939 % Set the font macro #1 to the font named #2, adding on the
1940 % specified font prefix (normally `cm').
1941 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1942 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1944 \def\setfont#1#2#3#4#5{%
1945 \font#1=\fontprefix#2#3 scaled #4
1946 \csname cmap#5\endcsname#1%
1948 % This is what gets called when #5 of \setfont is empty.
1950 % emacs-page end of cmaps
1952 % Use cm as the default font prefix.
1953 % To specify the font prefix, you must define \fontprefix
1954 % before you read in texinfo.tex.
1955 \ifx\fontprefix\undefined
1958 % Support font families that don't use the same naming scheme as CM.
1960 \def\rmbshape{bx} %where the normal face is bold
1965 \def\ttslshape{sltt}
1975 % Definitions for a main text size of 11pt. This is the default in
1978 \def\definetextfontsizexi{%
1979 % Text fonts (11.2pt, magstep1).
1980 \def\textnominalsize{11pt}
1981 \edef\mainmagstep{\magstephalf}
1982 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1983 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1984 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1985 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1986 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1987 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1988 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1989 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
1990 \font\texti=cmmi10 scaled \mainmagstep
1991 \font\textsy=cmsy10 scaled \mainmagstep
1992 \def\textecsize{1095}
1994 % A few fonts for @defun names and args.
1995 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
1996 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
1997 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
1998 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2000 % Fonts for indices, footnotes, small examples (9pt).
2001 \def\smallnominalsize{9pt}
2002 \setfont\smallrm\rmshape{9}{1000}{OT1}
2003 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2004 \setfont\smallbf\bfshape{10}{900}{OT1}
2005 \setfont\smallit\itshape{9}{1000}{OT1IT}
2006 \setfont\smallsl\slshape{9}{1000}{OT1}
2007 \setfont\smallsf\sfshape{9}{1000}{OT1}
2008 \setfont\smallsc\scshape{10}{900}{OT1}
2009 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2012 \def\smallecsize{0900}
2014 % Fonts for small examples (8pt).
2015 \def\smallernominalsize{8pt}
2016 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2017 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2018 \setfont\smallerbf\bfshape{10}{800}{OT1}
2019 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2020 \setfont\smallersl\slshape{8}{1000}{OT1}
2021 \setfont\smallersf\sfshape{8}{1000}{OT1}
2022 \setfont\smallersc\scshape{10}{800}{OT1}
2023 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2024 \font\smalleri=cmmi8
2025 \font\smallersy=cmsy8
2026 \def\smallerecsize{0800}
2028 % Fonts for title page (20.4pt):
2029 \def\titlenominalsize{20pt}
2030 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2031 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2032 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2033 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2034 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2035 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2036 \let\titlebf=\titlerm
2037 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2038 \font\titlei=cmmi12 scaled \magstep3
2039 \font\titlesy=cmsy10 scaled \magstep4
2040 \def\titleecsize{2074}
2042 % Chapter (and unnumbered) fonts (17.28pt).
2043 \def\chapnominalsize{17pt}
2044 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
2045 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
2046 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
2047 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
2048 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2049 \setfont\chapsf\sfbshape{17}{1000}{OT1}
2051 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
2052 \font\chapi=cmmi12 scaled \magstep2
2053 \font\chapsy=cmsy10 scaled \magstep3
2054 \def\chapecsize{1728}
2056 % Section fonts (14.4pt).
2057 \def\secnominalsize{14pt}
2058 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
2059 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
2060 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
2061 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
2062 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2063 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
2065 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
2066 \font\seci=cmmi12 scaled \magstep1
2067 \font\secsy=cmsy10 scaled \magstep2
2068 \def\sececsize{1440}
2070 % Subsection fonts (13.15pt).
2071 \def\ssecnominalsize{13pt}
2072 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
2073 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
2074 \setfont\ssecsl\slbshape{10}{1315}{OT1}
2075 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
2076 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2077 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
2079 \setfont\ssecsc\scbshape{10}{1315}{OT1}
2080 \font\sseci=cmmi12 scaled \magstephalf
2081 \font\ssecsy=cmsy10 scaled 1315
2082 \def\ssececsize{1200}
2084 % Reduced fonts for @acro in text (10pt).
2085 \def\reducednominalsize{10pt}
2086 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2087 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2088 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2089 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2090 \setfont\reducedsl\slshape{10}{1000}{OT1}
2091 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2092 \setfont\reducedsc\scshape{10}{1000}{OT1}
2093 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2094 \font\reducedi=cmmi10
2095 \font\reducedsy=cmsy10
2096 \def\reducedecsize{1000}
2098 % reset the current fonts
2101 } % end of 11pt text font size definitions
2104 % Definitions to make the main text be 10pt Computer Modern, with
2105 % section, chapter, etc., sizes following suit. This is for the GNU
2106 % Press printing of the Emacs 22 manual. Maybe other manuals in the
2107 % future. Used with @smallbook, which sets the leading to 12pt.
2109 \def\definetextfontsizex{%
2110 % Text fonts (10pt).
2111 \def\textnominalsize{10pt}
2112 \edef\mainmagstep{1000}
2113 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2114 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2115 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2116 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2117 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2118 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2119 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2120 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2121 \font\texti=cmmi10 scaled \mainmagstep
2122 \font\textsy=cmsy10 scaled \mainmagstep
2123 \def\textecsize{1000}
2125 % A few fonts for @defun names and args.
2126 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2127 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2128 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2129 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2131 % Fonts for indices, footnotes, small examples (9pt).
2132 \def\smallnominalsize{9pt}
2133 \setfont\smallrm\rmshape{9}{1000}{OT1}
2134 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2135 \setfont\smallbf\bfshape{10}{900}{OT1}
2136 \setfont\smallit\itshape{9}{1000}{OT1IT}
2137 \setfont\smallsl\slshape{9}{1000}{OT1}
2138 \setfont\smallsf\sfshape{9}{1000}{OT1}
2139 \setfont\smallsc\scshape{10}{900}{OT1}
2140 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2143 \def\smallecsize{0900}
2145 % Fonts for small examples (8pt).
2146 \def\smallernominalsize{8pt}
2147 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2148 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2149 \setfont\smallerbf\bfshape{10}{800}{OT1}
2150 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2151 \setfont\smallersl\slshape{8}{1000}{OT1}
2152 \setfont\smallersf\sfshape{8}{1000}{OT1}
2153 \setfont\smallersc\scshape{10}{800}{OT1}
2154 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2155 \font\smalleri=cmmi8
2156 \font\smallersy=cmsy8
2157 \def\smallerecsize{0800}
2159 % Fonts for title page (20.4pt):
2160 \def\titlenominalsize{20pt}
2161 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2162 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2163 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2164 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2165 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2166 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2167 \let\titlebf=\titlerm
2168 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2169 \font\titlei=cmmi12 scaled \magstep3
2170 \font\titlesy=cmsy10 scaled \magstep4
2171 \def\titleecsize{2074}
2173 % Chapter fonts (14.4pt).
2174 \def\chapnominalsize{14pt}
2175 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2176 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2177 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2178 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2179 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2180 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2182 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2183 \font\chapi=cmmi12 scaled \magstep1
2184 \font\chapsy=cmsy10 scaled \magstep2
2185 \def\chapecsize{1440}
2187 % Section fonts (12pt).
2188 \def\secnominalsize{12pt}
2189 \setfont\secrm\rmbshape{12}{1000}{OT1}
2190 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2191 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2192 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2193 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2194 \setfont\secsf\sfbshape{12}{1000}{OT1}
2196 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2198 \font\secsy=cmsy10 scaled \magstep1
2199 \def\sececsize{1200}
2201 % Subsection fonts (10pt).
2202 \def\ssecnominalsize{10pt}
2203 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2204 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2205 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2206 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2207 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2208 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2210 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2213 \def\ssececsize{1000}
2215 % Reduced fonts for @acro in text (9pt).
2216 \def\reducednominalsize{9pt}
2217 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2218 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2219 \setfont\reducedbf\bfshape{10}{900}{OT1}
2220 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2221 \setfont\reducedsl\slshape{9}{1000}{OT1}
2222 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2223 \setfont\reducedsc\scshape{10}{900}{OT1}
2224 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2225 \font\reducedi=cmmi9
2226 \font\reducedsy=cmsy9
2227 \def\reducedecsize{0900}
2229 % reduce space between paragraphs
2230 \divide\parskip by 2
2232 % reset the current fonts
2235 } % end of 10pt text font size definitions
2238 % We provide the user-level command
2240 % (or 11) to redefine the text font size. pt is assumed.
2245 \parseargdef\fonttextsize{%
2246 \def\textsizearg{#1}%
2247 \wlog{doing @fonttextsize \textsizearg}%
2249 % Set \globaldefs so that documents can use this inside @tex, since
2250 % makeinfo 4.8 does not support it, but we need it nonetheless.
2252 \begingroup \globaldefs=1
2253 \ifx\textsizearg\xword \definetextfontsizex
2254 \else \ifx\textsizearg\xiword \definetextfontsizexi
2257 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2263 % In order for the font changes to affect most math symbols and letters,
2264 % we have to define the \textfont of the standard families. Since
2265 % texinfo doesn't allow for producing subscripts and superscripts except
2266 % in the main text, we don't bother to reset \scriptfont and
2267 % \scriptscriptfont (which would also require loading a lot more fonts).
2269 \def\resetmathfonts{%
2270 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2271 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2272 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2275 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2276 % of just \STYLE. We do this because \STYLE needs to also set the
2277 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2278 % \tenSTYLE to set the current font.
2280 % Each font-changing command also sets the names \lsize (one size lower)
2281 % and \lllsize (three sizes lower). These relative commands are used in
2282 % the LaTeX logo and acronyms.
2284 % This all needs generalizing, badly.
2287 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2288 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2289 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2290 \let\tenttsl=\textttsl
2291 \def\curfontsize{text}%
2292 \def\lsize{reduced}\def\lllsize{smaller}%
2293 \resetmathfonts \setleading{\textleading}}
2295 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2296 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2297 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2298 \let\tenttsl=\titlettsl
2299 \def\curfontsize{title}%
2300 \def\lsize{chap}\def\lllsize{subsec}%
2301 \resetmathfonts \setleading{25pt}}
2302 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2304 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2305 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2306 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2307 \let\tenttsl=\chapttsl
2308 \def\curfontsize{chap}%
2309 \def\lsize{sec}\def\lllsize{text}%
2310 \resetmathfonts \setleading{19pt}}
2312 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2313 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2314 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2315 \let\tenttsl=\secttsl
2316 \def\curfontsize{sec}%
2317 \def\lsize{subsec}\def\lllsize{reduced}%
2318 \resetmathfonts \setleading{16pt}}
2320 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2321 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2322 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2323 \let\tenttsl=\ssecttsl
2324 \def\curfontsize{ssec}%
2325 \def\lsize{text}\def\lllsize{small}%
2326 \resetmathfonts \setleading{15pt}}
2327 \let\subsubsecfonts = \subsecfonts
2329 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2330 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2331 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2332 \let\tenttsl=\reducedttsl
2333 \def\curfontsize{reduced}%
2334 \def\lsize{small}\def\lllsize{smaller}%
2335 \resetmathfonts \setleading{10.5pt}}
2337 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2338 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2339 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2340 \let\tenttsl=\smallttsl
2341 \def\curfontsize{small}%
2342 \def\lsize{smaller}\def\lllsize{smaller}%
2343 \resetmathfonts \setleading{10.5pt}}
2345 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2346 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2347 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2348 \let\tenttsl=\smallerttsl
2349 \def\curfontsize{smaller}%
2350 \def\lsize{smaller}\def\lllsize{smaller}%
2351 \resetmathfonts \setleading{9.5pt}}
2353 % Set the fonts to use with the @small... environments.
2354 \let\smallexamplefonts = \smallfonts
2356 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2357 % can fit this many characters:
2358 % 8.5x11=86 smallbook=72 a4=90 a5=69
2359 % If we use \scriptfonts (8pt), then we can fit this many characters:
2360 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2361 % For me, subjectively, the few extra characters that fit aren't worth
2362 % the additional smallness of 8pt. So I'm making the default 9pt.
2364 % By the way, for comparison, here's what fits with @example (10pt):
2365 % 8.5x11=71 smallbook=60 a4=75 a5=58
2367 % I wish the USA used A4 paper.
2371 % Set up the default fonts, so we can use them for creating boxes.
2373 \definetextfontsizexi
2375 % Define these so they can be easily changed for other fonts.
2376 \def\angleleft{$\langle$}
2377 \def\angleright{$\rangle$}
2379 % Count depth in font-changes, for error checks
2380 \newcount\fontdepth \fontdepth=0
2382 % Fonts for short table of contents.
2383 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2384 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2385 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2386 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2388 %% Add scribe-like font environments, plus @l for inline lisp (usually sans
2389 %% serif) and @ii for TeX italic
2391 % \smartitalic{ARG} outputs arg in italics, followed by an italic correction
2392 % unless the following character is such as not to need one.
2393 \def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else
2394 \ptexslash\fi\fi\fi}
2395 \def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx}
2396 \def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx}
2398 % like \smartslanted except unconditionally uses \ttsl.
2399 % @var is set to this for defun arguments.
2400 \def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx}
2402 % like \smartslanted except unconditionally use \sl. We never want
2403 % ttsl for book titles, do we?
2404 \def\cite#1{{\sl #1}\futurelet\next\smartitalicx}
2407 \let\slanted=\smartslanted
2408 \def\var#1{{\setupmarkupstyle{var}\smartslanted{#1}}}
2409 \let\dfn=\smartslanted
2410 \let\emph=\smartitalic
2412 % @b, explicit bold.
2416 % @sansserif, explicit sans.
2417 \def\sansserif#1{{\sf #1}}
2419 % We can't just use \exhyphenpenalty, because that only has effect at
2420 % the end of a paragraph. Restore normal hyphenation at the end of the
2421 % group within which \nohyphenation is presumably called.
2423 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2424 \def\restorehyphenation{\hyphenchar\font = `- }
2426 % Set sfcode to normal for the chars that usually have another value.
2427 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2428 % sometimes \x has an active definition that messes things up.
2431 \def\plainfrenchspacing{%
2432 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2433 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2434 \def\endofsentencespacefactor{1000}% for @. and friends
2436 \def\plainnonfrenchspacing{%
2437 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2438 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2439 \def\endofsentencespacefactor{3000}% for @. and friends
2442 \def\endofsentencespacefactor{3000}% default
2445 {\tt \rawbackslash \plainfrenchspacing #1}%
2448 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2449 \setfont\keyrm\rmshape{8}{1000}{OT1}
2451 \def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2452 \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2453 \vbox{\hrule\kern-0.4pt
2454 \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2456 \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2457 \def\key #1{{\setupmarkupstyle{key}\nohyphenation \uppercase{#1}}\null}
2458 % The old definition, with no lozenge:
2459 %\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null}
2460 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2462 % @file, @option are the same as @samp.
2466 % @code is a modification of @t,
2467 % which makes spaces the same size as normal in the surrounding text.
2470 % Change normal interword space to be same as for the current font.
2471 \spaceskip = \fontdimen2\font
2473 % Switch to typewriter.
2476 % But `\ ' produces the large typewriter interword space.
2477 \def\ {{\spaceskip = 0pt{} }}%
2479 % Turn off hyphenation.
2489 % We *must* turn on hyphenation at `-' and `_' in @code.
2490 % Otherwise, it is too hard to avoid overfull hboxes
2491 % in the Emacs manual, the Library manual, etc.
2493 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2494 % both hyphenation at - and hyphenation within words.
2495 % We must therefore turn them both off (\tclose does that)
2496 % and arrange explicitly to hyphenate at a dash.
2499 \catcode`\-=\active \catcode`\_=\active
2500 \catcode`\'=\active \catcode`\`=\active
2501 \global\let'=\rq \global\let`=\lq % default definitions
2503 \global\def\code{\begingroup
2504 \setupmarkupstyle{code}%
2505 % The following should really be moved into \setupmarkupstyle handlers.
2506 \catcode\dashChar=\active \catcode\underChar=\active
2519 \def\codedash{-\discretionary{}{}{}}
2521 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2522 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2523 % will therefore expand the active definition of _, which is us
2524 % (inside @code that is), therefore an endless loop.
2526 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2527 \else\normalunderscore \fi
2528 \discretionary{}{}{}}%
2531 \def\codex #1{\tclose{#1}\endgroup}
2533 % An additional complication: the above will allow breaks after, e.g.,
2534 % each of the four underscores in __typeof__. This is undesirable in
2535 % some manuals, especially if they don't have long identifiers in
2536 % general. @allowcodebreaks provides a way to control this.
2538 \newif\ifallowcodebreaks \allowcodebreakstrue
2540 \def\keywordtrue{true}
2541 \def\keywordfalse{false}
2543 \parseargdef\allowcodebreaks{%
2545 \ifx\txiarg\keywordtrue
2546 \allowcodebreakstrue
2547 \else\ifx\txiarg\keywordfalse
2548 \allowcodebreaksfalse
2550 \errhelp = \EMsimple
2551 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2555 % @kbd is like @code, except that if the argument is just one @key command,
2556 % then @kbd has no effect.
2558 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2559 % `example' (@kbd uses ttsl only inside of @example and friends),
2560 % or `code' (@kbd uses normal tty font always).
2561 \parseargdef\kbdinputstyle{%
2563 \ifx\txiarg\worddistinct
2564 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2565 \else\ifx\txiarg\wordexample
2566 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2567 \else\ifx\txiarg\wordcode
2568 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2570 \errhelp = \EMsimple
2571 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2574 \def\worddistinct{distinct}
2575 \def\wordexample{example}
2578 % Default is `distinct.'
2579 \kbdinputstyle distinct
2582 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2583 \ifx\one\xkey\ifx\threex\three \key{#2}%
2584 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2585 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi}
2587 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2588 \let\indicateurl=\code
2592 % @clicksequence{File @click{} Open ...}
2593 \def\clicksequence#1{\begingroup #1\endgroup}
2595 % @clickstyle @arrow (by default)
2596 \parseargdef\clickstyle{\def\click{#1}}
2599 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2600 % second argument specifying the text to display and an optional third
2601 % arg as text to display instead of (rather than in addition to) the url
2602 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2603 % a hypertex \special here.
2605 \def\uref#1{\douref #1,,,\finish}
2606 \def\douref#1,#2,#3,#4\finish{\begingroup
2609 \setbox0 = \hbox{\ignorespaces #3}%
2611 \unhbox0 % third arg given, show only that
2613 \setbox0 = \hbox{\ignorespaces #2}%
2616 \unhbox0 % PDF: 2nd arg given, show only it
2618 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2621 \code{#1}% only url given, so show it
2627 % @url synonym for @uref, since that's how everyone uses it.
2631 % rms does not like angle brackets --karl, 17may97.
2632 % So now @email is just like @uref, unless we are pdf.
2634 %\def\email#1{\angleleft{\tt #1}\angleright}
2636 \def\email#1{\doemail#1,,\finish}
2637 \def\doemail#1,#2,#3\finish{\begingroup
2640 \setbox0 = \hbox{\ignorespaces #2}%
2641 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2648 % Check if we are currently using a typewriter font. Since all the
2649 % Computer Modern typewriter fonts have zero interword stretch (and
2650 % shrink), and it is reasonable to expect all typewriter fonts to have
2651 % this property, we can check that font parameter.
2653 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2655 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2656 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2658 \def\dmn#1{\thinspace #1}
2660 \def\kbd#1{{\setupmarkupstyle{kbd}\def\look{#1}\expandafter\kbdfoo\look??\par}}
2662 % @l was never documented to mean ``switch to the Lisp font'',
2663 % and it is not used as such in any manual I can find. We need it for
2664 % Polish suppressed-l. --karl, 22sep96.
2665 %\def\l#1{{\li #1}\null}
2667 % Explicit font changes: @r, @sc, undocumented @ii.
2668 \def\r#1{{\rm #1}} % roman font
2669 \def\sc#1{{\smallcaps#1}} % smallcaps font
2670 \def\ii#1{{\it #1}} % italic font
2672 % @acronym for "FBI", "NATO", and the like.
2673 % We print this one point size smaller, since it's intended for
2676 \def\acronym#1{\doacronym #1,,\finish}
2677 \def\doacronym#1,#2,#3\finish{%
2678 {\selectfonts\lsize #1}%
2680 \ifx\temp\empty \else
2681 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2685 % @abbr for "Comput. J." and the like.
2686 % No font change, but don't do end-of-sentence spacing.
2688 \def\abbr#1{\doabbr #1,,\finish}
2689 \def\doabbr#1,#2,#3\finish{%
2690 {\plainfrenchspacing #1}%
2692 \ifx\temp\empty \else
2693 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2697 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2699 \def\pounds{{\it\$}}
2701 % @euro{} comes from a separate font, depending on the current style.
2702 % We use the free feym* fonts from the eurosym package by Henrik
2703 % Theiling, which support regular, slanted, bold and bold slanted (and
2704 % "outlined" (blackboard board, sort of) versions, which we don't need).
2705 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2707 % Although only regular is the truly official Euro symbol, we ignore
2708 % that. The Euro is designed to be slightly taller than the regular
2714 % feybo - bold slanted
2716 % There is no good (free) typewriter version, to my knowledge.
2717 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2720 % Also doesn't work in math. Do we need to do math with euro symbols?
2724 \def\euro{{\eurofont e}}
2726 % We set the font at each command, rather than predefining it in
2727 % \textfonts and the other font-switching commands, so that
2728 % installations which never need the symbol don't have to have the
2731 % There is only one designed size (nominal 10pt), so we always scale
2732 % that to the current nominal size.
2734 % By the way, simply using "at 1em" works for cmr10 and the like, but
2735 % does not work for cmbx10 and other extended/shrunken fonts.
2737 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2739 \ifx\curfontstyle\bfstylename
2741 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2744 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2749 % Hacks for glyphs from the EC fonts similar to \euro. We don't
2750 % use \let for the aliases, because sometimes we redefine the original
2751 % macro, and the alias should reflect the redefinition.
2752 \def\guillemetleft{{\ecfont \char"13}}
2753 \def\guillemotleft{\guillemetleft}
2754 \def\guillemetright{{\ecfont \char"14}}
2755 \def\guillemotright{\guillemetright}
2756 \def\guilsinglleft{{\ecfont \char"0E}}
2757 \def\guilsinglright{{\ecfont \char"0F}}
2758 \def\quotedblbase{{\ecfont \char"12}}
2759 \def\quotesinglbase{{\ecfont \char"0D}}
2761 % This positioning is not perfect (see the ogonek LaTeX package), but
2762 % we have the precomposed glyphs for the most common cases. We put the
2763 % tests to use those glyphs in the single \ogonek macro so we have fewer
2764 % dummy definitions to worry about for index entries, etc.
2766 % ogonek is also used with other letters in Lithuanian (IOU), but using
2767 % the precomposed glyphs for those is not so easy since they aren't in
2771 \ifx\temp\macrocharA\Aogonek
2772 \else\ifx\temp\macrochara\aogonek
2773 \else\ifx\temp\macrocharE\Eogonek
2774 \else\ifx\temp\macrochare\eogonek
2776 \ecfont \setbox0=\hbox{#1}%
2777 \ifdim\ht0=1ex\accent"0C #1%
2778 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
2783 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
2784 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
2785 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
2786 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
2789 % We can't distinguish serif/sans and italic/slanted, but this
2790 % is used for crude hacks anyway (like adding French and German
2791 % quotes to documents typeset with CM, where we lose kerning), so
2792 % hopefully nobody will notice/care.
2793 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
2794 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
2795 \ifx\curfontstyle\bfstylename
2797 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
2800 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
2805 % @registeredsymbol - R in a circle. The font for the R should really
2806 % be smaller yet, but lllsize is the best we can do for now.
2807 % Adapted from the plain.tex definition of \copyright.
2809 \def\registeredsymbol{%
2810 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2815 % @textdegree - the normal degrees sign.
2817 \def\textdegree{$^\circ$}
2819 % Laurent Siebenmann reports \Orb undefined with:
2820 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
2821 % so we'll define it if necessary.
2824 \def\Orb{\mathhexbox20D}
2828 \chardef\quotedblleft="5C
2829 \chardef\quotedblright=`\"
2830 \chardef\quoteleft=`\`
2831 \chardef\quoteright=`\'
2834 \message{page headings,}
2836 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
2837 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
2839 % First the title page. Must do @settitle before @titlepage.
2841 \newif\iffinishedtitlepage
2843 % Do an implicit @contents or @shortcontents after @end titlepage if the
2844 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
2846 \newif\ifsetcontentsaftertitlepage
2847 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
2848 \newif\ifsetshortcontentsaftertitlepage
2849 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
2851 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
2852 \endgroup\page\hbox{}\page}
2855 % Open one extra group, as we want to close it in the middle of \Etitlepage.
2857 \parindent=0pt \textfonts
2858 % Leave some space at the very top of the page.
2859 \vglue\titlepagetopglue
2860 % No rule at page bottom unless we print one at the top with @title.
2861 \finishedtitlepagetrue
2863 % Most title ``pages'' are actually two pages long, with space
2864 % at the top of the second. We don't want the ragged left on the second.
2865 \let\oldpage = \page
2867 \iffinishedtitlepage\else
2870 \let\page = \oldpage
2877 \iffinishedtitlepage\else
2880 % It is important to do the page break before ending the group,
2881 % because the headline and footline are only empty inside the group.
2882 % If we use the new definition of \page, we always get a blank page
2883 % after the title page, which we certainly don't want.
2887 % Need this before the \...aftertitlepage checks so that if they are
2888 % in effect the toc pages will come out with page numbers.
2891 % If they want short, they certainly want long too.
2892 \ifsetshortcontentsaftertitlepage
2895 \global\let\shortcontents = \relax
2896 \global\let\contents = \relax
2899 \ifsetcontentsaftertitlepage
2901 \global\let\contents = \relax
2902 \global\let\shortcontents = \relax
2906 \def\finishtitlepage{%
2907 \vskip4pt \hrule height 2pt width \hsize
2908 \vskip\titlepagebottomglue
2909 \finishedtitlepagetrue
2912 %%% Macros to be used within @titlepage:
2914 \let\subtitlerm=\tenrm
2915 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
2917 \parseargdef\title{%
2919 \leftline{\titlefonts\rmisbold #1}
2920 % print a rule at the page bottom also.
2921 \finishedtitlepagefalse
2922 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
2925 \parseargdef\subtitle{%
2927 {\subtitlefont \rightline{#1}}%
2930 % @author should come last, but may come many times.
2931 % It can also be used inside @quotation.
2933 \parseargdef\author{%
2934 \def\temp{\quotation}%
2936 \def\quotationauthor{#1}% printed in \Equotation.
2939 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
2940 {\secfonts\rmisbold \leftline{#1}}%
2945 %%% Set up page headings and footings.
2947 \let\thispage=\folio
2949 \newtoks\evenheadline % headline on even pages
2950 \newtoks\oddheadline % headline on odd pages
2951 \newtoks\evenfootline % footline on even pages
2952 \newtoks\oddfootline % footline on odd pages
2954 % Now make TeX use those variables
2955 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
2956 \else \the\evenheadline \fi}}
2957 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
2958 \else \the\evenfootline \fi}\HEADINGShook}
2959 \let\HEADINGShook=\relax
2961 % Commands to set those variables.
2962 % For example, this is what @headings on does
2963 % @evenheading @thistitle|@thispage|@thischapter
2964 % @oddheading @thischapter|@thispage|@thistitle
2965 % @evenfooting @thisfile||
2966 % @oddfooting ||@thisfile
2969 \def\evenheading{\parsearg\evenheadingxxx}
2970 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
2971 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
2972 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2974 \def\oddheading{\parsearg\oddheadingxxx}
2975 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
2976 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
2977 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2979 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
2981 \def\evenfooting{\parsearg\evenfootingxxx}
2982 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
2983 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
2984 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
2986 \def\oddfooting{\parsearg\oddfootingxxx}
2987 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
2988 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
2989 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
2991 % Leave some space for the footline. Hopefully ok to assume
2992 % @evenfooting will not be used by itself.
2993 \global\advance\pageheight by -12pt
2994 \global\advance\vsize by -12pt
2997 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
2999 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3000 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3002 % The same set of arguments for:
3007 % @everyheadingmarks
3008 % @everyfootingmarks
3010 \def\evenheadingmarks{\headingmarks{even}{heading}}
3011 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3012 \def\evenfootingmarks{\headingmarks{even}{footing}}
3013 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3014 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3015 \headingmarks{odd}{heading}{#1} }
3016 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3017 \headingmarks{odd}{footing}{#1} }
3018 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3019 \def\headingmarks#1#2#3 {%
3020 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3021 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3024 \everyheadingmarks bottom
3025 \everyfootingmarks bottom
3027 % @headings double turns headings on for double-sided printing.
3028 % @headings single turns headings on for single-sided printing.
3029 % @headings off turns them off.
3030 % @headings on same as @headings double, retained for compatibility.
3031 % @headings after turns on double-sided headings after this page.
3032 % @headings doubleafter turns on double-sided headings after this page.
3033 % @headings singleafter turns on single-sided headings after this page.
3034 % By default, they are off at the start of a document,
3035 % and turned `on' after @end titlepage.
3037 \def\headings #1 {\csname HEADINGS#1\endcsname}
3040 \global\evenheadline={\hfil} \global\evenfootline={\hfil}
3041 \global\oddheadline={\hfil} \global\oddfootline={\hfil}}
3043 % When we turn headings on, set the page number to 1.
3044 % For double-sided printing, put current file name in lower left corner,
3045 % chapter name on inside top of right hand pages, document
3046 % title on inside top of left hand pages, and page numbers on outside top
3047 % edge of all pages.
3048 \def\HEADINGSdouble{%
3050 \global\evenfootline={\hfil}
3051 \global\oddfootline={\hfil}
3052 \global\evenheadline={\line{\folio\hfil\thistitle}}
3053 \global\oddheadline={\line{\thischapter\hfil\folio}}
3054 \global\let\contentsalignmacro = \chapoddpage
3056 \let\contentsalignmacro = \chappager
3058 % For single-sided printing, chapter title goes across top left of page,
3059 % page number on top right.
3060 \def\HEADINGSsingle{%
3062 \global\evenfootline={\hfil}
3063 \global\oddfootline={\hfil}
3064 \global\evenheadline={\line{\thischapter\hfil\folio}}
3065 \global\oddheadline={\line{\thischapter\hfil\folio}}
3066 \global\let\contentsalignmacro = \chappager
3068 \def\HEADINGSon{\HEADINGSdouble}
3070 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3071 \let\HEADINGSdoubleafter=\HEADINGSafter
3072 \def\HEADINGSdoublex{%
3073 \global\evenfootline={\hfil}
3074 \global\oddfootline={\hfil}
3075 \global\evenheadline={\line{\folio\hfil\thistitle}}
3076 \global\oddheadline={\line{\thischapter\hfil\folio}}
3077 \global\let\contentsalignmacro = \chapoddpage
3080 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3081 \def\HEADINGSsinglex{%
3082 \global\evenfootline={\hfil}
3083 \global\oddfootline={\hfil}
3084 \global\evenheadline={\line{\thischapter\hfil\folio}}
3085 \global\oddheadline={\line{\thischapter\hfil\folio}}
3086 \global\let\contentsalignmacro = \chappager
3089 % Subroutines used in generating headings
3090 % This produces Day Month Year style of output.
3091 % Only define if not already defined, in case a txi-??.tex file has set
3092 % up a different format (e.g., txi-cs.tex does this).
3093 \ifx\today\undefined
3097 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3098 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3099 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3104 % @settitle line... specifies the title of the document, for headings.
3105 % It generates no output of its own.
3106 \def\thistitle{\putwordNoTitle}
3107 \def\settitle{\parsearg{\gdef\thistitle}}
3111 % Tables -- @table, @ftable, @vtable, @item(x).
3113 % default indentation of table text
3114 \newdimen\tableindent \tableindent=.8in
3115 % default indentation of @itemize and @enumerate text
3116 \newdimen\itemindent \itemindent=.3in
3117 % margin between end of table item and start of table text.
3118 \newdimen\itemmargin \itemmargin=.1in
3120 % used internally for \itemindent minus \itemmargin
3123 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3125 % They also define \itemindex
3126 % to index the item name in whatever manner is desired (perhaps none).
3128 \newif\ifitemxneedsnegativevskip
3130 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3132 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3133 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3135 \def\itemzzz #1{\begingroup %
3136 \advance\hsize by -\rightskip
3137 \advance\hsize by -\tableindent
3138 \setbox0=\hbox{\itemindicate{#1}}%
3140 \nobreak % This prevents a break before @itemx.
3142 % If the item text does not fit in the space we have, put it on a line
3143 % by itself, and do not allow a page break either before or after that
3144 % line. We do not start a paragraph here because then if the next
3145 % command is, e.g., @kindex, the whatsit would get put into the
3146 % horizontal list on a line by itself, resulting in extra blank space.
3147 \ifdim \wd0>\itemmax
3149 % Make this a paragraph so we get the \parskip glue and wrapping,
3150 % but leave it ragged-right.
3152 \advance\leftskip by-\tableindent
3153 \advance\hsize by\tableindent
3154 \advance\rightskip by0pt plus1fil
3155 \leavevmode\unhbox0\par
3158 % We're going to be starting a paragraph, but we don't want the
3159 % \parskip glue -- logically it's part of the @item we just started.
3160 \nobreak \vskip-\parskip
3162 % Stop a page break at the \parskip glue coming up. However, if
3163 % what follows is an environment such as @example, there will be no
3164 % \parskip glue; then the negative vskip we just inserted would
3165 % cause the example and the item to crash together. So we use this
3166 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3167 % \parskip glue after all. Section titles are handled this way also.
3171 \itemxneedsnegativevskipfalse
3173 % The item text fits into the space. Start a paragraph, so that the
3174 % following text (if any) will end up on the same line.
3176 % Do this with kerns and \unhbox so that if there is a footnote in
3177 % the item text, it can migrate to the main vertical list and
3178 % eventually be printed.
3179 \nobreak\kern-\tableindent
3180 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3182 \nobreak\kern\dimen0
3184 \itemxneedsnegativevskiptrue
3188 \def\item{\errmessage{@item while not in a list environment}}
3189 \def\itemx{\errmessage{@itemx while not in a list environment}}
3191 % @table, @ftable, @vtable.
3193 \let\itemindex\gobble
3197 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3198 \tablecheck{ftable}%
3201 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3202 \tablecheck{vtable}%
3205 \ifnum \the\catcode`\^^M=\active
3207 \errmessage{This command won't work in this context; perhaps the problem is
3208 that we are \inenvironment\thisenv}%
3209 \def\next{\doignore{#1}}%
3216 \def\itemindicate{#1}%
3221 \makevalueexpandable
3222 \edef\temp{\noexpand\tablez #1\space\space\space}%
3226 \def\tablez #1 #2 #3 #4\endtablez{%
3228 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3229 \ifnum 0#2>0 \tableindent=#2\mil \fi
3230 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3231 \itemmax=\tableindent
3232 \advance \itemmax by -\itemmargin
3233 \advance \leftskip by \tableindent
3234 \exdentamount=\tableindent
3236 \parskip = \smallskipamount
3237 \ifdim \parskip=0pt \parskip=2pt \fi
3238 \let\item = \internalBitem
3239 \let\itemx = \internalBitemx
3241 \def\Etable{\endgraf\afterenvbreak}
3244 \let\Eitemize\Etable
3245 \let\Eenumerate\Etable
3247 % This is the counter used by @enumerate, which is really @itemize
3251 \envdef\itemize{\parsearg\doitemize}
3255 \itemmax=\itemindent
3256 \advance\itemmax by -\itemmargin
3257 \advance\leftskip by \itemindent
3258 \exdentamount=\itemindent
3260 \parskip=\smallskipamount
3261 \ifdim\parskip=0pt \parskip=2pt \fi
3262 \def\itemcontents{#1}%
3263 % @itemize with no arg is equivalent to @itemize @bullet.
3264 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3265 \let\item=\itemizeitem
3268 % Definition of @item while inside @itemize and @enumerate.
3271 \advance\itemno by 1 % for enumerations
3272 {\let\par=\endgraf \smallbreak}% reasonable place to break
3274 % If the document has an @itemize directly after a section title, a
3275 % \nobreak will be last on the list, and \sectionheading will have
3276 % done a \vskip-\parskip. In that case, we don't want to zero
3277 % parskip, or the item text will crash with the heading. On the
3278 % other hand, when there is normal text preceding the item (as there
3279 % usually is), we do want to zero parskip, or there would be too much
3280 % space. In that case, we won't have a \nobreak before. At least
3281 % that's the theory.
3282 \ifnum\lastpenalty<10000 \parskip=0in \fi
3284 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3285 \vadjust{\penalty 1200}}% not good to break after first line of item.
3289 % \splitoff TOKENS\endmark defines \first to be the first token in
3290 % TOKENS, and \rest to be the remainder.
3292 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3294 % Allow an optional argument of an uppercase letter, lowercase letter,
3295 % or number, to specify the first label in the enumerated list. No
3296 % argument is the same as `1'.
3298 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3299 \def\enumeratey #1 #2\endenumeratey{%
3300 % If we were given no argument, pretend we were given `1'.
3302 \ifx\thearg\empty \def\thearg{1}\fi
3304 % Detect if the argument is a single token. If so, it might be a
3305 % letter. Otherwise, the only valid thing it can be is a number.
3306 % (We will always have one token, because of the test we just made.
3307 % This is a good thing, since \splitoff doesn't work given nothing at
3308 % all -- the first parameter is undelimited.)
3309 \expandafter\splitoff\thearg\endmark
3311 % Only one token in the argument. It could still be anything.
3312 % A ``lowercase letter'' is one whose \lccode is nonzero.
3313 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3314 % not equal to itself.
3315 % Otherwise, we assume it's a number.
3317 % We need the \relax at the end of the \ifnum lines to stop TeX from
3318 % continuing to look for a <number>.
3320 \ifnum\lccode\expandafter`\thearg=0\relax
3321 \numericenumerate % a number (we hope)
3324 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3325 \lowercaseenumerate % lowercase letter
3327 \uppercaseenumerate % uppercase letter
3331 % Multiple tokens in the argument. We hope it's a number.
3336 % An @enumerate whose labels are integers. The starting integer is
3339 \def\numericenumerate{%
3341 \startenumeration{\the\itemno}%
3344 % The starting (lowercase) letter is in \thearg.
3345 \def\lowercaseenumerate{%
3346 \itemno = \expandafter`\thearg
3348 % Be sure we're not beyond the end of the alphabet.
3350 \errmessage{No more lowercase letters in @enumerate; get a bigger
3357 % The starting (uppercase) letter is in \thearg.
3358 \def\uppercaseenumerate{%
3359 \itemno = \expandafter`\thearg
3361 % Be sure we're not beyond the end of the alphabet.
3363 \errmessage{No more uppercase letters in @enumerate; get a bigger
3370 % Call \doitemize, adding a period to the first argument and supplying the
3371 % common last two arguments. Also subtract one from the initial value in
3372 % \itemno, since @item increments \itemno.
3374 \def\startenumeration#1{%
3375 \advance\itemno by -1
3376 \doitemize{#1.}\flushcr
3379 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3382 \def\alphaenumerate{\enumerate{a}}
3383 \def\capsenumerate{\enumerate{A}}
3384 \def\Ealphaenumerate{\Eenumerate}
3385 \def\Ecapsenumerate{\Eenumerate}
3388 % @multitable macros
3389 % Amy Hendrickson, 8/18/94, 3/6/96
3391 % @multitable ... @end multitable will make as many columns as desired.
3392 % Contents of each column will wrap at width given in preamble. Width
3393 % can be specified either with sample text given in a template line,
3394 % or in percent of \hsize, the current width of text on page.
3396 % Table can continue over pages but will only break between lines.
3400 % Either define widths of columns in terms of percent of \hsize:
3401 % @multitable @columnfractions .25 .3 .45
3404 % Numbers following @columnfractions are the percent of the total
3405 % current hsize to be used for each column. You may use as many
3406 % columns as desired.
3409 % Or use a template:
3410 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3412 % using the widest term desired in each column.
3414 % Each new table line starts with @item, each subsequent new column
3415 % starts with @tab. Empty columns may be produced by supplying @tab's
3416 % with nothing between them for as many times as empty columns are needed,
3417 % ie, @tab@tab@tab will produce two empty columns.
3419 % @item, @tab do not need to be on their own lines, but it will not hurt
3422 % Sample multitable:
3424 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3425 % @item first col stuff @tab second col stuff @tab third col
3432 % @item first col stuff @tab second col stuff
3433 % @tab Many paragraphs of text may be used in any column.
3435 % They will wrap at the width determined by the template.
3436 % @item@tab@tab This will be in third column.
3439 % Default dimensions may be reset by user.
3440 % @multitableparskip is vertical space between paragraphs in table.
3441 % @multitableparindent is paragraph indent in table.
3442 % @multitablecolmargin is horizontal space to be left between columns.
3443 % @multitablelinespace is space to leave between table items, baseline
3445 % 0pt means it depends on current normal line spacing.
3447 \newskip\multitableparskip
3448 \newskip\multitableparindent
3449 \newdimen\multitablecolspace
3450 \newskip\multitablelinespace
3451 \multitableparskip=0pt
3452 \multitableparindent=6pt
3453 \multitablecolspace=12pt
3454 \multitablelinespace=0pt
3456 % Macros used to set up halign preamble:
3458 \let\endsetuptable\relax
3459 \def\xendsetuptable{\endsetuptable}
3460 \let\columnfractions\relax
3461 \def\xcolumnfractions{\columnfractions}
3464 % #1 is the @columnfraction, usually a decimal number like .5, but might
3465 % be just 1. We just use it, whatever it is.
3467 \def\pickupwholefraction#1 {%
3468 \global\advance\colcount by 1
3469 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3476 \ifx\firstarg\xendsetuptable
3479 \ifx\firstarg\xcolumnfractions
3480 \global\setpercenttrue
3483 \let\go\pickupwholefraction
3485 \global\advance\colcount by 1
3486 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3487 % separator; typically that is always in the input, anyway.
3488 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3491 \ifx\go\pickupwholefraction
3492 % Put the argument back for the \pickupwholefraction call, so
3493 % we'll always have a period there to be parsed.
3494 \def\go{\pickupwholefraction#1}%
3496 \let\go = \setuptable
3502 % multitable-only commands.
3504 % @headitem starts a heading row, which we typeset in bold.
3505 % Assignments have to be global since we are inside the implicit group
3506 % of an alignment entry. Note that \everycr resets \everytab.
3507 \def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}%
3509 % A \tab used to include \hskip1sp. But then the space in a template
3510 % line is not enough. That is bad. So let's go back to just `&' until
3511 % we encounter the problem it was intended to solve again.
3512 % --karl, nathan@acm.org, 20apr99.
3513 \def\tab{\checkenv\multitable &\the\everytab}%
3515 % @multitable ... @end multitable definitions:
3517 \newtoks\everytab % insert after every tab.
3519 \envdef\multitable{%
3523 % @item within a multitable starts a normal row.
3524 % We use \def instead of \let so that if one of the multitable entries
3525 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3526 % \endtemplate) expanding \doitemize.
3531 \setmultitablespacing
3532 \parskip=\multitableparskip
3533 \parindent=\multitableparindent
3539 \global\everytab={}%
3540 \global\colcount=0 % Reset the column counter.
3541 % Check for saved footnotes, etc.
3543 % Keeps underfull box messages off when table breaks over pages.
3545 % Maybe so, but it also creates really weird page breaks when the
3546 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3547 % problem manifests itself, so it can be fixed for real --karl.
3551 \parsearg\domultitable
3553 \def\domultitable#1{%
3554 % To parse everything between @multitable and @item:
3555 \setuptable#1 \endsetuptable
3557 % This preamble sets up a generic column definition, which will
3558 % be used as many times as user calls for columns.
3559 % \vtop will set a single line and will also let text wrap and
3560 % continue for many paragraphs if desired.
3562 \global\advance\colcount by 1
3565 % Use the current \colcount to find the correct column width:
3566 \hsize=\expandafter\csname col\the\colcount\endcsname
3568 % In order to keep entries from bumping into each other
3569 % we will add a \leftskip of \multitablecolspace to all columns after
3572 % If a template has been used, we will add \multitablecolspace
3573 % to the width of each template entry.
3575 % If the user has set preamble in terms of percent of \hsize we will
3576 % use that dimension as the width of the column, and the \leftskip
3577 % will keep entries from bumping into each other. Table will start at
3578 % left margin and final column will justify at right margin.
3580 % Make sure we don't inherit \rightskip from the outer environment.
3583 % The first column will be indented with the surrounding text.
3584 \advance\hsize by\leftskip
3587 % If user has not set preamble in terms of percent of \hsize
3588 % we will advance \hsize by \multitablecolspace.
3589 \advance\hsize by \multitablecolspace
3591 % In either case we will make \leftskip=\multitablecolspace:
3592 \leftskip=\multitablecolspace
3594 % Ignoring space at the beginning and end avoids an occasional spurious
3595 % blank line, when TeX decides to break the line at the space before the
3596 % box from the multistrut, so the strut ends up on a line by itself.
3598 % @multitable @columnfractions .11 .89
3600 % @tab Legal holiday which is valid in major parts of the whole country.
3601 % Is automatically provided with highlighting sequences respectively
3602 % marking characters.
3603 \noindent\ignorespaces##\unskip\multistrut
3608 \egroup % end the \halign
3609 \global\setpercentfalse
3612 \def\setmultitablespacing{%
3613 \def\multistrut{\strut}% just use the standard line spacing
3615 % Compute \multitablelinespace (if not defined by user) for use in
3616 % \multitableparskip calculation. We used define \multistrut based on
3617 % this, but (ironically) that caused the spacing to be off.
3618 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3619 \ifdim\multitablelinespace=0pt
3620 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3621 \global\advance\multitablelinespace by-\ht0
3623 %% Test to see if parskip is larger than space between lines of
3624 %% table. If not, do nothing.
3625 %% If so, set to same dimension as multitablelinespace.
3626 \ifdim\multitableparskip>\multitablelinespace
3627 \global\multitableparskip=\multitablelinespace
3628 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3629 %% than skip between lines in the table.
3631 \ifdim\multitableparskip=0pt
3632 \global\multitableparskip=\multitablelinespace
3633 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3634 %% than skip between lines in the table.
3638 \message{conditionals,}
3640 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3641 % @ifnotxml always succeed. They currently do nothing; we don't
3642 % attempt to check whether the conditionals are properly nested. But we
3643 % have to remember that they are conditionals, so that @end doesn't
3644 % attempt to close an environment group.
3647 \expandafter\let\csname #1\endcsname = \relax
3648 \expandafter\let\csname iscond.#1\endcsname = 1
3651 \makecond{ifnotdocbook}
3652 \makecond{ifnothtml}
3653 \makecond{ifnotinfo}
3654 \makecond{ifnotplaintext}
3657 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3659 \def\direntry{\doignore{direntry}}
3660 \def\documentdescription{\doignore{documentdescription}}
3661 \def\docbook{\doignore{docbook}}
3662 \def\html{\doignore{html}}
3663 \def\ifdocbook{\doignore{ifdocbook}}
3664 \def\ifhtml{\doignore{ifhtml}}
3665 \def\ifinfo{\doignore{ifinfo}}
3666 \def\ifnottex{\doignore{ifnottex}}
3667 \def\ifplaintext{\doignore{ifplaintext}}
3668 \def\ifxml{\doignore{ifxml}}
3669 \def\ignore{\doignore{ignore}}
3670 \def\menu{\doignore{menu}}
3671 \def\xml{\doignore{xml}}
3673 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3675 % A count to remember the depth of nesting.
3676 \newcount\doignorecount
3678 \def\doignore#1{\begingroup
3679 % Scan in ``verbatim'' mode:
3681 \catcode`\@ = \other
3682 \catcode`\{ = \other
3683 \catcode`\} = \other
3685 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3688 % Count number of #1's that we've seen.
3691 % Swallow text until we reach the matching `@end #1'.
3695 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3698 \gdef\dodoignore#1{%
3699 % #1 contains the command name as a string, e.g., `ifinfo'.
3701 % Define a command to find the next `@end #1'.
3702 \long\def\doignoretext##1^^M@end #1{%
3703 \doignoretextyyy##1^^M@#1\_STOP_}%
3705 % And this command to find another #1 command, at the beginning of a
3706 % line. (Otherwise, we would consider a line `@c @ifset', for
3707 % example, to count as an @ifset for nesting.)
3708 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3710 % And now expand that command.
3715 \def\doignoreyyy#1{%
3717 \ifx\temp\empty % Nothing found.
3718 \let\next\doignoretextzzz
3719 \else % Found a nested condition, ...
3720 \advance\doignorecount by 1
3721 \let\next\doignoretextyyy % ..., look for another.
3722 % If we're here, #1 ends with ^^M\ifinfo (for example).
3724 \next #1% the token \_STOP_ is present just after this macro.
3727 % We have to swallow the remaining "\_STOP_".
3729 \def\doignoretextzzz#1{%
3730 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3731 \let\next\enddoignore
3732 \else % Still inside a nested condition.
3733 \advance\doignorecount by -1
3734 \let\next\doignoretext % Look for the next @end.
3739 % Finish off ignored text.
3741 % Ignore anything after the last `@end #1'; this matters in verbatim
3742 % environments, where otherwise the newline after an ignored conditional
3743 % would result in a blank line in the output.
3744 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3748 % @set VAR sets the variable VAR to an empty value.
3749 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3751 % Since we want to separate VAR from REST-OF-LINE (which might be
3752 % empty), we can't just use \parsearg; we have to insert a space of our
3753 % own to delimit the rest of the line, and then take it out again if we
3755 % We rely on the fact that \parsearg sets \catcode`\ =10.
3757 \parseargdef\set{\setyyy#1 \endsetyyy}
3758 \def\setyyy#1 #2\endsetyyy{%
3760 \makevalueexpandable
3762 \edef\next{\gdef\makecsname{SET#1}}%
3770 % Remove the trailing space \setxxx inserted.
3771 \def\setzzz#1 \endsetzzz{\next{#1}}
3773 % @clear VAR clears (i.e., unsets) the variable VAR.
3775 \parseargdef\clear{%
3777 \makevalueexpandable
3778 \global\expandafter\let\csname SET#1\endcsname=\relax
3782 % @value{foo} gets the text saved in variable foo.
3783 \def\value{\begingroup\makevalueexpandable\valuexxx}
3784 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3786 \catcode`\- = \active \catcode`\_ = \active
3788 \gdef\makevalueexpandable{%
3789 \let\value = \expandablevalue
3790 % We don't want these characters active, ...
3791 \catcode`\-=\other \catcode`\_=\other
3792 % ..., but we might end up with active ones in the argument if
3793 % we're called from @code, as @code{@value{foo-bar_}}, though.
3794 % So \let them to their normal equivalents.
3795 \let-\realdash \let_\normalunderscore
3799 % We have this subroutine so that we can handle at least some @value's
3800 % properly in indexes (we call \makevalueexpandable in \indexdummies).
3801 % The command has to be fully expandable (if the variable is set), since
3802 % the result winds up in the index file. This means that if the
3803 % variable's value contains other Texinfo commands, it's almost certain
3804 % it will fail (although perhaps we could fix that with sufficient work
3805 % to do a one-level expansion on the result, instead of complete).
3807 \def\expandablevalue#1{%
3808 \expandafter\ifx\csname SET#1\endcsname\relax
3809 {[No value for ``#1'']}%
3810 \message{Variable `#1', used in @value, is not set.}%
3812 \csname SET#1\endcsname
3816 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
3819 % To get special treatment of `@end ifset,' call \makeond and the redefine.
3822 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
3825 \makevalueexpandable
3827 \expandafter\ifx\csname SET#2\endcsname\relax
3828 #1% If not set, redefine \next.
3833 \def\ifsetfail{\doignore{ifset}}
3835 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
3836 % defined with @set, or has been undefined with @clear.
3838 % The `\else' inside the `\doifset' parameter is a trick to reuse the
3839 % above code: if the variable is not set, do nothing, if it is set,
3840 % then redefine \next to \ifclearfail.
3843 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
3844 \def\ifclearfail{\doignore{ifclear}}
3846 % @dircategory CATEGORY -- specify a category of the dir file
3847 % which this file should belong to. Ignore this in TeX.
3848 \let\dircategory=\comment
3850 % @defininfoenclose.
3851 \let\definfoenclose=\comment
3855 % Index generation facilities
3857 % Define \newwrite to be identical to plain tex's \newwrite
3858 % except not \outer, so it can be used within macros and \if's.
3859 \edef\newwrite{\makecsname{ptexnewwrite}}
3861 % \newindex {foo} defines an index named foo.
3862 % It automatically defines \fooindex such that
3863 % \fooindex ...rest of line... puts an entry in the index foo.
3864 % It also defines \fooindfile to be the number of the output channel for
3865 % the file that accumulates this index. The file's extension is foo.
3866 % The name of an index should be no more than 2 characters long
3867 % for the sake of vms.
3871 \expandafter\newwrite \csname#1indfile\endcsname
3872 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
3874 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
3875 \noexpand\doindex{#1}}
3878 % @defindex foo == \newindex{foo}
3880 \def\defindex{\parsearg\newindex}
3882 % Define @defcodeindex, like @defindex except put all entries in @code.
3884 \def\defcodeindex{\parsearg\newcodeindex}
3886 \def\newcodeindex#1{%
3888 \expandafter\newwrite \csname#1indfile\endcsname
3889 \openout \csname#1indfile\endcsname \jobname.#1
3891 \expandafter\xdef\csname#1index\endcsname{%
3892 \noexpand\docodeindex{#1}}%
3896 % @synindex foo bar makes index foo feed into index bar.
3897 % Do this instead of @defindex foo if you don't want it as a separate index.
3899 % @syncodeindex foo bar similar, but put all entries made for index foo
3902 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
3903 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
3905 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
3906 % #3 the target index (bar).
3907 \def\dosynindex#1#2#3{%
3908 % Only do \closeout if we haven't already done it, else we'll end up
3909 % closing the target index.
3910 \expandafter \ifx\csname donesynindex#2\endcsname \relax
3911 % The \closeout helps reduce unnecessary open files; the limit on the
3912 % Acorn RISC OS is a mere 16 files.
3913 \expandafter\closeout\csname#2indfile\endcsname
3914 \expandafter\let\csname donesynindex#2\endcsname = 1
3916 % redefine \fooindfile:
3917 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
3918 \expandafter\let\csname#2indfile\endcsname=\temp
3919 % redefine \fooindex:
3920 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
3923 % Define \doindex, the driver for all \fooindex macros.
3924 % Argument #1 is generated by the calling \fooindex macro,
3925 % and it is "foo", the name of the index.
3927 % \doindex just uses \parsearg; it calls \doind for the actual work.
3928 % This is because \doind is more useful to call from other macros.
3930 % There is also \dosubind {index}{topic}{subtopic}
3931 % which makes an entry in a two-level index such as the operation index.
3933 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
3934 \def\singleindexer #1{\doind{\indexname}{#1}}
3936 % like the previous two, but they put @code around the argument.
3937 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
3938 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
3940 % Take care of Texinfo commands that can appear in an index entry.
3941 % Since there are some commands we want to expand, and others we don't,
3942 % we have to laboriously prevent expansion for those that we don't.
3945 \escapechar = `\\ % use backslash in output files.
3946 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
3947 \def\ {\realbackslash\space }%
3949 % Need these in case \tex is in effect and \{ is a \delimiter again.
3950 % But can't use \lbracecmd and \rbracecmd because texindex assumes
3951 % braces and backslashes are used only as delimiters.
3955 % I don't entirely understand this, but when an index entry is
3956 % generated from a macro call, the \endinput which \scanmacro inserts
3957 % causes processing to be prematurely terminated. This is,
3958 % apparently, because \indexsorttmp is fully expanded, and \endinput
3959 % is an expandable command. The redefinition below makes \endinput
3960 % disappear altogether for that purpose -- although logging shows that
3961 % processing continues to some further point. On the other hand, it
3962 % seems \endinput does not hurt in the printed index arg, since that
3963 % is still getting written without apparent harm.
3965 % Sample source (mac-idx3.tex, reported by Graham Percival to
3966 % help-texinfo, 22may06):
3967 % @macro funindex {WORD}
3971 % @funindex commtest
3973 % The above is not enough to reproduce the bug, but it gives the flavor.
3975 % Sample whatsit resulting:
3976 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
3979 \let\endinput = \empty
3981 % Do the redefinitions.
3985 % For the aux and toc files, @ is the escape character. So we want to
3986 % redefine everything using @ as the escape character (instead of
3987 % \realbackslash, still used for index files). When everything uses @,
3988 % this will be simpler.
3993 \let\{ = \lbraceatcmd
3994 \let\} = \rbraceatcmd
3996 % Do the redefinitions.
4001 % Called from \indexdummies and \atdummies.
4003 \def\commondummies{%
4005 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4006 % preventing its expansion. This is used only for control% words,
4007 % not control letters, because the \space would be incorrect for
4008 % control characters, but is needed to separate the control word
4009 % from whatever follows.
4011 % For control letters, we have \definedummyletter, which omits the
4014 % These can be used both for control words that take an argument and
4015 % those that do not. If it is followed by {arg} in the input, then
4016 % that will dutifully get written to the index (or wherever).
4018 \def\definedummyword ##1{\def##1{\string##1\space}}%
4019 \def\definedummyletter##1{\def##1{\string##1}}%
4020 \let\definedummyaccent\definedummyletter
4022 \commondummiesnofonts
4024 \definedummyletter\_%
4026 % Non-English letters.
4038 \definedummyword\exclamdown
4039 \definedummyword\questiondown
4040 \definedummyword\ordf
4041 \definedummyword\ordm
4043 % Although these internal commands shouldn't show up, sometimes they do.
4045 \definedummyword\gtr
4046 \definedummyword\hat
4047 \definedummyword\less
4050 \definedummyword\tclose
4053 \definedummyword\LaTeX
4054 \definedummyword\TeX
4056 % Assorted special characters.
4057 \definedummyword\bullet
4058 \definedummyword\comma
4059 \definedummyword\copyright
4060 \definedummyword\registeredsymbol
4061 \definedummyword\dots
4062 \definedummyword\enddots
4063 \definedummyword\equiv
4064 \definedummyword\error
4065 \definedummyword\euro
4066 \definedummyword\guillemetleft
4067 \definedummyword\guillemetright
4068 \definedummyword\guilsinglleft
4069 \definedummyword\guilsinglright
4070 \definedummyword\expansion
4071 \definedummyword\minus
4072 \definedummyword\ogonek
4073 \definedummyword\pounds
4074 \definedummyword\point
4075 \definedummyword\print
4076 \definedummyword\quotedblbase
4077 \definedummyword\quotedblleft
4078 \definedummyword\quotedblright
4079 \definedummyword\quoteleft
4080 \definedummyword\quoteright
4081 \definedummyword\quotesinglbase
4082 \definedummyword\result
4083 \definedummyword\textdegree
4085 % We want to disable all macros so that they are not expanded by \write.
4088 \normalturnoffactive
4090 % Handle some cases of @value -- where it does not contain any
4091 % (non-fully-expandable) commands.
4092 \makevalueexpandable
4095 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4097 \def\commondummiesnofonts{%
4098 % Control letters and accents.
4099 \definedummyletter\!%
4100 \definedummyaccent\"%
4101 \definedummyaccent\'%
4102 \definedummyletter\*%
4103 \definedummyaccent\,%
4104 \definedummyletter\.%
4105 \definedummyletter\/%
4106 \definedummyletter\:%
4107 \definedummyaccent\=%
4108 \definedummyletter\?%
4109 \definedummyaccent\^%
4110 \definedummyaccent\`%
4111 \definedummyaccent\~%
4115 \definedummyword\dotaccent
4116 \definedummyword\ogonek
4117 \definedummyword\ringaccent
4118 \definedummyword\tieaccent
4119 \definedummyword\ubaraccent
4120 \definedummyword\udotaccent
4121 \definedummyword\dotless
4123 % Texinfo font commands.
4130 % Commands that take arguments.
4131 \definedummyword\acronym
4132 \definedummyword\cite
4133 \definedummyword\code
4134 \definedummyword\command
4135 \definedummyword\dfn
4136 \definedummyword\emph
4137 \definedummyword\env
4138 \definedummyword\file
4139 \definedummyword\kbd
4140 \definedummyword\key
4141 \definedummyword\math
4142 \definedummyword\option
4143 \definedummyword\pxref
4144 \definedummyword\ref
4145 \definedummyword\samp
4146 \definedummyword\strong
4147 \definedummyword\tie
4148 \definedummyword\uref
4149 \definedummyword\url
4150 \definedummyword\var
4151 \definedummyword\verb
4153 \definedummyword\xref
4156 % \indexnofonts is used when outputting the strings to sort the index
4157 % by, and when constructing control sequence names. It eliminates all
4158 % control sequences and just writes whatever the best ASCII sort string
4159 % would be for a given command (usually its argument).
4162 % Accent commands should become @asis.
4163 \def\definedummyaccent##1{\let##1\asis}%
4164 % We can just ignore other control letters.
4165 \def\definedummyletter##1{\let##1\empty}%
4166 % Hopefully, all control words can become @asis.
4167 \let\definedummyword\definedummyaccent
4169 \commondummiesnofonts
4171 % Don't no-op \tt, since it isn't a user-level command
4172 % and is used in the definitions of the active chars like <, >, |, etc.
4173 % Likewise with the other plain tex font commands.
4178 % how to handle braces?
4179 \def\_{\normalunderscore}%
4181 % Non-English letters.
4194 \def\questiondown{?}%
4201 % Assorted special characters.
4202 % (The following {} will end up in the sort string, but that's ok.)
4203 \def\bullet{bullet}%
4205 \def\copyright{copyright}%
4206 \def\registeredsymbol{R}%
4212 \def\guillemetleft{<<}%
4213 \def\guillemetright{>>}%
4214 \def\guilsinglleft{<}%
4215 \def\guilsinglright{>}%
4216 \def\expansion{==>}%
4218 \def\pounds{pounds}%
4221 \def\quotedblbase{"}%
4222 \def\quotedblleft{"}%
4223 \def\quotedblright{"}%
4226 \def\quotesinglbase{,}%
4228 \def\textdegree{degrees}%
4230 % We need to get rid of all macros, leaving only the arguments (if present).
4231 % Of course this is not nearly correct, but it is the best we can do for now.
4232 % makeinfo does not expand macros in the argument to @deffn, which ends up
4233 % writing an index entry, and texindex isn't prepared for an index sort entry
4234 % that starts with \.
4236 % Since macro invocations are followed by braces, we can just redefine them
4237 % to take a single TeX argument. The case of a macro invocation that
4238 % goes to end-of-line is not handled.
4243 \let\indexbackslash=0 %overridden during \printindex.
4244 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4246 % Most index entries go through here, but \dosubind is the general case.
4247 % #1 is the index name, #2 is the entry text.
4248 \def\doind#1#2{\dosubind{#1}{#2}{}}
4250 % Workhorse for all \fooindexes.
4251 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4252 % empty if called from \doind, as we usually are (the main exception
4253 % is with most defuns, which call us directly).
4255 \def\dosubind#1#2#3{%
4258 % Store the main index entry text (including the third arg).
4260 % If third arg is present, precede it with a space.
4262 \ifx\thirdarg\empty \else
4263 \toks0 = \expandafter{\the\toks0 \space #3}%
4266 \edef\writeto{\csname#1indfile\endcsname}%
4268 \safewhatsit\dosubindwrite
4273 % Write the entry in \toks0 to the index file:
4275 \def\dosubindwrite{%
4276 % Put the index entry in the margin if desired.
4277 \ifx\SETmarginindex\relax\else
4278 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4281 % Remember, we are within a group.
4282 \indexdummies % Must do this here, since \bf, etc expand at this stage
4283 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4284 % so it will be output as is; and it will print as backslash.
4286 % Process the index entry with all font commands turned off, to
4287 % get the string to sort by.
4289 \edef\temp{\the\toks0}% need full expansion
4290 \xdef\indexsorttmp{\temp}%
4293 % Set up the complete index entry, with both the sort key and
4294 % the original text, including any font commands. We write
4295 % three arguments to \entry to the .?? file (four in the
4296 % subentry case), texindex reduces to two when writing the .??s
4300 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4305 % Take care of unwanted page breaks/skips around a whatsit:
4307 % If a skip is the last thing on the list now, preserve it
4308 % by backing up by \lastskip, doing the \write, then inserting
4309 % the skip again. Otherwise, the whatsit generated by the
4310 % \write or \pdfdest will make \lastskip zero. The result is that
4311 % sequences like this:
4315 % will have extra space inserted, because the \medbreak in the
4316 % start of the @defun won't see the skip inserted by the @end of
4317 % the previous defun.
4319 % But don't do any of this if we're not in vertical mode. We
4320 % don't want to do a \vskip and prematurely end a paragraph.
4322 % Avoid page breaks due to these extra skips, too.
4324 % But wait, there is a catch there:
4325 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4326 % sufficient for this purpose, as it ignores stretch and shrink parts
4327 % of the skip. The only way seems to be to check the textual
4328 % representation of the skip.
4330 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4331 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4333 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4335 \newskip\whatsitskip
4336 \newcount\whatsitpenalty
4340 \def\safewhatsit#1{%
4342 % The \unskip is in case we are preceded by glue; we don't want to
4343 % allow a line break just before us. For example, if a paragraph
4344 % happens to end perfectly justified and the next line is
4346 % (with no blank line preceding), our whatsit would end up on a line
4347 % by itself, appearing as a spurious blank line in the output.
4351 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4352 \whatsitskip = \lastskip
4353 \edef\lastskipmacro{\the\lastskip}%
4354 \whatsitpenalty = \lastpenalty
4356 % If \lastskip is nonzero, that means the last item was a
4357 % skip. And since a skip is discardable, that means this
4358 % -\whatsitskip glue we're inserting is preceded by a
4359 % non-discardable item, therefore it is not a potential
4360 % breakpoint, therefore no \nobreak needed.
4361 \ifx\lastskipmacro\zeroskipmacro
4368 \ifx\lastskipmacro\zeroskipmacro
4369 % If \lastskip was zero, perhaps the last item was a penalty, and
4370 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4371 % to re-insert the same penalty (values >10000 are used for various
4372 % signals); since we just inserted a non-discardable item, any
4373 % following glue (such as a \parskip) would be a breakpoint. For example:
4375 % @deffn deffn-whatever
4376 % @vindex index-whatever
4378 % would allow a break between the index-whatever whatsit
4379 % and the "Description." paragraph.
4380 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4382 % On the other hand, if we had a nonzero \lastskip,
4383 % this make-up glue would be preceded by a non-discardable item
4384 % (the whatsit from the \write), so we must insert a \nobreak.
4385 \nobreak\vskip\whatsitskip
4390 % The index entry written in the file actually looks like
4391 % \entry {sortstring}{page}{topic}
4393 % \entry {sortstring}{page}{topic}{subtopic}
4394 % The texindex program reads in these files and writes files
4395 % containing these kinds of lines:
4397 % before the first topic whose initial is c
4398 % \entry {topic}{pagelist}
4399 % for a topic that is used without subtopics
4401 % for the beginning of a topic that is used with subtopics
4402 % \secondary {subtopic}{pagelist}
4403 % for each subtopic.
4405 % Define the user-accessible indexing commands
4406 % @findex, @vindex, @kindex, @cindex.
4408 \def\findex {\fnindex}
4409 \def\kindex {\kyindex}
4410 \def\cindex {\cpindex}
4411 \def\vindex {\vrindex}
4412 \def\tindex {\tpindex}
4413 \def\pindex {\pgindex}
4415 \def\cindexsub {\begingroup\obeylines\cindexsub}
4417 \gdef\cindexsub "#1" #2^^M{\endgroup %
4418 \dosubind{cp}{#2}{#1}}}
4420 % Define the macros used in formatting output of the sorted index material.
4422 % @printindex causes a particular index (the ??s file) to get printed.
4423 % It does not print any chapter heading (usually an @unnumbered).
4425 \parseargdef\printindex{\begingroup
4426 \dobreak \chapheadingskip{10000}%
4431 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4433 % See if the index file exists and is nonempty.
4434 % Change catcode of @ here so that if the index file contains
4436 % as its first line, TeX doesn't complain about mismatched braces
4437 % (because it thinks @} is a control sequence).
4439 \openin 1 \jobname.#1s
4441 % \enddoublecolumns gets confused if there is no text in the index,
4442 % and it loses the chapter title and the aux file entries for the
4443 % index. The easiest way to prevent this problem is to make sure
4444 % there is some text.
4445 \putwordIndexNonexistent
4448 % If the index file exists but is empty, then \openin leaves \ifeof
4449 % false. We have to make TeX try to read something from the file, so
4450 % it can discover if there is anything in it.
4453 \putwordIndexIsEmpty
4455 % Index files are almost Texinfo source, but we use \ as the escape
4456 % character. It would be better to use @, but that's too big a change
4457 % to make right now.
4458 \def\indexbackslash{\backslashcurfont}%
4469 % These macros are used by the sorted index file itself.
4470 % Change them to control the appearance of the index.
4473 % Some minor font changes for the special characters.
4474 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4476 % Remove any glue we may have, we'll be inserting our own.
4479 % We like breaks before the index initials, so insert a bonus.
4481 \vskip 0pt plus 3\baselineskip
4483 \vskip 0pt plus -3\baselineskip
4485 % Typeset the initial. Making this add up to a whole number of
4486 % baselineskips increases the chance of the dots lining up from column
4487 % to column. It still won't often be perfect, because of the stretch
4488 % we need before each entry, but it's better.
4490 % No shrink because it confuses \balancecolumns.
4491 \vskip 1.67\baselineskip plus .5\baselineskip
4492 \leftline{\secbf #1}%
4493 % Do our best not to break after the initial.
4495 \vskip .33\baselineskip plus .1\baselineskip
4498 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4499 % then page number (#2) flushed to the right margin. It is used for index
4500 % and table of contents entries. The paragraph is indented by \leftskip.
4502 % A straightforward implementation would start like this:
4503 % \def\entry#1#2{...
4504 % But this freezes the catcodes in the argument, and can cause problems to
4505 % @code, which sets - active. This problem was fixed by a kludge---
4506 % ``-'' was active throughout whole index, but this isn't really right.
4508 % The right solution is to prevent \entry from swallowing the whole text.
4513 % Start a new paragraph if necessary, so our assignments below can't
4514 % affect previous text.
4517 % Do not fill out the last line with white space.
4520 % No extra space above this paragraph.
4523 % Do not prefer a separate line ending with a hyphen to fewer lines.
4524 \finalhyphendemerits = 0
4526 % \hangindent is only relevant when the entry text and page number
4527 % don't both fit on one line. In that case, bob suggests starting the
4528 % dots pretty far over on the line. Unfortunately, a large
4529 % indentation looks wrong when the entry text itself is broken across
4530 % lines. So we use a small indentation and put up with long leaders.
4532 % \hangafter is reset to 1 (which is the value we want) at the start
4533 % of each paragraph, so we need not do anything with that.
4536 % When the entry text needs to be broken, just fill out the first line
4538 \rightskip = 0pt plus1fil
4540 % A bit of stretch before each entry for the benefit of balancing
4544 % Swallow the left brace of the text (first parameter):
4545 \afterassignment\doentry
4549 \bgroup % Instead of the swallowed brace.
4551 \aftergroup\finishentry
4552 % And now comes the text of the entry.
4554 \def\finishentry#1{%
4555 % #1 is the page number.
4557 % The following is kludged to not output a line of dots in the index if
4558 % there are no page numbers. The next person who breaks this will be
4559 % cursed by a Unix daemon.
4560 \setbox\boxA = \hbox{#1}%
4561 \ifdim\wd\boxA = 0pt
4565 % If we must, put the page number on a line of its own, and fill out
4566 % this line with blank space. (The \hfil is overwhelmed with the
4567 % fill leaders glue in \indexdotfill if the page number does fit.)
4569 \null\nobreak\indexdotfill % Have leaders before the page number.
4571 % The `\ ' here is removed by the implicit \unskip that TeX does as
4572 % part of (the primitive) \par. Without it, a spurious underfull
4585 % Like plain.tex's \dotfill, except uses up at least 1 em.
4586 \def\indexdotfill{\cleaders
4587 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4589 \def\primary #1{\line{#1\hfil}}
4591 \newskip\secondaryindent \secondaryindent=0.5cm
4592 \def\secondary#1#2{{%
4597 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4599 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4606 % Define two-column mode, which we use to typeset indexes.
4607 % Adapted from the TeXbook, page 416, which is to say,
4608 % the manmac.tex format used to print the TeXbook itself.
4612 \newdimen\doublecolumnhsize
4614 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4615 % Grab any single-column material above us.
4618 % Here is a possibility not foreseen in manmac: if we accumulate a
4619 % whole lot of material, we might end up calling this \output
4620 % routine twice in a row (see the doublecol-lose test, which is
4621 % essentially a couple of indexes with @setchapternewpage off). In
4622 % that case we just ship out what is in \partialpage with the normal
4623 % output routine. Generally, \partialpage will be empty when this
4624 % runs and this will be a no-op. See the indexspread.tex test case.
4625 \ifvoid\partialpage \else
4626 \onepageout{\pagecontents\partialpage}%
4629 \global\setbox\partialpage = \vbox{%
4630 % Unvbox the main output page.
4632 \kern-\topskip \kern\baselineskip
4635 \eject % run that output routine to set \partialpage
4637 % Use the double-column output routine for subsequent pages.
4638 \output = {\doublecolumnout}%
4640 % Change the page size parameters. We could do this once outside this
4641 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4642 % format, but then we repeat the same computation. Repeating a couple
4643 % of assignments once per index is clearly meaningless for the
4644 % execution time, so we may as well do it in one place.
4646 % First we halve the line length, less a little for the gutter between
4647 % the columns. We compute the gutter based on the line length, so it
4648 % changes automatically with the paper format. The magic constant
4649 % below is chosen so that the gutter has the same value (well, +-<1pt)
4650 % as it did when we hard-coded it.
4652 % We put the result in a separate register, \doublecolumhsize, so we
4653 % can restore it in \pagesofar, after \hsize itself has (potentially)
4656 \doublecolumnhsize = \hsize
4657 \advance\doublecolumnhsize by -.04154\hsize
4658 \divide\doublecolumnhsize by 2
4659 \hsize = \doublecolumnhsize
4661 % Double the \vsize as well. (We don't need a separate register here,
4662 % since nobody clobbers \vsize.)
4666 % The double-column output routine for all double-column pages except
4669 \def\doublecolumnout{%
4670 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4671 % Get the available space for the double columns -- the normal
4672 % (undoubled) page height minus any material left over from the
4676 \advance\dimen@ by -\ht\partialpage
4678 % box0 will be the left-hand column, box2 the right.
4679 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4680 \onepageout\pagesofar
4682 \penalty\outputpenalty
4685 % Re-output the contents of the output page -- any previous material,
4686 % followed by the two boxes we just split, in box0 and box2.
4690 \hsize = \doublecolumnhsize
4691 \wd0=\hsize \wd2=\hsize
4692 \hbox to\pagewidth{\box0\hfil\box2}%
4695 % All done with double columns.
4696 \def\enddoublecolumns{%
4697 % The following penalty ensures that the page builder is exercised
4698 % _before_ we change the output routine. This is necessary in the
4699 % following situation:
4701 % The last section of the index consists only of a single entry.
4702 % Before this section, \pagetotal is less than \pagegoal, so no
4703 % break occurs before the last section starts. However, the last
4704 % section, consisting of \initial and the single \entry, does not
4705 % fit on the page and has to be broken off. Without the following
4706 % penalty the page builder will not be exercised until \eject
4707 % below, and by that time we'll already have changed the output
4708 % routine to the \balancecolumns version, so the next-to-last
4709 % double-column page will be processed with \balancecolumns, which
4710 % is wrong: The two columns will go to the main vertical list, with
4711 % the broken-off section in the recent contributions. As soon as
4712 % the output routine finishes, TeX starts reconsidering the page
4713 % break. The two columns and the broken-off section both fit on the
4714 % page, because the two columns now take up only half of the page
4715 % goal. When TeX sees \eject from below which follows the final
4716 % section, it invokes the new output routine that we've set after
4717 % \balancecolumns below; \onepageout will try to fit the two columns
4718 % and the final section into the vbox of \pageheight (see
4719 % \pagebody), causing an overfull box.
4721 % Note that glue won't work here, because glue does not exercise the
4722 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4726 % Split the last of the double-column material. Leave it on the
4727 % current page, no automatic page break.
4730 % If we end up splitting too much material for the current page,
4731 % though, there will be another page break right after this \output
4732 % invocation ends. Having called \balancecolumns once, we do not
4733 % want to call it again. Therefore, reset \output to its normal
4734 % definition right away. (We hope \balancecolumns will never be
4735 % called on to balance too much material, but if it is, this makes
4736 % the output somewhat more palatable.)
4737 \global\output = {\onepageout{\pagecontents\PAGE}}%
4740 \endgroup % started in \begindoublecolumns
4742 % \pagegoal was set to the doubled \vsize above, since we restarted
4743 % the current page. We're now back to normal single-column
4744 % typesetting, so reset \pagegoal to the normal \vsize (after the
4745 % \endgroup where \vsize got restored).
4749 % Called at the end of the double column material.
4750 \def\balancecolumns{%
4751 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4753 \advance\dimen@ by \topskip
4754 \advance\dimen@ by-\baselineskip
4755 \divide\dimen@ by 2 % target to split to
4756 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4757 \splittopskip = \topskip
4758 % Loop until we get a decent breakpoint.
4762 \global\setbox3 = \copy0
4763 \global\setbox1 = \vsplit3 to \dimen@
4765 \global\advance\dimen@ by 1pt
4768 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4769 \setbox0=\vbox to\dimen@{\unvbox1}%
4770 \setbox2=\vbox to\dimen@{\unvbox3}%
4774 \catcode`\@ = \other
4777 \message{sectioning,}
4778 % Chapters, sections, etc.
4780 % \unnumberedno is an oxymoron, of course. But we count the unnumbered
4781 % sections so that we can refer to them unambiguously in the pdf
4782 % outlines by their "section number". We avoid collisions with chapter
4783 % numbers by starting them at 10000. (If a document ever has 10000
4784 % chapters, we're in trouble anyway, I'm sure.)
4785 \newcount\unnumberedno \unnumberedno = 10000
4787 \newcount\secno \secno=0
4788 \newcount\subsecno \subsecno=0
4789 \newcount\subsubsecno \subsubsecno=0
4791 % This counter is funny since it counts through charcodes of letters A, B, ...
4792 \newcount\appendixno \appendixno = `\@
4794 % \def\appendixletter{\char\the\appendixno}
4795 % We do the following ugly conditional instead of the above simple
4796 % construct for the sake of pdftex, which needs the actual
4797 % letter in the expansion, not just typeset.
4799 \def\appendixletter{%
4800 \ifnum\appendixno=`A A%
4801 \else\ifnum\appendixno=`B B%
4802 \else\ifnum\appendixno=`C C%
4803 \else\ifnum\appendixno=`D D%
4804 \else\ifnum\appendixno=`E E%
4805 \else\ifnum\appendixno=`F F%
4806 \else\ifnum\appendixno=`G G%
4807 \else\ifnum\appendixno=`H H%
4808 \else\ifnum\appendixno=`I I%
4809 \else\ifnum\appendixno=`J J%
4810 \else\ifnum\appendixno=`K K%
4811 \else\ifnum\appendixno=`L L%
4812 \else\ifnum\appendixno=`M M%
4813 \else\ifnum\appendixno=`N N%
4814 \else\ifnum\appendixno=`O O%
4815 \else\ifnum\appendixno=`P P%
4816 \else\ifnum\appendixno=`Q Q%
4817 \else\ifnum\appendixno=`R R%
4818 \else\ifnum\appendixno=`S S%
4819 \else\ifnum\appendixno=`T T%
4820 \else\ifnum\appendixno=`U U%
4821 \else\ifnum\appendixno=`V V%
4822 \else\ifnum\appendixno=`W W%
4823 \else\ifnum\appendixno=`X X%
4824 \else\ifnum\appendixno=`Y Y%
4825 \else\ifnum\appendixno=`Z Z%
4826 % The \the is necessary, despite appearances, because \appendixletter is
4827 % expanded while writing the .toc file. \char\appendixno is not
4828 % expandable, thus it is written literally, thus all appendixes come out
4829 % with the same letter (or @) in the toc without it.
4830 \else\char\the\appendixno
4831 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
4832 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
4834 % Each @chapter defines these (using marks) as the number+name, number
4835 % and name of the chapter. Page headings and footings can use
4836 % these. @section does likewise.
4838 \def\thischapternum{}
4839 \def\thischaptername{}
4841 \def\thissectionnum{}
4842 \def\thissectionname{}
4844 \newcount\absseclevel % used to calculate proper heading level
4845 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
4847 % @raisesections: treat @section as chapter, @subsection as section, etc.
4848 \def\raisesections{\global\advance\secbase by -1}
4849 \let\up=\raisesections % original BFox name
4851 % @lowersections: treat @chapter as section, @section as subsection, etc.
4852 \def\lowersections{\global\advance\secbase by 1}
4853 \let\down=\lowersections % original BFox name
4855 % we only have subsub.
4856 \chardef\maxseclevel = 3
4858 % A numbered section within an unnumbered changes to unnumbered too.
4859 % To achive this, remember the "biggest" unnum. sec. we are currently in:
4860 \chardef\unmlevel = \maxseclevel
4862 % Trace whether the current chapter is an appendix or not:
4863 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
4864 \def\chapheadtype{N}
4866 % Choose a heading macro
4867 % #1 is heading type
4868 % #2 is heading level
4869 % #3 is text for heading
4870 \def\genhead#1#2#3{%
4871 % Compute the abs. sec. level:
4873 \advance\absseclevel by \secbase
4874 % Make sure \absseclevel doesn't fall outside the range:
4875 \ifnum \absseclevel < 0
4878 \ifnum \absseclevel > 3
4885 \ifnum \absseclevel < \unmlevel
4886 \chardef\unmlevel = \absseclevel
4889 % Check for appendix sections:
4890 \ifnum \absseclevel = 0
4891 \edef\chapheadtype{\headtype}%
4893 \if \headtype A\if \chapheadtype N%
4894 \errmessage{@appendix... within a non-appendix chapter}%
4897 % Check for numbered within unnumbered:
4898 \ifnum \absseclevel > \unmlevel
4901 \chardef\unmlevel = 3
4904 % Now print the heading:
4908 \or \unnumberedseczzz{#3}%
4909 \or \unnumberedsubseczzz{#3}%
4910 \or \unnumberedsubsubseczzz{#3}%
4916 \or \appendixsectionzzz{#3}%
4917 \or \appendixsubseczzz{#3}%
4918 \or \appendixsubsubseczzz{#3}%
4924 \or \numberedsubseczzz{#3}%
4925 \or \numberedsubsubseczzz{#3}%
4929 \suppressfirstparagraphindent
4933 \def\numhead{\genhead N}
4934 \def\apphead{\genhead A}
4935 \def\unnmhead{\genhead U}
4937 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
4938 % all lower-level sectioning counters to zero.
4940 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
4941 % (e.g., figures), q.v. By default (before any chapter), that is empty.
4942 \let\chaplevelprefix = \empty
4944 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
4946 % section resetting is \global in case the chapter is in a group, such
4947 % as an @include file.
4948 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4949 \global\advance\chapno by 1
4952 \gdef\chaplevelprefix{\the\chapno.}%
4955 \message{\putwordChapter\space \the\chapno}%
4957 % Write the actual heading.
4958 \chapmacro{#1}{Ynumbered}{\the\chapno}%
4960 % So @section and the like are numbered underneath this chapter.
4961 \global\let\section = \numberedsec
4962 \global\let\subsection = \numberedsubsec
4963 \global\let\subsubsection = \numberedsubsubsec
4966 \outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz
4967 \def\appendixzzz#1{%
4968 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4969 \global\advance\appendixno by 1
4970 \gdef\chaplevelprefix{\appendixletter.}%
4973 \def\appendixnum{\putwordAppendix\space \appendixletter}%
4974 \message{\appendixnum}%
4976 \chapmacro{#1}{Yappendix}{\appendixletter}%
4978 \global\let\section = \appendixsec
4979 \global\let\subsection = \appendixsubsec
4980 \global\let\subsubsection = \appendixsubsubsec
4983 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
4984 \def\unnumberedzzz#1{%
4985 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
4986 \global\advance\unnumberedno by 1
4988 % Since an unnumbered has no number, no prefix for figures.
4989 \global\let\chaplevelprefix = \empty
4992 % This used to be simply \message{#1}, but TeX fully expands the
4993 % argument to \message. Therefore, if #1 contained @-commands, TeX
4994 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
4995 % expanded @cite (which turns out to cause errors because \cite is meant
4996 % to be executed, not expanded).
4998 % Anyway, we don't want the fully-expanded definition of @cite to appear
4999 % as a result of the \message, we just want `@cite' itself. We use
5000 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5001 % simply yielding the contents of <toks register>. (We also do this for
5004 \message{(\the\toks0)}%
5006 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5008 \global\let\section = \unnumberedsec
5009 \global\let\subsection = \unnumberedsubsec
5010 \global\let\subsubsection = \unnumberedsubsubsec
5013 % @centerchap is like @unnumbered, but the heading is centered.
5014 \outer\parseargdef\centerchap{%
5015 % Well, we could do the following in a group, but that would break
5016 % an assumption that \chapmacro is called at the outermost level.
5017 % Thus we are safer this way: --kasal, 24feb04
5018 \let\centerparametersmaybe = \centerparameters
5020 \let\centerparametersmaybe = \relax
5023 % @top is like @unnumbered.
5027 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5029 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5030 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5033 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
5034 \def\appendixsectionzzz#1{%
5035 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5036 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5038 \let\appendixsec\appendixsection
5040 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
5041 \def\unnumberedseczzz#1{%
5042 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5043 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5047 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
5048 \def\numberedsubseczzz#1{%
5049 \global\subsubsecno=0 \global\advance\subsecno by 1
5050 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5053 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
5054 \def\appendixsubseczzz#1{%
5055 \global\subsubsecno=0 \global\advance\subsecno by 1
5056 \sectionheading{#1}{subsec}{Yappendix}%
5057 {\appendixletter.\the\secno.\the\subsecno}%
5060 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
5061 \def\unnumberedsubseczzz#1{%
5062 \global\subsubsecno=0 \global\advance\subsecno by 1
5063 \sectionheading{#1}{subsec}{Ynothing}%
5064 {\the\unnumberedno.\the\secno.\the\subsecno}%
5068 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
5069 \def\numberedsubsubseczzz#1{%
5070 \global\advance\subsubsecno by 1
5071 \sectionheading{#1}{subsubsec}{Ynumbered}%
5072 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5075 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
5076 \def\appendixsubsubseczzz#1{%
5077 \global\advance\subsubsecno by 1
5078 \sectionheading{#1}{subsubsec}{Yappendix}%
5079 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5082 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
5083 \def\unnumberedsubsubseczzz#1{%
5084 \global\advance\subsubsecno by 1
5085 \sectionheading{#1}{subsubsec}{Ynothing}%
5086 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5089 % These macros control what the section commands do, according
5090 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5091 % Define them by default for a numbered chapter.
5092 \let\section = \numberedsec
5093 \let\subsection = \numberedsubsec
5094 \let\subsubsection = \numberedsubsubsec
5096 % Define @majorheading, @heading and @subheading
5098 % NOTE on use of \vbox for chapter headings, section headings, and such:
5099 % 1) We use \vbox rather than the earlier \line to permit
5100 % overlong headings to fold.
5101 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5102 % heading is obnoxious; this forbids it.
5103 % 3) Likewise, headings look best if no \parindent is used, and
5104 % if justification is not attempted. Hence \raggedright.
5107 {\advance\chapheadingskip by 10pt \chapbreak }%
5108 \parsearg\chapheadingzzz
5111 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5112 \def\chapheadingzzz#1{%
5113 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5114 \parindent=0pt\raggedright
5115 \rmisbold #1\hfill}}%
5116 \bigskip \par\penalty 200\relax
5117 \suppressfirstparagraphindent
5120 % @heading, @subheading, @subsubheading.
5121 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5122 \suppressfirstparagraphindent}
5123 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5124 \suppressfirstparagraphindent}
5125 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5126 \suppressfirstparagraphindent}
5128 % These macros generate a chapter, section, etc. heading only
5129 % (including whitespace, linebreaking, etc. around it),
5130 % given all the information in convenient, parsed form.
5132 %%% Args are the skip and penalty (usually negative)
5133 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5135 %%% Define plain chapter starts, and page on/off switching for it
5136 % Parameter controlling skip before chapter headings (if needed)
5138 \newskip\chapheadingskip
5140 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5141 \def\chappager{\par\vfill\supereject}
5142 % Because \domark is called before \chapoddpage, the filler page will
5143 % get the headings for the next chapter, which is wrong. But we don't
5144 % care -- we just disable all headings on the filler page.
5149 \evenheadline={\hfil}\evenfootline={\hfil}%
5150 \oddheadline={\hfil}\oddfootline={\hfil}%
5157 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5160 \global\let\contentsalignmacro = \chappager
5161 \global\let\pchapsepmacro=\chapbreak
5162 \global\let\pagealignmacro=\chappager}
5165 \global\let\contentsalignmacro = \chappager
5166 \global\let\pchapsepmacro=\chappager
5167 \global\let\pagealignmacro=\chappager
5168 \global\def\HEADINGSon{\HEADINGSsingle}}
5171 \global\let\contentsalignmacro = \chapoddpage
5172 \global\let\pchapsepmacro=\chapoddpage
5173 \global\let\pagealignmacro=\chapoddpage
5174 \global\def\HEADINGSon{\HEADINGSdouble}}
5180 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5181 % Yappendix, Yomitfromtoc), #3 the chapter number.
5183 % To test against our argument.
5184 \def\Ynothingkeyword{Ynothing}
5185 \def\Yomitfromtockeyword{Yomitfromtoc}
5186 \def\Yappendixkeyword{Yappendix}
5188 \def\chapmacro#1#2#3{%
5189 % Insert the first mark before the heading break (see notes for \domark).
5190 \let\prevchapterdefs=\lastchapterdefs
5191 \let\prevsectiondefs=\lastsectiondefs
5192 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5193 \gdef\thissection{}}%
5196 \ifx\temptype\Ynothingkeyword
5197 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5198 \gdef\thischapter{\thischaptername}}%
5199 \else\ifx\temptype\Yomitfromtockeyword
5200 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5201 \gdef\thischapter{}}%
5202 \else\ifx\temptype\Yappendixkeyword
5204 \xdef\lastchapterdefs{%
5205 \gdef\noexpand\thischaptername{\the\toks0}%
5206 \gdef\noexpand\thischapternum{\appendixletter}%
5207 \gdef\noexpand\thischapter{\putwordAppendix{} \noexpand\thischapternum:
5208 \noexpand\thischaptername}%
5212 \xdef\lastchapterdefs{%
5213 \gdef\noexpand\thischaptername{\the\toks0}%
5214 \gdef\noexpand\thischapternum{\the\chapno}%
5215 \gdef\noexpand\thischapter{\putwordChapter{} \noexpand\thischapternum:
5216 \noexpand\thischaptername}%
5220 % Output the mark. Pass it through \safewhatsit, to take care of
5221 % the preceding space.
5224 % Insert the chapter heading break.
5227 % Now the second mark, after the heading break. No break points
5228 % between here and the heading.
5229 \let\prevchapterdefs=\lastchapterdefs
5230 \let\prevsectiondefs=\lastsectiondefs
5234 \chapfonts \rmisbold
5236 % Have to define \lastsection before calling \donoderef, because the
5237 % xref code eventually uses it. On the other hand, it has to be called
5238 % after \pchapsepmacro, or the headline will change too soon.
5239 \gdef\lastsection{#1}%
5241 % Only insert the separating space if we have a chapter/appendix
5242 % number, and don't print the unnumbered ``number''.
5243 \ifx\temptype\Ynothingkeyword
5245 \def\toctype{unnchap}%
5246 \else\ifx\temptype\Yomitfromtockeyword
5247 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5249 \else\ifx\temptype\Yappendixkeyword
5250 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5253 \setbox0 = \hbox{#3\enspace}%
5254 \def\toctype{numchap}%
5257 % Write the toc entry for this chapter. Must come before the
5258 % \donoderef, because we include the current node name in the toc
5259 % entry, and \donoderef resets it to empty.
5260 \writetocentry{\toctype}{#1}{#3}%
5262 % For pdftex, we have to write out the node definition (aka, make
5263 % the pdfdest) after any page break, but before the actual text has
5264 % been typeset. If the destination for the pdf outline is after the
5265 % text, then jumping from the outline may wind up with the text not
5266 % being visible, for instance under high magnification.
5269 % Typeset the actual heading.
5270 \nobreak % Avoid page breaks at the interline glue.
5271 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
5272 \hangindent=\wd0 \centerparametersmaybe
5275 \nobreak\bigskip % no page break after a chapter title
5279 % @centerchap -- centered and unnumbered.
5280 \let\centerparametersmaybe = \relax
5281 \def\centerparameters{%
5282 \advance\rightskip by 3\rightskip
5283 \leftskip = \rightskip
5288 % I don't think this chapter style is supported any more, so I'm not
5289 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5291 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5293 \def\unnchfopen #1{%
5294 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5295 \parindent=0pt\raggedright
5296 \rmisbold #1\hfill}}\bigskip \par\nobreak
5298 \def\chfopen #1#2{\chapoddpage {\chapfonts
5299 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5302 \def\centerchfopen #1{%
5303 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5305 \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
5308 \global\let\chapmacro=\chfopen
5309 \global\let\centerchapmacro=\centerchfopen}
5312 % Section titles. These macros combine the section number parts and
5313 % call the generic \sectionheading to do the printing.
5315 \newskip\secheadingskip
5316 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5318 % Subsection titles.
5319 \newskip\subsecheadingskip
5320 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5322 % Subsubsection titles.
5323 \def\subsubsecheadingskip{\subsecheadingskip}
5324 \def\subsubsecheadingbreak{\subsecheadingbreak}
5327 % Print any size, any type, section title.
5329 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5330 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5333 \def\seckeyword{sec}
5335 \def\sectionheading#1#2#3#4{%
5337 % Switch to the right set of fonts.
5338 \csname #2fonts\endcsname \rmisbold
5340 \def\sectionlevel{#2}%
5343 % Insert first mark before the heading break (see notes for \domark).
5344 \let\prevsectiondefs=\lastsectiondefs
5345 \ifx\temptype\Ynothingkeyword
5346 \ifx\sectionlevel\seckeyword
5347 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5348 \gdef\thissection{\thissectionname}}%
5350 \else\ifx\temptype\Yomitfromtockeyword
5351 % Don't redefine \thissection.
5352 \else\ifx\temptype\Yappendixkeyword
5353 \ifx\sectionlevel\seckeyword
5355 \xdef\lastsectiondefs{%
5356 \gdef\noexpand\thissectionname{\the\toks0}%
5357 \gdef\noexpand\thissectionnum{#4}%
5358 \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5359 \noexpand\thissectionname}%
5363 \ifx\sectionlevel\seckeyword
5365 \xdef\lastsectiondefs{%
5366 \gdef\noexpand\thissectionname{\the\toks0}%
5367 \gdef\noexpand\thissectionnum{#4}%
5368 \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum:
5369 \noexpand\thissectionname}%
5374 % Output the mark. Pass it through \safewhatsit, to take care of
5375 % the preceding space.
5378 % Insert space above the heading.
5379 \csname #2headingbreak\endcsname
5381 % Now the second mark, after the heading break. No break points
5382 % between here and the heading.
5383 \let\prevsectiondefs=\lastsectiondefs
5386 % Only insert the space after the number if we have a section number.
5387 \ifx\temptype\Ynothingkeyword
5390 \gdef\lastsection{#1}%
5391 \else\ifx\temptype\Yomitfromtockeyword
5392 % for @headings -- no section number, don't include in toc,
5393 % and don't redefine \lastsection.
5396 \let\sectionlevel=\empty
5397 \else\ifx\temptype\Yappendixkeyword
5398 \setbox0 = \hbox{#4\enspace}%
5400 \gdef\lastsection{#1}%
5402 \setbox0 = \hbox{#4\enspace}%
5404 \gdef\lastsection{#1}%
5407 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5408 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5410 % Write the node reference (= pdf destination for pdftex).
5411 % Again, see comments in \chapmacro.
5414 % Interline glue will be inserted when the vbox is completed.
5415 % That glue will be a valid breakpoint for the page, since it'll be
5416 % preceded by a whatsit (usually from the \donoderef, or from the
5417 % \writetocentry if there was no node). We don't want to allow that
5418 % break, since then the whatsits could end up on page n while the
5419 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5422 % Output the actual section heading.
5423 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright
5424 \hangindent=\wd0 % zero if no section number
5427 % Add extra space after the heading -- half of whatever came above it.
5428 % Don't allow stretch, though.
5429 \kern .5 \csname #2headingskip\endcsname
5431 % Do not let the kern be a potential breakpoint, as it would be if it
5432 % was followed by glue.
5435 % We'll almost certainly start a paragraph next, so don't let that
5436 % glue accumulate. (Not a breakpoint because it's preceded by a
5437 % discardable item.)
5440 % This is purely so the last item on the list is a known \penalty >
5441 % 10000. This is so \startdefun can avoid allowing breakpoints after
5442 % section headings. Otherwise, it would insert a valid breakpoint between:
5444 % @section sec-whatever
5445 % @deffn def-whatever
5451 % Table of contents.
5454 % Write an entry to the toc file, opening it if necessary.
5455 % Called from @chapter, etc.
5457 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5458 % We append the current node name (if any) and page number as additional
5459 % arguments for the \{chap,sec,...}entry macros which will eventually
5460 % read this. The node name is used in the pdf outlines as the
5461 % destination to jump to.
5463 % We open the .toc file for writing here instead of at @setfilename (or
5464 % any other fixed time) so that @contents can be anywhere in the document.
5465 % But if #1 is `omit', then we don't do anything. This is used for the
5466 % table of contents chapter openings themselves.
5468 \newif\iftocfileopened
5469 \def\omitkeyword{omit}%
5471 \def\writetocentry#1#2#3{%
5472 \edef\writetoctype{#1}%
5473 \ifx\writetoctype\omitkeyword \else
5474 \iftocfileopened\else
5475 \immediate\openout\tocfile = \jobname.toc
5476 \global\tocfileopenedtrue
5482 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5488 % Tell \shipout to create a pdf destination on each page, if we're
5489 % writing pdf. These are used in the table of contents. We can't
5490 % just write one on every page because the title pages are numbered
5491 % 1 and 2 (the page numbers aren't printed), and so are the first
5492 % two pages of the document. Thus, we'd have two destinations named
5493 % `1', and two named `2'.
5494 \ifpdf \global\pdfmakepagedesttrue \fi
5498 % These characters do not print properly in the Computer Modern roman
5499 % fonts, so we must take special care. This is more or less redundant
5500 % with the Texinfo input format setup at the end of this file.
5502 \def\activecatcodes{%
5515 % Read the toc file, which is essentially Texinfo input.
5519 \input \tocreadfilename
5522 \newskip\contentsrightmargin \contentsrightmargin=1in
5523 \newcount\savepageno
5524 \newcount\lastnegativepageno \lastnegativepageno = -1
5526 % Prepare to read what we've written to \tocfile.
5528 \def\startcontents#1{%
5529 % If @setchapternewpage on, and @headings double, the contents should
5530 % start on an odd page, unlike chapters. Thus, we maintain
5531 % \contentsalignmacro in parallel with \pagealignmacro.
5532 % From: Torbjorn Granlund <tege@matematik.su.se>
5534 \immediate\closeout\tocfile
5536 % Don't need to put `Contents' or `Short Contents' in the headline.
5537 % It is abundantly clear what they are.
5538 \chapmacro{#1}{Yomitfromtoc}{}%
5540 \savepageno = \pageno
5541 \begingroup % Set up to handle contents files properly.
5542 \raggedbottom % Worry more about breakpoints than the bottom.
5543 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5545 % Roman numerals for page numbers.
5546 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5549 % redefined for the two-volume lispref. We always output on
5550 % \jobname.toc even if this is redefined.
5552 \def\tocreadfilename{\jobname.toc}
5554 % Normal (long) toc.
5557 \startcontents{\putwordTOC}%
5558 \openin 1 \tocreadfilename\space
5563 \contentsalignmacro % in case @setchapternewpage odd is in effect
5569 \lastnegativepageno = \pageno
5570 \global\pageno = \savepageno
5573 % And just the chapters.
5574 \def\summarycontents{%
5575 \startcontents{\putwordShortTOC}%
5577 \let\numchapentry = \shortchapentry
5578 \let\appentry = \shortchapentry
5579 \let\unnchapentry = \shortunnchapentry
5580 % We want a true roman here for the page numbers.
5582 \let\rm=\shortcontrm \let\bf=\shortcontbf
5583 \let\sl=\shortcontsl \let\tt=\shortconttt
5585 \hyphenpenalty = 10000
5586 \advance\baselineskip by 1pt % Open it up a little.
5587 \def\numsecentry##1##2##3##4{}
5588 \let\appsecentry = \numsecentry
5589 \let\unnsecentry = \numsecentry
5590 \let\numsubsecentry = \numsecentry
5591 \let\appsubsecentry = \numsecentry
5592 \let\unnsubsecentry = \numsecentry
5593 \let\numsubsubsecentry = \numsecentry
5594 \let\appsubsubsecentry = \numsecentry
5595 \let\unnsubsubsecentry = \numsecentry
5596 \openin 1 \tocreadfilename\space
5602 \contentsalignmacro % in case @setchapternewpage odd is in effect
5604 \lastnegativepageno = \pageno
5605 \global\pageno = \savepageno
5607 \let\shortcontents = \summarycontents
5609 % Typeset the label for a chapter or appendix for the short contents.
5610 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
5612 \def\shortchaplabel#1{%
5613 % This space should be enough, since a single number is .5em, and the
5614 % widest letter (M) is 1em, at least in the Computer Modern fonts.
5615 % But use \hss just in case.
5616 % (This space doesn't include the extra space that gets added after
5617 % the label; that gets put in by \shortchapentry above.)
5619 % We'd like to right-justify chapter numbers, but that looks strange
5620 % with appendix letters. And right-justifying numbers and
5621 % left-justifying letters looks strange when there is less than 10
5622 % chapters. Have to read the whole toc once to know how many chapters
5623 % there are before deciding ...
5624 \hbox to 1em{#1\hss}%
5627 % These macros generate individual entries in the table of contents.
5628 % The first argument is the chapter or section name.
5629 % The last argument is the page number.
5630 % The arguments in between are the chapter number, section number, ...
5632 % Chapters, in the main contents.
5633 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5635 % Chapters, in the short toc.
5636 % See comments in \dochapentry re vbox and related settings.
5637 \def\shortchapentry#1#2#3#4{%
5638 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5641 % Appendices, in the main contents.
5642 % Need the word Appendix, and a fixed-size box.
5644 \def\appendixbox#1{%
5645 % We use M since it's probably the widest letter.
5646 \setbox0 = \hbox{\putwordAppendix{} M}%
5647 \hbox to \wd0{\putwordAppendix{} #1\hss}}
5649 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5651 % Unnumbered chapters.
5652 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5653 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5656 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5657 \let\appsecentry=\numsecentry
5658 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5661 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5662 \let\appsubsecentry=\numsubsecentry
5663 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5665 % And subsubsections.
5666 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5667 \let\appsubsubsecentry=\numsubsubsecentry
5668 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5670 % This parameter controls the indentation of the various levels.
5671 % Same as \defaultparindent.
5672 \newdimen\tocindent \tocindent = 15pt
5674 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5677 % If the toc has to be broken over pages, we want it to be at chapters
5678 % if at all possible; hence the \penalty.
5679 \def\dochapentry#1#2{%
5680 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5683 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5685 \nobreak\vskip .25\baselineskip plus.1\baselineskip
5688 \def\dosecentry#1#2{\begingroup
5689 \secentryfonts \leftskip=\tocindent
5690 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5693 \def\dosubsecentry#1#2{\begingroup
5694 \subsecentryfonts \leftskip=2\tocindent
5695 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5698 \def\dosubsubsecentry#1#2{\begingroup
5699 \subsubsecentryfonts \leftskip=3\tocindent
5700 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5703 % We use the same \entry macro as for the index entries.
5704 \let\tocentry = \entry
5706 % Space between chapter (or whatever) number and the title.
5707 \def\labelspace{\hskip1em \relax}
5709 \def\dopageno#1{{\rm #1}}
5710 \def\doshortpageno#1{{\rm #1}}
5712 \def\chapentryfonts{\secfonts \rm}
5713 \def\secentryfonts{\textfonts}
5714 \def\subsecentryfonts{\textfonts}
5715 \def\subsubsecentryfonts{\textfonts}
5718 \message{environments,}
5719 % @foo ... @end foo.
5721 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
5722 % define and register \INITMACRO to be called on markup style changes.
5723 % \INITMACRO can check \currentmarkupstyle for the innermost
5724 % style and the set of \ifmarkupSTYLE switches for all styles
5725 % currently in effect.
5729 %\newif\ifmarkupfile % @file == @samp.
5730 %\newif\ifmarkupoption % @option == @samp.
5733 %\newif\ifmarkupenv % @env == @code.
5734 %\newif\ifmarkupcommand % @command == @code.
5735 \newif\ifmarkuptex % @tex (and part of @math, for now).
5736 \newif\ifmarkupexample
5738 \newif\ifmarkupverbatim
5740 \let\currentmarkupstyle\empty
5742 \def\setupmarkupstyle#1{%
5743 \csname markup#1true\endcsname
5744 \def\currentmarkupstyle{#1}%
5748 \let\markupstylesetup\empty
5750 \def\defmarkupstylesetup#1{%
5751 \expandafter\def\expandafter\markupstylesetup
5752 \expandafter{\markupstylesetup #1}%
5756 % Markup style setup for left and right quotes.
5757 \defmarkupstylesetup\markupsetuplq{%
5758 \expandafter\let\expandafter \temp \csname markupsetuplq\currentmarkupstyle\endcsname
5759 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
5762 \defmarkupstylesetup\markupsetuprq{%
5763 \expandafter\let\expandafter \temp \csname markupsetuprq\currentmarkupstyle\endcsname
5764 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
5771 \gdef\markupsetuplqdefault{\let`\lq}
5772 \gdef\markupsetuprqdefault{\let'\rq}
5774 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
5775 \gdef\markupsetcodequoteright{\let'\codequoteright}
5777 \gdef\markupsetnoligaturesquoteleft{\let`\noligaturesquoteleft}
5780 \let\markupsetuplqcode \markupsetcodequoteleft
5781 \let\markupsetuprqcode \markupsetcodequoteright
5782 \let\markupsetuplqexample \markupsetcodequoteleft
5783 \let\markupsetuprqexample \markupsetcodequoteright
5784 \let\markupsetuplqverb \markupsetcodequoteleft
5785 \let\markupsetuprqverb \markupsetcodequoteright
5786 \let\markupsetuplqverbatim \markupsetcodequoteleft
5787 \let\markupsetuprqverbatim \markupsetcodequoteright
5789 \let\markupsetuplqsamp \markupsetnoligaturesquoteleft
5790 \let\markupsetuplqkbd \markupsetnoligaturesquoteleft
5792 % Allow an option to not replace quotes with a regular directed right
5793 % quote/apostrophe (char 0x27), but instead use the undirected quote
5794 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
5795 % the default, but it works for pasting with more pdf viewers (at least
5796 % evince), the lilypond developers report. xpdf does work with the
5799 \def\codequoteright{%
5800 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
5801 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
5807 % and a similar option for the left quote char vs. a grave accent.
5808 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
5809 % the code environments to do likewise.
5811 \def\codequoteleft{%
5812 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
5813 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
5814 % [Knuth] pp. 380,381,391
5815 % \relax disables Spanish ligatures ?` and !` of \tt font.
5821 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
5822 \def\noligaturesquoteleft{\relax\lq}
5824 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
5826 % Since these characters are used in examples, they should be an even number of
5827 % \tt widths. Each \tt character is 1en, so two makes it 1em.
5830 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
5831 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
5832 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
5833 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
5834 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
5836 % The @error{} command.
5837 % Adapted from the TeXbook's \boxit.
5841 {\tentt \global\dimen0 = 3em}% Width of the box.
5842 \dimen2 = .55pt % Thickness of rules
5843 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
5844 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
5846 \setbox\errorbox=\hbox to \dimen0{\hfil
5847 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
5848 \advance\hsize by -2\dimen2 % Rules.
5850 \hrule height\dimen2
5851 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
5852 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
5853 \kern3pt\vrule width\dimen2}% Space to right.
5854 \hrule height\dimen2}
5857 \def\error{\leavevmode\lower.7ex\copy\errorbox}
5859 % @tex ... @end tex escapes into raw Tex temporarily.
5860 % One exception: @ is still an escape character, so that @end tex works.
5861 % But \@ or @@ will get a plain tex @ character.
5864 \setupmarkupstyle{tex}%
5865 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5866 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5867 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5879 \let\bullet=\ptexbullet
5884 \let\equiv=\ptexequiv
5887 \let\indent=\ptexindent
5888 \let\noindent=\ptexnoindent
5895 \expandafter \let\csname top\endcsname=\ptextop % outer
5896 \let\frenchspacing=\plainfrenchspacing
5898 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
5899 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
5902 % There is no need to define \Etex.
5904 % Define @lisp ... @end lisp.
5905 % @lisp environment forms a group so it can rebind things,
5906 % including the definition of @end lisp (which normally is erroneous).
5908 % Amount to narrow the margins by for @lisp.
5909 \newskip\lispnarrowing \lispnarrowing=0.4in
5911 % This is the definition that ^^M gets inside @lisp, @example, and other
5912 % such environments. \null is better than a space, since it doesn't
5914 \def\lisppar{\null\endgraf}
5916 % This space is always present above and below environments.
5917 \newskip\envskipamount \envskipamount = 0pt
5919 % Make spacing and below environment symmetrical. We use \parskip here
5920 % to help in doing that, since in @example-like environments \parskip
5921 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
5922 % start of the next paragraph will insert \parskip.
5924 \def\aboveenvbreak{{%
5925 % =10000 instead of <10000 because of a special case in \itemzzz and
5926 % \sectionheading, q.v.
5927 \ifnum \lastpenalty=10000 \else
5928 \advance\envskipamount by \parskip
5930 \ifdim\lastskip<\envskipamount
5932 % it's not a good place to break if the last penalty was \nobreak
5934 \ifnum\lastpenalty<10000 \penalty-50 \fi
5935 \vskip\envskipamount
5940 \let\afterenvbreak = \aboveenvbreak
5942 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
5943 % also clear it, so that its embedded environments do the narrowing again.
5944 \let\nonarrowing=\relax
5946 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
5947 % environment contents.
5948 \font\circle=lcircle10
5950 \newdimen\cartouter\newdimen\cartinner
5951 \newskip\normbskip\newskip\normpskip\newskip\normlskip
5952 \circthick=\fontdimen8\circle
5954 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
5955 \def\ctr{{\hskip 6pt\circle\char'010}}
5956 \def\cbl{{\circle\char'012\hskip -6pt}}
5957 \def\cbr{{\hskip 6pt\circle\char'011}}
5958 \def\carttop{\hbox to \cartouter{\hskip\lskip
5959 \ctl\leaders\hrule height\circthick\hfil\ctr
5961 \def\cartbot{\hbox to \cartouter{\hskip\lskip
5962 \cbl\leaders\hrule height\circthick\hfil\cbr
5965 \newskip\lskip\newskip\rskip
5968 \ifhmode\par\fi % can't be in the midst of a paragraph.
5970 \lskip=\leftskip \rskip=\rightskip
5971 \leftskip=0pt\rightskip=0pt % we want these *outside*.
5972 \cartinner=\hsize \advance\cartinner by-\lskip
5973 \advance\cartinner by-\rskip
5975 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
5976 % side, and for 6pt waste from
5977 % each corner char, and rule thickness
5978 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
5979 % Flag to tell @lisp, etc., not to narrow margin.
5980 \let\nonarrowing = t%
5982 \baselineskip=0pt\parskip=0pt\lineskip=0pt
5990 \baselineskip=\normbskip
5991 \lineskip=\normlskip
5994 \comment % For explanation, see the end of \def\group.
6009 % This macro is called at the beginning of all the @example variants,
6013 \hfuzz = 12pt % Don't be fussy
6014 \sepspaces % Make spaces be word-separators rather than space tokens.
6015 \let\par = \lisppar % don't ignore blank lines
6016 \obeylines % each line of input is a line of output
6019 \emergencystretch = 0pt % don't try to avoid overfull boxes
6020 \ifx\nonarrowing\relax
6021 \advance \leftskip by \lispnarrowing
6022 \exdentamount=\lispnarrowing
6024 \let\nonarrowing = \relax
6026 \let\exdent=\nofillexdent
6029 % If you want all examples etc. small: @set dispenvsize small.
6030 % If you want even small examples the full size: @set dispenvsize nosmall.
6031 % This affects the following displayed environments:
6032 % @example, @display, @format, @lisp
6034 \def\smallword{small}
6035 \def\nosmallword{nosmall}
6036 \let\SETdispenvsize\relax
6037 \def\setnormaldispenv{%
6038 \ifx\SETdispenvsize\smallword
6039 % end paragraph for sake of leading, in case document has no blank
6040 % line. This is redundant with what happens in \aboveenvbreak, but
6041 % we need to do it before changing the fonts, and it's inconvenient
6042 % to change the fonts afterward.
6043 \ifnum \lastpenalty=10000 \else \endgraf \fi
6044 \smallexamplefonts \rm
6047 \def\setsmalldispenv{%
6048 \ifx\SETdispenvsize\nosmallword
6050 \ifnum \lastpenalty=10000 \else \endgraf \fi
6051 \smallexamplefonts \rm
6055 % We often define two environments, @foo and @smallfoo.
6056 % Let's do it by one command:
6057 \def\makedispenv #1#2{
6058 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
6059 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
6060 \expandafter\let\csname E#1\endcsname \afterenvbreak
6061 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6064 % Define two synonyms:
6065 \def\maketwodispenvs #1#2#3{
6066 \makedispenv{#1}{#3}
6067 \makedispenv{#2}{#3}
6070 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
6072 % @smallexample and @smalllisp: use smaller fonts.
6073 % Originally contributed by Pavel@xerox.
6075 \maketwodispenvs {lisp}{example}{%
6077 \tt\setupmarkupstyle{example}%
6078 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6079 \gobble % eat return
6081 % @display/@smalldisplay: same as @lisp except keep current font.
6083 \makedispenv {display}{%
6088 % @format/@smallformat: same as @display except don't narrow margins.
6090 \makedispenv{format}{%
6091 \let\nonarrowing = t%
6096 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6098 \let\nonarrowing = t%
6102 \let\Eflushleft = \afterenvbreak
6106 \envdef\flushright{%
6107 \let\nonarrowing = t%
6109 \advance\leftskip by 0pt plus 1fill
6112 \let\Eflushright = \afterenvbreak
6115 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6116 % and narrows the margins. We keep \parskip nonzero in general, since
6117 % we're doing normal filling. So, when using \aboveenvbreak and
6118 % \afterenvbreak, temporarily make \parskip 0.
6120 \def\quotationstart{%
6121 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6124 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6125 \ifx\nonarrowing\relax
6126 \advance\leftskip by \lispnarrowing
6127 \advance\rightskip by \lispnarrowing
6128 \exdentamount = \lispnarrowing
6130 \let\nonarrowing = \relax
6132 \parsearg\quotationlabel
6140 \envdef\smallquotation{%
6144 \let\Esmallquotation = \Equotation
6146 % We have retained a nonzero parskip for the environment, since we're
6147 % doing normal filling.
6151 \ifx\quotationauthor\undefined\else
6153 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6155 {\parskip=0pt \afterenvbreak}%
6158 % If we're given an argument, typeset it in bold with a colon after.
6159 \def\quotationlabel#1{%
6161 \ifx\temp\empty \else
6167 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6168 % If we want to allow any <char> as delimiter,
6169 % we need the curly braces so that makeinfo sees the @verb command, eg:
6170 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6172 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6174 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6175 % active too. Otherwise, they get lost as the first character on a
6178 \do\ \do\\\do\{\do\}\do\$\do\&%
6179 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6180 \do\<\do\>\do\|\do\@\do+\do\"%
6181 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6182 % @set txicodequotebacktick will not have effect on @verb and
6183 % @verbatim, and ?` and !` ligatures won't get disabled.
6188 \def\uncatcodespecials{%
6189 \def\do##1{\catcode`##1=\other}\dospecials}
6191 % Setup for the @verb command.
6193 % Eight spaces for a tab
6195 \catcode`\^^I=\active
6196 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6200 \tt % easiest (and conventionally used) font for verbatim
6201 \def\par{\leavevmode\endgraf}%
6202 \setupmarkupstyle{verb}%
6204 % Respect line breaks,
6205 % print special symbols as themselves, and
6206 % make each space count
6207 % must do in this order:
6208 \obeylines \uncatcodespecials \sepspaces
6211 % Setup for the @verbatim environment
6213 % Real tab expansion
6214 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6216 \def\starttabbox{\setbox0=\hbox\bgroup}
6219 \catcode`\^^I=\active
6221 \catcode`\^^I=\active
6222 \def^^I{\leavevmode\egroup
6223 \dimen0=\wd0 % the width so far, or since the previous tab
6224 \divide\dimen0 by\tabw
6225 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
6226 \advance\dimen0 by\tabw % advance to next multiple of \tabw
6227 \wd0=\dimen0 \box0 \starttabbox
6232 % start the verbatim environment.
6233 \def\setupverbatim{%
6234 \let\nonarrowing = t%
6236 % Easiest (and conventionally used) font for verbatim
6238 \def\par{\leavevmode\egroup\box0\endgraf}%
6240 \setupmarkupstyle{verbatim}%
6241 % Respect line breaks,
6242 % print special symbols as themselves, and
6243 % make each space count
6244 % must do in this order:
6245 \obeylines \uncatcodespecials \sepspaces
6246 \everypar{\starttabbox}%
6249 % Do the @verb magic: verbatim text is quoted by unique
6250 % delimiter characters. Before first delimiter expect a
6251 % right brace, after last delimiter expect closing brace:
6253 % \def\doverb'{'<char>#1<char>'}'{#1}
6255 % [Knuth] p. 382; only eat outer {}
6257 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6258 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6261 \def\verb{\begingroup\setupverb\doverb}
6264 % Do the @verbatim magic: define the macro \doverbatim so that
6265 % the (first) argument ends when '@end verbatim' is reached, ie:
6267 % \def\doverbatim#1@end verbatim{#1}
6269 % For Texinfo it's a lot easier than for LaTeX,
6270 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6271 % we need not redefine '\', '{' and '}'.
6273 % Inspired by LaTeX's verbatim command set [latex.ltx]
6278 % ignore everything up to the first ^^M, that's the newline at the end
6279 % of the @verbatim input line itself. Otherwise we get an extra blank
6280 % line in the output.
6281 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6282 % We really want {...\end verbatim} in the body of the macro, but
6283 % without the active space; thus we have to use \xdef and \gobble.
6287 \setupverbatim\doverbatim
6289 \let\Everbatim = \afterenvbreak
6292 % @verbatiminclude FILE - insert text of file in verbatim environment.
6294 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6296 \def\doverbatiminclude#1{%
6298 \makevalueexpandable
6300 \indexnofonts % Allow `@@' and other weird things in file names.
6306 % @copying ... @end copying.
6307 % Save the text away for @insertcopying later.
6309 % We save the uninterpreted tokens, rather than creating a box.
6310 % Saving the text in a box would be much easier, but then all the
6311 % typesetting commands (@smallbook, font changes, etc.) have to be done
6312 % beforehand -- and a) we want @copying to be done first in the source
6313 % file; b) letting users define the frontmatter in as flexible order as
6314 % possible is very desirable.
6316 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6317 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6319 \def\insertcopying{%
6321 \parindent = 0pt % paragraph indentation looks wrong on title page
6322 \scanexp\copyingtext
6330 \newskip\defbodyindent \defbodyindent=.4in
6331 \newskip\defargsindent \defargsindent=50pt
6332 \newskip\deflastargmargin \deflastargmargin=18pt
6333 \newcount\defunpenalty
6335 % Start the processing of @deffn:
6337 \ifnum\lastpenalty<10000
6339 \defunpenalty=10003 % Will keep this @deffn together with the
6340 % following @def command, see below.
6342 % If there are two @def commands in a row, we'll have a \nobreak,
6343 % which is there to keep the function description together with its
6344 % header. But if there's nothing but headers, we need to allow a
6345 % break somewhere. Check specifically for penalty 10002, inserted
6346 % by \printdefunline, instead of 10000, since the sectioning
6347 % commands also insert a nobreak penalty, and we don't want to allow
6348 % a break between a section heading and a defun.
6350 % As a minor refinement, we avoid "club" headers by signalling
6351 % with penalty of 10003 after the very first @deffn in the
6352 % sequence (see above), and penalty of 10002 after any following
6354 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6356 % Similarly, after a section heading, do not allow a break.
6357 % But do insert the glue.
6358 \medskip % preceded by discardable penalty, so not a breakpoint
6362 \advance\leftskip by \defbodyindent
6363 \exdentamount=\defbodyindent
6367 % First, check whether we are in the right environment:
6370 % As above, allow line break if we have multiple x headers in a row.
6371 % It's not a great place, though.
6372 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6374 % And now, it's time to reuse the body of the original defun:
6375 \expandafter\gobbledefun#1%
6377 \def\gobbledefun#1\startdefun{}
6379 % \printdefunline \deffnheader{text}
6381 \def\printdefunline#1#2{%
6383 % call \deffnheader:
6386 \interlinepenalty = 10000
6387 \advance\rightskip by 0pt plus 1fil
6389 \nobreak\vskip -\parskip
6390 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6391 % Some of the @defun-type tags do not enable magic parentheses,
6392 % rendering the following check redundant. But we don't optimize.
6397 \def\Edefun{\endgraf\medbreak}
6399 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6400 % the only thing remaining is to define \deffnheader.
6403 \expandafter\let\csname E#1\endcsname = \Edefun
6404 \edef\temp{\noexpand\domakedefun
6405 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6409 % \domakedefun \deffn \deffnx \deffnheader
6411 % Define \deffn and \deffnx, without parameters.
6412 % \deffnheader has to be defined explicitly.
6414 \def\domakedefun#1#2#3{%
6417 \parseargusing\activeparens{\printdefunline#3}%
6419 \def#2{\dodefunx#1}%
6423 %%% Untyped functions:
6425 % @deffn category name args
6426 \makedefun{deffn}{\deffngeneral{}}
6428 % @deffn category class name args
6429 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6431 % \defopon {category on}class name args
6432 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6434 % \deffngeneral {subind}category name args
6436 \def\deffngeneral#1#2 #3 #4\endheader{%
6437 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6438 \dosubind{fn}{\code{#3}}{#1}%
6439 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6442 %%% Typed functions:
6444 % @deftypefn category type name args
6445 \makedefun{deftypefn}{\deftypefngeneral{}}
6447 % @deftypeop category class type name args
6448 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6450 % \deftypeopon {category on}class type name args
6451 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6453 % \deftypefngeneral {subind}category type name args
6455 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6456 \dosubind{fn}{\code{#4}}{#1}%
6457 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6460 %%% Typed variables:
6462 % @deftypevr category type var args
6463 \makedefun{deftypevr}{\deftypecvgeneral{}}
6465 % @deftypecv category class type var args
6466 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6468 % \deftypecvof {category of}class type var args
6469 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6471 % \deftypecvgeneral {subind}category type var args
6473 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6474 \dosubind{vr}{\code{#4}}{#1}%
6475 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6478 %%% Untyped variables:
6480 % @defvr category var args
6481 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6483 % @defcv category class var args
6484 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6486 % \defcvof {category of}class var args
6487 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6490 % @deftp category name args
6491 \makedefun{deftp}#1 #2 #3\endheader{%
6492 \doind{tp}{\code{#2}}%
6493 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6496 % Remaining @defun-like shortcuts:
6497 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6498 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6499 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6500 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6501 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6502 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6503 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6504 \makedefun{defmethod}{\defopon\putwordMethodon}
6505 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6506 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6507 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6509 % \defname, which formats the name of the @def (not the args).
6510 % #1 is the category, such as "Function".
6511 % #2 is the return type, if any.
6512 % #3 is the function name.
6514 % We are followed by (but not passed) the arguments, if any.
6516 \def\defname#1#2#3{%
6517 % Get the values of \leftskip and \rightskip as they were outside the @def...
6518 \advance\leftskip by -\defbodyindent
6520 % How we'll format the type name. Putting it in brackets helps
6521 % distinguish it from the body text that may end up on the next line
6524 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6526 % Figure out line sizes for the paragraph shape.
6527 % The first line needs space for \box0; but if \rightskip is nonzero,
6528 % we need only space for the part of \box0 which exceeds it:
6529 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6530 % The continuations:
6531 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6532 % (plain.tex says that \dimen1 should be used only as global.)
6533 \parshape 2 0in \dimen0 \defargsindent \dimen2
6535 % Put the type name to the right margin.
6538 \hfil\box0 \kern-\hsize
6539 % \hsize has to be shortened this way:
6541 % Intentionally do not respect \rightskip, since we need the space.
6544 % Allow all lines to be underfull without complaint:
6545 \tolerance=10000 \hbadness=10000
6546 \exdentamount=\defbodyindent
6548 % defun fonts. We use typewriter by default (used to be bold) because:
6549 % . we're printing identifiers, they should be in tt in principle.
6550 % . in languages with many accents, such as Czech or French, it's
6551 % common to leave accents off identifiers. The result looks ok in
6552 % tt, but exceedingly strange in rm.
6553 % . we don't want -- and --- to be treated as ligatures.
6554 % . this still does not fix the ?` and !` ligatures, but so far no
6555 % one has made identifiers using them :).
6557 \def\temp{#2}% return value type
6558 \ifx\temp\empty\else \tclose{\temp} \fi
6559 #3% output function name
6561 {\rm\enskip}% hskip 0.5 em of \tenrm
6564 % arguments will be output next, if any.
6567 % Print arguments in slanted roman (not ttsl), inconsistently with using
6568 % tt for the name. This is because literal text is sometimes needed in
6569 % the argument list (groff manual), and ttsl and tt are not very
6570 % distinguishable. Prevent hyphenation at `-' chars.
6573 % use sl by default (not ttsl),
6575 \df \sl \hyphenchar\font=0
6577 % On the other hand, if an argument has two dashes (for instance), we
6578 % want a way to get ttsl. Let's try @var for that.
6579 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
6581 \sl\hyphenchar\font=45
6584 % We want ()&[] to print specially on the defun line.
6587 \catcode`\(=\active \catcode`\)=\active
6588 \catcode`\[=\active \catcode`\]=\active
6592 % Make control sequences which act like normal parenthesis chars.
6593 \let\lparen = ( \let\rparen = )
6595 % Be sure that we always have a definition for `(', etc. For example,
6596 % if the fn name has parens in it, \boldbrax will not be in effect yet,
6597 % so TeX would otherwise complain about undefined control sequence.
6600 \global\let(=\lparen \global\let)=\rparen
6601 \global\let[=\lbrack \global\let]=\rbrack
6604 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
6605 \gdef\magicamp{\let&=\amprm}
6608 \newcount\parencount
6610 % If we encounter &foo, then turn on ()-hacking afterwards
6612 \def\amprm#1 {\ampseentrue{\bf\ }}
6616 % At the first level, print parens in roman,
6617 % otherwise use the default font.
6618 \ifnum \parencount=1 \rm \fi
6620 % The \sf parens (in \boldbrax) actually are a little bolder than
6621 % the contained text. This is especially needed for [ and ] .
6625 \def\infirstlevel#1{%
6632 \def\bfafterword#1 {#1 \bf}
6635 \global\advance\parencount by 1
6637 \infirstlevel \bfafterword
6642 \global\advance\parencount by -1
6645 \newcount\brackcount
6647 \global\advance\brackcount by 1
6652 \global\advance\brackcount by -1
6655 \def\checkparencounts{%
6656 \ifnum\parencount=0 \else \badparencount \fi
6657 \ifnum\brackcount=0 \else \badbrackcount \fi
6659 % these should not use \errmessage; the glibc manual, at least, actually
6660 % has such constructs (when documenting function pointers).
6661 \def\badparencount{%
6662 \message{Warning: unbalanced parentheses in @def...}%
6663 \global\parencount=0
6665 \def\badbrackcount{%
6666 \message{Warning: unbalanced square brackets in @def...}%
6667 \global\brackcount=0
6674 % To do this right we need a feature of e-TeX, \scantokens,
6675 % which we arrange to emulate with a temporary file in ordinary TeX.
6676 \ifx\eTeXversion\undefined
6677 \newwrite\macscribble
6680 \immediate\openout\macscribble=\jobname.tmp
6681 \immediate\write\macscribble{\the\toks0}%
6682 \immediate\closeout\macscribble
6690 \let\xeatspaces\eatspaces
6691 % Undo catcode changes of \startcontents and \doprintindex
6692 % When called from @insertcopying or (short)caption, we need active
6693 % backslash to get it printed correctly. Previously, we had
6694 % \catcode`\\=\other instead. We'll see whether a problem appears
6695 % with macro expansion. --kasal, 19aug04
6696 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6700 % Append \endinput to make sure that TeX does not see the ending newline.
6701 % I've verified that it is necessary both for e-TeX and for ordinary TeX
6703 \scantokens{#1\endinput}%
6708 \edef\temp{\noexpand\scanmacro{#1}}%
6712 \newcount\paramno % Count of parameters
6713 \newtoks\macname % Macro name
6714 \newif\ifrecursive % Is it recursive?
6716 % List of all defined macros in the form
6717 % \definedummyword\macro1\definedummyword\macro2...
6718 % Currently is also contains all @aliases; the list can be split
6719 % if there is a need.
6722 % Add the macro to \macrolist
6723 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6724 \def\addtomacrolistxxx#1{%
6725 \toks0 = \expandafter{\macrolist\definedummyword#1}%
6726 \xdef\macrolist{\the\toks0}%
6730 % This does \let #1 = #2, with \csnames; that is,
6731 % \let \csname#1\endcsname = \csname#2\endcsname
6732 % (except of course we have to play expansion games).
6736 \csname#1\expandafter\endcsname
6740 % Trim leading and trailing spaces off a string.
6741 % Concepts from aro-bend problem 15 (see CTAN).
6743 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6744 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6745 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6747 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6750 % Trim a single trailing ^^M off a string.
6751 {\catcode`\^^M=\other \catcode`\Q=3%
6752 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6753 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6754 \gdef\eatcrb#1Q#2Q{#1}%
6757 % Macro bodies are absorbed as an argument in a context where
6758 % all characters are catcode 10, 11 or 12, except \ which is active
6759 % (as in normal texinfo). It is necessary to change the definition of \.
6761 % Non-ASCII encodings make 8-bit characters active, so un-activate
6762 % them to avoid their expansion. Must do this non-globally, to
6763 % confine the change to the current group.
6765 % It's necessary to have hard CRs when the macro is executed. This is
6766 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
6767 % body, and then making it the \newlinechar in \scanmacro.
6779 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
6785 \catcode`\^^M=\other
6788 \def\macrobodyctxt{%
6792 \catcode`\^^M=\other
6801 % \mbodybackslash is the definition of \ in @macro bodies.
6802 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6803 % where N is the macro parameter number.
6804 % We define \csname macarg.\endcsname to be \realbackslash, so
6805 % \\ in macro replacement text gets you a backslash.
6807 {\catcode`@=0 @catcode`@\=@active
6808 @gdef@usembodybackslash{@let\=@mbodybackslash}
6809 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6811 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6813 \def\macro{\recursivefalse\parsearg\macroxxx}
6814 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6817 \getargs{#1}% now \macname is the macname and \argl the arglist
6818 \ifx\argl\empty % no arguments
6821 \expandafter\parsemargdef \argl;%
6823 \if1\csname ismacro.\the\macname\endcsname
6824 \message{Warning: redefining \the\macname}%
6826 \expandafter\ifx\csname \the\macname\endcsname \relax
6827 \else \errmessage{Macro name \the\macname\space already defined}\fi
6828 \global\cslet{macsave.\the\macname}{\the\macname}%
6829 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
6830 \addtomacrolist{\the\macname}%
6832 \begingroup \macrobodyctxt
6833 \ifrecursive \expandafter\parsermacbody
6834 \else \expandafter\parsemacbody
6837 \parseargdef\unmacro{%
6838 \if1\csname ismacro.#1\endcsname
6839 \global\cslet{#1}{macsave.#1}%
6840 \global\expandafter\let \csname ismacro.#1\endcsname=0%
6841 % Remove the macro name from \macrolist:
6843 \expandafter\let\csname#1\endcsname \relax
6844 \let\definedummyword\unmacrodo
6845 \xdef\macrolist{\macrolist}%
6848 \errmessage{Macro #1 not defined}%
6852 % Called by \do from \dounmacro on each macro. The idea is to omit any
6853 % macro definitions that have been changed to \relax.
6859 \noexpand\definedummyword \noexpand#1%
6863 % This makes use of the obscure feature that if the last token of a
6864 % <parameter list> is #, then the preceding argument is delimited by
6865 % an opening brace, and that opening brace is not consumed.
6866 \def\getargs#1{\getargsxxx#1{}}
6867 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
6868 \def\getmacname #1 #2\relax{\macname={#1}}
6869 \def\getmacargs#1{\def\argl{#1}}
6871 % Parse the optional {params} list. Set up \paramno and \paramlist
6872 % so \defmacro knows what to do. Define \macarg.blah for each blah
6873 % in the params list, to be ##N where N is the position in that list.
6874 % That gets used by \mbodybackslash (above).
6876 % We need to get `macro parameter char #' into several definitions.
6877 % The technique used is stolen from LaTeX: let \hash be something
6878 % unexpandable, insert that wherever you need a #, and then redefine
6879 % it to # just before using the token list produced.
6881 % The same technique is used to protect \eatspaces till just before
6882 % the macro is used.
6884 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
6885 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
6886 \def\parsemargdefxxx#1,{%
6887 \if#1;\let\next=\relax
6888 \else \let\next=\parsemargdefxxx
6889 \advance\paramno by 1%
6890 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
6891 {\xeatspaces{\hash\the\paramno}}%
6892 \edef\paramlist{\paramlist\hash\the\paramno,}%
6895 % These two commands read recursive and nonrecursive macro bodies.
6896 % (They're different since rec and nonrec macros end differently.)
6898 \long\def\parsemacbody#1@end macro%
6899 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6900 \long\def\parsermacbody#1@end rmacro%
6901 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
6903 % This defines the macro itself. There are six cases: recursive and
6904 % nonrecursive macros of zero, one, and many arguments.
6905 % Much magic with \expandafter here.
6906 % \xdef is used so that macro definitions will survive the file
6907 % they're defined in; @include reads the file inside a group.
6909 \let\hash=##% convert placeholders to macro parameter chars
6913 \expandafter\xdef\csname\the\macname\endcsname{%
6914 \noexpand\scanmacro{\temp}}%
6916 \expandafter\xdef\csname\the\macname\endcsname{%
6917 \bgroup\noexpand\macroargctxt
6918 \noexpand\braceorline
6919 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6920 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6921 \egroup\noexpand\scanmacro{\temp}}%
6923 \expandafter\xdef\csname\the\macname\endcsname{%
6924 \bgroup\noexpand\macroargctxt
6925 \noexpand\csname\the\macname xx\endcsname}%
6926 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6927 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6928 \expandafter\expandafter
6930 \expandafter\expandafter
6931 \csname\the\macname xxx\endcsname
6932 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
6937 \expandafter\xdef\csname\the\macname\endcsname{%
6938 \noexpand\norecurse{\the\macname}%
6939 \noexpand\scanmacro{\temp}\egroup}%
6941 \expandafter\xdef\csname\the\macname\endcsname{%
6942 \bgroup\noexpand\macroargctxt
6943 \noexpand\braceorline
6944 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
6945 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
6947 \noexpand\norecurse{\the\macname}%
6948 \noexpand\scanmacro{\temp}\egroup}%
6950 \expandafter\xdef\csname\the\macname\endcsname{%
6951 \bgroup\noexpand\macroargctxt
6952 \expandafter\noexpand\csname\the\macname xx\endcsname}%
6953 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
6954 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
6955 \expandafter\expandafter
6957 \expandafter\expandafter
6958 \csname\the\macname xxx\endcsname
6961 \noexpand\norecurse{\the\macname}%
6962 \noexpand\scanmacro{\temp}\egroup}%
6966 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
6968 % \braceorline decides whether the next nonwhitespace character is a
6969 % {. If so it reads up to the closing }, if not, it reads the whole
6970 % line. Whatever was read is then fed to the next control sequence
6971 % as an argument (by \parsebrace or \parsearg)
6972 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
6973 \def\braceorlinexxx{%
6974 \ifx\nchar\bgroup\else
6975 \expandafter\parsearg
6980 % We need some trickery to remove the optional spaces around the equal
6981 % sign. Just make them active and then expand them all to nothing.
6982 \def\alias{\parseargusing\obeyspaces\aliasxxx}
6983 \def\aliasxxx #1{\aliasyyy#1\relax}
6984 \def\aliasyyy #1=#2\relax{%
6986 \expandafter\let\obeyedspace=\empty
6987 \addtomacrolist{#1}%
6988 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
6994 \message{cross references,}
6997 \newif\ifhavexrefs % True if xref values are known.
6998 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7000 % @inforef is relatively simple.
7001 \def\inforef #1{\inforefzzz #1,,,,**}
7002 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7003 node \samp{\ignorespaces#1{}}}
7005 % @node's only job in TeX is to define \lastnode, which is used in
7006 % cross-references. The @node line might or might not have commas, and
7007 % might or might not have spaces before the first comma, like:
7008 % @node foo , bar , ...
7009 % We don't want such trailing spaces in the node name.
7011 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7013 % also remove a trailing comma, in case of something like this:
7014 % @node Help-Cross, , , Cross-refs
7015 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7016 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7019 \let\lastnode=\empty
7021 % Write a cross-reference definition for the current node. #1 is the
7022 % type (Ynumbered, Yappendix, Ynothing).
7025 \ifx\lastnode\empty\else
7026 \setref{\lastnode}{#1}%
7027 \global\let\lastnode=\empty
7031 % @anchor{NAME} -- define xref target at arbitrary point.
7033 \newcount\savesfregister
7035 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7036 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7037 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7039 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7040 % anchor), which consists of three parts:
7041 % 1) NAME-title - the current sectioning name taken from \lastsection,
7042 % or the anchor name.
7043 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7044 % empty for anchors.
7045 % 3) NAME-pg - the page number.
7047 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7048 % floats, there is an additional part, which is not written here:
7049 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7055 \atdummies % preserve commands, but don't expand them
7056 \edef\writexrdef##1##2{%
7057 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7058 ##1}{##2}}% these are parameters of \writexrdef
7060 \toks0 = \expandafter{\lastsection}%
7061 \immediate \writexrdef{title}{\the\toks0 }%
7062 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7063 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout
7068 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7069 % the node name, #2 the name of the Info cross-reference, #3 the printed
7070 % node name, #4 the name of the Info file, #5 the name of the printed
7071 % manual. All but the node name can be omitted.
7073 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7074 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7075 \def\ref#1{\xrefX[#1,,,,,,,]}
7076 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7078 \def\printedmanual{\ignorespaces #5}%
7079 \def\printedrefname{\ignorespaces #3}%
7080 \setbox1=\hbox{\printedmanual\unskip}%
7081 \setbox0=\hbox{\printedrefname\unskip}%
7083 % No printed node name was explicitly given.
7084 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
7085 % Use the node name inside the square brackets.
7086 \def\printedrefname{\ignorespaces #1}%
7088 % Use the actual chapter/section title appear inside
7089 % the square brackets. Use the real section title if we have it.
7091 % It is in another manual, so we don't have it.
7092 \def\printedrefname{\ignorespaces #1}%
7095 % We know the real title if we have the xref values.
7096 \def\printedrefname{\refx{#1-title}{}}%
7098 % Otherwise just copy the Info node name.
7099 \def\printedrefname{\ignorespaces #1}%
7105 % Make link in pdf output.
7109 % This expands tokens, so do it after making catcode changes, so _
7110 % etc. don't get their TeX definitions.
7113 % See comments at \activebackslashdouble.
7114 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
7115 \backslashparens\pdfxrefdest}%
7118 \startlink attr{/Border [0 0 0]}%
7119 \ifnum\filenamelength>0
7120 goto file{\the\filename.pdf} name{\pdfxrefdest}%
7122 goto name{\pdfmkpgn{\pdfxrefdest}}%
7125 \setcolor{\linkcolor}%
7128 % Float references are printed completely differently: "Figure 1.2"
7129 % instead of "[somenode], p.3". We distinguish them by the
7130 % LABEL-title being set to a magic string.
7132 % Have to otherify everything special to allow the \csname to
7133 % include an _ in the xref name, etc.
7136 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7137 \csname XR#1-title\endcsname
7139 \iffloat\Xthisreftitle
7140 % If the user specified the print name (third arg) to the ref,
7141 % print it instead of our usual "Figure 1.2".
7148 % if the user also gave the printed manual name (fifth arg), append
7151 \space \putwordin{} \cite{\printedmanual}%
7154 % node/anchor (non-float) references.
7156 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7157 % insert empty discretionaries after hyphens, which means that it will
7158 % not find a line break at a hyphen in a node names. Since some manuals
7159 % are best written with fairly long node names, containing hyphens, this
7160 % is a loss. Therefore, we give the text of the node name again, so it
7161 % is as if TeX is seeing it for the first time.
7163 \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7165 % _ (for example) has to be the character _ for the purposes of the
7166 % control sequence corresponding to the node, but it has to expand
7167 % into the usual \leavevmode...\vrule stuff for purposes of
7168 % printing. So we \turnoffactive for the \refx-snt, back on for the
7169 % printing, back off for the \refx-pg.
7171 % Only output a following space if the -snt ref is nonempty; for
7172 % @unnumbered and @anchor, it won't be.
7173 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7174 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7176 % output the `[mynode]' via a macro so it can be overridden.
7177 \xrefprintnodename\printedrefname
7179 % But we always want a comma and a space:
7182 % output the `page 3'.
7183 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7189 % This macro is called from \xrefX for the `[nodename]' part of xref
7190 % output. It's a separate macro only so it can be changed more easily,
7191 % since square brackets don't work well in some documents. Particularly
7192 % one that Bob is working on :).
7194 \def\xrefprintnodename#1{[#1]}
7196 % Things referred to by \setref.
7202 \putwordChapter@tie \the\chapno
7203 \else \ifnum\subsecno=0
7204 \putwordSection@tie \the\chapno.\the\secno
7205 \else \ifnum\subsubsecno=0
7206 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7208 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7213 \putwordAppendix@tie @char\the\appendixno{}%
7214 \else \ifnum\subsecno=0
7215 \putwordSection@tie @char\the\appendixno.\the\secno
7216 \else \ifnum\subsubsecno=0
7217 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7220 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7224 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7225 % If its value is nonempty, SUFFIX is output afterward.
7231 \expandafter\global\expandafter\let\expandafter\thisrefX
7232 \csname XR#1\endcsname
7235 % If not defined, say something at least.
7236 \angleleft un\-de\-fined\angleright
7239 \message{\linenumber Undefined cross reference `#1'.}%
7242 \global\warnedxrefstrue
7243 \message{Cross reference values unknown; you must run TeX again.}%
7248 % It's defined, so just use it.
7251 #2% Output the suffix in any case.
7254 % This is the macro invoked by entries in the aux file. Usually it's
7255 % just a \def (we prepend XR to the control sequence name to avoid
7256 % collisions). But if this is a float type, we have more work to do.
7259 {% The node name might contain 8-bit characters, which in our current
7260 % implementation are changed to commands like @'e. Don't let these
7261 % mess up the control sequence name.
7264 \xdef\safexrefname{#1}%
7267 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7269 % Was that xref control sequence that we just defined for a float?
7270 \expandafter\iffloat\csname XR\safexrefname\endcsname
7271 % it was a float, and we have the (safe) float type in \iffloattype.
7272 \expandafter\let\expandafter\floatlist
7273 \csname floatlist\iffloattype\endcsname
7275 % Is this the first time we've seen this float type?
7276 \expandafter\ifx\floatlist\relax
7277 \toks0 = {\do}% yes, so just \do
7279 % had it before, so preserve previous elements in list.
7280 \toks0 = \expandafter{\floatlist\do}%
7283 % Remember this xref in the control sequence \floatlistFLOATTYPE,
7284 % for later use in \listoffloats.
7285 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
7290 % Read the last existing aux file, if any. No error if none exists.
7293 \openin 1 \jobname.aux
7296 \global\havexrefstrue
7301 \def\setupdatafile{%
7302 \catcode`\^^@=\other
7303 \catcode`\^^A=\other
7304 \catcode`\^^B=\other
7305 \catcode`\^^C=\other
7306 \catcode`\^^D=\other
7307 \catcode`\^^E=\other
7308 \catcode`\^^F=\other
7309 \catcode`\^^G=\other
7310 \catcode`\^^H=\other
7311 \catcode`\^^K=\other
7312 \catcode`\^^L=\other
7313 \catcode`\^^N=\other
7314 \catcode`\^^P=\other
7315 \catcode`\^^Q=\other
7316 \catcode`\^^R=\other
7317 \catcode`\^^S=\other
7318 \catcode`\^^T=\other
7319 \catcode`\^^U=\other
7320 \catcode`\^^V=\other
7321 \catcode`\^^W=\other
7322 \catcode`\^^X=\other
7323 \catcode`\^^Z=\other
7324 \catcode`\^^[=\other
7325 \catcode`\^^\=\other
7326 \catcode`\^^]=\other
7327 \catcode`\^^^=\other
7328 \catcode`\^^_=\other
7329 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
7330 % in xref tags, i.e., node names. But since ^^e4 notation isn't
7331 % supported in the main text, it doesn't seem desirable. Furthermore,
7332 % that is not enough: for node names that actually contain a ^
7333 % character, we would end up writing a line like this: 'xrdef {'hat
7334 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
7335 % argument, and \hat is not an expandable control sequence. It could
7336 % all be worked out, but why? Either we support ^^ or we don't.
7338 % The other change necessary for this was to define \auxhat:
7339 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
7340 % and then to call \auxhat in \setq.
7344 % Special characters. Should be turned off anyway, but...
7357 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
7359 % This is to support \ in node names and titles, since the \
7360 % characters end up in a \csname. It's easier than
7361 % leaving it active and making its active definition an actual \
7362 % character. What I don't understand is why it works in the *value*
7363 % of the xrdef. Seems like it should be a catcode12 \, and that
7364 % should not typeset properly. But it works, so I'm moving on for
7365 % now. --karl, 15jan04.
7368 % Make the characters 128-255 be printing characters.
7372 \catcode\count1=\other
7373 \advance\count1 by 1
7374 \ifnum \count1<256 \loop \fi
7378 % @ is our escape character in .aux files, and we need braces.
7384 \def\readdatafile#1{%
7391 \message{insertions,}
7392 % including footnotes.
7394 \newcount \footnoteno
7396 % The trailing space in the following definition for supereject is
7397 % vital for proper filling; pages come out unaligned when you do a
7398 % pagealignmacro call if that space before the closing brace is
7399 % removed. (Generally, numeric constants should always be followed by a
7400 % space to prevent strange expansion errors.)
7401 \def\supereject{\par\penalty -20000\footnoteno =0 }
7403 % @footnotestyle is meaningful for info output only.
7404 \let\footnotestyle=\comment
7408 % Auto-number footnotes. Otherwise like plain.
7410 \let\indent=\ptexindent
7411 \let\noindent=\ptexnoindent
7412 \global\advance\footnoteno by \@ne
7413 \edef\thisfootno{$^{\the\footnoteno}$}%
7415 % In case the footnote comes at the end of a sentence, preserve the
7416 % extra spacing after we do the footnote number.
7418 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
7420 % Remove inadvertent blank space before typesetting the footnote number.
7426 % Don't bother with the trickery in plain.tex to not require the
7427 % footnote text as a parameter. Our footnotes don't need to be so general.
7429 % Oh yes, they do; otherwise, @ifset (and anything else that uses
7430 % \parseargline) fails inside footnotes because the tokens are fixed when
7431 % the footnote is read. --karl, 16nov96.
7434 \insert\footins\bgroup
7435 % We want to typeset this text as a normal paragraph, even if the
7436 % footnote reference occurs in (for example) a display environment.
7437 % So reset some parameters.
7439 \interlinepenalty\interfootnotelinepenalty
7440 \splittopskip\ht\strutbox % top baseline for broken footnotes
7441 \splitmaxdepth\dp\strutbox
7442 \floatingpenalty\@MM
7447 \parindent\defaultparindent
7451 % Because we use hanging indentation in footnotes, a @noindent appears
7452 % to exdent this text, so make it be a no-op. makeinfo does not use
7453 % hanging indentation so @noindent can still be needed within footnote
7454 % text after an @example or the like (not that this is good style).
7455 \let\noindent = \relax
7457 % Hang the footnote text off the number. Use \everypar in case the
7458 % footnote extends for more than one paragraph.
7459 \everypar = {\hang}%
7460 \textindent{\thisfootno}%
7462 % Don't crash into the line above the footnote text. Since this
7463 % expands into a box, it must come within the paragraph, lest it
7464 % provide a place where TeX can split the footnote.
7466 \futurelet\next\fo@t
7468 }%end \catcode `\@=11
7470 % In case a @footnote appears in a vbox, save the footnote text and create
7471 % the real \insert just after the vbox finished. Otherwise, the insertion
7473 % Similarly, if a @footnote appears inside an alignment, save the footnote
7474 % text to a box and make the \insert when a row of the table is finished.
7475 % And the same can be done for other insert classes. --kasal, 16nov03.
7477 % Replace the \insert primitive by a cheating macro.
7478 % Deeper inside, just make sure that the saved insertions are not spilled
7481 \def\startsavinginserts{%
7482 \ifx \insert\ptexinsert
7483 \let\insert\saveinsert
7485 \let\checkinserts\relax
7489 % This \insert replacement works for both \insert\footins{foo} and
7490 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
7493 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
7494 \afterassignment\next
7495 % swallow the left brace
7498 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
7499 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
7501 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
7503 \def\placesaveins#1{%
7504 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
7508 % eat @SAVE -- beware, all of them have catcode \other:
7510 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
7511 \gdef\gobblesave @SAVE{}
7515 \def\newsaveins #1{%
7516 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
7519 \def\newsaveinsX #1{%
7520 \csname newbox\endcsname #1%
7521 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7526 \let\checkinserts\empty
7531 % @image. We use the macros from epsf.tex to support this.
7532 % If epsf.tex is not installed and @image is used, we complain.
7534 % Check for and read epsf.tex up front. If we read it only at @image
7535 % time, we might be inside a group, and then its definitions would get
7536 % undone and the next image would fail.
7537 \openin 1 = epsf.tex
7539 % Do not bother showing banner with epsf.tex v2.7k (available in
7540 % doc/epsf.tex and on ctan).
7541 \def\epsfannounce{\toks0 = }%
7546 % We will only complain once about lack of epsf.tex.
7547 \newif\ifwarnednoepsf
7548 \newhelp\noepsfhelp{epsf.tex must be installed for images to
7549 work. It is also included in the Texinfo distribution, or you can get
7550 it from ftp://tug.org/tex/epsf.tex.}
7553 \ifx\epsfbox\undefined
7554 \ifwarnednoepsf \else
7555 \errhelp = \noepsfhelp
7556 \errmessage{epsf.tex not found, images will be ignored}%
7557 \global\warnednoepsftrue
7560 \imagexxx #1,,,,,\finish
7564 % Arguments to @image:
7565 % #1 is (mandatory) image filename; we tack on .eps extension.
7566 % #2 is (optional) width, #3 is (optional) height.
7567 % #4 is (ignored optional) html alt text.
7568 % #5 is (ignored optional) extension.
7569 % #6 is just the usual extra ignored arg for parsing this stuff.
7571 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7572 \catcode`\^^M = 5 % in case we're inside an example
7573 \normalturnoffactive % allow _ et al. in names
7574 % If the image is by itself, center it.
7578 % Usually we'll have text after the image which will insert
7579 % \parskip glue, so insert it here too to equalize the space
7581 \nobreak\vskip\parskip
7585 % Leave vertical mode so that indentation from an enclosing
7586 % environment such as @quotation is respected. On the other hand, if
7587 % it's at the top level, we don't want the normal paragraph indentation.
7592 \dopdfimage{#1}{#2}{#3}%
7594 % \epsfbox itself resets \epsf?size at each figure.
7595 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
7596 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7600 \ifimagevmode \medskip \fi % space after the standalone image
7604 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7605 % etc. We don't actually implement floating yet, we always include the
7606 % float "here". But it seemed the best name for the future.
7608 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7610 % There may be a space before second and/or third parameter; delete it.
7611 \def\eatcommaspace#1, {#1,}
7613 % #1 is the optional FLOATTYPE, the text label for this float, typically
7614 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
7615 % this float will not be numbered and cannot be referred to.
7617 % #2 is the optional xref label. Also must be present for the float to
7620 % #3 is the optional positioning argument; for now, it is ignored. It
7621 % will somehow specify the positions allowed to float to (here, top, bottom).
7623 % We keep a separate counter for each FLOATTYPE, which we reset at each
7624 % chapter-level command.
7625 \let\resetallfloatnos=\empty
7627 \def\dofloat#1,#2,#3,#4\finish{%
7628 \let\thiscaption=\empty
7629 \let\thisshortcaption=\empty
7631 % don't lose footnotes inside @float.
7633 % BEWARE: when the floats start float, we have to issue warning whenever an
7634 % insert appears inside a float which could possibly float. --kasal, 26may04
7638 % We can't be used inside a paragraph.
7643 \def\floatlabel{#2}%
7644 \def\floatloc{#3}% we do nothing with this yet.
7646 \ifx\floattype\empty
7647 \let\safefloattype=\empty
7650 % the floattype might have accents or other special characters,
7651 % but we need to use it in a control sequence name.
7654 \xdef\safefloattype{\floattype}%
7658 % If label is given but no type, we handle that as the empty type.
7659 \ifx\floatlabel\empty \else
7660 % We want each FLOATTYPE to be numbered separately (Figure 1,
7661 % Table 1, Figure 2, ...). (And if no label, no number.)
7663 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7664 \global\advance\floatno by 1
7667 % This magic value for \lastsection is output by \setref as the
7668 % XREFLABEL-title value. \xrefX uses it to distinguish float
7669 % labels (which have a completely different output format) from
7670 % node and anchor labels. And \xrdef uses it to construct the
7673 \edef\lastsection{\floatmagic=\safefloattype}%
7674 \setref{\floatlabel}{Yfloat}%
7678 % start with \parskip glue, I guess.
7681 % Don't suppress indentation if a float happens to start a section.
7682 \restorefirstparagraphindent
7685 % we have these possibilities:
7686 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7687 % @float Foo,lbl & no caption: Foo 1.1
7688 % @float Foo & @caption{Cap}: Foo: Cap
7689 % @float Foo & no caption: Foo
7690 % @float ,lbl & Caption{Cap}: 1.1: Cap
7691 % @float ,lbl & no caption: 1.1
7692 % @float & @caption{Cap}: Cap
7693 % @float & no caption:
7696 \let\floatident = \empty
7698 % In all cases, if we have a float type, it comes first.
7699 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7701 % If we have an xref label, the number comes next.
7702 \ifx\floatlabel\empty \else
7703 \ifx\floattype\empty \else % if also had float type, need tie first.
7704 \appendtomacro\floatident{\tie}%
7707 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
7710 % Start the printed caption with what we've constructed in
7711 % \floatident, but keep it separate; we need \floatident again.
7712 \let\captionline = \floatident
7714 \ifx\thiscaption\empty \else
7715 \ifx\floatident\empty \else
7716 \appendtomacro\captionline{: }% had ident, so need a colon between
7720 \appendtomacro\captionline{\scanexp\thiscaption}%
7723 % If we have anything to print, print it, with space before.
7724 % Eventually this needs to become an \insert.
7725 \ifx\captionline\empty \else
7729 % Space below caption.
7733 % If have an xref label, write the list of floats info. Do this
7734 % after the caption, to avoid chance of it being a breakpoint.
7735 \ifx\floatlabel\empty \else
7736 % Write the text that goes in the lof to the aux file as
7737 % \floatlabel-lof. Besides \floatident, we include the short
7738 % caption if specified, else the full caption if specified, else nothing.
7742 % since we read the caption text in the macro world, where ^^M
7743 % is turned into a normal character, we have to scan it back, so
7744 % we don't write the literal three characters "^^M" into the aux file.
7746 \xdef\noexpand\gtemp{%
7747 \ifx\thisshortcaption\empty
7754 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7755 \ifx\gtemp\empty \else : \gtemp \fi}}%
7758 \egroup % end of \vtop
7760 % place the captured inserts
7762 % BEWARE: when the floats start floating, we have to issue warning
7763 % whenever an insert appears inside a float which could possibly
7764 % float. --kasal, 26may04
7769 % Append the tokens #2 to the definition of macro #1, not expanding either.
7771 \def\appendtomacro#1#2{%
7772 \expandafter\def\expandafter#1\expandafter{#1#2}%
7775 % @caption, @shortcaption
7777 \def\caption{\docaption\thiscaption}
7778 \def\shortcaption{\docaption\thisshortcaption}
7779 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7780 \def\defcaption#1#2{\egroup \def#1{#2}}
7782 % The parameter is the control sequence identifying the counter we are
7783 % going to use. Create it if it doesn't exist and assign it to \floatno.
7786 % Haven't seen this figure type before.
7787 \csname newcount\endcsname #1%
7789 % Remember to reset this floatno at the next chap.
7790 \expandafter\gdef\expandafter\resetallfloatnos
7791 \expandafter{\resetallfloatnos #1=0 }%
7796 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
7797 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
7798 % first read the @float command.
7800 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7802 % Magic string used for the XREFLABEL-title value, so \xrefX can
7803 % distinguish floats from other xref types.
7804 \def\floatmagic{!!float!!}
7806 % #1 is the control sequence we are passed; we expand into a conditional
7807 % which is true if #1 represents a float ref. That is, the magic
7808 % \lastsection value which we \setref above.
7810 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7812 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
7813 % (safe) float type for this float. We set \iffloattype to #2.
7815 \def\doiffloat#1=#2=#3\finish{%
7817 \def\iffloattype{#2}%
7818 \ifx\temp\floatmagic
7821 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7823 \parseargdef\listoffloats{%
7824 \def\floattype{#1}% floattype
7826 % the floattype might have accents or other special characters,
7827 % but we need to use it in a control sequence name.
7830 \xdef\safefloattype{\floattype}%
7833 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
7834 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
7836 % if the user said @listoffloats foo but never @float foo.
7837 \message{\linenumber No `\safefloattype' floats to list.}%
7841 \leftskip=\tocindent % indent these entries like a toc
7842 \let\do=\listoffloatsdo
7843 \csname floatlist\safefloattype\endcsname
7848 % This is called on each entry in a list of floats. We're passed the
7849 % xref label, in the form LABEL-title, which is how we save it in the
7850 % aux file. We strip off the -title and look up \XRLABEL-lof, which
7851 % has the text we're supposed to typeset here.
7853 % Figures without xref labels will not be included in the list (since
7854 % they won't appear in the aux file).
7856 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
7857 \def\listoffloatsdoentry#1-title\finish{{%
7858 % Can't fully expand XR#1-lof because it can contain anything. Just
7859 % pass the control sequence. On the other hand, XR#1-pg is just the
7860 % page number, and we want to fully expand that so we can get a link
7862 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
7864 % use the same \entry macro we use to generate the TOC and index.
7865 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
7870 \message{localization,}
7872 % For single-language documents, @documentlanguage is usually given very
7873 % early, just after @documentencoding. Single argument is the language
7874 % (de) or locale (de_DE) abbreviation.
7877 \catcode`\_ = \active
7879 \parseargdef\documentlanguage{\begingroup
7880 \let_=\normalunderscore % normal _ character for filenames
7881 \tex % read txi-??.tex file in plain TeX.
7882 % Read the file by the name they passed if it exists.
7883 \openin 1 txi-#1.tex
7885 \documentlanguagetrywithoutunderscore{#1_\finish}%
7887 \globaldefs = 1 % everything in the txi-LL files needs to persist
7891 \endgroup % end raw TeX
7895 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
7898 \def\documentlanguagetrywithoutunderscore#1_#2\finish{%
7899 \openin 1 txi-#1.tex
7901 \errhelp = \nolanghelp
7902 \errmessage{Cannot read language file txi-#1.tex}%
7909 \newhelp\nolanghelp{The given language definition file cannot be found or
7910 is empty. Maybe you need to install it? Putting it in the current
7911 directory should work if nowhere else does.}
7913 % This macro is called from txi-??.tex files; the first argument is the
7914 % \language name to set (without the "\lang@" prefix), the second and
7915 % third args are \{left,right}hyphenmin.
7917 % The language names to pass are determined when the format is built.
7918 % See the etex.log file created at that time, e.g.,
7919 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
7921 % With TeX Live 2008, etex now includes hyphenation patterns for all
7922 % available languages. This means we can support hyphenation in
7923 % Texinfo, at least to some extent. (This still doesn't solve the
7924 % accented characters problem.)
7927 \def\txisetlanguage#1#2#3{%
7928 % do not set the language if the name is undefined in the current TeX.
7929 \expandafter\ifx\csname lang@#1\endcsname \relax
7930 \message{no patterns for #1}%
7932 \global\language = \csname lang@#1\endcsname
7934 % but there is no harm in adjusting the hyphenmin values regardless.
7935 \global\lefthyphenmin = #2\relax
7936 \global\righthyphenmin = #3\relax
7939 % Helpers for encodings.
7940 % Set the catcode of characters 128 through 255 to the specified number.
7942 \def\setnonasciicharscatcode#1{%
7944 \loop\ifnum\count255<256
7945 \global\catcode\count255=#1\relax
7946 \advance\count255 by 1
7950 \def\setnonasciicharscatcodenonglobal#1{%
7952 \loop\ifnum\count255<256
7953 \catcode\count255=#1\relax
7954 \advance\count255 by 1
7958 % @documentencoding sets the definition of non-ASCII characters
7959 % according to the specified encoding.
7961 \parseargdef\documentencoding{%
7962 % Encoding being declared for the document.
7963 \def\declaredencoding{\csname #1.enc\endcsname}%
7965 % Supported encodings: names converted to tokens in order to be able
7966 % to compare them with \ifx.
7967 \def\ascii{\csname US-ASCII.enc\endcsname}%
7968 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
7969 \def\latone{\csname ISO-8859-1.enc\endcsname}%
7970 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
7971 \def\utfeight{\csname UTF-8.enc\endcsname}%
7973 \ifx \declaredencoding \ascii
7976 \else \ifx \declaredencoding \lattwo
7977 \setnonasciicharscatcode\active
7980 \else \ifx \declaredencoding \latone
7981 \setnonasciicharscatcode\active
7984 \else \ifx \declaredencoding \latnine
7985 \setnonasciicharscatcode\active
7988 \else \ifx \declaredencoding \utfeight
7989 \setnonasciicharscatcode\active
7993 \message{Unknown document encoding #1, ignoring.}%
8002 % A message to be logged when using a character that isn't available
8003 % the default font encoding (OT1).
8005 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8007 % Take account of \c (plain) vs. \, (Texinfo) difference.
8008 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8010 % First, make active non-ASCII characters in order for them to be
8011 % correctly categorized when TeX reads the replacement text of
8012 % macros containing the character definitions.
8013 \setnonasciicharscatcode\active
8015 % Latin1 (ISO-8859-1) character definitions.
8016 \def\latonechardefs{%
8018 \gdef^^a1{\exclamdown}
8019 \gdef^^a2{\missingcharmsg{CENT SIGN}}
8020 \gdef^^a3{{\pounds}}
8021 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8022 \gdef^^a5{\missingcharmsg{YEN SIGN}}
8023 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8026 \gdef^^a9{\copyright}
8028 \gdef^^ab{\guillemetleft}
8031 \gdef^^ae{\registeredsymbol}
8034 \gdef^^b0{\textdegree}
8043 \gdef^^b8{\cedilla\ }
8047 \gdef^^bb{\guilletright}
8048 \gdef^^bc{$1\over4$}
8049 \gdef^^bd{$1\over2$}
8050 \gdef^^be{$3\over4$}
8051 \gdef^^bf{\questiondown}
8058 \gdef^^c5{\ringaccent A}
8060 \gdef^^c7{\cedilla C}
8070 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER ETH}}
8084 \gdef^^de{\missingcharmsg{LATIN CAPITAL LETTER THORN}}
8092 \gdef^^e5{\ringaccent a}
8094 \gdef^^e7{\cedilla c}
8099 \gdef^^ec{\`{\dotless i}}
8100 \gdef^^ed{\'{\dotless i}}
8101 \gdef^^ee{\^{\dotless i}}
8102 \gdef^^ef{\"{\dotless i}}
8104 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER ETH}}
8118 \gdef^^fe{\missingcharmsg{LATIN SMALL LETTER THORN}}
8122 % Latin9 (ISO-8859-15) encoding character definitions.
8123 \def\latninechardefs{%
8124 % Encoding is almost identical to Latin1.
8137 % Latin2 (ISO-8859-2) character definitions.
8138 \def\lattwochardefs{%
8140 \gdef^^a1{\ogonek{A}}
8143 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8149 \gdef^^aa{\cedilla S}
8154 \gdef^^af{\dotaccent Z}
8156 \gdef^^b0{\textdegree}
8157 \gdef^^b1{\ogonek{a}}
8158 \gdef^^b2{\ogonek{ }}
8164 \gdef^^b8{\cedilla\ }
8166 \gdef^^ba{\cedilla s}
8171 \gdef^^bf{\dotaccent z}
8180 \gdef^^c7{\cedilla C}
8183 \gdef^^ca{\ogonek{E}}
8190 \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER D WITH STROKE}}
8199 \gdef^^d9{\ringaccent U}
8204 \gdef^^de{\cedilla T}
8214 \gdef^^e7{\cedilla c}
8217 \gdef^^ea{\ogonek{e}}
8224 \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER D WITH STROKE}}
8233 \gdef^^f9{\ringaccent u}
8238 \gdef^^fe{\cedilla t}
8239 \gdef^^ff{\dotaccent{}}
8242 % UTF-8 character definitions.
8244 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8245 % changes for Texinfo conventions. It is included here under the GPL by
8246 % permission from Frank Mittelbach and the LaTeX team.
8252 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8253 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8255 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8256 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8258 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8259 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8261 \gdef\UTFviiiDefined#1{%
8263 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8274 \global\catcode\countUTFx\active
8275 \uccode`\~\countUTFx
8276 \uppercase\expandafter{\UTFviiiTmp}%
8277 \advance\countUTFx by 1
8278 \ifnum\countUTFx < \countUTFy
8279 \expandafter\UTFviiiLoop
8285 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
8291 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
8297 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
8310 \gdef\DeclareUnicodeCharacter#1#2{%
8311 \countUTFz = "#1\relax
8312 \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
8315 \def\UTFviiiTwoOctets##1##2{%
8316 \csname u8:##1\string ##2\endcsname}%
8317 \def\UTFviiiThreeOctets##1##2##3{%
8318 \csname u8:##1\string ##2\string ##3\endcsname}%
8319 \def\UTFviiiFourOctets##1##2##3##4{%
8320 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
8321 \expandafter\expandafter\expandafter\expandafter
8322 \expandafter\expandafter\expandafter
8323 \gdef\UTFviiiTmp{#2}%
8326 \gdef\parseXMLCharref{%
8327 \ifnum\countUTFz < "A0\relax
8328 \errhelp = \EMsimple
8329 \errmessage{Cannot define Unicode char value < 00A0}%
8330 \else\ifnum\countUTFz < "800\relax
8332 \parseUTFviiiB C\UTFviiiTwoOctets.,%
8333 \else\ifnum\countUTFz < "10000\relax
8336 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
8341 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
8345 \gdef\parseUTFviiiA#1{%
8346 \countUTFx = \countUTFz
8347 \divide\countUTFz by 64
8348 \countUTFy = \countUTFz
8349 \multiply\countUTFz by 64
8350 \advance\countUTFx by -\countUTFz
8351 \advance\countUTFx by 128
8352 \uccode `#1\countUTFx
8353 \countUTFz = \countUTFy}
8355 \gdef\parseUTFviiiB#1#2#3#4{%
8356 \advance\countUTFz by "#10\relax
8357 \uccode `#3\countUTFz
8358 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
8361 \def\utfeightchardefs{%
8362 \DeclareUnicodeCharacter{00A0}{\tie}
8363 \DeclareUnicodeCharacter{00A1}{\exclamdown}
8364 \DeclareUnicodeCharacter{00A3}{\pounds}
8365 \DeclareUnicodeCharacter{00A8}{\"{ }}
8366 \DeclareUnicodeCharacter{00A9}{\copyright}
8367 \DeclareUnicodeCharacter{00AA}{\ordf}
8368 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
8369 \DeclareUnicodeCharacter{00AD}{\-}
8370 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
8371 \DeclareUnicodeCharacter{00AF}{\={ }}
8373 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
8374 \DeclareUnicodeCharacter{00B4}{\'{ }}
8375 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
8376 \DeclareUnicodeCharacter{00BA}{\ordm}
8377 \DeclareUnicodeCharacter{00BB}{\guillemetright}
8378 \DeclareUnicodeCharacter{00BF}{\questiondown}
8380 \DeclareUnicodeCharacter{00C0}{\`A}
8381 \DeclareUnicodeCharacter{00C1}{\'A}
8382 \DeclareUnicodeCharacter{00C2}{\^A}
8383 \DeclareUnicodeCharacter{00C3}{\~A}
8384 \DeclareUnicodeCharacter{00C4}{\"A}
8385 \DeclareUnicodeCharacter{00C5}{\AA}
8386 \DeclareUnicodeCharacter{00C6}{\AE}
8387 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
8388 \DeclareUnicodeCharacter{00C8}{\`E}
8389 \DeclareUnicodeCharacter{00C9}{\'E}
8390 \DeclareUnicodeCharacter{00CA}{\^E}
8391 \DeclareUnicodeCharacter{00CB}{\"E}
8392 \DeclareUnicodeCharacter{00CC}{\`I}
8393 \DeclareUnicodeCharacter{00CD}{\'I}
8394 \DeclareUnicodeCharacter{00CE}{\^I}
8395 \DeclareUnicodeCharacter{00CF}{\"I}
8397 \DeclareUnicodeCharacter{00D1}{\~N}
8398 \DeclareUnicodeCharacter{00D2}{\`O}
8399 \DeclareUnicodeCharacter{00D3}{\'O}
8400 \DeclareUnicodeCharacter{00D4}{\^O}
8401 \DeclareUnicodeCharacter{00D5}{\~O}
8402 \DeclareUnicodeCharacter{00D6}{\"O}
8403 \DeclareUnicodeCharacter{00D8}{\O}
8404 \DeclareUnicodeCharacter{00D9}{\`U}
8405 \DeclareUnicodeCharacter{00DA}{\'U}
8406 \DeclareUnicodeCharacter{00DB}{\^U}
8407 \DeclareUnicodeCharacter{00DC}{\"U}
8408 \DeclareUnicodeCharacter{00DD}{\'Y}
8409 \DeclareUnicodeCharacter{00DF}{\ss}
8411 \DeclareUnicodeCharacter{00E0}{\`a}
8412 \DeclareUnicodeCharacter{00E1}{\'a}
8413 \DeclareUnicodeCharacter{00E2}{\^a}
8414 \DeclareUnicodeCharacter{00E3}{\~a}
8415 \DeclareUnicodeCharacter{00E4}{\"a}
8416 \DeclareUnicodeCharacter{00E5}{\aa}
8417 \DeclareUnicodeCharacter{00E6}{\ae}
8418 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
8419 \DeclareUnicodeCharacter{00E8}{\`e}
8420 \DeclareUnicodeCharacter{00E9}{\'e}
8421 \DeclareUnicodeCharacter{00EA}{\^e}
8422 \DeclareUnicodeCharacter{00EB}{\"e}
8423 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
8424 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
8425 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
8426 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
8428 \DeclareUnicodeCharacter{00F1}{\~n}
8429 \DeclareUnicodeCharacter{00F2}{\`o}
8430 \DeclareUnicodeCharacter{00F3}{\'o}
8431 \DeclareUnicodeCharacter{00F4}{\^o}
8432 \DeclareUnicodeCharacter{00F5}{\~o}
8433 \DeclareUnicodeCharacter{00F6}{\"o}
8434 \DeclareUnicodeCharacter{00F8}{\o}
8435 \DeclareUnicodeCharacter{00F9}{\`u}
8436 \DeclareUnicodeCharacter{00FA}{\'u}
8437 \DeclareUnicodeCharacter{00FB}{\^u}
8438 \DeclareUnicodeCharacter{00FC}{\"u}
8439 \DeclareUnicodeCharacter{00FD}{\'y}
8440 \DeclareUnicodeCharacter{00FF}{\"y}
8442 \DeclareUnicodeCharacter{0100}{\=A}
8443 \DeclareUnicodeCharacter{0101}{\=a}
8444 \DeclareUnicodeCharacter{0102}{\u{A}}
8445 \DeclareUnicodeCharacter{0103}{\u{a}}
8446 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
8447 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
8448 \DeclareUnicodeCharacter{0106}{\'C}
8449 \DeclareUnicodeCharacter{0107}{\'c}
8450 \DeclareUnicodeCharacter{0108}{\^C}
8451 \DeclareUnicodeCharacter{0109}{\^c}
8452 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
8453 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
8454 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
8455 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
8456 \DeclareUnicodeCharacter{010C}{\v{C}}
8457 \DeclareUnicodeCharacter{010D}{\v{c}}
8458 \DeclareUnicodeCharacter{010E}{\v{D}}
8460 \DeclareUnicodeCharacter{0112}{\=E}
8461 \DeclareUnicodeCharacter{0113}{\=e}
8462 \DeclareUnicodeCharacter{0114}{\u{E}}
8463 \DeclareUnicodeCharacter{0115}{\u{e}}
8464 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
8465 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
8466 \DeclareUnicodeCharacter{011A}{\v{E}}
8467 \DeclareUnicodeCharacter{011B}{\v{e}}
8468 \DeclareUnicodeCharacter{011C}{\^G}
8469 \DeclareUnicodeCharacter{011D}{\^g}
8470 \DeclareUnicodeCharacter{011E}{\u{G}}
8471 \DeclareUnicodeCharacter{011F}{\u{g}}
8473 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8474 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8475 \DeclareUnicodeCharacter{0124}{\^H}
8476 \DeclareUnicodeCharacter{0125}{\^h}
8477 \DeclareUnicodeCharacter{0128}{\~I}
8478 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8479 \DeclareUnicodeCharacter{012A}{\=I}
8480 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8481 \DeclareUnicodeCharacter{012C}{\u{I}}
8482 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8484 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8485 \DeclareUnicodeCharacter{0131}{\dotless{i}}
8486 \DeclareUnicodeCharacter{0132}{IJ}
8487 \DeclareUnicodeCharacter{0133}{ij}
8488 \DeclareUnicodeCharacter{0134}{\^J}
8489 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8490 \DeclareUnicodeCharacter{0139}{\'L}
8491 \DeclareUnicodeCharacter{013A}{\'l}
8493 \DeclareUnicodeCharacter{0141}{\L}
8494 \DeclareUnicodeCharacter{0142}{\l}
8495 \DeclareUnicodeCharacter{0143}{\'N}
8496 \DeclareUnicodeCharacter{0144}{\'n}
8497 \DeclareUnicodeCharacter{0147}{\v{N}}
8498 \DeclareUnicodeCharacter{0148}{\v{n}}
8499 \DeclareUnicodeCharacter{014C}{\=O}
8500 \DeclareUnicodeCharacter{014D}{\=o}
8501 \DeclareUnicodeCharacter{014E}{\u{O}}
8502 \DeclareUnicodeCharacter{014F}{\u{o}}
8504 \DeclareUnicodeCharacter{0150}{\H{O}}
8505 \DeclareUnicodeCharacter{0151}{\H{o}}
8506 \DeclareUnicodeCharacter{0152}{\OE}
8507 \DeclareUnicodeCharacter{0153}{\oe}
8508 \DeclareUnicodeCharacter{0154}{\'R}
8509 \DeclareUnicodeCharacter{0155}{\'r}
8510 \DeclareUnicodeCharacter{0158}{\v{R}}
8511 \DeclareUnicodeCharacter{0159}{\v{r}}
8512 \DeclareUnicodeCharacter{015A}{\'S}
8513 \DeclareUnicodeCharacter{015B}{\'s}
8514 \DeclareUnicodeCharacter{015C}{\^S}
8515 \DeclareUnicodeCharacter{015D}{\^s}
8516 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8517 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8519 \DeclareUnicodeCharacter{0160}{\v{S}}
8520 \DeclareUnicodeCharacter{0161}{\v{s}}
8521 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8522 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8523 \DeclareUnicodeCharacter{0164}{\v{T}}
8525 \DeclareUnicodeCharacter{0168}{\~U}
8526 \DeclareUnicodeCharacter{0169}{\~u}
8527 \DeclareUnicodeCharacter{016A}{\=U}
8528 \DeclareUnicodeCharacter{016B}{\=u}
8529 \DeclareUnicodeCharacter{016C}{\u{U}}
8530 \DeclareUnicodeCharacter{016D}{\u{u}}
8531 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8532 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8534 \DeclareUnicodeCharacter{0170}{\H{U}}
8535 \DeclareUnicodeCharacter{0171}{\H{u}}
8536 \DeclareUnicodeCharacter{0174}{\^W}
8537 \DeclareUnicodeCharacter{0175}{\^w}
8538 \DeclareUnicodeCharacter{0176}{\^Y}
8539 \DeclareUnicodeCharacter{0177}{\^y}
8540 \DeclareUnicodeCharacter{0178}{\"Y}
8541 \DeclareUnicodeCharacter{0179}{\'Z}
8542 \DeclareUnicodeCharacter{017A}{\'z}
8543 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8544 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8545 \DeclareUnicodeCharacter{017D}{\v{Z}}
8546 \DeclareUnicodeCharacter{017E}{\v{z}}
8548 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8549 \DeclareUnicodeCharacter{01C5}{D\v{z}}
8550 \DeclareUnicodeCharacter{01C6}{d\v{z}}
8551 \DeclareUnicodeCharacter{01C7}{LJ}
8552 \DeclareUnicodeCharacter{01C8}{Lj}
8553 \DeclareUnicodeCharacter{01C9}{lj}
8554 \DeclareUnicodeCharacter{01CA}{NJ}
8555 \DeclareUnicodeCharacter{01CB}{Nj}
8556 \DeclareUnicodeCharacter{01CC}{nj}
8557 \DeclareUnicodeCharacter{01CD}{\v{A}}
8558 \DeclareUnicodeCharacter{01CE}{\v{a}}
8559 \DeclareUnicodeCharacter{01CF}{\v{I}}
8561 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8562 \DeclareUnicodeCharacter{01D1}{\v{O}}
8563 \DeclareUnicodeCharacter{01D2}{\v{o}}
8564 \DeclareUnicodeCharacter{01D3}{\v{U}}
8565 \DeclareUnicodeCharacter{01D4}{\v{u}}
8567 \DeclareUnicodeCharacter{01E2}{\={\AE}}
8568 \DeclareUnicodeCharacter{01E3}{\={\ae}}
8569 \DeclareUnicodeCharacter{01E6}{\v{G}}
8570 \DeclareUnicodeCharacter{01E7}{\v{g}}
8571 \DeclareUnicodeCharacter{01E8}{\v{K}}
8572 \DeclareUnicodeCharacter{01E9}{\v{k}}
8574 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8575 \DeclareUnicodeCharacter{01F1}{DZ}
8576 \DeclareUnicodeCharacter{01F2}{Dz}
8577 \DeclareUnicodeCharacter{01F3}{dz}
8578 \DeclareUnicodeCharacter{01F4}{\'G}
8579 \DeclareUnicodeCharacter{01F5}{\'g}
8580 \DeclareUnicodeCharacter{01F8}{\`N}
8581 \DeclareUnicodeCharacter{01F9}{\`n}
8582 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8583 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8584 \DeclareUnicodeCharacter{01FE}{\'{\O}}
8585 \DeclareUnicodeCharacter{01FF}{\'{\o}}
8587 \DeclareUnicodeCharacter{021E}{\v{H}}
8588 \DeclareUnicodeCharacter{021F}{\v{h}}
8590 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8591 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8592 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8593 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8594 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8595 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8597 \DeclareUnicodeCharacter{0232}{\=Y}
8598 \DeclareUnicodeCharacter{0233}{\=y}
8599 \DeclareUnicodeCharacter{0237}{\dotless{j}}
8601 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
8603 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8604 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8605 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8606 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8607 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8608 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8609 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8610 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8611 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8612 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8613 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8614 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8616 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8617 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8619 \DeclareUnicodeCharacter{1E20}{\=G}
8620 \DeclareUnicodeCharacter{1E21}{\=g}
8621 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8622 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8623 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8624 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8625 \DeclareUnicodeCharacter{1E26}{\"H}
8626 \DeclareUnicodeCharacter{1E27}{\"h}
8628 \DeclareUnicodeCharacter{1E30}{\'K}
8629 \DeclareUnicodeCharacter{1E31}{\'k}
8630 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8631 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8632 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8633 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8634 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8635 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8636 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8637 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8638 \DeclareUnicodeCharacter{1E3E}{\'M}
8639 \DeclareUnicodeCharacter{1E3F}{\'m}
8641 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8642 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8643 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8644 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8645 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8646 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8647 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8648 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8649 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8650 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8652 \DeclareUnicodeCharacter{1E54}{\'P}
8653 \DeclareUnicodeCharacter{1E55}{\'p}
8654 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8655 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8656 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8657 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8658 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8659 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8660 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8661 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8663 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8664 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8665 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8666 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8667 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8668 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8669 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8670 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8671 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8672 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8674 \DeclareUnicodeCharacter{1E7C}{\~V}
8675 \DeclareUnicodeCharacter{1E7D}{\~v}
8676 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8677 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8679 \DeclareUnicodeCharacter{1E80}{\`W}
8680 \DeclareUnicodeCharacter{1E81}{\`w}
8681 \DeclareUnicodeCharacter{1E82}{\'W}
8682 \DeclareUnicodeCharacter{1E83}{\'w}
8683 \DeclareUnicodeCharacter{1E84}{\"W}
8684 \DeclareUnicodeCharacter{1E85}{\"w}
8685 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8686 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8687 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8688 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8689 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8690 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8691 \DeclareUnicodeCharacter{1E8C}{\"X}
8692 \DeclareUnicodeCharacter{1E8D}{\"x}
8693 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8694 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8696 \DeclareUnicodeCharacter{1E90}{\^Z}
8697 \DeclareUnicodeCharacter{1E91}{\^z}
8698 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8699 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8700 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
8701 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
8702 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
8703 \DeclareUnicodeCharacter{1E97}{\"t}
8704 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
8705 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
8707 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
8708 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
8710 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
8711 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
8712 \DeclareUnicodeCharacter{1EBC}{\~E}
8713 \DeclareUnicodeCharacter{1EBD}{\~e}
8715 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
8716 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
8717 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
8718 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
8720 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
8721 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
8723 \DeclareUnicodeCharacter{1EF2}{\`Y}
8724 \DeclareUnicodeCharacter{1EF3}{\`y}
8725 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
8727 \DeclareUnicodeCharacter{1EF8}{\~Y}
8728 \DeclareUnicodeCharacter{1EF9}{\~y}
8730 \DeclareUnicodeCharacter{2013}{--}
8731 \DeclareUnicodeCharacter{2014}{---}
8732 \DeclareUnicodeCharacter{2018}{\quoteleft}
8733 \DeclareUnicodeCharacter{2019}{\quoteright}
8734 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
8735 \DeclareUnicodeCharacter{201C}{\quotedblleft}
8736 \DeclareUnicodeCharacter{201D}{\quotedblright}
8737 \DeclareUnicodeCharacter{201E}{\quotedblbase}
8738 \DeclareUnicodeCharacter{2022}{\bullet}
8739 \DeclareUnicodeCharacter{2026}{\dots}
8740 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
8741 \DeclareUnicodeCharacter{203A}{\guilsinglright}
8742 \DeclareUnicodeCharacter{20AC}{\euro}
8744 \DeclareUnicodeCharacter{2192}{\expansion}
8745 \DeclareUnicodeCharacter{21D2}{\result}
8747 \DeclareUnicodeCharacter{2212}{\minus}
8748 \DeclareUnicodeCharacter{2217}{\point}
8749 \DeclareUnicodeCharacter{2261}{\equiv}
8750 }% end of \utfeightchardefs
8753 % US-ASCII character definitions.
8754 \def\asciichardefs{% nothing need be done
8758 % Make non-ASCII characters printable again for compatibility with
8759 % existing Texinfo documents that may use them, even without declaring a
8760 % document encoding.
8762 \setnonasciicharscatcode \other
8765 \message{formatting,}
8767 \newdimen\defaultparindent \defaultparindent = 15pt
8769 \chapheadingskip = 15pt plus 4pt minus 2pt
8770 \secheadingskip = 12pt plus 3pt minus 2pt
8771 \subsecheadingskip = 9pt plus 2pt minus 2pt
8773 % Prevent underfull vbox error messages.
8776 % Don't be so finicky about underfull hboxes, either.
8779 % Following George Bush, get rid of widows and orphans.
8783 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
8784 % using an old version of TeX, don't do anything. We want the amount of
8785 % stretch added to depend on the line length, hence the dependence on
8786 % \hsize. We call this whenever the paper size is set.
8788 \def\setemergencystretch{%
8789 \ifx\emergencystretch\thisisundefined
8790 % Allow us to assign to \emergencystretch anyway.
8791 \def\emergencystretch{\dimen0}%
8793 \emergencystretch = .15\hsize
8797 % Parameters in order: 1) textheight; 2) textwidth;
8798 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
8799 % 7) physical page height; 8) physical page width.
8801 % We also call \setleading{\textleading}, so the caller should define
8802 % \textleading. The caller should also set \parskip.
8804 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
8807 \splittopskip = \topskip
8810 \advance\vsize by \topskip
8811 \outervsize = \vsize
8812 \advance\outervsize by 2\topandbottommargin
8813 \pageheight = \vsize
8816 \outerhsize = \hsize
8817 \advance\outerhsize by 0.5in
8820 \normaloffset = #4\relax
8821 \bindingoffset = #5\relax
8824 \pdfpageheight #7\relax
8825 \pdfpagewidth #8\relax
8826 % if we don't reset these, they will remain at "1 true in" of
8827 % whatever layout pdftex was dumped with.
8828 \pdfhorigin = 1 true in
8829 \pdfvorigin = 1 true in
8832 \setleading{\textleading}
8834 \parindent = \defaultparindent
8835 \setemergencystretch
8838 % @letterpaper (the default).
8839 \def\letterpaper{{\globaldefs = 1
8840 \parskip = 3pt plus 2pt minus 1pt
8841 \textleading = 13.2pt
8843 % If page is nothing but text, make it come out even.
8844 \internalpagesizes{607.2pt}{6in}% that's 46 lines
8846 {\bindingoffset}{36pt}%
8850 % Use @smallbook to reset parameters for 7x9.25 trim size.
8851 \def\smallbook{{\globaldefs = 1
8852 \parskip = 2pt plus 1pt
8855 \internalpagesizes{7.5in}{5in}%
8857 {\bindingoffset}{16pt}%
8860 \lispnarrowing = 0.3in
8863 \contentsrightmargin = 0pt
8864 \defbodyindent = .5cm
8867 % Use @smallerbook to reset parameters for 6x9 trim size.
8868 % (Just testing, parameters still in flux.)
8869 \def\smallerbook{{\globaldefs = 1
8870 \parskip = 1.5pt plus 1pt
8873 \internalpagesizes{7.4in}{4.8in}%
8878 \lispnarrowing = 0.25in
8881 \contentsrightmargin = 0pt
8882 \defbodyindent = .4cm
8885 % Use @afourpaper to print on European A4 paper.
8886 \def\afourpaper{{\globaldefs = 1
8887 \parskip = 3pt plus 2pt minus 1pt
8888 \textleading = 13.2pt
8890 % Double-side printing via postscript on Laserjet 4050
8891 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
8892 % To change the settings for a different printer or situation, adjust
8893 % \normaloffset until the front-side and back-side texts align. Then
8894 % do the same for \bindingoffset. You can set these for testing in
8895 % your texinfo source file like this:
8897 % \global\normaloffset = -6mm
8898 % \global\bindingoffset = 10mm
8900 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
8901 {\voffset}{\hoffset}%
8902 {\bindingoffset}{44pt}%
8907 \contentsrightmargin = 0pt
8908 \defbodyindent = 5mm
8911 % Use @afivepaper to print on European A5 paper.
8912 % From romildo@urano.iceb.ufop.br, 2 July 2000.
8913 % He also recommends making @example and @lisp be small.
8914 \def\afivepaper{{\globaldefs = 1
8915 \parskip = 2pt plus 1pt minus 0.1pt
8916 \textleading = 12.5pt
8918 \internalpagesizes{160mm}{120mm}%
8919 {\voffset}{\hoffset}%
8920 {\bindingoffset}{8pt}%
8923 \lispnarrowing = 0.2in
8926 \contentsrightmargin = 0pt
8927 \defbodyindent = 2mm
8931 % A specific text layout, 24x15cm overall, intended for A4 paper.
8932 \def\afourlatex{{\globaldefs = 1
8934 \internalpagesizes{237mm}{150mm}%
8936 {\bindingoffset}{7mm}%
8939 % Must explicitly reset to 0 because we call \afourpaper.
8943 % Use @afourwide to print on A4 paper in landscape format.
8944 \def\afourwide{{\globaldefs = 1
8946 \internalpagesizes{241mm}{165mm}%
8947 {\voffset}{-2.95mm}%
8948 {\bindingoffset}{7mm}%
8953 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
8954 % Perhaps we should allow setting the margins, \topskip, \parskip,
8955 % and/or leading, also. Or perhaps we should compute them somehow.
8957 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
8958 \def\pagesizesyyy#1,#2,#3\finish{{%
8959 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
8962 \parskip = 3pt plus 2pt minus 1pt
8963 \setleading{\textleading}%
8966 \advance\dimen0 by \voffset
8969 \advance\dimen2 by \normaloffset
8971 \internalpagesizes{#1}{\hsize}%
8972 {\voffset}{\normaloffset}%
8973 {\bindingoffset}{44pt}%
8977 % Set default to letter.
8982 \message{and turning on texinfo input format.}
8984 % DEL is a comment character, in case @c does not suffice.
8987 % Define macros to output various characters with catcode for normal text.
8997 \def\normaldoublequote{"}
9000 \def\normalunderscore{_}
9001 \def\normalverticalbar{|}
9003 \def\normalgreater{>}
9005 \def\normaldollar{$}%$ font-lock fix
9007 % This macro is used to make a character print one way in \tt
9008 % (where it can probably be output as-is), and another way in other fonts,
9009 % where something hairier probably needs to be done.
9011 % #1 is what to print if we are indeed using \tt; #2 is what to print
9012 % otherwise. Since all the Computer Modern typewriter fonts have zero
9013 % interword stretch (and shrink), and it is reasonable to expect all
9014 % typewriter fonts to have this, we can check that font parameter.
9016 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9018 % Same as above, but check for italic font. Actually this also catches
9019 % non-italic slanted fonts since it is impossible to distinguish them from
9020 % italic fonts. But since this is only used by $ and it uses \sl anyway
9021 % this is not a problem.
9022 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9024 % Turn off all special characters except @
9025 % (and those which the user can use as if they were ordinary).
9026 % Most of these we simply print from the \tt font, but for some, we can
9027 % use math or other variants that look better in normal text.
9030 \def\activedoublequote{{\tt\char34}}
9031 \let"=\activedoublequote
9033 \def~{{\tt\char126}}
9039 \def_{\ifusingtt\normalunderscore\_}
9041 % Subroutine for the previous macro.
9042 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9045 \def|{{\tt\char124}}
9053 \def+{{\tt \char 43}}
9055 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9057 % If a .fmt file is being used, characters that might appear in a file
9058 % name cannot be active until we have parsed the command line.
9059 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9060 % \otherifyactive is called near the end of this file.
9061 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9063 % Used sometimes to turn off (effectively) the active characters even after
9065 \def\turnoffactive{%
9066 \normalturnoffactive
9072 % \backslashcurfont outputs one backslash character in current font,
9074 \global\chardef\backslashcurfont=`\\
9075 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
9077 % \realbackslash is an actual character `\' with catcode other, and
9078 % \doublebackslash is two of them (for the pdf outlines).
9079 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9081 % In texinfo, backslash is an active character; it prints the backslash
9082 % in fixed width font.
9084 @def@normalbackslash{{@tt@backslashcurfont}}
9085 % On startup, @fixbackslash assigns:
9086 % @let \ = @normalbackslash
9088 % \rawbackslash defines an active \ to do \backslashcurfont.
9089 % \otherbackslash defines an active \ to be a literal `\' character with
9091 @gdef@rawbackslash{@let\=@backslashcurfont}
9092 @gdef@otherbackslash{@let\=@realbackslash}
9094 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9095 % the literal character `\'.
9097 @def@normalturnoffactive{%
9098 @let\=@normalbackslash
9099 @let"=@normaldoublequote
9102 @let_=@normalunderscore
9103 @let|=@normalverticalbar
9105 @let>=@normalgreater
9107 @let$=@normaldollar %$ font-lock fix
9108 @markupsetuplqdefault
9109 @markupsetuprqdefault
9113 % Make _ and + \other characters, temporarily.
9114 % This is canceled by @fixbackslash.
9117 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9118 % That is what \eatinput is for; after that, the `\' should revert to printing
9121 @gdef@eatinput input texinfo{@fixbackslash}
9122 @global@let\ = @eatinput
9124 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
9125 % the first `\' in the file would cause an error. This macro tries to fix
9126 % that, assuming it is called before the first `\' could plausibly occur.
9127 % Also turn back on active characters that might appear in the input
9128 % file name, in case not using a pre-dumped format.
9130 @gdef@fixbackslash{%
9131 @ifx\@eatinput @let\ = @normalbackslash @fi
9136 % Say @foo, not \foo, in error messages.
9139 % These look ok in all fonts, so just make them not special.
9140 @catcode`@& = @other
9141 @catcode`@# = @other
9142 @catcode`@% = @other
9144 @c Finally, make ` and ' active, so that txicodequoteundirected and
9145 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
9146 @c don't make ` and ' active, @code will not get them as active chars.
9147 @c Do this last of all since we use ` in the previous @catcode assignments.
9150 @markupsetuplqdefault
9151 @markupsetuprqdefault
9154 @c eval: (add-hook 'write-file-hooks 'time-stamp)
9155 @c page-delimiter: "^\\\\message"
9156 @c time-stamp-start: "def\\\\texinfoversion{"
9157 @c time-stamp-format: "%:y-%02m-%02d.%02H"
9158 @c time-stamp-end: "}"
9164 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115