1 % texinfo.tex -- TeX macros to handle Texinfo files.
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
6 \def\texinfoversion{2010-04-13.15}
8 % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
12 % This texinfo.tex file is free software: you can redistribute it and/or
13 % modify it under the terms of the GNU General Public License as
14 % published by the Free Software Foundation, either version 3 of the
15 % License, or (at your option) any later version.
17 % This texinfo.tex file is distributed in the hope that it will be
18 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
19 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 % General Public License for more details.
22 % You should have received a copy of the GNU General Public License
23 % along with this program. If not, see <http://www.gnu.org/licenses/>.
25 % As a special exception, when this file is read by TeX when processing
26 % a Texinfo source document, you may use the result without
27 % restriction. (This has been our intent since Texinfo was invented.)
29 % Please try the latest version of texinfo.tex before submitting bug
30 % reports; you can get the latest version from:
31 % http://www.gnu.org/software/texinfo/ (the Texinfo home page), or
32 % ftp://tug.org/tex/texinfo.tex
33 % (and all CTAN mirrors, see http://www.ctan.org).
34 % The texinfo.tex in any given distribution could well be out
35 % of date, so if that's what you're using, please check.
37 % Send bug reports to bug-texinfo@gnu.org. Please include including a
38 % complete document in each bug report with which we can reproduce the
39 % problem. Patches are, of course, greatly appreciated.
41 % To process a Texinfo manual with TeX, it's most reliable to use the
42 % texi2dvi shell script that comes with the distribution. For a simple
43 % manual foo.texi, however, you can get away with this:
48 % dvips foo.dvi -o # or whatever; this makes foo.ps.
49 % The extra TeX runs get the cross-reference information correct.
50 % Sometimes one run after texindex suffices, and sometimes you need more
51 % than two; texi2dvi does it as many times as necessary.
53 % It is possible to adapt texinfo.tex for other languages, to some
54 % extent. You can get the existing language-specific files from the
55 % full Texinfo distribution.
57 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
60 \message{Loading texinfo [version \texinfoversion]:}
62 % If in a .fmt file, print the version number
63 % and turn on active characters that we couldn't do earlier because
64 % they might have appeared in the input file name.
65 \everyjob{\message{[Texinfo version \texinfoversion]}%
66 \catcode`+=\active \catcode`\_=\active}
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
96 \let\ptexraggedright=\raggedright
102 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
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 % except using rgb instead of cmyk; the latter is said to render as a
1336 % very dark gray on-screen and a very dark halftone in print, instead
1338 \def\rgbDarkRed{0.50 0.09 0.12}
1339 \def\rgbBlack{0 0 0}
1341 % k sets the color for filling (usual text, etc.);
1342 % K sets the color for stroking (thin rules, e.g., normal _'s).
1343 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1345 % Set color, and create a mark which defines \thiscolor accordingly,
1346 % so that \makeheadline knows which color to restore.
1348 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1353 \def\maincolor{\rgbBlack}
1354 \pdfsetcolor{\maincolor}
1355 \edef\thiscolor{\maincolor}
1356 \def\lastcolordefs{}
1360 \line{\pdfsetcolor{\maincolor}\the\footline}%
1368 % Extract \thiscolor definition from the marks.
1370 % Typeset the headline with \maincolor, then restore the color.
1371 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1379 \pdfcatalog{/PageMode /UseOutlines}
1381 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1382 \def\dopdfimage#1#2#3{%
1383 \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1384 \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1386 % pdftex (and the PDF format) support .png, .jpg, .pdf (among
1387 % others). Let's try in that order.
1388 \let\pdfimgext=\empty
1390 \openin 1 #1.png \ifeof 1
1391 \openin 1 #1.jpg \ifeof 1
1392 \openin 1 #1.jpeg \ifeof 1
1393 \openin 1 #1.JPG \ifeof 1
1394 \openin 1 #1.pdf \ifeof 1
1395 \openin 1 #1.PDF \ifeof 1
1396 \errhelp = \nopdfimagehelp
1397 \errmessage{Could not find image file #1 for pdf}%
1398 \else \gdef\pdfimgext{PDF}%
1400 \else \gdef\pdfimgext{pdf}%
1402 \else \gdef\pdfimgext{JPG}%
1404 \else \gdef\pdfimgext{jpeg}%
1406 \else \gdef\pdfimgext{jpg}%
1408 \else \gdef\pdfimgext{png}%
1413 % without \immediate, ancient pdftex seg faults when the same image is
1414 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1415 \ifnum\pdftexversion < 14
1418 \immediate\pdfximage
1420 \ifdim \wd0 >0pt width \imagewidth \fi
1421 \ifdim \wd2 >0pt height \imageheight \fi
1422 \ifnum\pdftexversion<13
1427 \ifnum\pdftexversion < 14 \else
1428 \pdfrefximage \pdflastximage
1432 % We have to set dummies so commands such as @code, and characters
1433 % such as \, aren't expanded when present in a section title.
1436 \activebackslashdouble
1437 \makevalueexpandable
1438 \def\pdfdestname{#1}%
1439 \backslashparens\pdfdestname
1440 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1443 % used to mark target names; must be expandable.
1446 % by default, use a color that is dark enough to print on paper as
1447 % nearly black, but still distinguishable for online viewing.
1448 \def\urlcolor{\rgbDarkRed}
1449 \def\linkcolor{\rgbDarkRed}
1450 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1452 % Adding outlines to PDF; macros for calculating structure of outlines
1453 % come from Petr Olsak
1454 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1455 \else \csname#1\endcsname \fi}
1456 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1457 \advance\tempnum by 1
1458 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1460 % #1 is the section text, which is what will be displayed in the
1461 % outline by the pdf viewer. #2 is the pdf expression for the number
1462 % of subentries (or empty, for subsubsections). #3 is the node text,
1463 % which might be empty if this toc entry had no corresponding node.
1464 % #4 is the page number
1466 \def\dopdfoutline#1#2#3#4{%
1467 % Generate a link to the node text if that exists; else, use the
1468 % page number. We could generate a destination for the section
1469 % text in the case where a section has no node, but it doesn't
1470 % seem worth the trouble, since most documents are normally structured.
1471 \def\pdfoutlinedest{#3}%
1472 \ifx\pdfoutlinedest\empty
1473 \def\pdfoutlinedest{#4}%
1475 % Doubled backslashes in the name.
1476 {\activebackslashdouble \xdef\pdfoutlinedest{#3}%
1477 \backslashparens\pdfoutlinedest}%
1480 % Also double the backslashes in the display string.
1481 {\activebackslashdouble \xdef\pdfoutlinetext{#1}%
1482 \backslashparens\pdfoutlinetext}%
1484 \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1487 \def\pdfmakeoutlines{%
1489 % Thanh's hack / proper braces in bookmarks
1490 \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace
1491 \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace
1493 % Read toc silently, to get counts of subentries for \pdfoutline.
1494 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1495 \def\numchapentry##1##2##3##4{%
1496 \def\thischapnum{##2}%
1498 \def\thissubsecnum{0}%
1500 \def\numsecentry##1##2##3##4{%
1501 \advancenumber{chap\thischapnum}%
1502 \def\thissecnum{##2}%
1503 \def\thissubsecnum{0}%
1505 \def\numsubsecentry##1##2##3##4{%
1506 \advancenumber{sec\thissecnum}%
1507 \def\thissubsecnum{##2}%
1509 \def\numsubsubsecentry##1##2##3##4{%
1510 \advancenumber{subsec\thissubsecnum}%
1512 \def\thischapnum{0}%
1514 \def\thissubsecnum{0}%
1516 % use \def rather than \let here because we redefine \chapentry et
1517 % al. a second time, below.
1518 \def\appentry{\numchapentry}%
1519 \def\appsecentry{\numsecentry}%
1520 \def\appsubsecentry{\numsubsecentry}%
1521 \def\appsubsubsecentry{\numsubsubsecentry}%
1522 \def\unnchapentry{\numchapentry}%
1523 \def\unnsecentry{\numsecentry}%
1524 \def\unnsubsecentry{\numsubsecentry}%
1525 \def\unnsubsubsecentry{\numsubsubsecentry}%
1528 % Read toc second time, this time actually producing the outlines.
1529 % The `-' means take the \expnumber as the absolute number of
1530 % subentries, which we calculated on our first read of the .toc above.
1532 % We use the node names as the destinations.
1533 \def\numchapentry##1##2##3##4{%
1534 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1535 \def\numsecentry##1##2##3##4{%
1536 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1537 \def\numsubsecentry##1##2##3##4{%
1538 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1539 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1540 \dopdfoutline{##1}{}{##3}{##4}}%
1542 % PDF outlines are displayed using system fonts, instead of
1543 % document fonts. Therefore we cannot use special characters,
1544 % since the encoding is unknown. For example, the eogonek from
1545 % Latin 2 (0xea) gets translated to a | character. Info from
1546 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1548 % xx to do this right, we have to translate 8-bit characters to
1549 % their "best" equivalent, based on the @documentencoding. Right
1550 % now, I guess we'll just let the pdf reader have its way.
1553 \catcode`\\=\active \otherbackslash
1554 \input \tocreadfilename
1558 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1559 \ifx\PP\D\let\nextsp\relax
1560 \else\let\nextsp\skipspaces
1561 \ifx\p\space\else\addtokens{\filename}{\PP}%
1562 \advance\filenamelength by 1
1566 \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax}
1567 \ifnum\pdftexversion < 14
1568 \let \startlink \pdfannotlink
1570 \let \startlink \pdfstartlink
1572 % make a live url in pdf output.
1575 % it seems we really need yet another set of dummies; have not
1576 % tried to figure out what each command should do in the context
1577 % of @url. for now, just make @/ a no-op, that's the only one
1578 % people have actually reported a problem with.
1580 \normalturnoffactive
1583 \makevalueexpandable
1584 % do we want to go so far as to use \indexnofonts instead of just
1585 % special-casing \var here?
1588 \leavevmode\setcolor{\urlcolor}%
1589 \startlink attr{/Border [0 0 0]}%
1590 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1592 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1593 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1594 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1595 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1597 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1599 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1600 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1601 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1603 \ifnum0=\countA\else\makelink\fi
1604 \ifx\first.\let\next=\done\else
1606 \addtokens{\toksB}{\the\toksD}
1607 \ifx\first,\addtokens{\toksB}{\space}\fi
1609 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1611 \def\makelink{\addtokens{\toksB}%
1612 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1614 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1615 \setcolor{\linkcolor}#1\endlink}
1616 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1619 \let\pdfmkdest = \gobble
1620 \let\pdfurl = \gobble
1621 \let\endlink = \relax
1622 \let\setcolor = \gobble
1623 \let\pdfsetcolor = \gobble
1624 \let\pdfmakeoutlines = \relax
1625 \fi % \ifx\pdfoutput
1630 % Change the current font style to #1, remembering it in \curfontstyle.
1631 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1632 % italics, not bold italics.
1634 \def\setfontstyle#1{%
1635 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1636 \csname ten#1\endcsname % change the current font
1639 % Select #1 fonts with the current style.
1641 \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname}
1643 \def\rm{\fam=0 \setfontstyle{rm}}
1644 \def\it{\fam=\itfam \setfontstyle{it}}
1645 \def\sl{\fam=\slfam \setfontstyle{sl}}
1646 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
1647 \def\tt{\fam=\ttfam \setfontstyle{tt}}
1649 % Unfortunately, we have to override this for titles and the like, since
1650 % in those cases "rm" is bold. Sigh.
1651 \def\rmisbold{\rm\def\curfontstyle{bf}}
1653 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1654 % So we set up a \sf.
1656 \def\sf{\fam=\sffam \setfontstyle{sf}}
1657 \let\li = \sf % Sometimes we call it \li, not \sf.
1659 % We don't need math for this font style.
1660 \def\ttsl{\setfontstyle{ttsl}}
1664 \newdimen\textleading \textleading = 13.2pt
1666 % Set the baselineskip to #1, and the lineskip and strut size
1667 % correspondingly. There is no deep meaning behind these magic numbers
1668 % used as factors; they just match (closely enough) what Knuth defined.
1670 \def\lineskipfactor{.08333}
1671 \def\strutheightpercent{.70833}
1672 \def\strutdepthpercent {.29167}
1674 % can get a sort of poor man's double spacing by redefining this.
1675 \def\baselinefactor{1}
1679 \normalbaselineskip = \baselinefactor\dimen0
1680 \normallineskip = \lineskipfactor\normalbaselineskip
1682 \setbox\strutbox =\hbox{%
1683 \vrule width0pt height\strutheightpercent\baselineskip
1684 depth \strutdepthpercent \baselineskip
1688 % PDF CMaps. See also LaTeX's t1.cmap.
1690 % do nothing with this by default.
1691 \expandafter\let\csname cmapOT1\endcsname\gobble
1692 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1693 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1695 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1696 % (\pdffontattr was introduced many years ago, but people still run
1697 % older pdftex's; it's easy to conditionalize, so we do.)
1698 \ifpdf \ifx\pdffontattr\undefined \else
1700 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1701 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1702 %%DocumentNeededResources: ProcSet (CIDInit)
1703 %%IncludeResource: ProcSet (CIDInit)
1704 %%BeginResource: CMap (TeX-OT1-0)
1705 %%Title: (TeX-OT1-0 TeX OT1 0)
1708 /CIDInit /ProcSet findresource begin
1716 /CMapName /TeX-OT1-0 def
1718 1 begincodespacerange
1774 CMapName currentdict /CMap defineresource pop
1780 \expandafter\edef\csname cmapOT1\endcsname#1{%
1781 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1786 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1787 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1788 %%DocumentNeededResources: ProcSet (CIDInit)
1789 %%IncludeResource: ProcSet (CIDInit)
1790 %%BeginResource: CMap (TeX-OT1IT-0)
1791 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1794 /CIDInit /ProcSet findresource begin
1802 /CMapName /TeX-OT1IT-0 def
1804 1 begincodespacerange
1862 CMapName currentdict /CMap defineresource pop
1868 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
1869 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1874 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1875 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1876 %%DocumentNeededResources: ProcSet (CIDInit)
1877 %%IncludeResource: ProcSet (CIDInit)
1878 %%BeginResource: CMap (TeX-OT1TT-0)
1879 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1882 /CIDInit /ProcSet findresource begin
1890 /CMapName /TeX-OT1TT-0 def
1892 1 begincodespacerange
1937 CMapName currentdict /CMap defineresource pop
1943 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
1944 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1949 % Set the font macro #1 to the font named #2, adding on the
1950 % specified font prefix (normally `cm').
1951 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1952 % encoding (currently only OT1, OT1IT and OT1TT are allowed, pass
1954 \def\setfont#1#2#3#4#5{%
1955 \font#1=\fontprefix#2#3 scaled #4
1956 \csname cmap#5\endcsname#1%
1958 % This is what gets called when #5 of \setfont is empty.
1960 % emacs-page end of cmaps
1962 % Use cm as the default font prefix.
1963 % To specify the font prefix, you must define \fontprefix
1964 % before you read in texinfo.tex.
1965 \ifx\fontprefix\undefined
1968 % Support font families that don't use the same naming scheme as CM.
1970 \def\rmbshape{bx} %where the normal face is bold
1975 \def\ttslshape{sltt}
1985 % Definitions for a main text size of 11pt. This is the default in
1988 \def\definetextfontsizexi{%
1989 % Text fonts (11.2pt, magstep1).
1990 \def\textnominalsize{11pt}
1991 \edef\mainmagstep{\magstephalf}
1992 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
1993 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
1994 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
1995 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
1996 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
1997 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
1998 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
1999 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2000 \font\texti=cmmi10 scaled \mainmagstep
2001 \font\textsy=cmsy10 scaled \mainmagstep
2002 \def\textecsize{1095}
2004 % A few fonts for @defun names and args.
2005 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
2006 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
2007 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
2008 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2010 % Fonts for indices, footnotes, small examples (9pt).
2011 \def\smallnominalsize{9pt}
2012 \setfont\smallrm\rmshape{9}{1000}{OT1}
2013 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2014 \setfont\smallbf\bfshape{10}{900}{OT1}
2015 \setfont\smallit\itshape{9}{1000}{OT1IT}
2016 \setfont\smallsl\slshape{9}{1000}{OT1}
2017 \setfont\smallsf\sfshape{9}{1000}{OT1}
2018 \setfont\smallsc\scshape{10}{900}{OT1}
2019 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2022 \def\smallecsize{0900}
2024 % Fonts for small examples (8pt).
2025 \def\smallernominalsize{8pt}
2026 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2027 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2028 \setfont\smallerbf\bfshape{10}{800}{OT1}
2029 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2030 \setfont\smallersl\slshape{8}{1000}{OT1}
2031 \setfont\smallersf\sfshape{8}{1000}{OT1}
2032 \setfont\smallersc\scshape{10}{800}{OT1}
2033 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2034 \font\smalleri=cmmi8
2035 \font\smallersy=cmsy8
2036 \def\smallerecsize{0800}
2038 % Fonts for title page (20.4pt):
2039 \def\titlenominalsize{20pt}
2040 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2041 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2042 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2043 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2044 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2045 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2046 \let\titlebf=\titlerm
2047 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2048 \font\titlei=cmmi12 scaled \magstep3
2049 \font\titlesy=cmsy10 scaled \magstep4
2050 \def\titleecsize{2074}
2052 % Chapter (and unnumbered) fonts (17.28pt).
2053 \def\chapnominalsize{17pt}
2054 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
2055 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
2056 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
2057 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
2058 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2059 \setfont\chapsf\sfbshape{17}{1000}{OT1}
2061 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
2062 \font\chapi=cmmi12 scaled \magstep2
2063 \font\chapsy=cmsy10 scaled \magstep3
2064 \def\chapecsize{1728}
2066 % Section fonts (14.4pt).
2067 \def\secnominalsize{14pt}
2068 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
2069 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
2070 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
2071 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
2072 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2073 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
2075 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
2076 \font\seci=cmmi12 scaled \magstep1
2077 \font\secsy=cmsy10 scaled \magstep2
2078 \def\sececsize{1440}
2080 % Subsection fonts (13.15pt).
2081 \def\ssecnominalsize{13pt}
2082 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
2083 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
2084 \setfont\ssecsl\slbshape{10}{1315}{OT1}
2085 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
2086 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2087 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
2089 \setfont\ssecsc\scbshape{10}{1315}{OT1}
2090 \font\sseci=cmmi12 scaled \magstephalf
2091 \font\ssecsy=cmsy10 scaled 1315
2092 \def\ssececsize{1200}
2094 % Reduced fonts for @acro in text (10pt).
2095 \def\reducednominalsize{10pt}
2096 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2097 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2098 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2099 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2100 \setfont\reducedsl\slshape{10}{1000}{OT1}
2101 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2102 \setfont\reducedsc\scshape{10}{1000}{OT1}
2103 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2104 \font\reducedi=cmmi10
2105 \font\reducedsy=cmsy10
2106 \def\reducedecsize{1000}
2108 \textleading = 13.2pt % line spacing for 11pt CM
2109 \textfonts % reset the current fonts
2111 } % end of 11pt text font size definitions
2114 % Definitions to make the main text be 10pt Computer Modern, with
2115 % section, chapter, etc., sizes following suit. This is for the GNU
2116 % Press printing of the Emacs 22 manual. Maybe other manuals in the
2117 % future. Used with @smallbook, which sets the leading to 12pt.
2119 \def\definetextfontsizex{%
2120 % Text fonts (10pt).
2121 \def\textnominalsize{10pt}
2122 \edef\mainmagstep{1000}
2123 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2124 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2125 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2126 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2127 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2128 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2129 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2130 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2131 \font\texti=cmmi10 scaled \mainmagstep
2132 \font\textsy=cmsy10 scaled \mainmagstep
2133 \def\textecsize{1000}
2135 % A few fonts for @defun names and args.
2136 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2137 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2138 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2139 \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf}
2141 % Fonts for indices, footnotes, small examples (9pt).
2142 \def\smallnominalsize{9pt}
2143 \setfont\smallrm\rmshape{9}{1000}{OT1}
2144 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2145 \setfont\smallbf\bfshape{10}{900}{OT1}
2146 \setfont\smallit\itshape{9}{1000}{OT1IT}
2147 \setfont\smallsl\slshape{9}{1000}{OT1}
2148 \setfont\smallsf\sfshape{9}{1000}{OT1}
2149 \setfont\smallsc\scshape{10}{900}{OT1}
2150 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2153 \def\smallecsize{0900}
2155 % Fonts for small examples (8pt).
2156 \def\smallernominalsize{8pt}
2157 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2158 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2159 \setfont\smallerbf\bfshape{10}{800}{OT1}
2160 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2161 \setfont\smallersl\slshape{8}{1000}{OT1}
2162 \setfont\smallersf\sfshape{8}{1000}{OT1}
2163 \setfont\smallersc\scshape{10}{800}{OT1}
2164 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2165 \font\smalleri=cmmi8
2166 \font\smallersy=cmsy8
2167 \def\smallerecsize{0800}
2169 % Fonts for title page (20.4pt):
2170 \def\titlenominalsize{20pt}
2171 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2172 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2173 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2174 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2175 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2176 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2177 \let\titlebf=\titlerm
2178 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2179 \font\titlei=cmmi12 scaled \magstep3
2180 \font\titlesy=cmsy10 scaled \magstep4
2181 \def\titleecsize{2074}
2183 % Chapter fonts (14.4pt).
2184 \def\chapnominalsize{14pt}
2185 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2186 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2187 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2188 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2189 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2190 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2192 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2193 \font\chapi=cmmi12 scaled \magstep1
2194 \font\chapsy=cmsy10 scaled \magstep2
2195 \def\chapecsize{1440}
2197 % Section fonts (12pt).
2198 \def\secnominalsize{12pt}
2199 \setfont\secrm\rmbshape{12}{1000}{OT1}
2200 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2201 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2202 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2203 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2204 \setfont\secsf\sfbshape{12}{1000}{OT1}
2206 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2208 \font\secsy=cmsy10 scaled \magstep1
2209 \def\sececsize{1200}
2211 % Subsection fonts (10pt).
2212 \def\ssecnominalsize{10pt}
2213 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2214 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2215 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2216 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2217 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2218 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2220 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2223 \def\ssececsize{1000}
2225 % Reduced fonts for @acro in text (9pt).
2226 \def\reducednominalsize{9pt}
2227 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2228 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2229 \setfont\reducedbf\bfshape{10}{900}{OT1}
2230 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2231 \setfont\reducedsl\slshape{9}{1000}{OT1}
2232 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2233 \setfont\reducedsc\scshape{10}{900}{OT1}
2234 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2235 \font\reducedi=cmmi9
2236 \font\reducedsy=cmsy9
2237 \def\reducedecsize{0900}
2239 \divide\parskip by 2 % reduce space between paragraphs
2240 \textleading = 12pt % line spacing for 10pt CM
2241 \textfonts % reset the current fonts
2243 } % end of 10pt text font size definitions
2246 % We provide the user-level command
2248 % (or 11) to redefine the text font size. pt is assumed.
2253 \parseargdef\fonttextsize{%
2254 \def\textsizearg{#1}%
2255 \wlog{doing @fonttextsize \textsizearg}%
2257 % Set \globaldefs so that documents can use this inside @tex, since
2258 % makeinfo 4.8 does not support it, but we need it nonetheless.
2260 \begingroup \globaldefs=1
2261 \ifx\textsizearg\xword \definetextfontsizex
2262 \else \ifx\textsizearg\xiword \definetextfontsizexi
2265 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2271 % In order for the font changes to affect most math symbols and letters,
2272 % we have to define the \textfont of the standard families. Since
2273 % texinfo doesn't allow for producing subscripts and superscripts except
2274 % in the main text, we don't bother to reset \scriptfont and
2275 % \scriptscriptfont (which would also require loading a lot more fonts).
2277 \def\resetmathfonts{%
2278 \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy
2279 \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf
2280 \textfont\ttfam=\tentt \textfont\sffam=\tensf
2283 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2284 % of just \STYLE. We do this because \STYLE needs to also set the
2285 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2286 % \tenSTYLE to set the current font.
2288 % Each font-changing command also sets the names \lsize (one size lower)
2289 % and \lllsize (three sizes lower). These relative commands are used in
2290 % the LaTeX logo and acronyms.
2292 % This all needs generalizing, badly.
2295 \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl
2296 \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc
2297 \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy
2298 \let\tenttsl=\textttsl
2299 \def\curfontsize{text}%
2300 \def\lsize{reduced}\def\lllsize{smaller}%
2301 \resetmathfonts \setleading{\textleading}}
2303 \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl
2304 \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc
2305 \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy
2306 \let\tenttsl=\titlettsl
2307 \def\curfontsize{title}%
2308 \def\lsize{chap}\def\lllsize{subsec}%
2309 \resetmathfonts \setleading{25pt}}
2310 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2312 \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl
2313 \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc
2314 \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy
2315 \let\tenttsl=\chapttsl
2316 \def\curfontsize{chap}%
2317 \def\lsize{sec}\def\lllsize{text}%
2318 \resetmathfonts \setleading{19pt}}
2320 \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl
2321 \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc
2322 \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy
2323 \let\tenttsl=\secttsl
2324 \def\curfontsize{sec}%
2325 \def\lsize{subsec}\def\lllsize{reduced}%
2326 \resetmathfonts \setleading{16pt}}
2328 \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl
2329 \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc
2330 \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy
2331 \let\tenttsl=\ssecttsl
2332 \def\curfontsize{ssec}%
2333 \def\lsize{text}\def\lllsize{small}%
2334 \resetmathfonts \setleading{15pt}}
2335 \let\subsubsecfonts = \subsecfonts
2337 \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl
2338 \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc
2339 \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy
2340 \let\tenttsl=\reducedttsl
2341 \def\curfontsize{reduced}%
2342 \def\lsize{small}\def\lllsize{smaller}%
2343 \resetmathfonts \setleading{10.5pt}}
2345 \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl
2346 \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc
2347 \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy
2348 \let\tenttsl=\smallttsl
2349 \def\curfontsize{small}%
2350 \def\lsize{smaller}\def\lllsize{smaller}%
2351 \resetmathfonts \setleading{10.5pt}}
2353 \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl
2354 \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc
2355 \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy
2356 \let\tenttsl=\smallerttsl
2357 \def\curfontsize{smaller}%
2358 \def\lsize{smaller}\def\lllsize{smaller}%
2359 \resetmathfonts \setleading{9.5pt}}
2361 % Fonts for short table of contents.
2362 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2363 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2364 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2365 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2367 % Define these just so they can be easily changed for other fonts.
2368 \def\angleleft{$\langle$}
2369 \def\angleright{$\rangle$}
2371 % Set the fonts to use with the @small... environments.
2372 \let\smallexamplefonts = \smallfonts
2374 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2375 % can fit this many characters:
2376 % 8.5x11=86 smallbook=72 a4=90 a5=69
2377 % If we use \scriptfonts (8pt), then we can fit this many characters:
2378 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2379 % For me, subjectively, the few extra characters that fit aren't worth
2380 % the additional smallness of 8pt. So I'm making the default 9pt.
2382 % By the way, for comparison, here's what fits with @example (10pt):
2383 % 8.5x11=71 smallbook=60 a4=75 a5=58
2386 % Set up the default fonts, so we can use them for creating boxes.
2388 \definetextfontsizexi
2393 % Check if we are currently using a typewriter font. Since all the
2394 % Computer Modern typewriter fonts have zero interword stretch (and
2395 % shrink), and it is reasonable to expect all typewriter fonts to have
2396 % this property, we can check that font parameter.
2398 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2400 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2401 % define and register \INITMACRO to be called on markup style changes.
2402 % \INITMACRO can check \currentmarkupstyle for the innermost
2403 % style and the set of \ifmarkupSTYLE switches for all styles
2404 % currently in effect.
2408 %\newif\ifmarkupfile % @file == @samp.
2409 %\newif\ifmarkupoption % @option == @samp.
2412 %\newif\ifmarkupenv % @env == @code.
2413 %\newif\ifmarkupcommand % @command == @code.
2414 \newif\ifmarkuptex % @tex (and part of @math, for now).
2415 \newif\ifmarkupexample
2417 \newif\ifmarkupverbatim
2419 \let\currentmarkupstyle\empty
2421 \def\setupmarkupstyle#1{%
2422 \csname markup#1true\endcsname
2423 \def\currentmarkupstyle{#1}%
2427 \let\markupstylesetup\empty
2429 \def\defmarkupstylesetup#1{%
2430 \expandafter\def\expandafter\markupstylesetup
2431 \expandafter{\markupstylesetup #1}%
2435 % Markup style setup for left and right quotes.
2436 \defmarkupstylesetup\markupsetuplq{%
2437 \expandafter\let\expandafter \temp \csname markupsetuplq\currentmarkupstyle\endcsname
2438 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2441 \defmarkupstylesetup\markupsetuprq{%
2442 \expandafter\let\expandafter \temp \csname markupsetuprq\currentmarkupstyle\endcsname
2443 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2450 \gdef\markupsetuplqdefault{\let`\lq}
2451 \gdef\markupsetuprqdefault{\let'\rq}
2453 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2454 \gdef\markupsetcodequoteright{\let'\codequoteright}
2456 \gdef\markupsetnoligaturesquoteleft{\let`\noligaturesquoteleft}
2459 \let\markupsetuplqcode \markupsetcodequoteleft
2460 \let\markupsetuprqcode \markupsetcodequoteright
2461 \let\markupsetuplqexample \markupsetcodequoteleft
2462 \let\markupsetuprqexample \markupsetcodequoteright
2463 \let\markupsetuplqverb \markupsetcodequoteleft
2464 \let\markupsetuprqverb \markupsetcodequoteright
2465 \let\markupsetuplqverbatim \markupsetcodequoteleft
2466 \let\markupsetuprqverbatim \markupsetcodequoteright
2468 \let\markupsetuplqsamp \markupsetnoligaturesquoteleft
2469 \let\markupsetuplqkbd \markupsetnoligaturesquoteleft
2471 % Allow an option to not replace quotes with a regular directed right
2472 % quote/apostrophe (char 0x27), but instead use the undirected quote
2473 % from cmtt (char 0x0d). The undirected quote is ugly, so don't make it
2474 % the default, but it works for pasting with more pdf viewers (at least
2475 % evince), the lilypond developers report. xpdf does work with the
2478 \def\codequoteright{%
2479 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2480 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2486 % and a similar option for the left quote char vs. a grave accent.
2487 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2488 % the code environments to do likewise.
2490 \def\codequoteleft{%
2491 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2492 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2493 % [Knuth] pp. 380,381,391
2494 % \relax disables Spanish ligatures ?` and !` of \tt font.
2500 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2501 \def\noligaturesquoteleft{\relax\lq}
2503 % Count depth in font-changes, for error checks
2504 \newcount\fontdepth \fontdepth=0
2508 % #1 is the font command (\sl or \it), #2 is the text to slant.
2509 % If we are in a monospaced environment, however, 1) always use \ttsl,
2510 % and 2) do not add an italic correction.
2511 \def\dosmartslant#1#2{%
2513 {\ttsl #2\let\next=\relax}%
2514 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2517 \def\smartslanted{\dosmartslant\sl}
2518 \def\smartitalic{\dosmartslant\it}
2520 % Output an italic correction unless \next (presumed to be the following
2521 % character) is such as not to need one.
2522 \def\smartitaliccorrection{%
2529 % like \smartslanted except unconditionally uses \ttsl, and no ic.
2530 % @var is set to this for defun arguments.
2531 \def\ttslanted#1{{\ttsl #1}}
2533 % @cite is like \smartslanted except unconditionally use \sl. We never want
2534 % ttsl for book titles, do we?
2535 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2538 \let\slanted=\smartslanted
2539 \def\var#1{\smartslanted{#1}}
2540 \let\dfn=\smartslanted
2541 \let\emph=\smartitalic
2543 % Explicit font changes: @r, @sc, undocumented @ii.
2544 \def\r#1{{\rm #1}} % roman font
2545 \def\sc#1{{\smallcaps#1}} % smallcaps font
2546 \def\ii#1{{\it #1}} % italic font
2548 % @b, explicit bold. Also @strong.
2552 % @sansserif, explicit sans.
2553 \def\sansserif#1{{\sf #1}}
2555 % We can't just use \exhyphenpenalty, because that only has effect at
2556 % the end of a paragraph. Restore normal hyphenation at the end of the
2557 % group within which \nohyphenation is presumably called.
2559 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2560 \def\restorehyphenation{\hyphenchar\font = `- }
2562 % Set sfcode to normal for the chars that usually have another value.
2563 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2564 % sometimes \x has an active definition that messes things up.
2567 \def\plainfrenchspacing{%
2568 \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m
2569 \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m
2570 \def\endofsentencespacefactor{1000}% for @. and friends
2572 \def\plainnonfrenchspacing{%
2573 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2574 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2575 \def\endofsentencespacefactor{3000}% for @. and friends
2578 \def\endofsentencespacefactor{3000}% default
2580 % @t, explicit typewriter.
2582 {\tt \rawbackslash \plainfrenchspacing #1}%
2587 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2589 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2590 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2592 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2593 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2594 % \vbox{\hrule\kern-0.4pt
2595 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2596 % \kern-0.4pt\hrule}%
2597 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2599 % definition of @key with no lozenge. If the current font is already
2600 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2601 % if it isn't monospace, then use \tt.
2603 \def\key#1{{\setupmarkupstyle{key}%
2605 \ifmonospace\else\tt\fi
2608 % ctrl is no longer a Texinfo command.
2609 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2611 % @file, @option are the same as @samp.
2615 % @code is a modification of @t,
2616 % which makes spaces the same size as normal in the surrounding text.
2619 % Change normal interword space to be same as for the current font.
2620 \spaceskip = \fontdimen2\font
2622 % Switch to typewriter.
2625 % But `\ ' produces the large typewriter interword space.
2626 \def\ {{\spaceskip = 0pt{} }}%
2628 % Turn off hyphenation.
2638 % We *must* turn on hyphenation at `-' and `_' in @code.
2639 % Otherwise, it is too hard to avoid overfull hboxes
2640 % in the Emacs manual, the Library manual, etc.
2642 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2643 % both hyphenation at - and hyphenation within words.
2644 % We must therefore turn them both off (\tclose does that)
2645 % and arrange explicitly to hyphenate at a dash.
2648 \catcode`\-=\active \catcode`\_=\active
2649 \catcode`\'=\active \catcode`\`=\active
2650 \global\let'=\rq \global\let`=\lq % default definitions
2652 \global\def\code{\begingroup
2653 \setupmarkupstyle{code}%
2654 % The following should really be moved into \setupmarkupstyle handlers.
2655 \catcode\dashChar=\active \catcode\underChar=\active
2668 \def\codedash{-\discretionary{}{}{}}
2670 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2671 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2672 % will therefore expand the active definition of _, which is us
2673 % (inside @code that is), therefore an endless loop.
2675 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2676 \else\normalunderscore \fi
2677 \discretionary{}{}{}}%
2680 \def\codex #1{\tclose{#1}\endgroup}
2682 % An additional complication: the above will allow breaks after, e.g.,
2683 % each of the four underscores in __typeof__. This is undesirable in
2684 % some manuals, especially if they don't have long identifiers in
2685 % general. @allowcodebreaks provides a way to control this.
2687 \newif\ifallowcodebreaks \allowcodebreakstrue
2689 \def\keywordtrue{true}
2690 \def\keywordfalse{false}
2692 \parseargdef\allowcodebreaks{%
2694 \ifx\txiarg\keywordtrue
2695 \allowcodebreakstrue
2696 \else\ifx\txiarg\keywordfalse
2697 \allowcodebreaksfalse
2699 \errhelp = \EMsimple
2700 \errmessage{Unknown @allowcodebreaks option `\txiarg'}%
2704 % @kbd is like @code, except that if the argument is just one @key command,
2705 % then @kbd has no effect.
2706 \def\kbd#1{{\setupmarkupstyle{kbd}\def\look{#1}\expandafter\kbdfoo\look??\par}}
2708 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2709 % `example' (@kbd uses ttsl only inside of @example and friends),
2710 % or `code' (@kbd uses normal tty font always).
2711 \parseargdef\kbdinputstyle{%
2713 \ifx\txiarg\worddistinct
2714 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2715 \else\ifx\txiarg\wordexample
2716 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2717 \else\ifx\txiarg\wordcode
2718 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2720 \errhelp = \EMsimple
2721 \errmessage{Unknown @kbdinputstyle option `\txiarg'}%
2724 \def\worddistinct{distinct}
2725 \def\wordexample{example}
2728 % Default is `distinct'.
2729 \kbdinputstyle distinct
2732 \def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}%
2733 \ifx\one\xkey\ifx\threex\three \key{#2}%
2734 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
2735 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi}
2737 % For @indicateurl, @env, @command quotes seem unnecessary, so use \code.
2738 \let\indicateurl=\code
2742 % @clicksequence{File @click{} Open ...}
2743 \def\clicksequence#1{\begingroup #1\endgroup}
2745 % @clickstyle @arrow (by default)
2746 \parseargdef\clickstyle{\def\click{#1}}
2749 % @uref (abbreviation for `urlref') takes an optional (comma-separated)
2750 % second argument specifying the text to display and an optional third
2751 % arg as text to display instead of (rather than in addition to) the url
2752 % itself. First (mandatory) arg is the url. Perhaps eventually put in
2753 % a hypertex \special here.
2755 \def\uref#1{\douref #1,,,\finish}
2756 \def\douref#1,#2,#3,#4\finish{\begingroup
2759 \setbox0 = \hbox{\ignorespaces #3}%
2761 \unhbox0 % third arg given, show only that
2763 \setbox0 = \hbox{\ignorespaces #2}%
2766 \unhbox0 % PDF: 2nd arg given, show only it
2768 \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url
2771 \code{#1}% only url given, so show it
2777 % @url synonym for @uref, since that's how everyone uses it.
2781 % rms does not like angle brackets --karl, 17may97.
2782 % So now @email is just like @uref, unless we are pdf.
2784 %\def\email#1{\angleleft{\tt #1}\angleright}
2786 \def\email#1{\doemail#1,,\finish}
2787 \def\doemail#1,#2,#3\finish{\begingroup
2790 \setbox0 = \hbox{\ignorespaces #2}%
2791 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
2798 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2799 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2801 \def\dmn#1{\thinspace #1}
2803 % @l was never documented to mean ``switch to the Lisp font'',
2804 % and it is not used as such in any manual I can find. We need it for
2805 % Polish suppressed-l. --karl, 22sep96.
2806 %\def\l#1{{\li #1}\null}
2808 % @acronym for "FBI", "NATO", and the like.
2809 % We print this one point size smaller, since it's intended for
2812 \def\acronym#1{\doacronym #1,,\finish}
2813 \def\doacronym#1,#2,#3\finish{%
2814 {\selectfonts\lsize #1}%
2816 \ifx\temp\empty \else
2817 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2821 % @abbr for "Comput. J." and the like.
2822 % No font change, but don't do end-of-sentence spacing.
2824 \def\abbr#1{\doabbr #1,,\finish}
2825 \def\doabbr#1,#2,#3\finish{%
2826 {\plainfrenchspacing #1}%
2828 \ifx\temp\empty \else
2829 \space ({\unsepspaces \ignorespaces \temp \unskip})%
2836 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
2838 % Since these characters are used in examples, they should be an even number of
2839 % \tt widths. Each \tt character is 1en, so two makes it 1em.
2842 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
2843 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
2844 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
2845 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
2846 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
2848 % The @error{} command.
2849 % Adapted from the TeXbook's \boxit.
2853 {\tentt \global\dimen0 = 3em}% Width of the box.
2854 \dimen2 = .55pt % Thickness of rules
2855 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
2856 \setbox0 = \hbox{\kern-.75pt \reducedsf error\kern-1.5pt}
2858 \setbox\errorbox=\hbox to \dimen0{\hfil
2859 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
2860 \advance\hsize by -2\dimen2 % Rules.
2862 \hrule height\dimen2
2863 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
2864 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
2865 \kern3pt\vrule width\dimen2}% Space to right.
2866 \hrule height\dimen2}
2869 \def\error{\leavevmode\lower.7ex\copy\errorbox}
2871 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
2873 \def\pounds{{\it\$}}
2875 % @euro{} comes from a separate font, depending on the current style.
2876 % We use the free feym* fonts from the eurosym package by Henrik
2877 % Theiling, which support regular, slanted, bold and bold slanted (and
2878 % "outlined" (blackboard board, sort of) versions, which we don't need).
2879 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
2881 % Although only regular is the truly official Euro symbol, we ignore
2882 % that. The Euro is designed to be slightly taller than the regular
2888 % feybo - bold slanted
2890 % There is no good (free) typewriter version, to my knowledge.
2891 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
2894 % Also doesn't work in math. Do we need to do math with euro symbols?
2898 \def\euro{{\eurofont e}}
2900 % We set the font at each command, rather than predefining it in
2901 % \textfonts and the other font-switching commands, so that
2902 % installations which never need the symbol don't have to have the
2905 % There is only one designed size (nominal 10pt), so we always scale
2906 % that to the current nominal size.
2908 % By the way, simply using "at 1em" works for cmr10 and the like, but
2909 % does not work for cmbx10 and other extended/shrunken fonts.
2911 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
2913 \ifx\curfontstyle\bfstylename
2915 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
2918 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
2923 % Glyphs from the EC fonts. We don't use \let for the aliases, because
2924 % sometimes we redefine the original macro, and the alias should reflect
2927 % Use LaTeX names for the Icelandic letters.
2928 \def\DH{{\ecfont \char"D0}} % Eth
2929 \def\dh{{\ecfont \char"F0}} % eth
2930 \def\TH{{\ecfont \char"DE}} % Thorn
2931 \def\th{{\ecfont \char"FE}} % thorn
2933 \def\guillemetleft{{\ecfont \char"13}}
2934 \def\guillemotleft{\guillemetleft}
2935 \def\guillemetright{{\ecfont \char"14}}
2936 \def\guillemotright{\guillemetright}
2937 \def\guilsinglleft{{\ecfont \char"0E}}
2938 \def\guilsinglright{{\ecfont \char"0F}}
2939 \def\quotedblbase{{\ecfont \char"12}}
2940 \def\quotesinglbase{{\ecfont \char"0D}}
2942 % This positioning is not perfect (see the ogonek LaTeX package), but
2943 % we have the precomposed glyphs for the most common cases. We put the
2944 % tests to use those glyphs in the single \ogonek macro so we have fewer
2945 % dummy definitions to worry about for index entries, etc.
2947 % ogonek is also used with other letters in Lithuanian (IOU), but using
2948 % the precomposed glyphs for those is not so easy since they aren't in
2952 \ifx\temp\macrocharA\Aogonek
2953 \else\ifx\temp\macrochara\aogonek
2954 \else\ifx\temp\macrocharE\Eogonek
2955 \else\ifx\temp\macrochare\eogonek
2957 \ecfont \setbox0=\hbox{#1}%
2958 \ifdim\ht0=1ex\accent"0C #1%
2959 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
2964 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
2965 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
2966 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
2967 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
2969 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
2971 % We can't distinguish serif/sans and italic/slanted, but this
2972 % is used for crude hacks anyway (like adding French and German
2973 % quotes to documents typeset with CM, where we lose kerning), so
2974 % hopefully nobody will notice/care.
2975 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
2976 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
2977 \ifx\curfontstyle\bfstylename
2979 \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize
2982 \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize
2987 % @registeredsymbol - R in a circle. The font for the R should really
2988 % be smaller yet, but lllsize is the best we can do for now.
2989 % Adapted from the plain.tex definition of \copyright.
2991 \def\registeredsymbol{%
2992 $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}%
2997 % @textdegree - the normal degrees sign.
2999 \def\textdegree{$^\circ$}
3001 % Laurent Siebenmann reports \Orb undefined with:
3002 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3003 % so we'll define it if necessary.
3006 \def\Orb{\mathhexbox20D}
3010 \chardef\quotedblleft="5C
3011 \chardef\quotedblright=`\"
3012 \chardef\quoteleft=`\`
3013 \chardef\quoteright=`\'
3016 \message{page headings,}
3018 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3019 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3021 % First the title page. Must do @settitle before @titlepage.
3023 \newif\iffinishedtitlepage
3025 % Do an implicit @contents or @shortcontents after @end titlepage if the
3026 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3028 \newif\ifsetcontentsaftertitlepage
3029 \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue
3030 \newif\ifsetshortcontentsaftertitlepage
3031 \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue
3033 \parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3034 \endgroup\page\hbox{}\page}
3037 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3039 \parindent=0pt \textfonts
3040 % Leave some space at the very top of the page.
3041 \vglue\titlepagetopglue
3042 % No rule at page bottom unless we print one at the top with @title.
3043 \finishedtitlepagetrue
3045 % Most title ``pages'' are actually two pages long, with space
3046 % at the top of the second. We don't want the ragged left on the second.
3047 \let\oldpage = \page
3049 \iffinishedtitlepage\else
3052 \let\page = \oldpage
3059 \iffinishedtitlepage\else
3062 % It is important to do the page break before ending the group,
3063 % because the headline and footline are only empty inside the group.
3064 % If we use the new definition of \page, we always get a blank page
3065 % after the title page, which we certainly don't want.
3069 % Need this before the \...aftertitlepage checks so that if they are
3070 % in effect the toc pages will come out with page numbers.
3073 % If they want short, they certainly want long too.
3074 \ifsetshortcontentsaftertitlepage
3077 \global\let\shortcontents = \relax
3078 \global\let\contents = \relax
3081 \ifsetcontentsaftertitlepage
3083 \global\let\contents = \relax
3084 \global\let\shortcontents = \relax
3088 \def\finishtitlepage{%
3089 \vskip4pt \hrule height 2pt width \hsize
3090 \vskip\titlepagebottomglue
3091 \finishedtitlepagetrue
3094 %%% Macros to be used within @titlepage:
3096 \let\subtitlerm=\tenrm
3097 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3099 \parseargdef\title{%
3101 \leftline{\titlefonts\rmisbold #1}
3102 % print a rule at the page bottom also.
3103 \finishedtitlepagefalse
3104 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3107 \parseargdef\subtitle{%
3109 {\subtitlefont \rightline{#1}}%
3112 % @author should come last, but may come many times.
3113 % It can also be used inside @quotation.
3115 \parseargdef\author{%
3116 \def\temp{\quotation}%
3118 \def\quotationauthor{#1}% printed in \Equotation.
3121 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3122 {\secfonts\rmisbold \leftline{#1}}%
3127 %%% Set up page headings and footings.
3129 \let\thispage=\folio
3131 \newtoks\evenheadline % headline on even pages
3132 \newtoks\oddheadline % headline on odd pages
3133 \newtoks\evenfootline % footline on even pages
3134 \newtoks\oddfootline % footline on odd pages
3136 % Now make TeX use those variables
3137 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3138 \else \the\evenheadline \fi}}
3139 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3140 \else \the\evenfootline \fi}\HEADINGShook}
3141 \let\HEADINGShook=\relax
3143 % Commands to set those variables.
3144 % For example, this is what @headings on does
3145 % @evenheading @thistitle|@thispage|@thischapter
3146 % @oddheading @thischapter|@thispage|@thistitle
3147 % @evenfooting @thisfile||
3148 % @oddfooting ||@thisfile
3151 \def\evenheading{\parsearg\evenheadingxxx}
3152 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3153 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3154 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3156 \def\oddheading{\parsearg\oddheadingxxx}
3157 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3158 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3159 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3161 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3163 \def\evenfooting{\parsearg\evenfootingxxx}
3164 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3165 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3166 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3168 \def\oddfooting{\parsearg\oddfootingxxx}
3169 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3170 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3171 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3173 % Leave some space for the footline. Hopefully ok to assume
3174 % @evenfooting will not be used by itself.
3175 \global\advance\pageheight by -12pt
3176 \global\advance\vsize by -12pt
3179 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3181 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3182 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3184 % The same set of arguments for:
3189 % @everyheadingmarks
3190 % @everyfootingmarks
3192 \def\evenheadingmarks{\headingmarks{even}{heading}}
3193 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3194 \def\evenfootingmarks{\headingmarks{even}{footing}}
3195 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3196 \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1}
3197 \headingmarks{odd}{heading}{#1} }
3198 \def\everyfootingmarks#1 {\headingmarks{even}{footing}{#1}
3199 \headingmarks{odd}{footing}{#1} }
3200 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3201 \def\headingmarks#1#2#3 {%
3202 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3203 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3206 \everyheadingmarks bottom
3207 \everyfootingmarks bottom
3209 % @headings double turns headings on for double-sided printing.
3210 % @headings single turns headings on for single-sided printing.
3211 % @headings off turns them off.
3212 % @headings on same as @headings double, retained for compatibility.
3213 % @headings after turns on double-sided headings after this page.
3214 % @headings doubleafter turns on double-sided headings after this page.
3215 % @headings singleafter turns on single-sided headings after this page.
3216 % By default, they are off at the start of a document,
3217 % and turned `on' after @end titlepage.
3219 \def\headings #1 {\csname HEADINGS#1\endcsname}
3221 \def\headingsoff{% non-global headings elimination
3222 \evenheadline={\hfil}\evenfootline={\hfil}%
3223 \oddheadline={\hfil}\oddfootline={\hfil}%
3226 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3227 \HEADINGSoff % it's the default
3229 % When we turn headings on, set the page number to 1.
3230 % For double-sided printing, put current file name in lower left corner,
3231 % chapter name on inside top of right hand pages, document
3232 % title on inside top of left hand pages, and page numbers on outside top
3233 % edge of all pages.
3234 \def\HEADINGSdouble{%
3236 \global\evenfootline={\hfil}
3237 \global\oddfootline={\hfil}
3238 \global\evenheadline={\line{\folio\hfil\thistitle}}
3239 \global\oddheadline={\line{\thischapter\hfil\folio}}
3240 \global\let\contentsalignmacro = \chapoddpage
3242 \let\contentsalignmacro = \chappager
3244 % For single-sided printing, chapter title goes across top left of page,
3245 % page number on top right.
3246 \def\HEADINGSsingle{%
3248 \global\evenfootline={\hfil}
3249 \global\oddfootline={\hfil}
3250 \global\evenheadline={\line{\thischapter\hfil\folio}}
3251 \global\oddheadline={\line{\thischapter\hfil\folio}}
3252 \global\let\contentsalignmacro = \chappager
3254 \def\HEADINGSon{\HEADINGSdouble}
3256 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3257 \let\HEADINGSdoubleafter=\HEADINGSafter
3258 \def\HEADINGSdoublex{%
3259 \global\evenfootline={\hfil}
3260 \global\oddfootline={\hfil}
3261 \global\evenheadline={\line{\folio\hfil\thistitle}}
3262 \global\oddheadline={\line{\thischapter\hfil\folio}}
3263 \global\let\contentsalignmacro = \chapoddpage
3266 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3267 \def\HEADINGSsinglex{%
3268 \global\evenfootline={\hfil}
3269 \global\oddfootline={\hfil}
3270 \global\evenheadline={\line{\thischapter\hfil\folio}}
3271 \global\oddheadline={\line{\thischapter\hfil\folio}}
3272 \global\let\contentsalignmacro = \chappager
3275 % Subroutines used in generating headings
3276 % This produces Day Month Year style of output.
3277 % Only define if not already defined, in case a txi-??.tex file has set
3278 % up a different format (e.g., txi-cs.tex does this).
3279 \ifx\today\undefined
3283 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3284 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3285 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3290 % @settitle line... specifies the title of the document, for headings.
3291 % It generates no output of its own.
3292 \def\thistitle{\putwordNoTitle}
3293 \def\settitle{\parsearg{\gdef\thistitle}}
3297 % Tables -- @table, @ftable, @vtable, @item(x).
3299 % default indentation of table text
3300 \newdimen\tableindent \tableindent=.8in
3301 % default indentation of @itemize and @enumerate text
3302 \newdimen\itemindent \itemindent=.3in
3303 % margin between end of table item and start of table text.
3304 \newdimen\itemmargin \itemmargin=.1in
3306 % used internally for \itemindent minus \itemmargin
3309 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3311 % They also define \itemindex
3312 % to index the item name in whatever manner is desired (perhaps none).
3314 \newif\ifitemxneedsnegativevskip
3316 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3318 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3319 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3321 \def\itemzzz #1{\begingroup %
3322 \advance\hsize by -\rightskip
3323 \advance\hsize by -\tableindent
3324 \setbox0=\hbox{\itemindicate{#1}}%
3326 \nobreak % This prevents a break before @itemx.
3328 % If the item text does not fit in the space we have, put it on a line
3329 % by itself, and do not allow a page break either before or after that
3330 % line. We do not start a paragraph here because then if the next
3331 % command is, e.g., @kindex, the whatsit would get put into the
3332 % horizontal list on a line by itself, resulting in extra blank space.
3333 \ifdim \wd0>\itemmax
3335 % Make this a paragraph so we get the \parskip glue and wrapping,
3336 % but leave it ragged-right.
3338 \advance\leftskip by-\tableindent
3339 \advance\hsize by\tableindent
3340 \advance\rightskip by0pt plus1fil\relax
3341 \leavevmode\unhbox0\par
3344 % We're going to be starting a paragraph, but we don't want the
3345 % \parskip glue -- logically it's part of the @item we just started.
3346 \nobreak \vskip-\parskip
3348 % Stop a page break at the \parskip glue coming up. However, if
3349 % what follows is an environment such as @example, there will be no
3350 % \parskip glue; then the negative vskip we just inserted would
3351 % cause the example and the item to crash together. So we use this
3352 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3353 % \parskip glue after all. Section titles are handled this way also.
3357 \itemxneedsnegativevskipfalse
3359 % The item text fits into the space. Start a paragraph, so that the
3360 % following text (if any) will end up on the same line.
3362 % Do this with kerns and \unhbox so that if there is a footnote in
3363 % the item text, it can migrate to the main vertical list and
3364 % eventually be printed.
3365 \nobreak\kern-\tableindent
3366 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
3368 \nobreak\kern\dimen0
3370 \itemxneedsnegativevskiptrue
3374 \def\item{\errmessage{@item while not in a list environment}}
3375 \def\itemx{\errmessage{@itemx while not in a list environment}}
3377 % @table, @ftable, @vtable.
3379 \let\itemindex\gobble
3383 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
3384 \tablecheck{ftable}%
3387 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
3388 \tablecheck{vtable}%
3391 \ifnum \the\catcode`\^^M=\active
3393 \errmessage{This command won't work in this context; perhaps the problem is
3394 that we are \inenvironment\thisenv}%
3395 \def\next{\doignore{#1}}%
3402 \def\itemindicate{#1}%
3407 \makevalueexpandable
3408 \edef\temp{\noexpand\tablez #1\space\space\space}%
3412 \def\tablez #1 #2 #3 #4\endtablez{%
3414 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
3415 \ifnum 0#2>0 \tableindent=#2\mil \fi
3416 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
3417 \itemmax=\tableindent
3418 \advance \itemmax by -\itemmargin
3419 \advance \leftskip by \tableindent
3420 \exdentamount=\tableindent
3422 \parskip = \smallskipamount
3423 \ifdim \parskip=0pt \parskip=2pt \fi
3424 \let\item = \internalBitem
3425 \let\itemx = \internalBitemx
3427 \def\Etable{\endgraf\afterenvbreak}
3430 \let\Eitemize\Etable
3431 \let\Eenumerate\Etable
3433 % This is the counter used by @enumerate, which is really @itemize
3437 \envdef\itemize{\parsearg\doitemize}
3441 \itemmax=\itemindent
3442 \advance\itemmax by -\itemmargin
3443 \advance\leftskip by \itemindent
3444 \exdentamount=\itemindent
3446 \parskip=\smallskipamount
3447 \ifdim\parskip=0pt \parskip=2pt \fi
3449 % Try typesetting the item mark that if the document erroneously says
3450 % something like @itemize @samp (intending @table), there's an error
3451 % right away at the @itemize. It's not the best error message in the
3452 % world, but it's better than leaving it to the @item. This means if
3453 % the user wants an empty mark, they have to say @w{} not just @w.
3454 \def\itemcontents{#1}%
3455 \setbox0 = \hbox{\itemcontents}%
3457 % @itemize with no arg is equivalent to @itemize @bullet.
3458 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3460 \let\item=\itemizeitem
3463 % Definition of @item while inside @itemize and @enumerate.
3466 \advance\itemno by 1 % for enumerations
3467 {\let\par=\endgraf \smallbreak}% reasonable place to break
3469 % If the document has an @itemize directly after a section title, a
3470 % \nobreak will be last on the list, and \sectionheading will have
3471 % done a \vskip-\parskip. In that case, we don't want to zero
3472 % parskip, or the item text will crash with the heading. On the
3473 % other hand, when there is normal text preceding the item (as there
3474 % usually is), we do want to zero parskip, or there would be too much
3475 % space. In that case, we won't have a \nobreak before. At least
3476 % that's the theory.
3477 \ifnum\lastpenalty<10000 \parskip=0in \fi
3479 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
3481 \vadjust{\penalty 1200}}% not good to break after first line of item.
3485 % \splitoff TOKENS\endmark defines \first to be the first token in
3486 % TOKENS, and \rest to be the remainder.
3488 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3490 % Allow an optional argument of an uppercase letter, lowercase letter,
3491 % or number, to specify the first label in the enumerated list. No
3492 % argument is the same as `1'.
3494 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3495 \def\enumeratey #1 #2\endenumeratey{%
3496 % If we were given no argument, pretend we were given `1'.
3498 \ifx\thearg\empty \def\thearg{1}\fi
3500 % Detect if the argument is a single token. If so, it might be a
3501 % letter. Otherwise, the only valid thing it can be is a number.
3502 % (We will always have one token, because of the test we just made.
3503 % This is a good thing, since \splitoff doesn't work given nothing at
3504 % all -- the first parameter is undelimited.)
3505 \expandafter\splitoff\thearg\endmark
3507 % Only one token in the argument. It could still be anything.
3508 % A ``lowercase letter'' is one whose \lccode is nonzero.
3509 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3510 % not equal to itself.
3511 % Otherwise, we assume it's a number.
3513 % We need the \relax at the end of the \ifnum lines to stop TeX from
3514 % continuing to look for a <number>.
3516 \ifnum\lccode\expandafter`\thearg=0\relax
3517 \numericenumerate % a number (we hope)
3520 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
3521 \lowercaseenumerate % lowercase letter
3523 \uppercaseenumerate % uppercase letter
3527 % Multiple tokens in the argument. We hope it's a number.
3532 % An @enumerate whose labels are integers. The starting integer is
3535 \def\numericenumerate{%
3537 \startenumeration{\the\itemno}%
3540 % The starting (lowercase) letter is in \thearg.
3541 \def\lowercaseenumerate{%
3542 \itemno = \expandafter`\thearg
3544 % Be sure we're not beyond the end of the alphabet.
3546 \errmessage{No more lowercase letters in @enumerate; get a bigger
3553 % The starting (uppercase) letter is in \thearg.
3554 \def\uppercaseenumerate{%
3555 \itemno = \expandafter`\thearg
3557 % Be sure we're not beyond the end of the alphabet.
3559 \errmessage{No more uppercase letters in @enumerate; get a bigger
3566 % Call \doitemize, adding a period to the first argument and supplying the
3567 % common last two arguments. Also subtract one from the initial value in
3568 % \itemno, since @item increments \itemno.
3570 \def\startenumeration#1{%
3571 \advance\itemno by -1
3572 \doitemize{#1.}\flushcr
3575 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3578 \def\alphaenumerate{\enumerate{a}}
3579 \def\capsenumerate{\enumerate{A}}
3580 \def\Ealphaenumerate{\Eenumerate}
3581 \def\Ecapsenumerate{\Eenumerate}
3584 % @multitable macros
3585 % Amy Hendrickson, 8/18/94, 3/6/96
3587 % @multitable ... @end multitable will make as many columns as desired.
3588 % Contents of each column will wrap at width given in preamble. Width
3589 % can be specified either with sample text given in a template line,
3590 % or in percent of \hsize, the current width of text on page.
3592 % Table can continue over pages but will only break between lines.
3596 % Either define widths of columns in terms of percent of \hsize:
3597 % @multitable @columnfractions .25 .3 .45
3600 % Numbers following @columnfractions are the percent of the total
3601 % current hsize to be used for each column. You may use as many
3602 % columns as desired.
3605 % Or use a template:
3606 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3608 % using the widest term desired in each column.
3610 % Each new table line starts with @item, each subsequent new column
3611 % starts with @tab. Empty columns may be produced by supplying @tab's
3612 % with nothing between them for as many times as empty columns are needed,
3613 % ie, @tab@tab@tab will produce two empty columns.
3615 % @item, @tab do not need to be on their own lines, but it will not hurt
3618 % Sample multitable:
3620 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3621 % @item first col stuff @tab second col stuff @tab third col
3628 % @item first col stuff @tab second col stuff
3629 % @tab Many paragraphs of text may be used in any column.
3631 % They will wrap at the width determined by the template.
3632 % @item@tab@tab This will be in third column.
3635 % Default dimensions may be reset by user.
3636 % @multitableparskip is vertical space between paragraphs in table.
3637 % @multitableparindent is paragraph indent in table.
3638 % @multitablecolmargin is horizontal space to be left between columns.
3639 % @multitablelinespace is space to leave between table items, baseline
3641 % 0pt means it depends on current normal line spacing.
3643 \newskip\multitableparskip
3644 \newskip\multitableparindent
3645 \newdimen\multitablecolspace
3646 \newskip\multitablelinespace
3647 \multitableparskip=0pt
3648 \multitableparindent=6pt
3649 \multitablecolspace=12pt
3650 \multitablelinespace=0pt
3652 % Macros used to set up halign preamble:
3654 \let\endsetuptable\relax
3655 \def\xendsetuptable{\endsetuptable}
3656 \let\columnfractions\relax
3657 \def\xcolumnfractions{\columnfractions}
3660 % #1 is the @columnfraction, usually a decimal number like .5, but might
3661 % be just 1. We just use it, whatever it is.
3663 \def\pickupwholefraction#1 {%
3664 \global\advance\colcount by 1
3665 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
3672 \ifx\firstarg\xendsetuptable
3675 \ifx\firstarg\xcolumnfractions
3676 \global\setpercenttrue
3679 \let\go\pickupwholefraction
3681 \global\advance\colcount by 1
3682 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
3683 % separator; typically that is always in the input, anyway.
3684 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
3687 \ifx\go\pickupwholefraction
3688 % Put the argument back for the \pickupwholefraction call, so
3689 % we'll always have a period there to be parsed.
3690 \def\go{\pickupwholefraction#1}%
3692 \let\go = \setuptable
3698 % multitable-only commands.
3700 % @headitem starts a heading row, which we typeset in bold.
3701 % Assignments have to be global since we are inside the implicit group
3702 % of an alignment entry. \everycr resets \everytab so we don't have to
3703 % undo it ourselves.
3704 \def\headitemfont{\b}% for people to use in the template row; not changeable
3706 \checkenv\multitable
3708 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3709 \the\everytab % for the first item
3712 % A \tab used to include \hskip1sp. But then the space in a template
3713 % line is not enough. That is bad. So let's go back to just `&' until
3714 % we again encounter the problem the 1sp was intended to solve.
3715 % --karl, nathan@acm.org, 20apr99.
3716 \def\tab{\checkenv\multitable &\the\everytab}%
3718 % @multitable ... @end multitable definitions:
3720 \newtoks\everytab % insert after every tab.
3722 \envdef\multitable{%
3726 % @item within a multitable starts a normal row.
3727 % We use \def instead of \let so that if one of the multitable entries
3728 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3729 % \endtemplate) expanding \doitemize.
3734 \setmultitablespacing
3735 \parskip=\multitableparskip
3736 \parindent=\multitableparindent
3742 \global\everytab={}%
3743 \global\colcount=0 % Reset the column counter.
3744 % Check for saved footnotes, etc.
3746 % Keeps underfull box messages off when table breaks over pages.
3748 % Maybe so, but it also creates really weird page breaks when the
3749 % table breaks over pages. Wouldn't \vfil be better? Wait until the
3750 % problem manifests itself, so it can be fixed for real --karl.
3754 \parsearg\domultitable
3756 \def\domultitable#1{%
3757 % To parse everything between @multitable and @item:
3758 \setuptable#1 \endsetuptable
3760 % This preamble sets up a generic column definition, which will
3761 % be used as many times as user calls for columns.
3762 % \vtop will set a single line and will also let text wrap and
3763 % continue for many paragraphs if desired.
3765 \global\advance\colcount by 1
3768 % Use the current \colcount to find the correct column width:
3769 \hsize=\expandafter\csname col\the\colcount\endcsname
3771 % In order to keep entries from bumping into each other
3772 % we will add a \leftskip of \multitablecolspace to all columns after
3775 % If a template has been used, we will add \multitablecolspace
3776 % to the width of each template entry.
3778 % If the user has set preamble in terms of percent of \hsize we will
3779 % use that dimension as the width of the column, and the \leftskip
3780 % will keep entries from bumping into each other. Table will start at
3781 % left margin and final column will justify at right margin.
3783 % Make sure we don't inherit \rightskip from the outer environment.
3786 % The first column will be indented with the surrounding text.
3787 \advance\hsize by\leftskip
3790 % If user has not set preamble in terms of percent of \hsize
3791 % we will advance \hsize by \multitablecolspace.
3792 \advance\hsize by \multitablecolspace
3794 % In either case we will make \leftskip=\multitablecolspace:
3795 \leftskip=\multitablecolspace
3797 % Ignoring space at the beginning and end avoids an occasional spurious
3798 % blank line, when TeX decides to break the line at the space before the
3799 % box from the multistrut, so the strut ends up on a line by itself.
3801 % @multitable @columnfractions .11 .89
3803 % @tab Legal holiday which is valid in major parts of the whole country.
3804 % Is automatically provided with highlighting sequences respectively
3805 % marking characters.
3806 \noindent\ignorespaces##\unskip\multistrut
3811 \egroup % end the \halign
3812 \global\setpercentfalse
3815 \def\setmultitablespacing{%
3816 \def\multistrut{\strut}% just use the standard line spacing
3818 % Compute \multitablelinespace (if not defined by user) for use in
3819 % \multitableparskip calculation. We used define \multistrut based on
3820 % this, but (ironically) that caused the spacing to be off.
3821 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
3822 \ifdim\multitablelinespace=0pt
3823 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
3824 \global\advance\multitablelinespace by-\ht0
3826 %% Test to see if parskip is larger than space between lines of
3827 %% table. If not, do nothing.
3828 %% If so, set to same dimension as multitablelinespace.
3829 \ifdim\multitableparskip>\multitablelinespace
3830 \global\multitableparskip=\multitablelinespace
3831 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3832 %% than skip between lines in the table.
3834 \ifdim\multitableparskip=0pt
3835 \global\multitableparskip=\multitablelinespace
3836 \global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller
3837 %% than skip between lines in the table.
3841 \message{conditionals,}
3843 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
3844 % @ifnotxml always succeed. They currently do nothing; we don't
3845 % attempt to check whether the conditionals are properly nested. But we
3846 % have to remember that they are conditionals, so that @end doesn't
3847 % attempt to close an environment group.
3850 \expandafter\let\csname #1\endcsname = \relax
3851 \expandafter\let\csname iscond.#1\endcsname = 1
3854 \makecond{ifnotdocbook}
3855 \makecond{ifnothtml}
3856 \makecond{ifnotinfo}
3857 \makecond{ifnotplaintext}
3860 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
3862 \def\direntry{\doignore{direntry}}
3863 \def\documentdescription{\doignore{documentdescription}}
3864 \def\docbook{\doignore{docbook}}
3865 \def\html{\doignore{html}}
3866 \def\ifdocbook{\doignore{ifdocbook}}
3867 \def\ifhtml{\doignore{ifhtml}}
3868 \def\ifinfo{\doignore{ifinfo}}
3869 \def\ifnottex{\doignore{ifnottex}}
3870 \def\ifplaintext{\doignore{ifplaintext}}
3871 \def\ifxml{\doignore{ifxml}}
3872 \def\ignore{\doignore{ignore}}
3873 \def\menu{\doignore{menu}}
3874 \def\xml{\doignore{xml}}
3876 % Ignore text until a line `@end #1', keeping track of nested conditionals.
3878 % A count to remember the depth of nesting.
3879 \newcount\doignorecount
3881 \def\doignore#1{\begingroup
3882 % Scan in ``verbatim'' mode:
3884 \catcode`\@ = \other
3885 \catcode`\{ = \other
3886 \catcode`\} = \other
3888 % Make sure that spaces turn into tokens that match what \doignoretext wants.
3891 % Count number of #1's that we've seen.
3894 % Swallow text until we reach the matching `@end #1'.
3898 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
3901 \gdef\dodoignore#1{%
3902 % #1 contains the command name as a string, e.g., `ifinfo'.
3904 % Define a command to find the next `@end #1'.
3905 \long\def\doignoretext##1^^M@end #1{%
3906 \doignoretextyyy##1^^M@#1\_STOP_}%
3908 % And this command to find another #1 command, at the beginning of a
3909 % line. (Otherwise, we would consider a line `@c @ifset', for
3910 % example, to count as an @ifset for nesting.)
3911 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
3913 % And now expand that command.
3918 \def\doignoreyyy#1{%
3920 \ifx\temp\empty % Nothing found.
3921 \let\next\doignoretextzzz
3922 \else % Found a nested condition, ...
3923 \advance\doignorecount by 1
3924 \let\next\doignoretextyyy % ..., look for another.
3925 % If we're here, #1 ends with ^^M\ifinfo (for example).
3927 \next #1% the token \_STOP_ is present just after this macro.
3930 % We have to swallow the remaining "\_STOP_".
3932 \def\doignoretextzzz#1{%
3933 \ifnum\doignorecount = 0 % We have just found the outermost @end.
3934 \let\next\enddoignore
3935 \else % Still inside a nested condition.
3936 \advance\doignorecount by -1
3937 \let\next\doignoretext % Look for the next @end.
3942 % Finish off ignored text.
3944 % Ignore anything after the last `@end #1'; this matters in verbatim
3945 % environments, where otherwise the newline after an ignored conditional
3946 % would result in a blank line in the output.
3947 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
3951 % @set VAR sets the variable VAR to an empty value.
3952 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
3954 % Since we want to separate VAR from REST-OF-LINE (which might be
3955 % empty), we can't just use \parsearg; we have to insert a space of our
3956 % own to delimit the rest of the line, and then take it out again if we
3958 % We rely on the fact that \parsearg sets \catcode`\ =10.
3960 \parseargdef\set{\setyyy#1 \endsetyyy}
3961 \def\setyyy#1 #2\endsetyyy{%
3963 \makevalueexpandable
3965 \edef\next{\gdef\makecsname{SET#1}}%
3973 % Remove the trailing space \setxxx inserted.
3974 \def\setzzz#1 \endsetzzz{\next{#1}}
3976 % @clear VAR clears (i.e., unsets) the variable VAR.
3978 \parseargdef\clear{%
3980 \makevalueexpandable
3981 \global\expandafter\let\csname SET#1\endcsname=\relax
3985 % @value{foo} gets the text saved in variable foo.
3986 \def\value{\begingroup\makevalueexpandable\valuexxx}
3987 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
3989 \catcode`\- = \active \catcode`\_ = \active
3991 \gdef\makevalueexpandable{%
3992 \let\value = \expandablevalue
3993 % We don't want these characters active, ...
3994 \catcode`\-=\other \catcode`\_=\other
3995 % ..., but we might end up with active ones in the argument if
3996 % we're called from @code, as @code{@value{foo-bar_}}, though.
3997 % So \let them to their normal equivalents.
3998 \let-\realdash \let_\normalunderscore
4002 % We have this subroutine so that we can handle at least some @value's
4003 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4004 % The command has to be fully expandable (if the variable is set), since
4005 % the result winds up in the index file. This means that if the
4006 % variable's value contains other Texinfo commands, it's almost certain
4007 % it will fail (although perhaps we could fix that with sufficient work
4008 % to do a one-level expansion on the result, instead of complete).
4010 \def\expandablevalue#1{%
4011 \expandafter\ifx\csname SET#1\endcsname\relax
4012 {[No value for ``#1'']}%
4013 \message{Variable `#1', used in @value, is not set.}%
4015 \csname SET#1\endcsname
4019 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4022 % To get special treatment of `@end ifset,' call \makeond and the redefine.
4025 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4028 \makevalueexpandable
4030 \expandafter\ifx\csname SET#2\endcsname\relax
4031 #1% If not set, redefine \next.
4036 \def\ifsetfail{\doignore{ifset}}
4038 % @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been
4039 % defined with @set, or has been undefined with @clear.
4041 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4042 % above code: if the variable is not set, do nothing, if it is set,
4043 % then redefine \next to \ifclearfail.
4046 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4047 \def\ifclearfail{\doignore{ifclear}}
4049 % @dircategory CATEGORY -- specify a category of the dir file
4050 % which this file should belong to. Ignore this in TeX.
4051 \let\dircategory=\comment
4053 % @defininfoenclose.
4054 \let\definfoenclose=\comment
4058 % Index generation facilities
4060 % Define \newwrite to be identical to plain tex's \newwrite
4061 % except not \outer, so it can be used within macros and \if's.
4062 \edef\newwrite{\makecsname{ptexnewwrite}}
4064 % \newindex {foo} defines an index named foo.
4065 % It automatically defines \fooindex such that
4066 % \fooindex ...rest of line... puts an entry in the index foo.
4067 % It also defines \fooindfile to be the number of the output channel for
4068 % the file that accumulates this index. The file's extension is foo.
4069 % The name of an index should be no more than 2 characters long
4070 % for the sake of vms.
4074 \expandafter\newwrite \csname#1indfile\endcsname
4075 \openout \csname#1indfile\endcsname \jobname.#1 % Open the file
4077 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4078 \noexpand\doindex{#1}}
4081 % @defindex foo == \newindex{foo}
4083 \def\defindex{\parsearg\newindex}
4085 % Define @defcodeindex, like @defindex except put all entries in @code.
4087 \def\defcodeindex{\parsearg\newcodeindex}
4089 \def\newcodeindex#1{%
4091 \expandafter\newwrite \csname#1indfile\endcsname
4092 \openout \csname#1indfile\endcsname \jobname.#1
4094 \expandafter\xdef\csname#1index\endcsname{%
4095 \noexpand\docodeindex{#1}}%
4099 % @synindex foo bar makes index foo feed into index bar.
4100 % Do this instead of @defindex foo if you don't want it as a separate index.
4102 % @syncodeindex foo bar similar, but put all entries made for index foo
4105 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4106 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4108 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4109 % #3 the target index (bar).
4110 \def\dosynindex#1#2#3{%
4111 % Only do \closeout if we haven't already done it, else we'll end up
4112 % closing the target index.
4113 \expandafter \ifx\csname donesynindex#2\endcsname \relax
4114 % The \closeout helps reduce unnecessary open files; the limit on the
4115 % Acorn RISC OS is a mere 16 files.
4116 \expandafter\closeout\csname#2indfile\endcsname
4117 \expandafter\let\csname donesynindex#2\endcsname = 1
4119 % redefine \fooindfile:
4120 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4121 \expandafter\let\csname#2indfile\endcsname=\temp
4122 % redefine \fooindex:
4123 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4126 % Define \doindex, the driver for all \fooindex macros.
4127 % Argument #1 is generated by the calling \fooindex macro,
4128 % and it is "foo", the name of the index.
4130 % \doindex just uses \parsearg; it calls \doind for the actual work.
4131 % This is because \doind is more useful to call from other macros.
4133 % There is also \dosubind {index}{topic}{subtopic}
4134 % which makes an entry in a two-level index such as the operation index.
4136 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4137 \def\singleindexer #1{\doind{\indexname}{#1}}
4139 % like the previous two, but they put @code around the argument.
4140 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4141 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4143 % Take care of Texinfo commands that can appear in an index entry.
4144 % Since there are some commands we want to expand, and others we don't,
4145 % we have to laboriously prevent expansion for those that we don't.
4148 \escapechar = `\\ % use backslash in output files.
4149 \def\@{@}% change to @@ when we switch to @ as escape char in index files.
4150 \def\ {\realbackslash\space }%
4152 % Need these in case \tex is in effect and \{ is a \delimiter again.
4153 % But can't use \lbracecmd and \rbracecmd because texindex assumes
4154 % braces and backslashes are used only as delimiters.
4158 % I don't entirely understand this, but when an index entry is
4159 % generated from a macro call, the \endinput which \scanmacro inserts
4160 % causes processing to be prematurely terminated. This is,
4161 % apparently, because \indexsorttmp is fully expanded, and \endinput
4162 % is an expandable command. The redefinition below makes \endinput
4163 % disappear altogether for that purpose -- although logging shows that
4164 % processing continues to some further point. On the other hand, it
4165 % seems \endinput does not hurt in the printed index arg, since that
4166 % is still getting written without apparent harm.
4168 % Sample source (mac-idx3.tex, reported by Graham Percival to
4169 % help-texinfo, 22may06):
4170 % @macro funindex {WORD}
4174 % @funindex commtest
4176 % The above is not enough to reproduce the bug, but it gives the flavor.
4178 % Sample whatsit resulting:
4179 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4182 \let\endinput = \empty
4184 % Do the redefinitions.
4188 % For the aux and toc files, @ is the escape character. So we want to
4189 % redefine everything using @ as the escape character (instead of
4190 % \realbackslash, still used for index files). When everything uses @,
4191 % this will be simpler.
4196 \let\{ = \lbraceatcmd
4197 \let\} = \rbraceatcmd
4199 % Do the redefinitions.
4204 % Called from \indexdummies and \atdummies.
4206 \def\commondummies{%
4208 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4209 % preventing its expansion. This is used only for control% words,
4210 % not control letters, because the \space would be incorrect for
4211 % control characters, but is needed to separate the control word
4212 % from whatever follows.
4214 % For control letters, we have \definedummyletter, which omits the
4217 % These can be used both for control words that take an argument and
4218 % those that do not. If it is followed by {arg} in the input, then
4219 % that will dutifully get written to the index (or wherever).
4221 \def\definedummyword ##1{\def##1{\string##1\space}}%
4222 \def\definedummyletter##1{\def##1{\string##1}}%
4223 \let\definedummyaccent\definedummyletter
4225 \commondummiesnofonts
4227 \definedummyletter\_%
4229 % Non-English letters.
4240 \definedummyword\exclamdown
4244 \definedummyword\ordf
4245 \definedummyword\ordm
4246 \definedummyword\questiondown
4250 % Although these internal commands shouldn't show up, sometimes they do.
4252 \definedummyword\gtr
4253 \definedummyword\hat
4254 \definedummyword\less
4257 \definedummyword\tclose
4260 \definedummyword\LaTeX
4261 \definedummyword\TeX
4263 % Assorted special characters.
4264 \definedummyword\bullet
4265 \definedummyword\comma
4266 \definedummyword\copyright
4267 \definedummyword\registeredsymbol
4268 \definedummyword\dots
4269 \definedummyword\enddots
4270 \definedummyword\equiv
4271 \definedummyword\error
4272 \definedummyword\euro
4273 \definedummyword\guillemetleft
4274 \definedummyword\guillemetright
4275 \definedummyword\guilsinglleft
4276 \definedummyword\guilsinglright
4277 \definedummyword\expansion
4278 \definedummyword\minus
4279 \definedummyword\ogonek
4280 \definedummyword\pounds
4281 \definedummyword\point
4282 \definedummyword\print
4283 \definedummyword\quotedblbase
4284 \definedummyword\quotedblleft
4285 \definedummyword\quotedblright
4286 \definedummyword\quoteleft
4287 \definedummyword\quoteright
4288 \definedummyword\quotesinglbase
4289 \definedummyword\result
4290 \definedummyword\textdegree
4292 % We want to disable all macros so that they are not expanded by \write.
4295 \normalturnoffactive
4297 % Handle some cases of @value -- where it does not contain any
4298 % (non-fully-expandable) commands.
4299 \makevalueexpandable
4302 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4304 \def\commondummiesnofonts{%
4305 % Control letters and accents.
4306 \definedummyletter\!%
4307 \definedummyaccent\"%
4308 \definedummyaccent\'%
4309 \definedummyletter\*%
4310 \definedummyaccent\,%
4311 \definedummyletter\.%
4312 \definedummyletter\/%
4313 \definedummyletter\:%
4314 \definedummyaccent\=%
4315 \definedummyletter\?%
4316 \definedummyaccent\^%
4317 \definedummyaccent\`%
4318 \definedummyaccent\~%
4322 \definedummyword\dotaccent
4323 \definedummyword\ogonek
4324 \definedummyword\ringaccent
4325 \definedummyword\tieaccent
4326 \definedummyword\ubaraccent
4327 \definedummyword\udotaccent
4328 \definedummyword\dotless
4330 % Texinfo font commands.
4337 % Commands that take arguments.
4338 \definedummyword\acronym
4339 \definedummyword\cite
4340 \definedummyword\code
4341 \definedummyword\command
4342 \definedummyword\dfn
4343 \definedummyword\email
4344 \definedummyword\emph
4345 \definedummyword\env
4346 \definedummyword\file
4347 \definedummyword\kbd
4348 \definedummyword\key
4349 \definedummyword\math
4350 \definedummyword\option
4351 \definedummyword\pxref
4352 \definedummyword\ref
4353 \definedummyword\samp
4354 \definedummyword\strong
4355 \definedummyword\tie
4356 \definedummyword\uref
4357 \definedummyword\url
4358 \definedummyword\var
4359 \definedummyword\verb
4361 \definedummyword\xref
4364 % \indexnofonts is used when outputting the strings to sort the index
4365 % by, and when constructing control sequence names. It eliminates all
4366 % control sequences and just writes whatever the best ASCII sort string
4367 % would be for a given command (usually its argument).
4370 % Accent commands should become @asis.
4371 \def\definedummyaccent##1{\let##1\asis}%
4372 % We can just ignore other control letters.
4373 \def\definedummyletter##1{\let##1\empty}%
4374 % Hopefully, all control words can become @asis.
4375 \let\definedummyword\definedummyaccent
4377 \commondummiesnofonts
4379 % Don't no-op \tt, since it isn't a user-level command
4380 % and is used in the definitions of the active chars like <, >, |, etc.
4381 % Likewise with the other plain tex font commands.
4386 % how to handle braces?
4387 \def\_{\normalunderscore}%
4389 % Non-English letters.
4406 \def\questiondown{?}%
4413 % Assorted special characters.
4414 % (The following {} will end up in the sort string, but that's ok.)
4415 \def\bullet{bullet}%
4417 \def\copyright{copyright}%
4423 \def\expansion{==>}%
4424 \def\guillemetleft{<<}%
4425 \def\guillemetright{>>}%
4426 \def\guilsinglleft{<}%
4427 \def\guilsinglright{>}%
4430 \def\pounds{pounds}%
4432 \def\quotedblbase{"}%
4433 \def\quotedblleft{"}%
4434 \def\quotedblright{"}%
4437 \def\quotesinglbase{,}%
4438 \def\registeredsymbol{R}%
4442 % We need to get rid of all macros, leaving only the arguments (if present).
4443 % Of course this is not nearly correct, but it is the best we can do for now.
4444 % makeinfo does not expand macros in the argument to @deffn, which ends up
4445 % writing an index entry, and texindex isn't prepared for an index sort entry
4446 % that starts with \.
4448 % Since macro invocations are followed by braces, we can just redefine them
4449 % to take a single TeX argument. The case of a macro invocation that
4450 % goes to end-of-line is not handled.
4455 \let\indexbackslash=0 %overridden during \printindex.
4456 \let\SETmarginindex=\relax % put index entries in margin (undocumented)?
4458 % Most index entries go through here, but \dosubind is the general case.
4459 % #1 is the index name, #2 is the entry text.
4460 \def\doind#1#2{\dosubind{#1}{#2}{}}
4462 % Workhorse for all \fooindexes.
4463 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4464 % empty if called from \doind, as we usually are (the main exception
4465 % is with most defuns, which call us directly).
4467 \def\dosubind#1#2#3{%
4470 % Store the main index entry text (including the third arg).
4472 % If third arg is present, precede it with a space.
4474 \ifx\thirdarg\empty \else
4475 \toks0 = \expandafter{\the\toks0 \space #3}%
4478 \edef\writeto{\csname#1indfile\endcsname}%
4480 \safewhatsit\dosubindwrite
4485 % Write the entry in \toks0 to the index file:
4487 \def\dosubindwrite{%
4488 % Put the index entry in the margin if desired.
4489 \ifx\SETmarginindex\relax\else
4490 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}%
4493 % Remember, we are within a group.
4494 \indexdummies % Must do this here, since \bf, etc expand at this stage
4495 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4496 % so it will be output as is; and it will print as backslash.
4498 % Process the index entry with all font commands turned off, to
4499 % get the string to sort by.
4501 \edef\temp{\the\toks0}% need full expansion
4502 \xdef\indexsorttmp{\temp}%
4505 % Set up the complete index entry, with both the sort key and
4506 % the original text, including any font commands. We write
4507 % three arguments to \entry to the .?? file (four in the
4508 % subentry case), texindex reduces to two when writing the .??s
4512 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4517 % Take care of unwanted page breaks/skips around a whatsit:
4519 % If a skip is the last thing on the list now, preserve it
4520 % by backing up by \lastskip, doing the \write, then inserting
4521 % the skip again. Otherwise, the whatsit generated by the
4522 % \write or \pdfdest will make \lastskip zero. The result is that
4523 % sequences like this:
4527 % will have extra space inserted, because the \medbreak in the
4528 % start of the @defun won't see the skip inserted by the @end of
4529 % the previous defun.
4531 % But don't do any of this if we're not in vertical mode. We
4532 % don't want to do a \vskip and prematurely end a paragraph.
4534 % Avoid page breaks due to these extra skips, too.
4536 % But wait, there is a catch there:
4537 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4538 % sufficient for this purpose, as it ignores stretch and shrink parts
4539 % of the skip. The only way seems to be to check the textual
4540 % representation of the skip.
4542 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4543 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4545 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
4547 \newskip\whatsitskip
4548 \newcount\whatsitpenalty
4552 \def\safewhatsit#1{%
4556 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4557 \whatsitskip = \lastskip
4558 \edef\lastskipmacro{\the\lastskip}%
4559 \whatsitpenalty = \lastpenalty
4561 % If \lastskip is nonzero, that means the last item was a
4562 % skip. And since a skip is discardable, that means this
4563 % -\whatsitskip glue we're inserting is preceded by a
4564 % non-discardable item, therefore it is not a potential
4565 % breakpoint, therefore no \nobreak needed.
4566 \ifx\lastskipmacro\zeroskipmacro
4573 \ifx\lastskipmacro\zeroskipmacro
4574 % If \lastskip was zero, perhaps the last item was a penalty, and
4575 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4576 % to re-insert the same penalty (values >10000 are used for various
4577 % signals); since we just inserted a non-discardable item, any
4578 % following glue (such as a \parskip) would be a breakpoint. For example:
4580 % @deffn deffn-whatever
4581 % @vindex index-whatever
4583 % would allow a break between the index-whatever whatsit
4584 % and the "Description." paragraph.
4585 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
4587 % On the other hand, if we had a nonzero \lastskip,
4588 % this make-up glue would be preceded by a non-discardable item
4589 % (the whatsit from the \write), so we must insert a \nobreak.
4590 \nobreak\vskip\whatsitskip
4595 % The index entry written in the file actually looks like
4596 % \entry {sortstring}{page}{topic}
4598 % \entry {sortstring}{page}{topic}{subtopic}
4599 % The texindex program reads in these files and writes files
4600 % containing these kinds of lines:
4602 % before the first topic whose initial is c
4603 % \entry {topic}{pagelist}
4604 % for a topic that is used without subtopics
4606 % for the beginning of a topic that is used with subtopics
4607 % \secondary {subtopic}{pagelist}
4608 % for each subtopic.
4610 % Define the user-accessible indexing commands
4611 % @findex, @vindex, @kindex, @cindex.
4613 \def\findex {\fnindex}
4614 \def\kindex {\kyindex}
4615 \def\cindex {\cpindex}
4616 \def\vindex {\vrindex}
4617 \def\tindex {\tpindex}
4618 \def\pindex {\pgindex}
4620 \def\cindexsub {\begingroup\obeylines\cindexsub}
4622 \gdef\cindexsub "#1" #2^^M{\endgroup %
4623 \dosubind{cp}{#2}{#1}}}
4625 % Define the macros used in formatting output of the sorted index material.
4627 % @printindex causes a particular index (the ??s file) to get printed.
4628 % It does not print any chapter heading (usually an @unnumbered).
4630 \parseargdef\printindex{\begingroup
4631 \dobreak \chapheadingskip{10000}%
4636 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
4638 % See if the index file exists and is nonempty.
4639 % Change catcode of @ here so that if the index file contains
4641 % as its first line, TeX doesn't complain about mismatched braces
4642 % (because it thinks @} is a control sequence).
4644 \openin 1 \jobname.#1s
4646 % \enddoublecolumns gets confused if there is no text in the index,
4647 % and it loses the chapter title and the aux file entries for the
4648 % index. The easiest way to prevent this problem is to make sure
4649 % there is some text.
4650 \putwordIndexNonexistent
4653 % If the index file exists but is empty, then \openin leaves \ifeof
4654 % false. We have to make TeX try to read something from the file, so
4655 % it can discover if there is anything in it.
4658 \putwordIndexIsEmpty
4660 % Index files are almost Texinfo source, but we use \ as the escape
4661 % character. It would be better to use @, but that's too big a change
4662 % to make right now.
4663 \def\indexbackslash{\backslashcurfont}%
4674 % These macros are used by the sorted index file itself.
4675 % Change them to control the appearance of the index.
4678 % Some minor font changes for the special characters.
4679 \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt
4681 % Remove any glue we may have, we'll be inserting our own.
4684 % We like breaks before the index initials, so insert a bonus.
4686 \vskip 0pt plus 3\baselineskip
4688 \vskip 0pt plus -3\baselineskip
4690 % Typeset the initial. Making this add up to a whole number of
4691 % baselineskips increases the chance of the dots lining up from column
4692 % to column. It still won't often be perfect, because of the stretch
4693 % we need before each entry, but it's better.
4695 % No shrink because it confuses \balancecolumns.
4696 \vskip 1.67\baselineskip plus .5\baselineskip
4697 \leftline{\secbf #1}%
4698 % Do our best not to break after the initial.
4700 \vskip .33\baselineskip plus .1\baselineskip
4703 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
4704 % then page number (#2) flushed to the right margin. It is used for index
4705 % and table of contents entries. The paragraph is indented by \leftskip.
4707 % A straightforward implementation would start like this:
4708 % \def\entry#1#2{...
4709 % But this freezes the catcodes in the argument, and can cause problems to
4710 % @code, which sets - active. This problem was fixed by a kludge---
4711 % ``-'' was active throughout whole index, but this isn't really right.
4713 % The right solution is to prevent \entry from swallowing the whole text.
4718 % Start a new paragraph if necessary, so our assignments below can't
4719 % affect previous text.
4722 % Do not fill out the last line with white space.
4725 % No extra space above this paragraph.
4728 % Do not prefer a separate line ending with a hyphen to fewer lines.
4729 \finalhyphendemerits = 0
4731 % \hangindent is only relevant when the entry text and page number
4732 % don't both fit on one line. In that case, bob suggests starting the
4733 % dots pretty far over on the line. Unfortunately, a large
4734 % indentation looks wrong when the entry text itself is broken across
4735 % lines. So we use a small indentation and put up with long leaders.
4737 % \hangafter is reset to 1 (which is the value we want) at the start
4738 % of each paragraph, so we need not do anything with that.
4741 % When the entry text needs to be broken, just fill out the first line
4743 \rightskip = 0pt plus1fil
4745 % A bit of stretch before each entry for the benefit of balancing
4749 % When reading the text of entry, convert explicit line breaks
4750 % from @* into spaces. The user might give these in long section
4751 % titles, for instance.
4752 \def\*{\unskip\space\ignorespaces}%
4754 % Swallow the left brace of the text (first parameter):
4755 \afterassignment\doentry
4759 \bgroup % Instead of the swallowed brace.
4761 \aftergroup\finishentry
4762 % And now comes the text of the entry.
4764 \def\finishentry#1{%
4765 % #1 is the page number.
4767 % The following is kludged to not output a line of dots in the index if
4768 % there are no page numbers. The next person who breaks this will be
4769 % cursed by a Unix daemon.
4770 \setbox\boxA = \hbox{#1}%
4771 \ifdim\wd\boxA = 0pt
4775 % If we must, put the page number on a line of its own, and fill out
4776 % this line with blank space. (The \hfil is overwhelmed with the
4777 % fill leaders glue in \indexdotfill if the page number does fit.)
4779 \null\nobreak\indexdotfill % Have leaders before the page number.
4781 % The `\ ' here is removed by the implicit \unskip that TeX does as
4782 % part of (the primitive) \par. Without it, a spurious underfull
4795 % Like plain.tex's \dotfill, except uses up at least 1 em.
4796 \def\indexdotfill{\cleaders
4797 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill}
4799 \def\primary #1{\line{#1\hfil}}
4801 \newskip\secondaryindent \secondaryindent=0.5cm
4802 \def\secondary#1#2{{%
4807 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
4809 \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph.
4816 % Define two-column mode, which we use to typeset indexes.
4817 % Adapted from the TeXbook, page 416, which is to say,
4818 % the manmac.tex format used to print the TeXbook itself.
4822 \newdimen\doublecolumnhsize
4824 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
4825 % Grab any single-column material above us.
4828 % Here is a possibility not foreseen in manmac: if we accumulate a
4829 % whole lot of material, we might end up calling this \output
4830 % routine twice in a row (see the doublecol-lose test, which is
4831 % essentially a couple of indexes with @setchapternewpage off). In
4832 % that case we just ship out what is in \partialpage with the normal
4833 % output routine. Generally, \partialpage will be empty when this
4834 % runs and this will be a no-op. See the indexspread.tex test case.
4835 \ifvoid\partialpage \else
4836 \onepageout{\pagecontents\partialpage}%
4839 \global\setbox\partialpage = \vbox{%
4840 % Unvbox the main output page.
4842 \kern-\topskip \kern\baselineskip
4845 \eject % run that output routine to set \partialpage
4847 % Use the double-column output routine for subsequent pages.
4848 \output = {\doublecolumnout}%
4850 % Change the page size parameters. We could do this once outside this
4851 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
4852 % format, but then we repeat the same computation. Repeating a couple
4853 % of assignments once per index is clearly meaningless for the
4854 % execution time, so we may as well do it in one place.
4856 % First we halve the line length, less a little for the gutter between
4857 % the columns. We compute the gutter based on the line length, so it
4858 % changes automatically with the paper format. The magic constant
4859 % below is chosen so that the gutter has the same value (well, +-<1pt)
4860 % as it did when we hard-coded it.
4862 % We put the result in a separate register, \doublecolumhsize, so we
4863 % can restore it in \pagesofar, after \hsize itself has (potentially)
4866 \doublecolumnhsize = \hsize
4867 \advance\doublecolumnhsize by -.04154\hsize
4868 \divide\doublecolumnhsize by 2
4869 \hsize = \doublecolumnhsize
4871 % Double the \vsize as well. (We don't need a separate register here,
4872 % since nobody clobbers \vsize.)
4876 % The double-column output routine for all double-column pages except
4879 \def\doublecolumnout{%
4880 \splittopskip=\topskip \splitmaxdepth=\maxdepth
4881 % Get the available space for the double columns -- the normal
4882 % (undoubled) page height minus any material left over from the
4886 \advance\dimen@ by -\ht\partialpage
4888 % box0 will be the left-hand column, box2 the right.
4889 \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@
4890 \onepageout\pagesofar
4892 \penalty\outputpenalty
4895 % Re-output the contents of the output page -- any previous material,
4896 % followed by the two boxes we just split, in box0 and box2.
4900 \hsize = \doublecolumnhsize
4901 \wd0=\hsize \wd2=\hsize
4902 \hbox to\pagewidth{\box0\hfil\box2}%
4905 % All done with double columns.
4906 \def\enddoublecolumns{%
4907 % The following penalty ensures that the page builder is exercised
4908 % _before_ we change the output routine. This is necessary in the
4909 % following situation:
4911 % The last section of the index consists only of a single entry.
4912 % Before this section, \pagetotal is less than \pagegoal, so no
4913 % break occurs before the last section starts. However, the last
4914 % section, consisting of \initial and the single \entry, does not
4915 % fit on the page and has to be broken off. Without the following
4916 % penalty the page builder will not be exercised until \eject
4917 % below, and by that time we'll already have changed the output
4918 % routine to the \balancecolumns version, so the next-to-last
4919 % double-column page will be processed with \balancecolumns, which
4920 % is wrong: The two columns will go to the main vertical list, with
4921 % the broken-off section in the recent contributions. As soon as
4922 % the output routine finishes, TeX starts reconsidering the page
4923 % break. The two columns and the broken-off section both fit on the
4924 % page, because the two columns now take up only half of the page
4925 % goal. When TeX sees \eject from below which follows the final
4926 % section, it invokes the new output routine that we've set after
4927 % \balancecolumns below; \onepageout will try to fit the two columns
4928 % and the final section into the vbox of \pageheight (see
4929 % \pagebody), causing an overfull box.
4931 % Note that glue won't work here, because glue does not exercise the
4932 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
4936 % Split the last of the double-column material. Leave it on the
4937 % current page, no automatic page break.
4940 % If we end up splitting too much material for the current page,
4941 % though, there will be another page break right after this \output
4942 % invocation ends. Having called \balancecolumns once, we do not
4943 % want to call it again. Therefore, reset \output to its normal
4944 % definition right away. (We hope \balancecolumns will never be
4945 % called on to balance too much material, but if it is, this makes
4946 % the output somewhat more palatable.)
4947 \global\output = {\onepageout{\pagecontents\PAGE}}%
4950 \endgroup % started in \begindoublecolumns
4952 % \pagegoal was set to the doubled \vsize above, since we restarted
4953 % the current page. We're now back to normal single-column
4954 % typesetting, so reset \pagegoal to the normal \vsize (after the
4955 % \endgroup where \vsize got restored).
4959 % Called at the end of the double column material.
4960 \def\balancecolumns{%
4961 \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120.
4963 \advance\dimen@ by \topskip
4964 \advance\dimen@ by-\baselineskip
4965 \divide\dimen@ by 2 % target to split to
4966 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
4967 \splittopskip = \topskip
4968 % Loop until we get a decent breakpoint.
4972 \global\setbox3 = \copy0
4973 \global\setbox1 = \vsplit3 to \dimen@
4975 \global\advance\dimen@ by 1pt
4978 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
4979 \setbox0=\vbox to\dimen@{\unvbox1}%
4980 \setbox2=\vbox to\dimen@{\unvbox3}%
4984 \catcode`\@ = \other
4987 \message{sectioning,}
4988 % Chapters, sections, etc.
4990 % Let's start with @part.
4991 \outer\parseargdef\part{\partzzz{#1}}
4995 \vskip.3\vsize % move it down on the page a bit
4997 \noindent \titlefonts\rmisbold #1\par % the text
4998 \let\lastnode=\empty % no node to associate with
4999 \writetocentry{part}{#1}{}% but put it in the toc
5000 \headingsoff % no headline or footline on the part page
5005 % \unnumberedno is an oxymoron. But we count the unnumbered
5006 % sections so that we can refer to them unambiguously in the pdf
5007 % outlines by their "section number". We avoid collisions with chapter
5008 % numbers by starting them at 10000. (If a document ever has 10000
5009 % chapters, we're in trouble anyway, I'm sure.)
5010 \newcount\unnumberedno \unnumberedno = 10000
5012 \newcount\secno \secno=0
5013 \newcount\subsecno \subsecno=0
5014 \newcount\subsubsecno \subsubsecno=0
5016 % This counter is funny since it counts through charcodes of letters A, B, ...
5017 \newcount\appendixno \appendixno = `\@
5019 % \def\appendixletter{\char\the\appendixno}
5020 % We do the following ugly conditional instead of the above simple
5021 % construct for the sake of pdftex, which needs the actual
5022 % letter in the expansion, not just typeset.
5024 \def\appendixletter{%
5025 \ifnum\appendixno=`A A%
5026 \else\ifnum\appendixno=`B B%
5027 \else\ifnum\appendixno=`C C%
5028 \else\ifnum\appendixno=`D D%
5029 \else\ifnum\appendixno=`E E%
5030 \else\ifnum\appendixno=`F F%
5031 \else\ifnum\appendixno=`G G%
5032 \else\ifnum\appendixno=`H H%
5033 \else\ifnum\appendixno=`I I%
5034 \else\ifnum\appendixno=`J J%
5035 \else\ifnum\appendixno=`K K%
5036 \else\ifnum\appendixno=`L L%
5037 \else\ifnum\appendixno=`M M%
5038 \else\ifnum\appendixno=`N N%
5039 \else\ifnum\appendixno=`O O%
5040 \else\ifnum\appendixno=`P P%
5041 \else\ifnum\appendixno=`Q Q%
5042 \else\ifnum\appendixno=`R R%
5043 \else\ifnum\appendixno=`S S%
5044 \else\ifnum\appendixno=`T T%
5045 \else\ifnum\appendixno=`U U%
5046 \else\ifnum\appendixno=`V V%
5047 \else\ifnum\appendixno=`W W%
5048 \else\ifnum\appendixno=`X X%
5049 \else\ifnum\appendixno=`Y Y%
5050 \else\ifnum\appendixno=`Z Z%
5051 % The \the is necessary, despite appearances, because \appendixletter is
5052 % expanded while writing the .toc file. \char\appendixno is not
5053 % expandable, thus it is written literally, thus all appendixes come out
5054 % with the same letter (or @) in the toc without it.
5055 \else\char\the\appendixno
5056 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5057 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5059 % Each @chapter defines these (using marks) as the number+name, number
5060 % and name of the chapter. Page headings and footings can use
5061 % these. @section does likewise.
5063 \def\thischapternum{}
5064 \def\thischaptername{}
5066 \def\thissectionnum{}
5067 \def\thissectionname{}
5069 \newcount\absseclevel % used to calculate proper heading level
5070 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
5072 % @raisesections: treat @section as chapter, @subsection as section, etc.
5073 \def\raisesections{\global\advance\secbase by -1}
5074 \let\up=\raisesections % original BFox name
5076 % @lowersections: treat @chapter as section, @section as subsection, etc.
5077 \def\lowersections{\global\advance\secbase by 1}
5078 \let\down=\lowersections % original BFox name
5080 % we only have subsub.
5081 \chardef\maxseclevel = 3
5083 % A numbered section within an unnumbered changes to unnumbered too.
5084 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5085 \chardef\unnlevel = \maxseclevel
5087 % Trace whether the current chapter is an appendix or not:
5088 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5089 \def\chapheadtype{N}
5091 % Choose a heading macro
5092 % #1 is heading type
5093 % #2 is heading level
5094 % #3 is text for heading
5095 \def\genhead#1#2#3{%
5096 % Compute the abs. sec. level:
5098 \advance\absseclevel by \secbase
5099 % Make sure \absseclevel doesn't fall outside the range:
5100 \ifnum \absseclevel < 0
5103 \ifnum \absseclevel > 3
5110 \ifnum \absseclevel < \unnlevel
5111 \chardef\unnlevel = \absseclevel
5114 % Check for appendix sections:
5115 \ifnum \absseclevel = 0
5116 \edef\chapheadtype{\headtype}%
5118 \if \headtype A\if \chapheadtype N%
5119 \errmessage{@appendix... within a non-appendix chapter}%
5122 % Check for numbered within unnumbered:
5123 \ifnum \absseclevel > \unnlevel
5126 \chardef\unnlevel = 3
5129 % Now print the heading:
5133 \or \unnumberedseczzz{#3}%
5134 \or \unnumberedsubseczzz{#3}%
5135 \or \unnumberedsubsubseczzz{#3}%
5141 \or \appendixsectionzzz{#3}%
5142 \or \appendixsubseczzz{#3}%
5143 \or \appendixsubsubseczzz{#3}%
5149 \or \numberedsubseczzz{#3}%
5150 \or \numberedsubsubseczzz{#3}%
5154 \suppressfirstparagraphindent
5158 \def\numhead{\genhead N}
5159 \def\apphead{\genhead A}
5160 \def\unnmhead{\genhead U}
5162 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5163 % all lower-level sectioning counters to zero.
5165 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5166 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5167 \let\chaplevelprefix = \empty
5169 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5171 % section resetting is \global in case the chapter is in a group, such
5172 % as an @include file.
5173 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5174 \global\advance\chapno by 1
5177 \gdef\chaplevelprefix{\the\chapno.}%
5180 % \putwordChapter can contain complex things in translations.
5181 \toks0=\expandafter{\putwordChapter}%
5182 \message{\the\toks0 \space \the\chapno}%
5184 % Write the actual heading.
5185 \chapmacro{#1}{Ynumbered}{\the\chapno}%
5187 % So @section and the like are numbered underneath this chapter.
5188 \global\let\section = \numberedsec
5189 \global\let\subsection = \numberedsubsec
5190 \global\let\subsubsection = \numberedsubsubsec
5193 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5195 \def\appendixzzz#1{%
5196 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5197 \global\advance\appendixno by 1
5198 \gdef\chaplevelprefix{\appendixletter.}%
5201 % \putwordAppendix can contain complex things in translations.
5202 \toks0=\expandafter{\putwordAppendix}%
5203 \message{\the\toks0 \space \appendixletter}%
5205 \chapmacro{#1}{Yappendix}{\appendixletter}%
5207 \global\let\section = \appendixsec
5208 \global\let\subsection = \appendixsubsec
5209 \global\let\subsubsection = \appendixsubsubsec
5212 \outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz
5213 \def\unnumberedzzz#1{%
5214 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
5215 \global\advance\unnumberedno by 1
5217 % Since an unnumbered has no number, no prefix for figures.
5218 \global\let\chaplevelprefix = \empty
5221 % This used to be simply \message{#1}, but TeX fully expands the
5222 % argument to \message. Therefore, if #1 contained @-commands, TeX
5223 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5224 % expanded @cite (which turns out to cause errors because \cite is meant
5225 % to be executed, not expanded).
5227 % Anyway, we don't want the fully-expanded definition of @cite to appear
5228 % as a result of the \message, we just want `@cite' itself. We use
5229 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5230 % simply yielding the contents of <toks register>. (We also do this for
5233 \message{(\the\toks0)}%
5235 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
5237 \global\let\section = \unnumberedsec
5238 \global\let\subsection = \unnumberedsubsec
5239 \global\let\subsubsection = \unnumberedsubsubsec
5242 % @centerchap is like @unnumbered, but the heading is centered.
5243 \outer\parseargdef\centerchap{%
5244 % Well, we could do the following in a group, but that would break
5245 % an assumption that \chapmacro is called at the outermost level.
5246 % Thus we are safer this way: --kasal, 24feb04
5247 \let\centerparametersmaybe = \centerparameters
5249 \let\centerparametersmaybe = \relax
5252 % @top is like @unnumbered.
5256 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5258 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5259 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
5262 \outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz
5263 \def\appendixsectionzzz#1{%
5264 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5265 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
5267 \let\appendixsec\appendixsection
5269 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz
5270 \def\unnumberedseczzz#1{%
5271 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
5272 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
5276 \outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz
5277 \def\numberedsubseczzz#1{%
5278 \global\subsubsecno=0 \global\advance\subsecno by 1
5279 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
5282 \outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz
5283 \def\appendixsubseczzz#1{%
5284 \global\subsubsecno=0 \global\advance\subsecno by 1
5285 \sectionheading{#1}{subsec}{Yappendix}%
5286 {\appendixletter.\the\secno.\the\subsecno}%
5289 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz
5290 \def\unnumberedsubseczzz#1{%
5291 \global\subsubsecno=0 \global\advance\subsecno by 1
5292 \sectionheading{#1}{subsec}{Ynothing}%
5293 {\the\unnumberedno.\the\secno.\the\subsecno}%
5297 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz
5298 \def\numberedsubsubseczzz#1{%
5299 \global\advance\subsubsecno by 1
5300 \sectionheading{#1}{subsubsec}{Ynumbered}%
5301 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
5304 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz
5305 \def\appendixsubsubseczzz#1{%
5306 \global\advance\subsubsecno by 1
5307 \sectionheading{#1}{subsubsec}{Yappendix}%
5308 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
5311 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz
5312 \def\unnumberedsubsubseczzz#1{%
5313 \global\advance\subsubsecno by 1
5314 \sectionheading{#1}{subsubsec}{Ynothing}%
5315 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
5318 % These macros control what the section commands do, according
5319 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5320 % Define them by default for a numbered chapter.
5321 \let\section = \numberedsec
5322 \let\subsection = \numberedsubsec
5323 \let\subsubsection = \numberedsubsubsec
5325 % Define @majorheading, @heading and @subheading
5327 % NOTE on use of \vbox for chapter headings, section headings, and such:
5328 % 1) We use \vbox rather than the earlier \line to permit
5329 % overlong headings to fold.
5330 % 2) \hyphenpenalty is set to 10000 because hyphenation in a
5331 % heading is obnoxious; this forbids it.
5332 % 3) Likewise, headings look best if no \parindent is used, and
5333 % if justification is not attempted. Hence \raggedright.
5336 {\advance\chapheadingskip by 10pt \chapbreak }%
5337 \parsearg\chapheadingzzz
5340 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5341 \def\chapheadingzzz#1{%
5342 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5343 \parindent=0pt\ptexraggedright
5344 \rmisbold #1\hfill}}%
5345 \bigskip \par\penalty 200\relax
5346 \suppressfirstparagraphindent
5349 % @heading, @subheading, @subsubheading.
5350 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
5351 \suppressfirstparagraphindent}
5352 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
5353 \suppressfirstparagraphindent}
5354 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
5355 \suppressfirstparagraphindent}
5357 % These macros generate a chapter, section, etc. heading only
5358 % (including whitespace, linebreaking, etc. around it),
5359 % given all the information in convenient, parsed form.
5361 %%% Args are the skip and penalty (usually negative)
5362 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
5364 %%% Define plain chapter starts, and page on/off switching for it
5365 % Parameter controlling skip before chapter headings (if needed)
5367 \newskip\chapheadingskip
5369 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
5370 \def\chappager{\par\vfill\supereject}
5371 % Because \domark is called before \chapoddpage, the filler page will
5372 % get the headings for the next chapter, which is wrong. But we don't
5373 % care -- we just disable all headings on the filler page.
5385 \def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname}
5388 \global\let\contentsalignmacro = \chappager
5389 \global\let\pchapsepmacro=\chapbreak
5390 \global\let\pagealignmacro=\chappager}
5393 \global\let\contentsalignmacro = \chappager
5394 \global\let\pchapsepmacro=\chappager
5395 \global\let\pagealignmacro=\chappager
5396 \global\def\HEADINGSon{\HEADINGSsingle}}
5399 \global\let\contentsalignmacro = \chapoddpage
5400 \global\let\pchapsepmacro=\chapoddpage
5401 \global\let\pagealignmacro=\chapoddpage
5402 \global\def\HEADINGSon{\HEADINGSdouble}}
5408 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5409 % Yappendix, Yomitfromtoc), #3 the chapter number.
5411 % To test against our argument.
5412 \def\Ynothingkeyword{Ynothing}
5413 \def\Yomitfromtockeyword{Yomitfromtoc}
5414 \def\Yappendixkeyword{Yappendix}
5416 \def\chapmacro#1#2#3{%
5417 % Insert the first mark before the heading break (see notes for \domark).
5418 \let\prevchapterdefs=\lastchapterdefs
5419 \let\prevsectiondefs=\lastsectiondefs
5420 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5421 \gdef\thissection{}}%
5424 \ifx\temptype\Ynothingkeyword
5425 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5426 \gdef\thischapter{\thischaptername}}%
5427 \else\ifx\temptype\Yomitfromtockeyword
5428 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5429 \gdef\thischapter{}}%
5430 \else\ifx\temptype\Yappendixkeyword
5432 \xdef\lastchapterdefs{%
5433 \gdef\noexpand\thischaptername{\the\toks0}%
5434 \gdef\noexpand\thischapternum{\appendixletter}%
5435 % \noexpand\putwordAppendix avoids expanding indigestible
5436 % commands in some of the translations.
5437 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5438 \noexpand\thischapternum:
5439 \noexpand\thischaptername}%
5443 \xdef\lastchapterdefs{%
5444 \gdef\noexpand\thischaptername{\the\toks0}%
5445 \gdef\noexpand\thischapternum{\the\chapno}%
5446 % \noexpand\putwordChapter avoids expanding indigestible
5447 % commands in some of the translations.
5448 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5449 \noexpand\thischapternum:
5450 \noexpand\thischaptername}%
5454 % Output the mark. Pass it through \safewhatsit, to take care of
5455 % the preceding space.
5458 % Insert the chapter heading break.
5461 % Now the second mark, after the heading break. No break points
5462 % between here and the heading.
5463 \let\prevchapterdefs=\lastchapterdefs
5464 \let\prevsectiondefs=\lastsectiondefs
5468 \chapfonts \rmisbold
5470 % Have to define \lastsection before calling \donoderef, because the
5471 % xref code eventually uses it. On the other hand, it has to be called
5472 % after \pchapsepmacro, or the headline will change too soon.
5473 \gdef\lastsection{#1}%
5475 % Only insert the separating space if we have a chapter/appendix
5476 % number, and don't print the unnumbered ``number''.
5477 \ifx\temptype\Ynothingkeyword
5479 \def\toctype{unnchap}%
5480 \else\ifx\temptype\Yomitfromtockeyword
5481 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
5483 \else\ifx\temptype\Yappendixkeyword
5484 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
5487 \setbox0 = \hbox{#3\enspace}%
5488 \def\toctype{numchap}%
5491 % Write the toc entry for this chapter. Must come before the
5492 % \donoderef, because we include the current node name in the toc
5493 % entry, and \donoderef resets it to empty.
5494 \writetocentry{\toctype}{#1}{#3}%
5496 % For pdftex, we have to write out the node definition (aka, make
5497 % the pdfdest) after any page break, but before the actual text has
5498 % been typeset. If the destination for the pdf outline is after the
5499 % text, then jumping from the outline may wind up with the text not
5500 % being visible, for instance under high magnification.
5503 % Typeset the actual heading.
5504 \nobreak % Avoid page breaks at the interline glue.
5505 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5506 \hangindent=\wd0 \centerparametersmaybe
5509 \nobreak\bigskip % no page break after a chapter title
5513 % @centerchap -- centered and unnumbered.
5514 \let\centerparametersmaybe = \relax
5515 \def\centerparameters{%
5516 \advance\rightskip by 3\rightskip
5517 \leftskip = \rightskip
5522 % I don't think this chapter style is supported any more, so I'm not
5523 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5525 \def\setchapterstyle #1 {\csname CHAPF#1\endcsname}
5527 \def\unnchfopen #1{%
5528 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5529 \parindent=0pt\ptexraggedright
5530 \rmisbold #1\hfill}}\bigskip \par\nobreak
5532 \def\chfopen #1#2{\chapoddpage {\chapfonts
5533 \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}%
5536 \def\centerchfopen #1{%
5537 \chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000
5539 \hfill {\rmisbold #1}\hfill}}\bigskip \par\nobreak
5542 \global\let\chapmacro=\chfopen
5543 \global\let\centerchapmacro=\centerchfopen}
5546 % Section titles. These macros combine the section number parts and
5547 % call the generic \sectionheading to do the printing.
5549 \newskip\secheadingskip
5550 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
5552 % Subsection titles.
5553 \newskip\subsecheadingskip
5554 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
5556 % Subsubsection titles.
5557 \def\subsubsecheadingskip{\subsecheadingskip}
5558 \def\subsubsecheadingbreak{\subsecheadingbreak}
5561 % Print any size, any type, section title.
5563 % #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is
5564 % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the
5567 \def\seckeyword{sec}
5569 \def\sectionheading#1#2#3#4{%
5571 % Switch to the right set of fonts.
5572 \csname #2fonts\endcsname \rmisbold
5574 \def\sectionlevel{#2}%
5577 % Insert first mark before the heading break (see notes for \domark).
5578 \let\prevsectiondefs=\lastsectiondefs
5579 \ifx\temptype\Ynothingkeyword
5580 \ifx\sectionlevel\seckeyword
5581 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5582 \gdef\thissection{\thissectionname}}%
5584 \else\ifx\temptype\Yomitfromtockeyword
5585 % Don't redefine \thissection.
5586 \else\ifx\temptype\Yappendixkeyword
5587 \ifx\sectionlevel\seckeyword
5589 \xdef\lastsectiondefs{%
5590 \gdef\noexpand\thissectionname{\the\toks0}%
5591 \gdef\noexpand\thissectionnum{#4}%
5592 % \noexpand\putwordSection avoids expanding indigestible
5593 % commands in some of the translations.
5594 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5595 \noexpand\thissectionnum:
5596 \noexpand\thissectionname}%
5600 \ifx\sectionlevel\seckeyword
5602 \xdef\lastsectiondefs{%
5603 \gdef\noexpand\thissectionname{\the\toks0}%
5604 \gdef\noexpand\thissectionnum{#4}%
5605 % \noexpand\putwordSection avoids expanding indigestible
5606 % commands in some of the translations.
5607 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5608 \noexpand\thissectionnum:
5609 \noexpand\thissectionname}%
5614 % Go into vertical mode. Usually we'll already be there, but we
5615 % don't want the following whatsit to end up in a preceding paragraph
5616 % if the document didn't happen to have a blank line.
5619 % Output the mark. Pass it through \safewhatsit, to take care of
5620 % the preceding space.
5623 % Insert space above the heading.
5624 \csname #2headingbreak\endcsname
5626 % Now the second mark, after the heading break. No break points
5627 % between here and the heading.
5628 \let\prevsectiondefs=\lastsectiondefs
5631 % Only insert the space after the number if we have a section number.
5632 \ifx\temptype\Ynothingkeyword
5635 \gdef\lastsection{#1}%
5636 \else\ifx\temptype\Yomitfromtockeyword
5637 % for @headings -- no section number, don't include in toc,
5638 % and don't redefine \lastsection.
5641 \let\sectionlevel=\empty
5642 \else\ifx\temptype\Yappendixkeyword
5643 \setbox0 = \hbox{#4\enspace}%
5645 \gdef\lastsection{#1}%
5647 \setbox0 = \hbox{#4\enspace}%
5649 \gdef\lastsection{#1}%
5652 % Write the toc entry (before \donoderef). See comments in \chapmacro.
5653 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
5655 % Write the node reference (= pdf destination for pdftex).
5656 % Again, see comments in \chapmacro.
5659 % Interline glue will be inserted when the vbox is completed.
5660 % That glue will be a valid breakpoint for the page, since it'll be
5661 % preceded by a whatsit (usually from the \donoderef, or from the
5662 % \writetocentry if there was no node). We don't want to allow that
5663 % break, since then the whatsits could end up on page n while the
5664 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
5667 % Output the actual section heading.
5668 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
5669 \hangindent=\wd0 % zero if no section number
5672 % Add extra space after the heading -- half of whatever came above it.
5673 % Don't allow stretch, though.
5674 \kern .5 \csname #2headingskip\endcsname
5676 % Do not let the kern be a potential breakpoint, as it would be if it
5677 % was followed by glue.
5680 % We'll almost certainly start a paragraph next, so don't let that
5681 % glue accumulate. (Not a breakpoint because it's preceded by a
5682 % discardable item.)
5685 % This is purely so the last item on the list is a known \penalty >
5686 % 10000. This is so \startdefun can avoid allowing breakpoints after
5687 % section headings. Otherwise, it would insert a valid breakpoint between:
5689 % @section sec-whatever
5690 % @deffn def-whatever
5696 % Table of contents.
5699 % Write an entry to the toc file, opening it if necessary.
5700 % Called from @chapter, etc.
5702 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
5703 % We append the current node name (if any) and page number as additional
5704 % arguments for the \{chap,sec,...}entry macros which will eventually
5705 % read this. The node name is used in the pdf outlines as the
5706 % destination to jump to.
5708 % We open the .toc file for writing here instead of at @setfilename (or
5709 % any other fixed time) so that @contents can be anywhere in the document.
5710 % But if #1 is `omit', then we don't do anything. This is used for the
5711 % table of contents chapter openings themselves.
5713 \newif\iftocfileopened
5714 \def\omitkeyword{omit}%
5716 \def\writetocentry#1#2#3{%
5717 \edef\writetoctype{#1}%
5718 \ifx\writetoctype\omitkeyword \else
5719 \iftocfileopened\else
5720 \immediate\openout\tocfile = \jobname.toc
5721 \global\tocfileopenedtrue
5727 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
5733 % Tell \shipout to create a pdf destination on each page, if we're
5734 % writing pdf. These are used in the table of contents. We can't
5735 % just write one on every page because the title pages are numbered
5736 % 1 and 2 (the page numbers aren't printed), and so are the first
5737 % two pages of the document. Thus, we'd have two destinations named
5738 % `1', and two named `2'.
5739 \ifpdf \global\pdfmakepagedesttrue \fi
5743 % These characters do not print properly in the Computer Modern roman
5744 % fonts, so we must take special care. This is more or less redundant
5745 % with the Texinfo input format setup at the end of this file.
5747 \def\activecatcodes{%
5760 % Read the toc file, which is essentially Texinfo input.
5764 \input \tocreadfilename
5767 \newskip\contentsrightmargin \contentsrightmargin=1in
5768 \newcount\savepageno
5769 \newcount\lastnegativepageno \lastnegativepageno = -1
5771 % Prepare to read what we've written to \tocfile.
5773 \def\startcontents#1{%
5774 % If @setchapternewpage on, and @headings double, the contents should
5775 % start on an odd page, unlike chapters. Thus, we maintain
5776 % \contentsalignmacro in parallel with \pagealignmacro.
5777 % From: Torbjorn Granlund <tege@matematik.su.se>
5779 \immediate\closeout\tocfile
5781 % Don't need to put `Contents' or `Short Contents' in the headline.
5782 % It is abundantly clear what they are.
5783 \chapmacro{#1}{Yomitfromtoc}{}%
5785 \savepageno = \pageno
5786 \begingroup % Set up to handle contents files properly.
5787 \raggedbottom % Worry more about breakpoints than the bottom.
5788 \advance\hsize by -\contentsrightmargin % Don't use the full line length.
5790 % Roman numerals for page numbers.
5791 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
5794 % redefined for the two-volume lispref. We always output on
5795 % \jobname.toc even if this is redefined.
5797 \def\tocreadfilename{\jobname.toc}
5799 % Normal (long) toc.
5802 \startcontents{\putwordTOC}%
5803 \openin 1 \tocreadfilename\space
5808 \contentsalignmacro % in case @setchapternewpage odd is in effect
5814 \lastnegativepageno = \pageno
5815 \global\pageno = \savepageno
5818 % And just the chapters.
5819 \def\summarycontents{%
5820 \startcontents{\putwordShortTOC}%
5822 \let\partentry = \shortpartentry
5823 \let\numchapentry = \shortchapentry
5824 \let\appentry = \shortchapentry
5825 \let\unnchapentry = \shortunnchapentry
5826 % We want a true roman here for the page numbers.
5828 \let\rm=\shortcontrm \let\bf=\shortcontbf
5829 \let\sl=\shortcontsl \let\tt=\shortconttt
5831 \hyphenpenalty = 10000
5832 \advance\baselineskip by 1pt % Open it up a little.
5833 \def\numsecentry##1##2##3##4{}
5834 \let\appsecentry = \numsecentry
5835 \let\unnsecentry = \numsecentry
5836 \let\numsubsecentry = \numsecentry
5837 \let\appsubsecentry = \numsecentry
5838 \let\unnsubsecentry = \numsecentry
5839 \let\numsubsubsecentry = \numsecentry
5840 \let\appsubsubsecentry = \numsecentry
5841 \let\unnsubsubsecentry = \numsecentry
5842 \openin 1 \tocreadfilename\space
5848 \contentsalignmacro % in case @setchapternewpage odd is in effect
5850 \lastnegativepageno = \pageno
5851 \global\pageno = \savepageno
5853 \let\shortcontents = \summarycontents
5855 % Typeset the label for a chapter or appendix for the short contents.
5856 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
5858 \def\shortchaplabel#1{%
5859 % This space should be enough, since a single number is .5em, and the
5860 % widest letter (M) is 1em, at least in the Computer Modern fonts.
5861 % But use \hss just in case.
5862 % (This space doesn't include the extra space that gets added after
5863 % the label; that gets put in by \shortchapentry above.)
5865 % We'd like to right-justify chapter numbers, but that looks strange
5866 % with appendix letters. And right-justifying numbers and
5867 % left-justifying letters looks strange when there is less than 10
5868 % chapters. Have to read the whole toc once to know how many chapters
5869 % there are before deciding ...
5870 \hbox to 1em{#1\hss}%
5873 % These macros generate individual entries in the table of contents.
5874 % The first argument is the chapter or section name.
5875 % The last argument is the page number.
5876 % The arguments in between are the chapter number, section number, ...
5878 % Parts, in the main contents. Replace the part number, which doesn't
5879 % exist, with an empty box. Let's hope all the numbers have the same width.
5880 % Also ignore the page number, which is conventionally not printed.
5881 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
5882 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
5884 % Parts, in the short toc.
5885 \def\shortpartentry#1#2#3#4{%
5887 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
5888 \shortchapentry{#1}{\numeralbox}{}{}%
5891 % Chapters, in the main contents.
5892 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
5894 % Chapters, in the short toc.
5895 % See comments in \dochapentry re vbox and related settings.
5896 \def\shortchapentry#1#2#3#4{%
5897 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
5900 % Appendices, in the main contents.
5901 % Need the word Appendix, and a fixed-size box.
5903 \def\appendixbox#1{%
5904 % We use M since it's probably the widest letter.
5905 \setbox0 = \hbox{\putwordAppendix{} M}%
5906 \hbox to \wd0{\putwordAppendix{} #1\hss}}
5908 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
5910 % Unnumbered chapters.
5911 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
5912 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
5915 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
5916 \let\appsecentry=\numsecentry
5917 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
5920 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
5921 \let\appsubsecentry=\numsubsecentry
5922 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
5924 % And subsubsections.
5925 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
5926 \let\appsubsubsecentry=\numsubsubsecentry
5927 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
5929 % This parameter controls the indentation of the various levels.
5930 % Same as \defaultparindent.
5931 \newdimen\tocindent \tocindent = 15pt
5933 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
5936 % If the toc has to be broken over pages, we want it to be at chapters
5937 % if at all possible; hence the \penalty.
5938 \def\dochapentry#1#2{%
5939 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
5942 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5944 \nobreak\vskip .25\baselineskip plus.1\baselineskip
5947 \def\dosecentry#1#2{\begingroup
5948 \secentryfonts \leftskip=\tocindent
5949 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5952 \def\dosubsecentry#1#2{\begingroup
5953 \subsecentryfonts \leftskip=2\tocindent
5954 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5957 \def\dosubsubsecentry#1#2{\begingroup
5958 \subsubsecentryfonts \leftskip=3\tocindent
5959 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
5962 % We use the same \entry macro as for the index entries.
5963 \let\tocentry = \entry
5965 % Space between chapter (or whatever) number and the title.
5966 \def\labelspace{\hskip1em \relax}
5968 \def\dopageno#1{{\rm #1}}
5969 \def\doshortpageno#1{{\rm #1}}
5971 \def\chapentryfonts{\secfonts \rm}
5972 \def\secentryfonts{\textfonts}
5973 \def\subsecentryfonts{\textfonts}
5974 \def\subsubsecentryfonts{\textfonts}
5977 \message{environments,}
5978 % @foo ... @end foo.
5980 % @tex ... @end tex escapes into raw Tex temporarily.
5981 % One exception: @ is still an escape character, so that @end tex works.
5982 % But \@ or @@ will get a plain tex @ character.
5985 \setupmarkupstyle{tex}%
5986 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
5987 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
5988 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
5999 % ' is active in math mode (mathcode"8000). So reset it, and all our
6000 % other math active characters (just in case), to plain's definitions.
6004 \let\bullet=\ptexbullet
6009 \let\equiv=\ptexequiv
6012 \let\indent=\ptexindent
6013 \let\noindent=\ptexnoindent
6020 \expandafter \let\csname top\endcsname=\ptextop % outer
6021 \let\frenchspacing=\plainfrenchspacing
6023 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6024 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
6027 % There is no need to define \Etex.
6029 % Define @lisp ... @end lisp.
6030 % @lisp environment forms a group so it can rebind things,
6031 % including the definition of @end lisp (which normally is erroneous).
6033 % Amount to narrow the margins by for @lisp.
6034 \newskip\lispnarrowing \lispnarrowing=0.4in
6036 % This is the definition that ^^M gets inside @lisp, @example, and other
6037 % such environments. \null is better than a space, since it doesn't
6039 \def\lisppar{\null\endgraf}
6041 % This space is always present above and below environments.
6042 \newskip\envskipamount \envskipamount = 0pt
6044 % Make spacing and below environment symmetrical. We use \parskip here
6045 % to help in doing that, since in @example-like environments \parskip
6046 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6047 % start of the next paragraph will insert \parskip.
6049 \def\aboveenvbreak{{%
6050 % =10000 instead of <10000 because of a special case in \itemzzz and
6051 % \sectionheading, q.v.
6052 \ifnum \lastpenalty=10000 \else
6053 \advance\envskipamount by \parskip
6055 \ifdim\lastskip<\envskipamount
6057 % it's not a good place to break if the last penalty was \nobreak
6059 \ifnum\lastpenalty<10000 \penalty-50 \fi
6060 \vskip\envskipamount
6065 \let\afterenvbreak = \aboveenvbreak
6067 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6068 % also clear it, so that its embedded environments do the narrowing again.
6069 \let\nonarrowing=\relax
6071 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6072 % environment contents.
6073 \font\circle=lcircle10
6075 \newdimen\cartouter\newdimen\cartinner
6076 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6077 \circthick=\fontdimen8\circle
6079 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
6080 \def\ctr{{\hskip 6pt\circle\char'010}}
6081 \def\cbl{{\circle\char'012\hskip -6pt}}
6082 \def\cbr{{\hskip 6pt\circle\char'011}}
6083 \def\carttop{\hbox to \cartouter{\hskip\lskip
6084 \ctl\leaders\hrule height\circthick\hfil\ctr
6086 \def\cartbot{\hbox to \cartouter{\hskip\lskip
6087 \cbl\leaders\hrule height\circthick\hfil\cbr
6090 \newskip\lskip\newskip\rskip
6093 \ifhmode\par\fi % can't be in the midst of a paragraph.
6095 \lskip=\leftskip \rskip=\rightskip
6096 \leftskip=0pt\rightskip=0pt % we want these *outside*.
6097 \cartinner=\hsize \advance\cartinner by-\lskip
6098 \advance\cartinner by-\rskip
6100 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
6101 % side, and for 6pt waste from
6102 % each corner char, and rule thickness
6103 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
6104 % Flag to tell @lisp, etc., not to narrow margin.
6105 \let\nonarrowing = t%
6107 \baselineskip=0pt\parskip=0pt\lineskip=0pt
6115 \baselineskip=\normbskip
6116 \lineskip=\normlskip
6119 \comment % For explanation, see the end of \def\group.
6134 % This macro is called at the beginning of all the @example variants,
6136 \newdimen\nonfillparindent
6139 \hfuzz = 12pt % Don't be fussy
6140 \sepspaces % Make spaces be word-separators rather than space tokens.
6141 \let\par = \lisppar % don't ignore blank lines
6142 \obeylines % each line of input is a line of output
6144 % Turn off paragraph indentation but redefine \indent to emulate
6145 % the normal \indent.
6146 \nonfillparindent=\parindent
6148 \let\indent\nonfillindent
6150 \emergencystretch = 0pt % don't try to avoid overfull boxes
6151 \ifx\nonarrowing\relax
6152 \advance \leftskip by \lispnarrowing
6153 \exdentamount=\lispnarrowing
6155 \let\nonarrowing = \relax
6157 \let\exdent=\nofillexdent
6162 % We want to swallow spaces (but not other tokens) after the fake
6163 % @indent in our nonfill-environments, where spaces are normally
6164 % active and set to @tie, resulting in them not being ignored after
6166 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6167 \gdef\nonfillindentcheck{%
6169 \expandafter\nonfillindentgobble%
6171 \leavevmode\nonfillindentbox%
6175 \def\nonfillindentgobble#1{\nonfillindent}
6176 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
6178 % If you want all examples etc. small: @set dispenvsize small.
6179 % If you want even small examples the full size: @set dispenvsize nosmall.
6180 % This affects the following displayed environments:
6181 % @example, @display, @format, @lisp
6183 \def\smallword{small}
6184 \def\nosmallword{nosmall}
6185 \let\SETdispenvsize\relax
6186 \def\setnormaldispenv{%
6187 \ifx\SETdispenvsize\smallword
6188 % end paragraph for sake of leading, in case document has no blank
6189 % line. This is redundant with what happens in \aboveenvbreak, but
6190 % we need to do it before changing the fonts, and it's inconvenient
6191 % to change the fonts afterward.
6192 \ifnum \lastpenalty=10000 \else \endgraf \fi
6193 \smallexamplefonts \rm
6196 \def\setsmalldispenv{%
6197 \ifx\SETdispenvsize\nosmallword
6199 \ifnum \lastpenalty=10000 \else \endgraf \fi
6200 \smallexamplefonts \rm
6204 % We often define two environments, @foo and @smallfoo.
6205 % Let's do it by one command:
6206 \def\makedispenv #1#2{
6207 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}
6208 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}
6209 \expandafter\let\csname E#1\endcsname \afterenvbreak
6210 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
6213 % Define two synonyms:
6214 \def\maketwodispenvs #1#2#3{
6215 \makedispenv{#1}{#3}
6216 \makedispenv{#2}{#3}
6219 % @lisp: indented, narrowed, typewriter font; @example: same as @lisp.
6221 % @smallexample and @smalllisp: use smaller fonts.
6222 % Originally contributed by Pavel@xerox.
6224 \maketwodispenvs {lisp}{example}{%
6226 \tt\setupmarkupstyle{example}%
6227 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
6228 \gobble % eat return
6230 % @display/@smalldisplay: same as @lisp except keep current font.
6232 \makedispenv {display}{%
6237 % @format/@smallformat: same as @display except don't narrow margins.
6239 \makedispenv{format}{%
6240 \let\nonarrowing = t%
6245 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6247 \let\nonarrowing = t%
6251 \let\Eflushleft = \afterenvbreak
6255 \envdef\flushright{%
6256 \let\nonarrowing = t%
6258 \advance\leftskip by 0pt plus 1fill\relax
6261 \let\Eflushright = \afterenvbreak
6264 % @raggedright does more-or-less normal line breaking but no right
6265 % justification. From plain.tex.
6266 \envdef\raggedright{%
6267 \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax
6269 \let\Eraggedright\par
6271 \envdef\raggedleft{%
6272 \parindent=0pt \leftskip0pt plus2em
6273 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6274 \hbadness=10000 % Last line will usually be underfull, so turn off
6275 % badness reporting.
6277 \let\Eraggedleft\par
6279 \envdef\raggedcenter{%
6280 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
6281 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
6282 \hbadness=10000 % Last line will usually be underfull, so turn off
6283 % badness reporting.
6285 \let\Eraggedcenter\par
6288 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6289 % and narrows the margins. We keep \parskip nonzero in general, since
6290 % we're doing normal filling. So, when using \aboveenvbreak and
6291 % \afterenvbreak, temporarily make \parskip 0.
6293 \def\quotationstart{%
6294 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
6297 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6298 \ifx\nonarrowing\relax
6299 \advance\leftskip by \lispnarrowing
6300 \advance\rightskip by \lispnarrowing
6301 \exdentamount = \lispnarrowing
6303 \let\nonarrowing = \relax
6305 \parsearg\quotationlabel
6313 \envdef\smallquotation{%
6317 \let\Esmallquotation = \Equotation
6319 % We have retained a nonzero parskip for the environment, since we're
6320 % doing normal filling.
6324 \ifx\quotationauthor\undefined\else
6326 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
6328 {\parskip=0pt \afterenvbreak}%
6331 % If we're given an argument, typeset it in bold with a colon after.
6332 \def\quotationlabel#1{%
6334 \ifx\temp\empty \else
6340 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6341 % If we want to allow any <char> as delimiter,
6342 % we need the curly braces so that makeinfo sees the @verb command, eg:
6343 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6345 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6347 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6348 % active too. Otherwise, they get lost as the first character on a
6351 \do\ \do\\\do\{\do\}\do\$\do\&%
6352 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
6353 \do\<\do\>\do\|\do\@\do+\do\"%
6354 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6355 % @set txicodequotebacktick will not have effect on @verb and
6356 % @verbatim, and ?` and !` ligatures won't get disabled.
6361 \def\uncatcodespecials{%
6362 \def\do##1{\catcode`##1=\other}\dospecials}
6364 % Setup for the @verb command.
6366 % Eight spaces for a tab
6368 \catcode`\^^I=\active
6369 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
6373 \tt % easiest (and conventionally used) font for verbatim
6374 \def\par{\leavevmode\endgraf}%
6375 \setupmarkupstyle{verb}%
6377 % Respect line breaks,
6378 % print special symbols as themselves, and
6379 % make each space count
6380 % must do in this order:
6381 \obeylines \uncatcodespecials \sepspaces
6384 % Setup for the @verbatim environment
6386 % Real tab expansion
6387 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
6389 \def\starttabbox{\setbox0=\hbox\bgroup}
6392 \catcode`\^^I=\active
6394 \catcode`\^^I=\active
6395 \def^^I{\leavevmode\egroup
6396 \dimen0=\wd0 % the width so far, or since the previous tab
6397 \divide\dimen0 by\tabw
6398 \multiply\dimen0 by\tabw % compute previous multiple of \tabw
6399 \advance\dimen0 by\tabw % advance to next multiple of \tabw
6400 \wd0=\dimen0 \box0 \starttabbox
6405 % start the verbatim environment.
6406 \def\setupverbatim{%
6407 \let\nonarrowing = t%
6409 % Easiest (and conventionally used) font for verbatim
6411 \def\par{\leavevmode\egroup\box0\endgraf}%
6413 \setupmarkupstyle{verbatim}%
6414 % Respect line breaks,
6415 % print special symbols as themselves, and
6416 % make each space count
6417 % must do in this order:
6418 \obeylines \uncatcodespecials \sepspaces
6419 \everypar{\starttabbox}%
6422 % Do the @verb magic: verbatim text is quoted by unique
6423 % delimiter characters. Before first delimiter expect a
6424 % right brace, after last delimiter expect closing brace:
6426 % \def\doverb'{'<char>#1<char>'}'{#1}
6428 % [Knuth] p. 382; only eat outer {}
6430 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
6431 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
6434 \def\verb{\begingroup\setupverb\doverb}
6437 % Do the @verbatim magic: define the macro \doverbatim so that
6438 % the (first) argument ends when '@end verbatim' is reached, ie:
6440 % \def\doverbatim#1@end verbatim{#1}
6442 % For Texinfo it's a lot easier than for LaTeX,
6443 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6444 % we need not redefine '\', '{' and '}'.
6446 % Inspired by LaTeX's verbatim command set [latex.ltx]
6451 % ignore everything up to the first ^^M, that's the newline at the end
6452 % of the @verbatim input line itself. Otherwise we get an extra blank
6453 % line in the output.
6454 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
6455 % We really want {...\end verbatim} in the body of the macro, but
6456 % without the active space; thus we have to use \xdef and \gobble.
6460 \setupverbatim\doverbatim
6462 \let\Everbatim = \afterenvbreak
6465 % @verbatiminclude FILE - insert text of file in verbatim environment.
6467 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6469 \def\doverbatiminclude#1{%
6471 \makevalueexpandable
6473 \indexnofonts % Allow `@@' and other weird things in file names.
6479 % @copying ... @end copying.
6480 % Save the text away for @insertcopying later.
6482 % We save the uninterpreted tokens, rather than creating a box.
6483 % Saving the text in a box would be much easier, but then all the
6484 % typesetting commands (@smallbook, font changes, etc.) have to be done
6485 % beforehand -- and a) we want @copying to be done first in the source
6486 % file; b) letting users define the frontmatter in as flexible order as
6487 % possible is very desirable.
6489 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6490 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
6492 \def\insertcopying{%
6494 \parindent = 0pt % paragraph indentation looks wrong on title page
6495 \scanexp\copyingtext
6503 \newskip\defbodyindent \defbodyindent=.4in
6504 \newskip\defargsindent \defargsindent=50pt
6505 \newskip\deflastargmargin \deflastargmargin=18pt
6506 \newcount\defunpenalty
6508 % Start the processing of @deffn:
6510 \ifnum\lastpenalty<10000
6512 \defunpenalty=10003 % Will keep this @deffn together with the
6513 % following @def command, see below.
6515 % If there are two @def commands in a row, we'll have a \nobreak,
6516 % which is there to keep the function description together with its
6517 % header. But if there's nothing but headers, we need to allow a
6518 % break somewhere. Check specifically for penalty 10002, inserted
6519 % by \printdefunline, instead of 10000, since the sectioning
6520 % commands also insert a nobreak penalty, and we don't want to allow
6521 % a break between a section heading and a defun.
6523 % As a minor refinement, we avoid "club" headers by signalling
6524 % with penalty of 10003 after the very first @deffn in the
6525 % sequence (see above), and penalty of 10002 after any following
6527 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
6529 % Similarly, after a section heading, do not allow a break.
6530 % But do insert the glue.
6531 \medskip % preceded by discardable penalty, so not a breakpoint
6535 \advance\leftskip by \defbodyindent
6536 \exdentamount=\defbodyindent
6540 % First, check whether we are in the right environment:
6543 % As above, allow line break if we have multiple x headers in a row.
6544 % It's not a great place, though.
6545 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
6547 % And now, it's time to reuse the body of the original defun:
6548 \expandafter\gobbledefun#1%
6550 \def\gobbledefun#1\startdefun{}
6552 % \printdefunline \deffnheader{text}
6554 \def\printdefunline#1#2{%
6556 % call \deffnheader:
6559 \interlinepenalty = 10000
6560 \advance\rightskip by 0pt plus 1fil\relax
6562 \nobreak\vskip -\parskip
6563 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6564 % Some of the @defun-type tags do not enable magic parentheses,
6565 % rendering the following check redundant. But we don't optimize.
6570 \def\Edefun{\endgraf\medbreak}
6572 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6573 % the only thing remaining is to define \deffnheader.
6576 \expandafter\let\csname E#1\endcsname = \Edefun
6577 \edef\temp{\noexpand\domakedefun
6578 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
6582 % \domakedefun \deffn \deffnx \deffnheader
6584 % Define \deffn and \deffnx, without parameters.
6585 % \deffnheader has to be defined explicitly.
6587 \def\domakedefun#1#2#3{%
6590 \parseargusing\activeparens{\printdefunline#3}%
6592 \def#2{\dodefunx#1}%
6596 %%% Untyped functions:
6598 % @deffn category name args
6599 \makedefun{deffn}{\deffngeneral{}}
6601 % @deffn category class name args
6602 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
6604 % \defopon {category on}class name args
6605 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6607 % \deffngeneral {subind}category name args
6609 \def\deffngeneral#1#2 #3 #4\endheader{%
6610 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
6611 \dosubind{fn}{\code{#3}}{#1}%
6612 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
6615 %%% Typed functions:
6617 % @deftypefn category type name args
6618 \makedefun{deftypefn}{\deftypefngeneral{}}
6620 % @deftypeop category class type name args
6621 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
6623 % \deftypeopon {category on}class type name args
6624 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
6626 % \deftypefngeneral {subind}category type name args
6628 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
6629 \dosubind{fn}{\code{#4}}{#1}%
6630 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6633 %%% Typed variables:
6635 % @deftypevr category type var args
6636 \makedefun{deftypevr}{\deftypecvgeneral{}}
6638 % @deftypecv category class type var args
6639 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
6641 % \deftypecvof {category of}class type var args
6642 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
6644 % \deftypecvgeneral {subind}category type var args
6646 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
6647 \dosubind{vr}{\code{#4}}{#1}%
6648 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
6651 %%% Untyped variables:
6653 % @defvr category var args
6654 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
6656 % @defcv category class var args
6657 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
6659 % \defcvof {category of}class var args
6660 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
6663 % @deftp category name args
6664 \makedefun{deftp}#1 #2 #3\endheader{%
6665 \doind{tp}{\code{#2}}%
6666 \defname{#1}{}{#2}\defunargs{#3\unskip}%
6669 % Remaining @defun-like shortcuts:
6670 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
6671 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
6672 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
6673 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
6674 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
6675 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
6676 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
6677 \makedefun{defmethod}{\defopon\putwordMethodon}
6678 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
6679 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
6680 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
6682 % \defname, which formats the name of the @def (not the args).
6683 % #1 is the category, such as "Function".
6684 % #2 is the return type, if any.
6685 % #3 is the function name.
6687 % We are followed by (but not passed) the arguments, if any.
6689 \def\defname#1#2#3{%
6690 % Get the values of \leftskip and \rightskip as they were outside the @def...
6691 \advance\leftskip by -\defbodyindent
6693 % How we'll format the type name. Putting it in brackets helps
6694 % distinguish it from the body text that may end up on the next line
6697 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
6699 % Figure out line sizes for the paragraph shape.
6700 % The first line needs space for \box0; but if \rightskip is nonzero,
6701 % we need only space for the part of \box0 which exceeds it:
6702 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
6703 % The continuations:
6704 \dimen2=\hsize \advance\dimen2 by -\defargsindent
6705 % (plain.tex says that \dimen1 should be used only as global.)
6706 \parshape 2 0in \dimen0 \defargsindent \dimen2
6708 % Put the type name to the right margin.
6711 \hfil\box0 \kern-\hsize
6712 % \hsize has to be shortened this way:
6714 % Intentionally do not respect \rightskip, since we need the space.
6717 % Allow all lines to be underfull without complaint:
6718 \tolerance=10000 \hbadness=10000
6719 \exdentamount=\defbodyindent
6721 % defun fonts. We use typewriter by default (used to be bold) because:
6722 % . we're printing identifiers, they should be in tt in principle.
6723 % . in languages with many accents, such as Czech or French, it's
6724 % common to leave accents off identifiers. The result looks ok in
6725 % tt, but exceedingly strange in rm.
6726 % . we don't want -- and --- to be treated as ligatures.
6727 % . this still does not fix the ?` and !` ligatures, but so far no
6728 % one has made identifiers using them :).
6730 \def\temp{#2}% return value type
6731 \ifx\temp\empty\else \tclose{\temp} \fi
6732 #3% output function name
6734 {\rm\enskip}% hskip 0.5 em of \tenrm
6737 % arguments will be output next, if any.
6740 % Print arguments in slanted roman (not ttsl), inconsistently with using
6741 % tt for the name. This is because literal text is sometimes needed in
6742 % the argument list (groff manual), and ttsl and tt are not very
6743 % distinguishable. Prevent hyphenation at `-' chars.
6746 % use sl by default (not ttsl),
6748 \df \sl \hyphenchar\font=0
6750 % On the other hand, if an argument has two dashes (for instance), we
6751 % want a way to get ttsl. Let's try @var for that.
6752 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
6754 \sl\hyphenchar\font=45
6757 % We want ()&[] to print specially on the defun line.
6760 \catcode`\(=\active \catcode`\)=\active
6761 \catcode`\[=\active \catcode`\]=\active
6765 % Make control sequences which act like normal parenthesis chars.
6766 \let\lparen = ( \let\rparen = )
6768 % Be sure that we always have a definition for `(', etc. For example,
6769 % if the fn name has parens in it, \boldbrax will not be in effect yet,
6770 % so TeX would otherwise complain about undefined control sequence.
6773 \global\let(=\lparen \global\let)=\rparen
6774 \global\let[=\lbrack \global\let]=\rbrack
6777 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
6778 \gdef\magicamp{\let&=\amprm}
6781 \newcount\parencount
6783 % If we encounter &foo, then turn on ()-hacking afterwards
6785 \def\amprm#1 {\ampseentrue{\bf\ }}
6789 % At the first level, print parens in roman,
6790 % otherwise use the default font.
6791 \ifnum \parencount=1 \rm \fi
6793 % The \sf parens (in \boldbrax) actually are a little bolder than
6794 % the contained text. This is especially needed for [ and ] .
6798 \def\infirstlevel#1{%
6805 \def\bfafterword#1 {#1 \bf}
6808 \global\advance\parencount by 1
6810 \infirstlevel \bfafterword
6815 \global\advance\parencount by -1
6818 \newcount\brackcount
6820 \global\advance\brackcount by 1
6825 \global\advance\brackcount by -1
6828 \def\checkparencounts{%
6829 \ifnum\parencount=0 \else \badparencount \fi
6830 \ifnum\brackcount=0 \else \badbrackcount \fi
6832 % these should not use \errmessage; the glibc manual, at least, actually
6833 % has such constructs (when documenting function pointers).
6834 \def\badparencount{%
6835 \message{Warning: unbalanced parentheses in @def...}%
6836 \global\parencount=0
6838 \def\badbrackcount{%
6839 \message{Warning: unbalanced square brackets in @def...}%
6840 \global\brackcount=0
6847 % To do this right we need a feature of e-TeX, \scantokens,
6848 % which we arrange to emulate with a temporary file in ordinary TeX.
6849 \ifx\eTeXversion\undefined
6850 \newwrite\macscribble
6853 \immediate\openout\macscribble=\jobname.tmp
6854 \immediate\write\macscribble{\the\toks0}%
6855 \immediate\closeout\macscribble
6863 \let\xeatspaces\eatspaces
6864 % Undo catcode changes of \startcontents and \doprintindex
6865 % When called from @insertcopying or (short)caption, we need active
6866 % backslash to get it printed correctly. Previously, we had
6867 % \catcode`\\=\other instead. We'll see whether a problem appears
6868 % with macro expansion. --kasal, 19aug04
6869 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@
6873 % Append \endinput to make sure that TeX does not see the ending newline.
6874 % I've verified that it is necessary both for e-TeX and for ordinary TeX
6876 \scantokens{#1\endinput}%
6881 \edef\temp{\noexpand\scanmacro{#1}}%
6885 \newcount\paramno % Count of parameters
6886 \newtoks\macname % Macro name
6887 \newif\ifrecursive % Is it recursive?
6889 % List of all defined macros in the form
6890 % \definedummyword\macro1\definedummyword\macro2...
6891 % Currently is also contains all @aliases; the list can be split
6892 % if there is a need.
6895 % Add the macro to \macrolist
6896 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
6897 \def\addtomacrolistxxx#1{%
6898 \toks0 = \expandafter{\macrolist\definedummyword#1}%
6899 \xdef\macrolist{\the\toks0}%
6903 % This does \let #1 = #2, with \csnames; that is,
6904 % \let \csname#1\endcsname = \csname#2\endcsname
6905 % (except of course we have to play expansion games).
6909 \csname#1\expandafter\endcsname
6913 % Trim leading and trailing spaces off a string.
6914 % Concepts from aro-bend problem 15 (see CTAN).
6916 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
6917 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
6918 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
6920 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
6923 % Trim a single trailing ^^M off a string.
6924 {\catcode`\^^M=\other \catcode`\Q=3%
6925 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
6926 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
6927 \gdef\eatcrb#1Q#2Q{#1}%
6930 % Macro bodies are absorbed as an argument in a context where
6931 % all characters are catcode 10, 11 or 12, except \ which is active
6932 % (as in normal texinfo). It is necessary to change the definition of \.
6934 % Non-ASCII encodings make 8-bit characters active, so un-activate
6935 % them to avoid their expansion. Must do this non-globally, to
6936 % confine the change to the current group.
6938 % It's necessary to have hard CRs when the macro is executed. This is
6939 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
6940 % body, and then making it the \newlinechar in \scanmacro.
6952 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
6958 \catcode`\^^M=\other
6961 \def\macrobodyctxt{%
6965 \catcode`\^^M=\other
6974 % \mbodybackslash is the definition of \ in @macro bodies.
6975 % It maps \foo\ => \csname macarg.foo\endcsname => #N
6976 % where N is the macro parameter number.
6977 % We define \csname macarg.\endcsname to be \realbackslash, so
6978 % \\ in macro replacement text gets you a backslash.
6980 {\catcode`@=0 @catcode`@\=@active
6981 @gdef@usembodybackslash{@let\=@mbodybackslash}
6982 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
6984 \expandafter\def\csname macarg.\endcsname{\realbackslash}
6986 \def\macro{\recursivefalse\parsearg\macroxxx}
6987 \def\rmacro{\recursivetrue\parsearg\macroxxx}
6990 \getargs{#1}% now \macname is the macname and \argl the arglist
6991 \ifx\argl\empty % no arguments
6994 \expandafter\parsemargdef \argl;%
6996 \if1\csname ismacro.\the\macname\endcsname
6997 \message{Warning: redefining \the\macname}%
6999 \expandafter\ifx\csname \the\macname\endcsname \relax
7000 \else \errmessage{Macro name \the\macname\space already defined}\fi
7001 \global\cslet{macsave.\the\macname}{\the\macname}%
7002 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
7003 \addtomacrolist{\the\macname}%
7005 \begingroup \macrobodyctxt
7006 \ifrecursive \expandafter\parsermacbody
7007 \else \expandafter\parsemacbody
7010 \parseargdef\unmacro{%
7011 \if1\csname ismacro.#1\endcsname
7012 \global\cslet{#1}{macsave.#1}%
7013 \global\expandafter\let \csname ismacro.#1\endcsname=0%
7014 % Remove the macro name from \macrolist:
7016 \expandafter\let\csname#1\endcsname \relax
7017 \let\definedummyword\unmacrodo
7018 \xdef\macrolist{\macrolist}%
7021 \errmessage{Macro #1 not defined}%
7025 % Called by \do from \dounmacro on each macro. The idea is to omit any
7026 % macro definitions that have been changed to \relax.
7032 \noexpand\definedummyword \noexpand#1%
7036 % This makes use of the obscure feature that if the last token of a
7037 % <parameter list> is #, then the preceding argument is delimited by
7038 % an opening brace, and that opening brace is not consumed.
7039 \def\getargs#1{\getargsxxx#1{}}
7040 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
7041 \def\getmacname #1 #2\relax{\macname={#1}}
7042 \def\getmacargs#1{\def\argl{#1}}
7044 % Parse the optional {params} list. Set up \paramno and \paramlist
7045 % so \defmacro knows what to do. Define \macarg.blah for each blah
7046 % in the params list, to be ##N where N is the position in that list.
7047 % That gets used by \mbodybackslash (above).
7049 % We need to get `macro parameter char #' into several definitions.
7050 % The technique used is stolen from LaTeX: let \hash be something
7051 % unexpandable, insert that wherever you need a #, and then redefine
7052 % it to # just before using the token list produced.
7054 % The same technique is used to protect \eatspaces till just before
7055 % the macro is used.
7057 \def\parsemargdef#1;{\paramno=0\def\paramlist{}%
7058 \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,}
7059 \def\parsemargdefxxx#1,{%
7060 \if#1;\let\next=\relax
7061 \else \let\next=\parsemargdefxxx
7062 \advance\paramno by 1%
7063 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
7064 {\xeatspaces{\hash\the\paramno}}%
7065 \edef\paramlist{\paramlist\hash\the\paramno,}%
7068 % These two commands read recursive and nonrecursive macro bodies.
7069 % (They're different since rec and nonrec macros end differently.)
7071 \long\def\parsemacbody#1@end macro%
7072 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7073 \long\def\parsermacbody#1@end rmacro%
7074 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7076 % This defines the macro itself. There are six cases: recursive and
7077 % nonrecursive macros of zero, one, and many arguments.
7078 % Much magic with \expandafter here.
7079 % \xdef is used so that macro definitions will survive the file
7080 % they're defined in; @include reads the file inside a group.
7082 \let\hash=##% convert placeholders to macro parameter chars
7086 \expandafter\xdef\csname\the\macname\endcsname{%
7087 \noexpand\scanmacro{\temp}}%
7089 \expandafter\xdef\csname\the\macname\endcsname{%
7090 \bgroup\noexpand\macroargctxt
7091 \noexpand\braceorline
7092 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7093 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7094 \egroup\noexpand\scanmacro{\temp}}%
7096 \expandafter\xdef\csname\the\macname\endcsname{%
7097 \bgroup\noexpand\macroargctxt
7098 \noexpand\csname\the\macname xx\endcsname}%
7099 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7100 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7101 \expandafter\expandafter
7103 \expandafter\expandafter
7104 \csname\the\macname xxx\endcsname
7105 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7110 \expandafter\xdef\csname\the\macname\endcsname{%
7111 \noexpand\norecurse{\the\macname}%
7112 \noexpand\scanmacro{\temp}\egroup}%
7114 \expandafter\xdef\csname\the\macname\endcsname{%
7115 \bgroup\noexpand\macroargctxt
7116 \noexpand\braceorline
7117 \expandafter\noexpand\csname\the\macname xxx\endcsname}%
7118 \expandafter\xdef\csname\the\macname xxx\endcsname##1{%
7120 \noexpand\norecurse{\the\macname}%
7121 \noexpand\scanmacro{\temp}\egroup}%
7123 \expandafter\xdef\csname\the\macname\endcsname{%
7124 \bgroup\noexpand\macroargctxt
7125 \expandafter\noexpand\csname\the\macname xx\endcsname}%
7126 \expandafter\xdef\csname\the\macname xx\endcsname##1{%
7127 \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}%
7128 \expandafter\expandafter
7130 \expandafter\expandafter
7131 \csname\the\macname xxx\endcsname
7134 \noexpand\norecurse{\the\macname}%
7135 \noexpand\scanmacro{\temp}\egroup}%
7139 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
7141 % \braceorline decides whether the next nonwhitespace character is a
7142 % {. If so it reads up to the closing }, if not, it reads the whole
7143 % line. Whatever was read is then fed to the next control sequence
7144 % as an argument (by \parsebrace or \parsearg)
7145 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
7146 \def\braceorlinexxx{%
7147 \ifx\nchar\bgroup\else
7148 \expandafter\parsearg
7153 % We need some trickery to remove the optional spaces around the equal
7154 % sign. Just make them active and then expand them all to nothing.
7155 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7156 \def\aliasxxx #1{\aliasyyy#1\relax}
7157 \def\aliasyyy #1=#2\relax{%
7159 \expandafter\let\obeyedspace=\empty
7160 \addtomacrolist{#1}%
7161 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
7167 \message{cross references,}
7170 \newif\ifhavexrefs % True if xref values are known.
7171 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7173 % @inforef is relatively simple.
7174 \def\inforef #1{\inforefzzz #1,,,,**}
7175 \def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7176 node \samp{\ignorespaces#1{}}}
7178 % @node's only job in TeX is to define \lastnode, which is used in
7179 % cross-references. The @node line might or might not have commas, and
7180 % might or might not have spaces before the first comma, like:
7181 % @node foo , bar , ...
7182 % We don't want such trailing spaces in the node name.
7184 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
7186 % also remove a trailing comma, in case of something like this:
7187 % @node Help-Cross, , , Cross-refs
7188 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
7189 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}}
7192 \let\lastnode=\empty
7194 % Write a cross-reference definition for the current node. #1 is the
7195 % type (Ynumbered, Yappendix, Ynothing).
7198 \ifx\lastnode\empty\else
7199 \setref{\lastnode}{#1}%
7200 \global\let\lastnode=\empty
7204 % @anchor{NAME} -- define xref target at arbitrary point.
7206 \newcount\savesfregister
7208 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
7209 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
7210 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
7212 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7213 % anchor), which consists of three parts:
7214 % 1) NAME-title - the current sectioning name taken from \lastsection,
7215 % or the anchor name.
7216 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7217 % empty for anchors.
7218 % 3) NAME-pg - the page number.
7220 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7221 % floats, there is an additional part, which is not written here:
7222 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7228 \atdummies % preserve commands, but don't expand them
7229 \edef\writexrdef##1##2{%
7230 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
7231 ##1}{##2}}% these are parameters of \writexrdef
7233 \toks0 = \expandafter{\lastsection}%
7234 \immediate \writexrdef{title}{\the\toks0 }%
7235 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
7236 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout
7241 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7242 % the node name, #2 the name of the Info cross-reference, #3 the printed
7243 % node name, #4 the name of the Info file, #5 the name of the printed
7244 % manual. All but the node name can be omitted.
7246 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]}
7247 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]}
7248 \def\ref#1{\xrefX[#1,,,,,,,]}
7249 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
7251 \def\printedmanual{\ignorespaces #5}%
7252 \def\printedrefname{\ignorespaces #3}%
7253 \setbox1=\hbox{\printedmanual\unskip}%
7254 \setbox0=\hbox{\printedrefname\unskip}%
7256 % No printed node name was explicitly given.
7257 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax
7258 % Use the node name inside the square brackets.
7259 \def\printedrefname{\ignorespaces #1}%
7261 % Use the actual chapter/section title appear inside
7262 % the square brackets. Use the real section title if we have it.
7264 % It is in another manual, so we don't have it.
7265 \def\printedrefname{\ignorespaces #1}%
7268 % We know the real title if we have the xref values.
7269 \def\printedrefname{\refx{#1-title}{}}%
7271 % Otherwise just copy the Info node name.
7272 \def\printedrefname{\ignorespaces #1}%
7278 % Make link in pdf output.
7282 % This expands tokens, so do it after making catcode changes, so _
7283 % etc. don't get their TeX definitions.
7286 % See comments at \activebackslashdouble.
7287 {\activebackslashdouble \xdef\pdfxrefdest{#1}%
7288 \backslashparens\pdfxrefdest}%
7291 \startlink attr{/Border [0 0 0]}%
7292 \ifnum\filenamelength>0
7293 goto file{\the\filename.pdf} name{\pdfxrefdest}%
7295 goto name{\pdfmkpgn{\pdfxrefdest}}%
7298 \setcolor{\linkcolor}%
7301 % Float references are printed completely differently: "Figure 1.2"
7302 % instead of "[somenode], p.3". We distinguish them by the
7303 % LABEL-title being set to a magic string.
7305 % Have to otherify everything special to allow the \csname to
7306 % include an _ in the xref name, etc.
7309 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
7310 \csname XR#1-title\endcsname
7312 \iffloat\Xthisreftitle
7313 % If the user specified the print name (third arg) to the ref,
7314 % print it instead of our usual "Figure 1.2".
7321 % if the user also gave the printed manual name (fifth arg), append
7324 \space \putwordin{} \cite{\printedmanual}%
7327 % node/anchor (non-float) references.
7329 % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not
7330 % insert empty discretionaries after hyphens, which means that it will
7331 % not find a line break at a hyphen in a node names. Since some manuals
7332 % are best written with fairly long node names, containing hyphens, this
7333 % is a loss. Therefore, we give the text of the node name again, so it
7334 % is as if TeX is seeing it for the first time.
7336 \putwordSection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}%
7338 % _ (for example) has to be the character _ for the purposes of the
7339 % control sequence corresponding to the node, but it has to expand
7340 % into the usual \leavevmode...\vrule stuff for purposes of
7341 % printing. So we \turnoffactive for the \refx-snt, back on for the
7342 % printing, back off for the \refx-pg.
7344 % Only output a following space if the -snt ref is nonempty; for
7345 % @unnumbered and @anchor, it won't be.
7346 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
7347 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
7349 % output the `[mynode]' via a macro so it can be overridden.
7350 \xrefprintnodename\printedrefname
7352 % But we always want a comma and a space:
7355 % output the `page 3'.
7356 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
7362 % This macro is called from \xrefX for the `[nodename]' part of xref
7363 % output. It's a separate macro only so it can be changed more easily,
7364 % since square brackets don't work well in some documents. Particularly
7365 % one that Bob is working on :).
7367 \def\xrefprintnodename#1{[#1]}
7369 % Things referred to by \setref.
7375 \putwordChapter@tie \the\chapno
7376 \else \ifnum\subsecno=0
7377 \putwordSection@tie \the\chapno.\the\secno
7378 \else \ifnum\subsubsecno=0
7379 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
7381 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
7386 \putwordAppendix@tie @char\the\appendixno{}%
7387 \else \ifnum\subsecno=0
7388 \putwordSection@tie @char\the\appendixno.\the\secno
7389 \else \ifnum\subsubsecno=0
7390 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
7393 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
7397 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
7398 % If its value is nonempty, SUFFIX is output afterward.
7404 \expandafter\global\expandafter\let\expandafter\thisrefX
7405 \csname XR#1\endcsname
7408 % If not defined, say something at least.
7409 \angleleft un\-de\-fined\angleright
7412 \message{\linenumber Undefined cross reference `#1'.}%
7415 \global\warnedxrefstrue
7416 \message{Cross reference values unknown; you must run TeX again.}%
7421 % It's defined, so just use it.
7424 #2% Output the suffix in any case.
7427 % This is the macro invoked by entries in the aux file. Usually it's
7428 % just a \def (we prepend XR to the control sequence name to avoid
7429 % collisions). But if this is a float type, we have more work to do.
7432 {% The node name might contain 8-bit characters, which in our current
7433 % implementation are changed to commands like @'e. Don't let these
7434 % mess up the control sequence name.
7437 \xdef\safexrefname{#1}%
7440 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref
7442 % Was that xref control sequence that we just defined for a float?
7443 \expandafter\iffloat\csname XR\safexrefname\endcsname
7444 % it was a float, and we have the (safe) float type in \iffloattype.
7445 \expandafter\let\expandafter\floatlist
7446 \csname floatlist\iffloattype\endcsname
7448 % Is this the first time we've seen this float type?
7449 \expandafter\ifx\floatlist\relax
7450 \toks0 = {\do}% yes, so just \do
7452 % had it before, so preserve previous elements in list.
7453 \toks0 = \expandafter{\floatlist\do}%
7456 % Remember this xref in the control sequence \floatlistFLOATTYPE,
7457 % for later use in \listoffloats.
7458 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
7463 % Read the last existing aux file, if any. No error if none exists.
7466 \openin 1 \jobname.aux
7469 \global\havexrefstrue
7474 \def\setupdatafile{%
7475 \catcode`\^^@=\other
7476 \catcode`\^^A=\other
7477 \catcode`\^^B=\other
7478 \catcode`\^^C=\other
7479 \catcode`\^^D=\other
7480 \catcode`\^^E=\other
7481 \catcode`\^^F=\other
7482 \catcode`\^^G=\other
7483 \catcode`\^^H=\other
7484 \catcode`\^^K=\other
7485 \catcode`\^^L=\other
7486 \catcode`\^^N=\other
7487 \catcode`\^^P=\other
7488 \catcode`\^^Q=\other
7489 \catcode`\^^R=\other
7490 \catcode`\^^S=\other
7491 \catcode`\^^T=\other
7492 \catcode`\^^U=\other
7493 \catcode`\^^V=\other
7494 \catcode`\^^W=\other
7495 \catcode`\^^X=\other
7496 \catcode`\^^Z=\other
7497 \catcode`\^^[=\other
7498 \catcode`\^^\=\other
7499 \catcode`\^^]=\other
7500 \catcode`\^^^=\other
7501 \catcode`\^^_=\other
7502 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
7503 % in xref tags, i.e., node names. But since ^^e4 notation isn't
7504 % supported in the main text, it doesn't seem desirable. Furthermore,
7505 % that is not enough: for node names that actually contain a ^
7506 % character, we would end up writing a line like this: 'xrdef {'hat
7507 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
7508 % argument, and \hat is not an expandable control sequence. It could
7509 % all be worked out, but why? Either we support ^^ or we don't.
7511 % The other change necessary for this was to define \auxhat:
7512 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
7513 % and then to call \auxhat in \setq.
7517 % Special characters. Should be turned off anyway, but...
7530 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
7532 % This is to support \ in node names and titles, since the \
7533 % characters end up in a \csname. It's easier than
7534 % leaving it active and making its active definition an actual \
7535 % character. What I don't understand is why it works in the *value*
7536 % of the xrdef. Seems like it should be a catcode12 \, and that
7537 % should not typeset properly. But it works, so I'm moving on for
7538 % now. --karl, 15jan04.
7541 % Make the characters 128-255 be printing characters.
7545 \catcode\count1=\other
7546 \advance\count1 by 1
7547 \ifnum \count1<256 \loop \fi
7551 % @ is our escape character in .aux files, and we need braces.
7557 \def\readdatafile#1{%
7564 \message{insertions,}
7565 % including footnotes.
7567 \newcount \footnoteno
7569 % The trailing space in the following definition for supereject is
7570 % vital for proper filling; pages come out unaligned when you do a
7571 % pagealignmacro call if that space before the closing brace is
7572 % removed. (Generally, numeric constants should always be followed by a
7573 % space to prevent strange expansion errors.)
7574 \def\supereject{\par\penalty -20000\footnoteno =0 }
7576 % @footnotestyle is meaningful for info output only.
7577 \let\footnotestyle=\comment
7581 % Auto-number footnotes. Otherwise like plain.
7583 \let\indent=\ptexindent
7584 \let\noindent=\ptexnoindent
7585 \global\advance\footnoteno by \@ne
7586 \edef\thisfootno{$^{\the\footnoteno}$}%
7588 % In case the footnote comes at the end of a sentence, preserve the
7589 % extra spacing after we do the footnote number.
7591 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
7593 % Remove inadvertent blank space before typesetting the footnote number.
7599 % Don't bother with the trickery in plain.tex to not require the
7600 % footnote text as a parameter. Our footnotes don't need to be so general.
7602 % Oh yes, they do; otherwise, @ifset (and anything else that uses
7603 % \parseargline) fails inside footnotes because the tokens are fixed when
7604 % the footnote is read. --karl, 16nov96.
7607 \insert\footins\bgroup
7608 % We want to typeset this text as a normal paragraph, even if the
7609 % footnote reference occurs in (for example) a display environment.
7610 % So reset some parameters.
7612 \interlinepenalty\interfootnotelinepenalty
7613 \splittopskip\ht\strutbox % top baseline for broken footnotes
7614 \splitmaxdepth\dp\strutbox
7615 \floatingpenalty\@MM
7620 \parindent\defaultparindent
7624 % Because we use hanging indentation in footnotes, a @noindent appears
7625 % to exdent this text, so make it be a no-op. makeinfo does not use
7626 % hanging indentation so @noindent can still be needed within footnote
7627 % text after an @example or the like (not that this is good style).
7628 \let\noindent = \relax
7630 % Hang the footnote text off the number. Use \everypar in case the
7631 % footnote extends for more than one paragraph.
7632 \everypar = {\hang}%
7633 \textindent{\thisfootno}%
7635 % Don't crash into the line above the footnote text. Since this
7636 % expands into a box, it must come within the paragraph, lest it
7637 % provide a place where TeX can split the footnote.
7639 \futurelet\next\fo@t
7641 }%end \catcode `\@=11
7643 % In case a @footnote appears in a vbox, save the footnote text and create
7644 % the real \insert just after the vbox finished. Otherwise, the insertion
7646 % Similarly, if a @footnote appears inside an alignment, save the footnote
7647 % text to a box and make the \insert when a row of the table is finished.
7648 % And the same can be done for other insert classes. --kasal, 16nov03.
7650 % Replace the \insert primitive by a cheating macro.
7651 % Deeper inside, just make sure that the saved insertions are not spilled
7654 \def\startsavinginserts{%
7655 \ifx \insert\ptexinsert
7656 \let\insert\saveinsert
7658 \let\checkinserts\relax
7662 % This \insert replacement works for both \insert\footins{foo} and
7663 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
7666 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
7667 \afterassignment\next
7668 % swallow the left brace
7671 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
7672 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
7674 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
7676 \def\placesaveins#1{%
7677 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
7681 % eat @SAVE -- beware, all of them have catcode \other:
7683 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
7684 \gdef\gobblesave @SAVE{}
7688 \def\newsaveins #1{%
7689 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
7692 \def\newsaveinsX #1{%
7693 \csname newbox\endcsname #1%
7694 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
7699 \let\checkinserts\empty
7704 % @image. We use the macros from epsf.tex to support this.
7705 % If epsf.tex is not installed and @image is used, we complain.
7707 % Check for and read epsf.tex up front. If we read it only at @image
7708 % time, we might be inside a group, and then its definitions would get
7709 % undone and the next image would fail.
7710 \openin 1 = epsf.tex
7712 % Do not bother showing banner with epsf.tex v2.7k (available in
7713 % doc/epsf.tex and on ctan).
7714 \def\epsfannounce{\toks0 = }%
7719 % We will only complain once about lack of epsf.tex.
7720 \newif\ifwarnednoepsf
7721 \newhelp\noepsfhelp{epsf.tex must be installed for images to
7722 work. It is also included in the Texinfo distribution, or you can get
7723 it from ftp://tug.org/tex/epsf.tex.}
7726 \ifx\epsfbox\undefined
7727 \ifwarnednoepsf \else
7728 \errhelp = \noepsfhelp
7729 \errmessage{epsf.tex not found, images will be ignored}%
7730 \global\warnednoepsftrue
7733 \imagexxx #1,,,,,\finish
7737 % Arguments to @image:
7738 % #1 is (mandatory) image filename; we tack on .eps extension.
7739 % #2 is (optional) width, #3 is (optional) height.
7740 % #4 is (ignored optional) html alt text.
7741 % #5 is (ignored optional) extension.
7742 % #6 is just the usual extra ignored arg for parsing stuff.
7744 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
7745 \catcode`\^^M = 5 % in case we're inside an example
7746 \normalturnoffactive % allow _ et al. in names
7747 % If the image is by itself, center it.
7751 % Usually we'll have text after the image which will insert
7752 % \parskip glue, so insert it here too to equalize the space
7754 \nobreak\vskip\parskip
7758 % Leave vertical mode so that indentation from an enclosing
7759 % environment such as @quotation is respected. On the other hand, if
7760 % it's at the top level, we don't want the normal paragraph indentation.
7765 \dopdfimage{#1}{#2}{#3}%
7767 % \epsfbox itself resets \epsf?size at each figure.
7768 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
7769 \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
7773 \ifimagevmode \medskip \fi % space after the standalone image
7777 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
7778 % etc. We don't actually implement floating yet, we always include the
7779 % float "here". But it seemed the best name for the future.
7781 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
7783 % There may be a space before second and/or third parameter; delete it.
7784 \def\eatcommaspace#1, {#1,}
7786 % #1 is the optional FLOATTYPE, the text label for this float, typically
7787 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
7788 % this float will not be numbered and cannot be referred to.
7790 % #2 is the optional xref label. Also must be present for the float to
7793 % #3 is the optional positioning argument; for now, it is ignored. It
7794 % will somehow specify the positions allowed to float to (here, top, bottom).
7796 % We keep a separate counter for each FLOATTYPE, which we reset at each
7797 % chapter-level command.
7798 \let\resetallfloatnos=\empty
7800 \def\dofloat#1,#2,#3,#4\finish{%
7801 \let\thiscaption=\empty
7802 \let\thisshortcaption=\empty
7804 % don't lose footnotes inside @float.
7806 % BEWARE: when the floats start float, we have to issue warning whenever an
7807 % insert appears inside a float which could possibly float. --kasal, 26may04
7811 % We can't be used inside a paragraph.
7816 \def\floatlabel{#2}%
7817 \def\floatloc{#3}% we do nothing with this yet.
7819 \ifx\floattype\empty
7820 \let\safefloattype=\empty
7823 % the floattype might have accents or other special characters,
7824 % but we need to use it in a control sequence name.
7827 \xdef\safefloattype{\floattype}%
7831 % If label is given but no type, we handle that as the empty type.
7832 \ifx\floatlabel\empty \else
7833 % We want each FLOATTYPE to be numbered separately (Figure 1,
7834 % Table 1, Figure 2, ...). (And if no label, no number.)
7836 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
7837 \global\advance\floatno by 1
7840 % This magic value for \lastsection is output by \setref as the
7841 % XREFLABEL-title value. \xrefX uses it to distinguish float
7842 % labels (which have a completely different output format) from
7843 % node and anchor labels. And \xrdef uses it to construct the
7846 \edef\lastsection{\floatmagic=\safefloattype}%
7847 \setref{\floatlabel}{Yfloat}%
7851 % start with \parskip glue, I guess.
7854 % Don't suppress indentation if a float happens to start a section.
7855 \restorefirstparagraphindent
7858 % we have these possibilities:
7859 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
7860 % @float Foo,lbl & no caption: Foo 1.1
7861 % @float Foo & @caption{Cap}: Foo: Cap
7862 % @float Foo & no caption: Foo
7863 % @float ,lbl & Caption{Cap}: 1.1: Cap
7864 % @float ,lbl & no caption: 1.1
7865 % @float & @caption{Cap}: Cap
7866 % @float & no caption:
7869 \let\floatident = \empty
7871 % In all cases, if we have a float type, it comes first.
7872 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
7874 % If we have an xref label, the number comes next.
7875 \ifx\floatlabel\empty \else
7876 \ifx\floattype\empty \else % if also had float type, need tie first.
7877 \appendtomacro\floatident{\tie}%
7880 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
7883 % Start the printed caption with what we've constructed in
7884 % \floatident, but keep it separate; we need \floatident again.
7885 \let\captionline = \floatident
7887 \ifx\thiscaption\empty \else
7888 \ifx\floatident\empty \else
7889 \appendtomacro\captionline{: }% had ident, so need a colon between
7893 \appendtomacro\captionline{\scanexp\thiscaption}%
7896 % If we have anything to print, print it, with space before.
7897 % Eventually this needs to become an \insert.
7898 \ifx\captionline\empty \else
7902 % Space below caption.
7906 % If have an xref label, write the list of floats info. Do this
7907 % after the caption, to avoid chance of it being a breakpoint.
7908 \ifx\floatlabel\empty \else
7909 % Write the text that goes in the lof to the aux file as
7910 % \floatlabel-lof. Besides \floatident, we include the short
7911 % caption if specified, else the full caption if specified, else nothing.
7915 % since we read the caption text in the macro world, where ^^M
7916 % is turned into a normal character, we have to scan it back, so
7917 % we don't write the literal three characters "^^M" into the aux file.
7919 \xdef\noexpand\gtemp{%
7920 \ifx\thisshortcaption\empty
7927 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
7928 \ifx\gtemp\empty \else : \gtemp \fi}}%
7931 \egroup % end of \vtop
7933 % place the captured inserts
7935 % BEWARE: when the floats start floating, we have to issue warning
7936 % whenever an insert appears inside a float which could possibly
7937 % float. --kasal, 26may04
7942 % Append the tokens #2 to the definition of macro #1, not expanding either.
7944 \def\appendtomacro#1#2{%
7945 \expandafter\def\expandafter#1\expandafter{#1#2}%
7948 % @caption, @shortcaption
7950 \def\caption{\docaption\thiscaption}
7951 \def\shortcaption{\docaption\thisshortcaption}
7952 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
7953 \def\defcaption#1#2{\egroup \def#1{#2}}
7955 % The parameter is the control sequence identifying the counter we are
7956 % going to use. Create it if it doesn't exist and assign it to \floatno.
7959 % Haven't seen this figure type before.
7960 \csname newcount\endcsname #1%
7962 % Remember to reset this floatno at the next chap.
7963 \expandafter\gdef\expandafter\resetallfloatnos
7964 \expandafter{\resetallfloatnos #1=0 }%
7969 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
7970 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
7971 % first read the @float command.
7973 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
7975 % Magic string used for the XREFLABEL-title value, so \xrefX can
7976 % distinguish floats from other xref types.
7977 \def\floatmagic{!!float!!}
7979 % #1 is the control sequence we are passed; we expand into a conditional
7980 % which is true if #1 represents a float ref. That is, the magic
7981 % \lastsection value which we \setref above.
7983 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
7985 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
7986 % (safe) float type for this float. We set \iffloattype to #2.
7988 \def\doiffloat#1=#2=#3\finish{%
7990 \def\iffloattype{#2}%
7991 \ifx\temp\floatmagic
7994 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
7996 \parseargdef\listoffloats{%
7997 \def\floattype{#1}% floattype
7999 % the floattype might have accents or other special characters,
8000 % but we need to use it in a control sequence name.
8003 \xdef\safefloattype{\floattype}%
8006 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8007 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
8009 % if the user said @listoffloats foo but never @float foo.
8010 \message{\linenumber No `\safefloattype' floats to list.}%
8014 \leftskip=\tocindent % indent these entries like a toc
8015 \let\do=\listoffloatsdo
8016 \csname floatlist\safefloattype\endcsname
8021 % This is called on each entry in a list of floats. We're passed the
8022 % xref label, in the form LABEL-title, which is how we save it in the
8023 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8024 % has the text we're supposed to typeset here.
8026 % Figures without xref labels will not be included in the list (since
8027 % they won't appear in the aux file).
8029 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8030 \def\listoffloatsdoentry#1-title\finish{{%
8031 % Can't fully expand XR#1-lof because it can contain anything. Just
8032 % pass the control sequence. On the other hand, XR#1-pg is just the
8033 % page number, and we want to fully expand that so we can get a link
8035 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
8037 % use the same \entry macro we use to generate the TOC and index.
8038 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
8043 \message{localization,}
8045 % For single-language documents, @documentlanguage is usually given very
8046 % early, just after @documentencoding. Single argument is the language
8047 % (de) or locale (de_DE) abbreviation.
8050 \catcode`\_ = \active
8052 \parseargdef\documentlanguage{\begingroup
8053 \let_=\normalunderscore % normal _ character for filenames
8054 \tex % read txi-??.tex file in plain TeX.
8055 % Read the file by the name they passed if it exists.
8056 \openin 1 txi-#1.tex
8058 \documentlanguagetrywithoutunderscore{#1_\finish}%
8060 \globaldefs = 1 % everything in the txi-LL files needs to persist
8064 \endgroup % end raw TeX
8067 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8070 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
8071 \openin 1 txi-#1.tex
8073 \errhelp = \nolanghelp
8074 \errmessage{Cannot read language file txi-#1.tex}%
8076 \globaldefs = 1 % everything in the txi-LL files needs to persist
8081 }% end of special _ catcode
8083 \newhelp\nolanghelp{The given language definition file cannot be found or
8084 is empty. Maybe you need to install it? Putting it in the current
8085 directory should work if nowhere else does.}
8087 % This macro is called from txi-??.tex files; the first argument is the
8088 % \language name to set (without the "\lang@" prefix), the second and
8089 % third args are \{left,right}hyphenmin.
8091 % The language names to pass are determined when the format is built.
8092 % See the etex.log file created at that time, e.g.,
8093 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8095 % With TeX Live 2008, etex now includes hyphenation patterns for all
8096 % available languages. This means we can support hyphenation in
8097 % Texinfo, at least to some extent. (This still doesn't solve the
8098 % accented characters problem.)
8101 \def\txisetlanguage#1#2#3{%
8102 % do not set the language if the name is undefined in the current TeX.
8103 \expandafter\ifx\csname lang@#1\endcsname \relax
8104 \message{no patterns for #1}%
8106 \global\language = \csname lang@#1\endcsname
8108 % but there is no harm in adjusting the hyphenmin values regardless.
8109 \global\lefthyphenmin = #2\relax
8110 \global\righthyphenmin = #3\relax
8113 % Helpers for encodings.
8114 % Set the catcode of characters 128 through 255 to the specified number.
8116 \def\setnonasciicharscatcode#1{%
8118 \loop\ifnum\count255<256
8119 \global\catcode\count255=#1\relax
8120 \advance\count255 by 1
8124 \def\setnonasciicharscatcodenonglobal#1{%
8126 \loop\ifnum\count255<256
8127 \catcode\count255=#1\relax
8128 \advance\count255 by 1
8132 % @documentencoding sets the definition of non-ASCII characters
8133 % according to the specified encoding.
8135 \parseargdef\documentencoding{%
8136 % Encoding being declared for the document.
8137 \def\declaredencoding{\csname #1.enc\endcsname}%
8139 % Supported encodings: names converted to tokens in order to be able
8140 % to compare them with \ifx.
8141 \def\ascii{\csname US-ASCII.enc\endcsname}%
8142 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
8143 \def\latone{\csname ISO-8859-1.enc\endcsname}%
8144 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
8145 \def\utfeight{\csname UTF-8.enc\endcsname}%
8147 \ifx \declaredencoding \ascii
8150 \else \ifx \declaredencoding \lattwo
8151 \setnonasciicharscatcode\active
8154 \else \ifx \declaredencoding \latone
8155 \setnonasciicharscatcode\active
8158 \else \ifx \declaredencoding \latnine
8159 \setnonasciicharscatcode\active
8162 \else \ifx \declaredencoding \utfeight
8163 \setnonasciicharscatcode\active
8167 \message{Unknown document encoding #1, ignoring.}%
8176 % A message to be logged when using a character that isn't available
8177 % the default font encoding (OT1).
8179 \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}}
8181 % Take account of \c (plain) vs. \, (Texinfo) difference.
8182 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
8184 % First, make active non-ASCII characters in order for them to be
8185 % correctly categorized when TeX reads the replacement text of
8186 % macros containing the character definitions.
8187 \setnonasciicharscatcode\active
8189 % Latin1 (ISO-8859-1) character definitions.
8190 \def\latonechardefs{%
8192 \gdef^^a1{\exclamdown}
8193 \gdef^^a2{\missingcharmsg{CENT SIGN}}
8194 \gdef^^a3{{\pounds}}
8195 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8196 \gdef^^a5{\missingcharmsg{YEN SIGN}}
8197 \gdef^^a6{\missingcharmsg{BROKEN BAR}}
8200 \gdef^^a9{\copyright}
8202 \gdef^^ab{\guillemetleft}
8205 \gdef^^ae{\registeredsymbol}
8208 \gdef^^b0{\textdegree}
8217 \gdef^^b8{\cedilla\ }
8221 \gdef^^bb{\guilletright}
8222 \gdef^^bc{$1\over4$}
8223 \gdef^^bd{$1\over2$}
8224 \gdef^^be{$3\over4$}
8225 \gdef^^bf{\questiondown}
8232 \gdef^^c5{\ringaccent A}
8234 \gdef^^c7{\cedilla C}
8266 \gdef^^e5{\ringaccent a}
8268 \gdef^^e7{\cedilla c}
8273 \gdef^^ec{\`{\dotless i}}
8274 \gdef^^ed{\'{\dotless i}}
8275 \gdef^^ee{\^{\dotless i}}
8276 \gdef^^ef{\"{\dotless i}}
8296 % Latin9 (ISO-8859-15) encoding character definitions.
8297 \def\latninechardefs{%
8298 % Encoding is almost identical to Latin1.
8311 % Latin2 (ISO-8859-2) character definitions.
8312 \def\lattwochardefs{%
8314 \gdef^^a1{\ogonek{A}}
8317 \gdef^^a4{\missingcharmsg{CURRENCY SIGN}}
8323 \gdef^^aa{\cedilla S}
8328 \gdef^^af{\dotaccent Z}
8330 \gdef^^b0{\textdegree}
8331 \gdef^^b1{\ogonek{a}}
8332 \gdef^^b2{\ogonek{ }}
8338 \gdef^^b8{\cedilla\ }
8340 \gdef^^ba{\cedilla s}
8345 \gdef^^bf{\dotaccent z}
8354 \gdef^^c7{\cedilla C}
8357 \gdef^^ca{\ogonek{E}}
8373 \gdef^^d9{\ringaccent U}
8378 \gdef^^de{\cedilla T}
8388 \gdef^^e7{\cedilla c}
8391 \gdef^^ea{\ogonek{e}}
8407 \gdef^^f9{\ringaccent u}
8412 \gdef^^fe{\cedilla t}
8413 \gdef^^ff{\dotaccent{}}
8416 % UTF-8 character definitions.
8418 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
8419 % changes for Texinfo conventions. It is included here under the GPL by
8420 % permission from Frank Mittelbach and the LaTeX team.
8426 \gdef\UTFviiiTwoOctets#1#2{\expandafter
8427 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
8429 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
8430 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
8432 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
8433 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
8435 \gdef\UTFviiiDefined#1{%
8437 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
8448 \global\catcode\countUTFx\active
8449 \uccode`\~\countUTFx
8450 \uppercase\expandafter{\UTFviiiTmp}%
8451 \advance\countUTFx by 1
8452 \ifnum\countUTFx < \countUTFy
8453 \expandafter\UTFviiiLoop
8459 \xdef~{\noexpand\UTFviiiTwoOctets\string~}}
8465 \xdef~{\noexpand\UTFviiiThreeOctets\string~}}
8471 \xdef~{\noexpand\UTFviiiFourOctets\string~}}
8484 \gdef\DeclareUnicodeCharacter#1#2{%
8485 \countUTFz = "#1\relax
8486 \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
8489 \def\UTFviiiTwoOctets##1##2{%
8490 \csname u8:##1\string ##2\endcsname}%
8491 \def\UTFviiiThreeOctets##1##2##3{%
8492 \csname u8:##1\string ##2\string ##3\endcsname}%
8493 \def\UTFviiiFourOctets##1##2##3##4{%
8494 \csname u8:##1\string ##2\string ##3\string ##4\endcsname}%
8495 \expandafter\expandafter\expandafter\expandafter
8496 \expandafter\expandafter\expandafter
8497 \gdef\UTFviiiTmp{#2}%
8500 \gdef\parseXMLCharref{%
8501 \ifnum\countUTFz < "A0\relax
8502 \errhelp = \EMsimple
8503 \errmessage{Cannot define Unicode char value < 00A0}%
8504 \else\ifnum\countUTFz < "800\relax
8506 \parseUTFviiiB C\UTFviiiTwoOctets.,%
8507 \else\ifnum\countUTFz < "10000\relax
8510 \parseUTFviiiB E\UTFviiiThreeOctets.{,;}%
8515 \parseUTFviiiB F\UTFviiiFourOctets.{!,;}%
8519 \gdef\parseUTFviiiA#1{%
8520 \countUTFx = \countUTFz
8521 \divide\countUTFz by 64
8522 \countUTFy = \countUTFz
8523 \multiply\countUTFz by 64
8524 \advance\countUTFx by -\countUTFz
8525 \advance\countUTFx by 128
8526 \uccode `#1\countUTFx
8527 \countUTFz = \countUTFy}
8529 \gdef\parseUTFviiiB#1#2#3#4{%
8530 \advance\countUTFz by "#10\relax
8531 \uccode `#3\countUTFz
8532 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
8535 \def\utfeightchardefs{%
8536 \DeclareUnicodeCharacter{00A0}{\tie}
8537 \DeclareUnicodeCharacter{00A1}{\exclamdown}
8538 \DeclareUnicodeCharacter{00A3}{\pounds}
8539 \DeclareUnicodeCharacter{00A8}{\"{ }}
8540 \DeclareUnicodeCharacter{00A9}{\copyright}
8541 \DeclareUnicodeCharacter{00AA}{\ordf}
8542 \DeclareUnicodeCharacter{00AB}{\guillemetleft}
8543 \DeclareUnicodeCharacter{00AD}{\-}
8544 \DeclareUnicodeCharacter{00AE}{\registeredsymbol}
8545 \DeclareUnicodeCharacter{00AF}{\={ }}
8547 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}
8548 \DeclareUnicodeCharacter{00B4}{\'{ }}
8549 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}
8550 \DeclareUnicodeCharacter{00BA}{\ordm}
8551 \DeclareUnicodeCharacter{00BB}{\guillemetright}
8552 \DeclareUnicodeCharacter{00BF}{\questiondown}
8554 \DeclareUnicodeCharacter{00C0}{\`A}
8555 \DeclareUnicodeCharacter{00C1}{\'A}
8556 \DeclareUnicodeCharacter{00C2}{\^A}
8557 \DeclareUnicodeCharacter{00C3}{\~A}
8558 \DeclareUnicodeCharacter{00C4}{\"A}
8559 \DeclareUnicodeCharacter{00C5}{\AA}
8560 \DeclareUnicodeCharacter{00C6}{\AE}
8561 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}
8562 \DeclareUnicodeCharacter{00C8}{\`E}
8563 \DeclareUnicodeCharacter{00C9}{\'E}
8564 \DeclareUnicodeCharacter{00CA}{\^E}
8565 \DeclareUnicodeCharacter{00CB}{\"E}
8566 \DeclareUnicodeCharacter{00CC}{\`I}
8567 \DeclareUnicodeCharacter{00CD}{\'I}
8568 \DeclareUnicodeCharacter{00CE}{\^I}
8569 \DeclareUnicodeCharacter{00CF}{\"I}
8571 \DeclareUnicodeCharacter{00D0}{\DH}
8572 \DeclareUnicodeCharacter{00D1}{\~N}
8573 \DeclareUnicodeCharacter{00D2}{\`O}
8574 \DeclareUnicodeCharacter{00D3}{\'O}
8575 \DeclareUnicodeCharacter{00D4}{\^O}
8576 \DeclareUnicodeCharacter{00D5}{\~O}
8577 \DeclareUnicodeCharacter{00D6}{\"O}
8578 \DeclareUnicodeCharacter{00D8}{\O}
8579 \DeclareUnicodeCharacter{00D9}{\`U}
8580 \DeclareUnicodeCharacter{00DA}{\'U}
8581 \DeclareUnicodeCharacter{00DB}{\^U}
8582 \DeclareUnicodeCharacter{00DC}{\"U}
8583 \DeclareUnicodeCharacter{00DD}{\'Y}
8584 \DeclareUnicodeCharacter{00DE}{\TH}
8585 \DeclareUnicodeCharacter{00DF}{\ss}
8587 \DeclareUnicodeCharacter{00E0}{\`a}
8588 \DeclareUnicodeCharacter{00E1}{\'a}
8589 \DeclareUnicodeCharacter{00E2}{\^a}
8590 \DeclareUnicodeCharacter{00E3}{\~a}
8591 \DeclareUnicodeCharacter{00E4}{\"a}
8592 \DeclareUnicodeCharacter{00E5}{\aa}
8593 \DeclareUnicodeCharacter{00E6}{\ae}
8594 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}
8595 \DeclareUnicodeCharacter{00E8}{\`e}
8596 \DeclareUnicodeCharacter{00E9}{\'e}
8597 \DeclareUnicodeCharacter{00EA}{\^e}
8598 \DeclareUnicodeCharacter{00EB}{\"e}
8599 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}
8600 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}
8601 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}
8602 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}
8604 \DeclareUnicodeCharacter{00F0}{\dh}
8605 \DeclareUnicodeCharacter{00F1}{\~n}
8606 \DeclareUnicodeCharacter{00F2}{\`o}
8607 \DeclareUnicodeCharacter{00F3}{\'o}
8608 \DeclareUnicodeCharacter{00F4}{\^o}
8609 \DeclareUnicodeCharacter{00F5}{\~o}
8610 \DeclareUnicodeCharacter{00F6}{\"o}
8611 \DeclareUnicodeCharacter{00F8}{\o}
8612 \DeclareUnicodeCharacter{00F9}{\`u}
8613 \DeclareUnicodeCharacter{00FA}{\'u}
8614 \DeclareUnicodeCharacter{00FB}{\^u}
8615 \DeclareUnicodeCharacter{00FC}{\"u}
8616 \DeclareUnicodeCharacter{00FD}{\'y}
8617 \DeclareUnicodeCharacter{00FE}{\th}
8618 \DeclareUnicodeCharacter{00FF}{\"y}
8620 \DeclareUnicodeCharacter{0100}{\=A}
8621 \DeclareUnicodeCharacter{0101}{\=a}
8622 \DeclareUnicodeCharacter{0102}{\u{A}}
8623 \DeclareUnicodeCharacter{0103}{\u{a}}
8624 \DeclareUnicodeCharacter{0104}{\ogonek{A}}
8625 \DeclareUnicodeCharacter{0105}{\ogonek{a}}
8626 \DeclareUnicodeCharacter{0106}{\'C}
8627 \DeclareUnicodeCharacter{0107}{\'c}
8628 \DeclareUnicodeCharacter{0108}{\^C}
8629 \DeclareUnicodeCharacter{0109}{\^c}
8630 \DeclareUnicodeCharacter{0118}{\ogonek{E}}
8631 \DeclareUnicodeCharacter{0119}{\ogonek{e}}
8632 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}
8633 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}
8634 \DeclareUnicodeCharacter{010C}{\v{C}}
8635 \DeclareUnicodeCharacter{010D}{\v{c}}
8636 \DeclareUnicodeCharacter{010E}{\v{D}}
8638 \DeclareUnicodeCharacter{0112}{\=E}
8639 \DeclareUnicodeCharacter{0113}{\=e}
8640 \DeclareUnicodeCharacter{0114}{\u{E}}
8641 \DeclareUnicodeCharacter{0115}{\u{e}}
8642 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}
8643 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}
8644 \DeclareUnicodeCharacter{011A}{\v{E}}
8645 \DeclareUnicodeCharacter{011B}{\v{e}}
8646 \DeclareUnicodeCharacter{011C}{\^G}
8647 \DeclareUnicodeCharacter{011D}{\^g}
8648 \DeclareUnicodeCharacter{011E}{\u{G}}
8649 \DeclareUnicodeCharacter{011F}{\u{g}}
8651 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}
8652 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}
8653 \DeclareUnicodeCharacter{0124}{\^H}
8654 \DeclareUnicodeCharacter{0125}{\^h}
8655 \DeclareUnicodeCharacter{0128}{\~I}
8656 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}
8657 \DeclareUnicodeCharacter{012A}{\=I}
8658 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}
8659 \DeclareUnicodeCharacter{012C}{\u{I}}
8660 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}
8662 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}
8663 \DeclareUnicodeCharacter{0131}{\dotless{i}}
8664 \DeclareUnicodeCharacter{0132}{IJ}
8665 \DeclareUnicodeCharacter{0133}{ij}
8666 \DeclareUnicodeCharacter{0134}{\^J}
8667 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}
8668 \DeclareUnicodeCharacter{0139}{\'L}
8669 \DeclareUnicodeCharacter{013A}{\'l}
8671 \DeclareUnicodeCharacter{0141}{\L}
8672 \DeclareUnicodeCharacter{0142}{\l}
8673 \DeclareUnicodeCharacter{0143}{\'N}
8674 \DeclareUnicodeCharacter{0144}{\'n}
8675 \DeclareUnicodeCharacter{0147}{\v{N}}
8676 \DeclareUnicodeCharacter{0148}{\v{n}}
8677 \DeclareUnicodeCharacter{014C}{\=O}
8678 \DeclareUnicodeCharacter{014D}{\=o}
8679 \DeclareUnicodeCharacter{014E}{\u{O}}
8680 \DeclareUnicodeCharacter{014F}{\u{o}}
8682 \DeclareUnicodeCharacter{0150}{\H{O}}
8683 \DeclareUnicodeCharacter{0151}{\H{o}}
8684 \DeclareUnicodeCharacter{0152}{\OE}
8685 \DeclareUnicodeCharacter{0153}{\oe}
8686 \DeclareUnicodeCharacter{0154}{\'R}
8687 \DeclareUnicodeCharacter{0155}{\'r}
8688 \DeclareUnicodeCharacter{0158}{\v{R}}
8689 \DeclareUnicodeCharacter{0159}{\v{r}}
8690 \DeclareUnicodeCharacter{015A}{\'S}
8691 \DeclareUnicodeCharacter{015B}{\'s}
8692 \DeclareUnicodeCharacter{015C}{\^S}
8693 \DeclareUnicodeCharacter{015D}{\^s}
8694 \DeclareUnicodeCharacter{015E}{\cedilla{S}}
8695 \DeclareUnicodeCharacter{015F}{\cedilla{s}}
8697 \DeclareUnicodeCharacter{0160}{\v{S}}
8698 \DeclareUnicodeCharacter{0161}{\v{s}}
8699 \DeclareUnicodeCharacter{0162}{\cedilla{t}}
8700 \DeclareUnicodeCharacter{0163}{\cedilla{T}}
8701 \DeclareUnicodeCharacter{0164}{\v{T}}
8703 \DeclareUnicodeCharacter{0168}{\~U}
8704 \DeclareUnicodeCharacter{0169}{\~u}
8705 \DeclareUnicodeCharacter{016A}{\=U}
8706 \DeclareUnicodeCharacter{016B}{\=u}
8707 \DeclareUnicodeCharacter{016C}{\u{U}}
8708 \DeclareUnicodeCharacter{016D}{\u{u}}
8709 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}
8710 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}
8712 \DeclareUnicodeCharacter{0170}{\H{U}}
8713 \DeclareUnicodeCharacter{0171}{\H{u}}
8714 \DeclareUnicodeCharacter{0174}{\^W}
8715 \DeclareUnicodeCharacter{0175}{\^w}
8716 \DeclareUnicodeCharacter{0176}{\^Y}
8717 \DeclareUnicodeCharacter{0177}{\^y}
8718 \DeclareUnicodeCharacter{0178}{\"Y}
8719 \DeclareUnicodeCharacter{0179}{\'Z}
8720 \DeclareUnicodeCharacter{017A}{\'z}
8721 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}
8722 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}
8723 \DeclareUnicodeCharacter{017D}{\v{Z}}
8724 \DeclareUnicodeCharacter{017E}{\v{z}}
8726 \DeclareUnicodeCharacter{01C4}{D\v{Z}}
8727 \DeclareUnicodeCharacter{01C5}{D\v{z}}
8728 \DeclareUnicodeCharacter{01C6}{d\v{z}}
8729 \DeclareUnicodeCharacter{01C7}{LJ}
8730 \DeclareUnicodeCharacter{01C8}{Lj}
8731 \DeclareUnicodeCharacter{01C9}{lj}
8732 \DeclareUnicodeCharacter{01CA}{NJ}
8733 \DeclareUnicodeCharacter{01CB}{Nj}
8734 \DeclareUnicodeCharacter{01CC}{nj}
8735 \DeclareUnicodeCharacter{01CD}{\v{A}}
8736 \DeclareUnicodeCharacter{01CE}{\v{a}}
8737 \DeclareUnicodeCharacter{01CF}{\v{I}}
8739 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}
8740 \DeclareUnicodeCharacter{01D1}{\v{O}}
8741 \DeclareUnicodeCharacter{01D2}{\v{o}}
8742 \DeclareUnicodeCharacter{01D3}{\v{U}}
8743 \DeclareUnicodeCharacter{01D4}{\v{u}}
8745 \DeclareUnicodeCharacter{01E2}{\={\AE}}
8746 \DeclareUnicodeCharacter{01E3}{\={\ae}}
8747 \DeclareUnicodeCharacter{01E6}{\v{G}}
8748 \DeclareUnicodeCharacter{01E7}{\v{g}}
8749 \DeclareUnicodeCharacter{01E8}{\v{K}}
8750 \DeclareUnicodeCharacter{01E9}{\v{k}}
8752 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}
8753 \DeclareUnicodeCharacter{01F1}{DZ}
8754 \DeclareUnicodeCharacter{01F2}{Dz}
8755 \DeclareUnicodeCharacter{01F3}{dz}
8756 \DeclareUnicodeCharacter{01F4}{\'G}
8757 \DeclareUnicodeCharacter{01F5}{\'g}
8758 \DeclareUnicodeCharacter{01F8}{\`N}
8759 \DeclareUnicodeCharacter{01F9}{\`n}
8760 \DeclareUnicodeCharacter{01FC}{\'{\AE}}
8761 \DeclareUnicodeCharacter{01FD}{\'{\ae}}
8762 \DeclareUnicodeCharacter{01FE}{\'{\O}}
8763 \DeclareUnicodeCharacter{01FF}{\'{\o}}
8765 \DeclareUnicodeCharacter{021E}{\v{H}}
8766 \DeclareUnicodeCharacter{021F}{\v{h}}
8768 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}
8769 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}
8770 \DeclareUnicodeCharacter{0228}{\cedilla{E}}
8771 \DeclareUnicodeCharacter{0229}{\cedilla{e}}
8772 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}
8773 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}
8775 \DeclareUnicodeCharacter{0232}{\=Y}
8776 \DeclareUnicodeCharacter{0233}{\=y}
8777 \DeclareUnicodeCharacter{0237}{\dotless{j}}
8779 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}
8781 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}
8782 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}
8783 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}
8784 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}
8785 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}
8786 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}
8787 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}
8788 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}
8789 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}
8790 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}
8791 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}
8792 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}
8794 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}
8795 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}
8797 \DeclareUnicodeCharacter{1E20}{\=G}
8798 \DeclareUnicodeCharacter{1E21}{\=g}
8799 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}
8800 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}
8801 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}
8802 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}
8803 \DeclareUnicodeCharacter{1E26}{\"H}
8804 \DeclareUnicodeCharacter{1E27}{\"h}
8806 \DeclareUnicodeCharacter{1E30}{\'K}
8807 \DeclareUnicodeCharacter{1E31}{\'k}
8808 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}
8809 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}
8810 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}
8811 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}
8812 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}
8813 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}
8814 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}
8815 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}
8816 \DeclareUnicodeCharacter{1E3E}{\'M}
8817 \DeclareUnicodeCharacter{1E3F}{\'m}
8819 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}
8820 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}
8821 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}
8822 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}
8823 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}
8824 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}
8825 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}
8826 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}
8827 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}
8828 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}
8830 \DeclareUnicodeCharacter{1E54}{\'P}
8831 \DeclareUnicodeCharacter{1E55}{\'p}
8832 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}
8833 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}
8834 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}
8835 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}
8836 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}
8837 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}
8838 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}
8839 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}
8841 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}
8842 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}
8843 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}
8844 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}
8845 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}
8846 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}
8847 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}
8848 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}
8849 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}
8850 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}
8852 \DeclareUnicodeCharacter{1E7C}{\~V}
8853 \DeclareUnicodeCharacter{1E7D}{\~v}
8854 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}
8855 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}
8857 \DeclareUnicodeCharacter{1E80}{\`W}
8858 \DeclareUnicodeCharacter{1E81}{\`w}
8859 \DeclareUnicodeCharacter{1E82}{\'W}
8860 \DeclareUnicodeCharacter{1E83}{\'w}
8861 \DeclareUnicodeCharacter{1E84}{\"W}
8862 \DeclareUnicodeCharacter{1E85}{\"w}
8863 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}
8864 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}
8865 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}
8866 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}
8867 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}
8868 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}
8869 \DeclareUnicodeCharacter{1E8C}{\"X}
8870 \DeclareUnicodeCharacter{1E8D}{\"x}
8871 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}
8872 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}
8874 \DeclareUnicodeCharacter{1E90}{\^Z}
8875 \DeclareUnicodeCharacter{1E91}{\^z}
8876 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}
8877 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}
8878 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}
8879 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}
8880 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}
8881 \DeclareUnicodeCharacter{1E97}{\"t}
8882 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}
8883 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}
8885 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}
8886 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}
8888 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}
8889 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}
8890 \DeclareUnicodeCharacter{1EBC}{\~E}
8891 \DeclareUnicodeCharacter{1EBD}{\~e}
8893 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}
8894 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}
8895 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}
8896 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}
8898 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}
8899 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}
8901 \DeclareUnicodeCharacter{1EF2}{\`Y}
8902 \DeclareUnicodeCharacter{1EF3}{\`y}
8903 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}
8905 \DeclareUnicodeCharacter{1EF8}{\~Y}
8906 \DeclareUnicodeCharacter{1EF9}{\~y}
8908 \DeclareUnicodeCharacter{2013}{--}
8909 \DeclareUnicodeCharacter{2014}{---}
8910 \DeclareUnicodeCharacter{2018}{\quoteleft}
8911 \DeclareUnicodeCharacter{2019}{\quoteright}
8912 \DeclareUnicodeCharacter{201A}{\quotesinglbase}
8913 \DeclareUnicodeCharacter{201C}{\quotedblleft}
8914 \DeclareUnicodeCharacter{201D}{\quotedblright}
8915 \DeclareUnicodeCharacter{201E}{\quotedblbase}
8916 \DeclareUnicodeCharacter{2022}{\bullet}
8917 \DeclareUnicodeCharacter{2026}{\dots}
8918 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
8919 \DeclareUnicodeCharacter{203A}{\guilsinglright}
8920 \DeclareUnicodeCharacter{20AC}{\euro}
8922 \DeclareUnicodeCharacter{2192}{\expansion}
8923 \DeclareUnicodeCharacter{21D2}{\result}
8925 \DeclareUnicodeCharacter{2212}{\minus}
8926 \DeclareUnicodeCharacter{2217}{\point}
8927 \DeclareUnicodeCharacter{2261}{\equiv}
8928 }% end of \utfeightchardefs
8931 % US-ASCII character definitions.
8932 \def\asciichardefs{% nothing need be done
8936 % Make non-ASCII characters printable again for compatibility with
8937 % existing Texinfo documents that may use them, even without declaring a
8938 % document encoding.
8940 \setnonasciicharscatcode \other
8943 \message{formatting,}
8945 \newdimen\defaultparindent \defaultparindent = 15pt
8947 \chapheadingskip = 15pt plus 4pt minus 2pt
8948 \secheadingskip = 12pt plus 3pt minus 2pt
8949 \subsecheadingskip = 9pt plus 2pt minus 2pt
8951 % Prevent underfull vbox error messages.
8954 % Don't be very finicky about underfull hboxes, either.
8957 % Following George Bush, get rid of widows and orphans.
8961 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
8962 % using an old version of TeX, don't do anything. We want the amount of
8963 % stretch added to depend on the line length, hence the dependence on
8964 % \hsize. We call this whenever the paper size is set.
8966 \def\setemergencystretch{%
8967 \ifx\emergencystretch\thisisundefined
8968 % Allow us to assign to \emergencystretch anyway.
8969 \def\emergencystretch{\dimen0}%
8971 \emergencystretch = .15\hsize
8975 % Parameters in order: 1) textheight; 2) textwidth;
8976 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
8977 % 7) physical page height; 8) physical page width.
8979 % We also call \setleading{\textleading}, so the caller should define
8980 % \textleading. The caller should also set \parskip.
8982 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
8985 \splittopskip = \topskip
8988 \advance\vsize by \topskip
8989 \outervsize = \vsize
8990 \advance\outervsize by 2\topandbottommargin
8991 \pageheight = \vsize
8994 \outerhsize = \hsize
8995 \advance\outerhsize by 0.5in
8998 \normaloffset = #4\relax
8999 \bindingoffset = #5\relax
9002 \pdfpageheight #7\relax
9003 \pdfpagewidth #8\relax
9004 % if we don't reset these, they will remain at "1 true in" of
9005 % whatever layout pdftex was dumped with.
9006 \pdfhorigin = 1 true in
9007 \pdfvorigin = 1 true in
9010 \setleading{\textleading}
9012 \parindent = \defaultparindent
9013 \setemergencystretch
9016 % @letterpaper (the default).
9017 \def\letterpaper{{\globaldefs = 1
9018 \parskip = 3pt plus 2pt minus 1pt
9019 \textleading = 13.2pt
9021 % If page is nothing but text, make it come out even.
9022 \internalpagesizes{607.2pt}{6in}% that's 46 lines
9024 {\bindingoffset}{36pt}%
9028 % Use @smallbook to reset parameters for 7x9.25 trim size.
9029 \def\smallbook{{\globaldefs = 1
9030 \parskip = 2pt plus 1pt
9033 \internalpagesizes{7.5in}{5in}%
9035 {\bindingoffset}{16pt}%
9038 \lispnarrowing = 0.3in
9041 \contentsrightmargin = 0pt
9042 \defbodyindent = .5cm
9045 % Use @smallerbook to reset parameters for 6x9 trim size.
9046 % (Just testing, parameters still in flux.)
9047 \def\smallerbook{{\globaldefs = 1
9048 \parskip = 1.5pt plus 1pt
9051 \internalpagesizes{7.4in}{4.8in}%
9056 \lispnarrowing = 0.25in
9059 \contentsrightmargin = 0pt
9060 \defbodyindent = .4cm
9063 % Use @afourpaper to print on European A4 paper.
9064 \def\afourpaper{{\globaldefs = 1
9065 \parskip = 3pt plus 2pt minus 1pt
9066 \textleading = 13.2pt
9068 % Double-side printing via postscript on Laserjet 4050
9069 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9070 % To change the settings for a different printer or situation, adjust
9071 % \normaloffset until the front-side and back-side texts align. Then
9072 % do the same for \bindingoffset. You can set these for testing in
9073 % your texinfo source file like this:
9075 % \global\normaloffset = -6mm
9076 % \global\bindingoffset = 10mm
9078 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
9079 {\voffset}{\hoffset}%
9080 {\bindingoffset}{44pt}%
9085 \contentsrightmargin = 0pt
9086 \defbodyindent = 5mm
9089 % Use @afivepaper to print on European A5 paper.
9090 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9091 % He also recommends making @example and @lisp be small.
9092 \def\afivepaper{{\globaldefs = 1
9093 \parskip = 2pt plus 1pt minus 0.1pt
9094 \textleading = 12.5pt
9096 \internalpagesizes{160mm}{120mm}%
9097 {\voffset}{\hoffset}%
9098 {\bindingoffset}{8pt}%
9101 \lispnarrowing = 0.2in
9104 \contentsrightmargin = 0pt
9105 \defbodyindent = 2mm
9109 % A specific text layout, 24x15cm overall, intended for A4 paper.
9110 \def\afourlatex{{\globaldefs = 1
9112 \internalpagesizes{237mm}{150mm}%
9114 {\bindingoffset}{7mm}%
9117 % Must explicitly reset to 0 because we call \afourpaper.
9121 % Use @afourwide to print on A4 paper in landscape format.
9122 \def\afourwide{{\globaldefs = 1
9124 \internalpagesizes{241mm}{165mm}%
9125 {\voffset}{-2.95mm}%
9126 {\bindingoffset}{7mm}%
9131 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
9132 % Perhaps we should allow setting the margins, \topskip, \parskip,
9133 % and/or leading, also. Or perhaps we should compute them somehow.
9135 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
9136 \def\pagesizesyyy#1,#2,#3\finish{{%
9137 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
9140 \parskip = 3pt plus 2pt minus 1pt
9141 \setleading{\textleading}%
9144 \advance\dimen0 by \voffset
9147 \advance\dimen2 by \normaloffset
9149 \internalpagesizes{#1}{\hsize}%
9150 {\voffset}{\normaloffset}%
9151 {\bindingoffset}{44pt}%
9155 % Set default to letter.
9160 \message{and turning on texinfo input format.}
9162 % DEL is a comment character, in case @c does not suffice.
9165 % Define macros to output various characters with catcode for normal text.
9175 \def\normaldoublequote{"}
9178 \def\normalunderscore{_}
9179 \def\normalverticalbar{|}
9181 \def\normalgreater{>}
9183 \def\normaldollar{$}%$ font-lock fix
9185 % This macro is used to make a character print one way in \tt
9186 % (where it can probably be output as-is), and another way in other fonts,
9187 % where something hairier probably needs to be done.
9189 % #1 is what to print if we are indeed using \tt; #2 is what to print
9190 % otherwise. Since all the Computer Modern typewriter fonts have zero
9191 % interword stretch (and shrink), and it is reasonable to expect all
9192 % typewriter fonts to have this, we can check that font parameter.
9194 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
9196 % Same as above, but check for italic font. Actually this also catches
9197 % non-italic slanted fonts since it is impossible to distinguish them from
9198 % italic fonts. But since this is only used by $ and it uses \sl anyway
9199 % this is not a problem.
9200 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
9202 % Turn off all special characters except @
9203 % (and those which the user can use as if they were ordinary).
9204 % Most of these we simply print from the \tt font, but for some, we can
9205 % use math or other variants that look better in normal text.
9208 \def\activedoublequote{{\tt\char34}}
9209 \let"=\activedoublequote
9211 \def~{{\tt\char126}}
9217 \def_{\ifusingtt\normalunderscore\_}
9219 % Subroutine for the previous macro.
9220 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
9223 \def|{{\tt\char124}}
9231 \def+{{\tt \char 43}}
9233 \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
9235 % If a .fmt file is being used, characters that might appear in a file
9236 % name cannot be active until we have parsed the command line.
9237 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
9238 % \otherifyactive is called near the end of this file.
9239 \def\otherifyactive{\catcode`+=\other \catcode`\_=\other}
9241 % Used sometimes to turn off (effectively) the active characters even after
9243 \def\turnoffactive{%
9244 \normalturnoffactive
9250 % \backslashcurfont outputs one backslash character in current font,
9252 \global\chardef\backslashcurfont=`\\
9253 \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work
9255 % \realbackslash is an actual character `\' with catcode other, and
9256 % \doublebackslash is two of them (for the pdf outlines).
9257 {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}}
9259 % In texinfo, backslash is an active character; it prints the backslash
9260 % in fixed width font.
9262 @def@normalbackslash{{@tt@backslashcurfont}}
9263 % On startup, @fixbackslash assigns:
9264 % @let \ = @normalbackslash
9266 % \rawbackslash defines an active \ to do \backslashcurfont.
9267 % \otherbackslash defines an active \ to be a literal `\' character with
9269 @gdef@rawbackslash{@let\=@backslashcurfont}
9270 @gdef@otherbackslash{@let\=@realbackslash}
9272 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
9273 % the literal character `\'.
9275 @def@normalturnoffactive{%
9276 @let\=@normalbackslash
9277 @let"=@normaldoublequote
9280 @let_=@normalunderscore
9281 @let|=@normalverticalbar
9283 @let>=@normalgreater
9285 @let$=@normaldollar %$ font-lock fix
9286 @markupsetuplqdefault
9287 @markupsetuprqdefault
9291 % Make _ and + \other characters, temporarily.
9292 % This is canceled by @fixbackslash.
9295 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
9296 % That is what \eatinput is for; after that, the `\' should revert to printing
9299 @gdef@eatinput input texinfo{@fixbackslash}
9300 @global@let\ = @eatinput
9302 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
9303 % the first `\' in the file would cause an error. This macro tries to fix
9304 % that, assuming it is called before the first `\' could plausibly occur.
9305 % Also turn back on active characters that might appear in the input
9306 % file name, in case not using a pre-dumped format.
9308 @gdef@fixbackslash{%
9309 @ifx\@eatinput @let\ = @normalbackslash @fi
9314 % Say @foo, not \foo, in error messages.
9317 % These look ok in all fonts, so just make them not special.
9318 @catcode`@& = @other
9319 @catcode`@# = @other
9320 @catcode`@% = @other
9322 @c Finally, make ` and ' active, so that txicodequoteundirected and
9323 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
9324 @c don't make ` and ' active, @code will not get them as active chars.
9325 @c Do this last of all since we use ` in the previous @catcode assignments.
9328 @markupsetuplqdefault
9329 @markupsetuprqdefault
9332 @c eval: (add-hook 'write-file-hooks 'time-stamp)
9333 @c page-delimiter: "^\\\\message"
9334 @c time-stamp-start: "def\\\\texinfoversion{"
9335 @c time-stamp-format: "%:y-%02m-%02d.%02H"
9336 @c time-stamp-end: "}"
9342 arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115