Mention latest change in NEWS
[autoconf.git] / build-aux / texinfo.tex
blobf059cfb3e2e294d141ca5cbd61c1f956c9ef9a7a
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{2022-05-30.20}
8 % Copyright 1985, 1986, 1988, 1990-2022 Free Software Foundation, Inc.
10 % This texinfo.tex file is free software: you can redistribute it and/or
11 % modify it under the terms of the GNU General Public License as
12 % published by the Free Software Foundation, either version 3 of the
13 % License, or (at your option) any later version.
15 % This texinfo.tex file is distributed in the hope that it will be
16 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
17 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 % General Public License for more details.
20 % You should have received a copy of the GNU General Public License
21 % along with this program. If not, see <https://www.gnu.org/licenses/>.
23 % As a special exception, when this file is read by TeX when processing
24 % a Texinfo source document, you may use the result without
25 % restriction. This Exception is an additional permission under section 7
26 % of the GNU General Public License, version 3 ("GPLv3").
28 % Please try the latest version of texinfo.tex before submitting bug
29 % reports; you can get the latest version from:
30 % https://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
31 % https://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
32 % https://www.gnu.org/software/texinfo/ (the Texinfo home page)
33 % The texinfo.tex in any given distribution could well be out
34 % of date, so if that's what you're using, please check.
36 % Send bug reports to bug-texinfo@gnu.org. Please include a
37 % complete document in each bug report with which we can reproduce the
38 % problem. Patches are, of course, greatly appreciated.
40 % To process a Texinfo manual with TeX, it's most reliable to use the
41 % texi2dvi shell script that comes with the distribution. For a simple
42 % manual foo.texi, however, you can get away with this:
43 % tex foo.texi
44 % texindex foo.??
45 % tex foo.texi
46 % tex foo.texi
47 % dvips foo.dvi -o # or whatever; this makes foo.ps.
48 % The extra TeX runs get the cross-reference information correct.
49 % Sometimes one run after texindex suffices, and sometimes you need more
50 % than two; texi2dvi does it as many times as necessary.
52 % It is possible to adapt texinfo.tex for other languages, to some
53 % extent. You can get the existing language-specific files from the
54 % full Texinfo distribution.
56 % The GNU Texinfo home page is https://www.gnu.org/software/texinfo.
59 \message{Loading texinfo [version \texinfoversion]:}
61 % If in a .fmt file, print the version number
62 % and turn on active characters that we couldn't do earlier because
63 % they might have appeared in the input file name.
64 \everyjob{\message{[Texinfo version \texinfoversion]}%
65 \catcode`+=\active \catcode`\_=\active}
67 % LaTeX's \typeout. This ensures that the messages it is used for
68 % are identical in format to the corresponding ones from latex/pdflatex.
69 \def\typeout{\immediate\write17}%
71 \chardef\other=12
73 % We never want plain's \outer definition of \+ in Texinfo.
74 % For @tex, we can use \tabalign.
75 \let\+ = \relax
77 % Save some plain tex macros whose names we will redefine.
78 \let\ptexb=\b
79 \let\ptexbullet=\bullet
80 \let\ptexc=\c
81 \let\ptexcomma=\,
82 \let\ptexdot=\.
83 \let\ptexdots=\dots
84 \let\ptexend=\end
85 \let\ptexequiv=\equiv
86 \let\ptexexclam=\!
87 \let\ptexfootnote=\footnote
88 \let\ptexgtr=>
89 \let\ptexhat=^
90 \let\ptexi=\i
91 \let\ptexindent=\indent
92 \let\ptexinsert=\insert
93 \let\ptexlbrace=\{
94 \let\ptexless=<
95 \let\ptexnewwrite\newwrite
96 \let\ptexnoindent=\noindent
97 \let\ptexplus=+
98 \let\ptexraggedright=\raggedright
99 \let\ptexrbrace=\}
100 \let\ptexslash=\/
101 \let\ptexsp=\sp
102 \let\ptexstar=\*
103 \let\ptexsup=\sup
104 \let\ptext=\t
105 \let\ptextop=\top
106 {\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
108 % If this character appears in an error message or help string, it
109 % starts a new line in the output.
110 \newlinechar = `^^J
112 % Use TeX 3.0's \inputlineno to get the line number, for better error
113 % messages, but if we're using an old version of TeX, don't do anything.
115 \ifx\inputlineno\thisisundefined
116 \let\linenumber = \empty % Pre-3.0.
117 \else
118 \def\linenumber{l.\the\inputlineno:\space}
121 % Set up fixed words for English if not already set.
122 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
123 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
124 \ifx\putworderror\undefined \gdef\putworderror{error}\fi
125 \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
126 \ifx\putwordin\undefined \gdef\putwordin{in}\fi
127 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
128 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
129 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
130 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
131 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
132 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
133 \ifx\putwordof\undefined \gdef\putwordof{of}\fi
134 \ifx\putwordon\undefined \gdef\putwordon{on}\fi
135 \ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
136 \ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
137 \ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
138 \ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
139 \ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
140 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
141 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
143 \ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
144 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
145 \ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
146 \ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
147 \ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
148 \ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
149 \ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
150 \ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
151 \ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
152 \ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
153 \ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
154 \ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
156 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
157 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
158 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
159 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
160 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
162 % Give the space character the catcode for a space.
163 \def\spaceisspace{\catcode`\ =10\relax}
165 % Likewise for ^^M, the end of line character.
166 \def\endlineisspace{\catcode13=10\relax}
168 \chardef\dashChar = `\-
169 \chardef\slashChar = `\/
170 \chardef\underChar = `\_
172 % Ignore a token.
174 \def\gobble#1{}
176 % The following is used inside several \edef's.
177 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
179 % Hyphenation fixes.
180 \hyphenation{
181 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
182 ap-pen-dix bit-map bit-maps
183 data-base data-bases eshell fall-ing half-way long-est man-u-script
184 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
185 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
186 spell-ing spell-ings
187 stand-alone strong-est time-stamp time-stamps which-ever white-space
188 wide-spread wrap-around
191 % Sometimes it is convenient to have everything in the transcript file
192 % and nothing on the terminal. We don't just call \tracingall here,
193 % since that produces some useless output on the terminal. We also make
194 % some effort to order the tracing commands to reduce output in the log
195 % file; cf. trace.sty in LaTeX.
197 \def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
198 \def\loggingall{%
199 \tracingstats2
200 \tracingpages1
201 \tracinglostchars2 % 2 gives us more in etex
202 \tracingparagraphs1
203 \tracingoutput1
204 \tracingmacros2
205 \tracingrestores1
206 \showboxbreadth\maxdimen \showboxdepth\maxdimen
207 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
208 \tracingscantokens1
209 \tracingifs1
210 \tracinggroups1
211 \tracingnesting2
212 \tracingassigns1
214 \tracingcommands3 % 3 gives us more in etex
215 \errorcontextlines16
218 % @errormsg{MSG}. Do the index-like expansions on MSG, but if things
219 % aren't perfect, it's not the end of the world, being an error message,
220 % after all.
222 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
223 \def\doerrormsg#1{\errmessage{#1}}
225 % add check for \lastpenalty to plain's definitions. If the last thing
226 % we did was a \nobreak, we don't want to insert more space.
228 \def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
229 \removelastskip\penalty-50\smallskip\fi\fi}
230 \def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
231 \removelastskip\penalty-100\medskip\fi\fi}
232 \def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
233 \removelastskip\penalty-200\bigskip\fi\fi}
235 %\f Output routine
238 % For a final copy, take out the rectangles
239 % that mark overfull boxes (in case you have decided
240 % that the text looks ok even though it passes the margin).
242 \def\finalout{\overfullrule=0pt }
244 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
245 \newdimen\topandbottommargin \topandbottommargin=.75in
247 % Output a mark which sets \thischapter, \thissection and \thiscolor.
248 % We dump everything together because we only have one kind of mark.
249 % This works because we only use \botmark / \topmark, not \firstmark.
251 % A mark contains a subexpression of the \ifcase ... \fi construct.
252 % \get*marks macros below extract the needed part using \ifcase.
254 % Another complication is to let the user choose whether \thischapter
255 % (\thissection) refers to the chapter (section) in effect at the top
256 % of a page, or that at the bottom of a page.
258 % \domark is called twice inside \chapmacro, to add one
259 % mark before the section break, and one after.
260 % In the second call \prevchapterdefs is the same as \currentchapterdefs,
261 % and \prevsectiondefs is the same as \currentsectiondefs.
262 % Then if the page is not broken at the mark, some of the previous
263 % section appears on the page, and we can get the name of this section
264 % from \firstmark for @everyheadingmarks top.
265 % @everyheadingmarks bottom uses \botmark.
267 % See page 260 of The TeXbook.
268 \def\domark{%
269 \toks0=\expandafter{\currentchapterdefs}%
270 \toks2=\expandafter{\currentsectiondefs}%
271 \toks4=\expandafter{\prevchapterdefs}%
272 \toks6=\expandafter{\prevsectiondefs}%
273 \toks8=\expandafter{\currentcolordefs}%
274 \mark{%
275 \the\toks0 \the\toks2 % 0: marks for @everyheadingmarks top
276 \noexpand\or \the\toks4 \the\toks6 % 1: for @everyheadingmarks bottom
277 \noexpand\else \the\toks8 % 2: color marks
281 % \gettopheadingmarks, \getbottomheadingmarks,
282 % \getcolormarks - extract needed part of mark.
284 % \topmark doesn't work for the very first chapter (after the title
285 % page or the contents), so we use \firstmark there -- this gets us
286 % the mark with the chapter defs, unless the user sneaks in, e.g.,
287 % @setcolor (or @url, or @link, etc.) between @contents and the very
288 % first @chapter.
289 \def\gettopheadingmarks{%
290 \ifcase0\the\savedtopmark\fi
291 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
293 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
294 \def\getcolormarks{\ifcase2\the\savedtopmark\fi}
296 % Avoid "undefined control sequence" errors.
297 \def\currentchapterdefs{}
298 \def\currentsectiondefs{}
299 \def\currentsection{}
300 \def\prevchapterdefs{}
301 \def\prevsectiondefs{}
302 \def\currentcolordefs{}
304 % Margin to add to right of even pages, to left of odd pages.
305 \newdimen\bindingoffset
306 \newdimen\normaloffset
307 \newdimen\txipagewidth \newdimen\txipageheight
309 % Main output routine.
311 \chardef\PAGE = 255
312 \newtoks\defaultoutput
313 \defaultoutput = {\savetopmark\onepageout{\pagecontents\PAGE}}
314 \output=\expandafter{\the\defaultoutput}
316 \newbox\headlinebox
317 \newbox\footlinebox
319 % When outputting the double column layout for indices, an output routine
320 % is run several times, which hides the original value of \topmark. This
321 % can lead to a page heading being output and duplicating the chapter heading
322 % of the index. Hence, save the contents of \topmark at the beginning of
323 % the output routine. The saved contents are valid until we actually
324 % \shipout a page.
326 % (We used to run a short output routine to actually set \topmark and
327 % \firstmark to the right values, but if this was called with an empty page
328 % containing whatsits for writing index entries, the whatsits would be thrown
329 % away and the index auxiliary file would remain empty.)
331 \newtoks\savedtopmark
332 \newif\iftopmarksaved
333 \topmarksavedtrue
334 \def\savetopmark{%
335 \iftopmarksaved\else
336 \global\savedtopmark=\expandafter{\topmark}%
337 \global\topmarksavedtrue
341 % \onepageout takes a vbox as an argument.
342 % \shipout a vbox for a single page, adding an optional header, footer
343 % and footnote. This also causes index entries for this page to be written
344 % to the auxiliary files.
346 \def\onepageout#1{%
347 \hoffset=\normaloffset
349 \ifodd\pageno \advance\hoffset by \bindingoffset
350 \else \advance\hoffset by -\bindingoffset\fi
352 \checkchapterpage
354 % Retrieve the information for the headings from the marks in the page,
355 % and call Plain TeX's \makeheadline and \makefootline, which use the
356 % values in \headline and \footline.
358 % Common context changes for both heading and footing.
359 % Do this outside of the \shipout so @code etc. will be expanded in
360 % the headline as they should be, not taken literally (outputting ''code).
361 \def\commonheadfootline{\let\hsize=\txipagewidth \texinfochars}
363 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
364 \global\setbox\headlinebox = \vbox{\commonheadfootline \makeheadline}%
365 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
366 \global\setbox\footlinebox = \vbox{\commonheadfootline \makefootline}%
369 % Set context for writing to auxiliary files like index files.
370 % Have to do this stuff outside the \shipout because we want it to
371 % take effect in \write's, yet the group defined by the \vbox ends
372 % before the \shipout runs.
374 \atdummies % don't expand commands in the output.
375 \turnoffactive
376 \shipout\vbox{%
377 % Do this early so pdf references go to the beginning of the page.
378 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
380 \unvbox\headlinebox
381 \pagebody{#1}%
382 \ifdim\ht\footlinebox > 0pt
383 % Only leave this space if the footline is nonempty.
384 % (We lessened \vsize for it in \oddfootingyyy.)
385 % The \baselineskip=24pt in plain's \makefootline has no effect.
386 \vskip 24pt
387 \unvbox\footlinebox
392 \global\topmarksavedfalse
393 \advancepageno
394 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
397 \newinsert\margin \dimen\margin=\maxdimen
399 % Main part of page, including any footnotes
400 \def\pagebody#1{\vbox to\txipageheight{\boxmaxdepth=\maxdepth #1}}
401 {\catcode`\@ =11
402 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
403 % marginal hacks, juha@viisa.uucp (Juha Takala)
404 \ifvoid\margin\else % marginal info is present
405 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
406 \dimen@=\dp#1\relax \unvbox#1\relax
407 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
408 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
411 % Check if we are on the first page of a chapter. Used for printing headings.
412 \newif\ifchapterpage
413 \def\checkchapterpage{%
414 % Get the chapter that was current at the end of the last page
415 \ifcase1\the\savedtopmark\fi
416 \let\prevchaptername\thischaptername
418 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
419 \let\curchaptername\thischaptername
421 \ifx\curchaptername\prevchaptername
422 \chapterpagefalse
423 \else
424 \chapterpagetrue
428 % Argument parsing
430 % Parse an argument, then pass it to #1. The argument is the rest of
431 % the input line (except we remove a trailing comment). #1 should be a
432 % macro which expects an ordinary undelimited TeX argument.
433 % For example, \def\foo{\parsearg\fooxxx}.
435 \def\parsearg{\parseargusing{}}
436 \def\parseargusing#1#2{%
437 \def\argtorun{#2}%
438 \begingroup
439 \obeylines
440 \spaceisspace
442 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
445 {\obeylines %
446 \gdef\parseargline#1^^M{%
447 \endgroup % End of the group started in \parsearg.
448 \argremovecomment #1\comment\ArgTerm%
452 % First remove any @comment, then any @c comment. Pass the result on to
453 % \argcheckspaces.
454 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
455 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
457 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
459 % \argremovec might leave us with trailing space, e.g.,
460 % @end itemize @c foo
461 % This space token undergoes the same procedure and is eventually removed
462 % by \finishparsearg.
464 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
465 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
466 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
467 \def\temp{#3}%
468 \ifx\temp\empty
469 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
470 \let\temp\finishparsearg
471 \else
472 \let\temp\argcheckspaces
474 % Put the space token in:
475 \temp#1 #3\ArgTerm
478 % If a _delimited_ argument is enclosed in braces, they get stripped; so
479 % to get _exactly_ the rest of the line, we had to prevent such situation.
480 % We prepended an \empty token at the very beginning and we expand it now,
481 % just before passing the control to \argtorun.
482 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
483 % either the null string, or it ends with \^^M---thus there is no danger
484 % that a pair of braces would be stripped.
486 % But first, we have to remove the trailing space token.
488 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
491 % \parseargdef - define a command taking an argument on the line
493 % \parseargdef\foo{...}
494 % is roughly equivalent to
495 % \def\foo{\parsearg\Xfoo}
496 % \def\Xfoo#1{...}
497 \def\parseargdef#1{%
498 \expandafter \doparseargdef \csname\string#1\endcsname #1%
500 \def\doparseargdef#1#2{%
501 \def#2{\parsearg#1}%
502 \def#1##1%
505 % Several utility definitions with active space:
507 \obeyspaces
508 \gdef\obeyedspace{ }
510 % Make each space character in the input produce a normal interword
511 % space in the output. Don't allow a line break at this space, as this
512 % is used only in environments like @example, where each line of input
513 % should produce a line of output anyway.
515 \gdef\sepspaces{\obeyspaces\let =\tie}
517 % If an index command is used in an @example environment, any spaces
518 % therein should become regular spaces in the raw index file, not the
519 % expansion of \tie (\leavevmode \penalty \@M \ ).
520 \gdef\unsepspaces{\let =\space}
524 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
526 % Define the framework for environments in texinfo.tex. It's used like this:
528 % \envdef\foo{...}
529 % \def\Efoo{...}
531 % It's the responsibility of \envdef to insert \begingroup before the
532 % actual body; @end closes the group after calling \Efoo. \envdef also
533 % defines \thisenv, so the current environment is known; @end checks
534 % whether the environment name matches. The \checkenv macro can also be
535 % used to check whether the current environment is the one expected.
537 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
538 % are not treated as environments; they don't open a group. (The
539 % implementation of @end takes care not to call \endgroup in this
540 % special case.)
543 % At run-time, environments start with this:
544 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
545 % initialize
546 \let\thisenv\empty
548 % ... but they get defined via ``\envdef\foo{...}'':
549 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
550 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
552 % Check whether we're in the right environment:
553 \def\checkenv#1{%
554 \def\temp{#1}%
555 \ifx\thisenv\temp
556 \else
557 \badenverr
561 % Environment mismatch, #1 expected:
562 \def\badenverr{%
563 \errhelp = \EMsimple
564 \errmessage{This command can appear only \inenvironment\temp,
565 not \inenvironment\thisenv}%
567 \def\inenvironment#1{%
568 \ifx#1\empty
569 outside of any environment%
570 \else
571 in environment \expandafter\string#1%
576 % @end foo calls \checkenv and executes the definition of \Efoo.
577 \parseargdef\end{%
578 \if 1\csname iscond.#1\endcsname
579 \else
580 % The general wording of \badenverr may not be ideal.
581 \expandafter\checkenv\csname#1\endcsname
582 \csname E#1\endcsname
583 \endgroup
587 \newhelp\EMsimple{Press RETURN to continue.}
590 % Be sure we're in horizontal mode when doing a tie, since we make space
591 % equivalent to this in @example-like environments. Otherwise, a space
592 % at the beginning of a line will start with \penalty -- and
593 % since \penalty is valid in vertical mode, we'd end up putting the
594 % penalty on the vertical list instead of in the new paragraph.
595 {\catcode`@ = 11
596 % Avoid using \@M directly, because that causes trouble
597 % if the definition is written into an index file.
598 \global\let\tiepenalty = \@M
599 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
602 % @: forces normal size whitespace following.
603 \def\:{\spacefactor=1000 }
605 % @* forces a line break.
606 \def\*{\unskip\hfil\break\hbox{}\ignorespaces}
608 % @/ allows a line break.
609 \let\/=\allowbreak
611 % @. is an end-of-sentence period.
612 \def\.{.\spacefactor=\endofsentencespacefactor\space}
614 % @! is an end-of-sentence bang.
615 \def\!{!\spacefactor=\endofsentencespacefactor\space}
617 % @? is an end-of-sentence query.
618 \def\?{?\spacefactor=\endofsentencespacefactor\space}
620 % @frenchspacing on|off says whether to put extra space after punctuation.
622 \def\onword{on}
623 \def\offword{off}
625 \parseargdef\frenchspacing{%
626 \def\temp{#1}%
627 \ifx\temp\onword \plainfrenchspacing
628 \else\ifx\temp\offword \plainnonfrenchspacing
629 \else
630 \errhelp = \EMsimple
631 \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
632 \fi\fi
635 % @w prevents a word break. Without the \leavevmode, @w at the
636 % beginning of a paragraph, when TeX is still in vertical mode, would
637 % produce a whole line of output instead of starting the paragraph.
638 \def\w#1{\leavevmode\hbox{#1}}
640 % @group ... @end group forces ... to be all on one page, by enclosing
641 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
642 % to keep its height that of a normal line. According to the rules for
643 % \topskip (p.114 of the TeXbook), the glue inserted is
644 % max (\topskip - \ht (first item), 0). If that height is large,
645 % therefore, no glue is inserted, and the space between the headline and
646 % the text is small, which looks bad.
648 % Another complication is that the group might be very large. This can
649 % cause the glue on the previous page to be unduly stretched, because it
650 % does not have much material. In this case, it's better to add an
651 % explicit \vfill so that the extra space is at the bottom. The
652 % threshold for doing this is if the group is more than \vfilllimit
653 % percent of a page (\vfilllimit can be changed inside of @tex).
655 \newbox\groupbox
656 \def\vfilllimit{0.7}
658 \envdef\group{%
659 \ifnum\catcode`\^^M=\active \else
660 \errhelp = \groupinvalidhelp
661 \errmessage{@group invalid in context where filling is enabled}%
663 \startsavinginserts
665 \setbox\groupbox = \vtop\bgroup
666 % Do @comment since we are called inside an environment such as
667 % @example, where each end-of-line in the input causes an
668 % end-of-line in the output. We don't want the end-of-line after
669 % the `@group' to put extra space in the output. Since @group
670 % should appear on a line by itself (according to the Texinfo
671 % manual), we don't worry about eating any user text.
672 \comment
675 % The \vtop produces a box with normal height and large depth; thus, TeX puts
676 % \baselineskip glue before it, and (when the next line of text is done)
677 % \lineskip glue after it. Thus, space below is not quite equal to space
678 % above. But it's pretty close.
679 \def\Egroup{%
680 % To get correct interline space between the last line of the group
681 % and the first line afterwards, we have to propagate \prevdepth.
682 \endgraf % Not \par, as it may have been set to \lisppar.
683 \global\dimen1 = \prevdepth
684 \egroup % End the \vtop.
685 \addgroupbox
686 \prevdepth = \dimen1
687 \checkinserts
690 \def\addgroupbox{
691 % \dimen0 is the vertical size of the group's box.
692 \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
693 % \dimen2 is how much space is left on the page (more or less).
694 \dimen2 = \txipageheight \advance\dimen2 by -\pagetotal
695 % if the group doesn't fit on the current page, and it's a big big
696 % group, force a page break.
697 \ifdim \dimen0 > \dimen2
698 \ifdim \pagetotal < \vfilllimit\txipageheight
699 \page
702 \box\groupbox
706 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
707 % message, so this ends up printing `@group can only ...'.
709 \newhelp\groupinvalidhelp{%
710 group can only be used in environments such as @example,^^J%
711 where each line of input produces a line of output.}
713 % @need space-in-mils
714 % forces a page break if there is not space-in-mils remaining.
716 \newdimen\mil \mil=0.001in
718 \parseargdef\need{%
719 % Ensure vertical mode, so we don't make a big box in the middle of a
720 % paragraph.
721 \par
723 % If the @need value is less than one line space, it's useless.
724 \dimen0 = #1\mil
725 \dimen2 = \ht\strutbox
726 \advance\dimen2 by \dp\strutbox
727 \ifdim\dimen0 > \dimen2
729 % Do a \strut just to make the height of this box be normal, so the
730 % normal leading is inserted relative to the preceding line.
731 % And a page break here is fine.
732 \vtop to #1\mil{\strut\vfil}%
734 % TeX does not even consider page breaks if a penalty added to the
735 % main vertical list is 10000 or more. But in order to see if the
736 % empty box we just added fits on the page, we must make it consider
737 % page breaks. On the other hand, we don't want to actually break the
738 % page after the empty box. So we use a penalty of 9999.
740 % There is an extremely small chance that TeX will actually break the
741 % page at this \penalty, if there are no other feasible breakpoints in
742 % sight. (If the user is using lots of big @group commands, which
743 % almost-but-not-quite fill up a page, TeX will have a hard time doing
744 % good page breaking, for example.) However, I could not construct an
745 % example where a page broke at this \penalty; if it happens in a real
746 % document, then we can reconsider our strategy.
747 \penalty9999
749 % Back up by the size of the box, whether we did a page break or not.
750 \kern -#1\mil
752 % Do not allow a page break right after this kern.
753 \nobreak
757 % @br forces paragraph break (and is undocumented).
759 \let\br = \par
761 % @page forces the start of a new page.
763 \def\page{\par\vfill\supereject}
765 % @exdent text....
766 % outputs text on separate line in roman font, starting at standard page margin
768 % This records the amount of indent in the innermost environment.
769 % That's how much \exdent should take out.
770 \newskip\exdentamount
772 % This defn is used inside fill environments such as @defun.
773 \parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
775 % This defn is used inside nofill environments such as @example.
776 \parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
777 \leftline{\hskip\leftskip{\rm#1}}}}
779 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
780 % paragraph. For more general purposes, use the \margin insertion
781 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
783 \newskip\inmarginspacing \inmarginspacing=1cm
784 \def\strutdepth{\dp\strutbox}
786 \def\doinmargin#1#2{\strut\vadjust{%
787 \nobreak
788 \kern-\strutdepth
789 \vtop to \strutdepth{%
790 \baselineskip=\strutdepth
791 \vss
792 % if you have multiple lines of stuff to put here, you'll need to
793 % make the vbox yourself of the appropriate size.
794 \ifx#1l%
795 \llap{\ignorespaces #2\hskip\inmarginspacing}%
796 \else
797 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
799 \null
802 \def\inleftmargin{\doinmargin l}
803 \def\inrightmargin{\doinmargin r}
805 % @inmargin{TEXT [, RIGHT-TEXT]}
806 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
807 % else use TEXT for both).
809 \def\inmargin#1{\parseinmargin #1,,\finish}
810 \def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
811 \setbox0 = \hbox{\ignorespaces #2}%
812 \ifdim\wd0 > 0pt
813 \def\lefttext{#1}% have both texts
814 \def\righttext{#2}%
815 \else
816 \def\lefttext{#1}% have only one text
817 \def\righttext{#1}%
820 \ifodd\pageno
821 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
822 \else
823 \def\temp{\inleftmargin\lefttext}%
825 \temp
828 % @include FILE -- \input text of FILE.
830 \def\include{\parseargusing\filenamecatcodes\includezzz}
831 \def\includezzz#1{%
832 \pushthisfilestack
833 \def\thisfile{#1}%
835 \makevalueexpandable % we want to expand any @value in FILE.
836 \turnoffactive % and allow special characters in the expansion
837 \indexnofonts % Allow `@@' and other weird things in file names.
838 \wlog{texinfo.tex: doing @include of #1^^J}%
839 \edef\temp{\noexpand\input #1 }%
841 % This trickery is to read FILE outside of a group, in case it makes
842 % definitions, etc.
843 \expandafter
844 }\temp
845 \popthisfilestack
847 \def\filenamecatcodes{%
848 \catcode`\\=\other
849 \catcode`~=\other
850 \catcode`^=\other
851 \catcode`_=\other
852 \catcode`|=\other
853 \catcode`<=\other
854 \catcode`>=\other
855 \catcode`+=\other
856 \catcode`-=\other
857 \catcode`\`=\other
858 \catcode`\'=\other
861 \def\pushthisfilestack{%
862 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
864 \def\pushthisfilestackX{%
865 \expandafter\pushthisfilestackY\thisfile\StackTerm
867 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
868 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
871 \def\popthisfilestack{\errthisfilestackempty}
872 \def\errthisfilestackempty{\errmessage{Internal error:
873 the stack of filenames is empty.}}
875 \def\thisfile{}
877 % @center line
878 % outputs that line, centered.
880 \parseargdef\center{%
881 \ifhmode
882 \let\centersub\centerH
883 \else
884 \let\centersub\centerV
886 \centersub{\hfil \ignorespaces#1\unskip \hfil}%
887 \let\centersub\relax % don't let the definition persist, just in case
889 \def\centerH#1{{%
890 \hfil\break
891 \advance\hsize by -\leftskip
892 \advance\hsize by -\rightskip
893 \line{#1}%
894 \break
897 \newcount\centerpenalty
898 \def\centerV#1{%
899 % The idea here is the same as in \startdefun, \cartouche, etc.: if
900 % @center is the first thing after a section heading, we need to wipe
901 % out the negative parskip inserted by \sectionheading, but still
902 % prevent a page break here.
903 \centerpenalty = \lastpenalty
904 \ifnum\centerpenalty>10000 \vskip\parskip \fi
905 \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi
906 \line{\kern\leftskip #1\kern\rightskip}%
909 % @sp n outputs n lines of vertical space
911 \parseargdef\sp{\vskip #1\baselineskip}
913 % @comment ...line which is ignored...
914 % @c is the same as @comment
915 % @ignore ... @end ignore is another way to write a comment
918 \def\c{\begingroup \catcode`\^^M=\active%
919 \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
920 \cxxx}
921 {\catcode`\^^M=\active \gdef\cxxx#1^^M{\endgroup}}
923 \let\comment\c
925 % @paragraphindent NCHARS
926 % We'll use ems for NCHARS, close enough.
927 % NCHARS can also be the word `asis' or `none'.
928 % We cannot feasibly implement @paragraphindent asis, though.
930 \def\asisword{asis} % no translation, these are keywords
931 \def\noneword{none}
933 \parseargdef\paragraphindent{%
934 \def\temp{#1}%
935 \ifx\temp\asisword
936 \else
937 \ifx\temp\noneword
938 \defaultparindent = 0pt
939 \else
940 \defaultparindent = #1em
943 \parindent = \defaultparindent
946 % @exampleindent NCHARS
947 % We'll use ems for NCHARS like @paragraphindent.
948 % It seems @exampleindent asis isn't necessary, but
949 % I preserve it to make it similar to @paragraphindent.
950 \parseargdef\exampleindent{%
951 \def\temp{#1}%
952 \ifx\temp\asisword
953 \else
954 \ifx\temp\noneword
955 \lispnarrowing = 0pt
956 \else
957 \lispnarrowing = #1em
962 % @firstparagraphindent WORD
963 % If WORD is `none', then suppress indentation of the first paragraph
964 % after a section heading. If WORD is `insert', then do indent at such
965 % paragraphs.
967 % The paragraph indentation is suppressed or not by calling
968 % \suppressfirstparagraphindent, which the sectioning commands do.
969 % We switch the definition of this back and forth according to WORD.
970 % By default, we suppress indentation.
972 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
973 \def\insertword{insert}
975 \parseargdef\firstparagraphindent{%
976 \def\temp{#1}%
977 \ifx\temp\noneword
978 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
979 \else\ifx\temp\insertword
980 \let\suppressfirstparagraphindent = \relax
981 \else
982 \errhelp = \EMsimple
983 \errmessage{Unknown @firstparagraphindent option `\temp'}%
984 \fi\fi
987 % Here is how we actually suppress indentation. Redefine \everypar to
988 % \kern backwards by \parindent, and then reset itself to empty.
990 % We also make \indent itself not actually do anything until the next
991 % paragraph.
993 \gdef\dosuppressfirstparagraphindent{%
994 \gdef\indent {\restorefirstparagraphindent \indent}%
995 \gdef\noindent{\restorefirstparagraphindent \noindent}%
996 \global\everypar = {\kern -\parindent \restorefirstparagraphindent}%
999 \gdef\restorefirstparagraphindent{%
1000 \global\let\indent = \ptexindent
1001 \global\let\noindent = \ptexnoindent
1002 \global\everypar = {}%
1005 % leave vertical mode without cancelling any first paragraph indent
1006 \gdef\imageindent{%
1007 \toks0=\everypar
1008 \everypar={}%
1009 \ptexnoindent
1010 \global\everypar=\toks0
1014 % @refill is a no-op.
1015 \let\refill=\relax
1017 % @setfilename INFO-FILENAME - ignored
1018 \let\setfilename=\comment
1020 % @bye.
1021 \outer\def\bye{\chappager\pagelabels\tracingstats=1\ptexend}
1024 \message{pdf,}
1025 % adobe `portable' document format
1026 \newcount\tempnum
1027 \newcount\lnkcount
1028 \newtoks\filename
1029 \newcount\filenamelength
1030 \newcount\pgn
1031 \newtoks\toksA
1032 \newtoks\toksB
1033 \newtoks\toksC
1034 \newtoks\toksD
1035 \newbox\boxA
1036 \newbox\boxB
1037 \newcount\countA
1038 \newif\ifpdf
1039 \newif\ifpdfmakepagedest
1042 % For LuaTeX
1045 \newif\iftxiuseunicodedestname
1046 \txiuseunicodedestnamefalse % For pdfTeX etc.
1048 \ifx\luatexversion\thisisundefined
1049 \else
1050 % Use Unicode destination names
1051 \txiuseunicodedestnametrue
1052 % Escape PDF strings with converting UTF-16 from UTF-8
1053 \begingroup
1054 \catcode`\%=12
1055 \directlua{
1056 function UTF16oct(str)
1057 tex.sprint(string.char(0x5c) .. '376' .. string.char(0x5c) .. '377')
1058 for c in string.utfvalues(str) do
1059 if c < 0x10000 then
1060 tex.sprint(
1061 string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
1062 string.char(0x5c) .. string.char(0x25) .. '03o',
1063 math.floor(c / 256), math.floor(c % 256)))
1064 else
1065 c = c - 0x10000
1066 local c_hi = c / 1024 + 0xd800
1067 local c_lo = c % 1024 + 0xdc00
1068 tex.sprint(
1069 string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
1070 string.char(0x5c) .. string.char(0x25) .. '03o' ..
1071 string.char(0x5c) .. string.char(0x25) .. '03o' ..
1072 string.char(0x5c) .. string.char(0x25) .. '03o',
1073 math.floor(c_hi / 256), math.floor(c_hi % 256),
1074 math.floor(c_lo / 256), math.floor(c_lo % 256)))
1079 \endgroup
1080 \def\pdfescapestrutfsixteen#1{\directlua{UTF16oct('\luaescapestring{#1}')}}
1081 % Escape PDF strings without converting
1082 \begingroup
1083 \directlua{
1084 function PDFescstr(str)
1085 for c in string.bytes(str) do
1086 if c <= 0x20 or c >= 0x80 or c == 0x28 or c == 0x29 or c == 0x5c then
1087 tex.sprint(-2,
1088 string.format(string.char(0x5c) .. string.char(0x25) .. '03o',
1090 else
1091 tex.sprint(-2, string.char(c))
1096 % The -2 in the arguments here gives all the input to TeX catcode 12
1097 % (other) or 10 (space), preventing undefined control sequence errors. See
1098 % https://lists.gnu.org/archive/html/bug-texinfo/2019-08/msg00031.html
1100 \endgroup
1101 \def\pdfescapestring#1{\directlua{PDFescstr('\luaescapestring{#1}')}}
1102 \ifnum\luatexversion>84
1103 % For LuaTeX >= 0.85
1104 \def\pdfdest{\pdfextension dest}
1105 \let\pdfoutput\outputmode
1106 \def\pdfliteral{\pdfextension literal}
1107 \def\pdfcatalog{\pdfextension catalog}
1108 \def\pdftexversion{\numexpr\pdffeedback version\relax}
1109 \let\pdfximage\saveimageresource
1110 \let\pdfrefximage\useimageresource
1111 \let\pdflastximage\lastsavedimageresourceindex
1112 \def\pdfendlink{\pdfextension endlink\relax}
1113 \def\pdfoutline{\pdfextension outline}
1114 \def\pdfstartlink{\pdfextension startlink}
1115 \def\pdffontattr{\pdfextension fontattr}
1116 \def\pdfobj{\pdfextension obj}
1117 \def\pdflastobj{\numexpr\pdffeedback lastobj\relax}
1118 \let\pdfpagewidth\pagewidth
1119 \let\pdfpageheight\pageheight
1120 \edef\pdfhorigin{\pdfvariable horigin}
1121 \edef\pdfvorigin{\pdfvariable vorigin}
1125 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1126 % can be set). So we test for \relax and 0 as well as being undefined.
1127 \ifx\pdfoutput\thisisundefined
1128 \else
1129 \ifx\pdfoutput\relax
1130 \else
1131 \ifcase\pdfoutput
1132 \else
1133 \pdftrue
1138 \newif\ifpdforxetex
1139 \pdforxetexfalse
1140 \ifpdf
1141 \pdforxetextrue
1143 \ifx\XeTeXrevision\thisisundefined\else
1144 \pdforxetextrue
1148 % Output page labels information.
1149 % See PDF reference v.1.7 p.594, section 8.3.1.
1150 \ifpdf
1151 \def\pagelabels{%
1152 \def\title{0 << /P (T-) /S /D >>}%
1153 \edef\roman{\the\romancount << /S /r >>}%
1154 \edef\arabic{\the\arabiccount << /S /D >>}%
1156 % Page label ranges must be increasing. Remove any duplicates.
1157 % (There is a slight chance of this being wrong if e.g. there is
1158 % a @contents but no @titlepage, etc.)
1160 \ifnum\romancount=0 \def\roman{}\fi
1161 \ifnum\arabiccount=0 \def\title{}%
1162 \else
1163 \ifnum\romancount=\arabiccount \def\roman{}\fi
1166 \ifnum\romancount<\arabiccount
1167 \pdfcatalog{/PageLabels << /Nums [\title \roman \arabic ] >> }\relax
1168 \else
1169 \pdfcatalog{/PageLabels << /Nums [\title \arabic \roman ] >> }\relax
1172 \else
1173 \let\pagelabels\relax
1176 \newcount\pagecount \pagecount=0
1177 \newcount\romancount \romancount=0
1178 \newcount\arabiccount \arabiccount=0
1179 \ifpdf
1180 \let\ptxadvancepageno\advancepageno
1181 \def\advancepageno{%
1182 \ptxadvancepageno\global\advance\pagecount by 1
1187 % PDF uses PostScript string constants for the names of xref targets,
1188 % for display in the outlines, and in other places. Thus, we have to
1189 % double any backslashes. Otherwise, a name like "\node" will be
1190 % interpreted as a newline (\n), followed by o, d, e. Not good.
1192 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1193 % related messages. The final outcome is that it is up to the TeX user
1194 % to double the backslashes and otherwise make the string valid, so
1195 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1196 % do this reliably, so we use it.
1198 % #1 is a control sequence in which to do the replacements,
1199 % which we \xdef.
1200 \def\txiescapepdf#1{%
1201 \ifx\pdfescapestring\thisisundefined
1202 % No primitive available; should we give a warning or log?
1203 % Many times it won't matter.
1204 \xdef#1{#1}%
1205 \else
1206 % The expandable \pdfescapestring primitive escapes parentheses,
1207 % backslashes, and other special chars.
1208 \xdef#1{\pdfescapestring{#1}}%
1211 \def\txiescapepdfutfsixteen#1{%
1212 \ifx\pdfescapestrutfsixteen\thisisundefined
1213 % No UTF-16 converting macro available.
1214 \txiescapepdf{#1}%
1215 \else
1216 \xdef#1{\pdfescapestrutfsixteen{#1}}%
1220 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1221 with PDF output, and none of those formats could be found. (.eps cannot
1222 be supported due to the design of the PDF format; use regular TeX (DVI
1223 output) for that.)}
1225 \ifpdf
1227 % Color manipulation macros using ideas from pdfcolor.tex,
1228 % except using rgb instead of cmyk; the latter is said to render as a
1229 % very dark gray on-screen and a very dark halftone in print, instead
1230 % of actual black. The dark red here is dark enough to print on paper as
1231 % nearly black, but still distinguishable for online viewing. We use
1232 % black by default, though.
1233 \def\rgbDarkRed{0.50 0.09 0.12}
1234 \def\rgbBlack{0 0 0}
1236 % rg sets the color for filling (usual text, etc.);
1237 % RG sets the color for stroking (thin rules, e.g., normal _'s).
1238 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1240 % Set color, and create a mark which defines \thiscolor accordingly,
1241 % so that \makeheadline knows which color to restore.
1242 \def\setcolor#1{%
1243 \xdef\currentcolordefs{\gdef\noexpand\thiscolor{#1}}%
1244 \domark
1245 \pdfsetcolor{#1}%
1248 \def\maincolor{\rgbBlack}
1249 \pdfsetcolor{\maincolor}
1250 \edef\thiscolor{\maincolor}
1251 \def\currentcolordefs{}
1253 \def\makefootline{%
1254 \baselineskip24pt
1255 \line{\pdfsetcolor{\maincolor}\the\footline}%
1258 \def\makeheadline{%
1259 \vbox to 0pt{%
1260 \vskip-22.5pt
1261 \line{%
1262 \vbox to8.5pt{}%
1263 % Extract \thiscolor definition from the marks.
1264 \getcolormarks
1265 % Typeset the headline with \maincolor, then restore the color.
1266 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1268 \vss
1270 \nointerlineskip
1274 \pdfcatalog{/PageMode /UseOutlines}
1276 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1277 \def\dopdfimage#1#2#3{%
1278 \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1279 \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1281 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1282 % others). Let's try in that order, PDF first since if
1283 % someone has a scalable image, presumably better to use that than a
1284 % bitmap.
1285 \let\pdfimgext=\empty
1286 \begingroup
1287 \openin 1 #1.pdf \ifeof 1
1288 \openin 1 #1.PDF \ifeof 1
1289 \openin 1 #1.png \ifeof 1
1290 \openin 1 #1.jpg \ifeof 1
1291 \openin 1 #1.jpeg \ifeof 1
1292 \openin 1 #1.JPG \ifeof 1
1293 \errhelp = \nopdfimagehelp
1294 \errmessage{Could not find image file #1 for pdf}%
1295 \else \gdef\pdfimgext{JPG}%
1297 \else \gdef\pdfimgext{jpeg}%
1299 \else \gdef\pdfimgext{jpg}%
1301 \else \gdef\pdfimgext{png}%
1303 \else \gdef\pdfimgext{PDF}%
1305 \else \gdef\pdfimgext{pdf}%
1307 \closein 1
1308 \endgroup
1310 % without \immediate, ancient pdftex seg faults when the same image is
1311 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1312 \ifnum\pdftexversion < 14
1313 \immediate\pdfimage
1314 \else
1315 \immediate\pdfximage
1317 \ifdim \wd0 >0pt width \pdfimagewidth \fi
1318 \ifdim \wd2 >0pt height \pdfimageheight \fi
1319 \ifnum\pdftexversion<13
1320 #1.\pdfimgext
1321 \else
1322 {#1.\pdfimgext}%
1324 \ifnum\pdftexversion < 14 \else
1325 \pdfrefximage \pdflastximage
1326 \fi}
1328 \def\setpdfdestname#1{{%
1329 % We have to set dummies so commands such as @code, and characters
1330 % such as \, aren't expanded when present in a section title.
1331 \indexnofonts
1332 \makevalueexpandable
1333 \turnoffactive
1334 \iftxiuseunicodedestname
1335 \ifx \declaredencoding \latone
1336 % Pass through Latin-1 characters.
1337 % LuaTeX with byte wise I/O converts Latin-1 characters to Unicode.
1338 \else
1339 \ifx \declaredencoding \utfeight
1340 % Pass through Unicode characters.
1341 \else
1342 % Use ASCII approximations in destination names.
1343 \passthroughcharsfalse
1346 \else
1347 % Use ASCII approximations in destination names.
1348 \passthroughcharsfalse
1350 \def\pdfdestname{#1}%
1351 \txiescapepdf\pdfdestname
1354 \def\setpdfoutlinetext#1{{%
1355 \indexnofonts
1356 \makevalueexpandable
1357 \turnoffactive
1358 \ifx \declaredencoding \latone
1359 % The PDF format can use an extended form of Latin-1 in bookmark
1360 % strings. See Appendix D of the PDF Reference, Sixth Edition, for
1361 % the "PDFDocEncoding".
1362 \passthroughcharstrue
1363 % Pass through Latin-1 characters.
1364 % LuaTeX: Convert to Unicode
1365 % pdfTeX: Use Latin-1 as PDFDocEncoding
1366 \def\pdfoutlinetext{#1}%
1367 \else
1368 \ifx \declaredencoding \utfeight
1369 \ifx\luatexversion\thisisundefined
1370 % For pdfTeX with UTF-8.
1371 % TODO: the PDF format can use UTF-16 in bookmark strings,
1372 % but the code for this isn't done yet.
1373 % Use ASCII approximations.
1374 \passthroughcharsfalse
1375 \def\pdfoutlinetext{#1}%
1376 \else
1377 % For LuaTeX with UTF-8.
1378 % Pass through Unicode characters for title texts.
1379 \passthroughcharstrue
1380 \def\pdfoutlinetext{#1}%
1382 \else
1383 % For non-Latin-1 or non-UTF-8 encodings.
1384 % Use ASCII approximations.
1385 \passthroughcharsfalse
1386 \def\pdfoutlinetext{#1}%
1389 % LuaTeX: Convert to UTF-16
1390 % pdfTeX: Use Latin-1 as PDFDocEncoding
1391 \txiescapepdfutfsixteen\pdfoutlinetext
1394 \def\pdfmkdest#1{%
1395 \setpdfdestname{#1}%
1396 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1399 % used to mark target names; must be expandable.
1400 \def\pdfmkpgn#1{#1}
1402 % by default, use black for everything.
1403 \def\urlcolor{\rgbBlack}
1404 \def\linkcolor{\rgbBlack}
1405 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1407 % Adding outlines to PDF; macros for calculating structure of outlines
1408 % come from Petr Olsak
1409 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1410 \else \csname#1\endcsname \fi}
1411 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1412 \advance\tempnum by 1
1413 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1415 % #1 is the section text, which is what will be displayed in the
1416 % outline by the pdf viewer. #2 is the pdf expression for the number
1417 % of subentries (or empty, for subsubsections). #3 is the node text,
1418 % which might be empty if this toc entry had no corresponding node.
1419 % #4 is the page number
1421 \def\dopdfoutline#1#2#3#4{%
1422 % Generate a link to the node text if that exists; else, use the
1423 % page number. We could generate a destination for the section
1424 % text in the case where a section has no node, but it doesn't
1425 % seem worth the trouble, since most documents are normally structured.
1426 \setpdfoutlinetext{#1}
1427 \setpdfdestname{#3}
1428 \ifx\pdfdestname\empty
1429 \def\pdfdestname{#4}%
1432 \pdfoutline goto name{\pdfmkpgn{\pdfdestname}}#2{\pdfoutlinetext}%
1435 \def\pdfmakeoutlines{%
1436 \begingroup
1437 % Read toc silently, to get counts of subentries for \pdfoutline.
1438 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1439 \def\numchapentry##1##2##3##4{%
1440 \def\thischapnum{##2}%
1441 \def\thissecnum{0}%
1442 \def\thissubsecnum{0}%
1444 \def\numsecentry##1##2##3##4{%
1445 \advancenumber{chap\thischapnum}%
1446 \def\thissecnum{##2}%
1447 \def\thissubsecnum{0}%
1449 \def\numsubsecentry##1##2##3##4{%
1450 \advancenumber{sec\thissecnum}%
1451 \def\thissubsecnum{##2}%
1453 \def\numsubsubsecentry##1##2##3##4{%
1454 \advancenumber{subsec\thissubsecnum}%
1456 \def\thischapnum{0}%
1457 \def\thissecnum{0}%
1458 \def\thissubsecnum{0}%
1460 % use \def rather than \let here because we redefine \chapentry et
1461 % al. a second time, below.
1462 \def\appentry{\numchapentry}%
1463 \def\appsecentry{\numsecentry}%
1464 \def\appsubsecentry{\numsubsecentry}%
1465 \def\appsubsubsecentry{\numsubsubsecentry}%
1466 \def\unnchapentry{\numchapentry}%
1467 \def\unnsecentry{\numsecentry}%
1468 \def\unnsubsecentry{\numsubsecentry}%
1469 \def\unnsubsubsecentry{\numsubsubsecentry}%
1470 \readdatafile{toc}%
1472 % Read toc second time, this time actually producing the outlines.
1473 % The `-' means take the \expnumber as the absolute number of
1474 % subentries, which we calculated on our first read of the .toc above.
1476 % We use the node names as the destinations.
1478 % Currently we prefix the section name with the section number
1479 % for chapter and appendix headings only in order to avoid too much
1480 % horizontal space being required in the PDF viewer.
1481 \def\numchapentry##1##2##3##4{%
1482 \dopdfoutline{##2 ##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1483 \def\unnchapentry##1##2##3##4{%
1484 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1485 \def\numsecentry##1##2##3##4{%
1486 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1487 \def\numsubsecentry##1##2##3##4{%
1488 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1489 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1490 \dopdfoutline{##1}{}{##3}{##4}}%
1492 % PDF outlines are displayed using system fonts, instead of
1493 % document fonts. Therefore we cannot use special characters,
1494 % since the encoding is unknown. For example, the eogonek from
1495 % Latin 2 (0xea) gets translated to a | character. Info from
1496 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1498 % TODO this right, we have to translate 8-bit characters to
1499 % their "best" equivalent, based on the @documentencoding. Too
1500 % much work for too little return. Just use the ASCII equivalents
1501 % we use for the index sort strings.
1503 \indexnofonts
1504 \setupdatafile
1505 % We can have normal brace characters in the PDF outlines, unlike
1506 % Texinfo index files. So set that up.
1507 \def\{{\lbracecharliteral}%
1508 \def\}{\rbracecharliteral}%
1509 \catcode`\\=\active \otherbackslash
1510 \input \tocreadfilename
1511 \endgroup
1513 {\catcode`[=1 \catcode`]=2
1514 \catcode`{=\other \catcode`}=\other
1515 \gdef\lbracecharliteral[{]%
1516 \gdef\rbracecharliteral[}]%
1519 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1520 \ifx\PP\D\let\nextsp\relax
1521 \else\let\nextsp\skipspaces
1522 \addtokens{\filename}{\PP}%
1523 \advance\filenamelength by 1
1525 \nextsp}
1526 \def\getfilename#1{%
1527 \filenamelength=0
1528 % If we don't expand the argument now, \skipspaces will get
1529 % snagged on things like "@value{foo}".
1530 \edef\temp{#1}%
1531 \expandafter\skipspaces\temp|\relax
1533 \ifnum\pdftexversion < 14
1534 \let \startlink \pdfannotlink
1535 \else
1536 \let \startlink \pdfstartlink
1538 % make a live url in pdf output.
1539 \def\pdfurl#1{%
1540 \begingroup
1541 % it seems we really need yet another set of dummies; have not
1542 % tried to figure out what each command should do in the context
1543 % of @url. for now, just make @/ a no-op, that's the only one
1544 % people have actually reported a problem with.
1546 \normalturnoffactive
1547 \def\@{@}%
1548 \let\/=\empty
1549 \makevalueexpandable
1550 % do we want to go so far as to use \indexnofonts instead of just
1551 % special-casing \var here?
1552 \def\var##1{##1}%
1554 \leavevmode\setcolor{\urlcolor}%
1555 \startlink attr{/Border [0 0 0]}%
1556 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1557 \endgroup}
1558 % \pdfgettoks - Surround page numbers in #1 with @pdflink. #1 may
1559 % be a simple number, or a list of numbers in the case of an index
1560 % entry.
1561 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1562 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1563 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1564 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1565 \def\maketoks{%
1566 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1567 \ifx\first0\adn0
1568 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1569 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1570 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1571 \else
1572 \ifnum0=\countA\else\makelink\fi
1573 \ifx\first.\let\next=\done\else
1574 \let\next=\maketoks
1575 \addtokens{\toksB}{\the\toksD}
1576 \ifx\first,\addtokens{\toksB}{\space}\fi
1578 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1579 \next}
1580 \def\makelink{\addtokens{\toksB}%
1581 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1582 \def\pdflink#1{%
1583 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1584 \setcolor{\linkcolor}#1\endlink}
1585 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1586 \else
1587 % non-pdf mode
1588 \let\pdfmkdest = \gobble
1589 \let\pdfurl = \gobble
1590 \let\endlink = \relax
1591 \let\setcolor = \gobble
1592 \let\pdfsetcolor = \gobble
1593 \let\pdfmakeoutlines = \relax
1594 \fi % \ifx\pdfoutput
1597 % For XeTeX
1599 \ifx\XeTeXrevision\thisisundefined
1600 \else
1602 % XeTeX version check
1604 \ifnum\strcmp{\the\XeTeXversion\XeTeXrevision}{0.99996}>-1
1605 % TeX Live 2016 contains XeTeX 0.99996 and xdvipdfmx 20160307.
1606 % It can use the `dvipdfmx:config' special (from TeX Live SVN r40941).
1607 % For avoiding PDF destination name replacement, we use this special
1608 % instead of xdvipdfmx's command line option `-C 0x0010'.
1609 \special{dvipdfmx:config C 0x0010}
1610 % XeTeX 0.99995+ comes with xdvipdfmx 20160307+.
1611 % It can handle Unicode destination names for PDF.
1612 \txiuseunicodedestnametrue
1613 \else
1614 % XeTeX < 0.99996 (TeX Live < 2016) cannot use the
1615 % `dvipdfmx:config' special.
1616 % So for avoiding PDF destination name replacement,
1617 % xdvipdfmx's command line option `-C 0x0010' is necessary.
1619 % XeTeX < 0.99995 can not handle Unicode destination names for PDF
1620 % because xdvipdfmx 20150315 has a UTF-16 conversion issue.
1621 % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
1622 \txiuseunicodedestnamefalse
1625 % Color support
1627 \def\rgbDarkRed{0.50 0.09 0.12}
1628 \def\rgbBlack{0 0 0}
1630 \def\pdfsetcolor#1{\special{pdf:scolor [#1]}}
1632 % Set color, and create a mark which defines \thiscolor accordingly,
1633 % so that \makeheadline knows which color to restore.
1634 \def\setcolor#1{%
1635 \xdef\currentcolordefs{\gdef\noexpand\thiscolor{#1}}%
1636 \domark
1637 \pdfsetcolor{#1}%
1640 \def\maincolor{\rgbBlack}
1641 \pdfsetcolor{\maincolor}
1642 \edef\thiscolor{\maincolor}
1643 \def\currentcolordefs{}
1645 \def\makefootline{%
1646 \baselineskip24pt
1647 \line{\pdfsetcolor{\maincolor}\the\footline}%
1650 \def\makeheadline{%
1651 \vbox to 0pt{%
1652 \vskip-22.5pt
1653 \line{%
1654 \vbox to8.5pt{}%
1655 % Extract \thiscolor definition from the marks.
1656 \getcolormarks
1657 % Typeset the headline with \maincolor, then restore the color.
1658 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1660 \vss
1662 \nointerlineskip
1665 % PDF outline support
1667 % Emulate pdfTeX primitive
1668 \def\pdfdest name#1 xyz{%
1669 \special{pdf:dest (#1) [@thispage /XYZ @xpos @ypos null]}%
1672 \def\setpdfdestname#1{{%
1673 % We have to set dummies so commands such as @code, and characters
1674 % such as \, aren't expanded when present in a section title.
1675 \indexnofonts
1676 \makevalueexpandable
1677 \turnoffactive
1678 \iftxiuseunicodedestname
1679 % Pass through Unicode characters.
1680 \else
1681 % Use ASCII approximations in destination names.
1682 \passthroughcharsfalse
1684 \def\pdfdestname{#1}%
1685 \txiescapepdf\pdfdestname
1688 \def\setpdfoutlinetext#1{{%
1689 \turnoffactive
1690 % Always use Unicode characters in title texts.
1691 \def\pdfoutlinetext{#1}%
1692 % For XeTeX, xdvipdfmx converts to UTF-16.
1693 % So we do not convert.
1694 \txiescapepdf\pdfoutlinetext
1697 \def\pdfmkdest#1{%
1698 \setpdfdestname{#1}%
1699 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1702 % by default, use black for everything.
1703 \def\urlcolor{\rgbBlack}
1704 \def\linkcolor{\rgbBlack}
1705 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1707 \def\dopdfoutline#1#2#3#4{%
1708 \setpdfoutlinetext{#1}
1709 \setpdfdestname{#3}
1710 \ifx\pdfdestname\empty
1711 \def\pdfdestname{#4}%
1714 \special{pdf:out [-] #2 << /Title (\pdfoutlinetext) /A
1715 << /S /GoTo /D (\pdfdestname) >> >> }%
1718 \def\pdfmakeoutlines{%
1719 \begingroup
1721 % For XeTeX, counts of subentries are not necessary.
1722 % Therefore, we read toc only once.
1724 % We use node names as destinations.
1726 % Currently we prefix the section name with the section number
1727 % for chapter and appendix headings only in order to avoid too much
1728 % horizontal space being required in the PDF viewer.
1729 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1730 \def\numchapentry##1##2##3##4{%
1731 \dopdfoutline{##2 ##1}{1}{##3}{##4}}%
1732 \def\numsecentry##1##2##3##4{%
1733 \dopdfoutline{##1}{2}{##3}{##4}}%
1734 \def\numsubsecentry##1##2##3##4{%
1735 \dopdfoutline{##1}{3}{##3}{##4}}%
1736 \def\numsubsubsecentry##1##2##3##4{%
1737 \dopdfoutline{##1}{4}{##3}{##4}}%
1739 \let\appentry\numchapentry%
1740 \let\appsecentry\numsecentry%
1741 \let\appsubsecentry\numsubsecentry%
1742 \let\appsubsubsecentry\numsubsubsecentry%
1743 \def\unnchapentry##1##2##3##4{%
1744 \dopdfoutline{##1}{1}{##3}{##4}}%
1745 \let\unnsecentry\numsecentry%
1746 \let\unnsubsecentry\numsubsecentry%
1747 \let\unnsubsubsecentry\numsubsubsecentry%
1749 % For XeTeX, xdvipdfmx converts strings to UTF-16.
1750 % Therefore, the encoding and the language may not be considered.
1752 \indexnofonts
1753 \setupdatafile
1754 % We can have normal brace characters in the PDF outlines, unlike
1755 % Texinfo index files. So set that up.
1756 \def\{{\lbracecharliteral}%
1757 \def\}{\rbracecharliteral}%
1758 \catcode`\\=\active \otherbackslash
1759 \input \tocreadfilename
1760 \endgroup
1762 {\catcode`[=1 \catcode`]=2
1763 \catcode`{=\other \catcode`}=\other
1764 \gdef\lbracecharliteral[{]%
1765 \gdef\rbracecharliteral[}]%
1768 \special{pdf:docview << /PageMode /UseOutlines >> }
1769 % ``\special{pdf:tounicode ...}'' is not necessary
1770 % because xdvipdfmx converts strings from UTF-8 to UTF-16 without it.
1771 % However, due to a UTF-16 conversion issue of xdvipdfmx 20150315,
1772 % ``\special{pdf:dest ...}'' cannot handle non-ASCII strings.
1773 % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
1775 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1776 \ifx\PP\D\let\nextsp\relax
1777 \else\let\nextsp\skipspaces
1778 \addtokens{\filename}{\PP}%
1779 \advance\filenamelength by 1
1781 \nextsp}
1782 \def\getfilename#1{%
1783 \filenamelength=0
1784 % If we don't expand the argument now, \skipspaces will get
1785 % snagged on things like "@value{foo}".
1786 \edef\temp{#1}%
1787 \expandafter\skipspaces\temp|\relax
1789 % make a live url in pdf output.
1790 \def\pdfurl#1{%
1791 \begingroup
1792 % it seems we really need yet another set of dummies; have not
1793 % tried to figure out what each command should do in the context
1794 % of @url. for now, just make @/ a no-op, that's the only one
1795 % people have actually reported a problem with.
1797 \normalturnoffactive
1798 \def\@{@}%
1799 \let\/=\empty
1800 \makevalueexpandable
1801 % do we want to go so far as to use \indexnofonts instead of just
1802 % special-casing \var here?
1803 \def\var##1{##1}%
1805 \leavevmode\setcolor{\urlcolor}%
1806 \special{pdf:bann << /Border [0 0 0]
1807 /Subtype /Link /A << /S /URI /URI (#1) >> >>}%
1808 \endgroup}
1809 \def\endlink{\setcolor{\maincolor}\special{pdf:eann}}
1810 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1811 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1812 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1813 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1814 \def\maketoks{%
1815 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1816 \ifx\first0\adn0
1817 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1818 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1819 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1820 \else
1821 \ifnum0=\countA\else\makelink\fi
1822 \ifx\first.\let\next=\done\else
1823 \let\next=\maketoks
1824 \addtokens{\toksB}{\the\toksD}
1825 \ifx\first,\addtokens{\toksB}{\space}\fi
1827 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1828 \next}
1829 \def\makelink{\addtokens{\toksB}%
1830 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1831 \def\pdflink#1{%
1832 \special{pdf:bann << /Border [0 0 0]
1833 /Type /Annot /Subtype /Link /A << /S /GoTo /D (#1) >> >>}%
1834 \setcolor{\linkcolor}#1\endlink}
1835 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1838 % @image support
1840 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1841 \def\doxeteximage#1#2#3{%
1842 \def\xeteximagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1843 \def\xeteximageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1845 % XeTeX (and the PDF format) supports .pdf, .png, .jpg (among
1846 % others). Let's try in that order, PDF first since if
1847 % someone has a scalable image, presumably better to use that than a
1848 % bitmap.
1849 \let\xeteximgext=\empty
1850 \begingroup
1851 \openin 1 #1.pdf \ifeof 1
1852 \openin 1 #1.PDF \ifeof 1
1853 \openin 1 #1.png \ifeof 1
1854 \openin 1 #1.jpg \ifeof 1
1855 \openin 1 #1.jpeg \ifeof 1
1856 \openin 1 #1.JPG \ifeof 1
1857 \errmessage{Could not find image file #1 for XeTeX}%
1858 \else \gdef\xeteximgext{JPG}%
1860 \else \gdef\xeteximgext{jpeg}%
1862 \else \gdef\xeteximgext{jpg}%
1864 \else \gdef\xeteximgext{png}%
1866 \else \gdef\xeteximgext{PDF}%
1868 \else \gdef\xeteximgext{pdf}%
1870 \closein 1
1871 \endgroup
1873 % Putting an \hbox around the image can prevent an over-long line
1874 % after the image.
1875 \hbox\bgroup
1876 \def\xetexpdfext{pdf}%
1877 \ifx\xeteximgext\xetexpdfext
1878 \XeTeXpdffile "#1".\xeteximgext ""
1879 \else
1880 \def\xetexpdfext{PDF}%
1881 \ifx\xeteximgext\xetexpdfext
1882 \XeTeXpdffile "#1".\xeteximgext ""
1883 \else
1884 \XeTeXpicfile "#1".\xeteximgext ""
1887 \ifdim \wd0 >0pt width \xeteximagewidth \fi
1888 \ifdim \wd2 >0pt height \xeteximageheight \fi \relax
1889 \egroup
1895 \message{fonts,}
1897 % Set the baselineskip to #1, and the lineskip and strut size
1898 % correspondingly. There is no deep meaning behind these magic numbers
1899 % used as factors; they just match (closely enough) what Knuth defined.
1901 \def\lineskipfactor{.08333}
1902 \def\strutheightpercent{.70833}
1903 \def\strutdepthpercent {.29167}
1905 % can get a sort of poor man's double spacing by redefining this.
1906 \def\baselinefactor{1}
1908 \newdimen\textleading
1909 \def\setleading#1{%
1910 \dimen0 = #1\relax
1911 \normalbaselineskip = \baselinefactor\dimen0
1912 \normallineskip = \lineskipfactor\normalbaselineskip
1913 \normalbaselines
1914 \setbox\strutbox =\hbox{%
1915 \vrule width0pt height\strutheightpercent\baselineskip
1916 depth \strutdepthpercent \baselineskip
1920 % PDF CMaps. See also LaTeX's t1.cmap.
1922 % do nothing with this by default.
1923 \expandafter\let\csname cmapOT1\endcsname\gobble
1924 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1925 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1927 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1928 % (\pdffontattr was introduced many years ago, but people still run
1929 % older pdftex's; it's easy to conditionalize, so we do.)
1930 \ifpdf \ifx\pdffontattr\thisisundefined \else
1931 \begingroup
1932 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1933 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1934 %%DocumentNeededResources: ProcSet (CIDInit)
1935 %%IncludeResource: ProcSet (CIDInit)
1936 %%BeginResource: CMap (TeX-OT1-0)
1937 %%Title: (TeX-OT1-0 TeX OT1 0)
1938 %%Version: 1.000
1939 %%EndComments
1940 /CIDInit /ProcSet findresource begin
1941 12 dict begin
1942 begincmap
1943 /CIDSystemInfo
1944 << /Registry (TeX)
1945 /Ordering (OT1)
1946 /Supplement 0
1947 >> def
1948 /CMapName /TeX-OT1-0 def
1949 /CMapType 2 def
1950 1 begincodespacerange
1951 <00> <7F>
1952 endcodespacerange
1953 8 beginbfrange
1954 <00> <01> <0393>
1955 <09> <0A> <03A8>
1956 <23> <26> <0023>
1957 <28> <3B> <0028>
1958 <3F> <5B> <003F>
1959 <5D> <5E> <005D>
1960 <61> <7A> <0061>
1961 <7B> <7C> <2013>
1962 endbfrange
1963 40 beginbfchar
1964 <02> <0398>
1965 <03> <039B>
1966 <04> <039E>
1967 <05> <03A0>
1968 <06> <03A3>
1969 <07> <03D2>
1970 <08> <03A6>
1971 <0B> <00660066>
1972 <0C> <00660069>
1973 <0D> <0066006C>
1974 <0E> <006600660069>
1975 <0F> <00660066006C>
1976 <10> <0131>
1977 <11> <0237>
1978 <12> <0060>
1979 <13> <00B4>
1980 <14> <02C7>
1981 <15> <02D8>
1982 <16> <00AF>
1983 <17> <02DA>
1984 <18> <00B8>
1985 <19> <00DF>
1986 <1A> <00E6>
1987 <1B> <0153>
1988 <1C> <00F8>
1989 <1D> <00C6>
1990 <1E> <0152>
1991 <1F> <00D8>
1992 <21> <0021>
1993 <22> <201D>
1994 <27> <2019>
1995 <3C> <00A1>
1996 <3D> <003D>
1997 <3E> <00BF>
1998 <5C> <201C>
1999 <5F> <02D9>
2000 <60> <2018>
2001 <7D> <02DD>
2002 <7E> <007E>
2003 <7F> <00A8>
2004 endbfchar
2005 endcmap
2006 CMapName currentdict /CMap defineresource pop
2009 %%EndResource
2010 %%EOF
2011 }\endgroup
2012 \expandafter\edef\csname cmapOT1\endcsname#1{%
2013 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
2016 % \cmapOT1IT
2017 \begingroup
2018 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
2019 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
2020 %%DocumentNeededResources: ProcSet (CIDInit)
2021 %%IncludeResource: ProcSet (CIDInit)
2022 %%BeginResource: CMap (TeX-OT1IT-0)
2023 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
2024 %%Version: 1.000
2025 %%EndComments
2026 /CIDInit /ProcSet findresource begin
2027 12 dict begin
2028 begincmap
2029 /CIDSystemInfo
2030 << /Registry (TeX)
2031 /Ordering (OT1IT)
2032 /Supplement 0
2033 >> def
2034 /CMapName /TeX-OT1IT-0 def
2035 /CMapType 2 def
2036 1 begincodespacerange
2037 <00> <7F>
2038 endcodespacerange
2039 8 beginbfrange
2040 <00> <01> <0393>
2041 <09> <0A> <03A8>
2042 <25> <26> <0025>
2043 <28> <3B> <0028>
2044 <3F> <5B> <003F>
2045 <5D> <5E> <005D>
2046 <61> <7A> <0061>
2047 <7B> <7C> <2013>
2048 endbfrange
2049 42 beginbfchar
2050 <02> <0398>
2051 <03> <039B>
2052 <04> <039E>
2053 <05> <03A0>
2054 <06> <03A3>
2055 <07> <03D2>
2056 <08> <03A6>
2057 <0B> <00660066>
2058 <0C> <00660069>
2059 <0D> <0066006C>
2060 <0E> <006600660069>
2061 <0F> <00660066006C>
2062 <10> <0131>
2063 <11> <0237>
2064 <12> <0060>
2065 <13> <00B4>
2066 <14> <02C7>
2067 <15> <02D8>
2068 <16> <00AF>
2069 <17> <02DA>
2070 <18> <00B8>
2071 <19> <00DF>
2072 <1A> <00E6>
2073 <1B> <0153>
2074 <1C> <00F8>
2075 <1D> <00C6>
2076 <1E> <0152>
2077 <1F> <00D8>
2078 <21> <0021>
2079 <22> <201D>
2080 <23> <0023>
2081 <24> <00A3>
2082 <27> <2019>
2083 <3C> <00A1>
2084 <3D> <003D>
2085 <3E> <00BF>
2086 <5C> <201C>
2087 <5F> <02D9>
2088 <60> <2018>
2089 <7D> <02DD>
2090 <7E> <007E>
2091 <7F> <00A8>
2092 endbfchar
2093 endcmap
2094 CMapName currentdict /CMap defineresource pop
2097 %%EndResource
2098 %%EOF
2099 }\endgroup
2100 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
2101 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
2104 % \cmapOT1TT
2105 \begingroup
2106 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
2107 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
2108 %%DocumentNeededResources: ProcSet (CIDInit)
2109 %%IncludeResource: ProcSet (CIDInit)
2110 %%BeginResource: CMap (TeX-OT1TT-0)
2111 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
2112 %%Version: 1.000
2113 %%EndComments
2114 /CIDInit /ProcSet findresource begin
2115 12 dict begin
2116 begincmap
2117 /CIDSystemInfo
2118 << /Registry (TeX)
2119 /Ordering (OT1TT)
2120 /Supplement 0
2121 >> def
2122 /CMapName /TeX-OT1TT-0 def
2123 /CMapType 2 def
2124 1 begincodespacerange
2125 <00> <7F>
2126 endcodespacerange
2127 5 beginbfrange
2128 <00> <01> <0393>
2129 <09> <0A> <03A8>
2130 <21> <26> <0021>
2131 <28> <5F> <0028>
2132 <61> <7E> <0061>
2133 endbfrange
2134 32 beginbfchar
2135 <02> <0398>
2136 <03> <039B>
2137 <04> <039E>
2138 <05> <03A0>
2139 <06> <03A3>
2140 <07> <03D2>
2141 <08> <03A6>
2142 <0B> <2191>
2143 <0C> <2193>
2144 <0D> <0027>
2145 <0E> <00A1>
2146 <0F> <00BF>
2147 <10> <0131>
2148 <11> <0237>
2149 <12> <0060>
2150 <13> <00B4>
2151 <14> <02C7>
2152 <15> <02D8>
2153 <16> <00AF>
2154 <17> <02DA>
2155 <18> <00B8>
2156 <19> <00DF>
2157 <1A> <00E6>
2158 <1B> <0153>
2159 <1C> <00F8>
2160 <1D> <00C6>
2161 <1E> <0152>
2162 <1F> <00D8>
2163 <20> <2423>
2164 <27> <2019>
2165 <60> <2018>
2166 <7F> <00A8>
2167 endbfchar
2168 endcmap
2169 CMapName currentdict /CMap defineresource pop
2172 %%EndResource
2173 %%EOF
2174 }\endgroup
2175 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
2176 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
2178 \fi\fi
2181 % Set the font macro #1 to the font named \fontprefix#2.
2182 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
2183 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
2184 % Example:
2185 % #1 = \textrm
2186 % #2 = \rmshape
2187 % #3 = 10
2188 % #4 = \mainmagstep
2189 % #5 = OT1
2191 \def\setfont#1#2#3#4#5{%
2192 \font#1=\fontprefix#2#3 scaled #4
2193 \csname cmap#5\endcsname#1%
2195 % This is what gets called when #5 of \setfont is empty.
2196 \let\cmap\gobble
2198 % (end of cmaps)
2200 % Use cm as the default font prefix.
2201 % To specify the font prefix, you must define \fontprefix
2202 % before you read in texinfo.tex.
2203 \ifx\fontprefix\thisisundefined
2204 \def\fontprefix{cm}
2206 % Support font families that don't use the same naming scheme as CM.
2207 \def\rmshape{r}
2208 \def\rmbshape{bx} % where the normal face is bold
2209 \def\bfshape{b}
2210 \def\bxshape{bx}
2211 \def\ttshape{tt}
2212 \def\ttbshape{tt}
2213 \def\ttslshape{sltt}
2214 \def\itshape{ti}
2215 \def\itbshape{bxti}
2216 \def\slshape{sl}
2217 \def\slbshape{bxsl}
2218 \def\sfshape{ss}
2219 \def\sfbshape{ss}
2220 \def\scshape{csc}
2221 \def\scbshape{csc}
2223 % Definitions for a main text size of 11pt. (The default in Texinfo.)
2225 \def\definetextfontsizexi{%
2226 % Text fonts (11.2pt, magstep1).
2227 \def\textnominalsize{11pt}
2228 \edef\mainmagstep{\magstephalf}
2229 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2230 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2231 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2232 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2233 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2234 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2235 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2236 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2237 \font\texti=cmmi10 scaled \mainmagstep
2238 \font\textsy=cmsy10 scaled \mainmagstep
2239 \def\textecsize{1095}
2241 % A few fonts for @defun names and args.
2242 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
2243 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
2244 \setfont\defsl\slshape{10}{\magstep1}{OT1}
2245 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
2246 \def\df{\let\ttfont=\deftt \let\bffont = \defbf
2247 \let\ttslfont=\defttsl \let\slfont=\defsl \bf}
2249 % Fonts for indices, footnotes, small examples (9pt).
2250 \def\smallnominalsize{9pt}
2251 \setfont\smallrm\rmshape{9}{1000}{OT1}
2252 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2253 \setfont\smallbf\bfshape{10}{900}{OT1}
2254 \setfont\smallit\itshape{9}{1000}{OT1IT}
2255 \setfont\smallsl\slshape{9}{1000}{OT1}
2256 \setfont\smallsf\sfshape{9}{1000}{OT1}
2257 \setfont\smallsc\scshape{10}{900}{OT1}
2258 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2259 \font\smalli=cmmi9
2260 \font\smallsy=cmsy9
2261 \def\smallecsize{0900}
2263 % Fonts for small examples (8pt).
2264 \def\smallernominalsize{8pt}
2265 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2266 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2267 \setfont\smallerbf\bfshape{10}{800}{OT1}
2268 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2269 \setfont\smallersl\slshape{8}{1000}{OT1}
2270 \setfont\smallersf\sfshape{8}{1000}{OT1}
2271 \setfont\smallersc\scshape{10}{800}{OT1}
2272 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2273 \font\smalleri=cmmi8
2274 \font\smallersy=cmsy8
2275 \def\smallerecsize{0800}
2277 % Fonts for math mode superscripts (7pt).
2278 \def\sevennominalsize{7pt}
2279 \setfont\sevenrm\rmshape{7}{1000}{OT1}
2280 \setfont\seventt\ttshape{10}{700}{OT1TT}
2281 \setfont\sevenbf\bfshape{10}{700}{OT1}
2282 \setfont\sevenit\itshape{7}{1000}{OT1IT}
2283 \setfont\sevensl\slshape{10}{700}{OT1}
2284 \setfont\sevensf\sfshape{10}{700}{OT1}
2285 \setfont\sevensc\scshape{10}{700}{OT1}
2286 \setfont\seventtsl\ttslshape{10}{700}{OT1TT}
2287 \font\seveni=cmmi7
2288 \font\sevensy=cmsy7
2289 \def\sevenecsize{0700}
2291 % Fonts for title page (20.4pt):
2292 \def\titlenominalsize{20pt}
2293 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2294 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2295 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2296 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2297 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2298 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2299 \let\titlebf=\titlerm
2300 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2301 \font\titlei=cmmi12 scaled \magstep3
2302 \font\titlesy=cmsy10 scaled \magstep4
2303 \def\titleecsize{2074}
2305 % Chapter (and unnumbered) fonts (17.28pt).
2306 \def\chapnominalsize{17pt}
2307 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
2308 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
2309 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
2310 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
2311 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2312 \setfont\chapsf\sfbshape{17}{1000}{OT1}
2313 \let\chapbf=\chaprm
2314 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
2315 \font\chapi=cmmi12 scaled \magstep2
2316 \font\chapsy=cmsy10 scaled \magstep3
2317 \def\chapecsize{1728}
2319 % Section fonts (14.4pt).
2320 \def\secnominalsize{14pt}
2321 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
2322 \setfont\secrmnotbold\rmshape{12}{\magstep1}{OT1}
2323 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
2324 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
2325 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
2326 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2327 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
2328 \let\secbf\secrm
2329 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
2330 \font\seci=cmmi12 scaled \magstep1
2331 \font\secsy=cmsy10 scaled \magstep2
2332 \def\sececsize{1440}
2334 % Subsection fonts (13.15pt).
2335 \def\ssecnominalsize{13pt}
2336 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
2337 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
2338 \setfont\ssecsl\slbshape{10}{1315}{OT1}
2339 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
2340 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2341 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
2342 \let\ssecbf\ssecrm
2343 \setfont\ssecsc\scbshape{10}{1315}{OT1}
2344 \font\sseci=cmmi12 scaled \magstephalf
2345 \font\ssecsy=cmsy10 scaled 1315
2346 \def\ssececsize{1200}
2348 % Reduced fonts for @acronym in text (10pt).
2349 \def\reducednominalsize{10pt}
2350 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2351 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2352 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2353 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2354 \setfont\reducedsl\slshape{10}{1000}{OT1}
2355 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2356 \setfont\reducedsc\scshape{10}{1000}{OT1}
2357 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2358 \font\reducedi=cmmi10
2359 \font\reducedsy=cmsy10
2360 \def\reducedecsize{1000}
2362 \textleading = 13.2pt % line spacing for 11pt CM
2363 \textfonts % reset the current fonts
2365 } % end of 11pt text font size definitions, \definetextfontsizexi
2368 % Definitions to make the main text be 10pt Computer Modern, with
2369 % section, chapter, etc., sizes following suit. This is for the GNU
2370 % Press printing of the Emacs 22 manual. Maybe other manuals in the
2371 % future. Used with @smallbook, which sets the leading to 12pt.
2373 \def\definetextfontsizex{%
2374 % Text fonts (10pt).
2375 \def\textnominalsize{10pt}
2376 \edef\mainmagstep{1000}
2377 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2378 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2379 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2380 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2381 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2382 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2383 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2384 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2385 \font\texti=cmmi10 scaled \mainmagstep
2386 \font\textsy=cmsy10 scaled \mainmagstep
2387 \def\textecsize{1000}
2389 % A few fonts for @defun names and args.
2390 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2391 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2392 \setfont\defsl\slshape{10}{\magstephalf}{OT1}
2393 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2394 \def\df{\let\ttfont=\deftt \let\bffont = \defbf
2395 \let\slfont=\defsl \let\ttslfont=\defttsl \bf}
2397 % Fonts for indices, footnotes, small examples (9pt).
2398 \def\smallnominalsize{9pt}
2399 \setfont\smallrm\rmshape{9}{1000}{OT1}
2400 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2401 \setfont\smallbf\bfshape{10}{900}{OT1}
2402 \setfont\smallit\itshape{9}{1000}{OT1IT}
2403 \setfont\smallsl\slshape{9}{1000}{OT1}
2404 \setfont\smallsf\sfshape{9}{1000}{OT1}
2405 \setfont\smallsc\scshape{10}{900}{OT1}
2406 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2407 \font\smalli=cmmi9
2408 \font\smallsy=cmsy9
2409 \def\smallecsize{0900}
2411 % Fonts for small examples (8pt).
2412 \def\smallernominalsize{8pt}
2413 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2414 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2415 \setfont\smallerbf\bfshape{10}{800}{OT1}
2416 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2417 \setfont\smallersl\slshape{8}{1000}{OT1}
2418 \setfont\smallersf\sfshape{8}{1000}{OT1}
2419 \setfont\smallersc\scshape{10}{800}{OT1}
2420 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2421 \font\smalleri=cmmi8
2422 \font\smallersy=cmsy8
2423 \def\smallerecsize{0800}
2425 % Fonts for math mode superscripts (7pt).
2426 \def\sevennominalsize{7pt}
2427 \setfont\sevenrm\rmshape{7}{1000}{OT1}
2428 \setfont\seventt\ttshape{10}{700}{OT1TT}
2429 \setfont\sevenbf\bfshape{10}{700}{OT1}
2430 \setfont\sevenit\itshape{7}{1000}{OT1IT}
2431 \setfont\sevensl\slshape{10}{700}{OT1}
2432 \setfont\sevensf\sfshape{10}{700}{OT1}
2433 \setfont\sevensc\scshape{10}{700}{OT1}
2434 \setfont\seventtsl\ttslshape{10}{700}{OT1TT}
2435 \font\seveni=cmmi7
2436 \font\sevensy=cmsy7
2437 \def\sevenecsize{0700}
2439 % Fonts for title page (20.4pt):
2440 \def\titlenominalsize{20pt}
2441 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2442 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2443 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2444 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2445 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2446 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2447 \let\titlebf=\titlerm
2448 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2449 \font\titlei=cmmi12 scaled \magstep3
2450 \font\titlesy=cmsy10 scaled \magstep4
2451 \def\titleecsize{2074}
2453 % Chapter fonts (14.4pt).
2454 \def\chapnominalsize{14pt}
2455 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2456 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2457 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2458 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2459 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2460 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2461 \let\chapbf\chaprm
2462 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2463 \font\chapi=cmmi12 scaled \magstep1
2464 \font\chapsy=cmsy10 scaled \magstep2
2465 \def\chapecsize{1440}
2467 % Section fonts (12pt).
2468 \def\secnominalsize{12pt}
2469 \setfont\secrm\rmbshape{12}{1000}{OT1}
2470 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2471 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2472 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2473 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2474 \setfont\secsf\sfbshape{12}{1000}{OT1}
2475 \let\secbf\secrm
2476 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2477 \font\seci=cmmi12
2478 \font\secsy=cmsy10 scaled \magstep1
2479 \def\sececsize{1200}
2481 % Subsection fonts (10pt).
2482 \def\ssecnominalsize{10pt}
2483 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2484 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2485 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2486 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2487 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2488 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2489 \let\ssecbf\ssecrm
2490 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2491 \font\sseci=cmmi10
2492 \font\ssecsy=cmsy10
2493 \def\ssececsize{1000}
2495 % Reduced fonts for @acronym in text (9pt).
2496 \def\reducednominalsize{9pt}
2497 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2498 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2499 \setfont\reducedbf\bfshape{10}{900}{OT1}
2500 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2501 \setfont\reducedsl\slshape{9}{1000}{OT1}
2502 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2503 \setfont\reducedsc\scshape{10}{900}{OT1}
2504 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2505 \font\reducedi=cmmi9
2506 \font\reducedsy=cmsy9
2507 \def\reducedecsize{0900}
2509 \divide\parskip by 2 % reduce space between paragraphs
2510 \textleading = 12pt % line spacing for 10pt CM
2511 \textfonts % reset the current fonts
2513 } % end of 10pt text font size definitions, \definetextfontsizex
2515 % Fonts for short table of contents.
2516 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2517 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2518 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2519 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2522 % We provide the user-level command
2523 % @fonttextsize 10
2524 % (or 11) to redefine the text font size. pt is assumed.
2526 \def\xiword{11}
2527 \def\xword{10}
2528 \def\xwordpt{10pt}
2530 \parseargdef\fonttextsize{%
2531 \def\textsizearg{#1}%
2532 %\wlog{doing @fonttextsize \textsizearg}%
2534 % Set \globaldefs so that documents can use this inside @tex, since
2535 % makeinfo 4.8 does not support it, but we need it nonetheless.
2537 \begingroup \globaldefs=1
2538 \ifx\textsizearg\xword \definetextfontsizex
2539 \else \ifx\textsizearg\xiword \definetextfontsizexi
2540 \else
2541 \errhelp=\EMsimple
2542 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2543 \fi\fi
2544 \endgroup
2548 % Change the current font style to #1, remembering it in \curfontstyle.
2549 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
2550 % italics, not bold italics.
2552 \def\setfontstyle#1{%
2553 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
2554 \csname #1font\endcsname % change the current font
2557 \def\rm{\fam=0 \setfontstyle{rm}}
2558 \def\it{\fam=\itfam \setfontstyle{it}}
2559 \def\sl{\fam=\slfam \setfontstyle{sl}}
2560 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
2561 \def\tt{\fam=\ttfam \setfontstyle{tt}}\def\ttstylename{tt}
2563 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
2564 % So we set up a \sf.
2565 \newfam\sffam
2566 \def\sf{\fam=\sffam \setfontstyle{sf}}
2568 % We don't need math for this font style.
2569 \def\ttsl{\setfontstyle{ttsl}}
2572 % In order for the font changes to affect most math symbols and letters,
2573 % we have to define the \textfont of the standard families.
2574 % We don't bother to reset \scriptscriptfont; awaiting user need.
2576 \def\resetmathfonts{%
2577 \textfont0=\rmfont \textfont1=\ifont \textfont2=\syfont
2578 \textfont\itfam=\itfont \textfont\slfam=\slfont \textfont\bffam=\bffont
2579 \textfont\ttfam=\ttfont \textfont\sffam=\sffont
2581 % Fonts for superscript. Note that the 7pt fonts are used regardless
2582 % of the current font size.
2583 \scriptfont0=\sevenrm \scriptfont1=\seveni \scriptfont2=\sevensy
2584 \scriptfont\itfam=\sevenit \scriptfont\slfam=\sevensl
2585 \scriptfont\bffam=\sevenbf \scriptfont\ttfam=\seventt
2586 \scriptfont\sffam=\sevensf
2591 % The font-changing commands (all called \...fonts) redefine the meanings
2592 % of \STYLEfont, instead of just \STYLE. We do this because \STYLE needs
2593 % to also set the current \fam for math mode. Our \STYLE (e.g., \rm)
2594 % commands hardwire \STYLEfont to set the current font.
2596 % The fonts used for \ifont are for "math italics" (\itfont is for italics
2597 % in regular text). \syfont is also used in math mode only.
2599 % Each font-changing command also sets the names \lsize (one size lower)
2600 % and \lllsize (three sizes lower). These relative commands are used
2601 % in, e.g., the LaTeX logo and acronyms.
2603 % This all needs generalizing, badly.
2606 \def\assignfonts#1{%
2607 \expandafter\let\expandafter\rmfont\csname #1rm\endcsname
2608 \expandafter\let\expandafter\itfont\csname #1it\endcsname
2609 \expandafter\let\expandafter\slfont\csname #1sl\endcsname
2610 \expandafter\let\expandafter\bffont\csname #1bf\endcsname
2611 \expandafter\let\expandafter\ttfont\csname #1tt\endcsname
2612 \expandafter\let\expandafter\smallcaps\csname #1sc\endcsname
2613 \expandafter\let\expandafter\sffont \csname #1sf\endcsname
2614 \expandafter\let\expandafter\ifont \csname #1i\endcsname
2615 \expandafter\let\expandafter\syfont \csname #1sy\endcsname
2616 \expandafter\let\expandafter\ttslfont\csname #1ttsl\endcsname
2619 \newif\ifrmisbold
2621 % Select smaller font size with the current style. Used to change font size
2622 % in, e.g., the LaTeX logo and acronyms. If we are using bold fonts for
2623 % normal roman text, also use bold fonts for roman text in the smaller size.
2624 \def\switchtolllsize{%
2625 \expandafter\assignfonts\expandafter{\lllsize}%
2626 \ifrmisbold
2627 \let\rmfont\bffont
2629 \csname\curfontstyle\endcsname
2632 \def\switchtolsize{%
2633 \expandafter\assignfonts\expandafter{\lsize}%
2634 \ifrmisbold
2635 \let\rmfont\bffont
2637 \csname\curfontstyle\endcsname
2640 \def\definefontsetatsize#1#2#3#4#5{%
2641 \expandafter\def\csname #1fonts\endcsname{%
2642 \def\curfontsize{#1}%
2643 \def\lsize{#2}\def\lllsize{#3}%
2644 \csname rmisbold#5\endcsname
2645 \assignfonts{#1}%
2646 \resetmathfonts
2647 \setleading{#4}%
2650 \definefontsetatsize{text} {reduced}{smaller}{\textleading}{false}
2651 \definefontsetatsize{title} {chap} {subsec} {27pt} {true}
2652 \definefontsetatsize{chap} {sec} {text} {19pt} {true}
2653 \definefontsetatsize{sec} {subsec} {reduced}{17pt} {true}
2654 \definefontsetatsize{ssec} {text} {small} {15pt} {true}
2655 \definefontsetatsize{reduced}{small} {smaller}{10.5pt}{false}
2656 \definefontsetatsize{small} {smaller}{smaller}{10.5pt}{false}
2657 \definefontsetatsize{smaller}{smaller}{smaller}{9.5pt} {false}
2659 \def\titlefont#1{{\titlefonts\rm #1}}
2660 \let\subsecfonts = \ssecfonts
2661 \let\subsubsecfonts = \ssecfonts
2663 % Define these just so they can be easily changed for other fonts.
2664 \def\angleleft{$\langle$}
2665 \def\angleright{$\rangle$}
2667 % Set the fonts to use with the @small... environments.
2668 \let\smallexamplefonts = \smallfonts
2670 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2671 % can fit this many characters:
2672 % 8.5x11=86 smallbook=72 a4=90 a5=69
2673 % If we use \scriptfonts (8pt), then we can fit this many characters:
2674 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2675 % For me, subjectively, the few extra characters that fit aren't worth
2676 % the additional smallness of 8pt. So I'm making the default 9pt.
2678 % By the way, for comparison, here's what fits with @example (10pt):
2679 % 8.5x11=71 smallbook=60 a4=75 a5=58
2680 % --karl, 24jan03.
2682 % Set up the default fonts, so we can use them for creating boxes.
2684 \definetextfontsizexi
2687 % Check if we are currently using a typewriter font. Since all the
2688 % Computer Modern typewriter fonts have zero interword stretch (and
2689 % shrink), and it is reasonable to expect all typewriter fonts to have
2690 % this property, we can check that font parameter.
2692 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2695 \catcode`\'=\active
2696 \catcode`\`=\active
2698 \gdef\setcodequotes{\let`\codequoteleft \let'\codequoteright}
2699 \gdef\setregularquotes{\let`\lq \let'\rq}
2702 % Allow an option to not use regular directed right quote/apostrophe
2703 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2704 % The undirected quote is ugly, so don't make it the default, but it
2705 % works for pasting with more pdf viewers (at least evince), the
2706 % lilypond developers report. xpdf does work with the regular 0x27.
2708 \def\codequoteright{%
2709 \ifmonospace
2710 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2711 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2713 \else \char'15 \fi
2714 \else \char'15 \fi
2715 \else
2720 % and a similar option for the left quote char vs. a grave accent.
2721 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2722 % the code environments to do likewise.
2724 \def\codequoteleft{%
2725 \ifmonospace
2726 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2727 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2728 % [Knuth] pp. 380,381,391
2729 % \relax disables Spanish ligatures ?` and !` of \tt font.
2730 \relax`%
2731 \else \char'22 \fi
2732 \else \char'22 \fi
2733 \else
2734 \relax`%
2738 % Commands to set the quote options.
2740 \parseargdef\codequoteundirected{%
2741 \def\temp{#1}%
2742 \ifx\temp\onword
2743 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2744 = t%
2745 \else\ifx\temp\offword
2746 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2747 = \relax
2748 \else
2749 \errhelp = \EMsimple
2750 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2751 \fi\fi
2754 \parseargdef\codequotebacktick{%
2755 \def\temp{#1}%
2756 \ifx\temp\onword
2757 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2758 = t%
2759 \else\ifx\temp\offword
2760 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2761 = \relax
2762 \else
2763 \errhelp = \EMsimple
2764 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2765 \fi\fi
2768 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2769 \def\noligaturesquoteleft{\relax\lq}
2771 % Count depth in font-changes, for error checks
2772 \newcount\fontdepth \fontdepth=0
2774 % Font commands.
2776 % #1 is the font command (\sl or \it), #2 is the text to slant.
2777 % If we are in a monospaced environment, however, 1) always use \ttsl,
2778 % and 2) do not add an italic correction.
2779 \def\dosmartslant#1#2{%
2780 \ifusingtt
2781 {{\ttsl #2}\let\next=\relax}%
2782 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2783 \next
2785 \def\smartslanted{\dosmartslant\sl}
2786 \def\smartitalic{\dosmartslant\it}
2788 % Output an italic correction unless \next (presumed to be the following
2789 % character) is such as not to need one.
2790 \def\smartitaliccorrection{%
2791 \ifx\next,%
2792 \else\ifx\next-%
2793 \else\ifx\next.%
2794 \else\ifx\next\.%
2795 \else\ifx\next\comma%
2796 \else\ptexslash
2797 \fi\fi\fi\fi\fi
2798 \aftersmartic
2801 % Unconditional use \ttsl, and no ic. @var is set to this for defuns.
2802 \def\ttslanted#1{{\ttsl #1}}
2804 % @cite is like \smartslanted except unconditionally use \sl. We never want
2805 % ttsl for book titles, do we?
2806 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2808 \def\aftersmartic{}
2809 \def\var#1{%
2810 \let\saveaftersmartic = \aftersmartic
2811 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2812 \smartslanted{#1}%
2815 \let\i=\smartitalic
2816 \let\slanted=\smartslanted
2817 \let\dfn=\smartslanted
2818 \let\emph=\smartitalic
2820 % Explicit font changes: @r, @sc, undocumented @ii.
2821 \def\r#1{{\rm #1}} % roman font
2822 \def\sc#1{{\smallcaps#1}} % smallcaps font
2823 \def\ii#1{{\it #1}} % italic font
2825 % @b, explicit bold. Also @strong.
2826 \def\b#1{{\bf #1}}
2827 \let\strong=\b
2829 % @sansserif, explicit sans.
2830 \def\sansserif#1{{\sf #1}}
2832 % We can't just use \exhyphenpenalty, because that only has effect at
2833 % the end of a paragraph. Restore normal hyphenation at the end of the
2834 % group within which \nohyphenation is presumably called.
2836 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2837 \def\restorehyphenation{\hyphenchar\font = `- }
2839 % Set sfcode to normal for the chars that usually have another value.
2840 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2841 % sometimes \x has an active definition that messes things up.
2843 \catcode`@=11
2844 \def\plainfrenchspacing{%
2845 \sfcode`\.=\@m \sfcode`\?=\@m \sfcode`\!=\@m
2846 \sfcode`\:=\@m \sfcode`\;=\@m \sfcode`\,=\@m
2847 \def\endofsentencespacefactor{1000}% for @. and friends
2849 \def\plainnonfrenchspacing{%
2850 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2851 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2852 \def\endofsentencespacefactor{3000}% for @. and friends
2854 \catcode`@=\other
2855 \def\endofsentencespacefactor{3000}% default
2857 % @t, explicit typewriter.
2858 \def\t#1{%
2859 {\tt \plainfrenchspacing #1}%
2860 \null
2863 % @samp.
2864 \def\samp#1{{\setcodequotes\lq\tclose{#1}\rq\null}}
2866 % @indicateurl is \samp, that is, with quotes.
2867 \let\indicateurl=\samp
2869 % @code (and similar) prints in typewriter, but with spaces the same
2870 % size as normal in the surrounding text, without hyphenation, etc.
2871 % This is a subroutine for that.
2872 \def\tclose#1{%
2874 % Change normal interword space to be same as for the current font.
2875 \spaceskip = \fontdimen2\font
2877 % Switch to typewriter.
2880 % But `\ ' produces the large typewriter interword space.
2881 \def\ {{\spaceskip = 0pt{} }}%
2883 % Turn off hyphenation.
2884 \nohyphenation
2886 \plainfrenchspacing
2889 \null % reset spacefactor to 1000
2892 % We *must* turn on hyphenation at `-' and `_' in @code.
2893 % (But see \codedashfinish below.)
2894 % Otherwise, it is too hard to avoid overfull hboxes
2895 % in the Emacs manual, the Library manual, etc.
2897 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2898 % both hyphenation at - and hyphenation within words.
2899 % We must therefore turn them both off (\tclose does that)
2900 % and arrange explicitly to hyphenate at a dash. -- rms.
2902 \catcode`\-=\active \catcode`\_=\active
2903 \catcode`\'=\active \catcode`\`=\active
2904 \global\let'=\rq \global\let`=\lq % default definitions
2906 \global\def\code{\begingroup
2907 \setcodequotes
2908 \catcode\dashChar=\active \catcode\underChar=\active
2909 \ifallowcodebreaks
2910 \let-\codedash
2911 \let_\codeunder
2912 \else
2913 \let-\normaldash
2914 \let_\realunder
2916 % Given -foo (with a single dash), we do not want to allow a break
2917 % after the hyphen.
2918 \global\let\codedashprev=\codedash
2920 \codex
2923 \gdef\codedash{\futurelet\next\codedashfinish}
2924 \gdef\codedashfinish{%
2925 \normaldash % always output the dash character itself.
2927 % Now, output a discretionary to allow a line break, unless
2928 % (a) the next character is a -, or
2929 % (b) the preceding character is a -.
2930 % E.g., given --posix, we do not want to allow a break after either -.
2931 % Given --foo-bar, we do want to allow a break between the - and the b.
2932 \ifx\next\codedash \else
2933 \ifx\codedashprev\codedash
2934 \else \discretionary{}{}{}\fi
2936 % we need the space after the = for the case when \next itself is a
2937 % space token; it would get swallowed otherwise. As in @code{- a}.
2938 \global\let\codedashprev= \next
2941 \def\normaldash{-}
2943 \def\codex #1{\tclose{#1}\endgroup}
2945 \def\codeunder{%
2946 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2947 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2948 % will therefore expand the active definition of _, which is us
2949 % (inside @code that is), therefore an endless loop.
2950 \ifusingtt{\ifmmode
2951 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2952 \else\normalunderscore \fi
2953 \discretionary{}{}{}}%
2954 {\_}%
2957 % An additional complication: the above will allow breaks after, e.g.,
2958 % each of the four underscores in __typeof__. This is bad.
2959 % @allowcodebreaks provides a document-level way to turn breaking at -
2960 % and _ on and off.
2962 \newif\ifallowcodebreaks \allowcodebreakstrue
2964 \def\keywordtrue{true}
2965 \def\keywordfalse{false}
2967 \parseargdef\allowcodebreaks{%
2968 \def\txiarg{#1}%
2969 \ifx\txiarg\keywordtrue
2970 \allowcodebreakstrue
2971 \else\ifx\txiarg\keywordfalse
2972 \allowcodebreaksfalse
2973 \else
2974 \errhelp = \EMsimple
2975 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2976 \fi\fi
2979 % For @command, @env, @file, @option quotes seem unnecessary,
2980 % so use \code rather than \samp.
2981 \let\command=\code
2982 \let\env=\code
2983 \let\file=\code
2984 \let\option=\code
2986 % @uref (abbreviation for `urlref') aka @url takes an optional
2987 % (comma-separated) second argument specifying the text to display and
2988 % an optional third arg as text to display instead of (rather than in
2989 % addition to) the url itself. First (mandatory) arg is the url.
2991 % TeX-only option to allow changing PDF output to show only the second
2992 % arg (if given), and not the url (which is then just the link target).
2993 \newif\ifurefurlonlylink
2995 % The default \pretolerance setting stops the penalty inserted in
2996 % \urefallowbreak being a discouragement to line breaking. Set it to
2997 % a negative value for this paragraph only. Hopefully this does not
2998 % conflict with redefinitions of \par done elsewhere.
2999 \def\nopretolerance{%
3000 \pretolerance=-1
3001 \def\par{\endgraf\pretolerance=100 \let\par\endgraf}%
3004 % The main macro is \urefbreak, which allows breaking at expected
3005 % places within the url.
3006 \def\urefbreak{\nopretolerance \begingroup \urefcatcodes \dourefbreak}
3007 \let\uref=\urefbreak
3009 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
3010 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
3011 \unsepspaces
3012 \pdfurl{#1}%
3013 \setbox0 = \hbox{\ignorespaces #3}%
3014 \ifdim\wd0 > 0pt
3015 \unhbox0 % third arg given, show only that
3016 \else
3017 \setbox0 = \hbox{\ignorespaces #2}% look for second arg
3018 \ifdim\wd0 > 0pt
3019 \ifpdf
3020 % For pdfTeX and LuaTeX
3021 \ifurefurlonlylink
3022 % PDF plus option to not display url, show just arg
3023 \unhbox0
3024 \else
3025 % PDF, normally display both arg and url for consistency,
3026 % visibility, if the pdf is eventually used to print, etc.
3027 \unhbox0\ (\urefcode{#1})%
3029 \else
3030 \ifx\XeTeXrevision\thisisundefined
3031 \unhbox0\ (\urefcode{#1})% DVI, always show arg and url
3032 \else
3033 % For XeTeX
3034 \ifurefurlonlylink
3035 % PDF plus option to not display url, show just arg
3036 \unhbox0
3037 \else
3038 % PDF, normally display both arg and url for consistency,
3039 % visibility, if the pdf is eventually used to print, etc.
3040 \unhbox0\ (\urefcode{#1})%
3044 \else
3045 \urefcode{#1}% only url given, so show it
3048 \endlink
3049 \endgroup}
3051 % Allow line breaks around only a few characters (only).
3052 \def\urefcatcodes{%
3053 \catcode`\&=\active \catcode`\.=\active
3054 \catcode`\#=\active \catcode`\?=\active
3055 \catcode`\/=\active
3058 \urefcatcodes
3060 \global\def\urefcode{\begingroup
3061 \setcodequotes
3062 \urefcatcodes
3063 \let&\urefcodeamp
3064 \let.\urefcodedot
3065 \let#\urefcodehash
3066 \let?\urefcodequest
3067 \let/\urefcodeslash
3068 \codex
3071 % By default, they are just regular characters.
3072 \global\def&{\normalamp}
3073 \global\def.{\normaldot}
3074 \global\def#{\normalhash}
3075 \global\def?{\normalquest}
3076 \global\def/{\normalslash}
3079 \def\urefcodeamp{\urefprebreak \&\urefpostbreak}
3080 \def\urefcodedot{\urefprebreak .\urefpostbreak}
3081 \def\urefcodehash{\urefprebreak \#\urefpostbreak}
3082 \def\urefcodequest{\urefprebreak ?\urefpostbreak}
3083 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
3085 \catcode`\/=\active
3086 \global\def\urefcodeslashfinish{%
3087 \urefprebreak \slashChar
3088 % Allow line break only after the final / in a sequence of
3089 % slashes, to avoid line break between the slashes in http://.
3090 \ifx\next/\else \urefpostbreak \fi
3094 % By default we'll break after the special characters, but some people like to
3095 % break before the special chars, so allow that. Also allow no breaking at
3096 % all, for manual control.
3098 \parseargdef\urefbreakstyle{%
3099 \def\txiarg{#1}%
3100 \ifx\txiarg\wordnone
3101 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
3102 \else\ifx\txiarg\wordbefore
3103 \def\urefprebreak{\urefallowbreak}\def\urefpostbreak{\nobreak}
3104 \else\ifx\txiarg\wordafter
3105 \def\urefprebreak{\nobreak}\def\urefpostbreak{\urefallowbreak}
3106 \else
3107 \errhelp = \EMsimple
3108 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
3109 \fi\fi\fi
3111 \def\wordafter{after}
3112 \def\wordbefore{before}
3113 \def\wordnone{none}
3115 % Allow a ragged right output to aid breaking long URL's. There can
3116 % be a break at the \allowbreak with no extra glue (if the existing stretch in
3117 % the line is sufficient), a break at the \penalty with extra glue added
3118 % at the end of the line, or no break at all here.
3119 % Changing the value of the penalty and/or the amount of stretch affects how
3120 % preferable one choice is over the other.
3121 \def\urefallowbreak{%
3122 \penalty0\relax
3123 \hskip 0pt plus 2 em\relax
3124 \penalty1000\relax
3125 \hskip 0pt plus -2 em\relax
3128 \urefbreakstyle after
3130 % @url synonym for @uref, since that's how everyone uses it.
3132 \let\url=\uref
3134 % rms does not like angle brackets --karl, 17may97.
3135 % So now @email is just like @uref, unless we are pdf.
3137 %\def\email#1{\angleleft{\tt #1}\angleright}
3138 \ifpdforxetex
3139 \def\email#1{\doemail#1,,\finish}
3140 \def\doemail#1,#2,#3\finish{\begingroup
3141 \unsepspaces
3142 \pdfurl{mailto:#1}%
3143 \setbox0 = \hbox{\ignorespaces #2}%
3144 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
3145 \endlink
3146 \endgroup}
3147 \else
3148 \let\email=\uref
3151 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
3152 % `example' (@kbd uses ttsl only inside of @example and friends),
3153 % or `code' (@kbd uses normal tty font always).
3154 \parseargdef\kbdinputstyle{%
3155 \def\txiarg{#1}%
3156 \ifx\txiarg\worddistinct
3157 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
3158 \else\ifx\txiarg\wordexample
3159 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
3160 \else\ifx\txiarg\wordcode
3161 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
3162 \else
3163 \errhelp = \EMsimple
3164 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
3165 \fi\fi\fi
3167 \def\worddistinct{distinct}
3168 \def\wordexample{example}
3169 \def\wordcode{code}
3171 % Default is `distinct'.
3172 \kbdinputstyle distinct
3174 \def\kbd#1{%
3175 \tclose{\kbdfont\setcodequotes#1}%
3178 % definition of @key that produces a lozenge. Doesn't adjust to text size.
3179 %\setfont\keyrm\rmshape{8}{1000}{OT1}
3180 %\font\keysy=cmsy9
3181 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
3182 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
3183 % \vbox{\hrule\kern-0.4pt
3184 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
3185 % \kern-0.4pt\hrule}%
3186 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
3188 % definition of @key with no lozenge.
3190 \def\key#1{{\setregularquotes \nohyphenation \tt #1}\null}
3192 % @clicksequence{File @click{} Open ...}
3193 \def\clicksequence#1{\begingroup #1\endgroup}
3195 % @clickstyle @arrow (by default)
3196 \parseargdef\clickstyle{\def\click{#1}}
3197 \def\click{\arrow}
3199 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
3200 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
3202 \def\dmn#1{\thinspace #1}
3204 % @acronym for "FBI", "NATO", and the like.
3205 % We print this one point size smaller, since it's intended for
3206 % all-uppercase.
3208 \def\acronym#1{\doacronym #1,,\finish}
3209 \def\doacronym#1,#2,#3\finish{%
3210 {\switchtolsize #1}%
3211 \def\temp{#2}%
3212 \ifx\temp\empty \else
3213 \space ({\unsepspaces \ignorespaces \temp \unskip})%
3215 \null % reset \spacefactor=1000
3218 % @abbr for "Comput. J." and the like.
3219 % No font change, but don't do end-of-sentence spacing.
3221 \def\abbr#1{\doabbr #1,,\finish}
3222 \def\doabbr#1,#2,#3\finish{%
3223 {\plainfrenchspacing #1}%
3224 \def\temp{#2}%
3225 \ifx\temp\empty \else
3226 \space ({\unsepspaces \ignorespaces \temp \unskip})%
3228 \null % reset \spacefactor=1000
3231 % @asis just yields its argument. Used with @table, for example.
3233 \def\asis#1{#1}
3235 % @math outputs its argument in math mode.
3237 % One complication: _ usually means subscripts, but it could also mean
3238 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
3239 % _ active, and distinguish by seeing if the current family is \slfam,
3240 % which is what @var uses.
3242 \catcode`\_ = \active
3243 \gdef\mathunderscore{%
3244 \catcode`\_=\active
3245 \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
3248 % Another complication: we want \\ (and @\) to output a math (or tt) \.
3249 % FYI, plain.tex uses \\ as a temporary control sequence (for no
3250 % particular reason), but this is not advertised and we don't care.
3252 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
3253 \def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
3255 \def\math{%
3256 \ifmmode\else % only go into math if not in math mode already
3257 \tex
3258 \mathunderscore
3259 \let\\ = \mathbackslash
3260 \mathactive
3261 % make the texinfo accent commands work in math mode
3262 \let\"=\ddot
3263 \let\'=\acute
3264 \let\==\bar
3265 \let\^=\hat
3266 \let\`=\grave
3267 \let\u=\breve
3268 \let\v=\check
3269 \let\~=\tilde
3270 \let\dotaccent=\dot
3271 % have to provide another name for sup operator
3272 \let\mathopsup=\sup
3273 $\expandafter\finishmath\fi
3275 \def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
3277 % Some active characters (such as <) are spaced differently in math.
3278 % We have to reset their definitions in case the @math was an argument
3279 % to a command which sets the catcodes (such as @item or @section).
3282 \catcode`^ = \active
3283 \catcode`< = \active
3284 \catcode`> = \active
3285 \catcode`+ = \active
3286 \catcode`' = \active
3287 \gdef\mathactive{%
3288 \let^ = \ptexhat
3289 \let< = \ptexless
3290 \let> = \ptexgtr
3291 \let+ = \ptexplus
3292 \let' = \ptexquoteright
3296 % for @sub and @sup, if in math mode, just do a normal sub/superscript.
3297 % If in text, use math to place as sub/superscript, but switch
3298 % into text mode, with smaller fonts. This is a different font than the
3299 % one used for real math sub/superscripts (8pt vs. 7pt), but let's not
3300 % fix it (significant additions to font machinery) until someone notices.
3302 \def\sub{\ifmmode \expandafter\sb \else \expandafter\finishsub\fi}
3303 \def\finishsub#1{$\sb{\hbox{\switchtolllsize #1}}$}%
3305 \def\sup{\ifmmode \expandafter\ptexsp \else \expandafter\finishsup\fi}
3306 \def\finishsup#1{$\ptexsp{\hbox{\switchtolllsize #1}}$}%
3308 % provide this command from LaTeX as it is very common
3309 \def\frac#1#2{{{#1}\over{#2}}}
3311 % @displaymath.
3312 % \globaldefs is needed to recognize the end lines in \tex and
3313 % \end tex. Set \thisenv as @end displaymath is seen before @end tex.
3314 {\obeylines
3315 \globaldefs=1
3316 \envdef\displaymath{%
3317 \tex%
3318 \def\thisenv{\displaymath}%
3319 \begingroup\let\end\displaymathend%
3323 \def\displaymathend{$$\endgroup\end}%
3325 \def\Edisplaymath{%
3326 \def\thisenv{\tex}%
3327 \end tex
3331 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
3332 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
3333 % except specified as a normal braced arg, so no newlines to worry about.
3335 \def\outfmtnametex{tex}
3337 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
3338 \long\def\doinlinefmt#1,#2,\finish{%
3339 \def\inlinefmtname{#1}%
3340 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
3343 % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
3344 % FMTNAME is tex, else ELSE-TEXT.
3345 \long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,\finish}
3346 \long\def\doinlinefmtifelse#1,#2,#3,#4,\finish{%
3347 \def\inlinefmtname{#1}%
3348 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
3351 % For raw, must switch into @tex before parsing the argument, to avoid
3352 % setting catcodes prematurely. Doing it this way means that, for
3353 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
3354 % ignored. But this isn't important because if people want a literal
3355 % *right* brace they would have to use a command anyway, so they may as
3356 % well use a command to get a left brace too. We could re-use the
3357 % delimiter character idea from \verb, but it seems like overkill.
3359 \long\def\inlineraw{\tex \doinlineraw}
3360 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
3361 \def\doinlinerawtwo#1,#2,\finish{%
3362 \def\inlinerawname{#1}%
3363 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
3364 \endgroup % close group opened by \tex.
3367 % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
3369 \long\def\inlineifset#1{\doinlineifset #1,\finish}
3370 \long\def\doinlineifset#1,#2,\finish{%
3371 \def\inlinevarname{#1}%
3372 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax
3373 \else\ignorespaces#2\fi
3376 % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
3378 \long\def\inlineifclear#1{\doinlineifclear #1,\finish}
3379 \long\def\doinlineifclear#1,#2,\finish{%
3380 \def\inlinevarname{#1}%
3381 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \ignorespaces#2\fi
3385 \message{glyphs,}
3386 % and logos.
3388 % @@ prints an @, as does @atchar{}.
3389 \def\@{\char64 }
3390 \let\atchar=\@
3392 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
3393 \def\lbracechar{{\ifmonospace\char123\else\ensuremath\lbrace\fi}}
3394 \def\rbracechar{{\ifmonospace\char125\else\ensuremath\rbrace\fi}}
3395 \let\{=\lbracechar
3396 \let\}=\rbracechar
3398 % @comma{} to avoid , parsing problems.
3399 \let\comma = ,
3401 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
3402 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
3403 \let\, = \ptexc
3404 \let\dotaccent = \ptexdot
3405 \def\ringaccent#1{{\accent23 #1}}
3406 \let\tieaccent = \ptext
3407 \let\ubaraccent = \ptexb
3408 \let\udotaccent = \d
3410 % Other special characters: @questiondown @exclamdown @ordf @ordm
3411 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
3412 \def\questiondown{?`}
3413 \def\exclamdown{!`}
3414 \def\ordf{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{a}}}
3415 \def\ordm{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{o}}}
3417 % Dotless i and dotless j, used for accents.
3418 \def\imacro{i}
3419 \def\jmacro{j}
3420 \def\dotless#1{%
3421 \def\temp{#1}%
3422 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
3423 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
3424 \else \errmessage{@dotless can be used only with i or j}%
3425 \fi\fi
3428 % The \TeX{} logo, as in plain, but resetting the spacing so that a
3429 % period following counts as ending a sentence. (Idea found in latex.)
3431 \edef\TeX{\TeX \spacefactor=1000 }
3433 % @LaTeX{} logo. Not quite the same results as the definition in
3434 % latex.ltx, since we use a different font for the raised A; it's most
3435 % convenient for us to use an explicitly smaller font, rather than using
3436 % the \scriptstyle font (since we don't reset \scriptstyle and
3437 % \scriptscriptstyle).
3439 \def\LaTeX{%
3440 L\kern-.36em
3441 {\setbox0=\hbox{T}%
3442 \vbox to \ht0{\hbox{%
3443 \ifx\textnominalsize\xwordpt
3444 % for 10pt running text, lllsize (8pt) is too small for the A in LaTeX.
3445 % Revert to plain's \scriptsize, which is 7pt.
3446 \count255=\the\fam $\fam\count255 \scriptstyle A$%
3447 \else
3448 % For 11pt, we can use our lllsize.
3449 \switchtolllsize A%
3452 \vss
3454 \kern-.15em
3455 \TeX
3458 % Some math mode symbols. Define \ensuremath to switch into math mode
3459 % unless we are already there. Expansion tricks may not be needed here,
3460 % but safer, and can't hurt.
3461 \def\ensuremath{\ifmmode \expandafter\asis \else\expandafter\ensuredmath \fi}
3462 \def\ensuredmath#1{$\relax#1$}
3464 \def\bullet{\ensuremath\ptexbullet}
3465 \def\geq{\ensuremath\ge}
3466 \def\leq{\ensuremath\le}
3467 \def\minus{\ensuremath-}
3469 % @dots{} outputs an ellipsis using the current font.
3470 % We do .5em per period so that it has the same spacing in the cm
3471 % typewriter fonts as three actual period characters; on the other hand,
3472 % in other typewriter fonts three periods are wider than 1.5em. So do
3473 % whichever is larger.
3475 \def\dots{%
3476 \leavevmode
3477 \setbox0=\hbox{...}% get width of three periods
3478 \ifdim\wd0 > 1.5em
3479 \dimen0 = \wd0
3480 \else
3481 \dimen0 = 1.5em
3483 \hbox to \dimen0{%
3484 \hskip 0pt plus.25fil
3485 .\hskip 0pt plus1fil
3486 .\hskip 0pt plus1fil
3487 .\hskip 0pt plus.5fil
3491 % @enddots{} is an end-of-sentence ellipsis.
3493 \def\enddots{%
3494 \dots
3495 \spacefactor=\endofsentencespacefactor
3498 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3500 % Since these characters are used in examples, they should be an even number of
3501 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3503 \def\point{$\star$}
3504 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3505 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3506 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3507 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3508 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3510 % The @error{} command.
3511 % Adapted from the TeXbook's \boxit.
3513 \newbox\errorbox
3515 {\ttfont \global\dimen0 = 3em}% Width of the box.
3516 \dimen2 = .55pt % Thickness of rules
3517 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3518 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
3520 \setbox\errorbox=\hbox to \dimen0{\hfil
3521 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3522 \advance\hsize by -2\dimen2 % Rules.
3523 \vbox{%
3524 \hrule height\dimen2
3525 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3526 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3527 \kern3pt\vrule width\dimen2}% Space to right.
3528 \hrule height\dimen2}
3529 \hfil}
3531 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3533 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3535 \def\pounds{\ifmonospace{\ecfont\char"BF}\else{\it\$}\fi}
3537 % @euro{} comes from a separate font, depending on the current style.
3538 % We use the free feym* fonts from the eurosym package by Henrik
3539 % Theiling, which support regular, slanted, bold and bold slanted (and
3540 % "outlined" (blackboard board, sort of) versions, which we don't need).
3541 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3543 % Although only regular is the truly official Euro symbol, we ignore
3544 % that. The Euro is designed to be slightly taller than the regular
3545 % font height.
3547 % feymr - regular
3548 % feymo - slanted
3549 % feybr - bold
3550 % feybo - bold slanted
3552 % There is no good (free) typewriter version, to my knowledge.
3553 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3554 % Hmm.
3556 % Also doesn't work in math. Do we need to do math with euro symbols?
3557 % Hope not.
3560 \def\euro{{\eurofont e}}
3561 \def\eurofont{%
3562 % We set the font at each command, rather than predefining it in
3563 % \textfonts and the other font-switching commands, so that
3564 % installations which never need the symbol don't have to have the
3565 % font installed.
3567 % There is only one designed size (nominal 10pt), so we always scale
3568 % that to the current nominal size.
3570 % By the way, simply using "at 1em" works for cmr10 and the like, but
3571 % does not work for cmbx10 and other extended/shrunken fonts.
3573 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3575 \ifx\curfontstyle\bfstylename
3576 % bold:
3577 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3578 \else
3579 % regular:
3580 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3582 \thiseurofont
3585 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3586 % sometimes we redefine the original macro, and the alias should reflect
3587 % the redefinition.
3589 % Use LaTeX names for the Icelandic letters.
3590 \def\DH{{\ecfont \char"D0}} % Eth
3591 \def\dh{{\ecfont \char"F0}} % eth
3592 \def\TH{{\ecfont \char"DE}} % Thorn
3593 \def\th{{\ecfont \char"FE}} % thorn
3595 \def\guillemetleft{{\ecfont \char"13}}
3596 \def\guillemotleft{\guillemetleft}
3597 \def\guillemetright{{\ecfont \char"14}}
3598 \def\guillemotright{\guillemetright}
3599 \def\guilsinglleft{{\ecfont \char"0E}}
3600 \def\guilsinglright{{\ecfont \char"0F}}
3601 \def\quotedblbase{{\ecfont \char"12}}
3602 \def\quotesinglbase{{\ecfont \char"0D}}
3604 \def\L{{\ecfont \char"8A}} % L with stroke
3605 \def\l{{\ecfont \char"AA}} % l with stroke
3607 % This positioning is not perfect (see the ogonek LaTeX package), but
3608 % we have the precomposed glyphs for the most common cases. We put the
3609 % tests to use those glyphs in the single \ogonek macro so we have fewer
3610 % dummy definitions to worry about for index entries, etc.
3612 % ogonek is also used with other letters in Lithuanian (IOU), but using
3613 % the precomposed glyphs for those is not so easy since they aren't in
3614 % the same EC font.
3615 \def\ogonek#1{{%
3616 \def\temp{#1}%
3617 \ifx\temp\macrocharA\Aogonek
3618 \else\ifx\temp\macrochara\aogonek
3619 \else\ifx\temp\macrocharE\Eogonek
3620 \else\ifx\temp\macrochare\eogonek
3621 \else
3622 \ecfont \setbox0=\hbox{#1}%
3623 \ifdim\ht0=1ex\accent"0C #1%
3624 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3626 \fi\fi\fi\fi
3629 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3630 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3631 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3632 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3634 % Use the European Computer Modern fonts (cm-super in outline format)
3635 % for non-CM glyphs. That is ec* for regular text and tc* for the text
3636 % companion symbols (LaTeX TS1 encoding). Both are part of the ec
3637 % package and follow the same conventions.
3639 \def\ecfont{\etcfont{e}}
3640 \def\tcfont{\etcfont{t}}
3642 \def\etcfont#1{%
3643 % We can't distinguish serif/sans and italic/slanted, but this
3644 % is used for crude hacks anyway (like adding French and German
3645 % quotes to documents typeset with CM, where we lose kerning), so
3646 % hopefully nobody will notice/care.
3647 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3648 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3649 \ifmonospace
3650 % typewriter:
3651 \font\thisecfont = #1ctt\ecsize \space at \nominalsize
3652 \else
3653 \ifx\curfontstyle\bfstylename
3654 % bold:
3655 \font\thisecfont = #1cb\ifusingit{i}{x}\ecsize \space at \nominalsize
3656 \else
3657 % regular:
3658 \font\thisecfont = #1c\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3661 \thisecfont
3664 % @registeredsymbol - R in a circle. The font for the R should really
3665 % be smaller yet, but lllsize is the best we can do for now.
3666 % Adapted from the plain.tex definition of \copyright.
3668 \def\registeredsymbol{%
3669 $^{{\ooalign{\hfil\raise.07ex\hbox{\switchtolllsize R}%
3670 \hfil\crcr\Orb}}%
3674 % @textdegree - the normal degrees sign.
3676 \def\textdegree{$^\circ$}
3678 % Laurent Siebenmann reports \Orb undefined with:
3679 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3680 % so we'll define it if necessary.
3682 \ifx\Orb\thisisundefined
3683 \def\Orb{\mathhexbox20D}
3686 % Quotes.
3687 \chardef\quoteleft=`\`
3688 \chardef\quoteright=`\'
3690 % only change font for tt for correct kerning and to avoid using
3691 % \ecfont unless necessary.
3692 \def\quotedblleft{%
3693 \ifmonospace{\ecfont\char"10}\else{\char"5C}\fi
3696 \def\quotedblright{%
3697 \ifmonospace{\ecfont\char"11}\else{\char`\"}\fi
3701 \message{page headings,}
3703 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3704 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3706 % First the title page. Must do @settitle before @titlepage.
3707 \newif\ifseenauthor
3708 \newif\iffinishedtitlepage
3710 % @setcontentsaftertitlepage used to do an implicit @contents or
3711 % @shortcontents after @end titlepage, but it is now obsolete.
3712 \def\setcontentsaftertitlepage{%
3713 \errmessage{@setcontentsaftertitlepage has been removed as a Texinfo
3714 command; move your @contents command if you want the contents
3715 after the title page.}}%
3716 \def\setshortcontentsaftertitlepage{%
3717 \errmessage{@setshortcontentsaftertitlepage has been removed as a Texinfo
3718 command; move your @shortcontents and @contents commands if you
3719 want the contents after the title page.}}%
3721 \parseargdef\shorttitlepage{%
3722 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3723 \endgroup\page\hbox{}\page}
3725 \envdef\titlepage{%
3726 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3727 \begingroup
3728 \parindent=0pt \textfonts
3729 % Leave some space at the very top of the page.
3730 \vglue\titlepagetopglue
3731 % No rule at page bottom unless we print one at the top with @title.
3732 \finishedtitlepagetrue
3734 % Most title ``pages'' are actually two pages long, with space
3735 % at the top of the second. We don't want the ragged left on the second.
3736 \let\oldpage = \page
3737 \def\page{%
3738 \iffinishedtitlepage\else
3739 \finishtitlepage
3741 \let\page = \oldpage
3742 \page
3743 \null
3747 \def\Etitlepage{%
3748 \iffinishedtitlepage\else
3749 \finishtitlepage
3751 % It is important to do the page break before ending the group,
3752 % because the headline and footline are only empty inside the group.
3753 % If we use the new definition of \page, we always get a blank page
3754 % after the title page, which we certainly don't want.
3755 \oldpage
3756 \endgroup
3758 % Need this before the \...aftertitlepage checks so that if they are
3759 % in effect the toc pages will come out with page numbers.
3760 \HEADINGSon
3763 \def\finishtitlepage{%
3764 \vskip4pt \hrule height 2pt width \hsize
3765 \vskip\titlepagebottomglue
3766 \finishedtitlepagetrue
3769 % Settings used for typesetting titles: no hyphenation, no indentation,
3770 % don't worry much about spacing, ragged right. This should be used
3771 % inside a \vbox, and fonts need to be set appropriately first. \par should
3772 % be specified before the end of the \vbox, since a vbox is a group.
3774 \def\raggedtitlesettings{%
3776 \hyphenpenalty=10000
3777 \parindent=0pt
3778 \tolerance=5000
3779 \ptexraggedright
3782 % Macros to be used within @titlepage:
3784 \let\subtitlerm=\rmfont
3785 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3787 \parseargdef\title{%
3788 \checkenv\titlepage
3789 \vbox{\titlefonts \raggedtitlesettings #1\par}%
3790 % print a rule at the page bottom also.
3791 \finishedtitlepagefalse
3792 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3795 \parseargdef\subtitle{%
3796 \checkenv\titlepage
3797 {\subtitlefont \rightline{#1}}%
3800 % @author should come last, but may come many times.
3801 % It can also be used inside @quotation.
3803 \parseargdef\author{%
3804 \def\temp{\quotation}%
3805 \ifx\thisenv\temp
3806 \def\quotationauthor{#1}% printed in \Equotation.
3807 \else
3808 \checkenv\titlepage
3809 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3810 {\secfonts\rm \leftline{#1}}%
3815 % Set up page headings and footings.
3817 \let\thispage=\folio
3819 \newtoks\evenheadline % headline on even pages
3820 \newtoks\oddheadline % headline on odd pages
3821 \newtoks\evenchapheadline% headline on even pages with a new chapter
3822 \newtoks\oddchapheadline % headline on odd pages with a new chapter
3823 \newtoks\evenfootline % footline on even pages
3824 \newtoks\oddfootline % footline on odd pages
3826 % Now make \makeheadline and \makefootline in Plain TeX use those variables
3827 \headline={{\textfonts\rm
3828 \ifchapterpage
3829 \ifodd\pageno\the\oddchapheadline\else\the\evenchapheadline\fi
3830 \else
3831 \ifodd\pageno\the\oddheadline\else\the\evenheadline\fi
3832 \fi}}
3834 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3835 \else \the\evenfootline \fi}\HEADINGShook}
3836 \let\HEADINGShook=\relax
3838 % Commands to set those variables.
3839 % For example, this is what @headings on does
3840 % @evenheading @thistitle|@thispage|@thischapter
3841 % @oddheading @thischapter|@thispage|@thistitle
3842 % @evenfooting @thisfile||
3843 % @oddfooting ||@thisfile
3846 \def\evenheading{\parsearg\evenheadingxxx}
3847 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3848 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3849 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}
3850 \global\evenchapheadline=\evenheadline}
3852 \def\oddheading{\parsearg\oddheadingxxx}
3853 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3854 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3855 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3856 \global\oddchapheadline=\oddheadline}
3858 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3860 \def\evenfooting{\parsearg\evenfootingxxx}
3861 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3862 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3863 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3865 \def\oddfooting{\parsearg\oddfootingxxx}
3866 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3867 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3868 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3870 % Leave some space for the footline. Hopefully ok to assume
3871 % @evenfooting will not be used by itself.
3872 \global\advance\txipageheight by -12pt
3873 \global\advance\vsize by -12pt
3876 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3878 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3879 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3881 % The same set of arguments for:
3883 % @oddheadingmarks
3884 % @evenfootingmarks
3885 % @oddfootingmarks
3886 % @everyheadingmarks
3887 % @everyfootingmarks
3889 % These define \getoddheadingmarks, \getevenheadingmarks,
3890 % \getoddfootingmarks, and \getevenfootingmarks, each to one of
3891 % \gettopheadingmarks, \getbottomheadingmarks.
3893 \def\evenheadingmarks{\headingmarks{even}{heading}}
3894 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3895 \def\evenfootingmarks{\headingmarks{even}{footing}}
3896 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3897 \parseargdef\everyheadingmarks{\headingmarks{even}{heading}{#1}
3898 \headingmarks{odd}{heading}{#1} }
3899 \parseargdef\everyfootingmarks{\headingmarks{even}{footing}{#1}
3900 \headingmarks{odd}{footing}{#1} }
3901 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3902 \def\headingmarks#1#2#3 {%
3903 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3904 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3907 \everyheadingmarks bottom
3908 \everyfootingmarks bottom
3910 % @headings double turns headings on for double-sided printing.
3911 % @headings single turns headings on for single-sided printing.
3912 % @headings off turns them off.
3913 % @headings on same as @headings double, retained for compatibility.
3914 % @headings after turns on double-sided headings after this page.
3915 % @headings doubleafter turns on double-sided headings after this page.
3916 % @headings singleafter turns on single-sided headings after this page.
3917 % By default, they are off at the start of a document,
3918 % and turned `on' after @end titlepage.
3920 \parseargdef\headings{\csname HEADINGS#1\endcsname}
3922 \def\headingsoff{% non-global headings elimination
3923 \evenheadline={\hfil}\evenfootline={\hfil}\evenchapheadline={\hfil}%
3924 \oddheadline={\hfil}\oddfootline={\hfil}\oddchapheadline={\hfil}%
3927 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3928 \HEADINGSoff % it's the default
3930 % When we turn headings on, set the page number to 1.
3931 \def\pageone{
3932 \global\pageno=1
3933 \global\arabiccount = \pagecount
3936 % For double-sided printing, put current file name in lower left corner,
3937 % chapter name on inside top of right hand pages, document
3938 % title on inside top of left hand pages, and page numbers on outside top
3939 % edge of all pages.
3940 \def\HEADINGSdouble{%
3941 \pageone
3942 \HEADINGSdoublex
3944 \let\contentsalignmacro = \chappager
3946 % For single-sided printing, chapter title goes across top left of page,
3947 % page number on top right.
3948 \def\HEADINGSsingle{%
3949 \pageone
3950 \HEADINGSsinglex
3952 \def\HEADINGSon{\HEADINGSdouble}
3954 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3955 \let\HEADINGSdoubleafter=\HEADINGSafter
3956 \def\HEADINGSdoublex{%
3957 \global\evenfootline={\hfil}
3958 \global\oddfootline={\hfil}
3959 \global\evenheadline={\line{\folio\hfil\thistitle}}
3960 \global\oddheadline={\line{\thischapter\hfil\folio}}
3961 \global\evenchapheadline={\line{\folio\hfil}}
3962 \global\oddchapheadline={\line{\hfil\folio}}
3963 \global\let\contentsalignmacro = \chapoddpage
3966 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3967 \def\HEADINGSsinglex{%
3968 \global\evenfootline={\hfil}
3969 \global\oddfootline={\hfil}
3970 \global\evenheadline={\line{\thischapter\hfil\folio}}
3971 \global\oddheadline={\line{\thischapter\hfil\folio}}
3972 \global\evenchapheadline={\line{\hfil\folio}}
3973 \global\oddchapheadline={\line{\hfil\folio}}
3974 \global\let\contentsalignmacro = \chappager
3977 % for @setchapternewpage off
3978 \def\HEADINGSsinglechapoff{%
3979 \pageone
3980 \global\evenfootline={\hfil}
3981 \global\oddfootline={\hfil}
3982 \global\evenheadline={\line{\thischapter\hfil\folio}}
3983 \global\oddheadline={\line{\thischapter\hfil\folio}}
3984 \global\evenchapheadline=\evenheadline
3985 \global\oddchapheadline=\oddheadline
3986 \global\let\contentsalignmacro = \chappager
3989 % Subroutines used in generating headings
3990 % This produces Day Month Year style of output.
3991 % Only define if not already defined, in case a txi-??.tex file has set
3992 % up a different format (e.g., txi-cs.tex does this).
3993 \ifx\today\thisisundefined
3994 \def\today{%
3995 \number\day\space
3996 \ifcase\month
3997 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3998 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3999 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
4001 \space\number\year}
4004 % @settitle line... specifies the title of the document, for headings.
4005 % It generates no output of its own.
4006 \def\thistitle{\putwordNoTitle}
4007 \def\settitle{\parsearg{\gdef\thistitle}}
4010 \message{tables,}
4011 % Tables -- @table, @ftable, @vtable, @item(x).
4013 % default indentation of table text
4014 \newdimen\tableindent \tableindent=.8in
4015 % default indentation of @itemize and @enumerate text
4016 \newdimen\itemindent \itemindent=.3in
4017 % margin between end of table item and start of table text.
4018 \newdimen\itemmargin \itemmargin=.1in
4020 % used internally for \itemindent minus \itemmargin
4021 \newdimen\itemmax
4023 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
4024 % these defs.
4025 % They also define \itemindex
4026 % to index the item name in whatever manner is desired (perhaps none).
4028 \newif\ifitemxneedsnegativevskip
4030 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
4032 \def\internalBitem{\smallbreak \parsearg\itemzzz}
4033 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
4035 \def\itemzzz #1{\begingroup %
4036 \advance\hsize by -\rightskip
4037 \advance\hsize by -\tableindent
4038 \setbox0=\hbox{\itemindicate{#1}}%
4039 \itemindex{#1}%
4040 \nobreak % This prevents a break before @itemx.
4042 % If the item text does not fit in the space we have, put it on a line
4043 % by itself, and do not allow a page break either before or after that
4044 % line. We do not start a paragraph here because then if the next
4045 % command is, e.g., @kindex, the whatsit would get put into the
4046 % horizontal list on a line by itself, resulting in extra blank space.
4047 \ifdim \wd0>\itemmax
4049 % Make this a paragraph so we get the \parskip glue and wrapping,
4050 % but leave it ragged-right.
4051 \begingroup
4052 \advance\leftskip by-\tableindent
4053 \advance\hsize by\tableindent
4054 \advance\rightskip by0pt plus1fil\relax
4055 \leavevmode\unhbox0\par
4056 \endgroup
4058 % We're going to be starting a paragraph, but we don't want the
4059 % \parskip glue -- logically it's part of the @item we just started.
4060 \nobreak \vskip-\parskip
4062 % Stop a page break at the \parskip glue coming up. However, if
4063 % what follows is an environment such as @example, there will be no
4064 % \parskip glue; then the negative vskip we just inserted would
4065 % cause the example and the item to crash together. So we use this
4066 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
4067 % \parskip glue after all. Section titles are handled this way also.
4069 \penalty 10001
4070 \endgroup
4071 \itemxneedsnegativevskipfalse
4072 \else
4073 % The item text fits into the space. Start a paragraph, so that the
4074 % following text (if any) will end up on the same line.
4075 \noindent
4076 % Do this with kerns and \unhbox so that if there is a footnote in
4077 % the item text, it can migrate to the main vertical list and
4078 % eventually be printed.
4079 \nobreak\kern-\tableindent
4080 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
4081 \unhbox0
4082 \nobreak\kern\dimen0
4083 \endgroup
4084 \itemxneedsnegativevskiptrue
4088 \def\item{\errmessage{@item while not in a list environment}}
4089 \def\itemx{\errmessage{@itemx while not in a list environment}}
4091 % @table, @ftable, @vtable.
4092 \envdef\table{%
4093 \let\itemindex\gobble
4094 \tablecheck{table}%
4096 \envdef\ftable{%
4097 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
4098 \tablecheck{ftable}%
4100 \envdef\vtable{%
4101 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
4102 \tablecheck{vtable}%
4104 \def\tablecheck#1{%
4105 \ifnum \the\catcode`\^^M=\active
4106 \endgroup
4107 \errmessage{This command won't work in this context; perhaps the problem is
4108 that we are \inenvironment\thisenv}%
4109 \def\next{\doignore{#1}}%
4110 \else
4111 \let\next\tablex
4113 \next
4115 \def\tablex#1{%
4116 \def\itemindicate{#1}%
4117 \parsearg\tabley
4119 \def\tabley#1{%
4121 \makevalueexpandable
4122 \edef\temp{\noexpand\tablez #1\space\space\space}%
4123 \expandafter
4124 }\temp \endtablez
4126 \def\tablez #1 #2 #3 #4\endtablez{%
4127 \aboveenvbreak
4128 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
4129 \ifnum 0#2>0 \tableindent=#2\mil \fi
4130 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
4131 \itemmax=\tableindent
4132 \advance \itemmax by -\itemmargin
4133 \advance \leftskip by \tableindent
4134 \exdentamount=\tableindent
4135 \parindent = 0pt
4136 \parskip = \smallskipamount
4137 \ifdim \parskip=0pt \parskip=2pt \fi
4138 \let\item = \internalBitem
4139 \let\itemx = \internalBitemx
4141 \def\Etable{\endgraf\afterenvbreak}
4142 \let\Eftable\Etable
4143 \let\Evtable\Etable
4144 \let\Eitemize\Etable
4145 \let\Eenumerate\Etable
4147 % This is the counter used by @enumerate, which is really @itemize
4149 \newcount \itemno
4151 \envdef\itemize{\parsearg\doitemize}
4153 \def\doitemize#1{%
4154 \aboveenvbreak
4155 \itemmax=\itemindent
4156 \advance\itemmax by -\itemmargin
4157 \advance\leftskip by \itemindent
4158 \exdentamount=\itemindent
4159 \parindent=0pt
4160 \parskip=\smallskipamount
4161 \ifdim\parskip=0pt \parskip=2pt \fi
4163 % Try typesetting the item mark so that if the document erroneously says
4164 % something like @itemize @samp (intending @table), there's an error
4165 % right away at the @itemize. It's not the best error message in the
4166 % world, but it's better than leaving it to the @item. This means if
4167 % the user wants an empty mark, they have to say @w{} not just @w.
4168 \def\itemcontents{#1}%
4169 \setbox0 = \hbox{\itemcontents}%
4171 % @itemize with no arg is equivalent to @itemize @bullet.
4172 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
4174 \let\item=\itemizeitem
4177 % Definition of @item while inside @itemize and @enumerate.
4179 \def\itemizeitem{%
4180 \advance\itemno by 1 % for enumerations
4181 {\let\par=\endgraf \smallbreak}% reasonable place to break
4183 % If the document has an @itemize directly after a section title, a
4184 % \nobreak will be last on the list, and \sectionheading will have
4185 % done a \vskip-\parskip. In that case, we don't want to zero
4186 % parskip, or the item text will crash with the heading. On the
4187 % other hand, when there is normal text preceding the item (as there
4188 % usually is), we do want to zero parskip, or there would be too much
4189 % space. In that case, we won't have a \nobreak before. At least
4190 % that's the theory.
4191 \ifnum\lastpenalty<10000 \parskip=0in \fi
4192 \noindent
4193 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
4195 \ifinner\else
4196 \vadjust{\penalty 1200}% not good to break after first line of item.
4198 % We can be in inner vertical mode in a footnote, although an
4199 % @itemize looks awful there.
4201 \flushcr
4204 % \splitoff TOKENS\endmark defines \first to be the first token in
4205 % TOKENS, and \rest to be the remainder.
4207 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
4209 % Allow an optional argument of an uppercase letter, lowercase letter,
4210 % or number, to specify the first label in the enumerated list. No
4211 % argument is the same as `1'.
4213 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
4214 \def\enumeratey #1 #2\endenumeratey{%
4215 % If we were given no argument, pretend we were given `1'.
4216 \def\thearg{#1}%
4217 \ifx\thearg\empty \def\thearg{1}\fi
4219 % Detect if the argument is a single token. If so, it might be a
4220 % letter. Otherwise, the only valid thing it can be is a number.
4221 % (We will always have one token, because of the test we just made.
4222 % This is a good thing, since \splitoff doesn't work given nothing at
4223 % all -- the first parameter is undelimited.)
4224 \expandafter\splitoff\thearg\endmark
4225 \ifx\rest\empty
4226 % Only one token in the argument. It could still be anything.
4227 % A ``lowercase letter'' is one whose \lccode is nonzero.
4228 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
4229 % not equal to itself.
4230 % Otherwise, we assume it's a number.
4232 % We need the \relax at the end of the \ifnum lines to stop TeX from
4233 % continuing to look for a <number>.
4235 \ifnum\lccode\expandafter`\thearg=0\relax
4236 \numericenumerate % a number (we hope)
4237 \else
4238 % It's a letter.
4239 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
4240 \lowercaseenumerate % lowercase letter
4241 \else
4242 \uppercaseenumerate % uppercase letter
4245 \else
4246 % Multiple tokens in the argument. We hope it's a number.
4247 \numericenumerate
4251 % An @enumerate whose labels are integers. The starting integer is
4252 % given in \thearg.
4254 \def\numericenumerate{%
4255 \itemno = \thearg
4256 \startenumeration{\the\itemno}%
4259 % The starting (lowercase) letter is in \thearg.
4260 \def\lowercaseenumerate{%
4261 \itemno = \expandafter`\thearg
4262 \startenumeration{%
4263 % Be sure we're not beyond the end of the alphabet.
4264 \ifnum\itemno=0
4265 \errmessage{No more lowercase letters in @enumerate; get a bigger
4266 alphabet}%
4268 \char\lccode\itemno
4272 % The starting (uppercase) letter is in \thearg.
4273 \def\uppercaseenumerate{%
4274 \itemno = \expandafter`\thearg
4275 \startenumeration{%
4276 % Be sure we're not beyond the end of the alphabet.
4277 \ifnum\itemno=0
4278 \errmessage{No more uppercase letters in @enumerate; get a bigger
4279 alphabet}
4281 \char\uccode\itemno
4285 % Call \doitemize, adding a period to the first argument and supplying the
4286 % common last two arguments. Also subtract one from the initial value in
4287 % \itemno, since @item increments \itemno.
4289 \def\startenumeration#1{%
4290 \advance\itemno by -1
4291 \doitemize{#1.}\flushcr
4295 % @multitable macros
4297 % Macros used to set up halign preamble:
4299 \let\endsetuptable\relax
4300 \def\xendsetuptable{\endsetuptable}
4301 \let\columnfractions\relax
4302 \def\xcolumnfractions{\columnfractions}
4303 \newif\ifsetpercent
4305 % #1 is the @columnfraction, usually a decimal number like .5, but might
4306 % be just 1. We just use it, whatever it is.
4308 \def\pickupwholefraction#1 {%
4309 \global\advance\colcount by 1
4310 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
4311 \setuptable
4314 \newcount\colcount
4315 \def\setuptable#1{%
4316 \def\firstarg{#1}%
4317 \ifx\firstarg\xendsetuptable
4318 \let\go = \relax
4319 \else
4320 \ifx\firstarg\xcolumnfractions
4321 \global\setpercenttrue
4322 \else
4323 \ifsetpercent
4324 \let\go\pickupwholefraction
4325 \else
4326 \global\advance\colcount by 1
4327 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
4328 % separator; typically that is always in the input, anyway.
4329 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
4332 \ifx\go\pickupwholefraction
4333 % Put the argument back for the \pickupwholefraction call, so
4334 % we'll always have a period there to be parsed.
4335 \def\go{\pickupwholefraction#1}%
4336 \else
4337 \let\go = \setuptable
4338 \fi%
4343 % @headitem starts a heading row, which we typeset in bold. Assignments
4344 % have to be global since we are inside the implicit group of an
4345 % alignment entry. \everycr below resets \everytab so we don't have to
4346 % undo it ourselves.
4347 \def\headitemfont{\b}% for people to use in the template row; not changeable
4348 \def\headitem{%
4349 \checkenv\multitable
4350 \crcr
4351 \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings
4352 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
4353 \the\everytab % for the first item
4356 % default for tables with no headings.
4357 \let\headitemcrhook=\relax
4359 \def\tab{\checkenv\multitable &\the\everytab}%
4361 \newtoks\everytab % insert after every tab.
4363 \envdef\multitable{%
4364 \vskip\parskip
4365 \startsavinginserts
4367 % @item within a multitable starts a normal row.
4368 % We use \def instead of \let so that if one of the multitable entries
4369 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
4370 % \endtemplate) expanding \doitemize.
4371 \def\item{\crcr}%
4373 \tolerance=9500
4374 \hbadness=9500
4375 \parskip=0pt
4376 \parindent=6pt
4377 \overfullrule=0pt
4378 \global\colcount=0
4380 \everycr = {%
4381 \noalign{%
4382 \global\everytab={}% Reset from possible headitem.
4383 \global\colcount=0 % Reset the column counter.
4385 % Check for saved footnotes, etc.:
4386 \checkinserts
4388 % Perhaps a \nobreak, then reset:
4389 \headitemcrhook
4390 \global\let\headitemcrhook=\relax
4394 \parsearg\domultitable
4396 \def\domultitable#1{%
4397 % To parse everything between @multitable and @item:
4398 \setuptable#1 \endsetuptable
4400 % This preamble sets up a generic column definition, which will
4401 % be used as many times as user calls for columns.
4402 % \vtop will set a single line and will also let text wrap and
4403 % continue for many paragraphs if desired.
4404 \halign\bgroup &%
4405 \global\advance\colcount by 1
4406 \strut
4407 \vtop{%
4408 \advance\hsize by -1\leftskip
4409 % Find the correct column width
4410 \hsize=\expandafter\csname col\the\colcount\endcsname
4412 \advance\rightskip by -1\rightskip % Zero leaving only any stretch
4413 \ifnum\colcount=1
4414 \advance\hsize by\leftskip % Add indent of surrounding text
4415 \else
4416 % In order to keep entries from bumping into each other.
4417 \leftskip=12pt
4418 \ifsetpercent \else
4419 % If a template has been used
4420 \advance\hsize by \leftskip
4423 \noindent\ignorespaces##\unskip\strut
4424 }\cr
4426 \def\Emultitable{%
4427 \crcr
4428 \egroup % end the \halign
4429 \global\setpercentfalse
4433 \message{conditionals,}
4435 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotlatex, @ifnotplaintext,
4436 % @ifnotxml always succeed. They currently do nothing; we don't
4437 % attempt to check whether the conditionals are properly nested. But we
4438 % have to remember that they are conditionals, so that @end doesn't
4439 % attempt to close an environment group.
4441 \def\makecond#1{%
4442 \expandafter\let\csname #1\endcsname = \relax
4443 \expandafter\let\csname iscond.#1\endcsname = 1
4445 \makecond{iftex}
4446 \makecond{ifnotdocbook}
4447 \makecond{ifnothtml}
4448 \makecond{ifnotinfo}
4449 \makecond{ifnotlatex}
4450 \makecond{ifnotplaintext}
4451 \makecond{ifnotxml}
4453 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4455 \def\direntry{\doignore{direntry}}
4456 \def\documentdescription{\doignore{documentdescription}}
4457 \def\docbook{\doignore{docbook}}
4458 \def\html{\doignore{html}}
4459 \def\ifdocbook{\doignore{ifdocbook}}
4460 \def\ifhtml{\doignore{ifhtml}}
4461 \def\ifinfo{\doignore{ifinfo}}
4462 \def\iflatex{\doignore{iflatex}}
4463 \def\ifnottex{\doignore{ifnottex}}
4464 \def\ifplaintext{\doignore{ifplaintext}}
4465 \def\ifxml{\doignore{ifxml}}
4466 \def\ignore{\doignore{ignore}}
4467 \def\latex{\doignore{latex}}
4468 \def\menu{\doignore{menu}}
4469 \def\xml{\doignore{xml}}
4471 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4473 % A count to remember the depth of nesting.
4474 \newcount\doignorecount
4476 \def\doignore#1{\begingroup
4477 % Scan in ``verbatim'' mode:
4478 \obeylines
4479 \catcode`\@ = \other
4480 \catcode`\{ = \other
4481 \catcode`\} = \other
4483 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4484 \spaceisspace
4486 % Count number of #1's that we've seen.
4487 \doignorecount = 0
4489 % Swallow text until we reach the matching `@end #1'.
4490 \dodoignore{#1}%
4493 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4494 \obeylines %
4496 \gdef\dodoignore#1{%
4497 % #1 contains the command name as a string, e.g., `ifinfo'.
4499 % Define a command to find the next `@end #1'.
4500 \long\def\doignoretext##1^^M@end #1{%
4501 \doignoretextyyy##1^^M@#1\_STOP_}%
4503 % And this command to find another #1 command, at the beginning of a
4504 % line. (Otherwise, we would consider a line `@c @ifset', for
4505 % example, to count as an @ifset for nesting.)
4506 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4508 % And now expand that command.
4509 \doignoretext ^^M%
4513 \def\doignoreyyy#1{%
4514 \def\temp{#1}%
4515 \ifx\temp\empty % Nothing found.
4516 \let\next\doignoretextzzz
4517 \else % Found a nested condition, ...
4518 \advance\doignorecount by 1
4519 \let\next\doignoretextyyy % ..., look for another.
4520 % If we're here, #1 ends with ^^M\ifinfo (for example).
4522 \next #1% the token \_STOP_ is present just after this macro.
4525 % We have to swallow the remaining "\_STOP_".
4527 \def\doignoretextzzz#1{%
4528 \ifnum\doignorecount = 0 % We have just found the outermost @end.
4529 \let\next\enddoignore
4530 \else % Still inside a nested condition.
4531 \advance\doignorecount by -1
4532 \let\next\doignoretext % Look for the next @end.
4534 \next
4537 % Finish off ignored text.
4538 { \obeylines%
4539 % Ignore anything after the last `@end #1'; this matters in verbatim
4540 % environments, where otherwise the newline after an ignored conditional
4541 % would result in a blank line in the output.
4542 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4546 % @set VAR sets the variable VAR to an empty value.
4547 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4549 % Since we want to separate VAR from REST-OF-LINE (which might be
4550 % empty), we can't just use \parsearg; we have to insert a space of our
4551 % own to delimit the rest of the line, and then take it out again if we
4552 % didn't need it.
4553 % We rely on the fact that \parsearg sets \catcode`\ =10.
4555 \parseargdef\set{\setyyy#1 \endsetyyy}
4556 \def\setyyy#1 #2\endsetyyy{%
4558 \makevalueexpandable
4559 \def\temp{#2}%
4560 \edef\next{\gdef\makecsname{SET#1}}%
4561 \ifx\temp\empty
4562 \next{}%
4563 \else
4564 \setzzz#2\endsetzzz
4568 % Remove the trailing space \setxxx inserted.
4569 \def\setzzz#1 \endsetzzz{\next{#1}}
4571 % @clear VAR clears (i.e., unsets) the variable VAR.
4573 \parseargdef\clear{%
4575 \makevalueexpandable
4576 \global\expandafter\let\csname SET#1\endcsname=\relax
4580 % @value{foo} gets the text saved in variable foo.
4581 \def\value{\begingroup\makevalueexpandable\valuexxx}
4582 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4584 \catcode`\-=\active \catcode`\_=\active
4586 \gdef\makevalueexpandable{%
4587 \let\value = \expandablevalue
4588 % We don't want these characters active, ...
4589 \catcode`\-=\other \catcode`\_=\other
4590 % ..., but we might end up with active ones in the argument if
4591 % we're called from @code, as @code{@value{foo-bar_}}, though.
4592 % So \let them to their normal equivalents.
4593 \let-\normaldash \let_\normalunderscore
4597 \def\expandablevalue#1{%
4598 \expandafter\ifx\csname SET#1\endcsname\relax
4599 {[No value for ``#1'']}%
4600 \message{Variable `#1', used in @value, is not set.}%
4601 \else
4602 \csname SET#1\endcsname
4606 % Like \expandablevalue, but completely expandable (the \message in the
4607 % definition above operates at the execution level of TeX). Used when
4608 % writing to auxiliary files, due to the expansion that \write does.
4609 % If flag is undefined, pass through an unexpanded @value command: maybe it
4610 % will be set by the time it is read back in.
4612 % NB flag names containing - or _ may not work here.
4613 \def\dummyvalue#1{%
4614 \expandafter\ifx\csname SET#1\endcsname\relax
4615 \string\value{#1}%
4616 \else
4617 \csname SET#1\endcsname
4621 % Used for @value's in index entries to form the sort key: expand the @value
4622 % if possible, otherwise sort late.
4623 \def\indexnofontsvalue#1{%
4624 \expandafter\ifx\csname SET#1\endcsname\relax
4625 ZZZZZZZ%
4626 \else
4627 \csname SET#1\endcsname
4631 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4632 % with @set.
4634 % To get the special treatment we need for `@end ifset,' we call
4635 % \makecond and then redefine.
4637 \makecond{ifset}
4638 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4639 \def\doifset#1#2{%
4641 \makevalueexpandable
4642 \let\next=\empty
4643 \expandafter\ifx\csname SET#2\endcsname\relax
4644 #1% If not set, redefine \next.
4646 \expandafter
4647 }\next
4649 \def\ifsetfail{\doignore{ifset}}
4651 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4652 % defined with @set, or has been undefined with @clear.
4654 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4655 % above code: if the variable is not set, do nothing, if it is set,
4656 % then redefine \next to \ifclearfail.
4658 \makecond{ifclear}
4659 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4660 \def\ifclearfail{\doignore{ifclear}}
4662 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4663 % without the @) is in fact defined. We can only feasibly check at the
4664 % TeX level, so something like `mathcode' is going to considered
4665 % defined even though it is not a Texinfo command.
4667 \makecond{ifcommanddefined}
4668 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
4670 \def\doifcmddefined#1#2{{%
4671 \makevalueexpandable
4672 \let\next=\empty
4673 \expandafter\ifx\csname #2\endcsname\relax
4674 #1% If not defined, \let\next as above.
4676 \expandafter
4677 }\next
4679 \def\ifcmddefinedfail{\doignore{ifcommanddefined}}
4681 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4682 \makecond{ifcommandnotdefined}
4683 \def\ifcommandnotdefined{%
4684 \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
4685 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
4687 % Set the `txicommandconditionals' variable, so documents have a way to
4688 % test if the @ifcommand...defined conditionals are available.
4689 \set txicommandconditionals
4691 % @dircategory CATEGORY -- specify a category of the dir file
4692 % which this file should belong to. Ignore this in TeX.
4693 \let\dircategory=\comment
4695 % @defininfoenclose.
4696 \let\definfoenclose=\comment
4699 \message{indexing,}
4700 % Index generation facilities
4702 % Define \newwrite to be identical to plain tex's \newwrite
4703 % except not \outer, so it can be used within macros and \if's.
4704 \edef\newwrite{\makecsname{ptexnewwrite}}
4706 % \newindex {foo} defines an index named IX.
4707 % It automatically defines \IXindex such that
4708 % \IXindex ...rest of line... puts an entry in the index IX.
4709 % It also defines \IXindfile to be the number of the output channel for
4710 % the file that accumulates this index. The file's extension is IX.
4711 % The name of an index should be no more than 2 characters long
4712 % for the sake of vms.
4714 \def\newindex#1{%
4715 \expandafter\chardef\csname#1indfile\endcsname=0
4716 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4717 \noexpand\doindex{#1}}
4720 % @defindex foo == \newindex{foo}
4722 \def\defindex{\parsearg\newindex}
4724 % Define @defcodeindex, like @defindex except put all entries in @code.
4726 \def\defcodeindex{\parsearg\newcodeindex}
4728 \def\newcodeindex#1{%
4729 \expandafter\chardef\csname#1indfile\endcsname=0
4730 \expandafter\xdef\csname#1index\endcsname{%
4731 \noexpand\docodeindex{#1}}%
4734 % The default indices:
4735 \newindex{cp}% concepts,
4736 \newcodeindex{fn}% functions,
4737 \newcodeindex{vr}% variables,
4738 \newcodeindex{tp}% types,
4739 \newcodeindex{ky}% keys
4740 \newcodeindex{pg}% and programs.
4743 % @synindex foo bar makes index foo feed into index bar.
4744 % Do this instead of @defindex foo if you don't want it as a separate index.
4746 % @syncodeindex foo bar similar, but put all entries made for index foo
4747 % inside @code.
4749 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4750 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4752 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4753 % #3 the target index (bar).
4754 \def\dosynindex#1#2#3{%
4755 \requireopenindexfile{#3}%
4756 % redefine \fooindfile:
4757 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4758 \expandafter\let\csname#2indfile\endcsname=\temp
4759 % redefine \fooindex:
4760 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4763 % Define \doindex, the driver for all index macros.
4764 % Argument #1 is generated by the calling \fooindex macro,
4765 % and it is the two-letter name of the index.
4767 \def\doindex#1{\edef\indexname{#1}\parsearg\doindexxxx}
4768 \def\doindexxxx #1{\doind{\indexname}{#1}}
4770 % like the previous two, but they put @code around the argument.
4771 \def\docodeindex#1{\edef\indexname{#1}\parsearg\docodeindexxxx}
4772 \def\docodeindexxxx #1{\docind{\indexname}{#1}}
4775 % Used for the aux, toc and index files to prevent expansion of Texinfo
4776 % commands.
4778 \def\atdummies{%
4779 \definedummyletter\@%
4780 \definedummyletter\ %
4781 \definedummyletter\{%
4782 \definedummyletter\}%
4783 \definedummyletter\&%
4785 % Do the redefinitions.
4786 \definedummies
4787 \otherbackslash
4790 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4791 % preventing its expansion. This is used only for control words,
4792 % not control letters, because the \space would be incorrect for
4793 % control characters, but is needed to separate the control word
4794 % from whatever follows.
4796 % These can be used both for control words that take an argument and
4797 % those that do not. If it is followed by {arg} in the input, then
4798 % that will dutifully get written to the index (or wherever).
4800 % For control letters, we have \definedummyletter, which omits the
4801 % space.
4803 \def\definedummyword #1{\def#1{\string#1\space}}%
4804 \def\definedummyletter#1{\def#1{\string#1}}%
4805 \let\definedummyaccent\definedummyletter
4807 % Called from \atdummies to prevent the expansion of commands.
4809 \def\definedummies{%
4811 \let\commondummyword\definedummyword
4812 \let\commondummyletter\definedummyletter
4813 \let\commondummyaccent\definedummyaccent
4814 \commondummiesnofonts
4816 \definedummyletter\_%
4817 \definedummyletter\-%
4819 % Non-English letters.
4820 \definedummyword\AA
4821 \definedummyword\AE
4822 \definedummyword\DH
4823 \definedummyword\L
4824 \definedummyword\O
4825 \definedummyword\OE
4826 \definedummyword\TH
4827 \definedummyword\aa
4828 \definedummyword\ae
4829 \definedummyword\dh
4830 \definedummyword\exclamdown
4831 \definedummyword\l
4832 \definedummyword\o
4833 \definedummyword\oe
4834 \definedummyword\ordf
4835 \definedummyword\ordm
4836 \definedummyword\questiondown
4837 \definedummyword\ss
4838 \definedummyword\th
4840 % Although these internal commands shouldn't show up, sometimes they do.
4841 \definedummyword\bf
4842 \definedummyword\gtr
4843 \definedummyword\hat
4844 \definedummyword\less
4845 \definedummyword\sf
4846 \definedummyword\sl
4847 \definedummyword\tclose
4848 \definedummyword\tt
4850 \definedummyword\LaTeX
4851 \definedummyword\TeX
4853 % Assorted special characters.
4854 \definedummyword\ampchar
4855 \definedummyword\atchar
4856 \definedummyword\arrow
4857 \definedummyword\backslashchar
4858 \definedummyword\bullet
4859 \definedummyword\comma
4860 \definedummyword\copyright
4861 \definedummyword\registeredsymbol
4862 \definedummyword\dots
4863 \definedummyword\enddots
4864 \definedummyword\entrybreak
4865 \definedummyword\equiv
4866 \definedummyword\error
4867 \definedummyword\euro
4868 \definedummyword\expansion
4869 \definedummyword\geq
4870 \definedummyword\guillemetleft
4871 \definedummyword\guillemetright
4872 \definedummyword\guilsinglleft
4873 \definedummyword\guilsinglright
4874 \definedummyword\lbracechar
4875 \definedummyword\leq
4876 \definedummyword\mathopsup
4877 \definedummyword\minus
4878 \definedummyword\ogonek
4879 \definedummyword\pounds
4880 \definedummyword\point
4881 \definedummyword\print
4882 \definedummyword\quotedblbase
4883 \definedummyword\quotedblleft
4884 \definedummyword\quotedblright
4885 \definedummyword\quoteleft
4886 \definedummyword\quoteright
4887 \definedummyword\quotesinglbase
4888 \definedummyword\rbracechar
4889 \definedummyword\result
4890 \definedummyword\sub
4891 \definedummyword\sup
4892 \definedummyword\textdegree
4894 \definedummyword\subentry
4896 % We want to disable all macros so that they are not expanded by \write.
4897 \macrolist
4898 \let\value\dummyvalue
4900 \normalturnoffactive
4903 % \commondummiesnofonts: common to \definedummies and \indexnofonts.
4904 % Define \commondummyletter, \commondummyaccent and \commondummyword before
4905 % using. Used for accents, font commands, and various control letters.
4907 \def\commondummiesnofonts{%
4908 % Control letters and accents.
4909 \commondummyletter\!%
4910 \commondummyaccent\"%
4911 \commondummyaccent\'%
4912 \commondummyletter\*%
4913 \commondummyaccent\,%
4914 \commondummyletter\.%
4915 \commondummyletter\/%
4916 \commondummyletter\:%
4917 \commondummyaccent\=%
4918 \commondummyletter\?%
4919 \commondummyaccent\^%
4920 \commondummyaccent\`%
4921 \commondummyaccent\~%
4922 \commondummyword\u
4923 \commondummyword\v
4924 \commondummyword\H
4925 \commondummyword\dotaccent
4926 \commondummyword\ogonek
4927 \commondummyword\ringaccent
4928 \commondummyword\tieaccent
4929 \commondummyword\ubaraccent
4930 \commondummyword\udotaccent
4931 \commondummyword\dotless
4933 % Texinfo font commands.
4934 \commondummyword\b
4935 \commondummyword\i
4936 \commondummyword\r
4937 \commondummyword\sansserif
4938 \commondummyword\sc
4939 \commondummyword\slanted
4940 \commondummyword\t
4942 % Commands that take arguments.
4943 \commondummyword\abbr
4944 \commondummyword\acronym
4945 \commondummyword\anchor
4946 \commondummyword\cite
4947 \commondummyword\code
4948 \commondummyword\command
4949 \commondummyword\dfn
4950 \commondummyword\dmn
4951 \commondummyword\email
4952 \commondummyword\emph
4953 \commondummyword\env
4954 \commondummyword\file
4955 \commondummyword\image
4956 \commondummyword\indicateurl
4957 \commondummyword\inforef
4958 \commondummyword\kbd
4959 \commondummyword\key
4960 \commondummyword\math
4961 \commondummyword\option
4962 \commondummyword\pxref
4963 \commondummyword\ref
4964 \commondummyword\samp
4965 \commondummyword\strong
4966 \commondummyword\tie
4967 \commondummyword\U
4968 \commondummyword\uref
4969 \commondummyword\url
4970 \commondummyword\var
4971 \commondummyword\verb
4972 \commondummyword\w
4973 \commondummyword\xref
4976 \let\indexlbrace\relax
4977 \let\indexrbrace\relax
4978 \let\indexatchar\relax
4979 \let\indexbackslash\relax
4981 {\catcode`\@=0
4982 \catcode`\\=13
4983 @gdef@backslashdisappear{@def\{}}
4987 \catcode`\<=13
4988 \catcode`\-=13
4989 \catcode`\`=13
4990 \gdef\indexnonalnumdisappear{%
4991 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax\else
4992 % @set txiindexlquoteignore makes us ignore left quotes in the sort term.
4993 % (Introduced for FSFS 2nd ed.)
4994 \let`=\empty
4997 \expandafter\ifx\csname SETtxiindexbackslashignore\endcsname\relax\else
4998 \backslashdisappear
5001 \expandafter\ifx\csname SETtxiindexhyphenignore\endcsname\relax\else
5002 \def-{}%
5004 \expandafter\ifx\csname SETtxiindexlessthanignore\endcsname\relax\else
5005 \def<{}%
5007 \expandafter\ifx\csname SETtxiindexatsignignore\endcsname\relax\else
5008 \def\@{}%
5012 \gdef\indexnonalnumreappear{%
5013 \let-\normaldash
5014 \let<\normalless
5019 % \indexnofonts is used when outputting the strings to sort the index
5020 % by, and when constructing control sequence names. It eliminates all
5021 % control sequences and just writes whatever the best ASCII sort string
5022 % would be for a given command (usually its argument).
5024 \def\indexnofonts{%
5025 % Accent commands should become @asis.
5026 \def\commondummyaccent##1{\let##1\asis}%
5027 % We can just ignore other control letters.
5028 \def\commondummyletter##1{\let##1\empty}%
5029 % All control words become @asis by default; overrides below.
5030 \let\commondummyword\commondummyaccent
5031 \commondummiesnofonts
5033 % Don't no-op \tt, since it isn't a user-level command
5034 % and is used in the definitions of the active chars like <, >, |, etc.
5035 % Likewise with the other plain tex font commands.
5036 %\let\tt=\asis
5038 \def\ { }%
5039 \def\@{@}%
5040 \def\_{\normalunderscore}%
5041 \def\-{}% @- shouldn't affect sorting
5043 \uccode`\1=`\{ \uppercase{\def\{{1}}%
5044 \uccode`\1=`\} \uppercase{\def\}{1}}%
5045 \let\lbracechar\{%
5046 \let\rbracechar\}%
5048 % Non-English letters.
5049 \def\AA{AA}%
5050 \def\AE{AE}%
5051 \def\DH{DZZ}%
5052 \def\L{L}%
5053 \def\OE{OE}%
5054 \def\O{O}%
5055 \def\TH{TH}%
5056 \def\aa{aa}%
5057 \def\ae{ae}%
5058 \def\dh{dzz}%
5059 \def\exclamdown{!}%
5060 \def\l{l}%
5061 \def\oe{oe}%
5062 \def\ordf{a}%
5063 \def\ordm{o}%
5064 \def\o{o}%
5065 \def\questiondown{?}%
5066 \def\ss{ss}%
5067 \def\th{th}%
5069 \let\do\indexnofontsdef
5071 \do\LaTeX{LaTeX}%
5072 \do\TeX{TeX}%
5074 % Assorted special characters.
5075 \do\atchar{@}%
5076 \do\arrow{->}%
5077 \do\bullet{bullet}%
5078 \do\comma{,}%
5079 \do\copyright{copyright}%
5080 \do\dots{...}%
5081 \do\enddots{...}%
5082 \do\equiv{==}%
5083 \do\error{error}%
5084 \do\euro{euro}%
5085 \do\expansion{==>}%
5086 \do\geq{>=}%
5087 \do\guillemetleft{<<}%
5088 \do\guillemetright{>>}%
5089 \do\guilsinglleft{<}%
5090 \do\guilsinglright{>}%
5091 \do\leq{<=}%
5092 \do\lbracechar{\{}%
5093 \do\minus{-}%
5094 \do\point{.}%
5095 \do\pounds{pounds}%
5096 \do\print{-|}%
5097 \do\quotedblbase{"}%
5098 \do\quotedblleft{"}%
5099 \do\quotedblright{"}%
5100 \do\quoteleft{`}%
5101 \do\quoteright{'}%
5102 \do\quotesinglbase{,}%
5103 \do\rbracechar{\}}%
5104 \do\registeredsymbol{R}%
5105 \do\result{=>}%
5106 \do\textdegree{o}%
5108 % We need to get rid of all macros, leaving only the arguments (if present).
5109 % Of course this is not nearly correct, but it is the best we can do for now.
5110 % makeinfo does not expand macros in the argument to @deffn, which ends up
5111 % writing an index entry, and texindex isn't prepared for an index sort entry
5112 % that starts with \.
5114 % Since macro invocations are followed by braces, we can just redefine them
5115 % to take a single TeX argument. The case of a macro invocation that
5116 % goes to end-of-line is not handled.
5118 \macrolist
5119 \let\value\indexnofontsvalue
5122 % Give the control sequence a definition that removes the {} that follows
5123 % its use, e.g. @AA{} -> AA
5124 \def\indexnofontsdef#1#2{\def#1##1{#2}}%
5129 % #1 is the index name, #2 is the entry text.
5130 \def\doind#1#2{%
5131 \iflinks
5134 \requireopenindexfile{#1}%
5135 \edef\writeto{\csname#1indfile\endcsname}%
5137 \def\indextext{#2}%
5138 \safewhatsit\doindwrite
5143 % Same as \doind, but for code indices
5144 \def\docind#1#2{%
5145 \iflinks
5148 \requireopenindexfile{#1}%
5149 \edef\writeto{\csname#1indfile\endcsname}%
5151 \def\indextext{#2}%
5152 \safewhatsit\docindwrite
5157 % Check if an index file has been opened, and if not, open it.
5158 \def\requireopenindexfile#1{%
5159 \ifnum\csname #1indfile\endcsname=0
5160 \expandafter\newwrite \csname#1indfile\endcsname
5161 \edef\suffix{#1}%
5162 % A .fls suffix would conflict with the file extension for the output
5163 % of -recorder, so use .f1s instead.
5164 \ifx\suffix\indexisfl\def\suffix{f1}\fi
5165 % Open the file
5166 \immediate\openout\csname#1indfile\endcsname \jobname.\suffix
5167 % Using \immediate above here prevents an object entering into the current
5168 % box, which could confound checks such as those in \safewhatsit for
5169 % preceding skips.
5170 \typeout{Writing index file \jobname.\suffix}%
5171 \fi}
5172 \def\indexisfl{fl}
5174 % Definition for writing index entry sort key.
5176 \catcode`\-=13
5177 \gdef\indexwritesortas{%
5178 \begingroup
5179 \indexnonalnumreappear
5180 \indexwritesortasxxx}
5181 \gdef\indexwritesortasxxx#1{%
5182 \xdef\indexsortkey{#1}\endgroup}
5185 \def\indexwriteseealso#1{
5186 \gdef\pagenumbertext{\string\seealso{#1}}%
5188 \def\indexwriteseeentry#1{
5189 \gdef\pagenumbertext{\string\seeentry{#1}}%
5192 % The default definitions
5193 \def\sortas#1{}%
5194 \def\seealso#1{\i{\putwordSeeAlso}\ #1}% for sorted index file only
5195 \def\putwordSeeAlso{See also}
5196 \def\seeentry#1{\i{\putwordSee}\ #1}% for sorted index file only
5199 % Given index entry text like "aaa @subentry bbb @sortas{ZZZ}":
5200 % * Set \bracedtext to "{aaa}{bbb}"
5201 % * Set \fullindexsortkey to "aaa @subentry ZZZ"
5202 % * If @seealso occurs, set \pagenumbertext
5204 \def\splitindexentry#1{%
5205 \gdef\fullindexsortkey{}%
5206 \xdef\bracedtext{}%
5207 \def\sep{}%
5208 \def\seealso##1{}%
5209 \def\seeentry##1{}%
5210 \expandafter\doindexsegment#1\subentry\finish\subentry
5213 % append the results from the next segment
5214 \def\doindexsegment#1\subentry{%
5215 \def\segment{#1}%
5216 \ifx\segment\isfinish
5217 \else
5219 % Fully expand the segment, throwing away any @sortas directives, and
5220 % trim spaces.
5221 \edef\trimmed{\segment}%
5222 \edef\trimmed{\expandafter\eatspaces\expandafter{\trimmed}}%
5223 \ifincodeindex
5224 \edef\trimmed{\noexpand\code{\trimmed}}%
5227 \xdef\bracedtext{\bracedtext{\trimmed}}%
5229 % Get the string to sort by. Process the segment with all
5230 % font commands turned off.
5231 \bgroup
5232 \let\sortas\indexwritesortas
5233 \let\seealso\indexwriteseealso
5234 \let\seeentry\indexwriteseeentry
5235 \indexnofonts
5236 % The braces around the commands are recognized by texindex.
5237 \def\lbracechar{{\string\indexlbrace}}%
5238 \def\rbracechar{{\string\indexrbrace}}%
5239 \let\{=\lbracechar
5240 \let\}=\rbracechar
5241 \def\@{{\string\indexatchar}}%
5242 \def\atchar##1{\@}%
5243 \def\backslashchar{{\string\indexbackslash}}%
5244 \uccode`\~=`\\ \uppercase{\let~\backslashchar}%
5246 \let\indexsortkey\empty
5247 \global\let\pagenumbertext\empty
5248 % Execute the segment and throw away the typeset output. This executes
5249 % any @sortas or @seealso commands in this segment.
5250 \setbox\dummybox = \hbox{\segment}%
5251 \ifx\indexsortkey\empty{%
5252 \indexnonalnumdisappear
5253 \xdef\trimmed{\segment}%
5254 \xdef\trimmed{\expandafter\eatspaces\expandafter{\trimmed}}%
5255 \xdef\indexsortkey{\trimmed}%
5256 \ifx\indexsortkey\empty\xdef\indexsortkey{ }\fi
5257 }\fi
5259 % Append to \fullindexsortkey.
5260 \edef\tmp{\gdef\noexpand\fullindexsortkey{%
5261 \fullindexsortkey\sep\indexsortkey}}%
5262 \tmp
5263 \egroup
5264 \def\sep{\subentry}%
5266 \expandafter\doindexsegment
5269 \def\isfinish{\finish}%
5270 \newbox\dummybox % used above
5272 \let\subentry\relax
5274 % Use \ instead of @ in index files. To support old texi2dvi and texindex.
5275 % This works without changing the escape character used in the toc or aux
5276 % files because the index entries are fully expanded here, and \string uses
5277 % the current value of \escapechar.
5278 \def\escapeisbackslash{\escapechar=`\\}
5280 % Use \ in index files by default. texi2dvi didn't support @ as the escape
5281 % character (as it checked for "\entry" in the files, and not "@entry"). When
5282 % the new version of texi2dvi has had a chance to become more prevalent, then
5283 % the escape character can change back to @ again. This should be an easy
5284 % change to make now because both @ and \ are only used as escape characters in
5285 % index files, never standing for themselves.
5287 \set txiindexescapeisbackslash
5289 % Write the entry in \indextext to the index file.
5292 \newif\ifincodeindex
5293 \def\doindwrite{\incodeindexfalse\doindwritex}
5294 \def\docindwrite{\incodeindextrue\doindwritex}
5296 \def\doindwritex{%
5297 \maybemarginindex
5299 \atdummies
5301 \expandafter\ifx\csname SETtxiindexescapeisbackslash\endcsname\relax\else
5302 \escapeisbackslash
5305 % For texindex which always views { and } as separators.
5306 \def\{{\lbracechar{}}%
5307 \def\}{\rbracechar{}}%
5308 \uccode`\~=`\\ \uppercase{\def~{\backslashchar{}}}%
5310 % Split the entry into primary entry and any subentries, and get the index
5311 % sort key.
5312 \splitindexentry\indextext
5314 % Set up the complete index entry, with both the sort key and
5315 % the original text, including any font commands. We write
5316 % three arguments to \entry to the .?? file (four in the
5317 % subentry case), texindex reduces to two when writing the .??s
5318 % sorted result.
5320 \edef\temp{%
5321 \write\writeto{%
5322 \string\entry{\fullindexsortkey}%
5323 {\ifx\pagenumbertext\empty\noexpand\folio\else\pagenumbertext\fi}%
5324 \bracedtext}%
5326 \temp
5329 % Put the index entry in the margin if desired (undocumented).
5330 \def\maybemarginindex{%
5331 \ifx\SETmarginindex\relax\else
5332 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \relax\indextext}}%
5335 \let\SETmarginindex=\relax
5338 % Take care of unwanted page breaks/skips around a whatsit:
5340 % If a skip is the last thing on the list now, preserve it
5341 % by backing up by \lastskip, doing the \write, then inserting
5342 % the skip again. Otherwise, the whatsit generated by the
5343 % \write or \pdfdest will make \lastskip zero. The result is that
5344 % sequences like this:
5345 % @end defun
5346 % @tindex whatever
5347 % @defun ...
5348 % will have extra space inserted, because the \medbreak in the
5349 % start of the @defun won't see the skip inserted by the @end of
5350 % the previous defun.
5352 % But don't do any of this if we're not in vertical mode. We
5353 % don't want to do a \vskip and prematurely end a paragraph.
5355 % Avoid page breaks due to these extra skips, too.
5357 % But wait, there is a catch there:
5358 % We'll have to check whether \lastskip is zero skip. \ifdim is not
5359 % sufficient for this purpose, as it ignores stretch and shrink parts
5360 % of the skip. The only way seems to be to check the textual
5361 % representation of the skip.
5363 % The following is almost like \def\zeroskipmacro{0.0pt} except that
5364 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
5366 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
5368 \newskip\whatsitskip
5369 \newcount\whatsitpenalty
5371 % ..., ready, GO:
5373 \def\safewhatsit#1{\ifhmode
5375 \else
5376 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
5377 \whatsitskip = \lastskip
5378 \edef\lastskipmacro{\the\lastskip}%
5379 \whatsitpenalty = \lastpenalty
5381 % If \lastskip is nonzero, that means the last item was a
5382 % skip. And since a skip is discardable, that means this
5383 % -\whatsitskip glue we're inserting is preceded by a
5384 % non-discardable item, therefore it is not a potential
5385 % breakpoint, therefore no \nobreak needed.
5386 \ifx\lastskipmacro\zeroskipmacro
5387 \else
5388 \vskip-\whatsitskip
5393 \ifx\lastskipmacro\zeroskipmacro
5394 % If \lastskip was zero, perhaps the last item was a penalty, and
5395 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
5396 % to re-insert the same penalty (values >10000 are used for various
5397 % signals); since we just inserted a non-discardable item, any
5398 % following glue (such as a \parskip) would be a breakpoint. For example:
5399 % @deffn deffn-whatever
5400 % @vindex index-whatever
5401 % Description.
5402 % would allow a break between the index-whatever whatsit
5403 % and the "Description." paragraph.
5404 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
5405 \else
5406 % On the other hand, if we had a nonzero \lastskip,
5407 % this make-up glue would be preceded by a non-discardable item
5408 % (the whatsit from the \write), so we must insert a \nobreak.
5409 \nobreak\vskip\whatsitskip
5411 \fi}
5413 % The index entry written in the file actually looks like
5414 % \entry {sortstring}{page}{topic}
5415 % or
5416 % \entry {sortstring}{page}{topic}{subtopic}
5417 % The texindex program reads in these files and writes files
5418 % containing these kinds of lines:
5419 % \initial {c}
5420 % before the first topic whose initial is c
5421 % \entry {topic}{pagelist}
5422 % for a topic that is used without subtopics
5423 % \primary {topic}
5424 % \entry {topic}{}
5425 % for the beginning of a topic that is used with subtopics
5426 % \secondary {subtopic}{pagelist}
5427 % for each subtopic.
5428 % \secondary {subtopic}{}
5429 % for a subtopic with sub-subtopics
5430 % \tertiary {subtopic}{subsubtopic}{pagelist}
5431 % for each sub-subtopic.
5433 % Define the user-accessible indexing commands
5434 % @findex, @vindex, @kindex, @cindex.
5436 \def\findex {\fnindex}
5437 \def\kindex {\kyindex}
5438 \def\cindex {\cpindex}
5439 \def\vindex {\vrindex}
5440 \def\tindex {\tpindex}
5441 \def\pindex {\pgindex}
5443 % Define the macros used in formatting output of the sorted index material.
5445 % @printindex causes a particular index (the ??s file) to get printed.
5446 % It does not print any chapter heading (usually an @unnumbered).
5448 \parseargdef\printindex{\begingroup
5449 \dobreak \chapheadingskip{10000}%
5451 \smallfonts \rm
5452 \tolerance = 9500
5453 \plainfrenchspacing
5454 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
5456 % See comment in \requireopenindexfile.
5457 \def\indexname{#1}\ifx\indexname\indexisfl\def\indexname{f1}\fi
5459 % See if the index file exists and is nonempty.
5460 \openin 1 \jobname.\indexname s
5461 \ifeof 1
5462 % \enddoublecolumns gets confused if there is no text in the index,
5463 % and it loses the chapter title and the aux file entries for the
5464 % index. The easiest way to prevent this problem is to make sure
5465 % there is some text.
5466 \putwordIndexNonexistent
5467 \typeout{No file \jobname.\indexname s.}%
5468 \else
5469 % If the index file exists but is empty, then \openin leaves \ifeof
5470 % false. We have to make TeX try to read something from the file, so
5471 % it can discover if there is anything in it.
5472 \read 1 to \thisline
5473 \ifeof 1
5474 \putwordIndexIsEmpty
5475 \else
5476 \expandafter\printindexzz\thisline\relax\relax\finish%
5479 \closein 1
5480 \endgroup}
5482 % If the index file starts with a backslash, forgo reading the index
5483 % file altogether. If somebody upgrades texinfo.tex they may still have
5484 % old index files using \ as the escape character. Reading this would
5485 % at best lead to typesetting garbage, at worst a TeX syntax error.
5486 \def\printindexzz#1#2\finish{%
5487 \expandafter\ifx\csname SETtxiindexescapeisbackslash\endcsname\relax
5488 \uccode`\~=`\\ \uppercase{\if\noexpand~}\noexpand#1
5489 \expandafter\ifx\csname SETtxiskipindexfileswithbackslash\endcsname\relax
5490 \errmessage{%
5491 ERROR: A sorted index file in an obsolete format was skipped.
5492 To fix this problem, please upgrade your version of 'texi2dvi'
5493 or 'texi2pdf' to that at <https://ftp.gnu.org/gnu/texinfo>.
5494 If you are using an old version of 'texindex' (part of the Texinfo
5495 distribution), you may also need to upgrade to a newer version (at least 6.0).
5496 You may be able to typeset the index if you run
5497 'texindex \jobname.\indexname' yourself.
5498 You could also try setting the 'txiindexescapeisbackslash' flag by
5499 running a command like
5500 'texi2dvi -t "@set txiindexescapeisbackslash" \jobname.texi'. If you do
5501 this, Texinfo will try to use index files in the old format.
5502 If you continue to have problems, deleting the index files and starting again
5503 might help (with 'rm \jobname.?? \jobname.??s')%
5505 \else
5506 (Skipped sorted index file in obsolete format)
5508 \else
5509 \begindoublecolumns
5510 \input \jobname.\indexname s
5511 \enddoublecolumns
5513 \else
5514 \begindoublecolumns
5515 \catcode`\\=0\relax
5517 % Make @ an escape character to give macros a chance to work. This
5518 % should work because we (hopefully) don't otherwise use @ in index files.
5519 %\catcode`\@=12\relax
5520 \catcode`\@=0\relax
5521 \input \jobname.\indexname s
5522 \enddoublecolumns
5526 % These macros are used by the sorted index file itself.
5527 % Change them to control the appearance of the index.
5529 {\catcode`\/=13 \catcode`\-=13 \catcode`\^=13 \catcode`\~=13 \catcode`\_=13
5530 \catcode`\|=13 \catcode`\<=13 \catcode`\>=13 \catcode`\+=13 \catcode`\"=13
5531 \catcode`\$=3
5532 \gdef\initialglyphs{%
5533 % special control sequences used in the index sort key
5534 \let\indexlbrace\{%
5535 \let\indexrbrace\}%
5536 \let\indexatchar\@%
5537 \def\indexbackslash{\math{\backslash}}%
5539 % Some changes for non-alphabetic characters. Using the glyphs from the
5540 % math fonts looks more consistent than the typewriter font used elsewhere
5541 % for these characters.
5542 \uccode`\~=`\\ \uppercase{\def~{\math{\backslash}}}
5544 % In case @\ is used for backslash
5545 \uppercase{\let\\=~}
5546 % Can't get bold backslash so don't use bold forward slash
5547 \catcode`\/=13
5548 \def/{{\secrmnotbold \normalslash}}%
5549 \def-{{\normaldash\normaldash}}% en dash `--'
5550 \def^{{\chapbf \normalcaret}}%
5551 \def~{{\chapbf \normaltilde}}%
5552 \def\_{%
5553 \leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }%
5554 \def|{$\vert$}%
5555 \def<{$\less$}%
5556 \def>{$\gtr$}%
5557 \def+{$\normalplus$}%
5560 \def\initial{%
5561 \bgroup
5562 \initialglyphs
5563 \initialx
5566 \def\initialx#1{%
5567 % Remove any glue we may have, we'll be inserting our own.
5568 \removelastskip
5570 % We like breaks before the index initials, so insert a bonus.
5571 % The glue before the bonus allows a little bit of space at the
5572 % bottom of a column to reduce an increase in inter-line spacing.
5573 \nobreak
5574 \vskip 0pt plus 5\baselineskip
5575 \penalty -300
5576 \vskip 0pt plus -5\baselineskip
5578 % Typeset the initial. Making this add up to a whole number of
5579 % baselineskips increases the chance of the dots lining up from column
5580 % to column. It still won't often be perfect, because of the stretch
5581 % we need before each entry, but it's better.
5583 % No shrink because it confuses \balancecolumns.
5584 \vskip 1.67\baselineskip plus 1\baselineskip
5585 \leftline{\secfonts \kern-0.05em \secbf #1}%
5586 % \secfonts is inside the argument of \leftline so that the change of
5587 % \baselineskip will not affect any glue inserted before the vbox that
5588 % \leftline creates.
5589 % Do our best not to break after the initial.
5590 \nobreak
5591 \vskip .33\baselineskip plus .1\baselineskip
5592 \egroup % \initialglyphs
5595 \newdimen\entryrightmargin
5596 \entryrightmargin=0pt
5598 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
5599 % then page number (#2) flushed to the right margin. It is used for index
5600 % and table of contents entries. The paragraph is indented by \leftskip.
5602 \def\entry{%
5603 \begingroup
5605 % Start a new paragraph if necessary, so our assignments below can't
5606 % affect previous text.
5607 \par
5609 % No extra space above this paragraph.
5610 \parskip = 0in
5612 % When reading the text of entry, convert explicit line breaks
5613 % from @* into spaces. The user might give these in long section
5614 % titles, for instance.
5615 \def\*{\unskip\space\ignorespaces}%
5616 \def\entrybreak{\hfil\break}% An undocumented command
5618 % Swallow the left brace of the text (first parameter):
5619 \afterassignment\doentry
5620 \let\temp =
5622 \def\entrybreak{\unskip\space\ignorespaces}%
5623 \def\doentry{%
5624 % Save the text of the entry
5625 \global\setbox\boxA=\hbox\bgroup
5626 \bgroup % Instead of the swallowed brace.
5627 \noindent
5628 \aftergroup\finishentry
5629 % And now comes the text of the entry.
5630 % Not absorbing as a macro argument reduces the chance of problems
5631 % with catcodes occurring.
5633 {\catcode`\@=11
5634 \gdef\finishentry#1{%
5635 \egroup % end box A
5636 \dimen@ = \wd\boxA % Length of text of entry
5637 \global\setbox\boxA=\hbox\bgroup
5638 \unhbox\boxA
5639 % #1 is the page number.
5641 % Get the width of the page numbers, and only use
5642 % leaders if they are present.
5643 \global\setbox\boxB = \hbox{#1}%
5644 \ifdim\wd\boxB = 0pt
5645 \null\nobreak\hfill\ %
5646 \else
5648 \null\nobreak\indexdotfill % Have leaders before the page number.
5650 \ifpdforxetex
5651 \pdfgettoks#1.%
5652 \hskip\skip\thinshrinkable\the\toksA
5653 \else
5654 \hskip\skip\thinshrinkable #1%
5657 \egroup % end \boxA
5658 \ifdim\wd\boxB = 0pt
5659 \noindent\unhbox\boxA\par
5660 \nobreak
5661 \else\bgroup
5662 % We want the text of the entries to be aligned to the left, and the
5663 % page numbers to be aligned to the right.
5665 \parindent = 0pt
5666 \advance\leftskip by 0pt plus 1fil
5667 \advance\leftskip by 0pt plus -1fill
5668 \rightskip = 0pt plus -1fil
5669 \advance\rightskip by 0pt plus 1fill
5670 % Cause last line, which could consist of page numbers on their own
5671 % if the list of page numbers is long, to be aligned to the right.
5672 \parfillskip=0pt plus -1fill
5674 \advance\rightskip by \entryrightmargin
5675 % Determine how far we can stretch into the margin.
5676 % This allows, e.g., "Appendix H GNU Free Documentation License" to
5677 % fit on one line in @letterpaper format.
5678 \ifdim\entryrightmargin>2.1em
5679 \dimen@i=2.1em
5680 \else
5681 \dimen@i=0em
5683 \advance \parfillskip by 0pt minus 1\dimen@i
5685 \dimen@ii = \hsize
5686 \advance\dimen@ii by -1\leftskip
5687 \advance\dimen@ii by -1\entryrightmargin
5688 \advance\dimen@ii by 1\dimen@i
5689 \ifdim\wd\boxA > \dimen@ii % If the entry doesn't fit in one line
5690 \ifdim\dimen@ > 0.8\dimen@ii % due to long index text
5691 % Try to split the text roughly evenly. \dimen@ will be the length of
5692 % the first line.
5693 \dimen@ = 0.7\dimen@
5694 \dimen@ii = \hsize
5695 \ifnum\dimen@>\dimen@ii
5696 % If the entry is too long (for example, if it needs more than
5697 % two lines), use all the space in the first line.
5698 \dimen@ = \dimen@ii
5700 \advance\leftskip by 0pt plus 1fill % ragged right
5701 \advance \dimen@ by 1\rightskip
5702 \parshape = 2 0pt \dimen@ 0em \dimen@ii
5703 % Ideally we'd add a finite glue at the end of the first line only,
5704 % instead of using \parshape with explicit line lengths, but TeX
5705 % doesn't seem to provide a way to do such a thing.
5707 % Indent all lines but the first one.
5708 \advance\leftskip by 1em
5709 \advance\parindent by -1em
5710 \fi\fi
5711 \indent % start paragraph
5712 \unhbox\boxA
5714 % Do not prefer a separate line ending with a hyphen to fewer lines.
5715 \finalhyphendemerits = 0
5717 % Word spacing - no stretch
5718 \spaceskip=\fontdimen2\font minus \fontdimen4\font
5720 \linepenalty=1000 % Discourage line breaks.
5721 \hyphenpenalty=5000 % Discourage hyphenation.
5723 \par % format the paragraph
5724 \egroup % The \vbox
5726 \endgroup
5729 \newskip\thinshrinkable
5730 \skip\thinshrinkable=.15em minus .15em
5732 % Like plain.tex's \dotfill, except uses up at least 1 em.
5733 % The filll stretch here overpowers both the fil and fill stretch to push
5734 % the page number to the right.
5735 \def\indexdotfill{\cleaders
5736 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1filll}
5739 \def\primary #1{\line{#1\hfil}}
5741 \def\secondary{\indententry{0.5cm}}
5742 \def\tertiary{\indententry{1cm}}
5744 \def\indententry#1#2#3{%
5745 \bgroup
5746 \leftskip=#1
5747 \entry{#2}{#3}%
5748 \egroup
5751 % Define two-column mode, which we use to typeset indexes.
5752 % Adapted from the TeXbook, page 416, which is to say,
5753 % the manmac.tex format used to print the TeXbook itself.
5754 \catcode`\@=11 % private names
5756 \newbox\partialpage
5757 \newdimen\doublecolumnhsize
5759 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5760 % If not much space left on page, start a new page.
5761 \ifdim\pagetotal>0.8\vsize\vfill\eject\fi
5763 % Grab any single-column material above us.
5764 \output = {%
5765 \savetopmark
5767 \global\setbox\partialpage = \vbox{%
5768 % Unvbox the main output page.
5769 \unvbox\PAGE
5770 \kern-\topskip \kern\baselineskip
5773 \eject % run that output routine to set \partialpage
5775 % Use the double-column output routine for subsequent pages.
5776 \output = {\doublecolumnout}%
5778 % Change the page size parameters. We could do this once outside this
5779 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5780 % format, but then we repeat the same computation. Repeating a couple
5781 % of assignments once per index is clearly meaningless for the
5782 % execution time, so we may as well do it in one place.
5784 % First we halve the line length, less a little for the gutter between
5785 % the columns. We compute the gutter based on the line length, so it
5786 % changes automatically with the paper format. The magic constant
5787 % below is chosen so that the gutter has the same value (well, +-<1pt)
5788 % as it did when we hard-coded it.
5790 % We put the result in a separate register, \doublecolumhsize, so we
5791 % can restore it in \pagesofar, after \hsize itself has (potentially)
5792 % been clobbered.
5794 \doublecolumnhsize = \hsize
5795 \advance\doublecolumnhsize by -.04154\hsize
5796 \divide\doublecolumnhsize by 2
5797 \hsize = \doublecolumnhsize
5799 % Get the available space for the double columns -- the normal
5800 % (undoubled) page height minus any material left over from the
5801 % previous page.
5802 \advance\vsize by -\ht\partialpage
5803 \vsize = 2\vsize
5805 % For the benefit of balancing columns
5806 \advance\baselineskip by 0pt plus 0.5pt
5809 % The double-column output routine for all double-column pages except
5810 % the last, which is done by \balancecolumns.
5812 \def\doublecolumnout{%
5814 \savetopmark
5815 \splittopskip=\topskip \splitmaxdepth=\maxdepth
5816 \dimen@ = \vsize
5817 \divide\dimen@ by 2
5819 % box0 will be the left-hand column, box2 the right.
5820 \setbox0=\vsplit\PAGE to\dimen@ \setbox2=\vsplit\PAGE to\dimen@
5821 \global\advance\vsize by 2\ht\partialpage
5822 \onepageout\pagesofar % empty except for the first time we are called
5823 \unvbox\PAGE
5824 \penalty\outputpenalty
5827 % Re-output the contents of the output page -- any previous material,
5828 % followed by the two boxes we just split, in box0 and box2.
5829 \def\pagesofar{%
5830 \unvbox\partialpage
5832 \hsize = \doublecolumnhsize
5833 \wd0=\hsize \wd2=\hsize
5834 \hbox to\txipagewidth{\box0\hfil\box2}%
5838 % Finished with double columns.
5839 \def\enddoublecolumns{%
5840 % The following penalty ensures that the page builder is exercised
5841 % _before_ we change the output routine. This is necessary in the
5842 % following situation:
5844 % The last section of the index consists only of a single entry.
5845 % Before this section, \pagetotal is less than \pagegoal, so no
5846 % break occurs before the last section starts. However, the last
5847 % section, consisting of \initial and the single \entry, does not
5848 % fit on the page and has to be broken off. Without the following
5849 % penalty the page builder will not be exercised until \eject
5850 % below, and by that time we'll already have changed the output
5851 % routine to the \balancecolumns version, so the next-to-last
5852 % double-column page will be processed with \balancecolumns, which
5853 % is wrong: The two columns will go to the main vertical list, with
5854 % the broken-off section in the recent contributions. As soon as
5855 % the output routine finishes, TeX starts reconsidering the page
5856 % break. The two columns and the broken-off section both fit on the
5857 % page, because the two columns now take up only half of the page
5858 % goal. When TeX sees \eject from below which follows the final
5859 % section, it invokes the new output routine that we've set after
5860 % \balancecolumns below; \onepageout will try to fit the two columns
5861 % and the final section into the vbox of \txipageheight (see
5862 % \pagebody), causing an overfull box.
5864 % Note that glue won't work here, because glue does not exercise the
5865 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5866 \penalty0
5868 \output = {%
5869 % Split the last of the double-column material.
5870 \savetopmark
5871 \balancecolumns
5873 \eject % call the \output just set
5874 \ifdim\pagetotal=0pt
5875 % Having called \balancecolumns once, we do not
5876 % want to call it again. Therefore, reset \output to its normal
5877 % definition right away.
5878 \global\output=\expandafter{\the\defaultoutput}
5880 \endgroup % started in \begindoublecolumns
5881 % Leave the double-column material on the current page, no automatic
5882 % page break.
5883 \box\balancedcolumns
5885 % \pagegoal was set to the doubled \vsize above, since we restarted
5886 % the current page. We're now back to normal single-column
5887 % typesetting, so reset \pagegoal to the normal \vsize.
5888 \global\vsize = \txipageheight %
5889 \pagegoal = \txipageheight %
5890 \else
5891 % We had some left-over material. This might happen when \doublecolumnout
5892 % is called in \balancecolumns. Try again.
5893 \expandafter\enddoublecolumns
5896 \newbox\balancedcolumns
5897 \setbox\balancedcolumns=\vbox{shouldnt see this}%
5899 % Only called for the last of the double column material. \doublecolumnout
5900 % does the others.
5901 \def\balancecolumns{%
5902 \setbox0 = \vbox{\unvbox\PAGE}% like \box255 but more efficient, see p.120.
5903 \dimen@ = \ht0
5904 \ifdim\dimen@<7\baselineskip
5905 % Don't split a short final column in two.
5906 \setbox2=\vbox{}%
5907 \global\setbox\balancedcolumns=\vbox{\pagesofar}%
5908 \else
5909 % double the leading vertical space
5910 \advance\dimen@ by \topskip
5911 \advance\dimen@ by-\baselineskip
5912 \divide\dimen@ by 2 % target to split to
5913 \dimen@ii = \dimen@
5914 \splittopskip = \topskip
5915 % Loop until left column is at least as high as the right column.
5917 \vbadness = 10000
5918 \loop
5919 \global\setbox3 = \copy0
5920 \global\setbox1 = \vsplit3 to \dimen@
5921 \ifdim\ht1<\ht3
5922 \global\advance\dimen@ by 1pt
5923 \repeat
5925 % Now the left column is in box 1, and the right column in box 3.
5927 % Check whether the left column has come out higher than the page itself.
5928 % (Note that we have doubled \vsize for the double columns, so
5929 % the actual height of the page is 0.5\vsize).
5930 \ifdim2\ht1>\vsize
5931 % It appears that we have been called upon to balance too much material.
5932 % Output some of it with \doublecolumnout, leaving the rest on the page.
5933 \setbox\PAGE=\box0
5934 \doublecolumnout
5935 \else
5936 % Compare the heights of the two columns.
5937 \ifdim4\ht1>5\ht3
5938 % Column heights are too different, so don't make their bottoms
5939 % flush with each other.
5940 \setbox2=\vbox to \ht1 {\unvbox3\vfill}%
5941 \setbox0=\vbox to \ht1 {\unvbox1\vfill}%
5942 \else
5943 % Make column bottoms flush with each other.
5944 \setbox2=\vbox to\ht1{\unvbox3\unskip}%
5945 \setbox0=\vbox to\ht1{\unvbox1\unskip}%
5947 \global\setbox\balancedcolumns=\vbox{\pagesofar}%
5952 \catcode`\@ = \other
5955 \message{sectioning,}
5956 % Chapters, sections, etc.
5958 % Let's start with @part.
5959 \parseargdef\part{\partzzz{#1}}
5960 \def\partzzz#1{%
5961 \chapoddpage
5962 \null
5963 \vskip.3\vsize % move it down on the page a bit
5964 \begingroup
5965 \noindent \titlefonts\rm #1\par % the text
5966 \let\lastnode=\empty % no node to associate with
5967 \writetocentry{part}{#1}{}% but put it in the toc
5968 \headingsoff % no headline or footline on the part page
5969 % This outputs a mark at the end of the page that clears \thischapter
5970 % and \thissection, as is done in \startcontents.
5971 \let\pchapsepmacro\relax
5972 \chapmacro{}{Yomitfromtoc}{}%
5973 \chapoddpage
5974 \endgroup
5977 % \unnumberedno is an oxymoron. But we count the unnumbered
5978 % sections so that we can refer to them unambiguously in the pdf
5979 % outlines by their "section number". We avoid collisions with chapter
5980 % numbers by starting them at 10000. (If a document ever has 10000
5981 % chapters, we're in trouble anyway, I'm sure.)
5982 \newcount\unnumberedno \unnumberedno = 10000
5983 \newcount\chapno
5984 \newcount\secno \secno=0
5985 \newcount\subsecno \subsecno=0
5986 \newcount\subsubsecno \subsubsecno=0
5988 % This counter is funny since it counts through charcodes of letters A, B, ...
5989 \newcount\appendixno \appendixno = `\@
5991 % \def\appendixletter{\char\the\appendixno}
5992 % We do the following ugly conditional instead of the above simple
5993 % construct for the sake of pdftex, which needs the actual
5994 % letter in the expansion, not just typeset.
5996 \def\appendixletter{%
5997 \ifnum\appendixno=`A A%
5998 \else\ifnum\appendixno=`B B%
5999 \else\ifnum\appendixno=`C C%
6000 \else\ifnum\appendixno=`D D%
6001 \else\ifnum\appendixno=`E E%
6002 \else\ifnum\appendixno=`F F%
6003 \else\ifnum\appendixno=`G G%
6004 \else\ifnum\appendixno=`H H%
6005 \else\ifnum\appendixno=`I I%
6006 \else\ifnum\appendixno=`J J%
6007 \else\ifnum\appendixno=`K K%
6008 \else\ifnum\appendixno=`L L%
6009 \else\ifnum\appendixno=`M M%
6010 \else\ifnum\appendixno=`N N%
6011 \else\ifnum\appendixno=`O O%
6012 \else\ifnum\appendixno=`P P%
6013 \else\ifnum\appendixno=`Q Q%
6014 \else\ifnum\appendixno=`R R%
6015 \else\ifnum\appendixno=`S S%
6016 \else\ifnum\appendixno=`T T%
6017 \else\ifnum\appendixno=`U U%
6018 \else\ifnum\appendixno=`V V%
6019 \else\ifnum\appendixno=`W W%
6020 \else\ifnum\appendixno=`X X%
6021 \else\ifnum\appendixno=`Y Y%
6022 \else\ifnum\appendixno=`Z Z%
6023 % The \the is necessary, despite appearances, because \appendixletter is
6024 % expanded while writing the .toc file. \char\appendixno is not
6025 % expandable, thus it is written literally, thus all appendixes come out
6026 % with the same letter (or @) in the toc without it.
6027 \else\char\the\appendixno
6028 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
6029 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
6031 % Each @chapter defines these (using marks) as the number+name, number
6032 % and name of the chapter. Page headings and footings can use
6033 % these. @section does likewise.
6034 \def\thischapter{}
6035 \def\thischapternum{}
6036 \def\thischaptername{}
6037 \def\thissection{}
6038 \def\thissectionnum{}
6039 \def\thissectionname{}
6041 \newcount\absseclevel % used to calculate proper heading level
6042 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
6044 % @raisesections: treat @section as chapter, @subsection as section, etc.
6045 \def\raisesections{\global\advance\secbase by -1}
6047 % @lowersections: treat @chapter as section, @section as subsection, etc.
6048 \def\lowersections{\global\advance\secbase by 1}
6050 % we only have subsub.
6051 \chardef\maxseclevel = 3
6053 % A numbered section within an unnumbered changes to unnumbered too.
6054 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
6055 \chardef\unnlevel = \maxseclevel
6057 % Trace whether the current chapter is an appendix or not:
6058 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
6059 \def\chapheadtype{N}
6061 % Choose a heading macro
6062 % #1 is heading type
6063 % #2 is heading level
6064 % #3 is text for heading
6065 \def\genhead#1#2#3{%
6066 % Compute the abs. sec. level:
6067 \absseclevel=#2
6068 \advance\absseclevel by \secbase
6069 % Make sure \absseclevel doesn't fall outside the range:
6070 \ifnum \absseclevel < 0
6071 \absseclevel = 0
6072 \else
6073 \ifnum \absseclevel > 3
6074 \absseclevel = 3
6077 % The heading type:
6078 \def\headtype{#1}%
6079 \if \headtype U%
6080 \ifnum \absseclevel < \unnlevel
6081 \chardef\unnlevel = \absseclevel
6083 \else
6084 % Check for appendix sections:
6085 \ifnum \absseclevel = 0
6086 \edef\chapheadtype{\headtype}%
6087 \else
6088 \if \headtype A\if \chapheadtype N%
6089 \errmessage{@appendix... within a non-appendix chapter}%
6090 \fi\fi
6092 % Check for numbered within unnumbered:
6093 \ifnum \absseclevel > \unnlevel
6094 \def\headtype{U}%
6095 \else
6096 \chardef\unnlevel = 3
6099 % Now print the heading:
6100 \if \headtype U%
6101 \ifcase\absseclevel
6102 \unnumberedzzz{#3}%
6103 \or \unnumberedseczzz{#3}%
6104 \or \unnumberedsubseczzz{#3}%
6105 \or \unnumberedsubsubseczzz{#3}%
6107 \else
6108 \if \headtype A%
6109 \ifcase\absseclevel
6110 \appendixzzz{#3}%
6111 \or \appendixsectionzzz{#3}%
6112 \or \appendixsubseczzz{#3}%
6113 \or \appendixsubsubseczzz{#3}%
6115 \else
6116 \ifcase\absseclevel
6117 \chapterzzz{#3}%
6118 \or \seczzz{#3}%
6119 \or \numberedsubseczzz{#3}%
6120 \or \numberedsubsubseczzz{#3}%
6124 \suppressfirstparagraphindent
6127 % an interface:
6128 \def\numhead{\genhead N}
6129 \def\apphead{\genhead A}
6130 \def\unnmhead{\genhead U}
6132 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
6133 % all lower-level sectioning counters to zero.
6135 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
6136 % (e.g., figures), q.v. By default (before any chapter), that is empty.
6137 \let\chaplevelprefix = \empty
6139 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
6140 \def\chapterzzz#1{%
6141 % section resetting is \global in case the chapter is in a group, such
6142 % as an @include file.
6143 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6144 \global\advance\chapno by 1
6146 % Used for \float.
6147 \gdef\chaplevelprefix{\the\chapno.}%
6148 \resetallfloatnos
6150 % \putwordChapter can contain complex things in translations.
6151 \toks0=\expandafter{\putwordChapter}%
6152 \message{\the\toks0 \space \the\chapno}%
6154 % Write the actual heading.
6155 \chapmacro{#1}{Ynumbered}{\the\chapno}%
6157 % So @section and the like are numbered underneath this chapter.
6158 \global\let\section = \numberedsec
6159 \global\let\subsection = \numberedsubsec
6160 \global\let\subsubsection = \numberedsubsubsec
6163 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
6165 \def\appendixzzz#1{%
6166 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6167 \global\advance\appendixno by 1
6168 \gdef\chaplevelprefix{\appendixletter.}%
6169 \resetallfloatnos
6171 % \putwordAppendix can contain complex things in translations.
6172 \toks0=\expandafter{\putwordAppendix}%
6173 \message{\the\toks0 \space \appendixletter}%
6175 \chapmacro{#1}{Yappendix}{\appendixletter}%
6177 \global\let\section = \appendixsec
6178 \global\let\subsection = \appendixsubsec
6179 \global\let\subsubsection = \appendixsubsubsec
6182 % normally unnmhead0 calls unnumberedzzz:
6183 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
6184 \def\unnumberedzzz#1{%
6185 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6186 \global\advance\unnumberedno by 1
6188 % Since an unnumbered has no number, no prefix for figures.
6189 \global\let\chaplevelprefix = \empty
6190 \resetallfloatnos
6192 % This used to be simply \message{#1}, but TeX fully expands the
6193 % argument to \message. Therefore, if #1 contained @-commands, TeX
6194 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
6195 % expanded @cite (which turns out to cause errors because \cite is meant
6196 % to be executed, not expanded).
6198 % Anyway, we don't want the fully-expanded definition of @cite to appear
6199 % as a result of the \message, we just want `@cite' itself. We use
6200 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
6201 % simply yielding the contents of <toks register>. (We also do this for
6202 % the toc entries.)
6203 \toks0 = {#1}%
6204 \message{(\the\toks0)}%
6206 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
6208 \global\let\section = \unnumberedsec
6209 \global\let\subsection = \unnumberedsubsec
6210 \global\let\subsubsection = \unnumberedsubsubsec
6213 % @centerchap is like @unnumbered, but the heading is centered.
6214 \outer\parseargdef\centerchap{%
6215 \let\centerparametersmaybe = \centerparameters
6216 \unnmhead0{#1}%
6217 \let\centerparametersmaybe = \relax
6220 % @top is like @unnumbered.
6221 \let\top\unnumbered
6223 % Sections.
6225 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
6226 \def\seczzz#1{%
6227 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
6228 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
6231 % normally calls appendixsectionzzz:
6232 \outer\parseargdef\appendixsection{\apphead1{#1}}
6233 \def\appendixsectionzzz#1{%
6234 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
6235 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
6237 \let\appendixsec\appendixsection
6239 % normally calls unnumberedseczzz:
6240 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
6241 \def\unnumberedseczzz#1{%
6242 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
6243 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
6246 % Subsections.
6248 % normally calls numberedsubseczzz:
6249 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
6250 \def\numberedsubseczzz#1{%
6251 \global\subsubsecno=0 \global\advance\subsecno by 1
6252 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
6255 % normally calls appendixsubseczzz:
6256 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
6257 \def\appendixsubseczzz#1{%
6258 \global\subsubsecno=0 \global\advance\subsecno by 1
6259 \sectionheading{#1}{subsec}{Yappendix}%
6260 {\appendixletter.\the\secno.\the\subsecno}%
6263 % normally calls unnumberedsubseczzz:
6264 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
6265 \def\unnumberedsubseczzz#1{%
6266 \global\subsubsecno=0 \global\advance\subsecno by 1
6267 \sectionheading{#1}{subsec}{Ynothing}%
6268 {\the\unnumberedno.\the\secno.\the\subsecno}%
6271 % Subsubsections.
6273 % normally numberedsubsubseczzz:
6274 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
6275 \def\numberedsubsubseczzz#1{%
6276 \global\advance\subsubsecno by 1
6277 \sectionheading{#1}{subsubsec}{Ynumbered}%
6278 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
6281 % normally appendixsubsubseczzz:
6282 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
6283 \def\appendixsubsubseczzz#1{%
6284 \global\advance\subsubsecno by 1
6285 \sectionheading{#1}{subsubsec}{Yappendix}%
6286 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
6289 % normally unnumberedsubsubseczzz:
6290 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
6291 \def\unnumberedsubsubseczzz#1{%
6292 \global\advance\subsubsecno by 1
6293 \sectionheading{#1}{subsubsec}{Ynothing}%
6294 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
6297 % These macros control what the section commands do, according
6298 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
6299 % Define them by default for a numbered chapter.
6300 \let\section = \numberedsec
6301 \let\subsection = \numberedsubsec
6302 \let\subsubsection = \numberedsubsubsec
6304 % Define @majorheading, @heading and @subheading
6306 \def\majorheading{%
6307 {\advance\chapheadingskip by 10pt \chapbreak }%
6308 \parsearg\chapheadingzzz
6311 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
6312 \def\chapheadingzzz#1{%
6313 \vbox{\chapfonts \raggedtitlesettings #1\par}%
6314 \nobreak\bigskip \nobreak
6315 \suppressfirstparagraphindent
6318 % @heading, @subheading, @subsubheading.
6319 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
6320 \suppressfirstparagraphindent}
6321 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
6322 \suppressfirstparagraphindent}
6323 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
6324 \suppressfirstparagraphindent}
6326 % These macros generate a chapter, section, etc. heading only
6327 % (including whitespace, linebreaking, etc. around it),
6328 % given all the information in convenient, parsed form.
6330 % Args are the skip and penalty (usually negative)
6331 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
6333 % Parameter controlling skip before chapter headings (if needed)
6334 \newskip\chapheadingskip
6336 % Define plain chapter starts, and page on/off switching for it.
6337 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
6339 % Start a new page
6340 \def\chappager{\par\vfill\supereject}
6342 % \chapoddpage - start on an odd page for a new chapter
6343 % Because \domark is called before \chapoddpage, the filler page will
6344 % get the headings for the next chapter, which is wrong. But we don't
6345 % care -- we just disable all headings on the filler page.
6346 \def\chapoddpage{%
6347 \chappager
6348 \ifodd\pageno \else
6349 \begingroup
6350 \headingsoff
6351 \null
6352 \chappager
6353 \endgroup
6357 \parseargdef\setchapternewpage{\csname CHAPPAG#1\endcsname}
6359 \def\CHAPPAGoff{%
6360 \global\let\contentsalignmacro = \chappager
6361 \global\let\pchapsepmacro=\chapbreak
6362 \global\def\HEADINGSon{\HEADINGSsinglechapoff}}
6364 \def\CHAPPAGon{%
6365 \global\let\contentsalignmacro = \chappager
6366 \global\let\pchapsepmacro=\chappager
6367 \global\def\HEADINGSon{\HEADINGSsingle}}
6369 \def\CHAPPAGodd{%
6370 \global\let\contentsalignmacro = \chapoddpage
6371 \global\let\pchapsepmacro=\chapoddpage
6372 \global\def\HEADINGSon{\HEADINGSdouble}}
6374 \CHAPPAGon
6376 % \chapmacro - Chapter opening.
6378 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
6379 % Yappendix, Yomitfromtoc), #3 the chapter number.
6380 % Not used for @heading series.
6382 % To test against our argument.
6383 \def\Ynothingkeyword{Ynothing}
6384 \def\Yappendixkeyword{Yappendix}
6385 \def\Yomitfromtockeyword{Yomitfromtoc}
6387 \def\chapmacro#1#2#3{%
6388 \expandafter\ifx\thisenv\titlepage\else
6389 \checkenv{}% chapters, etc., should not start inside an environment.
6391 % Insert the first mark before the heading break (see notes for \domark).
6392 \let\prevchapterdefs=\currentchapterdefs
6393 \let\prevsectiondefs=\currentsectiondefs
6394 \gdef\currentsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
6395 \gdef\thissection{}}%
6397 \def\temptype{#2}%
6398 \ifx\temptype\Ynothingkeyword
6399 \gdef\currentchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
6400 \gdef\thischapter{\thischaptername}}%
6401 \else\ifx\temptype\Yomitfromtockeyword
6402 \gdef\currentchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
6403 \gdef\thischapter{}}%
6404 \else\ifx\temptype\Yappendixkeyword
6405 \toks0={#1}%
6406 \xdef\currentchapterdefs{%
6407 \gdef\noexpand\thischaptername{\the\toks0}%
6408 \gdef\noexpand\thischapternum{\appendixletter}%
6409 % \noexpand\putwordAppendix avoids expanding indigestible
6410 % commands in some of the translations.
6411 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
6412 \noexpand\thischapternum:
6413 \noexpand\thischaptername}%
6415 \else
6416 \toks0={#1}%
6417 \xdef\currentchapterdefs{%
6418 \gdef\noexpand\thischaptername{\the\toks0}%
6419 \gdef\noexpand\thischapternum{\the\chapno}%
6420 % \noexpand\putwordChapter avoids expanding indigestible
6421 % commands in some of the translations.
6422 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
6423 \noexpand\thischapternum:
6424 \noexpand\thischaptername}%
6426 \fi\fi\fi
6428 % Output the mark. Pass it through \safewhatsit, to take care of
6429 % the preceding space.
6430 \safewhatsit\domark
6432 % Insert the chapter heading break.
6433 \pchapsepmacro
6435 % Now the second mark, after the heading break. No break points
6436 % between here and the heading.
6437 \let\prevchapterdefs=\currentchapterdefs
6438 \let\prevsectiondefs=\currentsectiondefs
6439 \domark
6442 \chapfonts \rm
6443 \let\footnote=\errfootnoteheading % give better error message
6445 % Have to define \currentsection before calling \donoderef, because the
6446 % xref code eventually uses it. On the other hand, it has to be called
6447 % after \pchapsepmacro, or the headline will change too soon.
6448 \gdef\currentsection{#1}%
6450 % Only insert the separating space if we have a chapter/appendix
6451 % number, and don't print the unnumbered ``number''.
6452 \ifx\temptype\Ynothingkeyword
6453 \setbox0 = \hbox{}%
6454 \def\toctype{unnchap}%
6455 \else\ifx\temptype\Yomitfromtockeyword
6456 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
6457 \def\toctype{omit}%
6458 \else\ifx\temptype\Yappendixkeyword
6459 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
6460 \def\toctype{app}%
6461 \else
6462 \setbox0 = \hbox{#3\enspace}%
6463 \def\toctype{numchap}%
6464 \fi\fi\fi
6466 % Write the toc entry for this chapter. Must come before the
6467 % \donoderef, because we include the current node name in the toc
6468 % entry, and \donoderef resets it to empty.
6469 \writetocentry{\toctype}{#1}{#3}%
6471 % For pdftex, we have to write out the node definition (aka, make
6472 % the pdfdest) after any page break, but before the actual text has
6473 % been typeset. If the destination for the pdf outline is after the
6474 % text, then jumping from the outline may wind up with the text not
6475 % being visible, for instance under high magnification.
6476 \donoderef{#2}%
6478 % Typeset the actual heading.
6479 \nobreak % Avoid page breaks at the interline glue.
6480 \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe
6481 \unhbox0 #1\par}%
6483 \nobreak\bigskip % no page break after a chapter title
6484 \nobreak
6487 % @centerchap -- centered and unnumbered.
6488 \let\centerparametersmaybe = \relax
6489 \def\centerparameters{%
6490 \advance\rightskip by 3\rightskip
6491 \leftskip = \rightskip
6492 \parfillskip = 0pt
6496 % Section titles. These macros combine the section number parts and
6497 % call the generic \sectionheading to do the printing.
6499 \newskip\secheadingskip
6500 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
6502 % Subsection titles.
6503 \newskip\subsecheadingskip
6504 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
6506 % Subsubsection titles.
6507 \def\subsubsecheadingskip{\subsecheadingskip}
6508 \def\subsubsecheadingbreak{\subsecheadingbreak}
6511 % Print any size, any type, section title.
6513 % #1 is the text of the title,
6514 % #2 is the section level (sec/subsec/subsubsec),
6515 % #3 is the section type (Ynumbered, Ynothing, Yappendix, Yomitfromtoc),
6516 % #4 is the section number.
6518 \def\seckeyword{sec}
6520 \def\sectionheading#1#2#3#4{%
6522 \def\sectionlevel{#2}%
6523 \def\temptype{#3}%
6525 % It is ok for the @heading series commands to appear inside an
6526 % environment (it's been historically allowed, though the logic is
6527 % dubious), but not the others.
6528 \ifx\temptype\Yomitfromtockeyword\else
6529 \checkenv{}% non-@*heading should not be in an environment.
6531 \let\footnote=\errfootnoteheading
6533 % Switch to the right set of fonts.
6534 \csname #2fonts\endcsname \rm
6536 % Insert first mark before the heading break (see notes for \domark).
6537 \let\prevsectiondefs=\currentsectiondefs
6538 \ifx\temptype\Ynothingkeyword
6539 \ifx\sectionlevel\seckeyword
6540 \gdef\currentsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
6541 \gdef\thissection{\thissectionname}}%
6543 \else\ifx\temptype\Yomitfromtockeyword
6544 % Don't redefine \thissection.
6545 \else\ifx\temptype\Yappendixkeyword
6546 \ifx\sectionlevel\seckeyword
6547 \toks0={#1}%
6548 \xdef\currentsectiondefs{%
6549 \gdef\noexpand\thissectionname{\the\toks0}%
6550 \gdef\noexpand\thissectionnum{#4}%
6551 % \noexpand\putwordSection avoids expanding indigestible
6552 % commands in some of the translations.
6553 \gdef\noexpand\thissection{\noexpand\putwordSection{}
6554 \noexpand\thissectionnum:
6555 \noexpand\thissectionname}%
6558 \else
6559 \ifx\sectionlevel\seckeyword
6560 \toks0={#1}%
6561 \xdef\currentsectiondefs{%
6562 \gdef\noexpand\thissectionname{\the\toks0}%
6563 \gdef\noexpand\thissectionnum{#4}%
6564 % \noexpand\putwordSection avoids expanding indigestible
6565 % commands in some of the translations.
6566 \gdef\noexpand\thissection{\noexpand\putwordSection{}
6567 \noexpand\thissectionnum:
6568 \noexpand\thissectionname}%
6571 \fi\fi\fi
6573 % Go into vertical mode. Usually we'll already be there, but we
6574 % don't want the following whatsit to end up in a preceding paragraph
6575 % if the document didn't happen to have a blank line.
6576 \par
6578 % Output the mark. Pass it through \safewhatsit, to take care of
6579 % the preceding space.
6580 \safewhatsit\domark
6582 % Insert space above the heading.
6583 \csname #2headingbreak\endcsname
6585 % Now the second mark, after the heading break. No break points
6586 % between here and the heading.
6587 \global\let\prevsectiondefs=\currentsectiondefs
6588 \domark
6590 % Only insert the space after the number if we have a section number.
6591 \ifx\temptype\Ynothingkeyword
6592 \setbox0 = \hbox{}%
6593 \def\toctype{unn}%
6594 \gdef\currentsection{#1}%
6595 \else\ifx\temptype\Yomitfromtockeyword
6596 % for @headings -- no section number, don't include in toc,
6597 % and don't redefine \currentsection.
6598 \setbox0 = \hbox{}%
6599 \def\toctype{omit}%
6600 \let\sectionlevel=\empty
6601 \else\ifx\temptype\Yappendixkeyword
6602 \setbox0 = \hbox{#4\enspace}%
6603 \def\toctype{app}%
6604 \gdef\currentsection{#1}%
6605 \else
6606 \setbox0 = \hbox{#4\enspace}%
6607 \def\toctype{num}%
6608 \gdef\currentsection{#1}%
6609 \fi\fi\fi
6611 % Write the toc entry (before \donoderef). See comments in \chapmacro.
6612 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
6614 % Write the node reference (= pdf destination for pdftex).
6615 % Again, see comments in \chapmacro.
6616 \donoderef{#3}%
6618 % Interline glue will be inserted when the vbox is completed.
6619 % That glue will be a valid breakpoint for the page, since it'll be
6620 % preceded by a whatsit (usually from the \donoderef, or from the
6621 % \writetocentry if there was no node). We don't want to allow that
6622 % break, since then the whatsits could end up on page n while the
6623 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
6624 \nobreak
6626 % Output the actual section heading.
6627 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
6628 \hangindent=\wd0 % zero if no section number
6629 \unhbox0 #1}%
6631 % Add extra space after the heading -- half of whatever came above it.
6632 % Don't allow stretch, though.
6633 \kern .5 \csname #2headingskip\endcsname
6635 % Do not let the kern be a potential breakpoint, as it would be if it
6636 % was followed by glue.
6637 \nobreak
6639 % We'll almost certainly start a paragraph next, so don't let that
6640 % glue accumulate. (Not a breakpoint because it's preceded by a
6641 % discardable item.) However, when a paragraph is not started next
6642 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
6643 % or the negative glue will cause weirdly wrong output, typically
6644 % obscuring the section heading with something else.
6645 \vskip-\parskip
6647 % This is so the last item on the main vertical list is a known
6648 % \penalty > 10000, so \startdefun, etc., can recognize the situation
6649 % and do the needful.
6650 \penalty 10001
6654 \message{toc,}
6655 % Table of contents.
6656 \newwrite\tocfile
6658 % Write an entry to the toc file, opening it if necessary.
6659 % Called from @chapter, etc.
6661 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
6662 % We append the current node name (if any) and page number as additional
6663 % arguments for the \{chap,sec,...}entry macros which will eventually
6664 % read this. The node name is used in the pdf outlines as the
6665 % destination to jump to.
6667 % We open the .toc file for writing here instead of at @setfilename (or
6668 % any other fixed time) so that @contents can be anywhere in the document.
6669 % But if #1 is `omit', then we don't do anything. This is used for the
6670 % table of contents chapter openings themselves.
6672 \newif\iftocfileopened
6673 \def\omitkeyword{omit}%
6675 \def\writetocentry#1#2#3{%
6676 \edef\writetoctype{#1}%
6677 \ifx\writetoctype\omitkeyword \else
6678 \iftocfileopened\else
6679 \immediate\openout\tocfile = \jobname.toc
6680 \global\tocfileopenedtrue
6683 \iflinks
6684 {\atdummies
6685 \edef\temp{%
6686 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
6687 \temp
6692 % Tell \shipout to create a pdf destination on each page, if we're
6693 % writing pdf. These are used in the table of contents. We can't
6694 % just write one on every page because the title pages are numbered
6695 % 1 and 2 (the page numbers aren't printed), and so are the first
6696 % two pages of the document. Thus, we'd have two destinations named
6697 % `1', and two named `2'.
6698 \ifpdforxetex
6699 \global\pdfmakepagedesttrue
6704 % These characters do not print properly in the Computer Modern roman
6705 % fonts, so we must take special care. This is more or less redundant
6706 % with the Texinfo input format setup at the end of this file.
6708 \def\activecatcodes{%
6709 \catcode`\"=\active
6710 \catcode`\$=\active
6711 \catcode`\<=\active
6712 \catcode`\>=\active
6713 \catcode`\\=\active
6714 \catcode`\^=\active
6715 \catcode`\_=\active
6716 \catcode`\|=\active
6717 \catcode`\~=\active
6721 % Read the toc file, which is essentially Texinfo input.
6722 \def\readtocfile{%
6723 \setupdatafile
6724 \activecatcodes
6725 \input \tocreadfilename
6728 \newskip\contentsrightmargin \contentsrightmargin=1in
6729 \newcount\savepageno
6730 \newcount\lastnegativepageno \lastnegativepageno = -1
6732 % Prepare to read what we've written to \tocfile.
6734 \def\startcontents#1{%
6735 % If @setchapternewpage on, and @headings double, the contents should
6736 % start on an odd page, unlike chapters.
6737 \contentsalignmacro
6738 \immediate\closeout\tocfile
6740 % Don't need to put `Contents' or `Short Contents' in the headline.
6741 % It is abundantly clear what they are.
6742 \chapmacro{#1}{Yomitfromtoc}{}%
6744 \savepageno = \pageno
6745 \begingroup % Set up to handle contents files properly.
6746 \raggedbottom % Worry more about breakpoints than the bottom.
6747 \entryrightmargin=\contentsrightmargin % Don't use the full line length.
6749 % Roman numerals for page numbers.
6750 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
6751 \def\thistitle{}% no title in double-sided headings
6752 % Record where the Roman numerals started.
6753 \ifnum\romancount=0 \global\romancount=\pagecount \fi
6756 % redefined for the two-volume lispref. We always output on
6757 % \jobname.toc even if this is redefined.
6759 \def\tocreadfilename{\jobname.toc}
6761 % Normal (long) toc.
6763 \def\contents{%
6764 \startcontents{\putwordTOC}%
6765 \openin 1 \tocreadfilename\space
6766 \ifeof 1 \else
6767 \readtocfile
6769 \vfill \eject
6770 \contentsalignmacro % in case @setchapternewpage odd is in effect
6771 \ifeof 1 \else
6772 \pdfmakeoutlines
6774 \closein 1
6775 \endgroup
6776 \contentsendroman
6779 % And just the chapters.
6780 \def\summarycontents{%
6781 \startcontents{\putwordShortTOC}%
6783 \let\partentry = \shortpartentry
6784 \let\numchapentry = \shortchapentry
6785 \let\appentry = \shortchapentry
6786 \let\unnchapentry = \shortunnchapentry
6787 % We want a true roman here for the page numbers.
6788 \secfonts
6789 \let\rm=\shortcontrm \let\bf=\shortcontbf
6790 \let\sl=\shortcontsl \let\tt=\shortconttt
6792 \hyphenpenalty = 10000
6793 \advance\baselineskip by 1pt % Open it up a little.
6794 \def\numsecentry##1##2##3##4{}
6795 \let\appsecentry = \numsecentry
6796 \let\unnsecentry = \numsecentry
6797 \let\numsubsecentry = \numsecentry
6798 \let\appsubsecentry = \numsecentry
6799 \let\unnsubsecentry = \numsecentry
6800 \let\numsubsubsecentry = \numsecentry
6801 \let\appsubsubsecentry = \numsecentry
6802 \let\unnsubsubsecentry = \numsecentry
6803 \openin 1 \tocreadfilename\space
6804 \ifeof 1 \else
6805 \readtocfile
6807 \closein 1
6808 \vfill \eject
6809 \contentsalignmacro % in case @setchapternewpage odd is in effect
6810 \endgroup
6811 \contentsendroman
6813 \let\shortcontents = \summarycontents
6815 % Get ready to use Arabic numerals again
6816 \def\contentsendroman{%
6817 \lastnegativepageno = \pageno
6818 \global\pageno = \savepageno
6820 % If \romancount > \arabiccount, the contents are at the end of the
6821 % document. Otherwise, advance where the Arabic numerals start for
6822 % the page numbers.
6823 \ifnum\romancount>\arabiccount\else\global\arabiccount=\pagecount\fi
6826 % Typeset the label for a chapter or appendix for the short contents.
6827 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6829 \def\shortchaplabel#1{%
6830 % This space should be enough, since a single number is .5em, and the
6831 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6832 % But use \hss just in case.
6833 % (This space doesn't include the extra space that gets added after
6834 % the label; that gets put in by \shortchapentry above.)
6836 % We'd like to right-justify chapter numbers, but that looks strange
6837 % with appendix letters. And right-justifying numbers and
6838 % left-justifying letters looks strange when there is less than 10
6839 % chapters. Have to read the whole toc once to know how many chapters
6840 % there are before deciding ...
6841 \hbox to 1em{#1\hss}%
6844 % These macros generate individual entries in the table of contents.
6845 % The first argument is the chapter or section name.
6846 % The last argument is the page number.
6847 % The arguments in between are the chapter number, section number, ...
6849 % Parts, in the main contents. Replace the part number, which doesn't
6850 % exist, with an empty box. Let's hope all the numbers have the same width.
6851 % Also ignore the page number, which is conventionally not printed.
6852 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6853 \def\partentry#1#2#3#4{%
6854 % Add stretch and a bonus for breaking the page before the part heading.
6855 % This reduces the chance of the page being broken immediately after the
6856 % part heading, before a following chapter heading.
6857 \vskip 0pt plus 5\baselineskip
6858 \penalty-300
6859 \vskip 0pt plus -5\baselineskip
6860 \dochapentry{\numeralbox\labelspace#1}{}%
6863 % Parts, in the short toc.
6864 \def\shortpartentry#1#2#3#4{%
6865 \penalty-300
6866 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6867 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6870 % Chapters, in the main contents.
6871 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6873 % Chapters, in the short toc.
6874 % See comments in \dochapentry re vbox and related settings.
6875 \def\shortchapentry#1#2#3#4{%
6876 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6879 % Appendices, in the main contents.
6880 % Need the word Appendix, and a fixed-size box.
6882 \def\appendixbox#1{%
6883 % We use M since it's probably the widest letter.
6884 \setbox0 = \hbox{\putwordAppendix{} M}%
6885 \hbox to \wd0{\putwordAppendix{} #1\hss}}
6887 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\hskip.7em#1}{#4}}
6889 % Unnumbered chapters.
6890 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6891 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6893 % Sections.
6894 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6895 \let\appsecentry=\numsecentry
6896 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6898 % Subsections.
6899 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6900 \let\appsubsecentry=\numsubsecentry
6901 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6903 % And subsubsections.
6904 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6905 \let\appsubsubsecentry=\numsubsubsecentry
6906 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6908 % This parameter controls the indentation of the various levels.
6909 % Same as \defaultparindent.
6910 \newdimen\tocindent \tocindent = 15pt
6912 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6913 % page number.
6915 % If the toc has to be broken over pages, we want it to be at chapters
6916 % if at all possible; hence the \penalty.
6917 \def\dochapentry#1#2{%
6918 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6919 \begingroup
6920 % Move the page numbers slightly to the right
6921 \advance\entryrightmargin by -0.05em
6922 \chapentryfonts
6923 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6924 \endgroup
6925 \nobreak\vskip .25\baselineskip plus.1\baselineskip
6928 \def\dosecentry#1#2{\begingroup
6929 \secentryfonts \leftskip=\tocindent
6930 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6931 \endgroup}
6933 \def\dosubsecentry#1#2{\begingroup
6934 \subsecentryfonts \leftskip=2\tocindent
6935 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6936 \endgroup}
6938 \def\dosubsubsecentry#1#2{\begingroup
6939 \subsubsecentryfonts \leftskip=3\tocindent
6940 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6941 \endgroup}
6943 % We use the same \entry macro as for the index entries.
6944 \let\tocentry = \entry
6946 % Space between chapter (or whatever) number and the title.
6947 \def\labelspace{\hskip1em \relax}
6949 \def\dopageno#1{{\rm #1}}
6950 \def\doshortpageno#1{{\rm #1}}
6952 \def\chapentryfonts{\secfonts \rm}
6953 \def\secentryfonts{\textfonts}
6954 \def\subsecentryfonts{\textfonts}
6955 \def\subsubsecentryfonts{\textfonts}
6958 \message{environments,}
6959 % @foo ... @end foo.
6961 % @tex ... @end tex escapes into raw TeX temporarily.
6962 % One exception: @ is still an escape character, so that @end tex works.
6963 % But \@ or @@ will get a plain @ character.
6965 \envdef\tex{%
6966 \setregularquotes
6967 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
6968 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
6969 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
6970 \catcode `\%=14
6971 \catcode `\+=\other
6972 \catcode `\"=\other
6973 \catcode `\|=\other
6974 \catcode `\<=\other
6975 \catcode `\>=\other
6976 \catcode `\`=\other
6977 \catcode `\'=\other
6979 % ' is active in math mode (mathcode"8000). So reset it, and all our
6980 % other math active characters (just in case), to plain's definitions.
6981 \mathactive
6983 % Inverse of the list at the beginning of the file.
6984 \let\b=\ptexb
6985 \let\bullet=\ptexbullet
6986 \let\c=\ptexc
6987 \let\,=\ptexcomma
6988 \let\.=\ptexdot
6989 \let\dots=\ptexdots
6990 \let\equiv=\ptexequiv
6991 \let\!=\ptexexclam
6992 \let\i=\ptexi
6993 \let\indent=\ptexindent
6994 \let\noindent=\ptexnoindent
6995 \let\{=\ptexlbrace
6996 \let\+=\tabalign
6997 \let\}=\ptexrbrace
6998 \let\/=\ptexslash
6999 \let\sp=\ptexsp
7000 \let\*=\ptexstar
7001 %\let\sup=\ptexsup % do not redefine, we want @sup to work in math mode
7002 \let\t=\ptext
7003 \expandafter \let\csname top\endcsname=\ptextop % we've made it outer
7004 \let\frenchspacing=\plainfrenchspacing
7006 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
7007 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
7008 \def\@{@}%
7010 % There is no need to define \Etex.
7012 % Define @lisp ... @end lisp.
7013 % @lisp environment forms a group so it can rebind things,
7014 % including the definition of @end lisp (which normally is erroneous).
7016 % Amount to narrow the margins by for @lisp.
7017 \newskip\lispnarrowing \lispnarrowing=0.4in
7019 % This is the definition that ^^M gets inside @lisp, @example, and other
7020 % such environments. \null is better than a space, since it doesn't
7021 % have any width.
7022 \def\lisppar{\null\endgraf}
7024 % This space is always present above and below environments.
7025 \newskip\envskipamount \envskipamount = 0pt
7027 % Make spacing and below environment symmetrical. We use \parskip here
7028 % to help in doing that, since in @example-like environments \parskip
7029 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
7030 % start of the next paragraph will insert \parskip.
7032 \def\aboveenvbreak{{%
7033 % =10000 instead of <10000 because of a special case in \itemzzz and
7034 % \sectionheading, q.v.
7035 \ifnum \lastpenalty=10000 \else
7036 \advance\envskipamount by \parskip
7037 \endgraf
7038 \ifdim\lastskip<\envskipamount
7039 \removelastskip
7040 \ifnum\lastpenalty<10000
7041 % Penalize breaking before the environment, because preceding text
7042 % often leads into it.
7043 \penalty100
7045 \vskip\envskipamount
7050 \def\afterenvbreak{{%
7051 % =10000 instead of <10000 because of a special case in \itemzzz and
7052 % \sectionheading, q.v.
7053 \ifnum \lastpenalty=10000 \else
7054 \advance\envskipamount by \parskip
7055 \endgraf
7056 \ifdim\lastskip<\envskipamount
7057 \removelastskip
7058 % it's not a good place to break if the last penalty was \nobreak
7059 % or better ...
7060 \ifnum\lastpenalty<10000 \penalty-50 \fi
7061 \vskip\envskipamount
7066 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
7067 % also clear it, so that its embedded environments do the narrowing again.
7068 \let\nonarrowing=\relax
7070 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
7071 % environment contents.
7074 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
7075 \def\ctr{{\hskip 6pt\circle\char'010}}
7076 \def\cbl{{\circle\char'012\hskip -6pt}}
7077 \def\cbr{{\hskip 6pt\circle\char'011}}
7078 \def\carttop{\hbox to \cartouter{\hskip\lskip
7079 \ctl\leaders\hrule height\circthick\hfil\ctr
7080 \hskip\rskip}}
7081 \def\cartbot{\hbox to \cartouter{\hskip\lskip
7082 \cbl\leaders\hrule height\circthick\hfil\cbr
7083 \hskip\rskip}}
7085 \newskip\lskip\newskip\rskip
7087 % only require the font if @cartouche is actually used
7088 \def\cartouchefontdefs{%
7089 \font\circle=lcircle10\relax
7090 \circthick=\fontdimen8\circle
7092 \newdimen\circthick
7093 \newdimen\cartouter\newdimen\cartinner
7094 \newskip\normbskip\newskip\normpskip\newskip\normlskip
7097 \envdef\cartouche{%
7098 \cartouchefontdefs
7099 \ifhmode\par\fi % can't be in the midst of a paragraph.
7100 \startsavinginserts
7101 \lskip=\leftskip \rskip=\rightskip
7102 \leftskip=0pt\rightskip=0pt % we want these *outside*.
7103 \cartinner=\hsize \advance\cartinner by-\lskip
7104 \advance\cartinner by-\rskip
7105 \cartouter=\hsize
7106 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
7107 % side, and for 6pt waste from
7108 % each corner char, and rule thickness
7109 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
7111 % If this cartouche directly follows a sectioning command, we need the
7112 % \parskip glue (backspaced over by default) or the cartouche can
7113 % collide with the section heading.
7114 \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
7116 \setbox\groupbox=\vbox\bgroup
7117 \baselineskip=0pt\parskip=0pt\lineskip=0pt
7118 \carttop
7119 \hbox\bgroup
7120 \hskip\lskip
7121 \vrule\kern3pt
7122 \vbox\bgroup
7123 \kern3pt
7124 \hsize=\cartinner
7125 \baselineskip=\normbskip
7126 \lineskip=\normlskip
7127 \parskip=\normpskip
7128 \vskip -\parskip
7129 \comment % For explanation, see the end of def\group.
7131 \def\Ecartouche{%
7132 \ifhmode\par\fi
7133 \kern3pt
7134 \egroup
7135 \kern3pt\vrule
7136 \hskip\rskip
7137 \egroup
7138 \cartbot
7139 \egroup
7140 \addgroupbox
7141 \checkinserts
7145 % This macro is called at the beginning of all the @example variants,
7146 % inside a group.
7147 \newdimen\nonfillparindent
7148 \def\nonfillstart{%
7149 \aboveenvbreak
7150 \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy
7151 \sepspaces % Make spaces be word-separators rather than space tokens.
7152 \let\par = \lisppar % don't ignore blank lines
7153 \obeylines % each line of input is a line of output
7154 \parskip = 0pt
7155 % Turn off paragraph indentation but redefine \indent to emulate
7156 % the normal \indent.
7157 \nonfillparindent=\parindent
7158 \parindent = 0pt
7159 \let\indent\nonfillindent
7161 \emergencystretch = 0pt % don't try to avoid overfull boxes
7162 \ifx\nonarrowing\relax
7163 \advance \leftskip by \lispnarrowing
7164 \exdentamount=\lispnarrowing
7165 \else
7166 \let\nonarrowing = \relax
7168 \let\exdent=\nofillexdent
7171 \begingroup
7172 \obeyspaces
7173 % We want to swallow spaces (but not other tokens) after the fake
7174 % @indent in our nonfill-environments, where spaces are normally
7175 % active and set to @tie, resulting in them not being ignored after
7176 % @indent.
7177 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
7178 \gdef\nonfillindentcheck{%
7179 \ifx\temp %
7180 \expandafter\nonfillindentgobble%
7181 \else%
7182 \leavevmode\nonfillindentbox%
7183 \fi%
7185 \endgroup
7186 \def\nonfillindentgobble#1{\nonfillindent}
7187 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
7189 % If you want all examples etc. small: @set dispenvsize small.
7190 % If you want even small examples the full size: @set dispenvsize nosmall.
7191 % This affects the following displayed environments:
7192 % @example, @display, @format, @lisp, @verbatim
7194 \def\smallword{small}
7195 \def\nosmallword{nosmall}
7196 \let\SETdispenvsize\relax
7197 \def\setnormaldispenv{%
7198 \ifx\SETdispenvsize\smallword
7199 % end paragraph for sake of leading, in case document has no blank
7200 % line. This is redundant with what happens in \aboveenvbreak, but
7201 % we need to do it before changing the fonts, and it's inconvenient
7202 % to change the fonts afterward.
7203 \ifnum \lastpenalty=10000 \else \endgraf \fi
7204 \smallexamplefonts \rm
7207 \def\setsmalldispenv{%
7208 \ifx\SETdispenvsize\nosmallword
7209 \else
7210 \ifnum \lastpenalty=10000 \else \endgraf \fi
7211 \smallexamplefonts \rm
7215 % We often define two environments, @foo and @smallfoo.
7216 % Let's do it in one command. #1 is the env name, #2 the definition.
7217 \def\makedispenvdef#1#2{%
7218 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
7219 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
7220 \expandafter\let\csname E#1\endcsname \afterenvbreak
7221 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
7224 % Define two environment synonyms (#1 and #2) for an environment.
7225 \def\maketwodispenvdef#1#2#3{%
7226 \makedispenvdef{#1}{#3}%
7227 \makedispenvdef{#2}{#3}%
7230 % @lisp: indented, narrowed, typewriter font;
7231 % @example: same as @lisp.
7233 % @smallexample and @smalllisp: use smaller fonts.
7234 % Originally contributed by Pavel@xerox.
7236 \maketwodispenvdef{lisp}{example}{%
7237 \nonfillstart
7238 \tt\setcodequotes
7239 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
7240 \parsearg\gobble
7242 % @display/@smalldisplay: same as @lisp except keep current font.
7244 \makedispenvdef{display}{%
7245 \nonfillstart
7246 \gobble
7249 % @format/@smallformat: same as @display except don't narrow margins.
7251 \makedispenvdef{format}{%
7252 \let\nonarrowing = t%
7253 \nonfillstart
7254 \gobble
7257 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
7258 \envdef\flushleft{%
7259 \let\nonarrowing = t%
7260 \nonfillstart
7261 \gobble
7263 \let\Eflushleft = \afterenvbreak
7265 % @flushright.
7267 \envdef\flushright{%
7268 \let\nonarrowing = t%
7269 \nonfillstart
7270 \advance\leftskip by 0pt plus 1fill\relax
7271 \gobble
7273 \let\Eflushright = \afterenvbreak
7276 % @raggedright does more-or-less normal line breaking but no right
7277 % justification. From plain.tex.
7278 \envdef\raggedright{%
7279 \rightskip0pt plus2.4em \spaceskip.3333em \xspaceskip.5em\relax
7281 \let\Eraggedright\par
7283 \envdef\raggedleft{%
7284 \parindent=0pt \leftskip0pt plus2em
7285 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
7286 \hbadness=10000 % Last line will usually be underfull, so turn off
7287 % badness reporting.
7289 \let\Eraggedleft\par
7291 \envdef\raggedcenter{%
7292 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
7293 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
7294 \hbadness=10000 % Last line will usually be underfull, so turn off
7295 % badness reporting.
7297 \let\Eraggedcenter\par
7300 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
7301 % and narrows the margins. We keep \parskip nonzero in general, since
7302 % we're doing normal filling. So, when using \aboveenvbreak and
7303 % \afterenvbreak, temporarily make \parskip 0.
7305 \makedispenvdef{quotation}{\quotationstart}
7307 \def\quotationstart{%
7308 \indentedblockstart % same as \indentedblock, but increase right margin too.
7309 \ifx\nonarrowing\relax
7310 \advance\rightskip by \lispnarrowing
7312 \parsearg\quotationlabel
7315 % We have retained a nonzero parskip for the environment, since we're
7316 % doing normal filling.
7318 \def\Equotation{%
7319 \par
7320 \ifx\quotationauthor\thisisundefined\else
7321 % indent a bit.
7322 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
7324 {\parskip=0pt \afterenvbreak}%
7326 \def\Esmallquotation{\Equotation}
7328 % If we're given an argument, typeset it in bold with a colon after.
7329 \def\quotationlabel#1{%
7330 \def\temp{#1}%
7331 \ifx\temp\empty \else
7332 {\bf #1: }%
7336 % @indentedblock is like @quotation, but indents only on the left and
7337 % has no optional argument.
7339 \makedispenvdef{indentedblock}{\indentedblockstart}
7341 \def\indentedblockstart{%
7342 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
7343 \parindent=0pt
7345 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
7346 \ifx\nonarrowing\relax
7347 \advance\leftskip by \lispnarrowing
7348 \exdentamount = \lispnarrowing
7349 \else
7350 \let\nonarrowing = \relax
7354 % Keep a nonzero parskip for the environment, since we're doing normal filling.
7356 \def\Eindentedblock{%
7357 \par
7358 {\parskip=0pt \afterenvbreak}%
7360 \def\Esmallindentedblock{\Eindentedblock}
7363 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
7364 % If we want to allow any <char> as delimiter,
7365 % we need the curly braces so that makeinfo sees the @verb command, eg:
7366 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
7368 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
7370 % [Knuth] p.344; only we need to do the other characters Texinfo sets
7371 % active too. Otherwise, they get lost as the first character on a
7372 % verbatim line.
7373 \def\dospecials{%
7374 \do\ \do\\\do\{\do\}\do\$\do\&%
7375 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
7376 \do\<\do\>\do\|\do\@\do+\do\"%
7377 % Don't do the quotes -- if we do, @set txicodequoteundirected and
7378 % @set txicodequotebacktick will not have effect on @verb and
7379 % @verbatim, and ?` and !` ligatures won't get disabled.
7380 %\do\`\do\'%
7383 % [Knuth] p. 380
7384 \def\uncatcodespecials{%
7385 \def\do##1{\catcode`##1=\other}\dospecials}
7387 % Setup for the @verb command.
7389 % Eight spaces for a tab
7390 \begingroup
7391 \catcode`\^^I=\active
7392 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
7393 \endgroup
7395 \def\setupverb{%
7396 \tt % easiest (and conventionally used) font for verbatim
7397 \def\par{\leavevmode\endgraf}%
7398 \setcodequotes
7399 \tabeightspaces
7400 % Respect line breaks,
7401 % print special symbols as themselves, and
7402 % make each space count
7403 % must do in this order:
7404 \obeylines \uncatcodespecials \sepspaces
7407 % Setup for the @verbatim environment
7409 % Real tab expansion.
7410 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
7412 % We typeset each line of the verbatim in an \hbox, so we can handle
7413 % tabs.
7414 \newbox\verbbox
7415 \def\starttabbox{\setbox\verbbox=\hbox\bgroup}
7417 \begingroup
7418 \catcode`\^^I=\active
7419 \gdef\tabexpand{%
7420 \catcode`\^^I=\active
7421 \def^^I{\leavevmode\egroup
7422 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
7423 \divide\dimen\verbbox by\tabw
7424 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
7425 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
7426 \wd\verbbox=\dimen\verbbox
7427 \leavevmode\box\verbbox \starttabbox
7430 \endgroup
7432 % start the verbatim environment.
7433 \def\setupverbatim{%
7434 \let\nonarrowing = t%
7435 \nonfillstart
7436 \tt % easiest (and conventionally used) font for verbatim
7437 \def\par{\egroup\leavevmode\box\verbbox\endgraf\starttabbox}%
7438 \tabexpand
7439 \setcodequotes
7440 % Respect line breaks,
7441 % print special symbols as themselves, and
7442 % make each space count.
7443 % Must do in this order:
7444 \obeylines \uncatcodespecials \sepspaces
7447 % Do the @verb magic: verbatim text is quoted by unique
7448 % delimiter characters. Before first delimiter expect a
7449 % right brace, after last delimiter expect closing brace:
7451 % \def\doverb'{'<char>#1<char>'}'{#1}
7453 % [Knuth] p. 382; only eat outer {}
7454 \begingroup
7455 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
7456 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
7457 \endgroup
7459 \def\verb{\begingroup\setupverb\doverb}
7462 % Do the @verbatim magic: define the macro \doverbatim so that
7463 % the (first) argument ends when '@end verbatim' is reached, ie:
7465 % \def\doverbatim#1@end verbatim{#1}
7467 % For Texinfo it's a lot easier than for LaTeX,
7468 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
7469 % we need not redefine '\', '{' and '}'.
7471 % Inspired by LaTeX's verbatim command set [latex.ltx]
7473 \begingroup
7474 \catcode`\ =\active
7475 \obeylines %
7476 % ignore everything up to the first ^^M, that's the newline at the end
7477 % of the @verbatim input line itself. Otherwise we get an extra blank
7478 % line in the output.
7479 \xdef\doverbatim#1^^M#2@end verbatim{%
7480 \starttabbox#2\egroup\noexpand\end\gobble verbatim}%
7481 % We really want {...\end verbatim} in the body of the macro, but
7482 % without the active space; thus we have to use \xdef and \gobble.
7483 % The \egroup ends the \verbbox started at the end of the last line in
7484 % the block.
7485 \endgroup
7487 \envdef\verbatim{%
7488 \setnormaldispenv\setupverbatim\doverbatim
7490 \let\Everbatim = \afterenvbreak
7493 % @verbatiminclude FILE - insert text of file in verbatim environment.
7495 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
7497 \def\doverbatiminclude#1{%
7499 \makevalueexpandable
7500 \setupverbatim
7502 \indexnofonts % Allow `@@' and other weird things in file names.
7503 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
7504 \edef\tmp{\noexpand\input #1 }
7505 \expandafter
7506 }\expandafter\starttabbox\tmp\egroup
7507 \afterenvbreak
7511 % @copying ... @end copying.
7512 % Save the text away for @insertcopying later.
7514 % We save the uninterpreted tokens, rather than creating a box.
7515 % Saving the text in a box would be much easier, but then all the
7516 % typesetting commands (@smallbook, font changes, etc.) have to be done
7517 % beforehand -- and a) we want @copying to be done first in the source
7518 % file; b) letting users define the frontmatter in as flexible order as
7519 % possible is desirable.
7521 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
7522 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
7524 \def\insertcopying{%
7525 \begingroup
7526 \parindent = 0pt % paragraph indentation looks wrong on title page
7527 \scanexp\copyingtext
7528 \endgroup
7532 \message{defuns,}
7533 % @defun etc.
7535 \newskip\defbodyindent \defbodyindent=.4in
7536 \newskip\defargsindent \defargsindent=50pt
7537 \newskip\deflastargmargin \deflastargmargin=18pt
7538 \newcount\defunpenalty
7540 % Start the processing of @deffn:
7541 \def\startdefun{%
7542 \ifnum\lastpenalty<10000
7543 \medbreak
7544 \defunpenalty=10003 % Will keep this @deffn together with the
7545 % following @def command, see below.
7546 \else
7547 % If there are two @def commands in a row, we'll have a \nobreak,
7548 % which is there to keep the function description together with its
7549 % header. But if there's nothing but headers, we need to allow a
7550 % break somewhere. Check specifically for penalty 10002, inserted
7551 % by \printdefunline, instead of 10000, since the sectioning
7552 % commands also insert a nobreak penalty, and we don't want to allow
7553 % a break between a section heading and a defun.
7555 % As a further refinement, we avoid "club" headers by signalling
7556 % with penalty of 10003 after the very first @deffn in the
7557 % sequence (see above), and penalty of 10002 after any following
7558 % @def command.
7559 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
7561 % Similarly, after a section heading, do not allow a break.
7562 % But do insert the glue.
7563 \medskip % preceded by discardable penalty, so not a breakpoint
7566 \parindent=0in
7567 \advance\leftskip by \defbodyindent
7568 \exdentamount=\defbodyindent
7571 \def\dodefunx#1{%
7572 % First, check whether we are in the right environment:
7573 \checkenv#1%
7575 % As above, allow line break if we have multiple x headers in a row.
7576 % It's not a great place, though.
7577 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
7579 % And now, it's time to reuse the body of the original defun:
7580 \expandafter\gobbledefun#1%
7582 \def\gobbledefun#1\startdefun{}
7584 % \printdefunline \deffnheader{text}
7586 \def\printdefunline#1#2{%
7587 \begingroup
7588 \plainfrenchspacing
7589 % call \deffnheader:
7590 #1#2 \endheader
7591 % common ending:
7592 \interlinepenalty = 10000
7593 \advance\rightskip by 0pt plus 1fil\relax
7594 \endgraf
7595 \nobreak\vskip -\parskip
7596 \penalty\defunpenalty % signal to \startdefun and \dodefunx
7597 % Some of the @defun-type tags do not enable magic parentheses,
7598 % rendering the following check redundant. But we don't optimize.
7599 \checkparencounts
7600 \endgroup
7603 \def\Edefun{\endgraf\medbreak}
7605 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
7606 % the only thing remaining is to define \deffnheader.
7608 \def\makedefun#1{%
7609 \expandafter\let\csname E#1\endcsname = \Edefun
7610 \edef\temp{\noexpand\domakedefun
7611 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
7612 \temp
7615 % \domakedefun \deffn \deffnx \deffnheader { (defn. of \deffnheader) }
7617 % Define \deffn and \deffnx, without parameters.
7618 % \deffnheader has to be defined explicitly.
7620 \def\domakedefun#1#2#3{%
7621 \envdef#1{%
7622 \startdefun
7623 \doingtypefnfalse % distinguish typed functions from all else
7624 \parseargusing\activeparens{\printdefunline#3}%
7626 \def#2{\dodefunx#1}%
7627 \def#3%
7630 \newif\ifdoingtypefn % doing typed function?
7631 \newif\ifrettypeownline % typeset return type on its own line?
7633 % @deftypefnnewline on|off says whether the return type of typed functions
7634 % are printed on their own line. This affects @deftypefn, @deftypefun,
7635 % @deftypeop, and @deftypemethod.
7637 \parseargdef\deftypefnnewline{%
7638 \def\temp{#1}%
7639 \ifx\temp\onword
7640 \expandafter\let\csname SETtxideftypefnnl\endcsname
7641 = \empty
7642 \else\ifx\temp\offword
7643 \expandafter\let\csname SETtxideftypefnnl\endcsname
7644 = \relax
7645 \else
7646 \errhelp = \EMsimple
7647 \errmessage{Unknown @txideftypefnnl value `\temp',
7648 must be on|off}%
7649 \fi\fi
7652 % \dosubind {index}{topic}{subtopic}
7654 % If SUBTOPIC is present, precede it with a space, and call \doind.
7655 % (At some time during the 20th century, this made a two-level entry in an
7656 % index such as the operation index. Nobody seemed to notice the change in
7657 % behaviour though.)
7658 \def\dosubind#1#2#3{%
7659 \def\thirdarg{#3}%
7660 \ifx\thirdarg\empty
7661 \doind{#1}{#2}%
7662 \else
7663 \doind{#1}{#2\space#3}%
7667 % Untyped functions:
7669 % @deffn category name args
7670 \makedefun{deffn}{\deffngeneral{}}
7672 % @deffn category class name args
7673 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
7675 % \defopon {category on}class name args
7676 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7678 % \deffngeneral {subind}category name args
7680 \def\deffngeneral#1#2 #3 #4\endheader{%
7681 \dosubind{fn}{\code{#3}}{#1}%
7682 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
7685 % Typed functions:
7687 % @deftypefn category type name args
7688 \makedefun{deftypefn}{\deftypefngeneral{}}
7690 % @deftypeop category class type name args
7691 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
7693 % \deftypeopon {category on}class type name args
7694 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7696 % \deftypefngeneral {subind}category type name args
7698 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
7699 \dosubind{fn}{\code{#4}}{#1}%
7700 \doingtypefntrue
7701 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7704 % Typed variables:
7706 % @deftypevr category type var args
7707 \makedefun{deftypevr}{\deftypecvgeneral{}}
7709 % @deftypecv category class type var args
7710 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
7712 % \deftypecvof {category of}class type var args
7713 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
7715 % \deftypecvgeneral {subind}category type var args
7717 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
7718 \dosubind{vr}{\code{#4}}{#1}%
7719 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7722 % Untyped variables:
7724 % @defvr category var args
7725 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
7727 % @defcv category class var args
7728 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
7730 % \defcvof {category of}class var args
7731 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
7733 % Types:
7735 % @deftp category name args
7736 \makedefun{deftp}#1 #2 #3\endheader{%
7737 \doind{tp}{\code{#2}}%
7738 \defname{#1}{}{#2}\defunargs{#3\unskip}%
7741 % Remaining @defun-like shortcuts:
7742 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
7743 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
7744 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
7745 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
7746 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
7747 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
7748 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
7749 \makedefun{defmethod}{\defopon\putwordMethodon}
7750 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
7751 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
7752 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
7754 % \defname, which formats the name of the @def (not the args).
7755 % #1 is the category, such as "Function".
7756 % #2 is the return type, if any.
7757 % #3 is the function name.
7759 % We are followed by (but not passed) the arguments, if any.
7761 \def\defname#1#2#3{%
7762 \par
7763 % Get the values of \leftskip and \rightskip as they were outside the @def...
7764 \advance\leftskip by -\defbodyindent
7766 % Determine if we are typesetting the return type of a typed function
7767 % on a line by itself.
7768 \rettypeownlinefalse
7769 \ifdoingtypefn % doing a typed function specifically?
7770 % then check user option for putting return type on its own line:
7771 \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
7772 \rettypeownlinetrue
7776 % How we'll format the category name. Putting it in brackets helps
7777 % distinguish it from the body text that may end up on the next line
7778 % just below it.
7779 \def\temp{#1}%
7780 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7782 % Figure out line sizes for the paragraph shape. We'll always have at
7783 % least two.
7784 \tempnum = 2
7786 % The first line needs space for \box0; but if \rightskip is nonzero,
7787 % we need only space for the part of \box0 which exceeds it:
7788 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
7790 % If doing a return type on its own line, we'll have another line.
7791 \ifrettypeownline
7792 \advance\tempnum by 1
7793 \def\maybeshapeline{0in \hsize}%
7794 \else
7795 \def\maybeshapeline{}%
7798 % The continuations:
7799 \dimen2=\hsize \advance\dimen2 by -\defargsindent
7801 % The final paragraph shape:
7802 \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2
7804 % Put the category name at the right margin.
7805 \noindent
7806 \hbox to 0pt{%
7807 \hfil\box0 \kern-\hsize
7808 % \hsize has to be shortened this way:
7809 \kern\leftskip
7810 % Intentionally do not respect \rightskip, since we need the space.
7813 % Allow all lines to be underfull without complaint:
7814 \tolerance=10000 \hbadness=10000
7815 \exdentamount=\defbodyindent
7817 % defun fonts. We use typewriter by default (used to be bold) because:
7818 % . we're printing identifiers, they should be in tt in principle.
7819 % . in languages with many accents, such as Czech or French, it's
7820 % common to leave accents off identifiers. The result looks ok in
7821 % tt, but exceedingly strange in rm.
7822 % . we don't want -- and --- to be treated as ligatures.
7823 % . this still does not fix the ?` and !` ligatures, but so far no
7824 % one has made identifiers using them :).
7825 \df \tt
7826 \def\temp{#2}% text of the return type
7827 \ifx\temp\empty\else
7828 \tclose{\temp}% typeset the return type
7829 \ifrettypeownline
7830 % put return type on its own line; prohibit line break following:
7831 \hfil\vadjust{\nobreak}\break
7832 \else
7833 \space % type on same line, so just followed by a space
7835 \fi % no return type
7836 #3% output function name
7838 {\rm\enskip}% hskip 0.5 em of \rmfont
7840 \boldbrax
7841 % arguments will be output next, if any.
7844 % Print arguments in slanted roman (not ttsl), inconsistently with using
7845 % tt for the name. This is because literal text is sometimes needed in
7846 % the argument list (groff manual), and ttsl and tt are not very
7847 % distinguishable. Prevent hyphenation at `-' chars.
7849 \def\defunargs#1{%
7850 % use sl by default (not ttsl),
7851 % tt for the names.
7852 \df \sl \hyphenchar\font=0
7854 % On the other hand, if an argument has two dashes (for instance), we
7855 % want a way to get ttsl. We used to recommend @var for that, so
7856 % leave the code in, but it's strange for @var to lead to typewriter.
7857 % Nowadays we recommend @code, since the difference between a ttsl hyphen
7858 % and a tt hyphen is pretty tiny. @code also disables ?` !`.
7859 \def\var##1{{\setregularquotes\ttslanted{##1}}}%
7861 \sl\hyphenchar\font=45
7864 % We want ()&[] to print specially on the defun line.
7866 \def\activeparens{%
7867 \catcode`\(=\active \catcode`\)=\active
7868 \catcode`\[=\active \catcode`\]=\active
7869 \catcode`\&=\active
7872 % Make control sequences which act like normal parenthesis chars.
7873 \let\lparen = ( \let\rparen = )
7875 % Be sure that we always have a definition for `(', etc. For example,
7876 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7877 % so TeX would otherwise complain about undefined control sequence.
7879 \activeparens
7880 \global\let(=\lparen \global\let)=\rparen
7881 \global\let[=\lbrack \global\let]=\rbrack
7882 \global\let& = \&
7884 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7885 \gdef\magicamp{\let&=\amprm}
7887 \let\ampchar\&
7889 \newcount\parencount
7891 % If we encounter &foo, then turn on ()-hacking afterwards
7892 \newif\ifampseen
7893 \def\amprm#1 {\ampseentrue{\bf\&#1 }}
7895 \def\parenfont{%
7896 \ifampseen
7897 % At the first level, print parens in roman,
7898 % otherwise use the default font.
7899 \ifnum \parencount=1 \rm \fi
7900 \else
7901 % The \sf parens (in \boldbrax) actually are a little bolder than
7902 % the contained text. This is especially needed for [ and ] .
7906 \def\infirstlevel#1{%
7907 \ifampseen
7908 \ifnum\parencount=1
7913 \def\bfafterword#1 {#1 \bf}
7915 \def\opnr{%
7916 \global\advance\parencount by 1
7917 {\parenfont(}%
7918 \infirstlevel \bfafterword
7920 \def\clnr{%
7921 {\parenfont)}%
7922 \infirstlevel \sl
7923 \global\advance\parencount by -1
7926 \newcount\brackcount
7927 \def\lbrb{%
7928 \global\advance\brackcount by 1
7929 {\bf[}%
7931 \def\rbrb{%
7932 {\bf]}%
7933 \global\advance\brackcount by -1
7936 \def\checkparencounts{%
7937 \ifnum\parencount=0 \else \badparencount \fi
7938 \ifnum\brackcount=0 \else \badbrackcount \fi
7940 % these should not use \errmessage; the glibc manual, at least, actually
7941 % has such constructs (when documenting function pointers).
7942 \def\badparencount{%
7943 \message{Warning: unbalanced parentheses in @def...}%
7944 \global\parencount=0
7946 \def\badbrackcount{%
7947 \message{Warning: unbalanced square brackets in @def...}%
7948 \global\brackcount=0
7952 \message{macros,}
7953 % @macro.
7955 % To do this right we need a feature of e-TeX, \scantokens,
7956 % which we arrange to emulate with a temporary file in ordinary TeX.
7957 \ifx\eTeXversion\thisisundefined
7958 \newwrite\macscribble
7959 \def\scantokens#1{%
7960 \toks0={#1}%
7961 \immediate\openout\macscribble=\jobname.tmp
7962 \immediate\write\macscribble{\the\toks0}%
7963 \immediate\closeout\macscribble
7964 \input \jobname.tmp
7968 \let\E=\expandafter
7970 % Used at the time of macro expansion.
7971 % Argument is macro body with arguments substituted
7972 \def\scanmacro#1{%
7973 \newlinechar`\^^M
7974 % expand the expansion of \eatleadingcr twice to maybe remove a leading
7975 % newline (and \else and \fi tokens), then call \eatspaces on the result.
7976 \def\xeatspaces##1{%
7977 \E\E\E\E\E\E\E\eatspaces\E\E\E\E\E\E\E{\eatleadingcr##1%
7979 \def\xempty##1{}%
7981 % Process the macro body under the current catcode regime.
7982 \scantokens{#1@comment}%
7984 % The \comment is to remove the \newlinechar added by \scantokens, and
7985 % can be noticed by \parsearg. Note \c isn't used because this means cedilla
7986 % in math mode.
7989 % Used for copying and captions
7990 \def\scanexp#1{%
7991 \expandafter\scanmacro\expandafter{#1}%
7994 \newcount\paramno % Count of parameters
7995 \newtoks\macname % Macro name
7996 \newif\ifrecursive % Is it recursive?
7998 % List of all defined macros in the form
7999 % \commondummyword\macro1\commondummyword\macro2...
8000 % Currently is also contains all @aliases; the list can be split
8001 % if there is a need.
8002 \def\macrolist{}
8004 % Add the macro to \macrolist
8005 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
8006 \def\addtomacrolistxxx#1{%
8007 \toks0 = \expandafter{\macrolist\commondummyword#1}%
8008 \xdef\macrolist{\the\toks0}%
8011 % Utility routines.
8012 % This does \let #1 = #2, with \csnames; that is,
8013 % \let \csname#1\endcsname = \csname#2\endcsname
8014 % (except of course we have to play expansion games).
8016 \def\cslet#1#2{%
8017 \expandafter\let
8018 \csname#1\expandafter\endcsname
8019 \csname#2\endcsname
8022 % Trim leading and trailing spaces off a string.
8023 % Concepts from aro-bend problem 15 (see CTAN).
8024 {\catcode`\@=11
8025 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
8026 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
8027 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
8028 \def\unbrace#1{#1}
8029 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
8032 {\catcode`\^^M=\other%
8033 \gdef\eatleadingcr#1{\if\noexpand#1\noexpand^^M\else\E#1\fi}}%
8034 % Warning: this won't work for a delimited argument
8035 % or for an empty argument
8037 % Trim a single trailing ^^M off a string.
8038 {\catcode`\^^M=\other \catcode`\Q=3%
8039 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
8040 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
8041 \gdef\eatcrb#1Q#2Q{#1}%
8044 % Macro bodies are absorbed as an argument in a context where
8045 % all characters are catcode 10, 11 or 12, except \ which is active
8046 % (as in normal texinfo). It is necessary to change the definition of \
8047 % to recognize macro arguments; this is the job of \mbodybackslash.
8049 % Non-ASCII encodings make 8-bit characters active, so un-activate
8050 % them to avoid their expansion. Must do this non-globally, to
8051 % confine the change to the current group.
8053 % It's necessary to have hard CRs when the macro is executed. This is
8054 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
8055 % body, and then making it the \newlinechar in \scanmacro.
8057 \def\scanctxt{% used as subroutine
8058 \catcode`\"=\other
8059 \catcode`\+=\other
8060 \catcode`\<=\other
8061 \catcode`\>=\other
8062 \catcode`\^=\other
8063 \catcode`\_=\other
8064 \catcode`\|=\other
8065 \catcode`\~=\other
8066 \passthroughcharstrue
8069 \def\scanargctxt{% used for copying and captions, not macros.
8070 \scanctxt
8071 \catcode`\@=\other
8072 \catcode`\\=\other
8073 \catcode`\^^M=\other
8076 \def\macrobodyctxt{% used for @macro definitions
8077 \scanctxt
8078 \catcode`\ =\other
8079 \catcode`\@=\other
8080 \catcode`\{=\other
8081 \catcode`\}=\other
8082 \catcode`\^^M=\other
8083 \usembodybackslash
8086 % Used when scanning braced macro arguments. Note, however, that catcode
8087 % changes here are ineffectual if the macro invocation was nested inside
8088 % an argument to another Texinfo command.
8089 \def\macroargctxt{%
8090 \scanctxt
8091 \catcode`\ =\active
8092 \catcode`\@=\other
8093 \catcode`\^^M=\other
8094 \catcode`\\=\active
8097 \def\macrolineargctxt{% used for whole-line arguments without braces
8098 \scanctxt
8099 \catcode`\@=\other
8100 \catcode`\{=\other
8101 \catcode`\}=\other
8104 % \mbodybackslash is the definition of \ in @macro bodies.
8105 % It maps \foo\ => \csname macarg.foo\endcsname => #N
8106 % where N is the macro parameter number.
8107 % We define \csname macarg.\endcsname to be \realbackslash, so
8108 % \\ in macro replacement text gets you a backslash.
8110 {\catcode`@=0 @catcode`@\=@active
8111 @gdef@usembodybackslash{@let\=@mbodybackslash}
8112 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
8114 \expandafter\def\csname macarg.\endcsname{\realbackslash}
8116 \def\margbackslash#1{\char`\#1 }
8118 \def\macro{\recursivefalse\parsearg\macroxxx}
8119 \def\rmacro{\recursivetrue\parsearg\macroxxx}
8121 \def\macroxxx#1{%
8122 \getargs{#1}% now \macname is the macname and \argl the arglist
8123 \ifx\argl\empty % no arguments
8124 \paramno=0\relax
8125 \else
8126 \expandafter\parsemargdef \argl;%
8127 \if\paramno>256\relax
8128 \ifx\eTeXversion\thisisundefined
8129 \errhelp = \EMsimple
8130 \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
8134 \if1\csname ismacro.\the\macname\endcsname
8135 \message{Warning: redefining \the\macname}%
8136 \else
8137 \expandafter\ifx\csname \the\macname\endcsname \relax
8138 \else \errmessage{Macro name \the\macname\space already defined}\fi
8139 \global\cslet{macsave.\the\macname}{\the\macname}%
8140 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
8141 \addtomacrolist{\the\macname}%
8143 \begingroup \macrobodyctxt
8144 \ifrecursive \expandafter\parsermacbody
8145 \else \expandafter\parsemacbody
8146 \fi}
8148 \parseargdef\unmacro{%
8149 \if1\csname ismacro.#1\endcsname
8150 \global\cslet{#1}{macsave.#1}%
8151 \global\expandafter\let \csname ismacro.#1\endcsname=0%
8152 % Remove the macro name from \macrolist:
8153 \begingroup
8154 \expandafter\let\csname#1\endcsname \relax
8155 \let\commondummyword\unmacrodo
8156 \xdef\macrolist{\macrolist}%
8157 \endgroup
8158 \else
8159 \errmessage{Macro #1 not defined}%
8163 % Called by \do from \dounmacro on each macro. The idea is to omit any
8164 % macro definitions that have been changed to \relax.
8166 \def\unmacrodo#1{%
8167 \ifx #1\relax
8168 % remove this
8169 \else
8170 \noexpand\commondummyword \noexpand#1%
8174 % \getargs -- Parse the arguments to a @macro line. Set \macname to
8175 % the name of the macro, and \argl to the braced argument list.
8176 \def\getargs#1{\getargsxxx#1{}}
8177 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
8178 \def\getmacname#1 #2\relax{\macname={#1}}
8179 \def\getmacargs#1{\def\argl{#1}}
8180 % This made use of the feature that if the last token of a
8181 % <parameter list> is #, then the preceding argument is delimited by
8182 % an opening brace, and that opening brace is not consumed.
8184 % Parse the optional {params} list to @macro or @rmacro.
8185 % Set \paramno to the number of arguments,
8186 % and \paramlist to a parameter text for the macro (e.g. #1,#2,#3 for a
8187 % three-param macro.) Define \macarg.BLAH for each BLAH in the params
8188 % list to some hook where the argument is to be expanded. If there are
8189 % less than 10 arguments that hook is to be replaced by ##N where N
8190 % is the position in that list, that is to say the macro arguments are to be
8191 % defined `a la TeX in the macro body.
8193 % That gets used by \mbodybackslash (above).
8195 % If there are 10 or more arguments, a different technique is used: see
8196 % \parsemmanyargdef.
8198 \def\parsemargdef#1;{%
8199 \paramno=0\def\paramlist{}%
8200 \let\hash\relax
8201 % \hash is redefined to `#' later to get it into definitions
8202 \let\xeatspaces\relax
8203 \let\xempty\relax
8204 \parsemargdefxxx#1,;,%
8205 \ifnum\paramno<10\relax\else
8206 \paramno0\relax
8207 \parsemmanyargdef@@#1,;,% 10 or more arguments
8210 \def\parsemargdefxxx#1,{%
8211 \if#1;\let\next=\relax
8212 \else \let\next=\parsemargdefxxx
8213 \advance\paramno by 1
8214 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
8215 {\xeatspaces{\hash\the\paramno\noexpand\xempty{}}}%
8216 \edef\paramlist{\paramlist\hash\the\paramno,}%
8217 \fi\next}
8218 % the \xempty{} is to give \eatleadingcr an argument in the case of an
8219 % empty macro argument.
8221 % \parsemacbody, \parsermacbody
8223 % Read recursive and nonrecursive macro bodies. (They're different since
8224 % rec and nonrec macros end differently.)
8226 % We are in \macrobodyctxt, and the \xdef causes backslashshes in the macro
8227 % body to be transformed.
8228 % Set \macrobody to the body of the macro, and call \defmacro.
8230 {\catcode`\ =\other\long\gdef\parsemacbody#1@end macro{%
8231 \xdef\macrobody{\eatcr{#1}}\endgroup\defmacro}}%
8232 {\catcode`\ =\other\long\gdef\parsermacbody#1@end rmacro{%
8233 \xdef\macrobody{\eatcr{#1}}\endgroup\defmacro}}%
8235 % Make @ a letter, so that we can make private-to-Texinfo macro names.
8236 \edef\texiatcatcode{\the\catcode`\@}
8237 \catcode `@=11\relax
8239 %%%%%%%%%%%%%% Code for > 10 arguments only %%%%%%%%%%%%%%%%%%
8241 % If there are 10 or more arguments, a different technique is used, where the
8242 % hook remains in the body, and when macro is to be expanded the body is
8243 % processed again to replace the arguments.
8245 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
8246 % argument N value and then \edef the body (nothing else will expand because of
8247 % the catcode regime under which the body was input).
8249 % If you compile with TeX (not eTeX), and you have macros with 10 or more
8250 % arguments, no macro can have more than 256 arguments (else error).
8252 % In case that there are 10 or more arguments we parse again the arguments
8253 % list to set new definitions for the \macarg.BLAH macros corresponding to
8254 % each BLAH argument. It was anyhow needed to parse already once this list
8255 % in order to count the arguments, and as macros with at most 9 arguments
8256 % are by far more frequent than macro with 10 or more arguments, defining
8257 % twice the \macarg.BLAH macros does not cost too much processing power.
8258 \def\parsemmanyargdef@@#1,{%
8259 \if#1;\let\next=\relax
8260 \else
8261 \let\next=\parsemmanyargdef@@
8262 \edef\tempb{\eatspaces{#1}}%
8263 \expandafter\def\expandafter\tempa
8264 \expandafter{\csname macarg.\tempb\endcsname}%
8265 % Note that we need some extra \noexpand\noexpand, this is because we
8266 % don't want \the to be expanded in the \parsermacbody as it uses an
8267 % \xdef .
8268 \expandafter\edef\tempa
8269 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
8270 \advance\paramno by 1\relax
8271 \fi\next}
8274 \let\endargs@\relax
8275 \let\nil@\relax
8276 \def\nilm@{\nil@}%
8277 \long\def\nillm@{\nil@}%
8279 % This macro is expanded during the Texinfo macro expansion, not during its
8280 % definition. It gets all the arguments' values and assigns them to macros
8281 % macarg.ARGNAME
8283 % #1 is the macro name
8284 % #2 is the list of argument names
8285 % #3 is the list of argument values
8286 \def\getargvals@#1#2#3{%
8287 \def\macargdeflist@{}%
8288 \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
8289 \def\paramlist{#2,\nil@}%
8290 \def\macroname{#1}%
8291 \begingroup
8292 \macroargctxt
8293 \def\argvaluelist{#3,\nil@}%
8294 \def\@tempa{#3}%
8295 \ifx\@tempa\empty
8296 \setemptyargvalues@
8297 \else
8298 \getargvals@@
8301 \def\getargvals@@{%
8302 \ifx\paramlist\nilm@
8303 % Some sanity check needed here that \argvaluelist is also empty.
8304 \ifx\argvaluelist\nillm@
8305 \else
8306 \errhelp = \EMsimple
8307 \errmessage{Too many arguments in macro `\macroname'!}%
8309 \let\next\macargexpandinbody@
8310 \else
8311 \ifx\argvaluelist\nillm@
8312 % No more arguments values passed to macro. Set remaining named-arg
8313 % macros to empty.
8314 \let\next\setemptyargvalues@
8315 \else
8316 % pop current arg name into \@tempb
8317 \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
8318 \expandafter\@tempa\expandafter{\paramlist}%
8319 % pop current argument value into \@tempc
8320 \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
8321 \expandafter\@tempa\expandafter{\argvaluelist}%
8322 % Here \@tempb is the current arg name and \@tempc is the current arg value.
8323 % First place the new argument macro definition into \@tempd
8324 \expandafter\macname\expandafter{\@tempc}%
8325 \expandafter\let\csname macarg.\@tempb\endcsname\relax
8326 \expandafter\def\expandafter\@tempe\expandafter{%
8327 \csname macarg.\@tempb\endcsname}%
8328 \edef\@tempd{\long\def\@tempe{\the\macname}}%
8329 \push@\@tempd\macargdeflist@
8330 \let\next\getargvals@@
8333 \next
8336 \def\push@#1#2{%
8337 \expandafter\expandafter\expandafter\def
8338 \expandafter\expandafter\expandafter#2%
8339 \expandafter\expandafter\expandafter{%
8340 \expandafter#1#2}%
8343 % Replace arguments by their values in the macro body, and place the result
8344 % in macro \@tempa.
8346 \def\macvalstoargs@{%
8347 % To do this we use the property that token registers that are \the'ed
8348 % within an \edef expand only once. So we are going to place all argument
8349 % values into respective token registers.
8351 % First we save the token context, and initialize argument numbering.
8352 \begingroup
8353 \paramno0\relax
8354 % Then, for each argument number #N, we place the corresponding argument
8355 % value into a new token list register \toks#N
8356 \expandafter\putargsintokens@\saveparamlist@,;,%
8357 % Then, we expand the body so that argument are replaced by their
8358 % values. The trick for values not to be expanded themselves is that they
8359 % are within tokens and that tokens expand only once in an \edef .
8360 \edef\@tempc{\csname mac.\macroname .body\endcsname}%
8361 % Now we restore the token stack pointer to free the token list registers
8362 % which we have used, but we make sure that expanded body is saved after
8363 % group.
8364 \expandafter
8365 \endgroup
8366 \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
8369 % Define the named-macro outside of this group and then close this group.
8371 \def\macargexpandinbody@{%
8372 \expandafter
8373 \endgroup
8374 \macargdeflist@
8375 % First the replace in body the macro arguments by their values, the result
8376 % is in \@tempa .
8377 \macvalstoargs@
8378 % Then we point at the \norecurse or \gobble (for recursive) macro value
8379 % with \@tempb .
8380 \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
8381 % Depending on whether it is recursive or not, we need some tailing
8382 % \egroup .
8383 \ifx\@tempb\gobble
8384 \let\@tempc\relax
8385 \else
8386 \let\@tempc\egroup
8388 % And now we do the real job:
8389 \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
8390 \@tempd
8393 \def\putargsintokens@#1,{%
8394 \if#1;\let\next\relax
8395 \else
8396 \let\next\putargsintokens@
8397 % First we allocate the new token list register, and give it a temporary
8398 % alias \@tempb .
8399 \toksdef\@tempb\the\paramno
8400 % Then we place the argument value into that token list register.
8401 \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
8402 \expandafter\@tempb\expandafter{\@tempa}%
8403 \advance\paramno by 1\relax
8405 \next
8408 % Trailing missing arguments are set to empty.
8410 \def\setemptyargvalues@{%
8411 \ifx\paramlist\nilm@
8412 \let\next\macargexpandinbody@
8413 \else
8414 \expandafter\setemptyargvaluesparser@\paramlist\endargs@
8415 \let\next\setemptyargvalues@
8417 \next
8420 \def\setemptyargvaluesparser@#1,#2\endargs@{%
8421 \expandafter\def\expandafter\@tempa\expandafter{%
8422 \expandafter\def\csname macarg.#1\endcsname{}}%
8423 \push@\@tempa\macargdeflist@
8424 \def\paramlist{#2}%
8427 % #1 is the element target macro
8428 % #2 is the list macro
8429 % #3,#4\endargs@ is the list value
8430 \def\pop@#1#2#3,#4\endargs@{%
8431 \def#1{#3}%
8432 \def#2{#4}%
8434 \long\def\longpop@#1#2#3,#4\endargs@{%
8435 \long\def#1{#3}%
8436 \long\def#2{#4}%
8440 %%%%%%%%%%%%%% End of code for > 10 arguments %%%%%%%%%%%%%%%%%%
8443 % This defines a Texinfo @macro or @rmacro, called by \parsemacbody.
8444 % \macrobody has the body of the macro in it, with placeholders for
8445 % its parameters, looking like "\xeatspaces{\hash 1}".
8446 % \paramno is the number of parameters
8447 % \paramlist is a TeX parameter text, e.g. "#1,#2,#3,"
8448 % There are four cases: macros of zero, one, up to nine, and many arguments.
8449 % \xdef is used so that macro definitions will survive the file
8450 % they're defined in: @include reads the file inside a group.
8452 \def\defmacro{%
8453 \let\hash=##% convert placeholders to macro parameter chars
8454 \ifnum\paramno=1
8455 \def\xeatspaces##1{##1}%
8456 % This removes the pair of braces around the argument. We don't
8457 % use \eatspaces, because this can cause ends of lines to be lost
8458 % when the argument to \eatspaces is read, leading to line-based
8459 % commands like "@itemize" not being read correctly.
8460 \else
8461 \let\xeatspaces\relax % suppress expansion
8463 \ifcase\paramno
8465 \expandafter\xdef\csname\the\macname\endcsname{%
8466 \bgroup
8467 \noexpand\spaceisspace
8468 \noexpand\endlineisspace
8469 \noexpand\expandafter % skip any whitespace after the macro name.
8470 \expandafter\noexpand\csname\the\macname @@@\endcsname}%
8471 \expandafter\xdef\csname\the\macname @@@\endcsname{%
8472 \egroup
8473 \noexpand\scanmacro{\macrobody}}%
8474 \or % 1
8475 \expandafter\xdef\csname\the\macname\endcsname{%
8476 \bgroup
8477 \noexpand\braceorline
8478 \expandafter\noexpand\csname\the\macname @@@\endcsname}%
8479 \expandafter\xdef\csname\the\macname @@@\endcsname##1{%
8480 \egroup
8481 \noexpand\scanmacro{\macrobody}%
8483 \else % at most 9
8484 \ifnum\paramno<10\relax
8485 % @MACNAME sets the context for reading the macro argument
8486 % @MACNAME@@ gets the argument, processes backslashes and appends a
8487 % comma.
8488 % @MACNAME@@@ removes braces surrounding the argument list.
8489 % @MACNAME@@@@ scans the macro body with arguments substituted.
8490 \expandafter\xdef\csname\the\macname\endcsname{%
8491 \bgroup
8492 \noexpand\expandafter % This \expandafter skip any spaces after the
8493 \noexpand\macroargctxt % macro before we change the catcode of space.
8494 \noexpand\expandafter
8495 \expandafter\noexpand\csname\the\macname @@\endcsname}%
8496 \expandafter\xdef\csname\the\macname @@\endcsname##1{%
8497 \noexpand\passargtomacro
8498 \expandafter\noexpand\csname\the\macname @@@\endcsname{##1,}}%
8499 \expandafter\xdef\csname\the\macname @@@\endcsname##1{%
8500 \expandafter\noexpand\csname\the\macname @@@@\endcsname ##1}%
8501 \expandafter\expandafter
8502 \expandafter\xdef
8503 \expandafter\expandafter
8504 \csname\the\macname @@@@\endcsname\paramlist{%
8505 \egroup\noexpand\scanmacro{\macrobody}}%
8506 \else % 10 or more:
8507 \expandafter\xdef\csname\the\macname\endcsname{%
8508 \noexpand\getargvals@{\the\macname}{\argl}%
8510 \global\expandafter\let\csname mac.\the\macname .body\endcsname\macrobody
8511 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
8513 \fi}
8515 \catcode `\@\texiatcatcode\relax % end private-to-Texinfo catcodes
8517 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
8520 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8522 {\catcode`\@=0 \catcode`\\=13 % We need to manipulate \ so use @ as escape
8523 @catcode`@_=11 % private names
8524 @catcode`@!=11 % used as argument separator
8526 % \passargtomacro#1#2 -
8527 % Call #1 with a list of tokens #2, with any doubled backslashes in #2
8528 % compressed to one.
8530 % This implementation works by expansion, and not execution (so we cannot use
8531 % \def or similar). This reduces the risk of this failing in contexts where
8532 % complete expansion is done with no execution (for example, in writing out to
8533 % an auxiliary file for an index entry).
8535 % State is kept in the input stream: the argument passed to
8536 % @look_ahead, @gobble_and_check_finish and @add_segment is
8538 % THE_MACRO ARG_RESULT ! {PENDING_BS} NEXT_TOKEN (... rest of input)
8540 % where:
8541 % THE_MACRO - name of the macro we want to call
8542 % ARG_RESULT - argument list we build to pass to that macro
8543 % PENDING_BS - either a backslash or nothing
8544 % NEXT_TOKEN - used to look ahead in the input stream to see what's coming next
8546 @gdef@passargtomacro#1#2{%
8547 @add_segment #1!{}@relax#2\@_finish\%
8549 @gdef@_finish{@_finishx} @global@let@_finishx@relax
8551 % #1 - THE_MACRO ARG_RESULT
8552 % #2 - PENDING_BS
8553 % #3 - NEXT_TOKEN
8554 % #4 used to look ahead
8556 % If the next token is not a backslash, process the rest of the argument;
8557 % otherwise, remove the next token.
8558 @gdef@look_ahead#1!#2#3#4{%
8559 @ifx#4\%
8560 @expandafter@gobble_and_check_finish
8561 @else
8562 @expandafter@add_segment
8563 @fi#1!{#2}#4#4%
8566 % #1 - THE_MACRO ARG_RESULT
8567 % #2 - PENDING_BS
8568 % #3 - NEXT_TOKEN
8569 % #4 should be a backslash, which is gobbled.
8570 % #5 looks ahead
8572 % Double backslash found. Add a single backslash, and look ahead.
8573 @gdef@gobble_and_check_finish#1!#2#3#4#5{%
8574 @add_segment#1\!{}#5#5%
8577 @gdef@is_fi{@fi}
8579 % #1 - THE_MACRO ARG_RESULT
8580 % #2 - PENDING_BS
8581 % #3 - NEXT_TOKEN
8582 % #4 is input stream until next backslash
8584 % Input stream is either at the start of the argument, or just after a
8585 % backslash sequence, either a lone backslash, or a doubled backslash.
8586 % NEXT_TOKEN contains the first token in the input stream: if it is \finish,
8587 % finish; otherwise, append to ARG_RESULT the segment of the argument up until
8588 % the next backslash. PENDING_BACKSLASH contains a backslash to represent
8589 % a backslash just before the start of the input stream that has not been
8590 % added to ARG_RESULT.
8591 @gdef@add_segment#1!#2#3#4\{%
8592 @ifx#3@_finish
8593 @call_the_macro#1!%
8594 @else
8595 % append the pending backslash to the result, followed by the next segment
8596 @expandafter@is_fi@look_ahead#1#2#4!{\}@fi
8597 % this @fi is discarded by @look_ahead.
8598 % we can't get rid of it with \expandafter because we don't know how
8599 % long #4 is.
8602 % #1 - THE_MACRO
8603 % #2 - ARG_RESULT
8604 % #3 discards the res of the conditional in @add_segment, and @is_fi ends the
8605 % conditional.
8606 @gdef@call_the_macro#1#2!#3@fi{@is_fi #1{#2}}
8609 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8611 % \braceorline MAC is used for a one-argument macro MAC. It checks
8612 % whether the next non-whitespace character is a {. It sets the context
8613 % for reading the argument (slightly different in the two cases). Then,
8614 % to read the argument, in the whole-line case, it then calls the regular
8615 % \parsearg MAC; in the lbrace case, it calls \passargtomacro MAC.
8617 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
8618 \def\braceorlinexxx{%
8619 \ifx\nchar\bgroup
8620 \macroargctxt
8621 \expandafter\passargtomacro
8622 \else
8623 \macrolineargctxt\expandafter\parsearg
8624 \fi \macnamexxx}
8627 % @alias.
8628 % We need some trickery to remove the optional spaces around the equal
8629 % sign. Make them active and then expand them all to nothing.
8631 \def\alias{\parseargusing\obeyspaces\aliasxxx}
8632 \def\aliasxxx #1{\aliasyyy#1\relax}
8633 \def\aliasyyy #1=#2\relax{%
8635 \expandafter\let\obeyedspace=\empty
8636 \addtomacrolist{#1}%
8637 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
8639 \next
8643 \message{cross references,}
8645 \newwrite\auxfile
8646 \newif\ifhavexrefs % True if xref values are known.
8647 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
8649 % @inforef is relatively simple.
8650 \def\inforef #1{\inforefzzz #1,,,,**}
8651 \def\inforefzzz #1,#2,#3,#4**{%
8652 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
8653 node \samp{\ignorespaces#1{}}}
8655 % @node's only job in TeX is to define \lastnode, which is used in
8656 % cross-references. The @node line might or might not have commas, and
8657 % might or might not have spaces before the first comma, like:
8658 % @node foo , bar , ...
8659 % We don't want such trailing spaces in the node name.
8661 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
8663 % also remove a trailing comma, in case of something like this:
8664 % @node Help-Cross, , , Cross-refs
8665 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
8666 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}\omittopnode}
8668 % Used so that the @top node doesn't have to be wrapped in an @ifnottex
8669 % conditional.
8670 % \doignore goes to more effort to skip nested conditionals but we don't need
8671 % that here.
8672 \def\omittopnode{%
8673 \ifx\lastnode\wordTop
8674 \expandafter\ignorenode\fi
8676 \def\wordTop{Top}
8678 % Until the next @node, @part or @bye command, divert output to a box that
8679 % is not output.
8680 \def\ignorenode{\setbox\dummybox\vbox\bgroup
8681 \def\part{\egroup\part}%
8682 \def\node{\egroup\node}%
8683 \ignorenodebye
8686 {\let\bye\relax
8687 \gdef\ignorenodebye{\let\bye\ignorenodebyedef}
8688 \gdef\ignorenodebyedef{\egroup(`Top' node ignored)\bye}}
8689 % The redefinition of \bye here is because it is declared \outer
8691 \let\lastnode=\empty
8693 % Write a cross-reference definition for the current node. #1 is the
8694 % type (Ynumbered, Yappendix, Ynothing).
8696 \def\donoderef#1{%
8697 \ifx\lastnode\empty\else
8698 \setref{\lastnode}{#1}%
8699 \global\let\lastnode=\empty
8703 % @anchor{NAME} -- define xref target at arbitrary point.
8705 \newcount\savesfregister
8707 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
8708 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
8709 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
8711 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
8712 % anchor), which consists of three parts:
8713 % 1) NAME-title - the current sectioning name taken from \currentsection,
8714 % or the anchor name.
8715 % 2) NAME-snt - section number and type, passed as the SNT arg, or
8716 % empty for anchors.
8717 % 3) NAME-pg - the page number.
8719 % This is called from \donoderef, \anchor, and \dofloat. In the case of
8720 % floats, there is an additional part, which is not written here:
8721 % 4) NAME-lof - the text as it should appear in a @listoffloats.
8723 \def\setref#1#2{%
8724 \pdfmkdest{#1}%
8725 \iflinks
8727 \requireauxfile
8728 \atdummies % preserve commands, but don't expand them
8729 % match definition in \xrdef, \refx, \xrefX.
8730 \def\value##1{##1}%
8731 \edef\writexrdef##1##2{%
8732 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
8733 ##1}{##2}}% these are parameters of \writexrdef
8735 \toks0 = \expandafter{\currentsection}%
8736 \immediate \writexrdef{title}{\the\toks0 }%
8737 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
8738 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
8743 % @xrefautosectiontitle on|off says whether @section(ing) names are used
8744 % automatically in xrefs, if the third arg is not explicitly specified.
8745 % This was provided as a "secret" @set xref-automatic-section-title
8746 % variable, now it's official.
8748 \parseargdef\xrefautomaticsectiontitle{%
8749 \def\temp{#1}%
8750 \ifx\temp\onword
8751 \expandafter\let\csname SETxref-automatic-section-title\endcsname
8752 = \empty
8753 \else\ifx\temp\offword
8754 \expandafter\let\csname SETxref-automatic-section-title\endcsname
8755 = \relax
8756 \else
8757 \errhelp = \EMsimple
8758 \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
8759 must be on|off}%
8760 \fi\fi
8763 % \f
8764 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
8765 % the node name, #2 the name of the Info cross-reference, #3 the printed
8766 % node name, #4 the name of the Info file, #5 the name of the printed
8767 % manual. All but the node name can be omitted.
8769 \def\pxref{\putwordsee{} \xrefXX}
8770 \def\xref{\putwordSee{} \xrefXX}
8771 \def\ref{\xrefXX}
8773 \def\xrefXX#1{\def\xrefXXarg{#1}\futurelet\tokenafterxref\xrefXXX}
8774 \def\xrefXXX{\expandafter\xrefX\expandafter[\xrefXXarg,,,,,,,]}
8776 \newbox\toprefbox
8777 \newbox\printedrefnamebox
8778 \newbox\infofilenamebox
8779 \newbox\printedmanualbox
8781 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
8782 \unsepspaces
8784 % Get args without leading/trailing spaces.
8785 \def\printedrefname{\ignorespaces #3}%
8786 \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
8788 \def\infofilename{\ignorespaces #4}%
8789 \setbox\infofilenamebox = \hbox{\infofilename\unskip}%
8791 \def\printedmanual{\ignorespaces #5}%
8792 \setbox\printedmanualbox = \hbox{\printedmanual\unskip}%
8794 % If the printed reference name (arg #3) was not explicitly given in
8795 % the @xref, figure out what we want to use.
8796 \ifdim \wd\printedrefnamebox = 0pt
8797 % No printed node name was explicitly given.
8798 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
8799 % Not auto section-title: use node name inside the square brackets.
8800 \def\printedrefname{\ignorespaces #1}%
8801 \else
8802 % Auto section-title: use chapter/section title inside
8803 % the square brackets if we have it.
8804 \ifdim \wd\printedmanualbox > 0pt
8805 % It is in another manual, so we don't have it; use node name.
8806 \def\printedrefname{\ignorespaces #1}%
8807 \else
8808 \ifhavexrefs
8809 % We (should) know the real title if we have the xref values.
8810 \def\printedrefname{\refx{#1-title}}%
8811 \else
8812 % Otherwise just copy the Info node name.
8813 \def\printedrefname{\ignorespaces #1}%
8814 \fi%
8819 % Make link in pdf output.
8820 \ifpdf
8821 % For pdfTeX and LuaTeX
8822 {\indexnofonts
8823 \makevalueexpandable
8824 \turnoffactive
8825 % This expands tokens, so do it after making catcode changes, so _
8826 % etc. don't get their TeX definitions. This ignores all spaces in
8827 % #4, including (wrongly) those in the middle of the filename.
8828 \getfilename{#4}%
8830 % This (wrongly) does not take account of leading or trailing
8831 % spaces in #1, which should be ignored.
8832 \setpdfdestname{#1}%
8834 \ifx\pdfdestname\empty
8835 \def\pdfdestname{Top}% no empty targets
8838 \leavevmode
8839 \startlink attr{/Border [0 0 0]}%
8840 \ifnum\filenamelength>0
8841 goto file{\the\filename.pdf} name{\pdfdestname}%
8842 \else
8843 goto name{\pdfmkpgn{\pdfdestname}}%
8846 \setcolor{\linkcolor}%
8847 \else
8848 \ifx\XeTeXrevision\thisisundefined
8849 \else
8850 % For XeTeX
8851 {\indexnofonts
8852 \makevalueexpandable
8853 \turnoffactive
8854 % This expands tokens, so do it after making catcode changes, so _
8855 % etc. don't get their TeX definitions. This ignores all spaces in
8856 % #4, including (wrongly) those in the middle of the filename.
8857 \getfilename{#4}%
8859 % This (wrongly) does not take account of leading or trailing
8860 % spaces in #1, which should be ignored.
8861 \setpdfdestname{#1}%
8863 \ifx\pdfdestname\empty
8864 \def\pdfdestname{Top}% no empty targets
8867 \leavevmode
8868 \ifnum\filenamelength>0
8869 % With default settings,
8870 % XeTeX (xdvipdfmx) replaces link destination names with integers.
8871 % In this case, the replaced destination names of
8872 % remote PDFs are no longer known. In order to avoid a replacement,
8873 % you can use xdvipdfmx's command line option `-C 0x0010'.
8874 % If you use XeTeX 0.99996+ (TeX Live 2016+),
8875 % this command line option is no longer necessary
8876 % because we can use the `dvipdfmx:config' special.
8877 \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A
8878 << /S /GoToR /F (\the\filename.pdf) /D (\pdfdestname) >> >>}%
8879 \else
8880 \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A
8881 << /S /GoTo /D (\pdfdestname) >> >>}%
8884 \setcolor{\linkcolor}%
8888 % Have to otherify everything special to allow the \csname to
8889 % include an _ in the xref name, etc.
8890 \indexnofonts
8891 \turnoffactive
8892 \def\value##1{##1}%
8893 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
8894 \csname XR#1-title\endcsname
8897 % Float references are printed completely differently: "Figure 1.2"
8898 % instead of "[somenode], p.3". \iffloat distinguishes them by
8899 % \Xthisreftitle being set to a magic string.
8900 \iffloat\Xthisreftitle
8901 % If the user specified the print name (third arg) to the ref,
8902 % print it instead of our usual "Figure 1.2".
8903 \ifdim\wd\printedrefnamebox = 0pt
8904 \refx{#1-snt}%
8905 \else
8906 \printedrefname
8909 % If the user also gave the printed manual name (fifth arg), append
8910 % "in MANUALNAME".
8911 \ifdim \wd\printedmanualbox > 0pt
8912 \space \putwordin{} \cite{\printedmanual}%
8914 \else
8915 % node/anchor (non-float) references.
8917 % If we use \unhbox to print the node names, TeX does not insert
8918 % empty discretionaries after hyphens, which means that it will not
8919 % find a line break at a hyphen in a node names. Since some manuals
8920 % are best written with fairly long node names, containing hyphens,
8921 % this is a loss. Therefore, we give the text of the node name
8922 % again, so it is as if TeX is seeing it for the first time.
8924 \ifdim \wd\printedmanualbox > 0pt
8925 % Cross-manual reference with a printed manual name.
8927 \crossmanualxref{\cite{\printedmanual\unskip}}%
8929 \else\ifdim \wd\infofilenamebox > 0pt
8930 % Cross-manual reference with only an info filename (arg 4), no
8931 % printed manual name (arg 5). This is essentially the same as
8932 % the case above; we output the filename, since we have nothing else.
8934 \crossmanualxref{\code{\infofilename\unskip}}%
8936 \else
8937 % Reference within this manual.
8939 % Only output a following space if the -snt ref is nonempty, as the ref
8940 % will be empty for @unnumbered and @anchor.
8941 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}}%
8942 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
8944 % output the `[mynode]' via the macro below so it can be overridden.
8945 \xrefprintnodename\printedrefname
8947 \expandafter\ifx\csname SETtxiomitxrefpg\endcsname\relax
8948 % But we always want a comma and a space:
8949 ,\space
8951 % output the `page 3'.
8952 \turnoffactive \putwordpage\tie\refx{#1-pg}%
8953 % Add a , if xref followed by a space
8954 \if\space\noexpand\tokenafterxref ,%
8955 \else\ifx\ \tokenafterxref ,% @TAB
8956 \else\ifx\*\tokenafterxref ,% @*
8957 \else\ifx\ \tokenafterxref ,% @SPACE
8958 \else\ifx\
8959 \tokenafterxref ,% @NL
8960 \else\ifx\tie\tokenafterxref ,% @tie
8961 \fi\fi\fi\fi\fi\fi
8963 \fi\fi
8965 \endlink
8966 \endgroup}
8968 % Output a cross-manual xref to #1. Used just above (twice).
8970 % Only include the text "Section ``foo'' in" if the foo is neither
8971 % missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply
8972 % "see The Foo Manual", the idea being to refer to the whole manual.
8974 % But, this being TeX, we can't easily compare our node name against the
8975 % string "Top" while ignoring the possible spaces before and after in
8976 % the input. By adding the arbitrary 7sp below, we make it much less
8977 % likely that a real node name would have the same width as "Top" (e.g.,
8978 % in a monospaced font). Hopefully it will never happen in practice.
8980 % For the same basic reason, we retypeset the "Top" at every
8981 % reference, since the current font is indeterminate.
8983 \def\crossmanualxref#1{%
8984 \setbox\toprefbox = \hbox{Top\kern7sp}%
8985 \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8986 \ifdim \wd2 > 7sp % nonempty?
8987 \ifdim \wd2 = \wd\toprefbox \else % same as Top?
8988 \putwordSection{} ``\printedrefname'' \putwordin{}\space
8994 % This macro is called from \xrefX for the `[nodename]' part of xref
8995 % output. It's a separate macro only so it can be changed more easily,
8996 % since square brackets don't work well in some documents. Particularly
8997 % one that Bob is working on :).
8999 \def\xrefprintnodename#1{[#1]}
9001 % Things referred to by \setref.
9003 \def\Ynothing{}
9004 \def\Yomitfromtoc{}
9005 \def\Ynumbered{%
9006 \ifnum\secno=0
9007 \putwordChapter@tie \the\chapno
9008 \else \ifnum\subsecno=0
9009 \putwordSection@tie \the\chapno.\the\secno
9010 \else \ifnum\subsubsecno=0
9011 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
9012 \else
9013 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
9014 \fi\fi\fi
9016 \def\Yappendix{%
9017 \ifnum\secno=0
9018 \putwordAppendix@tie @char\the\appendixno{}%
9019 \else \ifnum\subsecno=0
9020 \putwordSection@tie @char\the\appendixno.\the\secno
9021 \else \ifnum\subsubsecno=0
9022 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
9023 \else
9024 \putwordSection@tie
9025 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
9026 \fi\fi\fi
9029 % \refx{NAME} - reference a cross-reference string named NAME.
9030 \def\refx#1{%
9031 \requireauxfile
9033 \indexnofonts
9034 \turnoffactive
9035 \def\value##1{##1}%
9036 \expandafter\global\expandafter\let\expandafter\thisrefX
9037 \csname XR#1\endcsname
9039 \ifx\thisrefX\relax
9040 % If not defined, say something at least.
9041 \angleleft un\-de\-fined\angleright
9042 \iflinks
9043 \ifhavexrefs
9044 {\toks0 = {#1}% avoid expansion of possibly-complex value
9045 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
9046 \else
9047 \ifwarnedxrefs\else
9048 \global\warnedxrefstrue
9049 \message{Cross reference values unknown; you must run TeX again.}%
9053 \else
9054 % It's defined, so just use it.
9055 \thisrefX
9059 % This is the macro invoked by entries in the aux file. Define a control
9060 % sequence for a cross-reference target (we prepend XR to the control sequence
9061 % name to avoid collisions). The value is the page number. If this is a float
9062 % type, we have more work to do.
9064 \def\xrdef#1#2{%
9065 {% Expand the node or anchor name to remove control sequences.
9066 % \turnoffactive stops 8-bit characters being changed to commands
9067 % like @'e. \refx does the same to retrieve the value in the definition.
9068 \indexnofonts
9069 \turnoffactive
9070 \def\value##1{##1}%
9071 \xdef\safexrefname{#1}%
9074 \bgroup
9075 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}%
9076 \egroup
9077 % We put the \gdef inside a group to avoid the definitions building up on
9078 % TeX's save stack, which can cause it to run out of space for aux files with
9079 % thousands of lines. \gdef doesn't use the save stack, but \csname does
9080 % when it defines an unknown control sequence as \relax.
9082 % Was that xref control sequence that we just defined for a float?
9083 \expandafter\iffloat\csname XR\safexrefname\endcsname
9084 % it was a float, and we have the (safe) float type in \iffloattype.
9085 \expandafter\let\expandafter\floatlist
9086 \csname floatlist\iffloattype\endcsname
9088 % Is this the first time we've seen this float type?
9089 \expandafter\ifx\floatlist\relax
9090 \toks0 = {\do}% yes, so just \do
9091 \else
9092 % had it before, so preserve previous elements in list.
9093 \toks0 = \expandafter{\floatlist\do}%
9096 % Remember this xref in the control sequence \floatlistFLOATTYPE,
9097 % for later use in \listoffloats.
9098 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
9099 {\safexrefname}}%
9103 % If working on a large document in chapters, it is convenient to
9104 % be able to disable indexing, cross-referencing, and contents, for test runs.
9105 % This is done with @novalidate at the beginning of the file.
9107 \newif\iflinks \linkstrue % by default we want the aux files.
9108 \let\novalidate = \linksfalse
9110 % Used when writing to the aux file, or when using data from it.
9111 \def\requireauxfile{%
9112 \iflinks
9113 \tryauxfile
9114 % Open the new aux file. TeX will close it automatically at exit.
9115 \immediate\openout\auxfile=\jobname.aux
9117 \global\let\requireauxfile=\relax % Only do this once.
9120 % Read the last existing aux file, if any. No error if none exists.
9122 \def\tryauxfile{%
9123 \openin 1 \jobname.aux
9124 \ifeof 1 \else
9125 \readdatafile{aux}%
9126 \global\havexrefstrue
9128 \closein 1
9131 \def\setupdatafile{%
9132 \catcode`\^^@=\other
9133 \catcode`\^^A=\other
9134 \catcode`\^^B=\other
9135 \catcode`\^^C=\other
9136 \catcode`\^^D=\other
9137 \catcode`\^^E=\other
9138 \catcode`\^^F=\other
9139 \catcode`\^^G=\other
9140 \catcode`\^^H=\other
9141 \catcode`\^^K=\other
9142 \catcode`\^^L=\other
9143 \catcode`\^^N=\other
9144 \catcode`\^^P=\other
9145 \catcode`\^^Q=\other
9146 \catcode`\^^R=\other
9147 \catcode`\^^S=\other
9148 \catcode`\^^T=\other
9149 \catcode`\^^U=\other
9150 \catcode`\^^V=\other
9151 \catcode`\^^W=\other
9152 \catcode`\^^X=\other
9153 \catcode`\^^Z=\other
9154 \catcode`\^^[=\other
9155 \catcode`\^^\=\other
9156 \catcode`\^^]=\other
9157 \catcode`\^^^=\other
9158 \catcode`\^^_=\other
9159 \catcode`\^=\other
9161 % Special characters. Should be turned off anyway, but...
9162 \catcode`\~=\other
9163 \catcode`\[=\other
9164 \catcode`\]=\other
9165 \catcode`\"=\other
9166 \catcode`\_=\active
9167 \catcode`\|=\active
9168 \catcode`\<=\active
9169 \catcode`\>=\active
9170 \catcode`\$=\other
9171 \catcode`\#=\other
9172 \catcode`\&=\other
9173 \catcode`\%=\other
9174 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
9176 \catcode`\\=\active
9178 % @ is our escape character in .aux files, and we need braces.
9179 \catcode`\{=1
9180 \catcode`\}=2
9181 \catcode`\@=0
9184 \def\readdatafile#1{%
9185 \begingroup
9186 \setupdatafile
9187 \input\jobname.#1
9188 \endgroup}
9191 \message{insertions,}
9192 % including footnotes.
9194 \newcount \footnoteno
9196 % The trailing space in the following definition for supereject is
9197 % vital for proper filling; pages come out unaligned when you do a
9198 % pagealignmacro call if that space before the closing brace is
9199 % removed. (Generally, numeric constants should always be followed by a
9200 % space to prevent strange expansion errors.)
9201 \def\supereject{\par\penalty -20000\footnoteno =0 }
9203 % @footnotestyle is meaningful for Info output only.
9204 \let\footnotestyle=\comment
9206 {\catcode `\@=11
9208 % Auto-number footnotes. Otherwise like plain.
9209 \gdef\footnote{%
9210 \global\advance\footnoteno by \@ne
9211 \edef\thisfootno{$^{\the\footnoteno}$}%
9213 % In case the footnote comes at the end of a sentence, preserve the
9214 % extra spacing after we do the footnote number.
9215 \let\@sf\empty
9216 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
9218 % Remove inadvertent blank space before typesetting the footnote number.
9219 \unskip
9220 \thisfootno\@sf
9221 \dofootnote
9224 % Don't bother with the trickery in plain.tex to not require the
9225 % footnote text as a parameter. Our footnotes don't need to be so general.
9227 % Oh yes, they do; otherwise, @ifset (and anything else that uses
9228 % \parseargline) fails inside footnotes because the tokens are fixed when
9229 % the footnote is read. --karl, 16nov96.
9231 \gdef\dofootnote{%
9232 \insert\footins\bgroup
9234 % Nested footnotes are not supported in TeX, that would take a lot
9235 % more work. (\startsavinginserts does not suffice.)
9236 \let\footnote=\errfootnotenest
9238 % We want to typeset this text as a normal paragraph, even if the
9239 % footnote reference occurs in (for example) a display environment.
9240 % So reset some parameters.
9241 \hsize=\txipagewidth
9242 \interlinepenalty\interfootnotelinepenalty
9243 \splittopskip\ht\strutbox % top baseline for broken footnotes
9244 \splitmaxdepth\dp\strutbox
9245 \floatingpenalty\@MM
9246 \leftskip\z@skip
9247 \rightskip\z@skip
9248 \spaceskip\z@skip
9249 \xspaceskip\z@skip
9250 \parindent\defaultparindent
9252 \smallfonts \rm
9254 % Because we use hanging indentation in footnotes, a @noindent appears
9255 % to exdent this text, so make it be a no-op. makeinfo does not use
9256 % hanging indentation so @noindent can still be needed within footnote
9257 % text after an @example or the like (not that this is good style).
9258 \let\noindent = \relax
9260 % Hang the footnote text off the number. Use \everypar in case the
9261 % footnote extends for more than one paragraph.
9262 \everypar = {\hang}%
9263 \textindent{\thisfootno}%
9265 % Don't crash into the line above the footnote text. Since this
9266 % expands into a box, it must come within the paragraph, lest it
9267 % provide a place where TeX can split the footnote.
9268 \footstrut
9270 % Invoke rest of plain TeX footnote routine.
9271 \futurelet\next\fo@t
9273 }%end \catcode `\@=11
9275 \def\errfootnotenest{%
9276 \errhelp=\EMsimple
9277 \errmessage{Nested footnotes not supported in texinfo.tex,
9278 even though they work in makeinfo; sorry}
9281 \def\errfootnoteheading{%
9282 \errhelp=\EMsimple
9283 \errmessage{Footnotes in chapters, sections, etc., are not supported}
9286 % In case a @footnote appears in a vbox, save the footnote text and create
9287 % the real \insert just after the vbox finished. Otherwise, the insertion
9288 % would be lost.
9289 % Similarly, if a @footnote appears inside an alignment, save the footnote
9290 % text to a box and make the \insert when a row of the table is finished.
9291 % And the same can be done for other insert classes. --kasal, 16nov03.
9293 % Replace the \insert primitive by a cheating macro.
9294 % Deeper inside, just make sure that the saved insertions are not spilled
9295 % out prematurely.
9297 \def\startsavinginserts{%
9298 \ifx \insert\ptexinsert
9299 \let\insert\saveinsert
9300 \else
9301 \let\checkinserts\relax
9305 % This \insert replacement works for both \insert\footins{foo} and
9306 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
9308 \def\saveinsert#1{%
9309 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
9310 \afterassignment\next
9311 % swallow the left brace
9312 \let\temp =
9314 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
9315 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
9317 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
9319 \def\placesaveins#1{%
9320 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
9321 {\box#1}%
9324 % eat @SAVE -- beware, all of them have catcode \other:
9326 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
9327 \gdef\gobblesave @SAVE{}
9330 % initialization:
9331 \def\newsaveins #1{%
9332 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
9333 \next
9335 \def\newsaveinsX #1{%
9336 \csname newbox\endcsname #1%
9337 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
9338 \checksaveins #1}%
9341 % initialize:
9342 \let\checkinserts\empty
9343 \newsaveins\footins
9344 \newsaveins\margin
9347 % @image. We use the macros from epsf.tex to support this.
9348 % If epsf.tex is not installed and @image is used, we complain.
9350 % Check for and read epsf.tex up front. If we read it only at @image
9351 % time, we might be inside a group, and then its definitions would get
9352 % undone and the next image would fail.
9353 \openin 1 = epsf.tex
9354 \ifeof 1 \else
9355 % Do not bother showing banner with epsf.tex v2.7k (available in
9356 % doc/epsf.tex and on ctan).
9357 \def\epsfannounce{\toks0 = }%
9358 \input epsf.tex
9360 \closein 1
9362 % We will only complain once about lack of epsf.tex.
9363 \newif\ifwarnednoepsf
9364 \newhelp\noepsfhelp{epsf.tex must be installed for images to
9365 work. It is also included in the Texinfo distribution, or you can get
9366 it from https://ctan.org/texarchive/macros/texinfo/texinfo/doc/epsf.tex.}
9368 \def\image#1{%
9369 \ifx\epsfbox\thisisundefined
9370 \ifwarnednoepsf \else
9371 \errhelp = \noepsfhelp
9372 \errmessage{epsf.tex not found, images will be ignored}%
9373 \global\warnednoepsftrue
9375 \else
9376 \imagexxx #1,,,,,\finish
9380 % Arguments to @image:
9381 % #1 is (mandatory) image filename; we tack on .eps extension.
9382 % #2 is (optional) width, #3 is (optional) height.
9383 % #4 is (ignored optional) html alt text.
9384 % #5 is (ignored optional) extension.
9385 % #6 is just the usual extra ignored arg for parsing stuff.
9386 \newif\ifimagevmode
9387 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
9388 \catcode`\^^M = 5 % in case we're inside an example
9389 \normalturnoffactive % allow _ et al. in names
9390 \makevalueexpandable
9391 \ifvmode
9392 \imagevmodetrue
9393 \else \ifx\centersub\centerV
9394 % for @center @image, we need a vbox so we can have our vertical space
9395 \imagevmodetrue
9396 \vbox\bgroup % vbox has better behavior than vtop here
9397 \fi\fi
9399 \ifimagevmode
9400 \medskip
9401 % Usually we'll have text after the image which will insert
9402 % \parskip glue, so insert it here too to equalize the space
9403 % above and below.
9404 \vskip\parskip
9406 % Place image in a \vtop for a top page margin that is (close to) correct,
9407 % as \topskip glue is relative to the first baseline.
9408 \vtop\bgroup\hrule height 0pt\vskip-\parskip
9411 % Enter horizontal mode so that indentation from an enclosing
9412 % environment such as @quotation is respected.
9413 % However, if we're at the top level, we don't want the
9414 % normal paragraph indentation.
9415 % On the other hand, if we are in the case of @center @image, we don't
9416 % want to start a paragraph, which will create a hsize-width box and
9417 % eradicate the centering.
9418 \ifx\centersub\centerV \else \imageindent \fi
9420 % Output the image.
9421 \ifpdf
9422 % For pdfTeX and LuaTeX <= 0.80
9423 \dopdfimage{#1}{#2}{#3}%
9424 \else
9425 \ifx\XeTeXrevision\thisisundefined
9426 % For epsf.tex
9427 % \epsfbox itself resets \epsf?size at each figure.
9428 \setbox0 = \hbox{\ignorespaces #2}%
9429 \ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
9430 \setbox0 = \hbox{\ignorespaces #3}%
9431 \ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
9432 \epsfbox{#1.eps}%
9433 \else
9434 % For XeTeX
9435 \doxeteximage{#1}{#2}{#3}%
9439 \ifimagevmode
9440 \egroup
9441 \medskip % space after a standalone image
9443 \ifx\centersub\centerV \egroup \fi
9444 \endgroup}
9447 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
9448 % etc. We don't actually implement floating yet, we always include the
9449 % float "here". But it seemed the best name for the future.
9451 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
9453 % There may be a space before second and/or third parameter; delete it.
9454 \def\eatcommaspace#1, {#1,}
9456 % #1 is the optional FLOATTYPE, the text label for this float, typically
9457 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
9458 % this float will not be numbered and cannot be referred to.
9460 % #2 is the optional xref label. Also must be present for the float to
9461 % be referable.
9463 % #3 is the optional positioning argument; for now, it is ignored. It
9464 % will somehow specify the positions allowed to float to (here, top, bottom).
9466 % We keep a separate counter for each FLOATTYPE, which we reset at each
9467 % chapter-level command.
9468 \let\resetallfloatnos=\empty
9470 \def\dofloat#1,#2,#3,#4\finish{%
9471 \let\thiscaption=\empty
9472 \let\thisshortcaption=\empty
9474 % don't lose footnotes inside @float.
9476 % BEWARE: when the floats start float, we have to issue warning whenever an
9477 % insert appears inside a float which could possibly float. --kasal, 26may04
9479 \startsavinginserts
9481 % We can't be used inside a paragraph.
9482 \par
9484 \vtop\bgroup
9485 \def\floattype{#1}%
9486 \def\floatlabel{#2}%
9487 \def\floatloc{#3}% we do nothing with this yet.
9489 \ifx\floattype\empty
9490 \let\safefloattype=\empty
9491 \else
9493 % the floattype might have accents or other special characters,
9494 % but we need to use it in a control sequence name.
9495 \indexnofonts
9496 \turnoffactive
9497 \xdef\safefloattype{\floattype}%
9501 % If label is given but no type, we handle that as the empty type.
9502 \ifx\floatlabel\empty \else
9503 % We want each FLOATTYPE to be numbered separately (Figure 1,
9504 % Table 1, Figure 2, ...). (And if no label, no number.)
9506 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
9507 \global\advance\floatno by 1
9510 % This magic value for \currentsection is output by \setref as the
9511 % XREFLABEL-title value. \xrefX uses it to distinguish float
9512 % labels (which have a completely different output format) from
9513 % node and anchor labels. And \xrdef uses it to construct the
9514 % lists of floats.
9516 \edef\currentsection{\floatmagic=\safefloattype}%
9517 \setref{\floatlabel}{Yfloat}%
9521 % start with \parskip glue, I guess.
9522 \vskip\parskip
9524 % Don't suppress indentation if a float happens to start a section.
9525 \restorefirstparagraphindent
9528 % we have these possibilities:
9529 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
9530 % @float Foo,lbl & no caption: Foo 1.1
9531 % @float Foo & @caption{Cap}: Foo: Cap
9532 % @float Foo & no caption: Foo
9533 % @float ,lbl & Caption{Cap}: 1.1: Cap
9534 % @float ,lbl & no caption: 1.1
9535 % @float & @caption{Cap}: Cap
9536 % @float & no caption:
9538 \def\Efloat{%
9539 \let\floatident = \empty
9541 % In all cases, if we have a float type, it comes first.
9542 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
9544 % If we have an xref label, the number comes next.
9545 \ifx\floatlabel\empty \else
9546 \ifx\floattype\empty \else % if also had float type, need tie first.
9547 \appendtomacro\floatident{\tie}%
9549 % the number.
9550 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
9553 % Start the printed caption with what we've constructed in
9554 % \floatident, but keep it separate; we need \floatident again.
9555 \let\captionline = \floatident
9557 \ifx\thiscaption\empty \else
9558 \ifx\floatident\empty \else
9559 \appendtomacro\captionline{: }% had ident, so need a colon between
9562 % caption text.
9563 \appendtomacro\captionline{\scanexp\thiscaption}%
9566 % If we have anything to print, print it, with space before.
9567 % Eventually this needs to become an \insert.
9568 \ifx\captionline\empty \else
9569 \vskip.5\parskip
9570 \captionline
9572 % Space below caption.
9573 \vskip\parskip
9576 % If have an xref label, write the list of floats info. Do this
9577 % after the caption, to avoid chance of it being a breakpoint.
9578 \ifx\floatlabel\empty \else
9579 % Write the text that goes in the lof to the aux file as
9580 % \floatlabel-lof. Besides \floatident, we include the short
9581 % caption if specified, else the full caption if specified, else nothing.
9583 \requireauxfile
9584 \atdummies
9586 \ifx\thisshortcaption\empty
9587 \def\gtemp{\thiscaption}%
9588 \else
9589 \def\gtemp{\thisshortcaption}%
9591 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
9592 \ifx\gtemp\empty \else : \gtemp \fi}}%
9595 \egroup % end of \vtop
9597 \checkinserts
9600 % Append the tokens #2 to the definition of macro #1, not expanding either.
9602 \def\appendtomacro#1#2{%
9603 \expandafter\def\expandafter#1\expandafter{#1#2}%
9606 % @caption, @shortcaption
9608 \def\caption{\docaption\thiscaption}
9609 \def\shortcaption{\docaption\thisshortcaption}
9610 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
9611 \def\defcaption#1#2{\egroup \def#1{#2}}
9613 % The parameter is the control sequence identifying the counter we are
9614 % going to use. Create it if it doesn't exist and assign it to \floatno.
9615 \def\getfloatno#1{%
9616 \ifx#1\relax
9617 % Haven't seen this figure type before.
9618 \csname newcount\endcsname #1%
9620 % Remember to reset this floatno at the next chap.
9621 \expandafter\gdef\expandafter\resetallfloatnos
9622 \expandafter{\resetallfloatnos #1=0 }%
9624 \let\floatno#1%
9627 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
9628 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
9629 % first read the @float command.
9631 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
9633 % Magic string used for the XREFLABEL-title value, so \xrefX can
9634 % distinguish floats from other xref types.
9635 \def\floatmagic{!!float!!}
9637 % #1 is the control sequence we are passed; we expand into a conditional
9638 % which is true if #1 represents a float ref. That is, the magic
9639 % \currentsection value which we \setref above.
9641 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
9643 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
9644 % (safe) float type for this float. We set \iffloattype to #2.
9646 \def\doiffloat#1=#2=#3\finish{%
9647 \def\temp{#1}%
9648 \def\iffloattype{#2}%
9649 \ifx\temp\floatmagic
9652 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
9654 \parseargdef\listoffloats{%
9655 \def\floattype{#1}% floattype
9657 % the floattype might have accents or other special characters,
9658 % but we need to use it in a control sequence name.
9659 \indexnofonts
9660 \turnoffactive
9661 \xdef\safefloattype{\floattype}%
9664 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
9665 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
9666 \ifhavexrefs
9667 % if the user said @listoffloats foo but never @float foo.
9668 \message{\linenumber No `\safefloattype' floats to list.}%
9670 \else
9671 \begingroup
9672 \leftskip=\tocindent % indent these entries like a toc
9673 \let\do=\listoffloatsdo
9674 \csname floatlist\safefloattype\endcsname
9675 \endgroup
9679 % This is called on each entry in a list of floats. We're passed the
9680 % xref label, in the form LABEL-title, which is how we save it in the
9681 % aux file. We strip off the -title and look up \XRLABEL-lof, which
9682 % has the text we're supposed to typeset here.
9684 % Figures without xref labels will not be included in the list (since
9685 % they won't appear in the aux file).
9687 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
9688 \def\listoffloatsdoentry#1-title\finish{{%
9689 % Can't fully expand XR#1-lof because it can contain anything. Just
9690 % pass the control sequence. On the other hand, XR#1-pg is just the
9691 % page number, and we want to fully expand that so we can get a link
9692 % in pdf output.
9693 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
9695 % use the same \entry macro we use to generate the TOC and index.
9696 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
9697 \writeentry
9701 \message{localization,}
9703 % For single-language documents, @documentlanguage is usually given very
9704 % early, just after @documentencoding. Single argument is the language
9705 % (de) or locale (de_DE) abbreviation.
9708 \catcode`\_ = \active
9709 \globaldefs=1
9710 \parseargdef\documentlanguage{%
9711 \tex % read txi-??.tex file in plain TeX.
9712 % Read the file by the name they passed if it exists.
9713 \let_ = \normalunderscore % normal _ character for filename test
9714 \openin 1 txi-#1.tex
9715 \ifeof 1
9716 \documentlanguagetrywithoutunderscore #1_\finish
9717 \else
9718 \globaldefs = 1 % everything in the txi-LL files needs to persist
9719 \input txi-#1.tex
9721 \closein 1
9722 \endgroup % end raw TeX
9725 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
9726 % try txi-de.tex.
9728 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
9729 \openin 1 txi-#1.tex
9730 \ifeof 1
9731 \errhelp = \nolanghelp
9732 \errmessage{Cannot read language file txi-#1.tex}%
9733 \else
9734 \globaldefs = 1 % everything in the txi-LL files needs to persist
9735 \input txi-#1.tex
9737 \closein 1
9739 }% end of special _ catcode
9741 \newhelp\nolanghelp{The given language definition file cannot be found or
9742 is empty. Maybe you need to install it? Putting it in the current
9743 directory should work if nowhere else does.}
9745 % This macro is called from txi-??.tex files; the first argument is the
9746 % \language name to set (without the "\lang@" prefix), the second and
9747 % third args are \{left,right}hyphenmin.
9749 % The language names to pass are determined when the format is built.
9750 % See the etex.log file created at that time, e.g.,
9751 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
9753 % With TeX Live 2008, etex now includes hyphenation patterns for all
9754 % available languages. This means we can support hyphenation in
9755 % Texinfo, at least to some extent. (This still doesn't solve the
9756 % accented characters problem.)
9758 \catcode`@=11
9759 \def\txisetlanguage#1#2#3{%
9760 % do not set the language if the name is undefined in the current TeX.
9761 \expandafter\ifx\csname lang@#1\endcsname \relax
9762 \message{no patterns for #1}%
9763 \else
9764 \global\language = \csname lang@#1\endcsname
9766 % but there is no harm in adjusting the hyphenmin values regardless.
9767 \global\lefthyphenmin = #2\relax
9768 \global\righthyphenmin = #3\relax
9771 % XeTeX and LuaTeX can handle Unicode natively.
9772 % Their default I/O uses UTF-8 sequences instead of a byte-wise operation.
9773 % Other TeX engines' I/O (pdfTeX, etc.) is byte-wise.
9775 \newif\iftxinativeunicodecapable
9776 \newif\iftxiusebytewiseio
9778 \ifx\XeTeXrevision\thisisundefined
9779 \ifx\luatexversion\thisisundefined
9780 \txinativeunicodecapablefalse
9781 \txiusebytewiseiotrue
9782 \else
9783 \txinativeunicodecapabletrue
9784 \txiusebytewiseiofalse
9786 \else
9787 \txinativeunicodecapabletrue
9788 \txiusebytewiseiofalse
9791 % Set I/O by bytes instead of UTF-8 sequence for XeTeX and LuaTex
9792 % for non-UTF-8 (byte-wise) encodings.
9794 \def\setbytewiseio{%
9795 \ifx\XeTeXrevision\thisisundefined
9796 \else
9797 \XeTeXdefaultencoding "bytes" % For subsequent files to be read
9798 \XeTeXinputencoding "bytes" % For document root file
9799 % Unfortunately, there seems to be no corresponding XeTeX command for
9800 % output encoding. This is a problem for auxiliary index and TOC files.
9801 % The only solution would be perhaps to write out @U{...} sequences in
9802 % place of non-ASCII characters.
9805 \ifx\luatexversion\thisisundefined
9806 \else
9807 \directlua{
9808 local utf8_char, byte, gsub = unicode.utf8.char, string.byte, string.gsub
9809 local function convert_char (char)
9810 return utf8_char(byte(char))
9813 local function convert_line (line)
9814 return gsub(line, ".", convert_char)
9817 callback.register("process_input_buffer", convert_line)
9819 local function convert_line_out (line)
9820 local line_out = ""
9821 for c in string.utfvalues(line) do
9822 line_out = line_out .. string.char(c)
9824 return line_out
9827 callback.register("process_output_buffer", convert_line_out)
9831 \txiusebytewiseiotrue
9835 % Helpers for encodings.
9836 % Set the catcode of characters 128 through 255 to the specified number.
9838 \def\setnonasciicharscatcode#1{%
9839 \count255=128
9840 \loop\ifnum\count255<256
9841 \global\catcode\count255=#1\relax
9842 \advance\count255 by 1
9843 \repeat
9846 \def\setnonasciicharscatcodenonglobal#1{%
9847 \count255=128
9848 \loop\ifnum\count255<256
9849 \catcode\count255=#1\relax
9850 \advance\count255 by 1
9851 \repeat
9854 % @documentencoding sets the definition of non-ASCII characters
9855 % according to the specified encoding.
9857 \def\documentencoding{\parseargusing\filenamecatcodes\documentencodingzzz}
9858 \def\documentencodingzzz#1{%
9860 % Encoding being declared for the document.
9861 \def\declaredencoding{\csname #1.enc\endcsname}%
9863 % Supported encodings: names converted to tokens in order to be able
9864 % to compare them with \ifx.
9865 \def\ascii{\csname US-ASCII.enc\endcsname}%
9866 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
9867 \def\latone{\csname ISO-8859-1.enc\endcsname}%
9868 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
9869 \def\utfeight{\csname UTF-8.enc\endcsname}%
9871 \ifx \declaredencoding \ascii
9872 \asciichardefs
9874 \else \ifx \declaredencoding \lattwo
9875 \iftxinativeunicodecapable
9876 \setbytewiseio
9878 \setnonasciicharscatcode\active
9879 \lattwochardefs
9881 \else \ifx \declaredencoding \latone
9882 \iftxinativeunicodecapable
9883 \setbytewiseio
9885 \setnonasciicharscatcode\active
9886 \latonechardefs
9888 \else \ifx \declaredencoding \latnine
9889 \iftxinativeunicodecapable
9890 \setbytewiseio
9892 \setnonasciicharscatcode\active
9893 \latninechardefs
9895 \else \ifx \declaredencoding \utfeight
9896 \iftxinativeunicodecapable
9897 % For native Unicode handling (XeTeX and LuaTeX)
9898 \nativeunicodechardefs
9899 \else
9900 % For treating UTF-8 as byte sequences (TeX, eTeX and pdfTeX)
9901 \setnonasciicharscatcode\active
9902 % since we already invoked \utfeightchardefs at the top level
9903 % (below), do not re-invoke it, otherwise our check for duplicated
9904 % definitions gets triggered. Making non-ascii chars active is
9905 % sufficient.
9908 \else
9909 \message{Ignoring unknown document encoding: #1.}%
9911 \fi % utfeight
9912 \fi % latnine
9913 \fi % latone
9914 \fi % lattwo
9915 \fi % ascii
9917 \ifx\XeTeXrevision\thisisundefined
9918 \else
9919 \ifx \declaredencoding \utfeight
9920 \else
9921 \ifx \declaredencoding \ascii
9922 \else
9923 \message{Warning: XeTeX with non-UTF-8 encodings cannot handle %
9924 non-ASCII characters in auxiliary files.}%
9930 % emacs-page
9931 % A message to be logged when using a character that isn't available
9932 % the default font encoding (OT1).
9934 \def\missingcharmsg#1{\message{Character missing, sorry: #1.}}
9936 % Take account of \c (plain) vs. \, (Texinfo) difference.
9937 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
9939 % First, make active non-ASCII characters in order for them to be
9940 % correctly categorized when TeX reads the replacement text of
9941 % macros containing the character definitions.
9942 \setnonasciicharscatcode\active
9945 \def\gdefchar#1#2{%
9946 \gdef#1{%
9947 \ifpassthroughchars
9948 \string#1%
9949 \else
9954 % Latin1 (ISO-8859-1) character definitions.
9955 \def\latonechardefs{%
9956 \gdefchar^^a0{\tie}
9957 \gdefchar^^a1{\exclamdown}
9958 \gdefchar^^a2{{\tcfont \char162}} % cent
9959 \gdefchar^^a3{\pounds{}}
9960 \gdefchar^^a4{{\tcfont \char164}} % currency
9961 \gdefchar^^a5{{\tcfont \char165}} % yen
9962 \gdefchar^^a6{{\tcfont \char166}} % broken bar
9963 \gdefchar^^a7{\S}
9964 \gdefchar^^a8{\"{}}
9965 \gdefchar^^a9{\copyright{}}
9966 \gdefchar^^aa{\ordf}
9967 \gdefchar^^ab{\guillemetleft{}}
9968 \gdefchar^^ac{\ensuremath\lnot}
9969 \gdefchar^^ad{\-}
9970 \gdefchar^^ae{\registeredsymbol{}}
9971 \gdefchar^^af{\={}}
9973 \gdefchar^^b0{\textdegree}
9974 \gdefchar^^b1{$\pm$}
9975 \gdefchar^^b2{$^2$}
9976 \gdefchar^^b3{$^3$}
9977 \gdefchar^^b4{\'{}}
9978 \gdefchar^^b5{$\mu$}
9979 \gdefchar^^b6{\P}
9980 \gdefchar^^b7{\ensuremath\cdot}
9981 \gdefchar^^b8{\cedilla\ }
9982 \gdefchar^^b9{$^1$}
9983 \gdefchar^^ba{\ordm}
9984 \gdefchar^^bb{\guillemetright{}}
9985 \gdefchar^^bc{$1\over4$}
9986 \gdefchar^^bd{$1\over2$}
9987 \gdefchar^^be{$3\over4$}
9988 \gdefchar^^bf{\questiondown}
9990 \gdefchar^^c0{\`A}
9991 \gdefchar^^c1{\'A}
9992 \gdefchar^^c2{\^A}
9993 \gdefchar^^c3{\~A}
9994 \gdefchar^^c4{\"A}
9995 \gdefchar^^c5{\ringaccent A}
9996 \gdefchar^^c6{\AE}
9997 \gdefchar^^c7{\cedilla C}
9998 \gdefchar^^c8{\`E}
9999 \gdefchar^^c9{\'E}
10000 \gdefchar^^ca{\^E}
10001 \gdefchar^^cb{\"E}
10002 \gdefchar^^cc{\`I}
10003 \gdefchar^^cd{\'I}
10004 \gdefchar^^ce{\^I}
10005 \gdefchar^^cf{\"I}
10007 \gdefchar^^d0{\DH}
10008 \gdefchar^^d1{\~N}
10009 \gdefchar^^d2{\`O}
10010 \gdefchar^^d3{\'O}
10011 \gdefchar^^d4{\^O}
10012 \gdefchar^^d5{\~O}
10013 \gdefchar^^d6{\"O}
10014 \gdefchar^^d7{$\times$}
10015 \gdefchar^^d8{\O}
10016 \gdefchar^^d9{\`U}
10017 \gdefchar^^da{\'U}
10018 \gdefchar^^db{\^U}
10019 \gdefchar^^dc{\"U}
10020 \gdefchar^^dd{\'Y}
10021 \gdefchar^^de{\TH}
10022 \gdefchar^^df{\ss}
10024 \gdefchar^^e0{\`a}
10025 \gdefchar^^e1{\'a}
10026 \gdefchar^^e2{\^a}
10027 \gdefchar^^e3{\~a}
10028 \gdefchar^^e4{\"a}
10029 \gdefchar^^e5{\ringaccent a}
10030 \gdefchar^^e6{\ae}
10031 \gdefchar^^e7{\cedilla c}
10032 \gdefchar^^e8{\`e}
10033 \gdefchar^^e9{\'e}
10034 \gdefchar^^ea{\^e}
10035 \gdefchar^^eb{\"e}
10036 \gdefchar^^ec{\`{\dotless i}}
10037 \gdefchar^^ed{\'{\dotless i}}
10038 \gdefchar^^ee{\^{\dotless i}}
10039 \gdefchar^^ef{\"{\dotless i}}
10041 \gdefchar^^f0{\dh}
10042 \gdefchar^^f1{\~n}
10043 \gdefchar^^f2{\`o}
10044 \gdefchar^^f3{\'o}
10045 \gdefchar^^f4{\^o}
10046 \gdefchar^^f5{\~o}
10047 \gdefchar^^f6{\"o}
10048 \gdefchar^^f7{$\div$}
10049 \gdefchar^^f8{\o}
10050 \gdefchar^^f9{\`u}
10051 \gdefchar^^fa{\'u}
10052 \gdefchar^^fb{\^u}
10053 \gdefchar^^fc{\"u}
10054 \gdefchar^^fd{\'y}
10055 \gdefchar^^fe{\th}
10056 \gdefchar^^ff{\"y}
10059 % Latin9 (ISO-8859-15) encoding character definitions.
10060 \def\latninechardefs{%
10061 % Encoding is almost identical to Latin1.
10062 \latonechardefs
10064 \gdefchar^^a4{\euro{}}
10065 \gdefchar^^a6{\v S}
10066 \gdefchar^^a8{\v s}
10067 \gdefchar^^b4{\v Z}
10068 \gdefchar^^b8{\v z}
10069 \gdefchar^^bc{\OE}
10070 \gdefchar^^bd{\oe}
10071 \gdefchar^^be{\"Y}
10074 % Latin2 (ISO-8859-2) character definitions.
10075 \def\lattwochardefs{%
10076 \gdefchar^^a0{\tie}
10077 \gdefchar^^a1{\ogonek{A}}
10078 \gdefchar^^a2{\u{}}
10079 \gdefchar^^a3{\L}
10080 \gdefchar^^a4{\missingcharmsg{CURRENCY SIGN}}
10081 \gdefchar^^a5{\v L}
10082 \gdefchar^^a6{\'S}
10083 \gdefchar^^a7{\S}
10084 \gdefchar^^a8{\"{}}
10085 \gdefchar^^a9{\v S}
10086 \gdefchar^^aa{\cedilla S}
10087 \gdefchar^^ab{\v T}
10088 \gdefchar^^ac{\'Z}
10089 \gdefchar^^ad{\-}
10090 \gdefchar^^ae{\v Z}
10091 \gdefchar^^af{\dotaccent Z}
10093 \gdefchar^^b0{\textdegree{}}
10094 \gdefchar^^b1{\ogonek{a}}
10095 \gdefchar^^b2{\ogonek{ }}
10096 \gdefchar^^b3{\l}
10097 \gdefchar^^b4{\'{}}
10098 \gdefchar^^b5{\v l}
10099 \gdefchar^^b6{\'s}
10100 \gdefchar^^b7{\v{}}
10101 \gdefchar^^b8{\cedilla\ }
10102 \gdefchar^^b9{\v s}
10103 \gdefchar^^ba{\cedilla s}
10104 \gdefchar^^bb{\v t}
10105 \gdefchar^^bc{\'z}
10106 \gdefchar^^bd{\H{}}
10107 \gdefchar^^be{\v z}
10108 \gdefchar^^bf{\dotaccent z}
10110 \gdefchar^^c0{\'R}
10111 \gdefchar^^c1{\'A}
10112 \gdefchar^^c2{\^A}
10113 \gdefchar^^c3{\u A}
10114 \gdefchar^^c4{\"A}
10115 \gdefchar^^c5{\'L}
10116 \gdefchar^^c6{\'C}
10117 \gdefchar^^c7{\cedilla C}
10118 \gdefchar^^c8{\v C}
10119 \gdefchar^^c9{\'E}
10120 \gdefchar^^ca{\ogonek{E}}
10121 \gdefchar^^cb{\"E}
10122 \gdefchar^^cc{\v E}
10123 \gdefchar^^cd{\'I}
10124 \gdefchar^^ce{\^I}
10125 \gdefchar^^cf{\v D}
10127 \gdefchar^^d0{\DH}
10128 \gdefchar^^d1{\'N}
10129 \gdefchar^^d2{\v N}
10130 \gdefchar^^d3{\'O}
10131 \gdefchar^^d4{\^O}
10132 \gdefchar^^d5{\H O}
10133 \gdefchar^^d6{\"O}
10134 \gdefchar^^d7{$\times$}
10135 \gdefchar^^d8{\v R}
10136 \gdefchar^^d9{\ringaccent U}
10137 \gdefchar^^da{\'U}
10138 \gdefchar^^db{\H U}
10139 \gdefchar^^dc{\"U}
10140 \gdefchar^^dd{\'Y}
10141 \gdefchar^^de{\cedilla T}
10142 \gdefchar^^df{\ss}
10144 \gdefchar^^e0{\'r}
10145 \gdefchar^^e1{\'a}
10146 \gdefchar^^e2{\^a}
10147 \gdefchar^^e3{\u a}
10148 \gdefchar^^e4{\"a}
10149 \gdefchar^^e5{\'l}
10150 \gdefchar^^e6{\'c}
10151 \gdefchar^^e7{\cedilla c}
10152 \gdefchar^^e8{\v c}
10153 \gdefchar^^e9{\'e}
10154 \gdefchar^^ea{\ogonek{e}}
10155 \gdefchar^^eb{\"e}
10156 \gdefchar^^ec{\v e}
10157 \gdefchar^^ed{\'{\dotless{i}}}
10158 \gdefchar^^ee{\^{\dotless{i}}}
10159 \gdefchar^^ef{\v d}
10161 \gdefchar^^f0{\dh}
10162 \gdefchar^^f1{\'n}
10163 \gdefchar^^f2{\v n}
10164 \gdefchar^^f3{\'o}
10165 \gdefchar^^f4{\^o}
10166 \gdefchar^^f5{\H o}
10167 \gdefchar^^f6{\"o}
10168 \gdefchar^^f7{$\div$}
10169 \gdefchar^^f8{\v r}
10170 \gdefchar^^f9{\ringaccent u}
10171 \gdefchar^^fa{\'u}
10172 \gdefchar^^fb{\H u}
10173 \gdefchar^^fc{\"u}
10174 \gdefchar^^fd{\'y}
10175 \gdefchar^^fe{\cedilla t}
10176 \gdefchar^^ff{\dotaccent{}}
10179 % UTF-8 character definitions.
10181 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
10182 % changes for Texinfo conventions. It is included here under the GPL by
10183 % permission from Frank Mittelbach and the LaTeX team.
10185 \newcount\countUTFx
10186 \newcount\countUTFy
10187 \newcount\countUTFz
10189 \gdef\UTFviiiTwoOctets#1#2{\expandafter
10190 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
10192 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
10193 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
10195 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
10196 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
10198 \gdef\UTFviiiDefined#1{%
10199 \ifx #1\relax
10200 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
10201 \else
10202 \expandafter #1%
10206 % Give non-ASCII bytes the active definitions for processing UTF-8 sequences
10207 \begingroup
10208 \catcode`\~13
10209 \catcode`\$12
10210 \catcode`\"12
10212 % Loop from \countUTFx to \countUTFy, performing \UTFviiiTmp
10213 % substituting ~ and $ with a character token of that value.
10214 \def\UTFviiiLoop{%
10215 \global\catcode\countUTFx\active
10216 \uccode`\~\countUTFx
10217 \uccode`\$\countUTFx
10218 \uppercase\expandafter{\UTFviiiTmp}%
10219 \advance\countUTFx by 1
10220 \ifnum\countUTFx < \countUTFy
10221 \expandafter\UTFviiiLoop
10222 \fi}
10224 % For bytes other than the first in a UTF-8 sequence. Not expected to
10225 % be expanded except when writing to auxiliary files.
10226 \countUTFx = "80
10227 \countUTFy = "C2
10228 \def\UTFviiiTmp{%
10229 \gdef~{%
10230 \ifpassthroughchars $\fi}}%
10231 \UTFviiiLoop
10233 \countUTFx = "C2
10234 \countUTFy = "E0
10235 \def\UTFviiiTmp{%
10236 \gdef~{%
10237 \ifpassthroughchars $%
10238 \else\expandafter\UTFviiiTwoOctets\expandafter$\fi}}%
10239 \UTFviiiLoop
10241 \countUTFx = "E0
10242 \countUTFy = "F0
10243 \def\UTFviiiTmp{%
10244 \gdef~{%
10245 \ifpassthroughchars $%
10246 \else\expandafter\UTFviiiThreeOctets\expandafter$\fi}}%
10247 \UTFviiiLoop
10249 \countUTFx = "F0
10250 \countUTFy = "F4
10251 \def\UTFviiiTmp{%
10252 \gdef~{%
10253 \ifpassthroughchars $%
10254 \else\expandafter\UTFviiiFourOctets\expandafter$\fi
10256 \UTFviiiLoop
10257 \endgroup
10259 \def\globallet{\global\let} % save some \expandafter's below
10261 % @U{xxxx} to produce U+xxxx, if we support it.
10262 \def\U#1{%
10263 \expandafter\ifx\csname uni:#1\endcsname \relax
10264 \iftxinativeunicodecapable
10265 % All Unicode characters can be used if native Unicode handling is
10266 % active. However, if the font does not have the glyph,
10267 % letters are missing.
10268 \begingroup
10269 \uccode`\.="#1\relax
10270 \uppercase{.}
10271 \endgroup
10272 \else
10273 \errhelp = \EMsimple
10274 \errmessage{Unicode character U+#1 not supported, sorry}%
10276 \else
10277 \csname uni:#1\endcsname
10281 % These macros are used here to construct the name of a control
10282 % sequence to be defined.
10283 \def\UTFviiiTwoOctetsName#1#2{%
10284 \csname u8:#1\string #2\endcsname}%
10285 \def\UTFviiiThreeOctetsName#1#2#3{%
10286 \csname u8:#1\string #2\string #3\endcsname}%
10287 \def\UTFviiiFourOctetsName#1#2#3#4{%
10288 \csname u8:#1\string #2\string #3\string #4\endcsname}%
10290 % For UTF-8 byte sequences (TeX, e-TeX and pdfTeX),
10291 % provide a definition macro to replace a Unicode character;
10292 % this gets used by the @U command
10294 \begingroup
10295 \catcode`\"=12
10296 \catcode`\<=12
10297 \catcode`\.=12
10298 \catcode`\,=12
10299 \catcode`\;=12
10300 \catcode`\!=12
10301 \catcode`\~=13
10302 \gdef\DeclareUnicodeCharacterUTFviii#1#2{%
10303 \countUTFz = "#1\relax
10304 \begingroup
10305 \parseXMLCharref
10307 % Give \u8:... its definition. The sequence of seven \expandafter's
10308 % expands after the \gdef three times, e.g.
10310 % 1. \UTFviiTwoOctetsName B1 B2
10311 % 2. \csname u8:B1 \string B2 \endcsname
10312 % 3. \u8: B1 B2 (a single control sequence token)
10314 \expandafter\expandafter
10315 \expandafter\expandafter
10316 \expandafter\expandafter
10317 \expandafter\gdef \UTFviiiTmp{#2}%
10319 \expandafter\ifx\csname uni:#1\endcsname \relax \else
10320 \message{Internal error, already defined: #1}%
10323 % define an additional control sequence for this code point.
10324 \expandafter\globallet\csname uni:#1\endcsname \UTFviiiTmp
10325 \endgroup}
10327 % Given the value in \countUTFz as a Unicode code point, set \UTFviiiTmp
10328 % to the corresponding UTF-8 sequence.
10329 \gdef\parseXMLCharref{%
10330 \ifnum\countUTFz < "A0\relax
10331 \errhelp = \EMsimple
10332 \errmessage{Cannot define Unicode char value < 00A0}%
10333 \else\ifnum\countUTFz < "800\relax
10334 \parseUTFviiiA,%
10335 \parseUTFviiiB C\UTFviiiTwoOctetsName.,%
10336 \else\ifnum\countUTFz < "10000\relax
10337 \parseUTFviiiA;%
10338 \parseUTFviiiA,%
10339 \parseUTFviiiB E\UTFviiiThreeOctetsName.{,;}%
10340 \else
10341 \parseUTFviiiA;%
10342 \parseUTFviiiA,%
10343 \parseUTFviiiA!%
10344 \parseUTFviiiB F\UTFviiiFourOctetsName.{!,;}%
10345 \fi\fi\fi
10348 % Extract a byte from the end of the UTF-8 representation of \countUTFx.
10349 % It must be a non-initial byte in the sequence.
10350 % Change \uccode of #1 for it to be used in \parseUTFviiiB as one
10351 % of the bytes.
10352 \gdef\parseUTFviiiA#1{%
10353 \countUTFx = \countUTFz
10354 \divide\countUTFz by 64
10355 \countUTFy = \countUTFz % Save to be the future value of \countUTFz.
10356 \multiply\countUTFz by 64
10358 % \countUTFz is now \countUTFx with the last 5 bits cleared. Subtract
10359 % in order to get the last five bits.
10360 \advance\countUTFx by -\countUTFz
10362 % Convert this to the byte in the UTF-8 sequence.
10363 \advance\countUTFx by 128
10364 \uccode `#1\countUTFx
10365 \countUTFz = \countUTFy}
10367 % Used to put a UTF-8 byte sequence into \UTFviiiTmp
10368 % #1 is the increment for \countUTFz to yield a the first byte of the UTF-8
10369 % sequence.
10370 % #2 is one of the \UTFviii*OctetsName macros.
10371 % #3 is always a full stop (.)
10372 % #4 is a template for the other bytes in the sequence. The values for these
10373 % bytes is substituted in here with \uppercase using the \uccode's.
10374 \gdef\parseUTFviiiB#1#2#3#4{%
10375 \advance\countUTFz by "#10\relax
10376 \uccode `#3\countUTFz
10377 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
10378 \endgroup
10380 % For native Unicode handling (XeTeX and LuaTeX),
10381 % provide a definition macro that sets a catcode to `other' non-globally
10383 \def\DeclareUnicodeCharacterNativeOther#1#2{%
10384 \catcode"#1=\other
10387 % https://en.wikipedia.org/wiki/Plane_(Unicode)#Basic_M
10388 % U+0000..U+007F = https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)
10389 % U+0080..U+00FF = https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)
10390 % U+0100..U+017F = https://en.wikipedia.org/wiki/Latin_Extended-A
10391 % U+0180..U+024F = https://en.wikipedia.org/wiki/Latin_Extended-B
10393 % Many of our renditions are less than wonderful, and all the missing
10394 % characters are available somewhere. Loading the necessary fonts
10395 % awaits user request. We can't truly support Unicode without
10396 % reimplementing everything that's been done in LaTeX for many years,
10397 % plus probably using luatex or xetex, and who knows what else.
10398 % We won't be doing that here in this simple file. But we can try to at
10399 % least make most of the characters not bomb out.
10401 \def\unicodechardefs{%
10402 \DeclareUnicodeCharacter{00A0}{\tie}%
10403 \DeclareUnicodeCharacter{00A1}{\exclamdown}%
10404 \DeclareUnicodeCharacter{00A2}{{\tcfont \char162}}% 0242=cent
10405 \DeclareUnicodeCharacter{00A3}{\pounds{}}%
10406 \DeclareUnicodeCharacter{00A4}{{\tcfont \char164}}% 0244=currency
10407 \DeclareUnicodeCharacter{00A5}{{\tcfont \char165}}% 0245=yen
10408 \DeclareUnicodeCharacter{00A6}{{\tcfont \char166}}% 0246=brokenbar
10409 \DeclareUnicodeCharacter{00A7}{\S}%
10410 \DeclareUnicodeCharacter{00A8}{\"{ }}%
10411 \DeclareUnicodeCharacter{00A9}{\copyright{}}%
10412 \DeclareUnicodeCharacter{00AA}{\ordf}%
10413 \DeclareUnicodeCharacter{00AB}{\guillemetleft{}}%
10414 \DeclareUnicodeCharacter{00AC}{\ensuremath\lnot}%
10415 \DeclareUnicodeCharacter{00AD}{\-}%
10416 \DeclareUnicodeCharacter{00AE}{\registeredsymbol{}}%
10417 \DeclareUnicodeCharacter{00AF}{\={ }}%
10419 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}%
10420 \DeclareUnicodeCharacter{00B1}{\ensuremath\pm}%
10421 \DeclareUnicodeCharacter{00B2}{$^2$}%
10422 \DeclareUnicodeCharacter{00B3}{$^3$}%
10423 \DeclareUnicodeCharacter{00B4}{\'{ }}%
10424 \DeclareUnicodeCharacter{00B5}{$\mu$}%
10425 \DeclareUnicodeCharacter{00B6}{\P}%
10426 \DeclareUnicodeCharacter{00B7}{\ensuremath\cdot}%
10427 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}%
10428 \DeclareUnicodeCharacter{00B9}{$^1$}%
10429 \DeclareUnicodeCharacter{00BA}{\ordm}%
10430 \DeclareUnicodeCharacter{00BB}{\guillemetright{}}%
10431 \DeclareUnicodeCharacter{00BC}{$1\over4$}%
10432 \DeclareUnicodeCharacter{00BD}{$1\over2$}%
10433 \DeclareUnicodeCharacter{00BE}{$3\over4$}%
10434 \DeclareUnicodeCharacter{00BF}{\questiondown}%
10436 \DeclareUnicodeCharacter{00C0}{\`A}%
10437 \DeclareUnicodeCharacter{00C1}{\'A}%
10438 \DeclareUnicodeCharacter{00C2}{\^A}%
10439 \DeclareUnicodeCharacter{00C3}{\~A}%
10440 \DeclareUnicodeCharacter{00C4}{\"A}%
10441 \DeclareUnicodeCharacter{00C5}{\AA}%
10442 \DeclareUnicodeCharacter{00C6}{\AE}%
10443 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}%
10444 \DeclareUnicodeCharacter{00C8}{\`E}%
10445 \DeclareUnicodeCharacter{00C9}{\'E}%
10446 \DeclareUnicodeCharacter{00CA}{\^E}%
10447 \DeclareUnicodeCharacter{00CB}{\"E}%
10448 \DeclareUnicodeCharacter{00CC}{\`I}%
10449 \DeclareUnicodeCharacter{00CD}{\'I}%
10450 \DeclareUnicodeCharacter{00CE}{\^I}%
10451 \DeclareUnicodeCharacter{00CF}{\"I}%
10453 \DeclareUnicodeCharacter{00D0}{\DH}%
10454 \DeclareUnicodeCharacter{00D1}{\~N}%
10455 \DeclareUnicodeCharacter{00D2}{\`O}%
10456 \DeclareUnicodeCharacter{00D3}{\'O}%
10457 \DeclareUnicodeCharacter{00D4}{\^O}%
10458 \DeclareUnicodeCharacter{00D5}{\~O}%
10459 \DeclareUnicodeCharacter{00D6}{\"O}%
10460 \DeclareUnicodeCharacter{00D7}{\ensuremath\times}%
10461 \DeclareUnicodeCharacter{00D8}{\O}%
10462 \DeclareUnicodeCharacter{00D9}{\`U}%
10463 \DeclareUnicodeCharacter{00DA}{\'U}%
10464 \DeclareUnicodeCharacter{00DB}{\^U}%
10465 \DeclareUnicodeCharacter{00DC}{\"U}%
10466 \DeclareUnicodeCharacter{00DD}{\'Y}%
10467 \DeclareUnicodeCharacter{00DE}{\TH}%
10468 \DeclareUnicodeCharacter{00DF}{\ss}%
10470 \DeclareUnicodeCharacter{00E0}{\`a}%
10471 \DeclareUnicodeCharacter{00E1}{\'a}%
10472 \DeclareUnicodeCharacter{00E2}{\^a}%
10473 \DeclareUnicodeCharacter{00E3}{\~a}%
10474 \DeclareUnicodeCharacter{00E4}{\"a}%
10475 \DeclareUnicodeCharacter{00E5}{\aa}%
10476 \DeclareUnicodeCharacter{00E6}{\ae}%
10477 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}%
10478 \DeclareUnicodeCharacter{00E8}{\`e}%
10479 \DeclareUnicodeCharacter{00E9}{\'e}%
10480 \DeclareUnicodeCharacter{00EA}{\^e}%
10481 \DeclareUnicodeCharacter{00EB}{\"e}%
10482 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}%
10483 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}%
10484 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}%
10485 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}%
10487 \DeclareUnicodeCharacter{00F0}{\dh}%
10488 \DeclareUnicodeCharacter{00F1}{\~n}%
10489 \DeclareUnicodeCharacter{00F2}{\`o}%
10490 \DeclareUnicodeCharacter{00F3}{\'o}%
10491 \DeclareUnicodeCharacter{00F4}{\^o}%
10492 \DeclareUnicodeCharacter{00F5}{\~o}%
10493 \DeclareUnicodeCharacter{00F6}{\"o}%
10494 \DeclareUnicodeCharacter{00F7}{\ensuremath\div}%
10495 \DeclareUnicodeCharacter{00F8}{\o}%
10496 \DeclareUnicodeCharacter{00F9}{\`u}%
10497 \DeclareUnicodeCharacter{00FA}{\'u}%
10498 \DeclareUnicodeCharacter{00FB}{\^u}%
10499 \DeclareUnicodeCharacter{00FC}{\"u}%
10500 \DeclareUnicodeCharacter{00FD}{\'y}%
10501 \DeclareUnicodeCharacter{00FE}{\th}%
10502 \DeclareUnicodeCharacter{00FF}{\"y}%
10504 \DeclareUnicodeCharacter{0100}{\=A}%
10505 \DeclareUnicodeCharacter{0101}{\=a}%
10506 \DeclareUnicodeCharacter{0102}{\u{A}}%
10507 \DeclareUnicodeCharacter{0103}{\u{a}}%
10508 \DeclareUnicodeCharacter{0104}{\ogonek{A}}%
10509 \DeclareUnicodeCharacter{0105}{\ogonek{a}}%
10510 \DeclareUnicodeCharacter{0106}{\'C}%
10511 \DeclareUnicodeCharacter{0107}{\'c}%
10512 \DeclareUnicodeCharacter{0108}{\^C}%
10513 \DeclareUnicodeCharacter{0109}{\^c}%
10514 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}%
10515 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}%
10516 \DeclareUnicodeCharacter{010C}{\v{C}}%
10517 \DeclareUnicodeCharacter{010D}{\v{c}}%
10518 \DeclareUnicodeCharacter{010E}{\v{D}}%
10519 \DeclareUnicodeCharacter{010F}{d'}%
10521 \DeclareUnicodeCharacter{0110}{\DH}%
10522 \DeclareUnicodeCharacter{0111}{\dh}%
10523 \DeclareUnicodeCharacter{0112}{\=E}%
10524 \DeclareUnicodeCharacter{0113}{\=e}%
10525 \DeclareUnicodeCharacter{0114}{\u{E}}%
10526 \DeclareUnicodeCharacter{0115}{\u{e}}%
10527 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}%
10528 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}%
10529 \DeclareUnicodeCharacter{0118}{\ogonek{E}}%
10530 \DeclareUnicodeCharacter{0119}{\ogonek{e}}%
10531 \DeclareUnicodeCharacter{011A}{\v{E}}%
10532 \DeclareUnicodeCharacter{011B}{\v{e}}%
10533 \DeclareUnicodeCharacter{011C}{\^G}%
10534 \DeclareUnicodeCharacter{011D}{\^g}%
10535 \DeclareUnicodeCharacter{011E}{\u{G}}%
10536 \DeclareUnicodeCharacter{011F}{\u{g}}%
10538 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}%
10539 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}%
10540 \DeclareUnicodeCharacter{0122}{\cedilla{G}}%
10541 \DeclareUnicodeCharacter{0123}{\cedilla{g}}%
10542 \DeclareUnicodeCharacter{0124}{\^H}%
10543 \DeclareUnicodeCharacter{0125}{\^h}%
10544 \DeclareUnicodeCharacter{0126}{\missingcharmsg{H WITH STROKE}}%
10545 \DeclareUnicodeCharacter{0127}{\missingcharmsg{h WITH STROKE}}%
10546 \DeclareUnicodeCharacter{0128}{\~I}%
10547 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}%
10548 \DeclareUnicodeCharacter{012A}{\=I}%
10549 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}%
10550 \DeclareUnicodeCharacter{012C}{\u{I}}%
10551 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}%
10552 \DeclareUnicodeCharacter{012E}{\ogonek{I}}%
10553 \DeclareUnicodeCharacter{012F}{\ogonek{i}}%
10555 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}%
10556 \DeclareUnicodeCharacter{0131}{\dotless{i}}%
10557 \DeclareUnicodeCharacter{0132}{IJ}%
10558 \DeclareUnicodeCharacter{0133}{ij}%
10559 \DeclareUnicodeCharacter{0134}{\^J}%
10560 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}%
10561 \DeclareUnicodeCharacter{0136}{\cedilla{K}}%
10562 \DeclareUnicodeCharacter{0137}{\cedilla{k}}%
10563 \DeclareUnicodeCharacter{0138}{\ensuremath\kappa}%
10564 \DeclareUnicodeCharacter{0139}{\'L}%
10565 \DeclareUnicodeCharacter{013A}{\'l}%
10566 \DeclareUnicodeCharacter{013B}{\cedilla{L}}%
10567 \DeclareUnicodeCharacter{013C}{\cedilla{l}}%
10568 \DeclareUnicodeCharacter{013D}{L'}% should kern
10569 \DeclareUnicodeCharacter{013E}{l'}% should kern
10570 \DeclareUnicodeCharacter{013F}{L\U{00B7}}%
10572 \DeclareUnicodeCharacter{0140}{l\U{00B7}}%
10573 \DeclareUnicodeCharacter{0141}{\L}%
10574 \DeclareUnicodeCharacter{0142}{\l}%
10575 \DeclareUnicodeCharacter{0143}{\'N}%
10576 \DeclareUnicodeCharacter{0144}{\'n}%
10577 \DeclareUnicodeCharacter{0145}{\cedilla{N}}%
10578 \DeclareUnicodeCharacter{0146}{\cedilla{n}}%
10579 \DeclareUnicodeCharacter{0147}{\v{N}}%
10580 \DeclareUnicodeCharacter{0148}{\v{n}}%
10581 \DeclareUnicodeCharacter{0149}{'n}%
10582 \DeclareUnicodeCharacter{014A}{\missingcharmsg{ENG}}%
10583 \DeclareUnicodeCharacter{014B}{\missingcharmsg{eng}}%
10584 \DeclareUnicodeCharacter{014C}{\=O}%
10585 \DeclareUnicodeCharacter{014D}{\=o}%
10586 \DeclareUnicodeCharacter{014E}{\u{O}}%
10587 \DeclareUnicodeCharacter{014F}{\u{o}}%
10589 \DeclareUnicodeCharacter{0150}{\H{O}}%
10590 \DeclareUnicodeCharacter{0151}{\H{o}}%
10591 \DeclareUnicodeCharacter{0152}{\OE}%
10592 \DeclareUnicodeCharacter{0153}{\oe}%
10593 \DeclareUnicodeCharacter{0154}{\'R}%
10594 \DeclareUnicodeCharacter{0155}{\'r}%
10595 \DeclareUnicodeCharacter{0156}{\cedilla{R}}%
10596 \DeclareUnicodeCharacter{0157}{\cedilla{r}}%
10597 \DeclareUnicodeCharacter{0158}{\v{R}}%
10598 \DeclareUnicodeCharacter{0159}{\v{r}}%
10599 \DeclareUnicodeCharacter{015A}{\'S}%
10600 \DeclareUnicodeCharacter{015B}{\'s}%
10601 \DeclareUnicodeCharacter{015C}{\^S}%
10602 \DeclareUnicodeCharacter{015D}{\^s}%
10603 \DeclareUnicodeCharacter{015E}{\cedilla{S}}%
10604 \DeclareUnicodeCharacter{015F}{\cedilla{s}}%
10606 \DeclareUnicodeCharacter{0160}{\v{S}}%
10607 \DeclareUnicodeCharacter{0161}{\v{s}}%
10608 \DeclareUnicodeCharacter{0162}{\cedilla{T}}%
10609 \DeclareUnicodeCharacter{0163}{\cedilla{t}}%
10610 \DeclareUnicodeCharacter{0164}{\v{T}}%
10611 \DeclareUnicodeCharacter{0165}{\v{t}}%
10612 \DeclareUnicodeCharacter{0166}{\missingcharmsg{H WITH STROKE}}%
10613 \DeclareUnicodeCharacter{0167}{\missingcharmsg{h WITH STROKE}}%
10614 \DeclareUnicodeCharacter{0168}{\~U}%
10615 \DeclareUnicodeCharacter{0169}{\~u}%
10616 \DeclareUnicodeCharacter{016A}{\=U}%
10617 \DeclareUnicodeCharacter{016B}{\=u}%
10618 \DeclareUnicodeCharacter{016C}{\u{U}}%
10619 \DeclareUnicodeCharacter{016D}{\u{u}}%
10620 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}%
10621 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}%
10623 \DeclareUnicodeCharacter{0170}{\H{U}}%
10624 \DeclareUnicodeCharacter{0171}{\H{u}}%
10625 \DeclareUnicodeCharacter{0172}{\ogonek{U}}%
10626 \DeclareUnicodeCharacter{0173}{\ogonek{u}}%
10627 \DeclareUnicodeCharacter{0174}{\^W}%
10628 \DeclareUnicodeCharacter{0175}{\^w}%
10629 \DeclareUnicodeCharacter{0176}{\^Y}%
10630 \DeclareUnicodeCharacter{0177}{\^y}%
10631 \DeclareUnicodeCharacter{0178}{\"Y}%
10632 \DeclareUnicodeCharacter{0179}{\'Z}%
10633 \DeclareUnicodeCharacter{017A}{\'z}%
10634 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}%
10635 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}%
10636 \DeclareUnicodeCharacter{017D}{\v{Z}}%
10637 \DeclareUnicodeCharacter{017E}{\v{z}}%
10638 \DeclareUnicodeCharacter{017F}{\missingcharmsg{LONG S}}%
10640 \DeclareUnicodeCharacter{01C4}{D\v{Z}}%
10641 \DeclareUnicodeCharacter{01C5}{D\v{z}}%
10642 \DeclareUnicodeCharacter{01C6}{d\v{z}}%
10643 \DeclareUnicodeCharacter{01C7}{LJ}%
10644 \DeclareUnicodeCharacter{01C8}{Lj}%
10645 \DeclareUnicodeCharacter{01C9}{lj}%
10646 \DeclareUnicodeCharacter{01CA}{NJ}%
10647 \DeclareUnicodeCharacter{01CB}{Nj}%
10648 \DeclareUnicodeCharacter{01CC}{nj}%
10649 \DeclareUnicodeCharacter{01CD}{\v{A}}%
10650 \DeclareUnicodeCharacter{01CE}{\v{a}}%
10651 \DeclareUnicodeCharacter{01CF}{\v{I}}%
10653 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}%
10654 \DeclareUnicodeCharacter{01D1}{\v{O}}%
10655 \DeclareUnicodeCharacter{01D2}{\v{o}}%
10656 \DeclareUnicodeCharacter{01D3}{\v{U}}%
10657 \DeclareUnicodeCharacter{01D4}{\v{u}}%
10659 \DeclareUnicodeCharacter{01E2}{\={\AE}}%
10660 \DeclareUnicodeCharacter{01E3}{\={\ae}}%
10661 \DeclareUnicodeCharacter{01E6}{\v{G}}%
10662 \DeclareUnicodeCharacter{01E7}{\v{g}}%
10663 \DeclareUnicodeCharacter{01E8}{\v{K}}%
10664 \DeclareUnicodeCharacter{01E9}{\v{k}}%
10666 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}%
10667 \DeclareUnicodeCharacter{01F1}{DZ}%
10668 \DeclareUnicodeCharacter{01F2}{Dz}%
10669 \DeclareUnicodeCharacter{01F3}{dz}%
10670 \DeclareUnicodeCharacter{01F4}{\'G}%
10671 \DeclareUnicodeCharacter{01F5}{\'g}%
10672 \DeclareUnicodeCharacter{01F8}{\`N}%
10673 \DeclareUnicodeCharacter{01F9}{\`n}%
10674 \DeclareUnicodeCharacter{01FC}{\'{\AE}}%
10675 \DeclareUnicodeCharacter{01FD}{\'{\ae}}%
10676 \DeclareUnicodeCharacter{01FE}{\'{\O}}%
10677 \DeclareUnicodeCharacter{01FF}{\'{\o}}%
10679 \DeclareUnicodeCharacter{021E}{\v{H}}%
10680 \DeclareUnicodeCharacter{021F}{\v{h}}%
10682 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}%
10683 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}%
10684 \DeclareUnicodeCharacter{0228}{\cedilla{E}}%
10685 \DeclareUnicodeCharacter{0229}{\cedilla{e}}%
10686 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}%
10687 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}%
10689 \DeclareUnicodeCharacter{0232}{\=Y}%
10690 \DeclareUnicodeCharacter{0233}{\=y}%
10691 \DeclareUnicodeCharacter{0237}{\dotless{j}}%
10693 \DeclareUnicodeCharacter{02BC}{'}%
10695 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}%
10697 % Greek letters upper case
10698 \DeclareUnicodeCharacter{0391}{{\it A}}%
10699 \DeclareUnicodeCharacter{0392}{{\it B}}%
10700 \DeclareUnicodeCharacter{0393}{\ensuremath{\mit\Gamma}}%
10701 \DeclareUnicodeCharacter{0394}{\ensuremath{\mit\Delta}}%
10702 \DeclareUnicodeCharacter{0395}{{\it E}}%
10703 \DeclareUnicodeCharacter{0396}{{\it Z}}%
10704 \DeclareUnicodeCharacter{0397}{{\it H}}%
10705 \DeclareUnicodeCharacter{0398}{\ensuremath{\mit\Theta}}%
10706 \DeclareUnicodeCharacter{0399}{{\it I}}%
10707 \DeclareUnicodeCharacter{039A}{{\it K}}%
10708 \DeclareUnicodeCharacter{039B}{\ensuremath{\mit\Lambda}}%
10709 \DeclareUnicodeCharacter{039C}{{\it M}}%
10710 \DeclareUnicodeCharacter{039D}{{\it N}}%
10711 \DeclareUnicodeCharacter{039E}{\ensuremath{\mit\Xi}}%
10712 \DeclareUnicodeCharacter{039F}{{\it O}}%
10713 \DeclareUnicodeCharacter{03A0}{\ensuremath{\mit\Pi}}%
10714 \DeclareUnicodeCharacter{03A1}{{\it P}}%
10715 %\DeclareUnicodeCharacter{03A2}{} % none - corresponds to final sigma
10716 \DeclareUnicodeCharacter{03A3}{\ensuremath{\mit\Sigma}}%
10717 \DeclareUnicodeCharacter{03A4}{{\it T}}%
10718 \DeclareUnicodeCharacter{03A5}{\ensuremath{\mit\Upsilon}}%
10719 \DeclareUnicodeCharacter{03A6}{\ensuremath{\mit\Phi}}%
10720 \DeclareUnicodeCharacter{03A7}{{\it X}}%
10721 \DeclareUnicodeCharacter{03A8}{\ensuremath{\mit\Psi}}%
10722 \DeclareUnicodeCharacter{03A9}{\ensuremath{\mit\Omega}}%
10724 % Vowels with accents
10725 \DeclareUnicodeCharacter{0390}{\ensuremath{\ddot{\acute\iota}}}%
10726 \DeclareUnicodeCharacter{03AC}{\ensuremath{\acute\alpha}}%
10727 \DeclareUnicodeCharacter{03AD}{\ensuremath{\acute\epsilon}}%
10728 \DeclareUnicodeCharacter{03AE}{\ensuremath{\acute\eta}}%
10729 \DeclareUnicodeCharacter{03AF}{\ensuremath{\acute\iota}}%
10730 \DeclareUnicodeCharacter{03B0}{\ensuremath{\acute{\ddot\upsilon}}}%
10732 % Standalone accent
10733 \DeclareUnicodeCharacter{0384}{\ensuremath{\acute{\ }}}%
10735 % Greek letters lower case
10736 \DeclareUnicodeCharacter{03B1}{\ensuremath\alpha}%
10737 \DeclareUnicodeCharacter{03B2}{\ensuremath\beta}%
10738 \DeclareUnicodeCharacter{03B3}{\ensuremath\gamma}%
10739 \DeclareUnicodeCharacter{03B4}{\ensuremath\delta}%
10740 \DeclareUnicodeCharacter{03B5}{\ensuremath\epsilon}%
10741 \DeclareUnicodeCharacter{03B6}{\ensuremath\zeta}%
10742 \DeclareUnicodeCharacter{03B7}{\ensuremath\eta}%
10743 \DeclareUnicodeCharacter{03B8}{\ensuremath\theta}%
10744 \DeclareUnicodeCharacter{03B9}{\ensuremath\iota}%
10745 \DeclareUnicodeCharacter{03BA}{\ensuremath\kappa}%
10746 \DeclareUnicodeCharacter{03BB}{\ensuremath\lambda}%
10747 \DeclareUnicodeCharacter{03BC}{\ensuremath\mu}%
10748 \DeclareUnicodeCharacter{03BD}{\ensuremath\nu}%
10749 \DeclareUnicodeCharacter{03BE}{\ensuremath\xi}%
10750 \DeclareUnicodeCharacter{03BF}{{\it o}}% omicron
10751 \DeclareUnicodeCharacter{03C0}{\ensuremath\pi}%
10752 \DeclareUnicodeCharacter{03C1}{\ensuremath\rho}%
10753 \DeclareUnicodeCharacter{03C2}{\ensuremath\varsigma}%
10754 \DeclareUnicodeCharacter{03C3}{\ensuremath\sigma}%
10755 \DeclareUnicodeCharacter{03C4}{\ensuremath\tau}%
10756 \DeclareUnicodeCharacter{03C5}{\ensuremath\upsilon}%
10757 \DeclareUnicodeCharacter{03C6}{\ensuremath\phi}%
10758 \DeclareUnicodeCharacter{03C7}{\ensuremath\chi}%
10759 \DeclareUnicodeCharacter{03C8}{\ensuremath\psi}%
10760 \DeclareUnicodeCharacter{03C9}{\ensuremath\omega}%
10762 % More Greek vowels with accents
10763 \DeclareUnicodeCharacter{03CA}{\ensuremath{\ddot\iota}}%
10764 \DeclareUnicodeCharacter{03CB}{\ensuremath{\ddot\upsilon}}%
10765 \DeclareUnicodeCharacter{03CC}{\ensuremath{\acute o}}%
10766 \DeclareUnicodeCharacter{03CD}{\ensuremath{\acute\upsilon}}%
10767 \DeclareUnicodeCharacter{03CE}{\ensuremath{\acute\omega}}%
10769 % Variant Greek letters
10770 \DeclareUnicodeCharacter{03D1}{\ensuremath\vartheta}%
10771 \DeclareUnicodeCharacter{03D6}{\ensuremath\varpi}%
10772 \DeclareUnicodeCharacter{03F1}{\ensuremath\varrho}%
10774 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}%
10775 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}%
10776 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}%
10777 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}%
10778 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}%
10779 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}%
10780 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}%
10781 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}%
10782 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}%
10783 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}%
10784 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}%
10785 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}%
10787 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}%
10788 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}%
10790 \DeclareUnicodeCharacter{1E20}{\=G}%
10791 \DeclareUnicodeCharacter{1E21}{\=g}%
10792 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}%
10793 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}%
10794 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}%
10795 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}%
10796 \DeclareUnicodeCharacter{1E26}{\"H}%
10797 \DeclareUnicodeCharacter{1E27}{\"h}%
10799 \DeclareUnicodeCharacter{1E30}{\'K}%
10800 \DeclareUnicodeCharacter{1E31}{\'k}%
10801 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}%
10802 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}%
10803 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}%
10804 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}%
10805 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}%
10806 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}%
10807 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}%
10808 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}%
10809 \DeclareUnicodeCharacter{1E3E}{\'M}%
10810 \DeclareUnicodeCharacter{1E3F}{\'m}%
10812 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}%
10813 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}%
10814 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}%
10815 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}%
10816 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}%
10817 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}%
10818 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}%
10819 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}%
10820 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}%
10821 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}%
10823 \DeclareUnicodeCharacter{1E54}{\'P}%
10824 \DeclareUnicodeCharacter{1E55}{\'p}%
10825 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}%
10826 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}%
10827 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}%
10828 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}%
10829 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}%
10830 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}%
10831 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}%
10832 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}%
10834 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}%
10835 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}%
10836 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}%
10837 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}%
10838 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}%
10839 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}%
10840 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}%
10841 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}%
10842 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}%
10843 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}%
10845 \DeclareUnicodeCharacter{1E7C}{\~V}%
10846 \DeclareUnicodeCharacter{1E7D}{\~v}%
10847 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}%
10848 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}%
10850 \DeclareUnicodeCharacter{1E80}{\`W}%
10851 \DeclareUnicodeCharacter{1E81}{\`w}%
10852 \DeclareUnicodeCharacter{1E82}{\'W}%
10853 \DeclareUnicodeCharacter{1E83}{\'w}%
10854 \DeclareUnicodeCharacter{1E84}{\"W}%
10855 \DeclareUnicodeCharacter{1E85}{\"w}%
10856 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}%
10857 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}%
10858 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}%
10859 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}%
10860 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}%
10861 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}%
10862 \DeclareUnicodeCharacter{1E8C}{\"X}%
10863 \DeclareUnicodeCharacter{1E8D}{\"x}%
10864 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}%
10865 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}%
10867 \DeclareUnicodeCharacter{1E90}{\^Z}%
10868 \DeclareUnicodeCharacter{1E91}{\^z}%
10869 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}%
10870 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}%
10871 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}%
10872 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}%
10873 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}%
10874 \DeclareUnicodeCharacter{1E97}{\"t}%
10875 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}%
10876 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}%
10878 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}%
10879 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}%
10881 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}%
10882 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}%
10883 \DeclareUnicodeCharacter{1EBC}{\~E}%
10884 \DeclareUnicodeCharacter{1EBD}{\~e}%
10886 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}%
10887 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}%
10888 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}%
10889 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}%
10891 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}%
10892 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}%
10894 \DeclareUnicodeCharacter{1EF2}{\`Y}%
10895 \DeclareUnicodeCharacter{1EF3}{\`y}%
10896 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}%
10898 \DeclareUnicodeCharacter{1EF8}{\~Y}%
10899 \DeclareUnicodeCharacter{1EF9}{\~y}%
10901 % Exotic spaces
10902 \DeclareUnicodeCharacter{2007}{\hphantom{0}}%
10904 % Punctuation
10905 \DeclareUnicodeCharacter{2013}{--}%
10906 \DeclareUnicodeCharacter{2014}{---}%
10907 \DeclareUnicodeCharacter{2018}{\quoteleft{}}%
10908 \DeclareUnicodeCharacter{2019}{\quoteright{}}%
10909 \DeclareUnicodeCharacter{201A}{\quotesinglbase{}}%
10910 \DeclareUnicodeCharacter{201C}{\quotedblleft{}}%
10911 \DeclareUnicodeCharacter{201D}{\quotedblright{}}%
10912 \DeclareUnicodeCharacter{201E}{\quotedblbase{}}%
10913 \DeclareUnicodeCharacter{2020}{\ensuremath\dagger}%
10914 \DeclareUnicodeCharacter{2021}{\ensuremath\ddagger}%
10915 \DeclareUnicodeCharacter{2022}{\bullet{}}%
10916 \DeclareUnicodeCharacter{202F}{\thinspace}%
10917 \DeclareUnicodeCharacter{2026}{\dots{}}%
10918 \DeclareUnicodeCharacter{2039}{\guilsinglleft{}}%
10919 \DeclareUnicodeCharacter{203A}{\guilsinglright{}}%
10921 \DeclareUnicodeCharacter{20AC}{\euro{}}%
10923 \DeclareUnicodeCharacter{2192}{\expansion{}}%
10924 \DeclareUnicodeCharacter{21D2}{\result{}}%
10926 % Mathematical symbols
10927 \DeclareUnicodeCharacter{2200}{\ensuremath\forall}%
10928 \DeclareUnicodeCharacter{2203}{\ensuremath\exists}%
10929 \DeclareUnicodeCharacter{2208}{\ensuremath\in}%
10930 \DeclareUnicodeCharacter{2212}{\minus{}}%
10931 \DeclareUnicodeCharacter{2217}{\ast}%
10932 \DeclareUnicodeCharacter{221E}{\ensuremath\infty}%
10933 \DeclareUnicodeCharacter{2225}{\ensuremath\parallel}%
10934 \DeclareUnicodeCharacter{2227}{\ensuremath\wedge}%
10935 \DeclareUnicodeCharacter{2229}{\ensuremath\cap}%
10936 \DeclareUnicodeCharacter{2261}{\equiv{}}%
10937 \DeclareUnicodeCharacter{2264}{\ensuremath\leq}%
10938 \DeclareUnicodeCharacter{2265}{\ensuremath\geq}%
10939 \DeclareUnicodeCharacter{2282}{\ensuremath\subset}%
10940 \DeclareUnicodeCharacter{2287}{\ensuremath\supseteq}%
10942 \DeclareUnicodeCharacter{2016}{\ensuremath\Vert}%
10943 \DeclareUnicodeCharacter{2032}{\ensuremath\prime}%
10944 \DeclareUnicodeCharacter{210F}{\ensuremath\hbar}%
10945 \DeclareUnicodeCharacter{2111}{\ensuremath\Im}%
10946 \DeclareUnicodeCharacter{2113}{\ensuremath\ell}%
10947 \DeclareUnicodeCharacter{2118}{\ensuremath\wp}%
10948 \DeclareUnicodeCharacter{211C}{\ensuremath\Re}%
10949 \DeclareUnicodeCharacter{2135}{\ensuremath\aleph}%
10950 \DeclareUnicodeCharacter{2190}{\ensuremath\leftarrow}%
10951 \DeclareUnicodeCharacter{2191}{\ensuremath\uparrow}%
10952 \DeclareUnicodeCharacter{2193}{\ensuremath\downarrow}%
10953 \DeclareUnicodeCharacter{2194}{\ensuremath\leftrightarrow}%
10954 \DeclareUnicodeCharacter{2195}{\ensuremath\updownarrow}%
10955 \DeclareUnicodeCharacter{2196}{\ensuremath\nwarrow}%
10956 \DeclareUnicodeCharacter{2197}{\ensuremath\nearrow}%
10957 \DeclareUnicodeCharacter{2198}{\ensuremath\searrow}%
10958 \DeclareUnicodeCharacter{2199}{\ensuremath\swarrow}%
10959 \DeclareUnicodeCharacter{21A6}{\ensuremath\mapsto}%
10960 \DeclareUnicodeCharacter{21A9}{\ensuremath\hookleftarrow}%
10961 \DeclareUnicodeCharacter{21AA}{\ensuremath\hookrightarrow}%
10962 \DeclareUnicodeCharacter{21BC}{\ensuremath\leftharpoonup}%
10963 \DeclareUnicodeCharacter{21BD}{\ensuremath\leftharpoondown}%
10964 \DeclareUnicodeCharacter{21C0}{\ensuremath\rightharpoonup}%
10965 \DeclareUnicodeCharacter{21C1}{\ensuremath\rightharpoondown}%
10966 \DeclareUnicodeCharacter{21CC}{\ensuremath\rightleftharpoons}%
10967 \DeclareUnicodeCharacter{21D0}{\ensuremath\Leftarrow}%
10968 \DeclareUnicodeCharacter{21D1}{\ensuremath\Uparrow}%
10969 \DeclareUnicodeCharacter{21D3}{\ensuremath\Downarrow}%
10970 \DeclareUnicodeCharacter{21D4}{\ensuremath\Leftrightarrow}%
10971 \DeclareUnicodeCharacter{21D5}{\ensuremath\Updownarrow}%
10972 \DeclareUnicodeCharacter{2202}{\ensuremath\partial}%
10973 \DeclareUnicodeCharacter{2205}{\ensuremath\emptyset}%
10974 \DeclareUnicodeCharacter{2207}{\ensuremath\nabla}%
10975 \DeclareUnicodeCharacter{2209}{\ensuremath\notin}%
10976 \DeclareUnicodeCharacter{220B}{\ensuremath\owns}%
10977 \DeclareUnicodeCharacter{220F}{\ensuremath\prod}%
10978 \DeclareUnicodeCharacter{2210}{\ensuremath\coprod}%
10979 \DeclareUnicodeCharacter{2211}{\ensuremath\sum}%
10980 \DeclareUnicodeCharacter{2213}{\ensuremath\mp}%
10981 \DeclareUnicodeCharacter{2218}{\ensuremath\circ}%
10982 \DeclareUnicodeCharacter{221A}{\ensuremath\surd}%
10983 \DeclareUnicodeCharacter{221D}{\ensuremath\propto}%
10984 \DeclareUnicodeCharacter{2220}{\ensuremath\angle}%
10985 \DeclareUnicodeCharacter{2223}{\ensuremath\mid}%
10986 \DeclareUnicodeCharacter{2228}{\ensuremath\vee}%
10987 \DeclareUnicodeCharacter{222A}{\ensuremath\cup}%
10988 \DeclareUnicodeCharacter{222B}{\ensuremath\smallint}%
10989 \DeclareUnicodeCharacter{222E}{\ensuremath\oint}%
10990 \DeclareUnicodeCharacter{223C}{\ensuremath\sim}%
10991 \DeclareUnicodeCharacter{2240}{\ensuremath\wr}%
10992 \DeclareUnicodeCharacter{2243}{\ensuremath\simeq}%
10993 \DeclareUnicodeCharacter{2245}{\ensuremath\cong}%
10994 \DeclareUnicodeCharacter{2248}{\ensuremath\approx}%
10995 \DeclareUnicodeCharacter{224D}{\ensuremath\asymp}%
10996 \DeclareUnicodeCharacter{2250}{\ensuremath\doteq}%
10997 \DeclareUnicodeCharacter{2260}{\ensuremath\neq}%
10998 \DeclareUnicodeCharacter{226A}{\ensuremath\ll}%
10999 \DeclareUnicodeCharacter{226B}{\ensuremath\gg}%
11000 \DeclareUnicodeCharacter{227A}{\ensuremath\prec}%
11001 \DeclareUnicodeCharacter{227B}{\ensuremath\succ}%
11002 \DeclareUnicodeCharacter{2283}{\ensuremath\supset}%
11003 \DeclareUnicodeCharacter{2286}{\ensuremath\subseteq}%
11004 \DeclareUnicodeCharacter{228E}{\ensuremath\uplus}%
11005 \DeclareUnicodeCharacter{2291}{\ensuremath\sqsubseteq}%
11006 \DeclareUnicodeCharacter{2292}{\ensuremath\sqsupseteq}%
11007 \DeclareUnicodeCharacter{2293}{\ensuremath\sqcap}%
11008 \DeclareUnicodeCharacter{2294}{\ensuremath\sqcup}%
11009 \DeclareUnicodeCharacter{2295}{\ensuremath\oplus}%
11010 \DeclareUnicodeCharacter{2296}{\ensuremath\ominus}%
11011 \DeclareUnicodeCharacter{2297}{\ensuremath\otimes}%
11012 \DeclareUnicodeCharacter{2298}{\ensuremath\oslash}%
11013 \DeclareUnicodeCharacter{2299}{\ensuremath\odot}%
11014 \DeclareUnicodeCharacter{22A2}{\ensuremath\vdash}%
11015 \DeclareUnicodeCharacter{22A3}{\ensuremath\dashv}%
11016 \DeclareUnicodeCharacter{22A4}{\ensuremath\ptextop}%
11017 \DeclareUnicodeCharacter{22A5}{\ensuremath\bot}%
11018 \DeclareUnicodeCharacter{22A8}{\ensuremath\models}%
11019 \DeclareUnicodeCharacter{22C0}{\ensuremath\bigwedge}%
11020 \DeclareUnicodeCharacter{22C1}{\ensuremath\bigvee}%
11021 \DeclareUnicodeCharacter{22C2}{\ensuremath\bigcap}%
11022 \DeclareUnicodeCharacter{22C3}{\ensuremath\bigcup}%
11023 \DeclareUnicodeCharacter{22C4}{\ensuremath\diamond}%
11024 \DeclareUnicodeCharacter{22C5}{\ensuremath\cdot}%
11025 \DeclareUnicodeCharacter{22C6}{\ensuremath\star}%
11026 \DeclareUnicodeCharacter{22C8}{\ensuremath\bowtie}%
11027 \DeclareUnicodeCharacter{2308}{\ensuremath\lceil}%
11028 \DeclareUnicodeCharacter{2309}{\ensuremath\rceil}%
11029 \DeclareUnicodeCharacter{230A}{\ensuremath\lfloor}%
11030 \DeclareUnicodeCharacter{230B}{\ensuremath\rfloor}%
11031 \DeclareUnicodeCharacter{2322}{\ensuremath\frown}%
11032 \DeclareUnicodeCharacter{2323}{\ensuremath\smile}%
11034 \DeclareUnicodeCharacter{25B3}{\ensuremath\triangle}%
11035 \DeclareUnicodeCharacter{25B7}{\ensuremath\triangleright}%
11036 \DeclareUnicodeCharacter{25BD}{\ensuremath\bigtriangledown}%
11037 \DeclareUnicodeCharacter{25C1}{\ensuremath\triangleleft}%
11038 \DeclareUnicodeCharacter{25C7}{\ensuremath\diamond}%
11039 \DeclareUnicodeCharacter{2660}{\ensuremath\spadesuit}%
11040 \DeclareUnicodeCharacter{2661}{\ensuremath\heartsuit}%
11041 \DeclareUnicodeCharacter{2662}{\ensuremath\diamondsuit}%
11042 \DeclareUnicodeCharacter{2663}{\ensuremath\clubsuit}%
11043 \DeclareUnicodeCharacter{266D}{\ensuremath\flat}%
11044 \DeclareUnicodeCharacter{266E}{\ensuremath\natural}%
11045 \DeclareUnicodeCharacter{266F}{\ensuremath\sharp}%
11046 \DeclareUnicodeCharacter{26AA}{\ensuremath\bigcirc}%
11047 \DeclareUnicodeCharacter{27B9}{\ensuremath\rangle}%
11048 \DeclareUnicodeCharacter{27C2}{\ensuremath\perp}%
11049 \DeclareUnicodeCharacter{27E8}{\ensuremath\langle}%
11050 \DeclareUnicodeCharacter{27F5}{\ensuremath\longleftarrow}%
11051 \DeclareUnicodeCharacter{27F6}{\ensuremath\longrightarrow}%
11052 \DeclareUnicodeCharacter{27F7}{\ensuremath\longleftrightarrow}%
11053 \DeclareUnicodeCharacter{27FC}{\ensuremath\longmapsto}%
11054 \DeclareUnicodeCharacter{29F5}{\ensuremath\setminus}%
11055 \DeclareUnicodeCharacter{2A00}{\ensuremath\bigodot}%
11056 \DeclareUnicodeCharacter{2A01}{\ensuremath\bigoplus}%
11057 \DeclareUnicodeCharacter{2A02}{\ensuremath\bigotimes}%
11058 \DeclareUnicodeCharacter{2A04}{\ensuremath\biguplus}%
11059 \DeclareUnicodeCharacter{2A06}{\ensuremath\bigsqcup}%
11060 \DeclareUnicodeCharacter{2A3F}{\ensuremath\amalg}%
11061 \DeclareUnicodeCharacter{2AAF}{\ensuremath\preceq}%
11062 \DeclareUnicodeCharacter{2AB0}{\ensuremath\succeq}%
11064 \global\mathchardef\checkmark="1370% actually the square root sign
11065 \DeclareUnicodeCharacter{2713}{\ensuremath\checkmark}%
11066 }% end of \unicodechardefs
11068 % UTF-8 byte sequence (pdfTeX) definitions (replacing and @U command)
11069 % It makes the setting that replace UTF-8 byte sequence.
11070 \def\utfeightchardefs{%
11071 \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterUTFviii
11072 \unicodechardefs
11075 % Whether the active definitions of non-ASCII characters expand to
11076 % non-active tokens with the same character code. This is used to
11077 % write characters literally, instead of using active definitions for
11078 % printing the correct glyphs.
11079 \newif\ifpassthroughchars
11080 \passthroughcharsfalse
11082 % For native Unicode handling (XeTeX and LuaTeX),
11083 % provide a definition macro to replace/pass-through a Unicode character
11085 \def\DeclareUnicodeCharacterNative#1#2{%
11086 \catcode"#1=\active
11087 \def\dodeclareunicodecharacternative##1##2##3{%
11088 \begingroup
11089 \uccode`\~="##2\relax
11090 \uppercase{\gdef~}{%
11091 \ifpassthroughchars
11092 ##1%
11093 \else
11094 ##3%
11097 \endgroup
11099 \begingroup
11100 \uccode`\.="#1\relax
11101 \uppercase{\def\UTFNativeTmp{.}}%
11102 \expandafter\dodeclareunicodecharacternative\UTFNativeTmp{#1}{#2}%
11103 \endgroup
11106 % Native Unicode handling (XeTeX and LuaTeX) character replacing definition.
11107 % It activates the setting that replaces Unicode characters.
11108 \def\nativeunicodechardefs{%
11109 \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNative
11110 \unicodechardefs
11113 % For native Unicode handling (XeTeX and LuaTeX),
11114 % make the character token expand
11115 % to the sequences given in \unicodechardefs for printing.
11116 \def\DeclareUnicodeCharacterNativeAtU#1#2{%
11117 \def\UTFAtUTmp{#2}
11118 \expandafter\globallet\csname uni:#1\endcsname \UTFAtUTmp
11121 % @U command definitions for native Unicode handling (XeTeX and LuaTeX).
11122 \def\nativeunicodechardefsatu{%
11123 \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNativeAtU
11124 \unicodechardefs
11127 % US-ASCII character definitions.
11128 \def\asciichardefs{% nothing need be done
11129 \relax
11132 % Define all Unicode characters we know about. This makes UTF-8 the default
11133 % input encoding and allows @U to work.
11134 \iftxinativeunicodecapable
11135 \nativeunicodechardefsatu
11136 \else
11137 \utfeightchardefs
11140 \message{formatting,}
11142 \newdimen\defaultparindent \defaultparindent = 15pt
11144 \chapheadingskip = 15pt plus 4pt minus 2pt
11145 \secheadingskip = 12pt plus 3pt minus 2pt
11146 \subsecheadingskip = 9pt plus 2pt minus 2pt
11148 % Prevent underfull vbox error messages.
11149 \vbadness = 10000
11151 % Don't be very finicky about underfull hboxes, either.
11152 \hbadness = 6666
11154 % Following George Bush, get rid of widows and orphans.
11155 \widowpenalty=10000
11156 \clubpenalty=10000
11158 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
11159 % using an old version of TeX, don't do anything. We want the amount of
11160 % stretch added to depend on the line length, hence the dependence on
11161 % \hsize. We call this whenever the paper size is set.
11163 \def\setemergencystretch{%
11164 \ifx\emergencystretch\thisisundefined
11165 % Allow us to assign to \emergencystretch anyway.
11166 \def\emergencystretch{\dimen0}%
11167 \else
11168 \emergencystretch = .15\hsize
11172 % Parameters in order: 1) textheight; 2) textwidth;
11173 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
11174 % 7) physical page height; 8) physical page width.
11176 % We also call \setleading{\textleading}, so the caller should define
11177 % \textleading. The caller should also set \parskip.
11179 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
11180 \voffset = #3\relax
11181 \topskip = #6\relax
11182 \splittopskip = \topskip
11184 \vsize = #1\relax
11185 \advance\vsize by \topskip
11186 \outervsize = \vsize
11187 \advance\outervsize by 2\topandbottommargin
11188 \txipageheight = \vsize
11190 \hsize = #2\relax
11191 \outerhsize = \hsize
11192 \advance\outerhsize by 0.5in
11193 \txipagewidth = \hsize
11195 \normaloffset = #4\relax
11196 \bindingoffset = #5\relax
11198 \ifpdf
11199 \pdfpageheight #7\relax
11200 \pdfpagewidth #8\relax
11201 % if we don't reset these, they will remain at "1 true in" of
11202 % whatever layout pdftex was dumped with.
11203 \pdfhorigin = 1 true in
11204 \pdfvorigin = 1 true in
11205 \else
11206 \ifx\XeTeXrevision\thisisundefined
11207 \special{papersize=#8,#7}%
11208 \else
11209 \pdfpageheight #7\relax
11210 \pdfpagewidth #8\relax
11211 % XeTeX does not have \pdfhorigin and \pdfvorigin.
11215 \setleading{\textleading}
11217 \parindent = \defaultparindent
11218 \setemergencystretch
11221 % @letterpaper (the default).
11222 \def\letterpaper{{\globaldefs = 1
11223 \parskip = 3pt plus 2pt minus 1pt
11224 \textleading = 13.2pt
11226 % If page is nothing but text, make it come out even.
11227 \internalpagesizes{607.2pt}{6in}% that's 46 lines
11228 {\voffset}{.25in}%
11229 {\bindingoffset}{36pt}%
11230 {11in}{8.5in}%
11233 % Use @smallbook to reset parameters for 7x9.25 trim size.
11234 \def\smallbook{{\globaldefs = 1
11235 \parskip = 2pt plus 1pt
11236 \textleading = 12pt
11238 \internalpagesizes{7.5in}{5in}%
11239 {-.2in}{0in}%
11240 {\bindingoffset}{16pt}%
11241 {9.25in}{7in}%
11243 \lispnarrowing = 0.3in
11244 \tolerance = 700
11245 \contentsrightmargin = 0pt
11246 \defbodyindent = .5cm
11249 % Use @afourpaper to print on European A4 paper.
11250 \def\afourpaper{{\globaldefs = 1
11251 \parskip = 3pt plus 2pt minus 1pt
11252 \textleading = 13.2pt
11254 % Double-side printing via postscript on Laserjet 4050
11255 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
11256 % To change the settings for a different printer or situation, adjust
11257 % \normaloffset until the front-side and back-side texts align. Then
11258 % do the same for \bindingoffset. You can set these for testing in
11259 % your texinfo source file like this:
11260 % @tex
11261 % \global\normaloffset = -6mm
11262 % \global\bindingoffset = 10mm
11263 % @end tex
11264 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
11265 {\voffset}{\hoffset}%
11266 {\bindingoffset}{44pt}%
11267 {297mm}{210mm}%
11269 \tolerance = 700
11270 \contentsrightmargin = 0pt
11271 \defbodyindent = 5mm
11274 % Use @afivepaper to print on European A5 paper.
11275 % From romildo@urano.iceb.ufop.br, 2 July 2000.
11276 % He also recommends making @example and @lisp be small.
11277 \def\afivepaper{{\globaldefs = 1
11278 \parskip = 2pt plus 1pt minus 0.1pt
11279 \textleading = 12.5pt
11281 \internalpagesizes{160mm}{120mm}%
11282 {\voffset}{\hoffset}%
11283 {\bindingoffset}{8pt}%
11284 {210mm}{148mm}%
11286 \lispnarrowing = 0.2in
11287 \tolerance = 800
11288 \contentsrightmargin = 0pt
11289 \defbodyindent = 2mm
11290 \tableindent = 12mm
11293 % A specific text layout, 24x15cm overall, intended for A4 paper.
11294 \def\afourlatex{{\globaldefs = 1
11295 \afourpaper
11296 \internalpagesizes{237mm}{150mm}%
11297 {\voffset}{4.6mm}%
11298 {\bindingoffset}{7mm}%
11299 {297mm}{210mm}%
11301 % Must explicitly reset to 0 because we call \afourpaper.
11302 \globaldefs = 0
11305 % Use @afourwide to print on A4 paper in landscape format.
11306 \def\afourwide{{\globaldefs = 1
11307 \afourpaper
11308 \internalpagesizes{241mm}{165mm}%
11309 {\voffset}{-2.95mm}%
11310 {\bindingoffset}{7mm}%
11311 {297mm}{210mm}%
11312 \globaldefs = 0
11315 \def\bsixpaper{{\globaldefs = 1
11316 \afourpaper
11317 \internalpagesizes{140mm}{100mm}%
11318 {-6.35mm}{-12.7mm}%
11319 {\bindingoffset}{14pt}%
11320 {176mm}{125mm}%
11321 \let\SETdispenvsize=\smallword
11322 \lispnarrowing = 0.2in
11323 \globaldefs = 0
11327 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
11328 % Perhaps we should allow setting the margins, \topskip, \parskip,
11329 % and/or leading, also. Or perhaps we should compute them somehow.
11331 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
11332 \def\pagesizesyyy#1,#2,#3\finish{{%
11333 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
11334 \globaldefs = 1
11336 \parskip = 3pt plus 2pt minus 1pt
11337 \setleading{\textleading}%
11339 \dimen0 = #1\relax
11340 \advance\dimen0 by 2.5in % default 1in margin above heading line
11341 % and 1.5in to include heading, footing and
11342 % bottom margin
11344 \dimen2 = \hsize
11345 \advance\dimen2 by 2in % default to 1 inch margin on each side
11347 \internalpagesizes{#1}{\hsize}%
11348 {\voffset}{\normaloffset}%
11349 {\bindingoffset}{44pt}%
11350 {\dimen0}{\dimen2}%
11353 % Set default to letter.
11355 \letterpaper
11357 % Default value of \hfuzz, for suppressing warnings about overfull hboxes.
11358 \hfuzz = 1pt
11361 \message{and turning on texinfo input format.}
11363 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
11364 \catcode`\^^K = 10 % treat vertical tab as whitespace
11366 % DEL is a comment character, in case @c does not suffice.
11367 \catcode`\^^? = 14
11369 % Define macros to output various characters with catcode for normal text.
11370 \catcode`\"=\other \def\normaldoublequote{"}
11371 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
11372 \catcode`\+=\other \def\normalplus{+}
11373 \catcode`\<=\other \def\normalless{<}
11374 \catcode`\>=\other \def\normalgreater{>}
11375 \catcode`\^=\other \def\normalcaret{^}
11376 \catcode`\_=\other \def\normalunderscore{_}
11377 \catcode`\|=\other \def\normalverticalbar{|}
11378 \catcode`\~=\other \def\normaltilde{~}
11380 % This macro is used to make a character print one way in \tt
11381 % (where it can probably be output as-is), and another way in other fonts,
11382 % where something hairier probably needs to be done.
11384 % #1 is what to print if we are indeed using \tt; #2 is what to print
11385 % otherwise. Since all the Computer Modern typewriter fonts have zero
11386 % interword stretch (and shrink), and it is reasonable to expect all
11387 % typewriter fonts to have this, we can check that font parameter.
11389 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
11391 % Same as above, but check for italic font. Actually this also catches
11392 % non-italic slanted fonts since it is impossible to distinguish them from
11393 % italic fonts. But since this is only used by $ and it uses \sl anyway
11394 % this is not a problem.
11395 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
11397 % Set catcodes for Texinfo file
11399 % Active characters for printing the wanted glyph.
11400 % Most of these we simply print from the \tt font, but for some, we can
11401 % use math or other variants that look better in normal text.
11403 \catcode`\"=\active
11404 \def\activedoublequote{{\tt\char34}}
11405 \let"=\activedoublequote
11406 \catcode`\~=\active \def\activetilde{{\tt\char126}} \let~ = \activetilde
11407 \chardef\hatchar=`\^
11408 \catcode`\^=\active \def\activehat{{\tt \hatchar}} \let^ = \activehat
11410 \catcode`\_=\active
11411 \def_{\ifusingtt\normalunderscore\_}
11412 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
11413 \let\realunder=_
11415 \catcode`\|=\active \def|{{\tt\char124}}
11417 \chardef \less=`\<
11418 \catcode`\<=\active \def\activeless{{\tt \less}}\let< = \activeless
11419 \chardef \gtr=`\>
11420 \catcode`\>=\active \def\activegtr{{\tt \gtr}}\let> = \activegtr
11421 \catcode`\+=\active \def+{{\tt \char 43}}
11422 \catcode`\$=\active \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
11423 \catcode`\-=\active \let-=\normaldash
11426 % used for headline/footline in the output routine, in case the page
11427 % breaks in the middle of an @tex block.
11428 \def\texinfochars{%
11429 \let< = \activeless
11430 \let> = \activegtr
11431 \let~ = \activetilde
11432 \let^ = \activehat
11433 \setregularquotes
11434 \let\b = \strong
11435 \let\i = \smartitalic
11436 % in principle, all other definitions in \tex have to be undone too.
11439 % Used sometimes to turn off (effectively) the active characters even after
11440 % parsing them.
11441 \def\turnoffactive{%
11442 \normalturnoffactive
11443 \otherbackslash
11446 \catcode`\@=0
11448 % \backslashcurfont outputs one backslash character in current font,
11449 % as in \char`\\.
11450 \global\chardef\backslashcurfont=`\\
11452 % \realbackslash is an actual character `\' with catcode other.
11453 {\catcode`\\=\other @gdef@realbackslash{\}}
11455 % In Texinfo, backslash is an active character; it prints the backslash
11456 % in fixed width font.
11457 \catcode`\\=\active % @ for escape char from now on.
11459 % Print a typewriter backslash. For math mode, we can't simply use
11460 % \backslashcurfont: the story here is that in math mode, the \char
11461 % of \backslashcurfont ends up printing the roman \ from the math symbol
11462 % font (because \char in math mode uses the \mathcode, and plain.tex
11463 % sets \mathcode`\\="026E). Hence we use an explicit \mathchar,
11464 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
11465 % ignored family value; char position "5C). We can't use " for the
11466 % usual hex value because it has already been made active.
11468 @def@ttbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
11469 @let@backslashchar = @ttbackslash % @backslashchar{} is for user documents.
11471 % \otherbackslash defines an active \ to be a literal `\' character with
11472 % catcode other.
11473 @gdef@otherbackslash{@let\=@realbackslash}
11475 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
11476 % the literal character `\'.
11478 {@catcode`- = @active
11479 @gdef@normalturnoffactive{%
11480 @passthroughcharstrue
11481 @let-=@normaldash
11482 @let"=@normaldoublequote
11483 @let$=@normaldollar %$ font-lock fix
11484 @let+=@normalplus
11485 @let<=@normalless
11486 @let>=@normalgreater
11487 @let^=@normalcaret
11488 @let_=@normalunderscore
11489 @let|=@normalverticalbar
11490 @let~=@normaltilde
11491 @let\=@ttbackslash
11492 @setregularquotes
11493 @unsepspaces
11497 % If a .fmt file is being used, characters that might appear in a file
11498 % name cannot be active until we have parsed the command line.
11499 % So turn them off again, and have @fixbackslash turn them back on.
11500 @catcode`+=@other @catcode`@_=@other
11502 % \enablebackslashhack - allow file to begin `\input texinfo'
11504 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
11505 % That is what \eatinput is for; after that, the `\' should revert to printing
11506 % a backslash.
11507 % If the file did not have a `\input texinfo', then it is turned off after
11508 % the first line; otherwise the first `\' in the file would cause an error.
11509 % This is used on the very last line of this file, texinfo.tex.
11510 % We also use @c to call @fixbackslash, in case ends of lines are hidden.
11512 @catcode`@^=7
11513 @catcode`@^^M=13@gdef@enablebackslashhack{%
11514 @global@let\ = @eatinput%
11515 @catcode`@^^M=13%
11516 @def@c{@fixbackslash@c}%
11517 % Definition for the newline at the end of this file.
11518 @def ^^M{@let^^M@secondlinenl}%
11519 % Definition for a newline in the main Texinfo file.
11520 @gdef @secondlinenl{@fixbackslash}%
11521 % In case the first line has a whole-line command on it
11522 @let@originalparsearg@parsearg
11523 @def@parsearg{@fixbackslash@originalparsearg}
11526 {@catcode`@^=7 @catcode`@^^M=13%
11527 @gdef@eatinput input texinfo#1^^M{@fixbackslash}}
11529 % Emergency active definition of newline, in case an active newline token
11530 % appears by mistake.
11531 {@catcode`@^=7 @catcode13=13%
11532 @gdef@enableemergencynewline{%
11533 @gdef^^M{%
11534 @par%
11535 %<warning: active newline>@par%
11539 @gdef@fixbackslash{%
11540 @ifx\@eatinput @let\ = @ttbackslash @fi
11541 @catcode13=5 % regular end of line
11542 @enableemergencynewline
11543 @let@c=@comment
11544 @let@parsearg@originalparsearg
11545 % Also turn back on active characters that might appear in the input
11546 % file name, in case not using a pre-dumped format.
11547 @catcode`+=@active
11548 @catcode`@_=@active
11550 % If texinfo.cnf is present on the system, read it.
11551 % Useful for site-wide @afourpaper, etc. This macro, @fixbackslash, gets
11552 % called at the beginning of every Texinfo file. Not opening texinfo.cnf
11553 % directly in this file, texinfo.tex, makes it possible to make a format
11554 % file for Texinfo.
11556 @openin 1 texinfo.cnf
11557 @ifeof 1 @else @input texinfo.cnf @fi
11558 @closein 1
11562 % Say @foo, not \foo, in error messages.
11563 @escapechar = `@@
11565 % These (along with & and #) are made active for url-breaking, so need
11566 % active definitions as the normal characters.
11567 @def@normaldot{.}
11568 @def@normalquest{?}
11569 @def@normalslash{/}
11571 % These look ok in all fonts, so just make them not special.
11572 % @hashchar{} gets its own user-level command, because of #line.
11573 @catcode`@& = @other @def@normalamp{&}
11574 @catcode`@# = @other @def@normalhash{#}
11575 @catcode`@% = @other @def@normalpercent{%}
11577 @let @hashchar = @normalhash
11579 @c Finally, make ` and ' active, so that txicodequoteundirected and
11580 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
11581 @c don't make ` and ' active, @code will not get them as active chars.
11582 @c Do this last of all since we use ` in the previous @catcode assignments.
11583 @catcode`@'=@active
11584 @catcode`@`=@active
11585 @setregularquotes
11587 @c Local variables:
11588 @c eval: (add-hook 'before-save-hook 'time-stamp nil t)
11589 @c time-stamp-pattern: "texinfoversion{%Y-%02m-%02d.%02H}"
11590 @c page-delimiter: "^\\\\message\\|emacs-page"
11591 @c End:
11593 @c vim:sw=2:
11595 @enablebackslashhack