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{2019-09-24.13}
8 % Copyright 1985, 1986, 1988, 1990-2019 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 including 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:
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}%
73 % We never want plain's \outer definition of \+ in Texinfo.
74 % For @tex, we can use \tabalign.
77 % Save some plain tex macros whose names we will redefine.
79 \let\ptexbullet=\bullet
87 \let\ptexfootnote=\footnote
91 \let\ptexindent=\indent
92 \let\ptexinsert=\insert
95 \let\ptexnewwrite\newwrite
96 \let\ptexnoindent=\noindent
98 \let\ptexraggedright=\raggedright
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.
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.
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 = `\_
176 % The following is used inside several \edef's.
177 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
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
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}%
201 \tracinglostchars2 % 2 gives us more in etex
206 \showboxbreadth\maxdimen \showboxdepth\maxdimen
207 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
214 \tracingcommands3 % 3 gives us more in etex
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,
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}
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.
269 \toks0=\expandafter{\currentchapterdefs}%
270 \toks2=\expandafter{\currentsectiondefs}%
271 \toks4=\expandafter{\prevchapterdefs}%
272 \toks6=\expandafter{\prevsectiondefs}%
273 \toks8=\expandafter{\currentcolordefs}%
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
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.
312 \newtoks\defaultoutput
313 \defaultoutput = {\savetopmark\onepageout{\pagecontents\PAGE}}
314 \output=\expandafter{\the\defaultoutput}
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
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
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.
347 \hoffset=\normaloffset
349 \ifodd\pageno \advance\hoffset by \bindingoffset
350 \else \advance\hoffset by -\bindingoffset\fi
352 % Retrieve the information for the headings from the marks in the page,
353 % and call Plain TeX's \makeheadline and \makefootline, which use the
354 % values in \headline and \footline.
356 % This is used to check if we are on the first page of a chapter.
357 \ifcase1\the\savedtopmark\fi
358 \let\prevchaptername\thischaptername
359 \ifcase0\firstmark\fi
360 \let\curchaptername\thischaptername
362 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
364 \ifx\curchaptername\prevchaptername
365 \let\thischapterheading\thischapter
367 % \thischapterheading is the same as \thischapter except it is blank
368 % for the first page of a chapter. This is to prevent the chapter name
370 \def\thischapterheading{}%
373 % Common context changes for both heading and footing.
374 % Do this outside of the \shipout so @code etc. will be expanded in
375 % the headline as they should be, not taken literally (outputting ''code).
376 \def\commmonheadfootline{\let\hsize=\txipagewidth \texinfochars}
378 \global\setbox\headlinebox = \vbox{\commmonheadfootline \makeheadline}%
380 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
381 \global\setbox\footlinebox = \vbox{\commmonheadfootline \makefootline}%
384 % Set context for writing to auxiliary files like index files.
385 % Have to do this stuff outside the \shipout because we want it to
386 % take effect in \write's, yet the group defined by the \vbox ends
387 % before the \shipout runs.
389 \atdummies % don't expand commands in the output.
392 % Do this early so pdf references go to the beginning of the page.
393 \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
397 \ifdim\ht\footlinebox > 0pt
398 % Only leave this space if the footline is nonempty.
399 % (We lessened \vsize for it in \oddfootingyyy.)
400 % The \baselineskip=24pt in plain's \makefootline has no effect.
407 \global\topmarksavedfalse
409 \ifnum\outputpenalty>-20000 \else\dosupereject\fi
412 \newinsert\margin \dimen\margin=\maxdimen
414 % Main part of page, including any footnotes
415 \def\pagebody#1{\vbox to\txipageheight{\boxmaxdepth=\maxdepth #1}}
417 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
418 % marginal hacks, juha@viisa.uucp (Juha Takala)
419 \ifvoid\margin\else % marginal info is present
420 \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
421 \dimen@=\dp#1\relax \unvbox#1\relax
422 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
423 \ifr@ggedbottom \kern-\dimen@ \vfil \fi}
429 % Parse an argument, then pass it to #1. The argument is the rest of
430 % the input line (except we remove a trailing comment). #1 should be a
431 % macro which expects an ordinary undelimited TeX argument.
432 % For example, \def\foo{\parsearg\fooxxx}.
434 \def\parsearg{\parseargusing{}}
435 \def\parseargusing#1#2{%
441 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
445 \gdef\parseargline#1^^M{%
446 \endgroup % End of the group started in \parsearg.
447 \argremovecomment #1\comment\ArgTerm%
451 % First remove any @comment, then any @c comment. Pass the result on to
453 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
454 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
456 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
458 % \argremovec might leave us with trailing space, e.g.,
459 % @end itemize @c foo
460 % This space token undergoes the same procedure and is eventually removed
461 % by \finishparsearg.
463 \def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
464 \def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
465 \def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
468 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
469 \let\temp\finishparsearg
471 \let\temp\argcheckspaces
473 % Put the space token in:
477 % If a _delimited_ argument is enclosed in braces, they get stripped; so
478 % to get _exactly_ the rest of the line, we had to prevent such situation.
479 % We prepended an \empty token at the very beginning and we expand it now,
480 % just before passing the control to \argtorun.
481 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
482 % either the null string, or it ends with \^^M---thus there is no danger
483 % that a pair of braces would be stripped.
485 % But first, we have to remove the trailing space token.
487 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
490 % \parseargdef - define a command taking an argument on the line
492 % \parseargdef\foo{...}
493 % is roughly equivalent to
494 % \def\foo{\parsearg\Xfoo}
497 \expandafter \doparseargdef \csname\string#1\endcsname #1%
499 \def\doparseargdef#1#2{%
504 % Several utility definitions with active space:
509 % Make each space character in the input produce a normal interword
510 % space in the output. Don't allow a line break at this space, as this
511 % is used only in environments like @example, where each line of input
512 % should produce a line of output anyway.
514 \gdef\sepspaces{\obeyspaces\let =\tie}
516 % If an index command is used in an @example environment, any spaces
517 % therein should become regular spaces in the raw index file, not the
518 % expansion of \tie (\leavevmode \penalty \@M \ ).
519 \gdef\unsepspaces{\let =\space}
523 \def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
525 % Define the framework for environments in texinfo.tex. It's used like this:
530 % It's the responsibility of \envdef to insert \begingroup before the
531 % actual body; @end closes the group after calling \Efoo. \envdef also
532 % defines \thisenv, so the current environment is known; @end checks
533 % whether the environment name matches. The \checkenv macro can also be
534 % used to check whether the current environment is the one expected.
536 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
537 % are not treated as environments; they don't open a group. (The
538 % implementation of @end takes care not to call \endgroup in this
542 % At run-time, environments start with this:
543 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
547 % ... but they get defined via ``\envdef\foo{...}'':
548 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
549 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
551 % Check whether we're in the right environment:
560 % Environment mismatch, #1 expected:
563 \errmessage{This command can appear only \inenvironment\temp,
564 not \inenvironment\thisenv}%
566 \def\inenvironment#1{%
568 outside of any environment%
570 in environment \expandafter\string#1%
574 % @end foo executes the definition of \Efoo.
575 % But first, it executes a specialized version of \checkenv
578 \if 1\csname iscond.#1\endcsname
580 % The general wording of \badenverr may not be ideal.
581 \expandafter\checkenv\csname#1\endcsname
582 \csname E#1\endcsname
587 \newhelp\EMsimple{Press RETURN to continue.}
590 % Be sure we're in horizontal mode when doing a tie, since we make space
591 % equivalent to this in @example-like environments. Otherwise, a space
592 % at the beginning of a line will start with \penalty -- and
593 % since \penalty is valid in vertical mode, we'd end up putting the
594 % penalty on the vertical list instead of in the new paragraph.
596 % Avoid using \@M directly, because that causes trouble
597 % if the definition is written into an index file.
598 \global\let\tiepenalty = \@M
599 \gdef\tie{\leavevmode\penalty\tiepenalty\ }
602 % @: forces normal size whitespace following.
603 \def\:{\spacefactor=1000 }
605 % @* forces a line break.
606 \def\*{\unskip\hfil\break\hbox{}\ignorespaces}
608 % @/ allows a line break.
611 % @. is an end-of-sentence period.
612 \def\.{.\spacefactor=\endofsentencespacefactor\space}
614 % @! is an end-of-sentence bang.
615 \def\!{!\spacefactor=\endofsentencespacefactor\space}
617 % @? is an end-of-sentence query.
618 \def\?{?\spacefactor=\endofsentencespacefactor\space}
620 % @frenchspacing on|off says whether to put extra space after punctuation.
625 \parseargdef\frenchspacing{%
627 \ifx\temp\onword \plainfrenchspacing
628 \else\ifx\temp\offword \plainnonfrenchspacing
631 \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
635 % @w prevents a word break. Without the \leavevmode, @w at the
636 % beginning of a paragraph, when TeX is still in vertical mode, would
637 % produce a whole line of output instead of starting the paragraph.
638 \def\w#1{\leavevmode\hbox{#1}}
640 % @group ... @end group forces ... to be all on one page, by enclosing
641 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
642 % to keep its height that of a normal line. According to the rules for
643 % \topskip (p.114 of the TeXbook), the glue inserted is
644 % max (\topskip - \ht (first item), 0). If that height is large,
645 % therefore, no glue is inserted, and the space between the headline and
646 % the text is small, which looks bad.
648 % Another complication is that the group might be very large. This can
649 % cause the glue on the previous page to be unduly stretched, because it
650 % does not have much material. In this case, it's better to add an
651 % explicit \vfill so that the extra space is at the bottom. The
652 % threshold for doing this is if the group is more than \vfilllimit
653 % percent of a page (\vfilllimit can be changed inside of @tex).
659 \ifnum\catcode`\^^M=\active \else
660 \errhelp = \groupinvalidhelp
661 \errmessage{@group invalid in context where filling is enabled}%
665 \setbox\groupbox = \vtop\bgroup
666 % Do @comment since we are called inside an environment such as
667 % @example, where each end-of-line in the input causes an
668 % end-of-line in the output. We don't want the end-of-line after
669 % the `@group' to put extra space in the output. Since @group
670 % should appear on a line by itself (according to the Texinfo
671 % manual), we don't worry about eating any user text.
675 % The \vtop produces a box with normal height and large depth; thus, TeX puts
676 % \baselineskip glue before it, and (when the next line of text is done)
677 % \lineskip glue after it. Thus, space below is not quite equal to space
678 % above. But it's pretty close.
680 % To get correct interline space between the last line of the group
681 % and the first line afterwards, we have to propagate \prevdepth.
682 \endgraf % Not \par, as it may have been set to \lisppar.
683 \global\dimen1 = \prevdepth
684 \egroup % End the \vtop.
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
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
719 % Ensure vertical mode, so we don't make a big box in the middle of a
723 % If the @need value is less than one line space, it's useless.
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.
749 % Back up by the size of the box, whether we did a page break or not.
752 % Do not allow a page break right after this kern.
757 % @br forces paragraph break (and is undocumented).
761 % @page forces the start of a new page.
763 \def\page{\par\vfill\supereject}
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{%
789 \vtop to \strutdepth{%
790 \baselineskip=\strutdepth
792 % if you have multiple lines of stuff to put here, you'll need to
793 % make the vbox yourself of the appropriate size.
795 \llap{\ignorespaces #2\hskip\inmarginspacing}%
797 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
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}%
813 \def\lefttext{#1}% have both texts
816 \def\lefttext{#1}% have only one text
821 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
823 \def\temp{\inleftmargin\lefttext}%
828 % @include FILE -- \input text of FILE.
830 \def\include{\parseargusing\filenamecatcodes\includezzz}
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
847 \def\filenamecatcodes{%
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.}}
878 % outputs that line, centered.
880 \parseargdef\center{%
882 \let\centersub\centerH
884 \let\centersub\centerV
886 \centersub{\hfil \ignorespaces#1\unskip \hfil}%
887 \let\centersub\relax % don't let the definition persist, just in case
891 \advance\hsize by -\leftskip
892 \advance\hsize by -\rightskip
897 \newcount\centerpenalty
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%
921 {\catcode`\^^M=\active \gdef\cxxx#1^^M{\endgroup}}
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
933 \parseargdef\paragraphindent{%
938 \defaultparindent = 0pt
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{%
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
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{%
978 \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
979 \else\ifx\temp\insertword
980 \let\suppressfirstparagraphindent = \relax
983 \errmessage{Unknown @firstparagraphindent option `\temp'}%
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
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 = {}%
1006 % @refill is a no-op.
1009 % @setfilename INFO-FILENAME - ignored
1010 \let\setfilename=\comment
1013 \outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
1017 % adobe `portable' document format
1021 \newcount\filenamelength
1031 \newif\ifpdfmakepagedest
1037 \newif\iftxiuseunicodedestname
1038 \txiuseunicodedestnamefalse % For pdfTeX etc.
1040 \ifx\luatexversion\thisisundefined
1042 % Use Unicode destination names
1043 \txiuseunicodedestnametrue
1044 % Escape PDF strings with converting UTF-16 from UTF-8
1048 function UTF16oct(str)
1049 tex.sprint(string.char(0x5c) .. '376' .. string.char(0x5c) .. '377')
1050 for c in string.utfvalues(str) do
1053 string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
1054 string.char(0x5c) .. string.char(0x25) .. '03o',
1055 math.floor(c / 256), math.floor(c % 256)))
1058 local c_hi = c / 1024 + 0xd800
1059 local c_lo = c % 1024 + 0xdc00
1061 string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
1062 string.char(0x5c) .. string.char(0x25) .. '03o' ..
1063 string.char(0x5c) .. string.char(0x25) .. '03o' ..
1064 string.char(0x5c) .. string.char(0x25) .. '03o',
1065 math.floor(c_hi / 256), math.floor(c_hi % 256),
1066 math.floor(c_lo / 256), math.floor(c_lo % 256)))
1072 \def\pdfescapestrutfsixteen#1{\directlua{UTF16oct('\luaescapestring{#1}')}}
1073 % Escape PDF strings without converting
1076 function PDFescstr(str)
1077 for c in string.bytes(str) do
1078 if c <= 0x20 or c >= 0x80 or c == 0x28 or c == 0x29 or c == 0x5c then
1080 string.format(string.char(0x5c) .. string.char(0x25) .. '03o',
1083 tex.sprint(-2, string.char(c))
1088 % The -2 in the arguments here gives all the input to TeX catcode 12
1089 % (other) or 10 (space), preventing undefined control sequence errors. See
1090 % https://lists.gnu.org/archive/html/bug-texinfo/2019-08/msg00031.html
1093 \def\pdfescapestring#1{\directlua{PDFescstr('\luaescapestring{#1}')}}
1094 \ifnum\luatexversion>84
1095 % For LuaTeX >= 0.85
1096 \def\pdfdest{\pdfextension dest}
1097 \let\pdfoutput\outputmode
1098 \def\pdfliteral{\pdfextension literal}
1099 \def\pdfcatalog{\pdfextension catalog}
1100 \def\pdftexversion{\numexpr\pdffeedback version\relax}
1101 \let\pdfximage\saveimageresource
1102 \let\pdfrefximage\useimageresource
1103 \let\pdflastximage\lastsavedimageresourceindex
1104 \def\pdfendlink{\pdfextension endlink\relax}
1105 \def\pdfoutline{\pdfextension outline}
1106 \def\pdfstartlink{\pdfextension startlink}
1107 \def\pdffontattr{\pdfextension fontattr}
1108 \def\pdfobj{\pdfextension obj}
1109 \def\pdflastobj{\numexpr\pdffeedback lastobj\relax}
1110 \let\pdfpagewidth\pagewidth
1111 \let\pdfpageheight\pageheight
1112 \edef\pdfhorigin{\pdfvariable horigin}
1113 \edef\pdfvorigin{\pdfvariable vorigin}
1117 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1118 % can be set). So we test for \relax and 0 as well as being undefined.
1119 \ifx\pdfoutput\thisisundefined
1121 \ifx\pdfoutput\relax
1135 \ifx\XeTeXrevision\thisisundefined\else
1140 % PDF uses PostScript string constants for the names of xref targets,
1141 % for display in the outlines, and in other places. Thus, we have to
1142 % double any backslashes. Otherwise, a name like "\node" will be
1143 % interpreted as a newline (\n), followed by o, d, e. Not good.
1145 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1146 % related messages. The final outcome is that it is up to the TeX user
1147 % to double the backslashes and otherwise make the string valid, so
1148 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1149 % do this reliably, so we use it.
1151 % #1 is a control sequence in which to do the replacements,
1153 \def\txiescapepdf#1{%
1154 \ifx\pdfescapestring\thisisundefined
1155 % No primitive available; should we give a warning or log?
1156 % Many times it won't matter.
1159 % The expandable \pdfescapestring primitive escapes parentheses,
1160 % backslashes, and other special chars.
1161 \xdef#1{\pdfescapestring{#1}}%
1164 \def\txiescapepdfutfsixteen#1{%
1165 \ifx\pdfescapestrutfsixteen\thisisundefined
1166 % No UTF-16 converting macro available.
1169 \xdef#1{\pdfescapestrutfsixteen{#1}}%
1173 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1174 with PDF output, and none of those formats could be found. (.eps cannot
1175 be supported due to the design of the PDF format; use regular TeX (DVI
1180 % Color manipulation macros using ideas from pdfcolor.tex,
1181 % except using rgb instead of cmyk; the latter is said to render as a
1182 % very dark gray on-screen and a very dark halftone in print, instead
1183 % of actual black. The dark red here is dark enough to print on paper as
1184 % nearly black, but still distinguishable for online viewing. We use
1185 % black by default, though.
1186 \def\rgbDarkRed{0.50 0.09 0.12}
1187 \def\rgbBlack{0 0 0}
1189 % rg sets the color for filling (usual text, etc.);
1190 % RG sets the color for stroking (thin rules, e.g., normal _'s).
1191 \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
1193 % Set color, and create a mark which defines \thiscolor accordingly,
1194 % so that \makeheadline knows which color to restore.
1196 \xdef\currentcolordefs{\gdef\noexpand\thiscolor{#1}}%
1201 \def\maincolor{\rgbBlack}
1202 \pdfsetcolor{\maincolor}
1203 \edef\thiscolor{\maincolor}
1204 \def\currentcolordefs{}
1208 \line{\pdfsetcolor{\maincolor}\the\footline}%
1216 % Extract \thiscolor definition from the marks.
1218 % Typeset the headline with \maincolor, then restore the color.
1219 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1227 \pdfcatalog{/PageMode /UseOutlines}
1229 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1230 \def\dopdfimage#1#2#3{%
1231 \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1232 \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1234 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1235 % others). Let's try in that order, PDF first since if
1236 % someone has a scalable image, presumably better to use that than a
1238 \let\pdfimgext=\empty
1240 \openin 1 #1.pdf \ifeof 1
1241 \openin 1 #1.PDF \ifeof 1
1242 \openin 1 #1.png \ifeof 1
1243 \openin 1 #1.jpg \ifeof 1
1244 \openin 1 #1.jpeg \ifeof 1
1245 \openin 1 #1.JPG \ifeof 1
1246 \errhelp = \nopdfimagehelp
1247 \errmessage{Could not find image file #1 for pdf}%
1248 \else \gdef\pdfimgext{JPG}%
1250 \else \gdef\pdfimgext{jpeg}%
1252 \else \gdef\pdfimgext{jpg}%
1254 \else \gdef\pdfimgext{png}%
1256 \else \gdef\pdfimgext{PDF}%
1258 \else \gdef\pdfimgext{pdf}%
1263 % without \immediate, ancient pdftex seg faults when the same image is
1264 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1265 \ifnum\pdftexversion < 14
1268 \immediate\pdfximage
1270 \ifdim \wd0 >0pt width \pdfimagewidth \fi
1271 \ifdim \wd2 >0pt height \pdfimageheight \fi
1272 \ifnum\pdftexversion<13
1277 \ifnum\pdftexversion < 14 \else
1278 \pdfrefximage \pdflastximage
1281 \def\setpdfdestname#1{{%
1282 % We have to set dummies so commands such as @code, and characters
1283 % such as \, aren't expanded when present in a section title.
1285 \makevalueexpandable
1287 \iftxiuseunicodedestname
1288 \ifx \declaredencoding \latone
1289 % Pass through Latin-1 characters.
1290 % LuaTeX with byte wise I/O converts Latin-1 characters to Unicode.
1292 \ifx \declaredencoding \utfeight
1293 % Pass through Unicode characters.
1295 % Use ASCII approximations in destination names.
1296 \passthroughcharsfalse
1300 % Use ASCII approximations in destination names.
1301 \passthroughcharsfalse
1303 \def\pdfdestname{#1}%
1304 \txiescapepdf\pdfdestname
1307 \def\setpdfoutlinetext#1{{%
1309 \makevalueexpandable
1311 \ifx \declaredencoding \latone
1312 % The PDF format can use an extended form of Latin-1 in bookmark
1313 % strings. See Appendix D of the PDF Reference, Sixth Edition, for
1314 % the "PDFDocEncoding".
1315 \passthroughcharstrue
1316 % Pass through Latin-1 characters.
1317 % LuaTeX: Convert to Unicode
1318 % pdfTeX: Use Latin-1 as PDFDocEncoding
1319 \def\pdfoutlinetext{#1}%
1321 \ifx \declaredencoding \utfeight
1322 \ifx\luatexversion\thisisundefined
1323 % For pdfTeX with UTF-8.
1324 % TODO: the PDF format can use UTF-16 in bookmark strings,
1325 % but the code for this isn't done yet.
1326 % Use ASCII approximations.
1327 \passthroughcharsfalse
1328 \def\pdfoutlinetext{#1}%
1330 % For LuaTeX with UTF-8.
1331 % Pass through Unicode characters for title texts.
1332 \passthroughcharstrue
1333 \def\pdfoutlinetext{#1}%
1336 % For non-Latin-1 or non-UTF-8 encodings.
1337 % Use ASCII approximations.
1338 \passthroughcharsfalse
1339 \def\pdfoutlinetext{#1}%
1342 % LuaTeX: Convert to UTF-16
1343 % pdfTeX: Use Latin-1 as PDFDocEncoding
1344 \txiescapepdfutfsixteen\pdfoutlinetext
1348 \setpdfdestname{#1}%
1349 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1352 % used to mark target names; must be expandable.
1355 % by default, use black for everything.
1356 \def\urlcolor{\rgbBlack}
1357 \def\linkcolor{\rgbBlack}
1358 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1360 % Adding outlines to PDF; macros for calculating structure of outlines
1361 % come from Petr Olsak
1362 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1363 \else \csname#1\endcsname \fi}
1364 \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
1365 \advance\tempnum by 1
1366 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1368 % #1 is the section text, which is what will be displayed in the
1369 % outline by the pdf viewer. #2 is the pdf expression for the number
1370 % of subentries (or empty, for subsubsections). #3 is the node text,
1371 % which might be empty if this toc entry had no corresponding node.
1372 % #4 is the page number
1374 \def\dopdfoutline#1#2#3#4{%
1375 % Generate a link to the node text if that exists; else, use the
1376 % page number. We could generate a destination for the section
1377 % text in the case where a section has no node, but it doesn't
1378 % seem worth the trouble, since most documents are normally structured.
1379 \setpdfoutlinetext{#1}
1381 \ifx\pdfdestname\empty
1382 \def\pdfdestname{#4}%
1385 \pdfoutline goto name{\pdfmkpgn{\pdfdestname}}#2{\pdfoutlinetext}%
1388 \def\pdfmakeoutlines{%
1390 % Read toc silently, to get counts of subentries for \pdfoutline.
1391 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1392 \def\numchapentry##1##2##3##4{%
1393 \def\thischapnum{##2}%
1395 \def\thissubsecnum{0}%
1397 \def\numsecentry##1##2##3##4{%
1398 \advancenumber{chap\thischapnum}%
1399 \def\thissecnum{##2}%
1400 \def\thissubsecnum{0}%
1402 \def\numsubsecentry##1##2##3##4{%
1403 \advancenumber{sec\thissecnum}%
1404 \def\thissubsecnum{##2}%
1406 \def\numsubsubsecentry##1##2##3##4{%
1407 \advancenumber{subsec\thissubsecnum}%
1409 \def\thischapnum{0}%
1411 \def\thissubsecnum{0}%
1413 % use \def rather than \let here because we redefine \chapentry et
1414 % al. a second time, below.
1415 \def\appentry{\numchapentry}%
1416 \def\appsecentry{\numsecentry}%
1417 \def\appsubsecentry{\numsubsecentry}%
1418 \def\appsubsubsecentry{\numsubsubsecentry}%
1419 \def\unnchapentry{\numchapentry}%
1420 \def\unnsecentry{\numsecentry}%
1421 \def\unnsubsecentry{\numsubsecentry}%
1422 \def\unnsubsubsecentry{\numsubsubsecentry}%
1425 % Read toc second time, this time actually producing the outlines.
1426 % The `-' means take the \expnumber as the absolute number of
1427 % subentries, which we calculated on our first read of the .toc above.
1429 % We use the node names as the destinations.
1430 \def\numchapentry##1##2##3##4{%
1431 \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
1432 \def\numsecentry##1##2##3##4{%
1433 \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
1434 \def\numsubsecentry##1##2##3##4{%
1435 \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
1436 \def\numsubsubsecentry##1##2##3##4{% count is always zero
1437 \dopdfoutline{##1}{}{##3}{##4}}%
1439 % PDF outlines are displayed using system fonts, instead of
1440 % document fonts. Therefore we cannot use special characters,
1441 % since the encoding is unknown. For example, the eogonek from
1442 % Latin 2 (0xea) gets translated to a | character. Info from
1443 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1445 % TODO this right, we have to translate 8-bit characters to
1446 % their "best" equivalent, based on the @documentencoding. Too
1447 % much work for too little return. Just use the ASCII equivalents
1448 % we use for the index sort strings.
1452 % We can have normal brace characters in the PDF outlines, unlike
1453 % Texinfo index files. So set that up.
1454 \def\{{\lbracecharliteral}%
1455 \def\}{\rbracecharliteral}%
1456 \catcode`\\=\active \otherbackslash
1457 \input \tocreadfilename
1460 {\catcode`[=1 \catcode`]=2
1461 \catcode`{=\other \catcode`}=\other
1462 \gdef\lbracecharliteral[{]%
1463 \gdef\rbracecharliteral[}]%
1466 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1467 \ifx\PP\D\let\nextsp\relax
1468 \else\let\nextsp\skipspaces
1469 \addtokens{\filename}{\PP}%
1470 \advance\filenamelength by 1
1473 \def\getfilename#1{%
1475 % If we don't expand the argument now, \skipspaces will get
1476 % snagged on things like "@value{foo}".
1478 \expandafter\skipspaces\temp|\relax
1480 \ifnum\pdftexversion < 14
1481 \let \startlink \pdfannotlink
1483 \let \startlink \pdfstartlink
1485 % make a live url in pdf output.
1488 % it seems we really need yet another set of dummies; have not
1489 % tried to figure out what each command should do in the context
1490 % of @url. for now, just make @/ a no-op, that's the only one
1491 % people have actually reported a problem with.
1493 \normalturnoffactive
1496 \makevalueexpandable
1497 % do we want to go so far as to use \indexnofonts instead of just
1498 % special-casing \var here?
1501 \leavevmode\setcolor{\urlcolor}%
1502 \startlink attr{/Border [0 0 0]}%
1503 user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
1505 % \pdfgettoks - Surround page numbers in #1 with @pdflink. #1 may
1506 % be a simple number, or a list of numbers in the case of an index
1508 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1509 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1510 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1511 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1513 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1515 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1516 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1517 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1519 \ifnum0=\countA\else\makelink\fi
1520 \ifx\first.\let\next=\done\else
1522 \addtokens{\toksB}{\the\toksD}
1523 \ifx\first,\addtokens{\toksB}{\space}\fi
1525 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1527 \def\makelink{\addtokens{\toksB}%
1528 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1530 \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
1531 \setcolor{\linkcolor}#1\endlink}
1532 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1535 \let\pdfmkdest = \gobble
1536 \let\pdfurl = \gobble
1537 \let\endlink = \relax
1538 \let\setcolor = \gobble
1539 \let\pdfsetcolor = \gobble
1540 \let\pdfmakeoutlines = \relax
1541 \fi % \ifx\pdfoutput
1546 \ifx\XeTeXrevision\thisisundefined
1549 % XeTeX version check
1551 \ifnum\strcmp{\the\XeTeXversion\XeTeXrevision}{0.99996}>-1
1552 % TeX Live 2016 contains XeTeX 0.99996 and xdvipdfmx 20160307.
1553 % It can use the `dvipdfmx:config' special (from TeX Live SVN r40941).
1554 % For avoiding PDF destination name replacement, we use this special
1555 % instead of xdvipdfmx's command line option `-C 0x0010'.
1556 \special{dvipdfmx:config C 0x0010}
1557 % XeTeX 0.99995+ comes with xdvipdfmx 20160307+.
1558 % It can handle Unicode destination names for PDF.
1559 \txiuseunicodedestnametrue
1561 % XeTeX < 0.99996 (TeX Live < 2016) cannot use the
1562 % `dvipdfmx:config' special.
1563 % So for avoiding PDF destination name replacement,
1564 % xdvipdfmx's command line option `-C 0x0010' is necessary.
1566 % XeTeX < 0.99995 can not handle Unicode destination names for PDF
1567 % because xdvipdfmx 20150315 has a UTF-16 conversion issue.
1568 % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
1569 \txiuseunicodedestnamefalse
1574 \def\rgbDarkRed{0.50 0.09 0.12}
1575 \def\rgbBlack{0 0 0}
1577 \def\pdfsetcolor#1{\special{pdf:scolor [#1]}}
1579 % Set color, and create a mark which defines \thiscolor accordingly,
1580 % so that \makeheadline knows which color to restore.
1582 \xdef\currentcolordefs{\gdef\noexpand\thiscolor{#1}}%
1587 \def\maincolor{\rgbBlack}
1588 \pdfsetcolor{\maincolor}
1589 \edef\thiscolor{\maincolor}
1590 \def\currentcolordefs{}
1594 \line{\pdfsetcolor{\maincolor}\the\footline}%
1602 % Extract \thiscolor definition from the marks.
1604 % Typeset the headline with \maincolor, then restore the color.
1605 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1612 % PDF outline support
1614 % Emulate pdfTeX primitive
1615 \def\pdfdest name#1 xyz{%
1616 \special{pdf:dest (#1) [@thispage /XYZ @xpos @ypos null]}%
1619 \def\setpdfdestname#1{{%
1620 % We have to set dummies so commands such as @code, and characters
1621 % such as \, aren't expanded when present in a section title.
1623 \makevalueexpandable
1625 \iftxiuseunicodedestname
1626 % Pass through Unicode characters.
1628 % Use ASCII approximations in destination names.
1629 \passthroughcharsfalse
1631 \def\pdfdestname{#1}%
1632 \txiescapepdf\pdfdestname
1635 \def\setpdfoutlinetext#1{{%
1637 % Always use Unicode characters in title texts.
1638 \def\pdfoutlinetext{#1}%
1639 % For XeTeX, xdvipdfmx converts to UTF-16.
1640 % So we do not convert.
1641 \txiescapepdf\pdfoutlinetext
1645 \setpdfdestname{#1}%
1646 \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
1649 % by default, use black for everything.
1650 \def\urlcolor{\rgbBlack}
1651 \def\linkcolor{\rgbBlack}
1652 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1654 \def\dopdfoutline#1#2#3#4{%
1655 \setpdfoutlinetext{#1}
1657 \ifx\pdfdestname\empty
1658 \def\pdfdestname{#4}%
1661 \special{pdf:out [-] #2 << /Title (\pdfoutlinetext) /A
1662 << /S /GoTo /D (\pdfdestname) >> >> }%
1665 \def\pdfmakeoutlines{%
1668 % For XeTeX, counts of subentries are not necessary.
1669 % Therefore, we read toc only once.
1671 % We use node names as destinations.
1672 \def\partentry##1##2##3##4{}% ignore parts in the outlines
1673 \def\numchapentry##1##2##3##4{%
1674 \dopdfoutline{##1}{1}{##3}{##4}}%
1675 \def\numsecentry##1##2##3##4{%
1676 \dopdfoutline{##1}{2}{##3}{##4}}%
1677 \def\numsubsecentry##1##2##3##4{%
1678 \dopdfoutline{##1}{3}{##3}{##4}}%
1679 \def\numsubsubsecentry##1##2##3##4{%
1680 \dopdfoutline{##1}{4}{##3}{##4}}%
1682 \let\appentry\numchapentry%
1683 \let\appsecentry\numsecentry%
1684 \let\appsubsecentry\numsubsecentry%
1685 \let\appsubsubsecentry\numsubsubsecentry%
1686 \let\unnchapentry\numchapentry%
1687 \let\unnsecentry\numsecentry%
1688 \let\unnsubsecentry\numsubsecentry%
1689 \let\unnsubsubsecentry\numsubsubsecentry%
1691 % For XeTeX, xdvipdfmx converts strings to UTF-16.
1692 % Therefore, the encoding and the language may not be considered.
1696 % We can have normal brace characters in the PDF outlines, unlike
1697 % Texinfo index files. So set that up.
1698 \def\{{\lbracecharliteral}%
1699 \def\}{\rbracecharliteral}%
1700 \catcode`\\=\active \otherbackslash
1701 \input \tocreadfilename
1704 {\catcode`[=1 \catcode`]=2
1705 \catcode`{=\other \catcode`}=\other
1706 \gdef\lbracecharliteral[{]%
1707 \gdef\rbracecharliteral[}]%
1710 \special{pdf:docview << /PageMode /UseOutlines >> }
1711 % ``\special{pdf:tounicode ...}'' is not necessary
1712 % because xdvipdfmx converts strings from UTF-8 to UTF-16 without it.
1713 % However, due to a UTF-16 conversion issue of xdvipdfmx 20150315,
1714 % ``\special{pdf:dest ...}'' cannot handle non-ASCII strings.
1715 % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
1717 \def\skipspaces#1{\def\PP{#1}\def\D{|}%
1718 \ifx\PP\D\let\nextsp\relax
1719 \else\let\nextsp\skipspaces
1720 \addtokens{\filename}{\PP}%
1721 \advance\filenamelength by 1
1724 \def\getfilename#1{%
1726 % If we don't expand the argument now, \skipspaces will get
1727 % snagged on things like "@value{foo}".
1729 \expandafter\skipspaces\temp|\relax
1731 % make a live url in pdf output.
1734 % it seems we really need yet another set of dummies; have not
1735 % tried to figure out what each command should do in the context
1736 % of @url. for now, just make @/ a no-op, that's the only one
1737 % people have actually reported a problem with.
1739 \normalturnoffactive
1742 \makevalueexpandable
1743 % do we want to go so far as to use \indexnofonts instead of just
1744 % special-casing \var here?
1747 \leavevmode\setcolor{\urlcolor}%
1748 \special{pdf:bann << /Border [0 0 0]
1749 /Subtype /Link /A << /S /URI /URI (#1) >> >>}%
1751 \def\endlink{\setcolor{\maincolor}\special{pdf:eann}}
1752 \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
1753 \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
1754 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
1755 \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
1757 \expandafter\poptoks\the\toksA|ENDTOKS|\relax
1759 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1760 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1761 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1763 \ifnum0=\countA\else\makelink\fi
1764 \ifx\first.\let\next=\done\else
1766 \addtokens{\toksB}{\the\toksD}
1767 \ifx\first,\addtokens{\toksB}{\space}\fi
1769 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1771 \def\makelink{\addtokens{\toksB}%
1772 {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
1774 \special{pdf:bann << /Border [0 0 0]
1775 /Type /Annot /Subtype /Link /A << /S /GoTo /D (#1) >> >>}%
1776 \setcolor{\linkcolor}#1\endlink}
1777 \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
1782 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1783 \def\doxeteximage#1#2#3{%
1784 \def\xeteximagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
1785 \def\xeteximageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
1787 % XeTeX (and the PDF format) supports .pdf, .png, .jpg (among
1788 % others). Let's try in that order, PDF first since if
1789 % someone has a scalable image, presumably better to use that than a
1791 \let\xeteximgext=\empty
1793 \openin 1 #1.pdf \ifeof 1
1794 \openin 1 #1.PDF \ifeof 1
1795 \openin 1 #1.png \ifeof 1
1796 \openin 1 #1.jpg \ifeof 1
1797 \openin 1 #1.jpeg \ifeof 1
1798 \openin 1 #1.JPG \ifeof 1
1799 \errmessage{Could not find image file #1 for XeTeX}%
1800 \else \gdef\xeteximgext{JPG}%
1802 \else \gdef\xeteximgext{jpeg}%
1804 \else \gdef\xeteximgext{jpg}%
1806 \else \gdef\xeteximgext{png}%
1808 \else \gdef\xeteximgext{PDF}%
1810 \else \gdef\xeteximgext{pdf}%
1815 \def\xetexpdfext{pdf}%
1816 \ifx\xeteximgext\xetexpdfext
1817 \XeTeXpdffile "#1".\xeteximgext ""
1819 \def\xetexpdfext{PDF}%
1820 \ifx\xeteximgext\xetexpdfext
1821 \XeTeXpdffile "#1".\xeteximgext ""
1823 \XeTeXpicfile "#1".\xeteximgext ""
1826 \ifdim \wd0 >0pt width \xeteximagewidth \fi
1827 \ifdim \wd2 >0pt height \xeteximageheight \fi \relax
1835 % Set the baselineskip to #1, and the lineskip and strut size
1836 % correspondingly. There is no deep meaning behind these magic numbers
1837 % used as factors; they just match (closely enough) what Knuth defined.
1839 \def\lineskipfactor{.08333}
1840 \def\strutheightpercent{.70833}
1841 \def\strutdepthpercent {.29167}
1843 % can get a sort of poor man's double spacing by redefining this.
1844 \def\baselinefactor{1}
1846 \newdimen\textleading
1849 \normalbaselineskip = \baselinefactor\dimen0
1850 \normallineskip = \lineskipfactor\normalbaselineskip
1852 \setbox\strutbox =\hbox{%
1853 \vrule width0pt height\strutheightpercent\baselineskip
1854 depth \strutdepthpercent \baselineskip
1858 % PDF CMaps. See also LaTeX's t1.cmap.
1860 % do nothing with this by default.
1861 \expandafter\let\csname cmapOT1\endcsname\gobble
1862 \expandafter\let\csname cmapOT1IT\endcsname\gobble
1863 \expandafter\let\csname cmapOT1TT\endcsname\gobble
1865 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1866 % (\pdffontattr was introduced many years ago, but people still run
1867 % older pdftex's; it's easy to conditionalize, so we do.)
1868 \ifpdf \ifx\pdffontattr\thisisundefined \else
1870 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1871 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1872 %%DocumentNeededResources: ProcSet (CIDInit)
1873 %%IncludeResource: ProcSet (CIDInit)
1874 %%BeginResource: CMap (TeX-OT1-0)
1875 %%Title: (TeX-OT1-0 TeX OT1 0)
1878 /CIDInit /ProcSet findresource begin
1886 /CMapName /TeX-OT1-0 def
1888 1 begincodespacerange
1944 CMapName currentdict /CMap defineresource pop
1950 \expandafter\edef\csname cmapOT1\endcsname#1{%
1951 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
1956 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
1957 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
1958 %%DocumentNeededResources: ProcSet (CIDInit)
1959 %%IncludeResource: ProcSet (CIDInit)
1960 %%BeginResource: CMap (TeX-OT1IT-0)
1961 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1964 /CIDInit /ProcSet findresource begin
1972 /CMapName /TeX-OT1IT-0 def
1974 1 begincodespacerange
2032 CMapName currentdict /CMap defineresource pop
2038 \expandafter\edef\csname cmapOT1IT\endcsname#1{%
2039 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
2044 \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
2045 \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
2046 %%DocumentNeededResources: ProcSet (CIDInit)
2047 %%IncludeResource: ProcSet (CIDInit)
2048 %%BeginResource: CMap (TeX-OT1TT-0)
2049 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
2052 /CIDInit /ProcSet findresource begin
2060 /CMapName /TeX-OT1TT-0 def
2062 1 begincodespacerange
2107 CMapName currentdict /CMap defineresource pop
2113 \expandafter\edef\csname cmapOT1TT\endcsname#1{%
2114 \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
2119 % Set the font macro #1 to the font named \fontprefix#2.
2120 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
2121 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
2129 \def\setfont#1#2#3#4#5{%
2130 \font#1=\fontprefix#2#3 scaled #4
2131 \csname cmap#5\endcsname#1%
2133 % This is what gets called when #5 of \setfont is empty.
2138 % Use cm as the default font prefix.
2139 % To specify the font prefix, you must define \fontprefix
2140 % before you read in texinfo.tex.
2141 \ifx\fontprefix\thisisundefined
2144 % Support font families that don't use the same naming scheme as CM.
2146 \def\rmbshape{bx} % where the normal face is bold
2151 \def\ttslshape{sltt}
2161 % Definitions for a main text size of 11pt. (The default in Texinfo.)
2163 \def\definetextfontsizexi{%
2164 % Text fonts (11.2pt, magstep1).
2165 \def\textnominalsize{11pt}
2166 \edef\mainmagstep{\magstephalf}
2167 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2168 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2169 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2170 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2171 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2172 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2173 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2174 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2175 \font\texti=cmmi10 scaled \mainmagstep
2176 \font\textsy=cmsy10 scaled \mainmagstep
2177 \def\textecsize{1095}
2179 % A few fonts for @defun names and args.
2180 \setfont\defbf\bfshape{10}{\magstep1}{OT1}
2181 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
2182 \setfont\defsl\slshape{10}{\magstep1}{OT1}
2183 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
2184 \def\df{\let\ttfont=\deftt \let\bffont = \defbf
2185 \let\ttslfont=\defttsl \let\slfont=\defsl \bf}
2187 % Fonts for indices, footnotes, small examples (9pt).
2188 \def\smallnominalsize{9pt}
2189 \setfont\smallrm\rmshape{9}{1000}{OT1}
2190 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2191 \setfont\smallbf\bfshape{10}{900}{OT1}
2192 \setfont\smallit\itshape{9}{1000}{OT1IT}
2193 \setfont\smallsl\slshape{9}{1000}{OT1}
2194 \setfont\smallsf\sfshape{9}{1000}{OT1}
2195 \setfont\smallsc\scshape{10}{900}{OT1}
2196 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2199 \def\smallecsize{0900}
2201 % Fonts for small examples (8pt).
2202 \def\smallernominalsize{8pt}
2203 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2204 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2205 \setfont\smallerbf\bfshape{10}{800}{OT1}
2206 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2207 \setfont\smallersl\slshape{8}{1000}{OT1}
2208 \setfont\smallersf\sfshape{8}{1000}{OT1}
2209 \setfont\smallersc\scshape{10}{800}{OT1}
2210 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2211 \font\smalleri=cmmi8
2212 \font\smallersy=cmsy8
2213 \def\smallerecsize{0800}
2215 % Fonts for math mode superscripts (7pt).
2216 \def\sevennominalsize{7pt}
2217 \setfont\sevenrm\rmshape{7}{1000}{OT1}
2218 \setfont\seventt\ttshape{10}{700}{OT1TT}
2219 \setfont\sevenbf\bfshape{10}{700}{OT1}
2220 \setfont\sevenit\itshape{7}{1000}{OT1IT}
2221 \setfont\sevensl\slshape{10}{700}{OT1}
2222 \setfont\sevensf\sfshape{10}{700}{OT1}
2223 \setfont\sevensc\scshape{10}{700}{OT1}
2224 \setfont\seventtsl\ttslshape{10}{700}{OT1TT}
2227 \def\sevenecsize{0700}
2229 % Fonts for title page (20.4pt):
2230 \def\titlenominalsize{20pt}
2231 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2232 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2233 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2234 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2235 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2236 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2237 \let\titlebf=\titlerm
2238 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2239 \font\titlei=cmmi12 scaled \magstep3
2240 \font\titlesy=cmsy10 scaled \magstep4
2241 \def\titleecsize{2074}
2243 % Chapter (and unnumbered) fonts (17.28pt).
2244 \def\chapnominalsize{17pt}
2245 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
2246 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
2247 \setfont\chapsl\slbshape{10}{\magstep3}{OT1}
2248 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
2249 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
2250 \setfont\chapsf\sfbshape{17}{1000}{OT1}
2252 \setfont\chapsc\scbshape{10}{\magstep3}{OT1}
2253 \font\chapi=cmmi12 scaled \magstep2
2254 \font\chapsy=cmsy10 scaled \magstep3
2255 \def\chapecsize{1728}
2257 % Section fonts (14.4pt).
2258 \def\secnominalsize{14pt}
2259 \setfont\secrm\rmbshape{12}{\magstep1}{OT1}
2260 \setfont\secrmnotbold\rmshape{12}{\magstep1}{OT1}
2261 \setfont\secit\itbshape{10}{\magstep2}{OT1IT}
2262 \setfont\secsl\slbshape{10}{\magstep2}{OT1}
2263 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
2264 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
2265 \setfont\secsf\sfbshape{12}{\magstep1}{OT1}
2267 \setfont\secsc\scbshape{10}{\magstep2}{OT1}
2268 \font\seci=cmmi12 scaled \magstep1
2269 \font\secsy=cmsy10 scaled \magstep2
2270 \def\sececsize{1440}
2272 % Subsection fonts (13.15pt).
2273 \def\ssecnominalsize{13pt}
2274 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
2275 \setfont\ssecit\itbshape{10}{1315}{OT1IT}
2276 \setfont\ssecsl\slbshape{10}{1315}{OT1}
2277 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
2278 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
2279 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
2281 \setfont\ssecsc\scbshape{10}{1315}{OT1}
2282 \font\sseci=cmmi12 scaled \magstephalf
2283 \font\ssecsy=cmsy10 scaled 1315
2284 \def\ssececsize{1200}
2286 % Reduced fonts for @acronym in text (10pt).
2287 \def\reducednominalsize{10pt}
2288 \setfont\reducedrm\rmshape{10}{1000}{OT1}
2289 \setfont\reducedtt\ttshape{10}{1000}{OT1TT}
2290 \setfont\reducedbf\bfshape{10}{1000}{OT1}
2291 \setfont\reducedit\itshape{10}{1000}{OT1IT}
2292 \setfont\reducedsl\slshape{10}{1000}{OT1}
2293 \setfont\reducedsf\sfshape{10}{1000}{OT1}
2294 \setfont\reducedsc\scshape{10}{1000}{OT1}
2295 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
2296 \font\reducedi=cmmi10
2297 \font\reducedsy=cmsy10
2298 \def\reducedecsize{1000}
2300 \textleading = 13.2pt % line spacing for 11pt CM
2301 \textfonts % reset the current fonts
2303 } % end of 11pt text font size definitions, \definetextfontsizexi
2306 % Definitions to make the main text be 10pt Computer Modern, with
2307 % section, chapter, etc., sizes following suit. This is for the GNU
2308 % Press printing of the Emacs 22 manual. Maybe other manuals in the
2309 % future. Used with @smallbook, which sets the leading to 12pt.
2311 \def\definetextfontsizex{%
2312 % Text fonts (10pt).
2313 \def\textnominalsize{10pt}
2314 \edef\mainmagstep{1000}
2315 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
2316 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
2317 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
2318 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
2319 \setfont\textsl\slshape{10}{\mainmagstep}{OT1}
2320 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
2321 \setfont\textsc\scshape{10}{\mainmagstep}{OT1}
2322 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
2323 \font\texti=cmmi10 scaled \mainmagstep
2324 \font\textsy=cmsy10 scaled \mainmagstep
2325 \def\textecsize{1000}
2327 % A few fonts for @defun names and args.
2328 \setfont\defbf\bfshape{10}{\magstephalf}{OT1}
2329 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
2330 \setfont\defsl\slshape{10}{\magstephalf}{OT1}
2331 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
2332 \def\df{\let\ttfont=\deftt \let\bffont = \defbf
2333 \let\slfont=\defsl \let\ttslfont=\defttsl \bf}
2335 % Fonts for indices, footnotes, small examples (9pt).
2336 \def\smallnominalsize{9pt}
2337 \setfont\smallrm\rmshape{9}{1000}{OT1}
2338 \setfont\smalltt\ttshape{9}{1000}{OT1TT}
2339 \setfont\smallbf\bfshape{10}{900}{OT1}
2340 \setfont\smallit\itshape{9}{1000}{OT1IT}
2341 \setfont\smallsl\slshape{9}{1000}{OT1}
2342 \setfont\smallsf\sfshape{9}{1000}{OT1}
2343 \setfont\smallsc\scshape{10}{900}{OT1}
2344 \setfont\smallttsl\ttslshape{10}{900}{OT1TT}
2347 \def\smallecsize{0900}
2349 % Fonts for small examples (8pt).
2350 \def\smallernominalsize{8pt}
2351 \setfont\smallerrm\rmshape{8}{1000}{OT1}
2352 \setfont\smallertt\ttshape{8}{1000}{OT1TT}
2353 \setfont\smallerbf\bfshape{10}{800}{OT1}
2354 \setfont\smallerit\itshape{8}{1000}{OT1IT}
2355 \setfont\smallersl\slshape{8}{1000}{OT1}
2356 \setfont\smallersf\sfshape{8}{1000}{OT1}
2357 \setfont\smallersc\scshape{10}{800}{OT1}
2358 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
2359 \font\smalleri=cmmi8
2360 \font\smallersy=cmsy8
2361 \def\smallerecsize{0800}
2363 % Fonts for math mode superscripts (7pt).
2364 \def\sevennominalsize{7pt}
2365 \setfont\sevenrm\rmshape{7}{1000}{OT1}
2366 \setfont\seventt\ttshape{10}{700}{OT1TT}
2367 \setfont\sevenbf\bfshape{10}{700}{OT1}
2368 \setfont\sevenit\itshape{7}{1000}{OT1IT}
2369 \setfont\sevensl\slshape{10}{700}{OT1}
2370 \setfont\sevensf\sfshape{10}{700}{OT1}
2371 \setfont\sevensc\scshape{10}{700}{OT1}
2372 \setfont\seventtsl\ttslshape{10}{700}{OT1TT}
2375 \def\sevenecsize{0700}
2377 % Fonts for title page (20.4pt):
2378 \def\titlenominalsize{20pt}
2379 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
2380 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
2381 \setfont\titlesl\slbshape{10}{\magstep4}{OT1}
2382 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
2383 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
2384 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
2385 \let\titlebf=\titlerm
2386 \setfont\titlesc\scbshape{10}{\magstep4}{OT1}
2387 \font\titlei=cmmi12 scaled \magstep3
2388 \font\titlesy=cmsy10 scaled \magstep4
2389 \def\titleecsize{2074}
2391 % Chapter fonts (14.4pt).
2392 \def\chapnominalsize{14pt}
2393 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
2394 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
2395 \setfont\chapsl\slbshape{10}{\magstep2}{OT1}
2396 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
2397 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
2398 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
2400 \setfont\chapsc\scbshape{10}{\magstep2}{OT1}
2401 \font\chapi=cmmi12 scaled \magstep1
2402 \font\chapsy=cmsy10 scaled \magstep2
2403 \def\chapecsize{1440}
2405 % Section fonts (12pt).
2406 \def\secnominalsize{12pt}
2407 \setfont\secrm\rmbshape{12}{1000}{OT1}
2408 \setfont\secit\itbshape{10}{\magstep1}{OT1IT}
2409 \setfont\secsl\slbshape{10}{\magstep1}{OT1}
2410 \setfont\sectt\ttbshape{12}{1000}{OT1TT}
2411 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
2412 \setfont\secsf\sfbshape{12}{1000}{OT1}
2414 \setfont\secsc\scbshape{10}{\magstep1}{OT1}
2416 \font\secsy=cmsy10 scaled \magstep1
2417 \def\sececsize{1200}
2419 % Subsection fonts (10pt).
2420 \def\ssecnominalsize{10pt}
2421 \setfont\ssecrm\rmbshape{10}{1000}{OT1}
2422 \setfont\ssecit\itbshape{10}{1000}{OT1IT}
2423 \setfont\ssecsl\slbshape{10}{1000}{OT1}
2424 \setfont\ssectt\ttbshape{10}{1000}{OT1TT}
2425 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
2426 \setfont\ssecsf\sfbshape{10}{1000}{OT1}
2428 \setfont\ssecsc\scbshape{10}{1000}{OT1}
2431 \def\ssececsize{1000}
2433 % Reduced fonts for @acronym in text (9pt).
2434 \def\reducednominalsize{9pt}
2435 \setfont\reducedrm\rmshape{9}{1000}{OT1}
2436 \setfont\reducedtt\ttshape{9}{1000}{OT1TT}
2437 \setfont\reducedbf\bfshape{10}{900}{OT1}
2438 \setfont\reducedit\itshape{9}{1000}{OT1IT}
2439 \setfont\reducedsl\slshape{9}{1000}{OT1}
2440 \setfont\reducedsf\sfshape{9}{1000}{OT1}
2441 \setfont\reducedsc\scshape{10}{900}{OT1}
2442 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
2443 \font\reducedi=cmmi9
2444 \font\reducedsy=cmsy9
2445 \def\reducedecsize{0900}
2447 \divide\parskip by 2 % reduce space between paragraphs
2448 \textleading = 12pt % line spacing for 10pt CM
2449 \textfonts % reset the current fonts
2451 } % end of 10pt text font size definitions, \definetextfontsizex
2453 % Fonts for short table of contents.
2454 \setfont\shortcontrm\rmshape{12}{1000}{OT1}
2455 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
2456 \setfont\shortcontsl\slshape{12}{1000}{OT1}
2457 \setfont\shortconttt\ttshape{12}{1000}{OT1TT}
2460 % We provide the user-level command
2462 % (or 11) to redefine the text font size. pt is assumed.
2468 \parseargdef\fonttextsize{%
2469 \def\textsizearg{#1}%
2470 %\wlog{doing @fonttextsize \textsizearg}%
2472 % Set \globaldefs so that documents can use this inside @tex, since
2473 % makeinfo 4.8 does not support it, but we need it nonetheless.
2475 \begingroup \globaldefs=1
2476 \ifx\textsizearg\xword \definetextfontsizex
2477 \else \ifx\textsizearg\xiword \definetextfontsizexi
2480 \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
2486 % Change the current font style to #1, remembering it in \curfontstyle.
2487 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
2488 % italics, not bold italics.
2490 \def\setfontstyle#1{%
2491 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
2492 \csname #1font\endcsname % change the current font
2495 \def\rm{\fam=0 \setfontstyle{rm}}
2496 \def\it{\fam=\itfam \setfontstyle{it}}
2497 \def\sl{\fam=\slfam \setfontstyle{sl}}
2498 \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
2499 \def\tt{\fam=\ttfam \setfontstyle{tt}}
2501 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
2502 % So we set up a \sf.
2504 \def\sf{\fam=\sffam \setfontstyle{sf}}
2506 % We don't need math for this font style.
2507 \def\ttsl{\setfontstyle{ttsl}}
2510 % In order for the font changes to affect most math symbols and letters,
2511 % we have to define the \textfont of the standard families.
2512 % We don't bother to reset \scriptscriptfont; awaiting user need.
2514 \def\resetmathfonts{%
2515 \textfont0=\rmfont \textfont1=\ifont \textfont2=\syfont
2516 \textfont\itfam=\itfont \textfont\slfam=\slfont \textfont\bffam=\bffont
2517 \textfont\ttfam=\ttfont \textfont\sffam=\sffont
2519 % Fonts for superscript. Note that the 7pt fonts are used regardless
2520 % of the current font size.
2521 \scriptfont0=\sevenrm \scriptfont1=\seveni \scriptfont2=\sevensy
2522 \scriptfont\itfam=\sevenit \scriptfont\slfam=\sevensl
2523 \scriptfont\bffam=\sevenbf \scriptfont\ttfam=\seventt
2524 \scriptfont\sffam=\sevensf
2529 % The font-changing commands (all called \...fonts) redefine the meanings
2530 % of \STYLEfont, instead of just \STYLE. We do this because \STYLE needs
2531 % to also set the current \fam for math mode. Our \STYLE (e.g., \rm)
2532 % commands hardwire \STYLEfont to set the current font.
2534 % The fonts used for \ifont are for "math italics" (\itfont is for italics
2535 % in regular text). \syfont is also used in math mode only.
2537 % Each font-changing command also sets the names \lsize (one size lower)
2538 % and \lllsize (three sizes lower). These relative commands are used
2539 % in, e.g., the LaTeX logo and acronyms.
2541 % This all needs generalizing, badly.
2544 \def\assignfonts#1{%
2545 \expandafter\let\expandafter\rmfont\csname #1rm\endcsname
2546 \expandafter\let\expandafter\itfont\csname #1it\endcsname
2547 \expandafter\let\expandafter\slfont\csname #1sl\endcsname
2548 \expandafter\let\expandafter\bffont\csname #1bf\endcsname
2549 \expandafter\let\expandafter\ttfont\csname #1tt\endcsname
2550 \expandafter\let\expandafter\smallcaps\csname #1sc\endcsname
2551 \expandafter\let\expandafter\sffont \csname #1sf\endcsname
2552 \expandafter\let\expandafter\ifont \csname #1i\endcsname
2553 \expandafter\let\expandafter\syfont \csname #1sy\endcsname
2554 \expandafter\let\expandafter\ttslfont\csname #1ttsl\endcsname
2559 % Select smaller font size with the current style. Used to change font size
2560 % in, e.g., the LaTeX logo and acronyms. If we are using bold fonts for
2561 % normal roman text, also use bold fonts for roman text in the smaller size.
2562 \def\switchtolllsize{%
2563 \expandafter\assignfonts\expandafter{\lllsize}%
2567 \csname\curfontstyle\endcsname
2570 \def\switchtolsize{%
2571 \expandafter\assignfonts\expandafter{\lsize}%
2575 \csname\curfontstyle\endcsname
2578 \def\definefontsetatsize#1#2#3#4#5{%
2579 \expandafter\def\csname #1fonts\endcsname{%
2580 \def\curfontsize{#1}%
2581 \def\lsize{#2}\def\lllsize{#3}%
2582 \csname rmisbold#5\endcsname
2588 \definefontsetatsize{text} {reduced}{smaller}{\textleading}{false}
2589 \definefontsetatsize{title} {chap} {subsec} {27pt} {true}
2590 \definefontsetatsize{chap} {sec} {text} {19pt} {true}
2591 \definefontsetatsize{sec} {subsec} {reduced}{17pt} {true}
2592 \definefontsetatsize{ssec} {text} {small} {15pt} {true}
2593 \definefontsetatsize{reduced}{small} {smaller}{10.5pt}{false}
2594 \definefontsetatsize{small} {smaller}{smaller}{10.5pt}{false}
2595 \definefontsetatsize{smaller}{smaller}{smaller}{9.5pt} {false}
2597 \def\titlefont#1{{\titlefonts\rm #1}}
2598 \let\subsecfonts = \ssecfonts
2599 \let\subsubsecfonts = \ssecfonts
2601 % Define these just so they can be easily changed for other fonts.
2602 \def\angleleft{$\langle$}
2603 \def\angleright{$\rangle$}
2605 % Set the fonts to use with the @small... environments.
2606 \let\smallexamplefonts = \smallfonts
2608 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2609 % can fit this many characters:
2610 % 8.5x11=86 smallbook=72 a4=90 a5=69
2611 % If we use \scriptfonts (8pt), then we can fit this many characters:
2612 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2613 % For me, subjectively, the few extra characters that fit aren't worth
2614 % the additional smallness of 8pt. So I'm making the default 9pt.
2616 % By the way, for comparison, here's what fits with @example (10pt):
2617 % 8.5x11=71 smallbook=60 a4=75 a5=58
2620 % Set up the default fonts, so we can use them for creating boxes.
2622 \definetextfontsizexi
2627 % Check if we are currently using a typewriter font. Since all the
2628 % Computer Modern typewriter fonts have zero interword stretch (and
2629 % shrink), and it is reasonable to expect all typewriter fonts to have
2630 % this property, we can check that font parameter.
2632 \def\ifmonospace{\ifdim\fontdimen3\font=0pt }
2634 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2635 % define and register \INITMACRO to be called on markup style changes.
2636 % \INITMACRO can check \currentmarkupstyle for the innermost
2639 \let\currentmarkupstyle\empty
2641 \def\setupmarkupstyle#1{%
2642 \def\currentmarkupstyle{#1}%
2646 \let\markupstylesetup\empty
2648 \def\defmarkupstylesetup#1{%
2649 \expandafter\def\expandafter\markupstylesetup
2650 \expandafter{\markupstylesetup #1}%
2654 % Markup style setup for left and right quotes.
2655 \defmarkupstylesetup\markupsetuplq{%
2656 \expandafter\let\expandafter \temp
2657 \csname markupsetuplq\currentmarkupstyle\endcsname
2658 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2661 \defmarkupstylesetup\markupsetuprq{%
2662 \expandafter\let\expandafter \temp
2663 \csname markupsetuprq\currentmarkupstyle\endcsname
2664 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2671 \gdef\markupsetuplqdefault{\let`\lq}
2672 \gdef\markupsetuprqdefault{\let'\rq}
2674 \gdef\markupsetcodequoteleft{\let`\codequoteleft}
2675 \gdef\markupsetcodequoteright{\let'\codequoteright}
2678 \let\markupsetuplqcode \markupsetcodequoteleft
2679 \let\markupsetuprqcode \markupsetcodequoteright
2681 \let\markupsetuplqexample \markupsetcodequoteleft
2682 \let\markupsetuprqexample \markupsetcodequoteright
2684 \let\markupsetuplqkbd \markupsetcodequoteleft
2685 \let\markupsetuprqkbd \markupsetcodequoteright
2687 \let\markupsetuplqsamp \markupsetcodequoteleft
2688 \let\markupsetuprqsamp \markupsetcodequoteright
2690 \let\markupsetuplqverb \markupsetcodequoteleft
2691 \let\markupsetuprqverb \markupsetcodequoteright
2693 \let\markupsetuplqverbatim \markupsetcodequoteleft
2694 \let\markupsetuprqverbatim \markupsetcodequoteright
2696 % Allow an option to not use regular directed right quote/apostrophe
2697 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2698 % The undirected quote is ugly, so don't make it the default, but it
2699 % works for pasting with more pdf viewers (at least evince), the
2700 % lilypond developers report. xpdf does work with the regular 0x27.
2702 \def\codequoteright{%
2704 \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
2705 \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
2714 % and a similar option for the left quote char vs. a grave accent.
2715 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2716 % the code environments to do likewise.
2718 \def\codequoteleft{%
2720 \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
2721 \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
2722 % [Knuth] pp. 380,381,391
2723 % \relax disables Spanish ligatures ?` and !` of \tt font.
2732 % Commands to set the quote options.
2734 \parseargdef\codequoteundirected{%
2737 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2739 \else\ifx\temp\offword
2740 \expandafter\let\csname SETtxicodequoteundirected\endcsname
2743 \errhelp = \EMsimple
2744 \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
2748 \parseargdef\codequotebacktick{%
2751 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2753 \else\ifx\temp\offword
2754 \expandafter\let\csname SETtxicodequotebacktick\endcsname
2757 \errhelp = \EMsimple
2758 \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
2762 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2763 \def\noligaturesquoteleft{\relax\lq}
2765 % Count depth in font-changes, for error checks
2766 \newcount\fontdepth \fontdepth=0
2770 % #1 is the font command (\sl or \it), #2 is the text to slant.
2771 % If we are in a monospaced environment, however, 1) always use \ttsl,
2772 % and 2) do not add an italic correction.
2773 \def\dosmartslant#1#2{%
2775 {{\ttsl #2}\let\next=\relax}%
2776 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2779 \def\smartslanted{\dosmartslant\sl}
2780 \def\smartitalic{\dosmartslant\it}
2782 % Output an italic correction unless \next (presumed to be the following
2783 % character) is such as not to need one.
2784 \def\smartitaliccorrection{%
2789 \else\ifx\next\comma%
2795 % Unconditional use \ttsl, and no ic. @var is set to this for defuns.
2796 \def\ttslanted#1{{\ttsl #1}}
2798 % @cite is like \smartslanted except unconditionally use \sl. We never want
2799 % ttsl for book titles, do we?
2800 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2804 \let\saveaftersmartic = \aftersmartic
2805 \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
2810 \let\slanted=\smartslanted
2811 \let\dfn=\smartslanted
2812 \let\emph=\smartitalic
2814 % Explicit font changes: @r, @sc, undocumented @ii.
2815 \def\r#1{{\rm #1}} % roman font
2816 \def\sc#1{{\smallcaps#1}} % smallcaps font
2817 \def\ii#1{{\it #1}} % italic font
2819 % @b, explicit bold. Also @strong.
2823 % @sansserif, explicit sans.
2824 \def\sansserif#1{{\sf #1}}
2826 % We can't just use \exhyphenpenalty, because that only has effect at
2827 % the end of a paragraph. Restore normal hyphenation at the end of the
2828 % group within which \nohyphenation is presumably called.
2830 \def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
2831 \def\restorehyphenation{\hyphenchar\font = `- }
2833 % Set sfcode to normal for the chars that usually have another value.
2834 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2835 % sometimes \x has an active definition that messes things up.
2838 \def\plainfrenchspacing{%
2839 \sfcode`\.=\@m \sfcode`\?=\@m \sfcode`\!=\@m
2840 \sfcode`\:=\@m \sfcode`\;=\@m \sfcode`\,=\@m
2841 \def\endofsentencespacefactor{1000}% for @. and friends
2843 \def\plainnonfrenchspacing{%
2844 \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
2845 \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
2846 \def\endofsentencespacefactor{3000}% for @. and friends
2849 \def\endofsentencespacefactor{3000}% default
2851 % @t, explicit typewriter.
2853 {\tt \plainfrenchspacing #1}%
2858 \def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
2860 % @indicateurl is \samp, that is, with quotes.
2861 \let\indicateurl=\samp
2863 % @code (and similar) prints in typewriter, but with spaces the same
2864 % size as normal in the surrounding text, without hyphenation, etc.
2865 % This is a subroutine for that.
2868 % Change normal interword space to be same as for the current font.
2869 \spaceskip = \fontdimen2\font
2871 % Switch to typewriter.
2874 % But `\ ' produces the large typewriter interword space.
2875 \def\ {{\spaceskip = 0pt{} }}%
2877 % Turn off hyphenation.
2883 \null % reset spacefactor to 1000
2886 % We *must* turn on hyphenation at `-' and `_' in @code.
2887 % (But see \codedashfinish below.)
2888 % Otherwise, it is too hard to avoid overfull hboxes
2889 % in the Emacs manual, the Library manual, etc.
2891 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2892 % both hyphenation at - and hyphenation within words.
2893 % We must therefore turn them both off (\tclose does that)
2894 % and arrange explicitly to hyphenate at a dash. -- rms.
2896 \catcode`\-=\active \catcode`\_=\active
2897 \catcode`\'=\active \catcode`\`=\active
2898 \global\let'=\rq \global\let`=\lq % default definitions
2900 \global\def\code{\begingroup
2901 \setupmarkupstyle{code}%
2902 % The following should really be moved into \setupmarkupstyle handlers.
2903 \catcode\dashChar=\active \catcode\underChar=\active
2911 % Given -foo (with a single dash), we do not want to allow a break
2913 \global\let\codedashprev=\codedash
2918 \gdef\codedash{\futurelet\next\codedashfinish}
2919 \gdef\codedashfinish{%
2920 \normaldash % always output the dash character itself.
2922 % Now, output a discretionary to allow a line break, unless
2923 % (a) the next character is a -, or
2924 % (b) the preceding character is a -.
2925 % E.g., given --posix, we do not want to allow a break after either -.
2926 % Given --foo-bar, we do want to allow a break between the - and the b.
2927 \ifx\next\codedash \else
2928 \ifx\codedashprev\codedash
2929 \else \discretionary{}{}{}\fi
2931 % we need the space after the = for the case when \next itself is a
2932 % space token; it would get swallowed otherwise. As in @code{- a}.
2933 \global\let\codedashprev= \next
2938 \def\codex #1{\tclose{#1}\endgroup}
2941 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2942 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2943 % will therefore expand the active definition of _, which is us
2944 % (inside @code that is), therefore an endless loop.
2946 \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2947 \else\normalunderscore \fi
2948 \discretionary{}{}{}}%
2952 % An additional complication: the above will allow breaks after, e.g.,
2953 % each of the four underscores in __typeof__. This is bad.
2954 % @allowcodebreaks provides a document-level way to turn breaking at -
2957 \newif\ifallowcodebreaks \allowcodebreakstrue
2959 \def\keywordtrue{true}
2960 \def\keywordfalse{false}
2962 \parseargdef\allowcodebreaks{%
2964 \ifx\txiarg\keywordtrue
2965 \allowcodebreakstrue
2966 \else\ifx\txiarg\keywordfalse
2967 \allowcodebreaksfalse
2969 \errhelp = \EMsimple
2970 \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
2974 % For @command, @env, @file, @option quotes seem unnecessary,
2975 % so use \code rather than \samp.
2981 % @uref (abbreviation for `urlref') aka @url takes an optional
2982 % (comma-separated) second argument specifying the text to display and
2983 % an optional third arg as text to display instead of (rather than in
2984 % addition to) the url itself. First (mandatory) arg is the url.
2986 % TeX-only option to allow changing PDF output to show only the second
2987 % arg (if given), and not the url (which is then just the link target).
2988 \newif\ifurefurlonlylink
2990 % The main macro is \urefbreak, which allows breaking at expected
2991 % places within the url. (There used to be another version, which
2992 % didn't support automatic breaking.)
2993 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2994 \let\uref=\urefbreak
2996 \def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
2997 \def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
3000 \setbox0 = \hbox{\ignorespaces #3}%
3002 \unhbox0 % third arg given, show only that
3004 \setbox0 = \hbox{\ignorespaces #2}% look for second arg
3007 % For pdfTeX and LuaTeX
3009 % PDF plus option to not display url, show just arg
3012 % PDF, normally display both arg and url for consistency,
3013 % visibility, if the pdf is eventually used to print, etc.
3014 \unhbox0\ (\urefcode{#1})%
3017 \ifx\XeTeXrevision\thisisundefined
3018 \unhbox0\ (\urefcode{#1})% DVI, always show arg and url
3022 % PDF plus option to not display url, show just arg
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})%
3032 \urefcode{#1}% only url given, so show it
3038 % Allow line breaks around only a few characters (only).
3040 \catcode`\&=\active \catcode`\.=\active
3041 \catcode`\#=\active \catcode`\?=\active
3047 \global\def\urefcode{\begingroup
3048 \setupmarkupstyle{code}%
3058 % By default, they are just regular characters.
3059 \global\def&{\normalamp}
3060 \global\def.{\normaldot}
3061 \global\def#{\normalhash}
3062 \global\def?{\normalquest}
3063 \global\def/{\normalslash}
3066 \def\urefcodeamp{\urefprebreak \&\urefpostbreak}
3067 \def\urefcodedot{\urefprebreak .\urefpostbreak}
3068 \def\urefcodehash{\urefprebreak \#\urefpostbreak}
3069 \def\urefcodequest{\urefprebreak ?\urefpostbreak}
3070 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
3073 \global\def\urefcodeslashfinish{%
3074 \urefprebreak \slashChar
3075 % Allow line break only after the final / in a sequence of
3076 % slashes, to avoid line break between the slashes in http://.
3077 \ifx\next/\else \urefpostbreak \fi
3081 % By default we'll break after the special characters, but some people like to
3082 % break before the special chars, so allow that. Also allow no breaking at
3083 % all, for manual control.
3085 \parseargdef\urefbreakstyle{%
3087 \ifx\txiarg\wordnone
3088 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
3089 \else\ifx\txiarg\wordbefore
3090 \def\urefprebreak{\urefallowbreak}\def\urefpostbreak{\nobreak}
3091 \else\ifx\txiarg\wordafter
3092 \def\urefprebreak{\nobreak}\def\urefpostbreak{\urefallowbreak}
3094 \errhelp = \EMsimple
3095 \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
3098 \def\wordafter{after}
3099 \def\wordbefore{before}
3102 % Allow a ragged right output to aid breaking long URL's. There can
3103 % be a break at the \allowbreak with no extra glue (if the existing stretch in
3104 % the line is sufficent), a break at the \penalty100 with extra glue added
3105 % at the end of the line, or no break at all here.
3106 % Changing the value of the penalty and/or the amount of stretch affects how
3107 % preferrable one choice is over the other.
3108 \def\urefallowbreak{%
3110 \hskip 0pt plus 4 em\relax
3112 \hskip 0pt plus -4 em\relax
3115 \urefbreakstyle after
3117 % @url synonym for @uref, since that's how everyone uses it.
3121 % rms does not like angle brackets --karl, 17may97.
3122 % So now @email is just like @uref, unless we are pdf.
3124 %\def\email#1{\angleleft{\tt #1}\angleright}
3126 \def\email#1{\doemail#1,,\finish}
3127 \def\doemail#1,#2,#3\finish{\begingroup
3130 \setbox0 = \hbox{\ignorespaces #2}%
3131 \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
3138 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
3139 % `example' (@kbd uses ttsl only inside of @example and friends),
3140 % or `code' (@kbd uses normal tty font always).
3141 \parseargdef\kbdinputstyle{%
3143 \ifx\txiarg\worddistinct
3144 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
3145 \else\ifx\txiarg\wordexample
3146 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
3147 \else\ifx\txiarg\wordcode
3148 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
3150 \errhelp = \EMsimple
3151 \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
3154 \def\worddistinct{distinct}
3155 \def\wordexample{example}
3158 % Default is `distinct'.
3159 \kbdinputstyle distinct
3161 % @kbd is like @code, except that if the argument is just one @key command,
3162 % then @kbd has no effect.
3163 \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}}
3166 \def\kbdsub#1#2#3\par{%
3167 \def\one{#1}\def\three{#3}\def\threex{??}%
3168 \ifx\one\xkey\ifx\threex\three \key{#2}%
3169 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
3170 \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
3173 % definition of @key that produces a lozenge. Doesn't adjust to text size.
3174 %\setfont\keyrm\rmshape{8}{1000}{OT1}
3176 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
3177 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
3178 % \vbox{\hrule\kern-0.4pt
3179 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
3180 % \kern-0.4pt\hrule}%
3181 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
3183 % definition of @key with no lozenge. If the current font is already
3184 % monospace, don't change it; that way, we respect @kbdinputstyle. But
3185 % if it isn't monospace, then use \tt.
3187 \def\key#1{{\setupmarkupstyle{key}%
3189 \ifmonospace\else\tt\fi
3192 % @clicksequence{File @click{} Open ...}
3193 \def\clicksequence#1{\begingroup #1\endgroup}
3195 % @clickstyle @arrow (by default)
3196 \parseargdef\clickstyle{\def\click{#1}}
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
3208 \def\acronym#1{\doacronym #1,,\finish}
3209 \def\doacronym#1,#2,#3\finish{%
3210 {\switchtolsize #1}%
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}%
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.
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{%
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}
3256 \ifmmode\else % only go into math if not in math mode already
3259 \let\\ = \mathbackslash
3261 % make the texinfo accent commands work in math mode
3271 % have to provide another name for sup operator
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
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 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
3309 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
3310 % except specified as a normal braced arg, so no newlines to worry about.
3312 \def\outfmtnametex{tex}
3314 \long\def\inlinefmt#1{\doinlinefmt #1,\finish}
3315 \long\def\doinlinefmt#1,#2,\finish{%
3316 \def\inlinefmtname{#1}%
3317 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
3320 % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
3321 % FMTNAME is tex, else ELSE-TEXT.
3322 \long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,\finish}
3323 \long\def\doinlinefmtifelse#1,#2,#3,#4,\finish{%
3324 \def\inlinefmtname{#1}%
3325 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
3328 % For raw, must switch into @tex before parsing the argument, to avoid
3329 % setting catcodes prematurely. Doing it this way means that, for
3330 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
3331 % ignored. But this isn't important because if people want a literal
3332 % *right* brace they would have to use a command anyway, so they may as
3333 % well use a command to get a left brace too. We could re-use the
3334 % delimiter character idea from \verb, but it seems like overkill.
3336 \long\def\inlineraw{\tex \doinlineraw}
3337 \long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
3338 \def\doinlinerawtwo#1,#2,\finish{%
3339 \def\inlinerawname{#1}%
3340 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
3341 \endgroup % close group opened by \tex.
3344 % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
3346 \long\def\inlineifset#1{\doinlineifset #1,\finish}
3347 \long\def\doinlineifset#1,#2,\finish{%
3348 \def\inlinevarname{#1}%
3349 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax
3350 \else\ignorespaces#2\fi
3353 % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
3355 \long\def\inlineifclear#1{\doinlineifclear #1,\finish}
3356 \long\def\doinlineifclear#1,#2,\finish{%
3357 \def\inlinevarname{#1}%
3358 \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \ignorespaces#2\fi
3365 % @@ prints an @, as does @atchar{}.
3369 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
3370 \def\lbracechar{{\ifmonospace\char123\else\ensuremath\lbrace\fi}}
3371 \def\rbracechar{{\ifmonospace\char125\else\ensuremath\rbrace\fi}}
3375 % @comma{} to avoid , parsing problems.
3378 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
3379 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
3381 \let\dotaccent = \ptexdot
3382 \def\ringaccent#1{{\accent23 #1}}
3383 \let\tieaccent = \ptext
3384 \let\ubaraccent = \ptexb
3385 \let\udotaccent = \d
3387 % Other special characters: @questiondown @exclamdown @ordf @ordm
3388 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
3389 \def\questiondown{?`}
3391 \def\ordf{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{a}}}
3392 \def\ordm{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{o}}}
3394 % Dotless i and dotless j, used for accents.
3399 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
3400 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
3401 \else \errmessage{@dotless can be used only with i or j}%
3405 % The \TeX{} logo, as in plain, but resetting the spacing so that a
3406 % period following counts as ending a sentence. (Idea found in latex.)
3408 \edef\TeX{\TeX \spacefactor=1000 }
3410 % @LaTeX{} logo. Not quite the same results as the definition in
3411 % latex.ltx, since we use a different font for the raised A; it's most
3412 % convenient for us to use an explicitly smaller font, rather than using
3413 % the \scriptstyle font (since we don't reset \scriptstyle and
3414 % \scriptscriptstyle).
3419 \vbox to \ht0{\hbox{%
3420 \ifx\textnominalsize\xwordpt
3421 % for 10pt running text, lllsize (8pt) is too small for the A in LaTeX.
3422 % Revert to plain's \scriptsize, which is 7pt.
3423 \count255=\the\fam $\fam\count255 \scriptstyle A$%
3425 % For 11pt, we can use our lllsize.
3435 % Some math mode symbols. Define \ensuremath to switch into math mode
3436 % unless we are already there. Expansion tricks may not be needed here,
3437 % but safer, and can't hurt.
3438 \def\ensuremath{\ifmmode \expandafter\asis \else\expandafter\ensuredmath \fi}
3439 \def\ensuredmath#1{$\relax#1$}
3441 \def\bullet{\ensuremath\ptexbullet}
3442 \def\geq{\ensuremath\ge}
3443 \def\leq{\ensuremath\le}
3444 \def\minus{\ensuremath-}
3446 % @dots{} outputs an ellipsis using the current font.
3447 % We do .5em per period so that it has the same spacing in the cm
3448 % typewriter fonts as three actual period characters; on the other hand,
3449 % in other typewriter fonts three periods are wider than 1.5em. So do
3450 % whichever is larger.
3454 \setbox0=\hbox{...}% get width of three periods
3461 \hskip 0pt plus.25fil
3462 .\hskip 0pt plus1fil
3463 .\hskip 0pt plus1fil
3464 .\hskip 0pt plus.5fil
3468 % @enddots{} is an end-of-sentence ellipsis.
3472 \spacefactor=\endofsentencespacefactor
3475 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3477 % Since these characters are used in examples, they should be an even number of
3478 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3481 \def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
3482 \def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
3483 \def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
3484 \def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
3485 \def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
3487 % The @error{} command.
3488 % Adapted from the TeXbook's \boxit.
3492 {\ttfont \global\dimen0 = 3em}% Width of the box.
3493 \dimen2 = .55pt % Thickness of rules
3494 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3495 \setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
3497 \setbox\errorbox=\hbox to \dimen0{\hfil
3498 \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
3499 \advance\hsize by -2\dimen2 % Rules.
3501 \hrule height\dimen2
3502 \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
3503 \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
3504 \kern3pt\vrule width\dimen2}% Space to right.
3505 \hrule height\dimen2}
3508 \def\error{\leavevmode\lower.7ex\copy\errorbox}
3510 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3512 \def\pounds{{\it\$}}
3514 % @euro{} comes from a separate font, depending on the current style.
3515 % We use the free feym* fonts from the eurosym package by Henrik
3516 % Theiling, which support regular, slanted, bold and bold slanted (and
3517 % "outlined" (blackboard board, sort of) versions, which we don't need).
3518 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3520 % Although only regular is the truly official Euro symbol, we ignore
3521 % that. The Euro is designed to be slightly taller than the regular
3527 % feybo - bold slanted
3529 % There is no good (free) typewriter version, to my knowledge.
3530 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3533 % Also doesn't work in math. Do we need to do math with euro symbols?
3537 \def\euro{{\eurofont e}}
3539 % We set the font at each command, rather than predefining it in
3540 % \textfonts and the other font-switching commands, so that
3541 % installations which never need the symbol don't have to have the
3544 % There is only one designed size (nominal 10pt), so we always scale
3545 % that to the current nominal size.
3547 % By the way, simply using "at 1em" works for cmr10 and the like, but
3548 % does not work for cmbx10 and other extended/shrunken fonts.
3550 \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
3552 \ifx\curfontstyle\bfstylename
3554 \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
3557 \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
3562 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3563 % sometimes we redefine the original macro, and the alias should reflect
3566 % Use LaTeX names for the Icelandic letters.
3567 \def\DH{{\ecfont \char"D0}} % Eth
3568 \def\dh{{\ecfont \char"F0}} % eth
3569 \def\TH{{\ecfont \char"DE}} % Thorn
3570 \def\th{{\ecfont \char"FE}} % thorn
3572 \def\guillemetleft{{\ecfont \char"13}}
3573 \def\guillemotleft{\guillemetleft}
3574 \def\guillemetright{{\ecfont \char"14}}
3575 \def\guillemotright{\guillemetright}
3576 \def\guilsinglleft{{\ecfont \char"0E}}
3577 \def\guilsinglright{{\ecfont \char"0F}}
3578 \def\quotedblbase{{\ecfont \char"12}}
3579 \def\quotesinglbase{{\ecfont \char"0D}}
3581 % This positioning is not perfect (see the ogonek LaTeX package), but
3582 % we have the precomposed glyphs for the most common cases. We put the
3583 % tests to use those glyphs in the single \ogonek macro so we have fewer
3584 % dummy definitions to worry about for index entries, etc.
3586 % ogonek is also used with other letters in Lithuanian (IOU), but using
3587 % the precomposed glyphs for those is not so easy since they aren't in
3591 \ifx\temp\macrocharA\Aogonek
3592 \else\ifx\temp\macrochara\aogonek
3593 \else\ifx\temp\macrocharE\Eogonek
3594 \else\ifx\temp\macrochare\eogonek
3596 \ecfont \setbox0=\hbox{#1}%
3597 \ifdim\ht0=1ex\accent"0C #1%
3598 \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
3603 \def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
3604 \def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
3605 \def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
3606 \def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
3608 % Use the European Computer Modern fonts (cm-super in outline format)
3609 % for non-CM glyphs. That is ec* for regular text and tc* for the text
3610 % companion symbols (LaTeX TS1 encoding). Both are part of the ec
3611 % package and follow the same conventions.
3613 \def\ecfont{\etcfont{e}}
3614 \def\tcfont{\etcfont{t}}
3617 % We can't distinguish serif/sans and italic/slanted, but this
3618 % is used for crude hacks anyway (like adding French and German
3619 % quotes to documents typeset with CM, where we lose kerning), so
3620 % hopefully nobody will notice/care.
3621 \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
3622 \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
3625 \font\thisecfont = #1ctt\ecsize \space at \nominalsize
3627 \ifx\curfontstyle\bfstylename
3629 \font\thisecfont = #1cb\ifusingit{i}{x}\ecsize \space at \nominalsize
3632 \font\thisecfont = #1c\ifusingit{ti}{rm}\ecsize \space at \nominalsize
3638 % @registeredsymbol - R in a circle. The font for the R should really
3639 % be smaller yet, but lllsize is the best we can do for now.
3640 % Adapted from the plain.tex definition of \copyright.
3642 \def\registeredsymbol{%
3643 $^{{\ooalign{\hfil\raise.07ex\hbox{\switchtolllsize R}%
3648 % @textdegree - the normal degrees sign.
3650 \def\textdegree{$^\circ$}
3652 % Laurent Siebenmann reports \Orb undefined with:
3653 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3654 % so we'll define it if necessary.
3656 \ifx\Orb\thisisundefined
3657 \def\Orb{\mathhexbox20D}
3661 \chardef\quotedblleft="5C
3662 \chardef\quotedblright=`\"
3663 \chardef\quoteleft=`\`
3664 \chardef\quoteright=`\'
3667 \message{page headings,}
3669 \newskip\titlepagetopglue \titlepagetopglue = 1.5in
3670 \newskip\titlepagebottomglue \titlepagebottomglue = 2pc
3672 % First the title page. Must do @settitle before @titlepage.
3674 \newif\iffinishedtitlepage
3676 % @setcontentsaftertitlepage used to do an implicit @contents or
3677 % @shortcontents after @end titlepage, but it is now obsolete.
3678 \def\setcontentsaftertitlepage{%
3679 \errmessage{@setcontentsaftertitlepage has been removed as a Texinfo
3680 command; move your @contents command if you want the contents
3681 after the title page.}}%
3682 \def\setshortcontentsaftertitlepage{%
3683 \errmessage{@setshortcontentsaftertitlepage has been removed as a Texinfo
3684 command; move your @shortcontents and @contents commands if you
3685 want the contents after the title page.}}%
3687 \parseargdef\shorttitlepage{%
3688 \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
3689 \endgroup\page\hbox{}\page}
3692 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3694 \parindent=0pt \textfonts
3695 % Leave some space at the very top of the page.
3696 \vglue\titlepagetopglue
3697 % No rule at page bottom unless we print one at the top with @title.
3698 \finishedtitlepagetrue
3700 % Most title ``pages'' are actually two pages long, with space
3701 % at the top of the second. We don't want the ragged left on the second.
3702 \let\oldpage = \page
3704 \iffinishedtitlepage\else
3707 \let\page = \oldpage
3714 \iffinishedtitlepage\else
3717 % It is important to do the page break before ending the group,
3718 % because the headline and footline are only empty inside the group.
3719 % If we use the new definition of \page, we always get a blank page
3720 % after the title page, which we certainly don't want.
3724 % Need this before the \...aftertitlepage checks so that if they are
3725 % in effect the toc pages will come out with page numbers.
3729 \def\finishtitlepage{%
3730 \vskip4pt \hrule height 2pt width \hsize
3731 \vskip\titlepagebottomglue
3732 \finishedtitlepagetrue
3735 % Settings used for typesetting titles: no hyphenation, no indentation,
3736 % don't worry much about spacing, ragged right. This should be used
3737 % inside a \vbox, and fonts need to be set appropriately first. \par should
3738 % be specified before the end of the \vbox, since a vbox is a group.
3740 \def\raggedtitlesettings{%
3742 \hyphenpenalty=10000
3748 % Macros to be used within @titlepage:
3750 \let\subtitlerm=\rmfont
3751 \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
3753 \parseargdef\title{%
3755 \vbox{\titlefonts \raggedtitlesettings #1\par}%
3756 % print a rule at the page bottom also.
3757 \finishedtitlepagefalse
3758 \vskip4pt \hrule height 4pt width \hsize \vskip4pt
3761 \parseargdef\subtitle{%
3763 {\subtitlefont \rightline{#1}}%
3766 % @author should come last, but may come many times.
3767 % It can also be used inside @quotation.
3769 \parseargdef\author{%
3770 \def\temp{\quotation}%
3772 \def\quotationauthor{#1}% printed in \Equotation.
3775 \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
3776 {\secfonts\rm \leftline{#1}}%
3781 % Set up page headings and footings.
3783 \let\thispage=\folio
3785 \newtoks\evenheadline % headline on even pages
3786 \newtoks\oddheadline % headline on odd pages
3787 \newtoks\evenfootline % footline on even pages
3788 \newtoks\oddfootline % footline on odd pages
3790 % Now make \makeheadline and \makefootline in Plain TeX use those variables
3791 \headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
3792 \else \the\evenheadline \fi}}
3793 \footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
3794 \else \the\evenfootline \fi}\HEADINGShook}
3795 \let\HEADINGShook=\relax
3797 % Commands to set those variables.
3798 % For example, this is what @headings on does
3799 % @evenheading @thistitle|@thispage|@thischapter
3800 % @oddheading @thischapter|@thispage|@thistitle
3801 % @evenfooting @thisfile||
3802 % @oddfooting ||@thisfile
3805 \def\evenheading{\parsearg\evenheadingxxx}
3806 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
3807 \def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
3808 \global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3810 \def\oddheading{\parsearg\oddheadingxxx}
3811 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
3812 \def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
3813 \global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3815 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3817 \def\evenfooting{\parsearg\evenfootingxxx}
3818 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
3819 \def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
3820 \global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3822 \def\oddfooting{\parsearg\oddfootingxxx}
3823 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
3824 \def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
3825 \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3827 % Leave some space for the footline. Hopefully ok to assume
3828 % @evenfooting will not be used by itself.
3829 \global\advance\txipageheight by -12pt
3830 \global\advance\vsize by -12pt
3833 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3835 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3836 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3838 % The same set of arguments for:
3843 % @everyheadingmarks
3844 % @everyfootingmarks
3846 % These define \getoddheadingmarks, \getevenheadingmarks,
3847 % \getoddfootingmarks, and \getevenfootingmarks, each to one of
3848 % \gettopheadingmarks, \getbottomheadingmarks.
3850 \def\evenheadingmarks{\headingmarks{even}{heading}}
3851 \def\oddheadingmarks{\headingmarks{odd}{heading}}
3852 \def\evenfootingmarks{\headingmarks{even}{footing}}
3853 \def\oddfootingmarks{\headingmarks{odd}{footing}}
3854 \parseargdef\everyheadingmarks{\headingmarks{even}{heading}{#1}
3855 \headingmarks{odd}{heading}{#1} }
3856 \parseargdef\everyfootingmarks{\headingmarks{even}{footing}{#1}
3857 \headingmarks{odd}{footing}{#1} }
3858 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3859 \def\headingmarks#1#2#3 {%
3860 \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
3861 \global\expandafter\let\csname get#1#2marks\endcsname \temp
3864 \everyheadingmarks bottom
3865 \everyfootingmarks bottom
3867 % @headings double turns headings on for double-sided printing.
3868 % @headings single turns headings on for single-sided printing.
3869 % @headings off turns them off.
3870 % @headings on same as @headings double, retained for compatibility.
3871 % @headings after turns on double-sided headings after this page.
3872 % @headings doubleafter turns on double-sided headings after this page.
3873 % @headings singleafter turns on single-sided headings after this page.
3874 % By default, they are off at the start of a document,
3875 % and turned `on' after @end titlepage.
3877 \parseargdef\headings{\csname HEADINGS#1\endcsname}
3879 \def\headingsoff{% non-global headings elimination
3880 \evenheadline={\hfil}\evenfootline={\hfil}%
3881 \oddheadline={\hfil}\oddfootline={\hfil}%
3884 \def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
3885 \HEADINGSoff % it's the default
3887 % When we turn headings on, set the page number to 1.
3888 % For double-sided printing, put current file name in lower left corner,
3889 % chapter name on inside top of right hand pages, document
3890 % title on inside top of left hand pages, and page numbers on outside top
3891 % edge of all pages.
3892 \def\HEADINGSdouble{%
3894 \global\evenfootline={\hfil}
3895 \global\oddfootline={\hfil}
3896 \global\evenheadline={\line{\folio\hfil\thistitle}}
3897 \global\oddheadline={\line{\thischapterheading\hfil\folio}}
3898 \global\let\contentsalignmacro = \chapoddpage
3900 \let\contentsalignmacro = \chappager
3902 % For single-sided printing, chapter title goes across top left of page,
3903 % page number on top right.
3904 \def\HEADINGSsingle{%
3906 \global\evenfootline={\hfil}
3907 \global\oddfootline={\hfil}
3908 \global\evenheadline={\line{\thischapterheading\hfil\folio}}
3909 \global\oddheadline={\line{\thischapterheading\hfil\folio}}
3910 \global\let\contentsalignmacro = \chappager
3912 \def\HEADINGSon{\HEADINGSdouble}
3914 \def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
3915 \let\HEADINGSdoubleafter=\HEADINGSafter
3916 \def\HEADINGSdoublex{%
3917 \global\evenfootline={\hfil}
3918 \global\oddfootline={\hfil}
3919 \global\evenheadline={\line{\folio\hfil\thistitle}}
3920 \global\oddheadline={\line{\thischapterheading\hfil\folio}}
3921 \global\let\contentsalignmacro = \chapoddpage
3924 \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
3925 \def\HEADINGSsinglex{%
3926 \global\evenfootline={\hfil}
3927 \global\oddfootline={\hfil}
3928 \global\evenheadline={\line{\thischapterheading\hfil\folio}}
3929 \global\oddheadline={\line{\thischapterheading\hfil\folio}}
3930 \global\let\contentsalignmacro = \chappager
3933 % Subroutines used in generating headings
3934 % This produces Day Month Year style of output.
3935 % Only define if not already defined, in case a txi-??.tex file has set
3936 % up a different format (e.g., txi-cs.tex does this).
3937 \ifx\today\thisisundefined
3941 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3942 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3943 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3948 % @settitle line... specifies the title of the document, for headings.
3949 % It generates no output of its own.
3950 \def\thistitle{\putwordNoTitle}
3951 \def\settitle{\parsearg{\gdef\thistitle}}
3955 % Tables -- @table, @ftable, @vtable, @item(x).
3957 % default indentation of table text
3958 \newdimen\tableindent \tableindent=.8in
3959 % default indentation of @itemize and @enumerate text
3960 \newdimen\itemindent \itemindent=.3in
3961 % margin between end of table item and start of table text.
3962 \newdimen\itemmargin \itemmargin=.1in
3964 % used internally for \itemindent minus \itemmargin
3967 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3969 % They also define \itemindex
3970 % to index the item name in whatever manner is desired (perhaps none).
3972 \newif\ifitemxneedsnegativevskip
3974 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
3976 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3977 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3979 \def\itemzzz #1{\begingroup %
3980 \advance\hsize by -\rightskip
3981 \advance\hsize by -\tableindent
3982 \setbox0=\hbox{\itemindicate{#1}}%
3984 \nobreak % This prevents a break before @itemx.
3986 % If the item text does not fit in the space we have, put it on a line
3987 % by itself, and do not allow a page break either before or after that
3988 % line. We do not start a paragraph here because then if the next
3989 % command is, e.g., @kindex, the whatsit would get put into the
3990 % horizontal list on a line by itself, resulting in extra blank space.
3991 \ifdim \wd0>\itemmax
3993 % Make this a paragraph so we get the \parskip glue and wrapping,
3994 % but leave it ragged-right.
3996 \advance\leftskip by-\tableindent
3997 \advance\hsize by\tableindent
3998 \advance\rightskip by0pt plus1fil\relax
3999 \leavevmode\unhbox0\par
4002 % We're going to be starting a paragraph, but we don't want the
4003 % \parskip glue -- logically it's part of the @item we just started.
4004 \nobreak \vskip-\parskip
4006 % Stop a page break at the \parskip glue coming up. However, if
4007 % what follows is an environment such as @example, there will be no
4008 % \parskip glue; then the negative vskip we just inserted would
4009 % cause the example and the item to crash together. So we use this
4010 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
4011 % \parskip glue after all. Section titles are handled this way also.
4015 \itemxneedsnegativevskipfalse
4017 % The item text fits into the space. Start a paragraph, so that the
4018 % following text (if any) will end up on the same line.
4020 % Do this with kerns and \unhbox so that if there is a footnote in
4021 % the item text, it can migrate to the main vertical list and
4022 % eventually be printed.
4023 \nobreak\kern-\tableindent
4024 \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
4026 \nobreak\kern\dimen0
4028 \itemxneedsnegativevskiptrue
4032 \def\item{\errmessage{@item while not in a list environment}}
4033 \def\itemx{\errmessage{@itemx while not in a list environment}}
4035 % @table, @ftable, @vtable.
4037 \let\itemindex\gobble
4041 \def\itemindex ##1{\doind {fn}{\code{##1}}}%
4042 \tablecheck{ftable}%
4045 \def\itemindex ##1{\doind {vr}{\code{##1}}}%
4046 \tablecheck{vtable}%
4049 \ifnum \the\catcode`\^^M=\active
4051 \errmessage{This command won't work in this context; perhaps the problem is
4052 that we are \inenvironment\thisenv}%
4053 \def\next{\doignore{#1}}%
4060 \def\itemindicate{#1}%
4065 \makevalueexpandable
4066 \edef\temp{\noexpand\tablez #1\space\space\space}%
4070 \def\tablez #1 #2 #3 #4\endtablez{%
4072 \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
4073 \ifnum 0#2>0 \tableindent=#2\mil \fi
4074 \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
4075 \itemmax=\tableindent
4076 \advance \itemmax by -\itemmargin
4077 \advance \leftskip by \tableindent
4078 \exdentamount=\tableindent
4080 \parskip = \smallskipamount
4081 \ifdim \parskip=0pt \parskip=2pt \fi
4082 \let\item = \internalBitem
4083 \let\itemx = \internalBitemx
4085 \def\Etable{\endgraf\afterenvbreak}
4088 \let\Eitemize\Etable
4089 \let\Eenumerate\Etable
4091 % This is the counter used by @enumerate, which is really @itemize
4095 \envdef\itemize{\parsearg\doitemize}
4099 \itemmax=\itemindent
4100 \advance\itemmax by -\itemmargin
4101 \advance\leftskip by \itemindent
4102 \exdentamount=\itemindent
4104 \parskip=\smallskipamount
4105 \ifdim\parskip=0pt \parskip=2pt \fi
4107 % Try typesetting the item mark so that if the document erroneously says
4108 % something like @itemize @samp (intending @table), there's an error
4109 % right away at the @itemize. It's not the best error message in the
4110 % world, but it's better than leaving it to the @item. This means if
4111 % the user wants an empty mark, they have to say @w{} not just @w.
4112 \def\itemcontents{#1}%
4113 \setbox0 = \hbox{\itemcontents}%
4115 % @itemize with no arg is equivalent to @itemize @bullet.
4116 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
4118 \let\item=\itemizeitem
4121 % Definition of @item while inside @itemize and @enumerate.
4124 \advance\itemno by 1 % for enumerations
4125 {\let\par=\endgraf \smallbreak}% reasonable place to break
4127 % If the document has an @itemize directly after a section title, a
4128 % \nobreak will be last on the list, and \sectionheading will have
4129 % done a \vskip-\parskip. In that case, we don't want to zero
4130 % parskip, or the item text will crash with the heading. On the
4131 % other hand, when there is normal text preceding the item (as there
4132 % usually is), we do want to zero parskip, or there would be too much
4133 % space. In that case, we won't have a \nobreak before. At least
4134 % that's the theory.
4135 \ifnum\lastpenalty<10000 \parskip=0in \fi
4137 \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
4140 \vadjust{\penalty 1200}% not good to break after first line of item.
4142 % We can be in inner vertical mode in a footnote, although an
4143 % @itemize looks awful there.
4148 % \splitoff TOKENS\endmark defines \first to be the first token in
4149 % TOKENS, and \rest to be the remainder.
4151 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
4153 % Allow an optional argument of an uppercase letter, lowercase letter,
4154 % or number, to specify the first label in the enumerated list. No
4155 % argument is the same as `1'.
4157 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
4158 \def\enumeratey #1 #2\endenumeratey{%
4159 % If we were given no argument, pretend we were given `1'.
4161 \ifx\thearg\empty \def\thearg{1}\fi
4163 % Detect if the argument is a single token. If so, it might be a
4164 % letter. Otherwise, the only valid thing it can be is a number.
4165 % (We will always have one token, because of the test we just made.
4166 % This is a good thing, since \splitoff doesn't work given nothing at
4167 % all -- the first parameter is undelimited.)
4168 \expandafter\splitoff\thearg\endmark
4170 % Only one token in the argument. It could still be anything.
4171 % A ``lowercase letter'' is one whose \lccode is nonzero.
4172 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
4173 % not equal to itself.
4174 % Otherwise, we assume it's a number.
4176 % We need the \relax at the end of the \ifnum lines to stop TeX from
4177 % continuing to look for a <number>.
4179 \ifnum\lccode\expandafter`\thearg=0\relax
4180 \numericenumerate % a number (we hope)
4183 \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
4184 \lowercaseenumerate % lowercase letter
4186 \uppercaseenumerate % uppercase letter
4190 % Multiple tokens in the argument. We hope it's a number.
4195 % An @enumerate whose labels are integers. The starting integer is
4198 \def\numericenumerate{%
4200 \startenumeration{\the\itemno}%
4203 % The starting (lowercase) letter is in \thearg.
4204 \def\lowercaseenumerate{%
4205 \itemno = \expandafter`\thearg
4207 % Be sure we're not beyond the end of the alphabet.
4209 \errmessage{No more lowercase letters in @enumerate; get a bigger
4216 % The starting (uppercase) letter is in \thearg.
4217 \def\uppercaseenumerate{%
4218 \itemno = \expandafter`\thearg
4220 % Be sure we're not beyond the end of the alphabet.
4222 \errmessage{No more uppercase letters in @enumerate; get a bigger
4229 % Call \doitemize, adding a period to the first argument and supplying the
4230 % common last two arguments. Also subtract one from the initial value in
4231 % \itemno, since @item increments \itemno.
4233 \def\startenumeration#1{%
4234 \advance\itemno by -1
4235 \doitemize{#1.}\flushcr
4238 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
4241 \def\alphaenumerate{\enumerate{a}}
4242 \def\capsenumerate{\enumerate{A}}
4243 \def\Ealphaenumerate{\Eenumerate}
4244 \def\Ecapsenumerate{\Eenumerate}
4247 % @multitable macros
4248 % Amy Hendrickson, 8/18/94, 3/6/96
4250 % @multitable ... @end multitable will make as many columns as desired.
4251 % Contents of each column will wrap at width given in preamble. Width
4252 % can be specified either with sample text given in a template line,
4253 % or in percent of \hsize, the current width of text on page.
4255 % Table can continue over pages but will only break between lines.
4259 % Either define widths of columns in terms of percent of \hsize:
4260 % @multitable @columnfractions .25 .3 .45
4263 % Numbers following @columnfractions are the percent of the total
4264 % current hsize to be used for each column. You may use as many
4265 % columns as desired.
4268 % Or use a template:
4269 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
4271 % using the widest term desired in each column.
4273 % Each new table line starts with @item, each subsequent new column
4274 % starts with @tab. Empty columns may be produced by supplying @tab's
4275 % with nothing between them for as many times as empty columns are needed,
4276 % ie, @tab@tab@tab will produce two empty columns.
4278 % @item, @tab do not need to be on their own lines, but it will not hurt
4281 % Sample multitable:
4283 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
4284 % @item first col stuff @tab second col stuff @tab third col
4291 % @item first col stuff @tab second col stuff
4292 % @tab Many paragraphs of text may be used in any column.
4294 % They will wrap at the width determined by the template.
4295 % @item@tab@tab This will be in third column.
4298 % Default dimensions may be reset by user.
4299 % @multitableparskip is vertical space between paragraphs in table.
4300 % @multitableparindent is paragraph indent in table.
4301 % @multitablecolmargin is horizontal space to be left between columns.
4302 % @multitablelinespace is space to leave between table items, baseline
4304 % 0pt means it depends on current normal line spacing.
4306 \newskip\multitableparskip
4307 \newskip\multitableparindent
4308 \newdimen\multitablecolspace
4309 \newskip\multitablelinespace
4310 \multitableparskip=0pt
4311 \multitableparindent=6pt
4312 \multitablecolspace=12pt
4313 \multitablelinespace=0pt
4315 % Macros used to set up halign preamble:
4317 \let\endsetuptable\relax
4318 \def\xendsetuptable{\endsetuptable}
4319 \let\columnfractions\relax
4320 \def\xcolumnfractions{\columnfractions}
4323 % #1 is the @columnfraction, usually a decimal number like .5, but might
4324 % be just 1. We just use it, whatever it is.
4326 \def\pickupwholefraction#1 {%
4327 \global\advance\colcount by 1
4328 \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
4335 \ifx\firstarg\xendsetuptable
4338 \ifx\firstarg\xcolumnfractions
4339 \global\setpercenttrue
4342 \let\go\pickupwholefraction
4344 \global\advance\colcount by 1
4345 \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
4346 % separator; typically that is always in the input, anyway.
4347 \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
4350 \ifx\go\pickupwholefraction
4351 % Put the argument back for the \pickupwholefraction call, so
4352 % we'll always have a period there to be parsed.
4353 \def\go{\pickupwholefraction#1}%
4355 \let\go = \setuptable
4361 % multitable-only commands.
4363 % @headitem starts a heading row, which we typeset in bold. Assignments
4364 % have to be global since we are inside the implicit group of an
4365 % alignment entry. \everycr below resets \everytab so we don't have to
4366 % undo it ourselves.
4367 \def\headitemfont{\b}% for people to use in the template row; not changeable
4369 \checkenv\multitable
4371 \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings
4372 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
4373 \the\everytab % for the first item
4376 % default for tables with no headings.
4377 \let\headitemcrhook=\relax
4379 % A \tab used to include \hskip1sp. But then the space in a template
4380 % line is not enough. That is bad. So let's go back to just `&' until
4381 % we again encounter the problem the 1sp was intended to solve.
4382 % --karl, nathan@acm.org, 20apr99.
4383 \def\tab{\checkenv\multitable &\the\everytab}%
4385 % @multitable ... @end multitable definitions:
4387 \newtoks\everytab % insert after every tab.
4389 \envdef\multitable{%
4393 % @item within a multitable starts a normal row.
4394 % We use \def instead of \let so that if one of the multitable entries
4395 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
4396 % \endtemplate) expanding \doitemize.
4401 \setmultitablespacing
4402 \parskip=\multitableparskip
4403 \parindent=\multitableparindent
4409 \global\everytab={}% Reset from possible headitem.
4410 \global\colcount=0 % Reset the column counter.
4412 % Check for saved footnotes, etc.:
4415 % Perhaps a \nobreak, then reset:
4417 \global\let\headitemcrhook=\relax
4421 \parsearg\domultitable
4423 \def\domultitable#1{%
4424 % To parse everything between @multitable and @item:
4425 \setuptable#1 \endsetuptable
4427 % This preamble sets up a generic column definition, which will
4428 % be used as many times as user calls for columns.
4429 % \vtop will set a single line and will also let text wrap and
4430 % continue for many paragraphs if desired.
4432 \global\advance\colcount by 1
4435 % Use the current \colcount to find the correct column width:
4436 \hsize=\expandafter\csname col\the\colcount\endcsname
4438 % In order to keep entries from bumping into each other
4439 % we will add a \leftskip of \multitablecolspace to all columns after
4442 % If a template has been used, we will add \multitablecolspace
4443 % to the width of each template entry.
4445 % If the user has set preamble in terms of percent of \hsize we will
4446 % use that dimension as the width of the column, and the \leftskip
4447 % will keep entries from bumping into each other. Table will start at
4448 % left margin and final column will justify at right margin.
4450 % Make sure we don't inherit \rightskip from the outer environment.
4453 % The first column will be indented with the surrounding text.
4454 \advance\hsize by\leftskip
4457 % If user has not set preamble in terms of percent of \hsize
4458 % we will advance \hsize by \multitablecolspace.
4459 \advance\hsize by \multitablecolspace
4461 % In either case we will make \leftskip=\multitablecolspace:
4462 \leftskip=\multitablecolspace
4464 % Ignoring space at the beginning and end avoids an occasional spurious
4465 % blank line, when TeX decides to break the line at the space before the
4466 % box from the multistrut, so the strut ends up on a line by itself.
4468 % @multitable @columnfractions .11 .89
4470 % @tab Legal holiday which is valid in major parts of the whole country.
4471 % Is automatically provided with highlighting sequences respectively
4472 % marking characters.
4473 \noindent\ignorespaces##\unskip\multistrut
4478 \egroup % end the \halign
4479 \global\setpercentfalse
4482 \def\setmultitablespacing{%
4483 \def\multistrut{\strut}% just use the standard line spacing
4485 % Compute \multitablelinespace (if not defined by user) for use in
4486 % \multitableparskip calculation. We used define \multistrut based on
4487 % this, but (ironically) that caused the spacing to be off.
4488 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
4489 \ifdim\multitablelinespace=0pt
4490 \setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
4491 \global\advance\multitablelinespace by-\ht0
4493 % Test to see if parskip is larger than space between lines of
4494 % table. If not, do nothing.
4495 % If so, set to same dimension as multitablelinespace.
4496 \ifdim\multitableparskip>\multitablelinespace
4497 \global\multitableparskip=\multitablelinespace
4498 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4499 % than skip between lines in the table.
4501 \ifdim\multitableparskip=0pt
4502 \global\multitableparskip=\multitablelinespace
4503 \global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
4504 % than skip between lines in the table.
4508 \message{conditionals,}
4510 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4511 % @ifnotxml always succeed. They currently do nothing; we don't
4512 % attempt to check whether the conditionals are properly nested. But we
4513 % have to remember that they are conditionals, so that @end doesn't
4514 % attempt to close an environment group.
4517 \expandafter\let\csname #1\endcsname = \relax
4518 \expandafter\let\csname iscond.#1\endcsname = 1
4521 \makecond{ifnotdocbook}
4522 \makecond{ifnothtml}
4523 \makecond{ifnotinfo}
4524 \makecond{ifnotplaintext}
4527 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4529 \def\direntry{\doignore{direntry}}
4530 \def\documentdescription{\doignore{documentdescription}}
4531 \def\docbook{\doignore{docbook}}
4532 \def\html{\doignore{html}}
4533 \def\ifdocbook{\doignore{ifdocbook}}
4534 \def\ifhtml{\doignore{ifhtml}}
4535 \def\ifinfo{\doignore{ifinfo}}
4536 \def\ifnottex{\doignore{ifnottex}}
4537 \def\ifplaintext{\doignore{ifplaintext}}
4538 \def\ifxml{\doignore{ifxml}}
4539 \def\ignore{\doignore{ignore}}
4540 \def\menu{\doignore{menu}}
4541 \def\xml{\doignore{xml}}
4543 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4545 % A count to remember the depth of nesting.
4546 \newcount\doignorecount
4548 \def\doignore#1{\begingroup
4549 % Scan in ``verbatim'' mode:
4551 \catcode`\@ = \other
4552 \catcode`\{ = \other
4553 \catcode`\} = \other
4555 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4558 % Count number of #1's that we've seen.
4561 % Swallow text until we reach the matching `@end #1'.
4565 { \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
4568 \gdef\dodoignore#1{%
4569 % #1 contains the command name as a string, e.g., `ifinfo'.
4571 % Define a command to find the next `@end #1'.
4572 \long\def\doignoretext##1^^M@end #1{%
4573 \doignoretextyyy##1^^M@#1\_STOP_}%
4575 % And this command to find another #1 command, at the beginning of a
4576 % line. (Otherwise, we would consider a line `@c @ifset', for
4577 % example, to count as an @ifset for nesting.)
4578 \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
4580 % And now expand that command.
4585 \def\doignoreyyy#1{%
4587 \ifx\temp\empty % Nothing found.
4588 \let\next\doignoretextzzz
4589 \else % Found a nested condition, ...
4590 \advance\doignorecount by 1
4591 \let\next\doignoretextyyy % ..., look for another.
4592 % If we're here, #1 ends with ^^M\ifinfo (for example).
4594 \next #1% the token \_STOP_ is present just after this macro.
4597 % We have to swallow the remaining "\_STOP_".
4599 \def\doignoretextzzz#1{%
4600 \ifnum\doignorecount = 0 % We have just found the outermost @end.
4601 \let\next\enddoignore
4602 \else % Still inside a nested condition.
4603 \advance\doignorecount by -1
4604 \let\next\doignoretext % Look for the next @end.
4609 % Finish off ignored text.
4611 % Ignore anything after the last `@end #1'; this matters in verbatim
4612 % environments, where otherwise the newline after an ignored conditional
4613 % would result in a blank line in the output.
4614 \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
4618 % @set VAR sets the variable VAR to an empty value.
4619 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4621 % Since we want to separate VAR from REST-OF-LINE (which might be
4622 % empty), we can't just use \parsearg; we have to insert a space of our
4623 % own to delimit the rest of the line, and then take it out again if we
4625 % We rely on the fact that \parsearg sets \catcode`\ =10.
4627 \parseargdef\set{\setyyy#1 \endsetyyy}
4628 \def\setyyy#1 #2\endsetyyy{%
4630 \makevalueexpandable
4632 \edef\next{\gdef\makecsname{SET#1}}%
4640 % Remove the trailing space \setxxx inserted.
4641 \def\setzzz#1 \endsetzzz{\next{#1}}
4643 % @clear VAR clears (i.e., unsets) the variable VAR.
4645 \parseargdef\clear{%
4647 \makevalueexpandable
4648 \global\expandafter\let\csname SET#1\endcsname=\relax
4652 % @value{foo} gets the text saved in variable foo.
4653 \def\value{\begingroup\makevalueexpandable\valuexxx}
4654 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4656 \catcode`\-=\active \catcode`\_=\active
4658 \gdef\makevalueexpandable{%
4659 \let\value = \expandablevalue
4660 % We don't want these characters active, ...
4661 \catcode`\-=\other \catcode`\_=\other
4662 % ..., but we might end up with active ones in the argument if
4663 % we're called from @code, as @code{@value{foo-bar_}}, though.
4664 % So \let them to their normal equivalents.
4665 \let-\normaldash \let_\normalunderscore
4669 \def\expandablevalue#1{%
4670 \expandafter\ifx\csname SET#1\endcsname\relax
4671 {[No value for ``#1'']}%
4672 \message{Variable `#1', used in @value, is not set.}%
4674 \csname SET#1\endcsname
4678 % Like \expandablevalue, but completely expandable (the \message in the
4679 % definition above operates at the execution level of TeX). Used when
4680 % writing to auxiliary files, due to the expansion that \write does.
4681 % If flag is undefined, pass through an unexpanded @value command: maybe it
4682 % will be set by the time it is read back in.
4684 % NB flag names containing - or _ may not work here.
4686 \expandafter\ifx\csname SET#1\endcsname\relax
4689 \csname SET#1\endcsname
4693 % Used for @value's in index entries to form the sort key: expand the @value
4694 % if possible, otherwise sort late.
4695 \def\indexnofontsvalue#1{%
4696 \expandafter\ifx\csname SET#1\endcsname\relax
4699 \csname SET#1\endcsname
4703 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4706 % To get the special treatment we need for `@end ifset,' we call
4707 % \makecond and then redefine.
4710 \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
4713 \makevalueexpandable
4715 \expandafter\ifx\csname SET#2\endcsname\relax
4716 #1% If not set, redefine \next.
4721 \def\ifsetfail{\doignore{ifset}}
4723 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4724 % defined with @set, or has been undefined with @clear.
4726 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4727 % above code: if the variable is not set, do nothing, if it is set,
4728 % then redefine \next to \ifclearfail.
4731 \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
4732 \def\ifclearfail{\doignore{ifclear}}
4734 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4735 % without the @) is in fact defined. We can only feasibly check at the
4736 % TeX level, so something like `mathcode' is going to considered
4737 % defined even though it is not a Texinfo command.
4739 \makecond{ifcommanddefined}
4740 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
4742 \def\doifcmddefined#1#2{{%
4743 \makevalueexpandable
4745 \expandafter\ifx\csname #2\endcsname\relax
4746 #1% If not defined, \let\next as above.
4751 \def\ifcmddefinedfail{\doignore{ifcommanddefined}}
4753 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4754 \makecond{ifcommandnotdefined}
4755 \def\ifcommandnotdefined{%
4756 \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
4757 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
4759 % Set the `txicommandconditionals' variable, so documents have a way to
4760 % test if the @ifcommand...defined conditionals are available.
4761 \set txicommandconditionals
4763 % @dircategory CATEGORY -- specify a category of the dir file
4764 % which this file should belong to. Ignore this in TeX.
4765 \let\dircategory=\comment
4767 % @defininfoenclose.
4768 \let\definfoenclose=\comment
4772 % Index generation facilities
4774 % Define \newwrite to be identical to plain tex's \newwrite
4775 % except not \outer, so it can be used within macros and \if's.
4776 \edef\newwrite{\makecsname{ptexnewwrite}}
4778 % \newindex {foo} defines an index named IX.
4779 % It automatically defines \IXindex such that
4780 % \IXindex ...rest of line... puts an entry in the index IX.
4781 % It also defines \IXindfile to be the number of the output channel for
4782 % the file that accumulates this index. The file's extension is IX.
4783 % The name of an index should be no more than 2 characters long
4784 % for the sake of vms.
4787 \expandafter\chardef\csname#1indfile\endcsname=0
4788 \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
4789 \noexpand\doindex{#1}}
4792 % @defindex foo == \newindex{foo}
4794 \def\defindex{\parsearg\newindex}
4796 % Define @defcodeindex, like @defindex except put all entries in @code.
4798 \def\defcodeindex{\parsearg\newcodeindex}
4800 \def\newcodeindex#1{%
4801 \expandafter\chardef\csname#1indfile\endcsname=0
4802 \expandafter\xdef\csname#1index\endcsname{%
4803 \noexpand\docodeindex{#1}}%
4806 % The default indices:
4807 \newindex{cp}% concepts,
4808 \newcodeindex{fn}% functions,
4809 \newcodeindex{vr}% variables,
4810 \newcodeindex{tp}% types,
4811 \newcodeindex{ky}% keys
4812 \newcodeindex{pg}% and programs.
4815 % @synindex foo bar makes index foo feed into index bar.
4816 % Do this instead of @defindex foo if you don't want it as a separate index.
4818 % @syncodeindex foo bar similar, but put all entries made for index foo
4821 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4822 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4824 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4825 % #3 the target index (bar).
4826 \def\dosynindex#1#2#3{%
4827 \requireopenindexfile{#3}%
4828 % redefine \fooindfile:
4829 \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
4830 \expandafter\let\csname#2indfile\endcsname=\temp
4831 % redefine \fooindex:
4832 \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
4835 % Define \doindex, the driver for all index macros.
4836 % Argument #1 is generated by the calling \fooindex macro,
4837 % and it is the two-letter name of the index.
4839 \def\doindex#1{\edef\indexname{#1}\parsearg\doindexxxx}
4840 \def\doindexxxx #1{\doind{\indexname}{#1}}
4842 % like the previous two, but they put @code around the argument.
4843 \def\docodeindex#1{\edef\indexname{#1}\parsearg\docodeindexxxx}
4844 \def\docodeindexxxx #1{\doind{\indexname}{\code{#1}}}
4847 % Used for the aux, toc and index files to prevent expansion of Texinfo
4851 \definedummyletter\@%
4852 \definedummyletter\ %
4853 \definedummyletter\{%
4854 \definedummyletter\}%
4855 \definedummyletter\&%
4857 % Do the redefinitions.
4862 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4863 % preventing its expansion. This is used only for control words,
4864 % not control letters, because the \space would be incorrect for
4865 % control characters, but is needed to separate the control word
4866 % from whatever follows.
4868 % These can be used both for control words that take an argument and
4869 % those that do not. If it is followed by {arg} in the input, then
4870 % that will dutifully get written to the index (or wherever).
4872 % For control letters, we have \definedummyletter, which omits the
4875 \def\definedummyword #1{\def#1{\string#1\space}}%
4876 \def\definedummyletter#1{\def#1{\string#1}}%
4877 \let\definedummyaccent\definedummyletter
4879 % Called from \atdummies to prevent the expansion of commands.
4881 \def\definedummies{%
4883 \let\commondummyword\definedummyword
4884 \let\commondummyletter\definedummyletter
4885 \let\commondummyaccent\definedummyaccent
4886 \commondummiesnofonts
4888 \definedummyletter\_%
4889 \definedummyletter\-%
4891 % Non-English letters.
4902 \definedummyword\exclamdown
4906 \definedummyword\ordf
4907 \definedummyword\ordm
4908 \definedummyword\questiondown
4912 % Although these internal commands shouldn't show up, sometimes they do.
4914 \definedummyword\gtr
4915 \definedummyword\hat
4916 \definedummyword\less
4919 \definedummyword\tclose
4922 \definedummyword\LaTeX
4923 \definedummyword\TeX
4925 % Assorted special characters.
4926 \definedummyword\ampchar
4927 \definedummyword\atchar
4928 \definedummyword\arrow
4929 \definedummyword\backslashchar
4930 \definedummyword\bullet
4931 \definedummyword\comma
4932 \definedummyword\copyright
4933 \definedummyword\registeredsymbol
4934 \definedummyword\dots
4935 \definedummyword\enddots
4936 \definedummyword\entrybreak
4937 \definedummyword\equiv
4938 \definedummyword\error
4939 \definedummyword\euro
4940 \definedummyword\expansion
4941 \definedummyword\geq
4942 \definedummyword\guillemetleft
4943 \definedummyword\guillemetright
4944 \definedummyword\guilsinglleft
4945 \definedummyword\guilsinglright
4946 \definedummyword\lbracechar
4947 \definedummyword\leq
4948 \definedummyword\mathopsup
4949 \definedummyword\minus
4950 \definedummyword\ogonek
4951 \definedummyword\pounds
4952 \definedummyword\point
4953 \definedummyword\print
4954 \definedummyword\quotedblbase
4955 \definedummyword\quotedblleft
4956 \definedummyword\quotedblright
4957 \definedummyword\quoteleft
4958 \definedummyword\quoteright
4959 \definedummyword\quotesinglbase
4960 \definedummyword\rbracechar
4961 \definedummyword\result
4962 \definedummyword\sub
4963 \definedummyword\sup
4964 \definedummyword\textdegree
4966 \definedummyword\subentry
4968 % We want to disable all macros so that they are not expanded by \write.
4970 \let\value\dummyvalue
4972 \normalturnoffactive
4975 % \commondummiesnofonts: common to \definedummies and \indexnofonts.
4976 % Define \commondummyletter, \commondummyaccent and \commondummyword before
4977 % using. Used for accents, font commands, and various control letters.
4979 \def\commondummiesnofonts{%
4980 % Control letters and accents.
4981 \commondummyletter\!%
4982 \commondummyaccent\"%
4983 \commondummyaccent\'%
4984 \commondummyletter\*%
4985 \commondummyaccent\,%
4986 \commondummyletter\.%
4987 \commondummyletter\/%
4988 \commondummyletter\:%
4989 \commondummyaccent\=%
4990 \commondummyletter\?%
4991 \commondummyaccent\^%
4992 \commondummyaccent\`%
4993 \commondummyaccent\~%
4997 \commondummyword\dotaccent
4998 \commondummyword\ogonek
4999 \commondummyword\ringaccent
5000 \commondummyword\tieaccent
5001 \commondummyword\ubaraccent
5002 \commondummyword\udotaccent
5003 \commondummyword\dotless
5005 % Texinfo font commands.
5009 \commondummyword\sansserif
5011 \commondummyword\slanted
5014 % Commands that take arguments.
5015 \commondummyword\abbr
5016 \commondummyword\acronym
5017 \commondummyword\anchor
5018 \commondummyword\cite
5019 \commondummyword\code
5020 \commondummyword\command
5021 \commondummyword\dfn
5022 \commondummyword\dmn
5023 \commondummyword\email
5024 \commondummyword\emph
5025 \commondummyword\env
5026 \commondummyword\file
5027 \commondummyword\image
5028 \commondummyword\indicateurl
5029 \commondummyword\inforef
5030 \commondummyword\kbd
5031 \commondummyword\key
5032 \commondummyword\math
5033 \commondummyword\option
5034 \commondummyword\pxref
5035 \commondummyword\ref
5036 \commondummyword\samp
5037 \commondummyword\strong
5038 \commondummyword\tie
5040 \commondummyword\uref
5041 \commondummyword\url
5042 \commondummyword\var
5043 \commondummyword\verb
5045 \commondummyword\xref
5048 \let\indexlbrace\relax
5049 \let\indexrbrace\relax
5050 \let\indexatchar\relax
5051 \let\indexbackslash\relax
5055 @gdef@backslashdisappear{@def\{}}
5062 \gdef\indexnonalnumdisappear{%
5063 \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax\else
5064 % @set txiindexlquoteignore makes us ignore left quotes in the sort term.
5065 % (Introduced for FSFS 2nd ed.)
5069 \expandafter\ifx\csname SETtxiindexbackslashignore\endcsname\relax\else
5073 \expandafter\ifx\csname SETtxiindexhyphenignore\endcsname\relax\else
5076 \expandafter\ifx\csname SETtxiindexlessthanignore\endcsname\relax\else
5079 \expandafter\ifx\csname SETtxiindexatsignignore\endcsname\relax\else
5084 \gdef\indexnonalnumreappear{%
5091 % \indexnofonts is used when outputting the strings to sort the index
5092 % by, and when constructing control sequence names. It eliminates all
5093 % control sequences and just writes whatever the best ASCII sort string
5094 % would be for a given command (usually its argument).
5097 % Accent commands should become @asis.
5098 \def\commondummyaccent##1{\let##1\asis}%
5099 % We can just ignore other control letters.
5100 \def\commondummyletter##1{\let##1\empty}%
5101 % All control words become @asis by default; overrides below.
5102 \let\commondummyword\commondummyaccent
5103 \commondummiesnofonts
5105 % Don't no-op \tt, since it isn't a user-level command
5106 % and is used in the definitions of the active chars like <, >, |, etc.
5107 % Likewise with the other plain tex font commands.
5112 \def\_{\normalunderscore}%
5113 \def\-{}% @- shouldn't affect sorting
5115 \uccode`\1=`\{ \uppercase{\def\{{1}}%
5116 \uccode`\1=`\} \uppercase{\def\}{1}}%
5120 % Non-English letters.
5137 \def\questiondown{?}%
5144 % Assorted special characters. \defglyph gives the control sequence a
5145 % definition that removes the {} that follows its use.
5146 \defglyph\atchar{@}%
5147 \defglyph\arrow{->}%
5148 \defglyph\bullet{bullet}%
5150 \defglyph\copyright{copyright}%
5151 \defglyph\dots{...}%
5152 \defglyph\enddots{...}%
5153 \defglyph\equiv{==}%
5154 \defglyph\error{error}%
5155 \defglyph\euro{euro}%
5156 \defglyph\expansion{==>}%
5158 \defglyph\guillemetleft{<<}%
5159 \defglyph\guillemetright{>>}%
5160 \defglyph\guilsinglleft{<}%
5161 \defglyph\guilsinglright{>}%
5163 \defglyph\lbracechar{\{}%
5166 \defglyph\pounds{pounds}%
5167 \defglyph\print{-|}%
5168 \defglyph\quotedblbase{"}%
5169 \defglyph\quotedblleft{"}%
5170 \defglyph\quotedblright{"}%
5171 \defglyph\quoteleft{`}%
5172 \defglyph\quoteright{'}%
5173 \defglyph\quotesinglbase{,}%
5174 \defglyph\rbracechar{\}}%
5175 \defglyph\registeredsymbol{R}%
5176 \defglyph\result{=>}%
5177 \defglyph\textdegree{o}%
5179 % We need to get rid of all macros, leaving only the arguments (if present).
5180 % Of course this is not nearly correct, but it is the best we can do for now.
5181 % makeinfo does not expand macros in the argument to @deffn, which ends up
5182 % writing an index entry, and texindex isn't prepared for an index sort entry
5183 % that starts with \.
5185 % Since macro invocations are followed by braces, we can just redefine them
5186 % to take a single TeX argument. The case of a macro invocation that
5187 % goes to end-of-line is not handled.
5190 \let\value\indexnofontsvalue
5192 \def\defglyph#1#2{\def#1##1{#2}} % see above
5197 % #1 is the index name, #2 is the entry text.
5202 \requireopenindexfile{#1}%
5203 \edef\writeto{\csname#1indfile\endcsname}%
5206 \safewhatsit\doindwrite
5211 % Check if an index file has been opened, and if not, open it.
5212 \def\requireopenindexfile#1{%
5213 \ifnum\csname #1indfile\endcsname=0
5214 \expandafter\newwrite \csname#1indfile\endcsname
5216 % A .fls suffix would conflict with the file extension for the output
5217 % of -recorder, so use .f1s instead.
5218 \ifx\suffix\indexisfl\def\suffix{f1}\fi
5220 \immediate\openout\csname#1indfile\endcsname \jobname.\suffix
5221 % Using \immediate above here prevents an object entering into the current
5222 % box, which could confound checks such as those in \safewhatsit for
5224 \typeout{Writing index file \jobname.\suffix}%
5228 % Definition for writing index entry sort key.
5231 \gdef\indexwritesortas{%
5233 \indexnonalnumreappear
5234 \indexwritesortasxxx}
5235 \gdef\indexwritesortasxxx#1{%
5236 \xdef\indexsortkey{#1}\endgroup}
5239 \def\indexwriteseealso#1{
5240 \gdef\pagenumbertext{\string\seealso{#1}}%
5242 \def\indexwriteseeentry#1{
5243 \gdef\pagenumbertext{\string\seeentry{#1}}%
5246 % The default definitions
5248 \def\seealso#1{\i{\putwordSeeAlso}\ #1}% for sorted index file only
5249 \def\putwordSeeAlso{See also}
5250 \def\seeentry#1{\i{\putwordSee}\ #1}% for sorted index file only
5253 % Given index entry text like "aaa @subentry bbb @sortas{ZZZ}":
5254 % * Set \bracedtext to "{aaa}{bbb}"
5255 % * Set \fullindexsortkey to "aaa @subentry ZZZ"
5256 % * If @seealso occurs, set \pagenumbertext
5258 \def\splitindexentry#1{%
5259 \gdef\fullindexsortkey{}%
5264 \expandafter\doindexsegment#1\subentry\finish\subentry
5267 % append the results from the next segment
5268 \def\doindexsegment#1\subentry{%
5270 \ifx\segment\isfinish
5273 % Fully expand the segment, throwing away any @sortas directives, and
5275 \edef\trimmed{\segment}%
5276 \edef\trimmed{\expandafter\eatspaces\expandafter{\trimmed}}%
5278 \xdef\bracedtext{\bracedtext{\trimmed}}%
5280 % Get the string to sort by. Process the segment with all
5281 % font commands turned off.
5283 \let\sortas\indexwritesortas
5284 \let\seealso\indexwriteseealso
5285 \let\seeentry\indexwriteseeentry
5287 % The braces around the commands are recognized by texindex.
5288 \def\lbracechar{{\string\indexlbrace}}%
5289 \def\rbracechar{{\string\indexrbrace}}%
5292 \def\@{{\string\indexatchar}}%
5294 \def\backslashchar{{\string\indexbackslash}}%
5295 \uccode`\~=`\\ \uppercase{\let~\backslashchar}%
5297 \let\indexsortkey\empty
5298 \global\let\pagenumbertext\empty
5299 % Execute the segment and throw away the typeset output. This executes
5300 % any @sortas or @seealso commands in this segment.
5301 \setbox\dummybox = \hbox{\segment}%
5302 \ifx\indexsortkey\empty{%
5303 \indexnonalnumdisappear
5304 \xdef\trimmed{\segment}%
5305 \xdef\trimmed{\expandafter\eatspaces\expandafter{\trimmed}}%
5306 \xdef\indexsortkey{\trimmed}%
5307 \ifx\indexsortkey\empty\xdef\indexsortkey{ }\fi
5310 % Append to \fullindexsortkey.
5311 \edef\tmp{\gdef\noexpand\fullindexsortkey{%
5312 \fullindexsortkey\sep\indexsortkey}}%
5315 \def\sep{\subentry}%
5317 \expandafter\doindexsegment
5320 \def\isfinish{\finish}%
5321 \newbox\dummybox % used above
5325 % Use \ instead of @ in index files. To support old texi2dvi and texindex.
5326 % This works without changing the escape character used in the toc or aux
5327 % files because the index entries are fully expanded here, and \string uses
5328 % the current value of \escapechar.
5329 \def\escapeisbackslash{\escapechar=`\\}
5331 % Use \ in index files by default. texi2dvi didn't support @ as the escape
5332 % character (as it checked for "\entry" in the files, and not "@entry"). When
5333 % the new version of texi2dvi has had a chance to become more prevalent, then
5334 % the escape character can change back to @ again. This should be an easy
5335 % change to make now because both @ and \ are only used as escape characters in
5336 % index files, never standing for themselves.
5338 \set txiindexescapeisbackslash
5340 % Write the entry in \indextext to the index file.
5347 \expandafter\ifx\csname SETtxiindexescapeisbackslash\endcsname\relax\else
5351 % For texindex which always views { and } as separators.
5352 \def\{{\lbracechar{}}%
5353 \def\}{\rbracechar{}}%
5354 \uccode`\~=`\\ \uppercase{\def~{\backslashchar{}}}%
5356 % Split the entry into primary entry and any subentries, and get the index
5358 \splitindexentry\indextext
5360 % Set up the complete index entry, with both the sort key and
5361 % the original text, including any font commands. We write
5362 % three arguments to \entry to the .?? file (four in the
5363 % subentry case), texindex reduces to two when writing the .??s
5368 \string\entry{\fullindexsortkey}%
5369 {\ifx\pagenumbertext\empty\noexpand\folio\else\pagenumbertext\fi}%
5375 % Put the index entry in the margin if desired (undocumented).
5376 \def\maybemarginindex{%
5377 \ifx\SETmarginindex\relax\else
5378 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \relax\indextext}}%
5381 \let\SETmarginindex=\relax
5384 % Take care of unwanted page breaks/skips around a whatsit:
5386 % If a skip is the last thing on the list now, preserve it
5387 % by backing up by \lastskip, doing the \write, then inserting
5388 % the skip again. Otherwise, the whatsit generated by the
5389 % \write or \pdfdest will make \lastskip zero. The result is that
5390 % sequences like this:
5394 % will have extra space inserted, because the \medbreak in the
5395 % start of the @defun won't see the skip inserted by the @end of
5396 % the previous defun.
5398 % But don't do any of this if we're not in vertical mode. We
5399 % don't want to do a \vskip and prematurely end a paragraph.
5401 % Avoid page breaks due to these extra skips, too.
5403 % But wait, there is a catch there:
5404 % We'll have to check whether \lastskip is zero skip. \ifdim is not
5405 % sufficient for this purpose, as it ignores stretch and shrink parts
5406 % of the skip. The only way seems to be to check the textual
5407 % representation of the skip.
5409 % The following is almost like \def\zeroskipmacro{0.0pt} except that
5410 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
5412 \edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
5414 \newskip\whatsitskip
5415 \newcount\whatsitpenalty
5419 \def\safewhatsit#1{\ifhmode
5422 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
5423 \whatsitskip = \lastskip
5424 \edef\lastskipmacro{\the\lastskip}%
5425 \whatsitpenalty = \lastpenalty
5427 % If \lastskip is nonzero, that means the last item was a
5428 % skip. And since a skip is discardable, that means this
5429 % -\whatsitskip glue we're inserting is preceded by a
5430 % non-discardable item, therefore it is not a potential
5431 % breakpoint, therefore no \nobreak needed.
5432 \ifx\lastskipmacro\zeroskipmacro
5439 \ifx\lastskipmacro\zeroskipmacro
5440 % If \lastskip was zero, perhaps the last item was a penalty, and
5441 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
5442 % to re-insert the same penalty (values >10000 are used for various
5443 % signals); since we just inserted a non-discardable item, any
5444 % following glue (such as a \parskip) would be a breakpoint. For example:
5445 % @deffn deffn-whatever
5446 % @vindex index-whatever
5448 % would allow a break between the index-whatever whatsit
5449 % and the "Description." paragraph.
5450 \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
5452 % On the other hand, if we had a nonzero \lastskip,
5453 % this make-up glue would be preceded by a non-discardable item
5454 % (the whatsit from the \write), so we must insert a \nobreak.
5455 \nobreak\vskip\whatsitskip
5459 % The index entry written in the file actually looks like
5460 % \entry {sortstring}{page}{topic}
5462 % \entry {sortstring}{page}{topic}{subtopic}
5463 % The texindex program reads in these files and writes files
5464 % containing these kinds of lines:
5466 % before the first topic whose initial is c
5467 % \entry {topic}{pagelist}
5468 % for a topic that is used without subtopics
5471 % for the beginning of a topic that is used with subtopics
5472 % \secondary {subtopic}{pagelist}
5473 % for each subtopic.
5474 % \secondary {subtopic}{}
5475 % for a subtopic with sub-subtopics
5476 % \tertiary {subtopic}{subsubtopic}{pagelist}
5477 % for each sub-subtopic.
5479 % Define the user-accessible indexing commands
5480 % @findex, @vindex, @kindex, @cindex.
5482 \def\findex {\fnindex}
5483 \def\kindex {\kyindex}
5484 \def\cindex {\cpindex}
5485 \def\vindex {\vrindex}
5486 \def\tindex {\tpindex}
5487 \def\pindex {\pgindex}
5489 % Define the macros used in formatting output of the sorted index material.
5491 % @printindex causes a particular index (the ??s file) to get printed.
5492 % It does not print any chapter heading (usually an @unnumbered).
5494 \parseargdef\printindex{\begingroup
5495 \dobreak \chapheadingskip{10000}%
5500 \everypar = {}% don't want the \kern\-parindent from indentation suppression.
5502 % See comment in \requireopenindexfile.
5503 \def\indexname{#1}\ifx\indexname\indexisfl\def\indexname{f1}\fi
5505 % See if the index file exists and is nonempty.
5506 \openin 1 \jobname.\indexname s
5508 % \enddoublecolumns gets confused if there is no text in the index,
5509 % and it loses the chapter title and the aux file entries for the
5510 % index. The easiest way to prevent this problem is to make sure
5511 % there is some text.
5512 \putwordIndexNonexistent
5513 \typeout{No file \jobname.\indexname s.}%
5515 % If the index file exists but is empty, then \openin leaves \ifeof
5516 % false. We have to make TeX try to read something from the file, so
5517 % it can discover if there is anything in it.
5518 \read 1 to \thisline
5520 \putwordIndexIsEmpty
5522 \expandafter\printindexzz\thisline\relax\relax\finish%
5528 % If the index file starts with a backslash, forgo reading the index
5529 % file altogether. If somebody upgrades texinfo.tex they may still have
5530 % old index files using \ as the escape character. Reading this would
5531 % at best lead to typesetting garbage, at worst a TeX syntax error.
5532 \def\printindexzz#1#2\finish{%
5533 \expandafter\ifx\csname SETtxiindexescapeisbackslash\endcsname\relax
5534 \uccode`\~=`\\ \uppercase{\if\noexpand~}\noexpand#1
5535 \expandafter\ifx\csname SETtxiskipindexfileswithbackslash\endcsname\relax
5537 ERROR: A sorted index file in an obsolete format was skipped.
5538 To fix this problem, please upgrade your version of 'texi2dvi'
5539 or 'texi2pdf' to that at <https://ftp.gnu.org/gnu/texinfo>.
5540 If you are using an old version of 'texindex' (part of the Texinfo
5541 distribution), you may also need to upgrade to a newer version (at least 6.0).
5542 You may be able to typeset the index if you run
5543 'texindex \jobname.\indexname' yourself.
5544 You could also try setting the 'txiindexescapeisbackslash' flag by
5545 running a command like
5546 'texi2dvi -t "@set txiindexescapeisbackslash" \jobname.texi'. If you do
5547 this, Texinfo will try to use index files in the old format.
5548 If you continue to have problems, deleting the index files and starting again
5549 might help (with 'rm \jobname.?? \jobname.??s')%
5552 (Skipped sorted index file in obsolete format)
5556 \input \jobname.\indexname s
5562 \catcode`\@=12\relax
5563 \input \jobname.\indexname s
5568 % These macros are used by the sorted index file itself.
5569 % Change them to control the appearance of the index.
5571 {\catcode`\/=13 \catcode`\-=13 \catcode`\^=13 \catcode`\~=13 \catcode`\_=13
5572 \catcode`\|=13 \catcode`\<=13 \catcode`\>=13 \catcode`\+=13 \catcode`\"=13
5574 \gdef\initialglyphs{%
5575 % special control sequences used in the index sort key
5579 \def\indexbackslash{\math{\backslash}}%
5581 % Some changes for non-alphabetic characters. Using the glyphs from the
5582 % math fonts looks more consistent than the typewriter font used elsewhere
5583 % for these characters.
5584 \uccode`\~=`\\ \uppercase{\def~{\math{\backslash}}}
5586 % In case @\ is used for backslash
5587 \uppercase{\let\\=~}
5588 % Can't get bold backslash so don't use bold forward slash
5590 \def/{{\secrmnotbold \normalslash}}%
5591 \def-{{\normaldash\normaldash}}% en dash `--'
5592 \def^{{\chapbf \normalcaret}}%
5593 \def~{{\chapbf \normaltilde}}%
5595 \leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }%
5599 \def+{$\normalplus$}%
5609 % Remove any glue we may have, we'll be inserting our own.
5612 % We like breaks before the index initials, so insert a bonus.
5613 % The glue before the bonus allows a little bit of space at the
5614 % bottom of a column to reduce an increase in inter-line spacing.
5616 \vskip 0pt plus 5\baselineskip
5618 \vskip 0pt plus -5\baselineskip
5620 % Typeset the initial. Making this add up to a whole number of
5621 % baselineskips increases the chance of the dots lining up from column
5622 % to column. It still won't often be perfect, because of the stretch
5623 % we need before each entry, but it's better.
5625 % No shrink because it confuses \balancecolumns.
5626 \vskip 1.67\baselineskip plus 1\baselineskip
5627 \leftline{\secfonts \kern-0.05em \secbf #1}%
5628 % \secfonts is inside the argument of \leftline so that the change of
5629 % \baselineskip will not affect any glue inserted before the vbox that
5630 % \leftline creates.
5631 % Do our best not to break after the initial.
5633 \vskip .33\baselineskip plus .1\baselineskip
5634 \egroup % \initialglyphs
5637 \newdimen\entryrightmargin
5638 \entryrightmargin=0pt
5640 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
5641 % then page number (#2) flushed to the right margin. It is used for index
5642 % and table of contents entries. The paragraph is indented by \leftskip.
5647 % Start a new paragraph if necessary, so our assignments below can't
5648 % affect previous text.
5651 % No extra space above this paragraph.
5654 % When reading the text of entry, convert explicit line breaks
5655 % from @* into spaces. The user might give these in long section
5656 % titles, for instance.
5657 \def\*{\unskip\space\ignorespaces}%
5658 \def\entrybreak{\hfil\break}% An undocumented command
5660 % Swallow the left brace of the text (first parameter):
5661 \afterassignment\doentry
5664 \def\entrybreak{\unskip\space\ignorespaces}%
5666 % Save the text of the entry
5667 \global\setbox\boxA=\hbox\bgroup
5668 \bgroup % Instead of the swallowed brace.
5670 \aftergroup\finishentry
5671 % And now comes the text of the entry.
5672 % Not absorbing as a macro argument reduces the chance of problems
5673 % with catcodes occurring.
5676 \gdef\finishentry#1{%
5678 \dimen@ = \wd\boxA % Length of text of entry
5679 \global\setbox\boxA=\hbox\bgroup
5681 % #1 is the page number.
5683 % Get the width of the page numbers, and only use
5684 % leaders if they are present.
5685 \global\setbox\boxB = \hbox{#1}%
5686 \ifdim\wd\boxB = 0pt
5687 \null\nobreak\hfill\ %
5690 \null\nobreak\indexdotfill % Have leaders before the page number.
5694 \hskip\skip\thinshrinkable\the\toksA
5696 \hskip\skip\thinshrinkable #1%
5700 \ifdim\wd\boxB = 0pt
5701 \noindent\unhbox\boxA\par
5704 % We want the text of the entries to be aligned to the left, and the
5705 % page numbers to be aligned to the right.
5708 \advance\leftskip by 0pt plus 1fil
5709 \advance\leftskip by 0pt plus -1fill
5710 \rightskip = 0pt plus -1fil
5711 \advance\rightskip by 0pt plus 1fill
5712 % Cause last line, which could consist of page numbers on their own
5713 % if the list of page numbers is long, to be aligned to the right.
5714 \parfillskip=0pt plus -1fill
5716 \advance\rightskip by \entryrightmargin
5717 % Determine how far we can stretch into the margin.
5718 % This allows, e.g., "Appendix H GNU Free Documentation License" to
5719 % fit on one line in @letterpaper format.
5720 \ifdim\entryrightmargin>2.1em
5725 \advance \parfillskip by 0pt minus 1\dimen@i
5728 \advance\dimen@ii by -1\leftskip
5729 \advance\dimen@ii by -1\entryrightmargin
5730 \advance\dimen@ii by 1\dimen@i
5731 \ifdim\wd\boxA > \dimen@ii % If the entry doesn't fit in one line
5732 \ifdim\dimen@ > 0.8\dimen@ii % due to long index text
5733 % Try to split the text roughly evenly. \dimen@ will be the length of
5735 \dimen@ = 0.7\dimen@
5737 \ifnum\dimen@>\dimen@ii
5738 % If the entry is too long (for example, if it needs more than
5739 % two lines), use all the space in the first line.
5742 \advance\leftskip by 0pt plus 1fill % ragged right
5743 \advance \dimen@ by 1\rightskip
5744 \parshape = 2 0pt \dimen@ 0em \dimen@ii
5745 % Ideally we'd add a finite glue at the end of the first line only,
5746 % instead of using \parshape with explicit line lengths, but TeX
5747 % doesn't seem to provide a way to do such a thing.
5749 % Indent all lines but the first one.
5750 \advance\leftskip by 1em
5751 \advance\parindent by -1em
5753 \indent % start paragraph
5756 % Do not prefer a separate line ending with a hyphen to fewer lines.
5757 \finalhyphendemerits = 0
5759 % Word spacing - no stretch
5760 \spaceskip=\fontdimen2\font minus \fontdimen4\font
5762 \linepenalty=1000 % Discourage line breaks.
5763 \hyphenpenalty=5000 % Discourage hyphenation.
5765 \par % format the paragraph
5771 \newskip\thinshrinkable
5772 \skip\thinshrinkable=.15em minus .15em
5774 % Like plain.tex's \dotfill, except uses up at least 1 em.
5775 % The filll stretch here overpowers both the fil and fill stretch to push
5776 % the page number to the right.
5777 \def\indexdotfill{\cleaders
5778 \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1filll}
5781 \def\primary #1{\line{#1\hfil}}
5783 \def\secondary{\indententry{0.5cm}}
5784 \def\tertiary{\indententry{1cm}}
5786 \def\indententry#1#2#3{%
5793 % Define two-column mode, which we use to typeset indexes.
5794 % Adapted from the TeXbook, page 416, which is to say,
5795 % the manmac.tex format used to print the TeXbook itself.
5796 \catcode`\@=11 % private names
5799 \newdimen\doublecolumnhsize
5801 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5802 % If not much space left on page, start a new page.
5803 \ifdim\pagetotal>0.8\vsize\vfill\eject\fi
5805 % Grab any single-column material above us.
5809 \global\setbox\partialpage = \vbox{%
5810 % Unvbox the main output page.
5812 \kern-\topskip \kern\baselineskip
5815 \eject % run that output routine to set \partialpage
5817 % Use the double-column output routine for subsequent pages.
5818 \output = {\doublecolumnout}%
5820 % Change the page size parameters. We could do this once outside this
5821 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5822 % format, but then we repeat the same computation. Repeating a couple
5823 % of assignments once per index is clearly meaningless for the
5824 % execution time, so we may as well do it in one place.
5826 % First we halve the line length, less a little for the gutter between
5827 % the columns. We compute the gutter based on the line length, so it
5828 % changes automatically with the paper format. The magic constant
5829 % below is chosen so that the gutter has the same value (well, +-<1pt)
5830 % as it did when we hard-coded it.
5832 % We put the result in a separate register, \doublecolumhsize, so we
5833 % can restore it in \pagesofar, after \hsize itself has (potentially)
5836 \doublecolumnhsize = \hsize
5837 \advance\doublecolumnhsize by -.04154\hsize
5838 \divide\doublecolumnhsize by 2
5839 \hsize = \doublecolumnhsize
5841 % Get the available space for the double columns -- the normal
5842 % (undoubled) page height minus any material left over from the
5844 \advance\vsize by -\ht\partialpage
5847 % For the benefit of balancing columns
5848 \advance\baselineskip by 0pt plus 0.5pt
5851 % The double-column output routine for all double-column pages except
5852 % the last, which is done by \balancecolumns.
5854 \def\doublecolumnout{%
5857 \splittopskip=\topskip \splitmaxdepth=\maxdepth
5861 % box0 will be the left-hand column, box2 the right.
5862 \setbox0=\vsplit\PAGE to\dimen@ \setbox2=\vsplit\PAGE to\dimen@
5863 \global\advance\vsize by 2\ht\partialpage
5864 \onepageout\pagesofar % empty except for the first time we are called
5866 \penalty\outputpenalty
5869 % Re-output the contents of the output page -- any previous material,
5870 % followed by the two boxes we just split, in box0 and box2.
5874 \hsize = \doublecolumnhsize
5875 \wd0=\hsize \wd2=\hsize
5876 \hbox to\txipagewidth{\box0\hfil\box2}%
5880 % Finished with double columns.
5881 \def\enddoublecolumns{%
5882 % The following penalty ensures that the page builder is exercised
5883 % _before_ we change the output routine. This is necessary in the
5884 % following situation:
5886 % The last section of the index consists only of a single entry.
5887 % Before this section, \pagetotal is less than \pagegoal, so no
5888 % break occurs before the last section starts. However, the last
5889 % section, consisting of \initial and the single \entry, does not
5890 % fit on the page and has to be broken off. Without the following
5891 % penalty the page builder will not be exercised until \eject
5892 % below, and by that time we'll already have changed the output
5893 % routine to the \balancecolumns version, so the next-to-last
5894 % double-column page will be processed with \balancecolumns, which
5895 % is wrong: The two columns will go to the main vertical list, with
5896 % the broken-off section in the recent contributions. As soon as
5897 % the output routine finishes, TeX starts reconsidering the page
5898 % break. The two columns and the broken-off section both fit on the
5899 % page, because the two columns now take up only half of the page
5900 % goal. When TeX sees \eject from below which follows the final
5901 % section, it invokes the new output routine that we've set after
5902 % \balancecolumns below; \onepageout will try to fit the two columns
5903 % and the final section into the vbox of \txipageheight (see
5904 % \pagebody), causing an overfull box.
5906 % Note that glue won't work here, because glue does not exercise the
5907 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5911 % Split the last of the double-column material.
5915 \eject % call the \output just set
5916 \ifdim\pagetotal=0pt
5917 % Having called \balancecolumns once, we do not
5918 % want to call it again. Therefore, reset \output to its normal
5919 % definition right away.
5920 \global\output=\expandafter{\the\defaultoutput}
5922 \endgroup % started in \begindoublecolumns
5923 % Leave the double-column material on the current page, no automatic
5925 \box\balancedcolumns
5927 % \pagegoal was set to the doubled \vsize above, since we restarted
5928 % the current page. We're now back to normal single-column
5929 % typesetting, so reset \pagegoal to the normal \vsize.
5930 \global\vsize = \txipageheight %
5931 \pagegoal = \txipageheight %
5933 % We had some left-over material. This might happen when \doublecolumnout
5934 % is called in \balancecolumns. Try again.
5935 \expandafter\enddoublecolumns
5938 \newbox\balancedcolumns
5939 \setbox\balancedcolumns=\vbox{shouldnt see this}%
5941 % Only called for the last of the double column material. \doublecolumnout
5943 \def\balancecolumns{%
5944 \setbox0 = \vbox{\unvbox\PAGE}% like \box255 but more efficient, see p.120.
5946 \ifdim\dimen@<7\baselineskip
5947 % Don't split a short final column in two.
5949 \global\setbox\balancedcolumns=\vbox{\pagesofar}%
5951 % double the leading vertical space
5952 \advance\dimen@ by \topskip
5953 \advance\dimen@ by-\baselineskip
5954 \divide\dimen@ by 2 % target to split to
5956 \splittopskip = \topskip
5957 % Loop until left column is at least as high as the right column.
5961 \global\setbox3 = \copy0
5962 \global\setbox1 = \vsplit3 to \dimen@
5964 \global\advance\dimen@ by 1pt
5967 % Now the left column is in box 1, and the right column in box 3.
5969 % Check whether the left column has come out higher than the page itself.
5970 % (Note that we have doubled \vsize for the double columns, so
5971 % the actual height of the page is 0.5\vsize).
5973 % It appears that we have been called upon to balance too much material.
5974 % Output some of it with \doublecolumnout, leaving the rest on the page.
5978 % Compare the heights of the two columns.
5980 % Column heights are too different, so don't make their bottoms
5981 % flush with each other.
5982 \setbox2=\vbox to \ht1 {\unvbox3\vfill}%
5983 \setbox0=\vbox to \ht1 {\unvbox1\vfill}%
5985 % Make column bottoms flush with each other.
5986 \setbox2=\vbox to\ht1{\unvbox3\unskip}%
5987 \setbox0=\vbox to\ht1{\unvbox1\unskip}%
5989 \global\setbox\balancedcolumns=\vbox{\pagesofar}%
5994 \catcode`\@ = \other
5997 \message{sectioning,}
5998 % Chapters, sections, etc.
6000 % Let's start with @part.
6001 \outer\parseargdef\part{\partzzz{#1}}
6005 \vskip.3\vsize % move it down on the page a bit
6007 \noindent \titlefonts\rm #1\par % the text
6008 \let\lastnode=\empty % no node to associate with
6009 \writetocentry{part}{#1}{}% but put it in the toc
6010 \headingsoff % no headline or footline on the part page
6011 % This outputs a mark at the end of the page that clears \thischapter
6012 % and \thissection, as is done in \startcontents.
6013 \let\pchapsepmacro\relax
6014 \chapmacro{}{Yomitfromtoc}{}%
6019 % \unnumberedno is an oxymoron. But we count the unnumbered
6020 % sections so that we can refer to them unambiguously in the pdf
6021 % outlines by their "section number". We avoid collisions with chapter
6022 % numbers by starting them at 10000. (If a document ever has 10000
6023 % chapters, we're in trouble anyway, I'm sure.)
6024 \newcount\unnumberedno \unnumberedno = 10000
6026 \newcount\secno \secno=0
6027 \newcount\subsecno \subsecno=0
6028 \newcount\subsubsecno \subsubsecno=0
6030 % This counter is funny since it counts through charcodes of letters A, B, ...
6031 \newcount\appendixno \appendixno = `\@
6033 % \def\appendixletter{\char\the\appendixno}
6034 % We do the following ugly conditional instead of the above simple
6035 % construct for the sake of pdftex, which needs the actual
6036 % letter in the expansion, not just typeset.
6038 \def\appendixletter{%
6039 \ifnum\appendixno=`A A%
6040 \else\ifnum\appendixno=`B B%
6041 \else\ifnum\appendixno=`C C%
6042 \else\ifnum\appendixno=`D D%
6043 \else\ifnum\appendixno=`E E%
6044 \else\ifnum\appendixno=`F F%
6045 \else\ifnum\appendixno=`G G%
6046 \else\ifnum\appendixno=`H H%
6047 \else\ifnum\appendixno=`I I%
6048 \else\ifnum\appendixno=`J J%
6049 \else\ifnum\appendixno=`K K%
6050 \else\ifnum\appendixno=`L L%
6051 \else\ifnum\appendixno=`M M%
6052 \else\ifnum\appendixno=`N N%
6053 \else\ifnum\appendixno=`O O%
6054 \else\ifnum\appendixno=`P P%
6055 \else\ifnum\appendixno=`Q Q%
6056 \else\ifnum\appendixno=`R R%
6057 \else\ifnum\appendixno=`S S%
6058 \else\ifnum\appendixno=`T T%
6059 \else\ifnum\appendixno=`U U%
6060 \else\ifnum\appendixno=`V V%
6061 \else\ifnum\appendixno=`W W%
6062 \else\ifnum\appendixno=`X X%
6063 \else\ifnum\appendixno=`Y Y%
6064 \else\ifnum\appendixno=`Z Z%
6065 % The \the is necessary, despite appearances, because \appendixletter is
6066 % expanded while writing the .toc file. \char\appendixno is not
6067 % expandable, thus it is written literally, thus all appendixes come out
6068 % with the same letter (or @) in the toc without it.
6069 \else\char\the\appendixno
6070 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
6071 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
6073 % Each @chapter defines these (using marks) as the number+name, number
6074 % and name of the chapter. Page headings and footings can use
6075 % these. @section does likewise.
6077 \def\thischapternum{}
6078 \def\thischaptername{}
6080 \def\thissectionnum{}
6081 \def\thissectionname{}
6083 \newcount\absseclevel % used to calculate proper heading level
6084 \newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
6086 % @raisesections: treat @section as chapter, @subsection as section, etc.
6087 \def\raisesections{\global\advance\secbase by -1}
6089 % @lowersections: treat @chapter as section, @section as subsection, etc.
6090 \def\lowersections{\global\advance\secbase by 1}
6092 % we only have subsub.
6093 \chardef\maxseclevel = 3
6095 % A numbered section within an unnumbered changes to unnumbered too.
6096 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
6097 \chardef\unnlevel = \maxseclevel
6099 % Trace whether the current chapter is an appendix or not:
6100 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
6101 \def\chapheadtype{N}
6103 % Choose a heading macro
6104 % #1 is heading type
6105 % #2 is heading level
6106 % #3 is text for heading
6107 \def\genhead#1#2#3{%
6108 % Compute the abs. sec. level:
6110 \advance\absseclevel by \secbase
6111 % Make sure \absseclevel doesn't fall outside the range:
6112 \ifnum \absseclevel < 0
6115 \ifnum \absseclevel > 3
6122 \ifnum \absseclevel < \unnlevel
6123 \chardef\unnlevel = \absseclevel
6126 % Check for appendix sections:
6127 \ifnum \absseclevel = 0
6128 \edef\chapheadtype{\headtype}%
6130 \if \headtype A\if \chapheadtype N%
6131 \errmessage{@appendix... within a non-appendix chapter}%
6134 % Check for numbered within unnumbered:
6135 \ifnum \absseclevel > \unnlevel
6138 \chardef\unnlevel = 3
6141 % Now print the heading:
6145 \or \unnumberedseczzz{#3}%
6146 \or \unnumberedsubseczzz{#3}%
6147 \or \unnumberedsubsubseczzz{#3}%
6153 \or \appendixsectionzzz{#3}%
6154 \or \appendixsubseczzz{#3}%
6155 \or \appendixsubsubseczzz{#3}%
6161 \or \numberedsubseczzz{#3}%
6162 \or \numberedsubsubseczzz{#3}%
6166 \suppressfirstparagraphindent
6170 \def\numhead{\genhead N}
6171 \def\apphead{\genhead A}
6172 \def\unnmhead{\genhead U}
6174 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
6175 % all lower-level sectioning counters to zero.
6177 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
6178 % (e.g., figures), q.v. By default (before any chapter), that is empty.
6179 \let\chaplevelprefix = \empty
6181 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
6183 % section resetting is \global in case the chapter is in a group, such
6184 % as an @include file.
6185 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6186 \global\advance\chapno by 1
6189 \gdef\chaplevelprefix{\the\chapno.}%
6192 % \putwordChapter can contain complex things in translations.
6193 \toks0=\expandafter{\putwordChapter}%
6194 \message{\the\toks0 \space \the\chapno}%
6196 % Write the actual heading.
6197 \chapmacro{#1}{Ynumbered}{\the\chapno}%
6199 % So @section and the like are numbered underneath this chapter.
6200 \global\let\section = \numberedsec
6201 \global\let\subsection = \numberedsubsec
6202 \global\let\subsubsection = \numberedsubsubsec
6205 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
6207 \def\appendixzzz#1{%
6208 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6209 \global\advance\appendixno by 1
6210 \gdef\chaplevelprefix{\appendixletter.}%
6213 % \putwordAppendix can contain complex things in translations.
6214 \toks0=\expandafter{\putwordAppendix}%
6215 \message{\the\toks0 \space \appendixletter}%
6217 \chapmacro{#1}{Yappendix}{\appendixletter}%
6219 \global\let\section = \appendixsec
6220 \global\let\subsection = \appendixsubsec
6221 \global\let\subsubsection = \appendixsubsubsec
6224 % normally unnmhead0 calls unnumberedzzz:
6225 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
6226 \def\unnumberedzzz#1{%
6227 \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
6228 \global\advance\unnumberedno by 1
6230 % Since an unnumbered has no number, no prefix for figures.
6231 \global\let\chaplevelprefix = \empty
6234 % This used to be simply \message{#1}, but TeX fully expands the
6235 % argument to \message. Therefore, if #1 contained @-commands, TeX
6236 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
6237 % expanded @cite (which turns out to cause errors because \cite is meant
6238 % to be executed, not expanded).
6240 % Anyway, we don't want the fully-expanded definition of @cite to appear
6241 % as a result of the \message, we just want `@cite' itself. We use
6242 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
6243 % simply yielding the contents of <toks register>. (We also do this for
6246 \message{(\the\toks0)}%
6248 \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
6250 \global\let\section = \unnumberedsec
6251 \global\let\subsection = \unnumberedsubsec
6252 \global\let\subsubsection = \unnumberedsubsubsec
6255 % @centerchap is like @unnumbered, but the heading is centered.
6256 \outer\parseargdef\centerchap{%
6257 \let\centerparametersmaybe = \centerparameters
6259 \let\centerparametersmaybe = \relax
6262 % @top is like @unnumbered.
6267 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
6269 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
6270 \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
6273 % normally calls appendixsectionzzz:
6274 \outer\parseargdef\appendixsection{\apphead1{#1}}
6275 \def\appendixsectionzzz#1{%
6276 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
6277 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
6279 \let\appendixsec\appendixsection
6281 % normally calls unnumberedseczzz:
6282 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
6283 \def\unnumberedseczzz#1{%
6284 \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
6285 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
6290 % normally calls numberedsubseczzz:
6291 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
6292 \def\numberedsubseczzz#1{%
6293 \global\subsubsecno=0 \global\advance\subsecno by 1
6294 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
6297 % normally calls appendixsubseczzz:
6298 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
6299 \def\appendixsubseczzz#1{%
6300 \global\subsubsecno=0 \global\advance\subsecno by 1
6301 \sectionheading{#1}{subsec}{Yappendix}%
6302 {\appendixletter.\the\secno.\the\subsecno}%
6305 % normally calls unnumberedsubseczzz:
6306 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
6307 \def\unnumberedsubseczzz#1{%
6308 \global\subsubsecno=0 \global\advance\subsecno by 1
6309 \sectionheading{#1}{subsec}{Ynothing}%
6310 {\the\unnumberedno.\the\secno.\the\subsecno}%
6315 % normally numberedsubsubseczzz:
6316 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
6317 \def\numberedsubsubseczzz#1{%
6318 \global\advance\subsubsecno by 1
6319 \sectionheading{#1}{subsubsec}{Ynumbered}%
6320 {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
6323 % normally appendixsubsubseczzz:
6324 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
6325 \def\appendixsubsubseczzz#1{%
6326 \global\advance\subsubsecno by 1
6327 \sectionheading{#1}{subsubsec}{Yappendix}%
6328 {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
6331 % normally unnumberedsubsubseczzz:
6332 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
6333 \def\unnumberedsubsubseczzz#1{%
6334 \global\advance\subsubsecno by 1
6335 \sectionheading{#1}{subsubsec}{Ynothing}%
6336 {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
6339 % These macros control what the section commands do, according
6340 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
6341 % Define them by default for a numbered chapter.
6342 \let\section = \numberedsec
6343 \let\subsection = \numberedsubsec
6344 \let\subsubsection = \numberedsubsubsec
6346 % Define @majorheading, @heading and @subheading
6349 {\advance\chapheadingskip by 10pt \chapbreak }%
6350 \parsearg\chapheadingzzz
6353 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
6354 \def\chapheadingzzz#1{%
6355 \vbox{\chapfonts \raggedtitlesettings #1\par}%
6356 \nobreak\bigskip \nobreak
6357 \suppressfirstparagraphindent
6360 % @heading, @subheading, @subsubheading.
6361 \parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
6362 \suppressfirstparagraphindent}
6363 \parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
6364 \suppressfirstparagraphindent}
6365 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
6366 \suppressfirstparagraphindent}
6368 % These macros generate a chapter, section, etc. heading only
6369 % (including whitespace, linebreaking, etc. around it),
6370 % given all the information in convenient, parsed form.
6372 % Args are the skip and penalty (usually negative)
6373 \def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
6375 % Parameter controlling skip before chapter headings (if needed)
6376 \newskip\chapheadingskip
6378 % Define plain chapter starts, and page on/off switching for it.
6379 \def\chapbreak{\dobreak \chapheadingskip {-4000}}
6382 \def\chappager{\par\vfill\supereject}
6384 % \chapoddpage - start on an odd page for a new chapter
6385 % Because \domark is called before \chapoddpage, the filler page will
6386 % get the headings for the next chapter, which is wrong. But we don't
6387 % care -- we just disable all headings on the filler page.
6399 \parseargdef\setchapternewpage{\csname CHAPPAG#1\endcsname}
6402 \global\let\contentsalignmacro = \chappager
6403 \global\let\pchapsepmacro=\chapbreak
6404 \global\let\pagealignmacro=\chappager}
6407 \global\let\contentsalignmacro = \chappager
6408 \global\let\pchapsepmacro=\chappager
6409 \global\let\pagealignmacro=\chappager
6410 \global\def\HEADINGSon{\HEADINGSsingle}}
6413 \global\let\contentsalignmacro = \chapoddpage
6414 \global\let\pchapsepmacro=\chapoddpage
6415 \global\let\pagealignmacro=\chapoddpage
6416 \global\def\HEADINGSon{\HEADINGSdouble}}
6420 % \chapmacro - Chapter opening.
6422 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
6423 % Yappendix, Yomitfromtoc), #3 the chapter number.
6424 % Not used for @heading series.
6426 % To test against our argument.
6427 \def\Ynothingkeyword{Ynothing}
6428 \def\Yappendixkeyword{Yappendix}
6429 \def\Yomitfromtockeyword{Yomitfromtoc}
6431 \def\chapmacro#1#2#3{%
6432 \expandafter\ifx\thisenv\titlepage\else
6433 \checkenv{}% chapters, etc., should not start inside an environment.
6435 % Insert the first mark before the heading break (see notes for \domark).
6436 \let\prevchapterdefs=\currentchapterdefs
6437 \let\prevsectiondefs=\currentsectiondefs
6438 \gdef\currentsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
6439 \gdef\thissection{}}%
6442 \ifx\temptype\Ynothingkeyword
6443 \gdef\currentchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
6444 \gdef\thischapter{\thischaptername}}%
6445 \else\ifx\temptype\Yomitfromtockeyword
6446 \gdef\currentchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
6447 \gdef\thischapter{}}%
6448 \else\ifx\temptype\Yappendixkeyword
6450 \xdef\currentchapterdefs{%
6451 \gdef\noexpand\thischaptername{\the\toks0}%
6452 \gdef\noexpand\thischapternum{\appendixletter}%
6453 % \noexpand\putwordAppendix avoids expanding indigestible
6454 % commands in some of the translations.
6455 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
6456 \noexpand\thischapternum:
6457 \noexpand\thischaptername}%
6461 \xdef\currentchapterdefs{%
6462 \gdef\noexpand\thischaptername{\the\toks0}%
6463 \gdef\noexpand\thischapternum{\the\chapno}%
6464 % \noexpand\putwordChapter avoids expanding indigestible
6465 % commands in some of the translations.
6466 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
6467 \noexpand\thischapternum:
6468 \noexpand\thischaptername}%
6472 % Output the mark. Pass it through \safewhatsit, to take care of
6473 % the preceding space.
6476 % Insert the chapter heading break.
6479 % Now the second mark, after the heading break. No break points
6480 % between here and the heading.
6481 \let\prevchapterdefs=\currentchapterdefs
6482 \let\prevsectiondefs=\currentsectiondefs
6487 \let\footnote=\errfootnoteheading % give better error message
6489 % Have to define \currentsection before calling \donoderef, because the
6490 % xref code eventually uses it. On the other hand, it has to be called
6491 % after \pchapsepmacro, or the headline will change too soon.
6492 \gdef\currentsection{#1}%
6494 % Only insert the separating space if we have a chapter/appendix
6495 % number, and don't print the unnumbered ``number''.
6496 \ifx\temptype\Ynothingkeyword
6498 \def\toctype{unnchap}%
6499 \else\ifx\temptype\Yomitfromtockeyword
6500 \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
6502 \else\ifx\temptype\Yappendixkeyword
6503 \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
6506 \setbox0 = \hbox{#3\enspace}%
6507 \def\toctype{numchap}%
6510 % Write the toc entry for this chapter. Must come before the
6511 % \donoderef, because we include the current node name in the toc
6512 % entry, and \donoderef resets it to empty.
6513 \writetocentry{\toctype}{#1}{#3}%
6515 % For pdftex, we have to write out the node definition (aka, make
6516 % the pdfdest) after any page break, but before the actual text has
6517 % been typeset. If the destination for the pdf outline is after the
6518 % text, then jumping from the outline may wind up with the text not
6519 % being visible, for instance under high magnification.
6522 % Typeset the actual heading.
6523 \nobreak % Avoid page breaks at the interline glue.
6524 \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe
6527 \nobreak\bigskip % no page break after a chapter title
6531 % @centerchap -- centered and unnumbered.
6532 \let\centerparametersmaybe = \relax
6533 \def\centerparameters{%
6534 \advance\rightskip by 3\rightskip
6535 \leftskip = \rightskip
6540 % Section titles. These macros combine the section number parts and
6541 % call the generic \sectionheading to do the printing.
6543 \newskip\secheadingskip
6544 \def\secheadingbreak{\dobreak \secheadingskip{-1000}}
6546 % Subsection titles.
6547 \newskip\subsecheadingskip
6548 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
6550 % Subsubsection titles.
6551 \def\subsubsecheadingskip{\subsecheadingskip}
6552 \def\subsubsecheadingbreak{\subsecheadingbreak}
6555 % Print any size, any type, section title.
6557 % #1 is the text of the title,
6558 % #2 is the section level (sec/subsec/subsubsec),
6559 % #3 is the section type (Ynumbered, Ynothing, Yappendix, Yomitfromtoc),
6560 % #4 is the section number.
6562 \def\seckeyword{sec}
6564 \def\sectionheading#1#2#3#4{%
6566 \def\sectionlevel{#2}%
6569 % It is ok for the @heading series commands to appear inside an
6570 % environment (it's been historically allowed, though the logic is
6571 % dubious), but not the others.
6572 \ifx\temptype\Yomitfromtockeyword\else
6573 \checkenv{}% non-@*heading should not be in an environment.
6575 \let\footnote=\errfootnoteheading
6577 % Switch to the right set of fonts.
6578 \csname #2fonts\endcsname \rm
6580 % Insert first mark before the heading break (see notes for \domark).
6581 \let\prevsectiondefs=\currentsectiondefs
6582 \ifx\temptype\Ynothingkeyword
6583 \ifx\sectionlevel\seckeyword
6584 \gdef\currentsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
6585 \gdef\thissection{\thissectionname}}%
6587 \else\ifx\temptype\Yomitfromtockeyword
6588 % Don't redefine \thissection.
6589 \else\ifx\temptype\Yappendixkeyword
6590 \ifx\sectionlevel\seckeyword
6592 \xdef\currentsectiondefs{%
6593 \gdef\noexpand\thissectionname{\the\toks0}%
6594 \gdef\noexpand\thissectionnum{#4}%
6595 % \noexpand\putwordSection avoids expanding indigestible
6596 % commands in some of the translations.
6597 \gdef\noexpand\thissection{\noexpand\putwordSection{}
6598 \noexpand\thissectionnum:
6599 \noexpand\thissectionname}%
6603 \ifx\sectionlevel\seckeyword
6605 \xdef\currentsectiondefs{%
6606 \gdef\noexpand\thissectionname{\the\toks0}%
6607 \gdef\noexpand\thissectionnum{#4}%
6608 % \noexpand\putwordSection avoids expanding indigestible
6609 % commands in some of the translations.
6610 \gdef\noexpand\thissection{\noexpand\putwordSection{}
6611 \noexpand\thissectionnum:
6612 \noexpand\thissectionname}%
6617 % Go into vertical mode. Usually we'll already be there, but we
6618 % don't want the following whatsit to end up in a preceding paragraph
6619 % if the document didn't happen to have a blank line.
6622 % Output the mark. Pass it through \safewhatsit, to take care of
6623 % the preceding space.
6626 % Insert space above the heading.
6627 \csname #2headingbreak\endcsname
6629 % Now the second mark, after the heading break. No break points
6630 % between here and the heading.
6631 \global\let\prevsectiondefs=\currentsectiondefs
6634 % Only insert the space after the number if we have a section number.
6635 \ifx\temptype\Ynothingkeyword
6638 \gdef\currentsection{#1}%
6639 \else\ifx\temptype\Yomitfromtockeyword
6640 % for @headings -- no section number, don't include in toc,
6641 % and don't redefine \currentsection.
6644 \let\sectionlevel=\empty
6645 \else\ifx\temptype\Yappendixkeyword
6646 \setbox0 = \hbox{#4\enspace}%
6648 \gdef\currentsection{#1}%
6650 \setbox0 = \hbox{#4\enspace}%
6652 \gdef\currentsection{#1}%
6655 % Write the toc entry (before \donoderef). See comments in \chapmacro.
6656 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
6658 % Write the node reference (= pdf destination for pdftex).
6659 % Again, see comments in \chapmacro.
6662 % Interline glue will be inserted when the vbox is completed.
6663 % That glue will be a valid breakpoint for the page, since it'll be
6664 % preceded by a whatsit (usually from the \donoderef, or from the
6665 % \writetocentry if there was no node). We don't want to allow that
6666 % break, since then the whatsits could end up on page n while the
6667 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
6670 % Output the actual section heading.
6671 \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
6672 \hangindent=\wd0 % zero if no section number
6675 % Add extra space after the heading -- half of whatever came above it.
6676 % Don't allow stretch, though.
6677 \kern .5 \csname #2headingskip\endcsname
6679 % Do not let the kern be a potential breakpoint, as it would be if it
6680 % was followed by glue.
6683 % We'll almost certainly start a paragraph next, so don't let that
6684 % glue accumulate. (Not a breakpoint because it's preceded by a
6685 % discardable item.) However, when a paragraph is not started next
6686 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
6687 % or the negative glue will cause weirdly wrong output, typically
6688 % obscuring the section heading with something else.
6691 % This is so the last item on the main vertical list is a known
6692 % \penalty > 10000, so \startdefun, etc., can recognize the situation
6693 % and do the needful.
6699 % Table of contents.
6702 % Write an entry to the toc file, opening it if necessary.
6703 % Called from @chapter, etc.
6705 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
6706 % We append the current node name (if any) and page number as additional
6707 % arguments for the \{chap,sec,...}entry macros which will eventually
6708 % read this. The node name is used in the pdf outlines as the
6709 % destination to jump to.
6711 % We open the .toc file for writing here instead of at @setfilename (or
6712 % any other fixed time) so that @contents can be anywhere in the document.
6713 % But if #1 is `omit', then we don't do anything. This is used for the
6714 % table of contents chapter openings themselves.
6716 \newif\iftocfileopened
6717 \def\omitkeyword{omit}%
6719 \def\writetocentry#1#2#3{%
6720 \edef\writetoctype{#1}%
6721 \ifx\writetoctype\omitkeyword \else
6722 \iftocfileopened\else
6723 \immediate\openout\tocfile = \jobname.toc
6724 \global\tocfileopenedtrue
6730 \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
6736 % Tell \shipout to create a pdf destination on each page, if we're
6737 % writing pdf. These are used in the table of contents. We can't
6738 % just write one on every page because the title pages are numbered
6739 % 1 and 2 (the page numbers aren't printed), and so are the first
6740 % two pages of the document. Thus, we'd have two destinations named
6741 % `1', and two named `2'.
6743 \global\pdfmakepagedesttrue
6748 % These characters do not print properly in the Computer Modern roman
6749 % fonts, so we must take special care. This is more or less redundant
6750 % with the Texinfo input format setup at the end of this file.
6752 \def\activecatcodes{%
6765 % Read the toc file, which is essentially Texinfo input.
6769 \input \tocreadfilename
6772 \newskip\contentsrightmargin \contentsrightmargin=1in
6773 \newcount\savepageno
6774 \newcount\lastnegativepageno \lastnegativepageno = -1
6776 % Prepare to read what we've written to \tocfile.
6778 \def\startcontents#1{%
6779 % If @setchapternewpage on, and @headings double, the contents should
6780 % start on an odd page, unlike chapters. Thus, we maintain
6781 % \contentsalignmacro in parallel with \pagealignmacro.
6782 % From: Torbjorn Granlund <tege@matematik.su.se>
6784 \immediate\closeout\tocfile
6786 % Don't need to put `Contents' or `Short Contents' in the headline.
6787 % It is abundantly clear what they are.
6788 \chapmacro{#1}{Yomitfromtoc}{}%
6790 \savepageno = \pageno
6791 \begingroup % Set up to handle contents files properly.
6792 \raggedbottom % Worry more about breakpoints than the bottom.
6793 \entryrightmargin=\contentsrightmargin % Don't use the full line length.
6795 % Roman numerals for page numbers.
6796 \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
6799 % redefined for the two-volume lispref. We always output on
6800 % \jobname.toc even if this is redefined.
6802 \def\tocreadfilename{\jobname.toc}
6804 % Normal (long) toc.
6807 \startcontents{\putwordTOC}%
6808 \openin 1 \tocreadfilename\space
6813 \contentsalignmacro % in case @setchapternewpage odd is in effect
6819 \lastnegativepageno = \pageno
6820 \global\pageno = \savepageno
6823 % And just the chapters.
6824 \def\summarycontents{%
6825 \startcontents{\putwordShortTOC}%
6827 \let\partentry = \shortpartentry
6828 \let\numchapentry = \shortchapentry
6829 \let\appentry = \shortchapentry
6830 \let\unnchapentry = \shortunnchapentry
6831 % We want a true roman here for the page numbers.
6833 \let\rm=\shortcontrm \let\bf=\shortcontbf
6834 \let\sl=\shortcontsl \let\tt=\shortconttt
6836 \hyphenpenalty = 10000
6837 \advance\baselineskip by 1pt % Open it up a little.
6838 \def\numsecentry##1##2##3##4{}
6839 \let\appsecentry = \numsecentry
6840 \let\unnsecentry = \numsecentry
6841 \let\numsubsecentry = \numsecentry
6842 \let\appsubsecentry = \numsecentry
6843 \let\unnsubsecentry = \numsecentry
6844 \let\numsubsubsecentry = \numsecentry
6845 \let\appsubsubsecentry = \numsecentry
6846 \let\unnsubsubsecentry = \numsecentry
6847 \openin 1 \tocreadfilename\space
6853 \contentsalignmacro % in case @setchapternewpage odd is in effect
6855 \lastnegativepageno = \pageno
6856 \global\pageno = \savepageno
6858 \let\shortcontents = \summarycontents
6860 % Typeset the label for a chapter or appendix for the short contents.
6861 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6863 \def\shortchaplabel#1{%
6864 % This space should be enough, since a single number is .5em, and the
6865 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6866 % But use \hss just in case.
6867 % (This space doesn't include the extra space that gets added after
6868 % the label; that gets put in by \shortchapentry above.)
6870 % We'd like to right-justify chapter numbers, but that looks strange
6871 % with appendix letters. And right-justifying numbers and
6872 % left-justifying letters looks strange when there is less than 10
6873 % chapters. Have to read the whole toc once to know how many chapters
6874 % there are before deciding ...
6875 \hbox to 1em{#1\hss}%
6878 % These macros generate individual entries in the table of contents.
6879 % The first argument is the chapter or section name.
6880 % The last argument is the page number.
6881 % The arguments in between are the chapter number, section number, ...
6883 % Parts, in the main contents. Replace the part number, which doesn't
6884 % exist, with an empty box. Let's hope all the numbers have the same width.
6885 % Also ignore the page number, which is conventionally not printed.
6886 \def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
6887 \def\partentry#1#2#3#4{%
6888 % Add stretch and a bonus for breaking the page before the part heading.
6889 % This reduces the chance of the page being broken immediately after the
6890 % part heading, before a following chapter heading.
6891 \vskip 0pt plus 5\baselineskip
6893 \vskip 0pt plus -5\baselineskip
6894 \dochapentry{\numeralbox\labelspace#1}{}%
6897 % Parts, in the short toc.
6898 \def\shortpartentry#1#2#3#4{%
6900 \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
6901 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6904 % Chapters, in the main contents.
6905 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6907 % Chapters, in the short toc.
6908 % See comments in \dochapentry re vbox and related settings.
6909 \def\shortchapentry#1#2#3#4{%
6910 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6913 % Appendices, in the main contents.
6914 % Need the word Appendix, and a fixed-size box.
6916 \def\appendixbox#1{%
6917 % We use M since it's probably the widest letter.
6918 \setbox0 = \hbox{\putwordAppendix{} M}%
6919 \hbox to \wd0{\putwordAppendix{} #1\hss}}
6921 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\hskip.7em#1}{#4}}
6923 % Unnumbered chapters.
6924 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6925 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6928 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6929 \let\appsecentry=\numsecentry
6930 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6933 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6934 \let\appsubsecentry=\numsubsecentry
6935 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6937 % And subsubsections.
6938 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6939 \let\appsubsubsecentry=\numsubsubsecentry
6940 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6942 % This parameter controls the indentation of the various levels.
6943 % Same as \defaultparindent.
6944 \newdimen\tocindent \tocindent = 15pt
6946 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6949 % If the toc has to be broken over pages, we want it to be at chapters
6950 % if at all possible; hence the \penalty.
6951 \def\dochapentry#1#2{%
6952 \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
6954 % Move the page numbers slightly to the right
6955 \advance\entryrightmargin by -0.05em
6957 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6959 \nobreak\vskip .25\baselineskip plus.1\baselineskip
6962 \def\dosecentry#1#2{\begingroup
6963 \secentryfonts \leftskip=\tocindent
6964 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6967 \def\dosubsecentry#1#2{\begingroup
6968 \subsecentryfonts \leftskip=2\tocindent
6969 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6972 \def\dosubsubsecentry#1#2{\begingroup
6973 \subsubsecentryfonts \leftskip=3\tocindent
6974 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6977 % We use the same \entry macro as for the index entries.
6978 \let\tocentry = \entry
6980 % Space between chapter (or whatever) number and the title.
6981 \def\labelspace{\hskip1em \relax}
6983 \def\dopageno#1{{\rm #1}}
6984 \def\doshortpageno#1{{\rm #1}}
6986 \def\chapentryfonts{\secfonts \rm}
6987 \def\secentryfonts{\textfonts}
6988 \def\subsecentryfonts{\textfonts}
6989 \def\subsubsecentryfonts{\textfonts}
6992 \message{environments,}
6993 % @foo ... @end foo.
6995 % @tex ... @end tex escapes into raw TeX temporarily.
6996 % One exception: @ is still an escape character, so that @end tex works.
6997 % But \@ or @@ will get a plain @ character.
7000 \setupmarkupstyle{tex}%
7001 \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
7002 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
7003 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
7013 % ' is active in math mode (mathcode"8000). So reset it, and all our
7014 % other math active characters (just in case), to plain's definitions.
7017 % Inverse of the list at the beginning of the file.
7019 \let\bullet=\ptexbullet
7024 \let\equiv=\ptexequiv
7027 \let\indent=\ptexindent
7028 \let\noindent=\ptexnoindent
7035 %\let\sup=\ptexsup % do not redefine, we want @sup to work in math mode
7037 \expandafter \let\csname top\endcsname=\ptextop % we've made it outer
7038 \let\frenchspacing=\plainfrenchspacing
7040 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
7041 \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
7044 % There is no need to define \Etex.
7046 % Define @lisp ... @end lisp.
7047 % @lisp environment forms a group so it can rebind things,
7048 % including the definition of @end lisp (which normally is erroneous).
7050 % Amount to narrow the margins by for @lisp.
7051 \newskip\lispnarrowing \lispnarrowing=0.4in
7053 % This is the definition that ^^M gets inside @lisp, @example, and other
7054 % such environments. \null is better than a space, since it doesn't
7056 \def\lisppar{\null\endgraf}
7058 % This space is always present above and below environments.
7059 \newskip\envskipamount \envskipamount = 0pt
7061 % Make spacing and below environment symmetrical. We use \parskip here
7062 % to help in doing that, since in @example-like environments \parskip
7063 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
7064 % start of the next paragraph will insert \parskip.
7066 \def\aboveenvbreak{{%
7067 % =10000 instead of <10000 because of a special case in \itemzzz and
7068 % \sectionheading, q.v.
7069 \ifnum \lastpenalty=10000 \else
7070 \advance\envskipamount by \parskip
7072 \ifdim\lastskip<\envskipamount
7074 \ifnum\lastpenalty<10000
7075 % Penalize breaking before the environment, because preceding text
7076 % often leads into it.
7079 \vskip\envskipamount
7084 \def\afterenvbreak{{%
7085 % =10000 instead of <10000 because of a special case in \itemzzz and
7086 % \sectionheading, q.v.
7087 \ifnum \lastpenalty=10000 \else
7088 \advance\envskipamount by \parskip
7090 \ifdim\lastskip<\envskipamount
7092 % it's not a good place to break if the last penalty was \nobreak
7094 \ifnum\lastpenalty<10000 \penalty-50 \fi
7095 \vskip\envskipamount
7100 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
7101 % also clear it, so that its embedded environments do the narrowing again.
7102 \let\nonarrowing=\relax
7104 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
7105 % environment contents.
7108 \def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
7109 \def\ctr{{\hskip 6pt\circle\char'010}}
7110 \def\cbl{{\circle\char'012\hskip -6pt}}
7111 \def\cbr{{\hskip 6pt\circle\char'011}}
7112 \def\carttop{\hbox to \cartouter{\hskip\lskip
7113 \ctl\leaders\hrule height\circthick\hfil\ctr
7115 \def\cartbot{\hbox to \cartouter{\hskip\lskip
7116 \cbl\leaders\hrule height\circthick\hfil\cbr
7119 \newskip\lskip\newskip\rskip
7121 % only require the font if @cartouche is actually used
7122 \def\cartouchefontdefs{%
7123 \font\circle=lcircle10\relax
7124 \circthick=\fontdimen8\circle
7127 \newdimen\cartouter\newdimen\cartinner
7128 \newskip\normbskip\newskip\normpskip\newskip\normlskip
7133 \ifhmode\par\fi % can't be in the midst of a paragraph.
7135 \lskip=\leftskip \rskip=\rightskip
7136 \leftskip=0pt\rightskip=0pt % we want these *outside*.
7137 \cartinner=\hsize \advance\cartinner by-\lskip
7138 \advance\cartinner by-\rskip
7140 \advance\cartouter by 18.4pt % allow for 3pt kerns on either
7141 % side, and for 6pt waste from
7142 % each corner char, and rule thickness
7143 \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
7145 % If this cartouche directly follows a sectioning command, we need the
7146 % \parskip glue (backspaced over by default) or the cartouche can
7147 % collide with the section heading.
7148 \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
7150 \setbox\groupbox=\vbox\bgroup
7151 \baselineskip=0pt\parskip=0pt\lineskip=0pt
7159 \baselineskip=\normbskip
7160 \lineskip=\normlskip
7163 \comment % For explanation, see the end of def\group.
7179 % This macro is called at the beginning of all the @example variants,
7181 \newdimen\nonfillparindent
7184 \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy
7185 \sepspaces % Make spaces be word-separators rather than space tokens.
7186 \let\par = \lisppar % don't ignore blank lines
7187 \obeylines % each line of input is a line of output
7189 % Turn off paragraph indentation but redefine \indent to emulate
7190 % the normal \indent.
7191 \nonfillparindent=\parindent
7193 \let\indent\nonfillindent
7195 \emergencystretch = 0pt % don't try to avoid overfull boxes
7196 \ifx\nonarrowing\relax
7197 \advance \leftskip by \lispnarrowing
7198 \exdentamount=\lispnarrowing
7200 \let\nonarrowing = \relax
7202 \let\exdent=\nofillexdent
7207 % We want to swallow spaces (but not other tokens) after the fake
7208 % @indent in our nonfill-environments, where spaces are normally
7209 % active and set to @tie, resulting in them not being ignored after
7211 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
7212 \gdef\nonfillindentcheck{%
7214 \expandafter\nonfillindentgobble%
7216 \leavevmode\nonfillindentbox%
7220 \def\nonfillindentgobble#1{\nonfillindent}
7221 \def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
7223 % If you want all examples etc. small: @set dispenvsize small.
7224 % If you want even small examples the full size: @set dispenvsize nosmall.
7225 % This affects the following displayed environments:
7226 % @example, @display, @format, @lisp
7228 \def\smallword{small}
7229 \def\nosmallword{nosmall}
7230 \let\SETdispenvsize\relax
7231 \def\setnormaldispenv{%
7232 \ifx\SETdispenvsize\smallword
7233 % end paragraph for sake of leading, in case document has no blank
7234 % line. This is redundant with what happens in \aboveenvbreak, but
7235 % we need to do it before changing the fonts, and it's inconvenient
7236 % to change the fonts afterward.
7237 \ifnum \lastpenalty=10000 \else \endgraf \fi
7238 \smallexamplefonts \rm
7241 \def\setsmalldispenv{%
7242 \ifx\SETdispenvsize\nosmallword
7244 \ifnum \lastpenalty=10000 \else \endgraf \fi
7245 \smallexamplefonts \rm
7249 % We often define two environments, @foo and @smallfoo.
7250 % Let's do it in one command. #1 is the env name, #2 the definition.
7251 \def\makedispenvdef#1#2{%
7252 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
7253 \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
7254 \expandafter\let\csname E#1\endcsname \afterenvbreak
7255 \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
7258 % Define two environment synonyms (#1 and #2) for an environment.
7259 \def\maketwodispenvdef#1#2#3{%
7260 \makedispenvdef{#1}{#3}%
7261 \makedispenvdef{#2}{#3}%
7264 % @lisp: indented, narrowed, typewriter font;
7265 % @example: same as @lisp.
7267 % @smallexample and @smalllisp: use smaller fonts.
7268 % Originally contributed by Pavel@xerox.
7270 \maketwodispenvdef{lisp}{example}{%
7272 \tt\setupmarkupstyle{example}%
7273 \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
7274 \gobble % eat return
7276 % @display/@smalldisplay: same as @lisp except keep current font.
7278 \makedispenvdef{display}{%
7283 % @format/@smallformat: same as @display except don't narrow margins.
7285 \makedispenvdef{format}{%
7286 \let\nonarrowing = t%
7291 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
7293 \let\nonarrowing = t%
7297 \let\Eflushleft = \afterenvbreak
7301 \envdef\flushright{%
7302 \let\nonarrowing = t%
7304 \advance\leftskip by 0pt plus 1fill\relax
7307 \let\Eflushright = \afterenvbreak
7310 % @raggedright does more-or-less normal line breaking but no right
7311 % justification. From plain.tex.
7312 \envdef\raggedright{%
7313 \rightskip0pt plus2.4em \spaceskip.3333em \xspaceskip.5em\relax
7315 \let\Eraggedright\par
7317 \envdef\raggedleft{%
7318 \parindent=0pt \leftskip0pt plus2em
7319 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
7320 \hbadness=10000 % Last line will usually be underfull, so turn off
7321 % badness reporting.
7323 \let\Eraggedleft\par
7325 \envdef\raggedcenter{%
7326 \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
7327 \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
7328 \hbadness=10000 % Last line will usually be underfull, so turn off
7329 % badness reporting.
7331 \let\Eraggedcenter\par
7334 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
7335 % and narrows the margins. We keep \parskip nonzero in general, since
7336 % we're doing normal filling. So, when using \aboveenvbreak and
7337 % \afterenvbreak, temporarily make \parskip 0.
7339 \makedispenvdef{quotation}{\quotationstart}
7341 \def\quotationstart{%
7342 \indentedblockstart % same as \indentedblock, but increase right margin too.
7343 \ifx\nonarrowing\relax
7344 \advance\rightskip by \lispnarrowing
7346 \parsearg\quotationlabel
7349 % We have retained a nonzero parskip for the environment, since we're
7350 % doing normal filling.
7354 \ifx\quotationauthor\thisisundefined\else
7356 \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
7358 {\parskip=0pt \afterenvbreak}%
7360 \def\Esmallquotation{\Equotation}
7362 % If we're given an argument, typeset it in bold with a colon after.
7363 \def\quotationlabel#1{%
7365 \ifx\temp\empty \else
7370 % @indentedblock is like @quotation, but indents only on the left and
7371 % has no optional argument.
7373 \makedispenvdef{indentedblock}{\indentedblockstart}
7375 \def\indentedblockstart{%
7376 {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
7379 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
7380 \ifx\nonarrowing\relax
7381 \advance\leftskip by \lispnarrowing
7382 \exdentamount = \lispnarrowing
7384 \let\nonarrowing = \relax
7388 % Keep a nonzero parskip for the environment, since we're doing normal filling.
7390 \def\Eindentedblock{%
7392 {\parskip=0pt \afterenvbreak}%
7394 \def\Esmallindentedblock{\Eindentedblock}
7397 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
7398 % If we want to allow any <char> as delimiter,
7399 % we need the curly braces so that makeinfo sees the @verb command, eg:
7400 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
7402 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
7404 % [Knuth] p.344; only we need to do the other characters Texinfo sets
7405 % active too. Otherwise, they get lost as the first character on a
7408 \do\ \do\\\do\{\do\}\do\$\do\&%
7409 \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
7410 \do\<\do\>\do\|\do\@\do+\do\"%
7411 % Don't do the quotes -- if we do, @set txicodequoteundirected and
7412 % @set txicodequotebacktick will not have effect on @verb and
7413 % @verbatim, and ?` and !` ligatures won't get disabled.
7418 \def\uncatcodespecials{%
7419 \def\do##1{\catcode`##1=\other}\dospecials}
7421 % Setup for the @verb command.
7423 % Eight spaces for a tab
7425 \catcode`\^^I=\active
7426 \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
7430 \tt % easiest (and conventionally used) font for verbatim
7431 \def\par{\leavevmode\endgraf}%
7432 \setupmarkupstyle{verb}%
7434 % Respect line breaks,
7435 % print special symbols as themselves, and
7436 % make each space count
7437 % must do in this order:
7438 \obeylines \uncatcodespecials \sepspaces
7441 % Setup for the @verbatim environment
7443 % Real tab expansion.
7444 \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
7446 % We typeset each line of the verbatim in an \hbox, so we can handle
7447 % tabs. The \global is in case the verbatim line starts with an accent,
7448 % or some other command that starts with a begin-group. Otherwise, the
7449 % entire \verbbox would disappear at the corresponding end-group, before
7450 % it is typeset. Meanwhile, we can't have nested verbatim commands
7451 % (can we?), so the \global won't be overwriting itself.
7453 \def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
7456 \catcode`\^^I=\active
7458 \catcode`\^^I=\active
7459 \def^^I{\leavevmode\egroup
7460 \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
7461 \divide\dimen\verbbox by\tabw
7462 \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
7463 \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
7464 \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
7469 % start the verbatim environment.
7470 \def\setupverbatim{%
7471 \let\nonarrowing = t%
7473 \tt % easiest (and conventionally used) font for verbatim
7474 % The \leavevmode here is for blank lines. Otherwise, we would
7475 % never \starttabbox and the \egroup would end verbatim mode.
7476 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
7478 \setupmarkupstyle{verbatim}%
7479 % Respect line breaks,
7480 % print special symbols as themselves, and
7481 % make each space count.
7482 % Must do in this order:
7483 \obeylines \uncatcodespecials \sepspaces
7484 \everypar{\starttabbox}%
7487 % Do the @verb magic: verbatim text is quoted by unique
7488 % delimiter characters. Before first delimiter expect a
7489 % right brace, after last delimiter expect closing brace:
7491 % \def\doverb'{'<char>#1<char>'}'{#1}
7493 % [Knuth] p. 382; only eat outer {}
7495 \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
7496 \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
7499 \def\verb{\begingroup\setupverb\doverb}
7502 % Do the @verbatim magic: define the macro \doverbatim so that
7503 % the (first) argument ends when '@end verbatim' is reached, ie:
7505 % \def\doverbatim#1@end verbatim{#1}
7507 % For Texinfo it's a lot easier than for LaTeX,
7508 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
7509 % we need not redefine '\', '{' and '}'.
7511 % Inspired by LaTeX's verbatim command set [latex.ltx]
7516 % ignore everything up to the first ^^M, that's the newline at the end
7517 % of the @verbatim input line itself. Otherwise we get an extra blank
7518 % line in the output.
7519 \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
7520 % We really want {...\end verbatim} in the body of the macro, but
7521 % without the active space; thus we have to use \xdef and \gobble.
7525 \setupverbatim\doverbatim
7527 \let\Everbatim = \afterenvbreak
7530 % @verbatiminclude FILE - insert text of file in verbatim environment.
7532 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
7534 \def\doverbatiminclude#1{%
7536 \makevalueexpandable
7539 \indexnofonts % Allow `@@' and other weird things in file names.
7540 \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
7541 \edef\tmp{\noexpand\input #1 }
7548 % @copying ... @end copying.
7549 % Save the text away for @insertcopying later.
7551 % We save the uninterpreted tokens, rather than creating a box.
7552 % Saving the text in a box would be much easier, but then all the
7553 % typesetting commands (@smallbook, font changes, etc.) have to be done
7554 % beforehand -- and a) we want @copying to be done first in the source
7555 % file; b) letting users define the frontmatter in as flexible order as
7556 % possible is desirable.
7558 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
7559 \def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
7561 \def\insertcopying{%
7563 \parindent = 0pt % paragraph indentation looks wrong on title page
7564 \scanexp\copyingtext
7572 \newskip\defbodyindent \defbodyindent=.4in
7573 \newskip\defargsindent \defargsindent=50pt
7574 \newskip\deflastargmargin \deflastargmargin=18pt
7575 \newcount\defunpenalty
7577 % Start the processing of @deffn:
7579 \ifnum\lastpenalty<10000
7581 \defunpenalty=10003 % Will keep this @deffn together with the
7582 % following @def command, see below.
7584 % If there are two @def commands in a row, we'll have a \nobreak,
7585 % which is there to keep the function description together with its
7586 % header. But if there's nothing but headers, we need to allow a
7587 % break somewhere. Check specifically for penalty 10002, inserted
7588 % by \printdefunline, instead of 10000, since the sectioning
7589 % commands also insert a nobreak penalty, and we don't want to allow
7590 % a break between a section heading and a defun.
7592 % As a further refinement, we avoid "club" headers by signalling
7593 % with penalty of 10003 after the very first @deffn in the
7594 % sequence (see above), and penalty of 10002 after any following
7596 \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
7598 % Similarly, after a section heading, do not allow a break.
7599 % But do insert the glue.
7600 \medskip % preceded by discardable penalty, so not a breakpoint
7604 \advance\leftskip by \defbodyindent
7605 \exdentamount=\defbodyindent
7609 % First, check whether we are in the right environment:
7612 % As above, allow line break if we have multiple x headers in a row.
7613 % It's not a great place, though.
7614 \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
7616 % And now, it's time to reuse the body of the original defun:
7617 \expandafter\gobbledefun#1%
7619 \def\gobbledefun#1\startdefun{}
7621 % \printdefunline \deffnheader{text}
7623 \def\printdefunline#1#2{%
7625 % call \deffnheader:
7628 \interlinepenalty = 10000
7629 \advance\rightskip by 0pt plus 1fil\relax
7631 \nobreak\vskip -\parskip
7632 \penalty\defunpenalty % signal to \startdefun and \dodefunx
7633 % Some of the @defun-type tags do not enable magic parentheses,
7634 % rendering the following check redundant. But we don't optimize.
7639 \def\Edefun{\endgraf\medbreak}
7641 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
7642 % the only thing remaining is to define \deffnheader.
7645 \expandafter\let\csname E#1\endcsname = \Edefun
7646 \edef\temp{\noexpand\domakedefun
7647 \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
7651 % \domakedefun \deffn \deffnx \deffnheader { (defn. of \deffnheader) }
7653 % Define \deffn and \deffnx, without parameters.
7654 % \deffnheader has to be defined explicitly.
7656 \def\domakedefun#1#2#3{%
7659 \doingtypefnfalse % distinguish typed functions from all else
7660 \parseargusing\activeparens{\printdefunline#3}%
7662 \def#2{\dodefunx#1}%
7666 \newif\ifdoingtypefn % doing typed function?
7667 \newif\ifrettypeownline % typeset return type on its own line?
7669 % @deftypefnnewline on|off says whether the return type of typed functions
7670 % are printed on their own line. This affects @deftypefn, @deftypefun,
7671 % @deftypeop, and @deftypemethod.
7673 \parseargdef\deftypefnnewline{%
7676 \expandafter\let\csname SETtxideftypefnnl\endcsname
7678 \else\ifx\temp\offword
7679 \expandafter\let\csname SETtxideftypefnnl\endcsname
7682 \errhelp = \EMsimple
7683 \errmessage{Unknown @txideftypefnnl value `\temp',
7688 % \dosubind {index}{topic}{subtopic}
7690 % If SUBTOPIC is present, precede it with a space, and call \doind.
7691 % (At some time during the 20th century, this made a two-level entry in an
7692 % index such as the operation index. Nobody seemed to notice the change in
7693 % behaviour though.)
7694 \def\dosubind#1#2#3{%
7699 \doind{#1}{#2\space#3}%
7703 % Untyped functions:
7705 % @deffn category name args
7706 \makedefun{deffn}{\deffngeneral{}}
7708 % @deffn category class name args
7709 \makedefun{defop}#1 {\defopon{#1\ \putwordon}}
7711 % \defopon {category on}class name args
7712 \def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7714 % \deffngeneral {subind}category name args
7716 \def\deffngeneral#1#2 #3 #4\endheader{%
7717 \dosubind{fn}{\code{#3}}{#1}%
7718 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
7723 % @deftypefn category type name args
7724 \makedefun{deftypefn}{\deftypefngeneral{}}
7726 % @deftypeop category class type name args
7727 \makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
7729 % \deftypeopon {category on}class type name args
7730 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
7732 % \deftypefngeneral {subind}category type name args
7734 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
7735 \dosubind{fn}{\code{#4}}{#1}%
7737 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7742 % @deftypevr category type var args
7743 \makedefun{deftypevr}{\deftypecvgeneral{}}
7745 % @deftypecv category class type var args
7746 \makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
7748 % \deftypecvof {category of}class type var args
7749 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
7751 % \deftypecvgeneral {subind}category type var args
7753 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
7754 \dosubind{vr}{\code{#4}}{#1}%
7755 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7758 % Untyped variables:
7760 % @defvr category var args
7761 \makedefun{defvr}#1 {\deftypevrheader{#1} {} }
7763 % @defcv category class var args
7764 \makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
7766 % \defcvof {category of}class var args
7767 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
7771 % @deftp category name args
7772 \makedefun{deftp}#1 #2 #3\endheader{%
7773 \doind{tp}{\code{#2}}%
7774 \defname{#1}{}{#2}\defunargs{#3\unskip}%
7777 % Remaining @defun-like shortcuts:
7778 \makedefun{defun}{\deffnheader{\putwordDeffunc} }
7779 \makedefun{defmac}{\deffnheader{\putwordDefmac} }
7780 \makedefun{defspec}{\deffnheader{\putwordDefspec} }
7781 \makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
7782 \makedefun{defvar}{\defvrheader{\putwordDefvar} }
7783 \makedefun{defopt}{\defvrheader{\putwordDefopt} }
7784 \makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
7785 \makedefun{defmethod}{\defopon\putwordMethodon}
7786 \makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
7787 \makedefun{defivar}{\defcvof\putwordInstanceVariableof}
7788 \makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
7790 % \defname, which formats the name of the @def (not the args).
7791 % #1 is the category, such as "Function".
7792 % #2 is the return type, if any.
7793 % #3 is the function name.
7795 % We are followed by (but not passed) the arguments, if any.
7797 \def\defname#1#2#3{%
7799 % Get the values of \leftskip and \rightskip as they were outside the @def...
7800 \advance\leftskip by -\defbodyindent
7802 % Determine if we are typesetting the return type of a typed function
7803 % on a line by itself.
7804 \rettypeownlinefalse
7805 \ifdoingtypefn % doing a typed function specifically?
7806 % then check user option for putting return type on its own line:
7807 \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
7812 % How we'll format the category name. Putting it in brackets helps
7813 % distinguish it from the body text that may end up on the next line
7816 \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7818 % Figure out line sizes for the paragraph shape. We'll always have at
7822 % The first line needs space for \box0; but if \rightskip is nonzero,
7823 % we need only space for the part of \box0 which exceeds it:
7824 \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
7826 % If doing a return type on its own line, we'll have another line.
7828 \advance\tempnum by 1
7829 \def\maybeshapeline{0in \hsize}%
7831 \def\maybeshapeline{}%
7834 % The continuations:
7835 \dimen2=\hsize \advance\dimen2 by -\defargsindent
7837 % The final paragraph shape:
7838 \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2
7840 % Put the category name at the right margin.
7843 \hfil\box0 \kern-\hsize
7844 % \hsize has to be shortened this way:
7846 % Intentionally do not respect \rightskip, since we need the space.
7849 % Allow all lines to be underfull without complaint:
7850 \tolerance=10000 \hbadness=10000
7851 \exdentamount=\defbodyindent
7853 % defun fonts. We use typewriter by default (used to be bold) because:
7854 % . we're printing identifiers, they should be in tt in principle.
7855 % . in languages with many accents, such as Czech or French, it's
7856 % common to leave accents off identifiers. The result looks ok in
7857 % tt, but exceedingly strange in rm.
7858 % . we don't want -- and --- to be treated as ligatures.
7859 % . this still does not fix the ?` and !` ligatures, but so far no
7860 % one has made identifiers using them :).
7862 \def\temp{#2}% text of the return type
7863 \ifx\temp\empty\else
7864 \tclose{\temp}% typeset the return type
7866 % put return type on its own line; prohibit line break following:
7867 \hfil\vadjust{\nobreak}\break
7869 \space % type on same line, so just followed by a space
7871 \fi % no return type
7872 #3% output function name
7874 {\rm\enskip}% hskip 0.5 em of \rmfont
7877 % arguments will be output next, if any.
7880 % Print arguments in slanted roman (not ttsl), inconsistently with using
7881 % tt for the name. This is because literal text is sometimes needed in
7882 % the argument list (groff manual), and ttsl and tt are not very
7883 % distinguishable. Prevent hyphenation at `-' chars.
7886 % use sl by default (not ttsl),
7888 \df \sl \hyphenchar\font=0
7890 % On the other hand, if an argument has two dashes (for instance), we
7891 % want a way to get ttsl. We used to recommend @var for that, so
7892 % leave the code in, but it's strange for @var to lead to typewriter.
7893 % Nowadays we recommend @code, since the difference between a ttsl hyphen
7894 % and a tt hyphen is pretty tiny. @code also disables ?` !`.
7895 \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
7897 \sl\hyphenchar\font=45
7900 % We want ()&[] to print specially on the defun line.
7903 \catcode`\(=\active \catcode`\)=\active
7904 \catcode`\[=\active \catcode`\]=\active
7908 % Make control sequences which act like normal parenthesis chars.
7909 \let\lparen = ( \let\rparen = )
7911 % Be sure that we always have a definition for `(', etc. For example,
7912 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7913 % so TeX would otherwise complain about undefined control sequence.
7916 \global\let(=\lparen \global\let)=\rparen
7917 \global\let[=\lbrack \global\let]=\rbrack
7920 \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
7921 \gdef\magicamp{\let&=\amprm}
7925 \newcount\parencount
7927 % If we encounter &foo, then turn on ()-hacking afterwards
7929 \def\amprm#1 {\ampseentrue{\bf\ }}
7933 % At the first level, print parens in roman,
7934 % otherwise use the default font.
7935 \ifnum \parencount=1 \rm \fi
7937 % The \sf parens (in \boldbrax) actually are a little bolder than
7938 % the contained text. This is especially needed for [ and ] .
7942 \def\infirstlevel#1{%
7949 \def\bfafterword#1 {#1 \bf}
7952 \global\advance\parencount by 1
7954 \infirstlevel \bfafterword
7959 \global\advance\parencount by -1
7962 \newcount\brackcount
7964 \global\advance\brackcount by 1
7969 \global\advance\brackcount by -1
7972 \def\checkparencounts{%
7973 \ifnum\parencount=0 \else \badparencount \fi
7974 \ifnum\brackcount=0 \else \badbrackcount \fi
7976 % these should not use \errmessage; the glibc manual, at least, actually
7977 % has such constructs (when documenting function pointers).
7978 \def\badparencount{%
7979 \message{Warning: unbalanced parentheses in @def...}%
7980 \global\parencount=0
7982 \def\badbrackcount{%
7983 \message{Warning: unbalanced square brackets in @def...}%
7984 \global\brackcount=0
7991 % To do this right we need a feature of e-TeX, \scantokens,
7992 % which we arrange to emulate with a temporary file in ordinary TeX.
7993 \ifx\eTeXversion\thisisundefined
7994 \newwrite\macscribble
7997 \immediate\openout\macscribble=\jobname.tmp
7998 \immediate\write\macscribble{\the\toks0}%
7999 \immediate\closeout\macscribble
8004 % Used at the time of macro expansion.
8005 % Argument is macro body with arguments substituted
8008 \def\xeatspaces{\eatspaces}%
8010 % Process the macro body under the current catcode regime.
8011 \scantokens{#1@comment}%
8013 % The \comment is to remove the \newlinechar added by \scantokens, and
8014 % can be noticed by \parsearg. Note \c isn't used because this means cedilla
8018 % Used for copying and captions
8020 \expandafter\scanmacro\expandafter{#1}%
8023 \newcount\paramno % Count of parameters
8024 \newtoks\macname % Macro name
8025 \newif\ifrecursive % Is it recursive?
8027 % List of all defined macros in the form
8028 % \commondummyword\macro1\commondummyword\macro2...
8029 % Currently is also contains all @aliases; the list can be split
8030 % if there is a need.
8033 % Add the macro to \macrolist
8034 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
8035 \def\addtomacrolistxxx#1{%
8036 \toks0 = \expandafter{\macrolist\commondummyword#1}%
8037 \xdef\macrolist{\the\toks0}%
8041 % This does \let #1 = #2, with \csnames; that is,
8042 % \let \csname#1\endcsname = \csname#2\endcsname
8043 % (except of course we have to play expansion games).
8047 \csname#1\expandafter\endcsname
8051 % Trim leading and trailing spaces off a string.
8052 % Concepts from aro-bend problem 15 (see CTAN).
8054 \gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
8055 \gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
8056 \gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
8058 \unbrace{\gdef\trim@@@ #1 } #2@{#1}
8061 % Trim a single trailing ^^M off a string.
8062 {\catcode`\^^M=\other \catcode`\Q=3%
8063 \gdef\eatcr #1{\eatcra #1Q^^MQ}%
8064 \gdef\eatcra#1^^MQ{\eatcrb#1Q}%
8065 \gdef\eatcrb#1Q#2Q{#1}%
8068 % Macro bodies are absorbed as an argument in a context where
8069 % all characters are catcode 10, 11 or 12, except \ which is active
8070 % (as in normal texinfo). It is necessary to change the definition of \
8071 % to recognize macro arguments; this is the job of \mbodybackslash.
8073 % Non-ASCII encodings make 8-bit characters active, so un-activate
8074 % them to avoid their expansion. Must do this non-globally, to
8075 % confine the change to the current group.
8077 % It's necessary to have hard CRs when the macro is executed. This is
8078 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
8079 % body, and then making it the \newlinechar in \scanmacro.
8081 \def\scanctxt{% used as subroutine
8090 \passthroughcharstrue
8093 \def\scanargctxt{% used for copying and captions, not macros.
8097 \catcode`\^^M=\other
8100 \def\macrobodyctxt{% used for @macro definitions
8106 \catcode`\^^M=\other
8110 % Used when scanning braced macro arguments. Note, however, that catcode
8111 % changes here are ineffectual if the macro invocation was nested inside
8112 % an argument to another Texinfo command.
8117 \catcode`\^^M=\other
8121 \def\macrolineargctxt{% used for whole-line arguments without braces
8128 % \mbodybackslash is the definition of \ in @macro bodies.
8129 % It maps \foo\ => \csname macarg.foo\endcsname => #N
8130 % where N is the macro parameter number.
8131 % We define \csname macarg.\endcsname to be \realbackslash, so
8132 % \\ in macro replacement text gets you a backslash.
8134 {\catcode`@=0 @catcode`@\=@active
8135 @gdef@usembodybackslash{@let\=@mbodybackslash}
8136 @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
8138 \expandafter\def\csname macarg.\endcsname{\realbackslash}
8140 \def\margbackslash#1{\char`\#1 }
8142 \def\macro{\recursivefalse\parsearg\macroxxx}
8143 \def\rmacro{\recursivetrue\parsearg\macroxxx}
8146 \getargs{#1}% now \macname is the macname and \argl the arglist
8147 \ifx\argl\empty % no arguments
8150 \expandafter\parsemargdef \argl;%
8151 \if\paramno>256\relax
8152 \ifx\eTeXversion\thisisundefined
8153 \errhelp = \EMsimple
8154 \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
8158 \if1\csname ismacro.\the\macname\endcsname
8159 \message{Warning: redefining \the\macname}%
8161 \expandafter\ifx\csname \the\macname\endcsname \relax
8162 \else \errmessage{Macro name \the\macname\space already defined}\fi
8163 \global\cslet{macsave.\the\macname}{\the\macname}%
8164 \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
8165 \addtomacrolist{\the\macname}%
8167 \begingroup \macrobodyctxt
8168 \ifrecursive \expandafter\parsermacbody
8169 \else \expandafter\parsemacbody
8172 \parseargdef\unmacro{%
8173 \if1\csname ismacro.#1\endcsname
8174 \global\cslet{#1}{macsave.#1}%
8175 \global\expandafter\let \csname ismacro.#1\endcsname=0%
8176 % Remove the macro name from \macrolist:
8178 \expandafter\let\csname#1\endcsname \relax
8179 \let\commondummyword\unmacrodo
8180 \xdef\macrolist{\macrolist}%
8183 \errmessage{Macro #1 not defined}%
8187 % Called by \do from \dounmacro on each macro. The idea is to omit any
8188 % macro definitions that have been changed to \relax.
8194 \noexpand\commondummyword \noexpand#1%
8198 % \getargs -- Parse the arguments to a @macro line. Set \macname to
8199 % the name of the macro, and \argl to the braced argument list.
8200 \def\getargs#1{\getargsxxx#1{}}
8201 \def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
8202 \def\getmacname#1 #2\relax{\macname={#1}}
8203 \def\getmacargs#1{\def\argl{#1}}
8204 % This made use of the feature that if the last token of a
8205 % <parameter list> is #, then the preceding argument is delimited by
8206 % an opening brace, and that opening brace is not consumed.
8208 % Parse the optional {params} list to @macro or @rmacro.
8209 % Set \paramno to the number of arguments,
8210 % and \paramlist to a parameter text for the macro (e.g. #1,#2,#3 for a
8211 % three-param macro.) Define \macarg.BLAH for each BLAH in the params
8212 % list to some hook where the argument is to be expanded. If there are
8213 % less than 10 arguments that hook is to be replaced by ##N where N
8214 % is the position in that list, that is to say the macro arguments are to be
8215 % defined `a la TeX in the macro body.
8217 % That gets used by \mbodybackslash (above).
8219 % If there are 10 or more arguments, a different technique is used: see
8220 % \parsemmanyargdef.
8222 \def\parsemargdef#1;{%
8223 \paramno=0\def\paramlist{}%
8225 % \hash is redefined to `#' later to get it into definitions
8226 \let\xeatspaces\relax
8227 \parsemargdefxxx#1,;,%
8228 \ifnum\paramno<10\relax\else
8230 \parsemmanyargdef@@#1,;,% 10 or more arguments
8233 \def\parsemargdefxxx#1,{%
8234 \if#1;\let\next=\relax
8235 \else \let\next=\parsemargdefxxx
8236 \advance\paramno by 1
8237 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
8238 {\xeatspaces{\hash\the\paramno}}%
8239 \edef\paramlist{\paramlist\hash\the\paramno,}%
8242 % \parsemacbody, \parsermacbody
8244 % Read recursive and nonrecursive macro bodies. (They're different since
8245 % rec and nonrec macros end differently.)
8247 % We are in \macrobodyctxt, and the \xdef causes backslashshes in the macro
8248 % body to be transformed.
8249 % Set \macrobody to the body of the macro, and call \defmacro.
8251 {\catcode`\ =\other\long\gdef\parsemacbody#1@end macro{%
8252 \xdef\macrobody{\eatcr{#1}}\endgroup\defmacro}}%
8253 {\catcode`\ =\other\long\gdef\parsermacbody#1@end rmacro{%
8254 \xdef\macrobody{\eatcr{#1}}\endgroup\defmacro}}%
8256 % Make @ a letter, so that we can make private-to-Texinfo macro names.
8257 \edef\texiatcatcode{\the\catcode`\@}
8258 \catcode `@=11\relax
8260 %%%%%%%%%%%%%% Code for > 10 arguments only %%%%%%%%%%%%%%%%%%
8262 % If there are 10 or more arguments, a different technique is used, where the
8263 % hook remains in the body, and when macro is to be expanded the body is
8264 % processed again to replace the arguments.
8266 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
8267 % argument N value and then \edef the body (nothing else will expand because of
8268 % the catcode regime under which the body was input).
8270 % If you compile with TeX (not eTeX), and you have macros with 10 or more
8271 % arguments, no macro can have more than 256 arguments (else error).
8273 % In case that there are 10 or more arguments we parse again the arguments
8274 % list to set new definitions for the \macarg.BLAH macros corresponding to
8275 % each BLAH argument. It was anyhow needed to parse already once this list
8276 % in order to count the arguments, and as macros with at most 9 arguments
8277 % are by far more frequent than macro with 10 or more arguments, defining
8278 % twice the \macarg.BLAH macros does not cost too much processing power.
8279 \def\parsemmanyargdef@@#1,{%
8280 \if#1;\let\next=\relax
8282 \let\next=\parsemmanyargdef@@
8283 \edef\tempb{\eatspaces{#1}}%
8284 \expandafter\def\expandafter\tempa
8285 \expandafter{\csname macarg.\tempb\endcsname}%
8286 % Note that we need some extra \noexpand\noexpand, this is because we
8287 % don't want \the to be expanded in the \parsermacbody as it uses an
8289 \expandafter\edef\tempa
8290 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
8291 \advance\paramno by 1\relax
8298 \long\def\nillm@{\nil@}%
8300 % This macro is expanded during the Texinfo macro expansion, not during its
8301 % definition. It gets all the arguments' values and assigns them to macros
8304 % #1 is the macro name
8305 % #2 is the list of argument names
8306 % #3 is the list of argument values
8307 \def\getargvals@#1#2#3{%
8308 \def\macargdeflist@{}%
8309 \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
8310 \def\paramlist{#2,\nil@}%
8314 \def\argvaluelist{#3,\nil@}%
8323 \ifx\paramlist\nilm@
8324 % Some sanity check needed here that \argvaluelist is also empty.
8325 \ifx\argvaluelist\nillm@
8327 \errhelp = \EMsimple
8328 \errmessage{Too many arguments in macro `\macroname'!}%
8330 \let\next\macargexpandinbody@
8332 \ifx\argvaluelist\nillm@
8333 % No more arguments values passed to macro. Set remaining named-arg
8335 \let\next\setemptyargvalues@
8337 % pop current arg name into \@tempb
8338 \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
8339 \expandafter\@tempa\expandafter{\paramlist}%
8340 % pop current argument value into \@tempc
8341 \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
8342 \expandafter\@tempa\expandafter{\argvaluelist}%
8343 % Here \@tempb is the current arg name and \@tempc is the current arg value.
8344 % First place the new argument macro definition into \@tempd
8345 \expandafter\macname\expandafter{\@tempc}%
8346 \expandafter\let\csname macarg.\@tempb\endcsname\relax
8347 \expandafter\def\expandafter\@tempe\expandafter{%
8348 \csname macarg.\@tempb\endcsname}%
8349 \edef\@tempd{\long\def\@tempe{\the\macname}}%
8350 \push@\@tempd\macargdeflist@
8351 \let\next\getargvals@@
8358 \expandafter\expandafter\expandafter\def
8359 \expandafter\expandafter\expandafter#2%
8360 \expandafter\expandafter\expandafter{%
8364 % Replace arguments by their values in the macro body, and place the result
8367 \def\macvalstoargs@{%
8368 % To do this we use the property that token registers that are \the'ed
8369 % within an \edef expand only once. So we are going to place all argument
8370 % values into respective token registers.
8372 % First we save the token context, and initialize argument numbering.
8375 % Then, for each argument number #N, we place the corresponding argument
8376 % value into a new token list register \toks#N
8377 \expandafter\putargsintokens@\saveparamlist@,;,%
8378 % Then, we expand the body so that argument are replaced by their
8379 % values. The trick for values not to be expanded themselves is that they
8380 % are within tokens and that tokens expand only once in an \edef .
8381 \edef\@tempc{\csname mac.\macroname .body\endcsname}%
8382 % Now we restore the token stack pointer to free the token list registers
8383 % which we have used, but we make sure that expanded body is saved after
8387 \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
8390 % Define the named-macro outside of this group and then close this group.
8392 \def\macargexpandinbody@{%
8396 % First the replace in body the macro arguments by their values, the result
8399 % Then we point at the \norecurse or \gobble (for recursive) macro value
8401 \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
8402 % Depending on whether it is recursive or not, we need some tailing
8409 % And now we do the real job:
8410 \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
8414 \def\putargsintokens@#1,{%
8415 \if#1;\let\next\relax
8417 \let\next\putargsintokens@
8418 % First we allocate the new token list register, and give it a temporary
8420 \toksdef\@tempb\the\paramno
8421 % Then we place the argument value into that token list register.
8422 \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
8423 \expandafter\@tempb\expandafter{\@tempa}%
8424 \advance\paramno by 1\relax
8429 % Trailing missing arguments are set to empty.
8431 \def\setemptyargvalues@{%
8432 \ifx\paramlist\nilm@
8433 \let\next\macargexpandinbody@
8435 \expandafter\setemptyargvaluesparser@\paramlist\endargs@
8436 \let\next\setemptyargvalues@
8441 \def\setemptyargvaluesparser@#1,#2\endargs@{%
8442 \expandafter\def\expandafter\@tempa\expandafter{%
8443 \expandafter\def\csname macarg.#1\endcsname{}}%
8444 \push@\@tempa\macargdeflist@
8448 % #1 is the element target macro
8449 % #2 is the list macro
8450 % #3,#4\endargs@ is the list value
8451 \def\pop@#1#2#3,#4\endargs@{%
8455 \long\def\longpop@#1#2#3,#4\endargs@{%
8461 %%%%%%%%%%%%%% End of code for > 10 arguments %%%%%%%%%%%%%%%%%%
8464 % This defines a Texinfo @macro or @rmacro, called by \parsemacbody.
8465 % \macrobody has the body of the macro in it, with placeholders for
8466 % its parameters, looking like "\xeatspaces{\hash 1}".
8467 % \paramno is the number of parameters
8468 % \paramlist is a TeX parameter text, e.g. "#1,#2,#3,"
8469 % There are four cases: macros of zero, one, up to nine, and many arguments.
8470 % \xdef is used so that macro definitions will survive the file
8471 % they're defined in: @include reads the file inside a group.
8474 \let\hash=##% convert placeholders to macro parameter chars
8476 \def\xeatspaces##1{##1}%
8477 % This removes the pair of braces around the argument. We don't
8478 % use \eatspaces, because this can cause ends of lines to be lost
8479 % when the argument to \eatspaces is read, leading to line-based
8480 % commands like "@itemize" not being read correctly.
8482 \let\xeatspaces\relax % suppress expansion
8486 \expandafter\xdef\csname\the\macname\endcsname{%
8488 \noexpand\spaceisspace
8489 \noexpand\endlineisspace
8490 \noexpand\expandafter % skip any whitespace after the macro name.
8491 \expandafter\noexpand\csname\the\macname @@@\endcsname}%
8492 \expandafter\xdef\csname\the\macname @@@\endcsname{%
8494 \noexpand\scanmacro{\macrobody}}%
8496 \expandafter\xdef\csname\the\macname\endcsname{%
8498 \noexpand\braceorline
8499 \expandafter\noexpand\csname\the\macname @@@\endcsname}%
8500 \expandafter\xdef\csname\the\macname @@@\endcsname##1{%
8502 \noexpand\scanmacro{\macrobody}%
8505 \ifnum\paramno<10\relax
8506 % @MACNAME sets the context for reading the macro argument
8507 % @MACNAME@@ gets the argument, processes backslashes and appends a
8509 % @MACNAME@@@ removes braces surrounding the argument list.
8510 % @MACNAME@@@@ scans the macro body with arguments substituted.
8511 \expandafter\xdef\csname\the\macname\endcsname{%
8513 \noexpand\expandafter % This \expandafter skip any spaces after the
8514 \noexpand\macroargctxt % macro before we change the catcode of space.
8515 \noexpand\expandafter
8516 \expandafter\noexpand\csname\the\macname @@\endcsname}%
8517 \expandafter\xdef\csname\the\macname @@\endcsname##1{%
8518 \noexpand\passargtomacro
8519 \expandafter\noexpand\csname\the\macname @@@\endcsname{##1,}}%
8520 \expandafter\xdef\csname\the\macname @@@\endcsname##1{%
8521 \expandafter\noexpand\csname\the\macname @@@@\endcsname ##1}%
8522 \expandafter\expandafter
8524 \expandafter\expandafter
8525 \csname\the\macname @@@@\endcsname\paramlist{%
8526 \egroup\noexpand\scanmacro{\macrobody}}%
8528 \expandafter\xdef\csname\the\macname\endcsname{%
8529 \noexpand\getargvals@{\the\macname}{\argl}%
8531 \global\expandafter\let\csname mac.\the\macname .body\endcsname\macrobody
8532 \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
8536 \catcode `\@\texiatcatcode\relax % end private-to-Texinfo catcodes
8538 \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
8541 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8543 {\catcode`\@=0 \catcode`\\=13 % We need to manipulate \ so use @ as escape
8544 @catcode`@_=11 % private names
8545 @catcode`@!=11 % used as argument separator
8547 % \passargtomacro#1#2 -
8548 % Call #1 with a list of tokens #2, with any doubled backslashes in #2
8549 % compressed to one.
8551 % This implementation works by expansion, and not execution (so we cannot use
8552 % \def or similar). This reduces the risk of this failing in contexts where
8553 % complete expansion is done with no execution (for example, in writing out to
8554 % an auxiliary file for an index entry).
8556 % State is kept in the input stream: the argument passed to
8557 % @look_ahead, @gobble_and_check_finish and @add_segment is
8559 % THE_MACRO ARG_RESULT ! {PENDING_BS} NEXT_TOKEN (... rest of input)
8562 % THE_MACRO - name of the macro we want to call
8563 % ARG_RESULT - argument list we build to pass to that macro
8564 % PENDING_BS - either a backslash or nothing
8565 % NEXT_TOKEN - used to look ahead in the input stream to see what's coming next
8567 @gdef@passargtomacro#1#2{%
8568 @add_segment #1!{}@relax#2\@_finish\%
8570 @gdef@_finish{@_finishx} @global@let@_finishx@relax
8572 % #1 - THE_MACRO ARG_RESULT
8575 % #4 used to look ahead
8577 % If the next token is not a backslash, process the rest of the argument;
8578 % otherwise, remove the next token.
8579 @gdef@look_ahead#1!#2#3#4{%
8581 @expandafter@gobble_and_check_finish
8583 @expandafter@add_segment
8587 % #1 - THE_MACRO ARG_RESULT
8590 % #4 should be a backslash, which is gobbled.
8593 % Double backslash found. Add a single backslash, and look ahead.
8594 @gdef@gobble_and_check_finish#1!#2#3#4#5{%
8595 @add_segment#1\!{}#5#5%
8600 % #1 - THE_MACRO ARG_RESULT
8603 % #4 is input stream until next backslash
8605 % Input stream is either at the start of the argument, or just after a
8606 % backslash sequence, either a lone backslash, or a doubled backslash.
8607 % NEXT_TOKEN contains the first token in the input stream: if it is \finish,
8608 % finish; otherwise, append to ARG_RESULT the segment of the argument up until
8609 % the next backslash. PENDING_BACKSLASH contains a backslash to represent
8610 % a backslash just before the start of the input stream that has not been
8611 % added to ARG_RESULT.
8612 @gdef@add_segment#1!#2#3#4\{%
8616 % append the pending backslash to the result, followed by the next segment
8617 @expandafter@is_fi@look_ahead#1#2#4!{\}@fi
8618 % this @fi is discarded by @look_ahead.
8619 % we can't get rid of it with \expandafter because we don't know how
8625 % #3 discards the res of the conditional in @add_segment, and @is_fi ends the
8627 @gdef@call_the_macro#1#2!#3@fi{@is_fi #1{#2}}
8630 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8632 % \braceorline MAC is used for a one-argument macro MAC. It checks
8633 % whether the next non-whitespace character is a {. It sets the context
8634 % for reading the argument (slightly different in the two cases). Then,
8635 % to read the argument, in the whole-line case, it then calls the regular
8636 % \parsearg MAC; in the lbrace case, it calls \passargtomacro MAC.
8638 \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
8639 \def\braceorlinexxx{%
8642 \expandafter\passargtomacro
8644 \macrolineargctxt\expandafter\parsearg
8649 % We need some trickery to remove the optional spaces around the equal
8650 % sign. Make them active and then expand them all to nothing.
8652 \def\alias{\parseargusing\obeyspaces\aliasxxx}
8653 \def\aliasxxx #1{\aliasyyy#1\relax}
8654 \def\aliasyyy #1=#2\relax{%
8656 \expandafter\let\obeyedspace=\empty
8657 \addtomacrolist{#1}%
8658 \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
8664 \message{cross references,}
8667 \newif\ifhavexrefs % True if xref values are known.
8668 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
8670 % @inforef is relatively simple.
8671 \def\inforef #1{\inforefzzz #1,,,,**}
8672 \def\inforefzzz #1,#2,#3,#4**{%
8673 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
8674 node \samp{\ignorespaces#1{}}}
8676 % @node's only job in TeX is to define \lastnode, which is used in
8677 % cross-references. The @node line might or might not have commas, and
8678 % might or might not have spaces before the first comma, like:
8679 % @node foo , bar , ...
8680 % We don't want such trailing spaces in the node name.
8682 \parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
8684 % also remove a trailing comma, in case of something like this:
8685 % @node Help-Cross, , , Cross-refs
8686 \def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
8687 \def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}\omittopnode}
8689 % Used so that the @top node doesn't have to be wrapped in an @ifnottex
8691 % \doignore goes to more effort to skip nested conditionals but we don't need
8694 \ifx\lastnode\wordTop
8695 \expandafter\ignorenode\fi
8699 % Until the next @node or @bye command, divert output to a box that is not
8701 \def\ignorenode{\setbox\dummybox\vbox\bgroup\def\node{\egroup\node}%
8706 \gdef\ignorenodebye{\let\bye\ignorenodebyedef}
8707 \gdef\ignorenodebyedef{\egroup(`Top' node ignored)\bye}}
8708 % The redefinition of \bye here is because it is declared \outer
8710 \let\lastnode=\empty
8712 % Write a cross-reference definition for the current node. #1 is the
8713 % type (Ynumbered, Yappendix, Ynothing).
8716 \ifx\lastnode\empty\else
8717 \setref{\lastnode}{#1}%
8718 \global\let\lastnode=\empty
8722 % @anchor{NAME} -- define xref target at arbitrary point.
8724 \newcount\savesfregister
8726 \def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
8727 \def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
8728 \def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
8730 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
8731 % anchor), which consists of three parts:
8732 % 1) NAME-title - the current sectioning name taken from \currentsection,
8733 % or the anchor name.
8734 % 2) NAME-snt - section number and type, passed as the SNT arg, or
8735 % empty for anchors.
8736 % 3) NAME-pg - the page number.
8738 % This is called from \donoderef, \anchor, and \dofloat. In the case of
8739 % floats, there is an additional part, which is not written here:
8740 % 4) NAME-lof - the text as it should appear in a @listoffloats.
8747 \atdummies % preserve commands, but don't expand them
8748 % match definition in \xrdef, \refx, \xrefX.
8750 \edef\writexrdef##1##2{%
8751 \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
8752 ##1}{##2}}% these are parameters of \writexrdef
8754 \toks0 = \expandafter{\currentsection}%
8755 \immediate \writexrdef{title}{\the\toks0 }%
8756 \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
8757 \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
8762 % @xrefautosectiontitle on|off says whether @section(ing) names are used
8763 % automatically in xrefs, if the third arg is not explicitly specified.
8764 % This was provided as a "secret" @set xref-automatic-section-title
8765 % variable, now it's official.
8767 \parseargdef\xrefautomaticsectiontitle{%
8770 \expandafter\let\csname SETxref-automatic-section-title\endcsname
8772 \else\ifx\temp\offword
8773 \expandafter\let\csname SETxref-automatic-section-title\endcsname
8776 \errhelp = \EMsimple
8777 \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
8783 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
8784 % the node name, #2 the name of the Info cross-reference, #3 the printed
8785 % node name, #4 the name of the Info file, #5 the name of the printed
8786 % manual. All but the node name can be omitted.
8788 \def\pxref{\putwordsee{} \xrefXX}
8789 \def\xref{\putwordSee{} \xrefXX}
8792 \def\xrefXX#1{\def\xrefXXarg{#1}\futurelet\tokenafterxref\xrefXXX}
8793 \def\xrefXXX{\expandafter\xrefX\expandafter[\xrefXXarg,,,,,,,]}
8796 \newbox\printedrefnamebox
8797 \newbox\infofilenamebox
8798 \newbox\printedmanualbox
8800 \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
8803 % Get args without leading/trailing spaces.
8804 \def\printedrefname{\ignorespaces #3}%
8805 \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
8807 \def\infofilename{\ignorespaces #4}%
8808 \setbox\infofilenamebox = \hbox{\infofilename\unskip}%
8810 \def\printedmanual{\ignorespaces #5}%
8811 \setbox\printedmanualbox = \hbox{\printedmanual\unskip}%
8813 % If the printed reference name (arg #3) was not explicitly given in
8814 % the @xref, figure out what we want to use.
8815 \ifdim \wd\printedrefnamebox = 0pt
8816 % No printed node name was explicitly given.
8817 \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
8818 % Not auto section-title: use node name inside the square brackets.
8819 \def\printedrefname{\ignorespaces #1}%
8821 % Auto section-title: use chapter/section title inside
8822 % the square brackets if we have it.
8823 \ifdim \wd\printedmanualbox > 0pt
8824 % It is in another manual, so we don't have it; use node name.
8825 \def\printedrefname{\ignorespaces #1}%
8828 % We (should) know the real title if we have the xref values.
8829 \def\printedrefname{\refx{#1-title}{}}%
8831 % Otherwise just copy the Info node name.
8832 \def\printedrefname{\ignorespaces #1}%
8838 % Make link in pdf output.
8840 % For pdfTeX and LuaTeX
8842 \makevalueexpandable
8844 % This expands tokens, so do it after making catcode changes, so _
8845 % etc. don't get their TeX definitions. This ignores all spaces in
8846 % #4, including (wrongly) those in the middle of the filename.
8849 % This (wrongly) does not take account of leading or trailing
8850 % spaces in #1, which should be ignored.
8851 \setpdfdestname{#1}%
8853 \ifx\pdfdestname\empty
8854 \def\pdfdestname{Top}% no empty targets
8858 \startlink attr{/Border [0 0 0]}%
8859 \ifnum\filenamelength>0
8860 goto file{\the\filename.pdf} name{\pdfdestname}%
8862 goto name{\pdfmkpgn{\pdfdestname}}%
8865 \setcolor{\linkcolor}%
8867 \ifx\XeTeXrevision\thisisundefined
8871 \makevalueexpandable
8873 % This expands tokens, so do it after making catcode changes, so _
8874 % etc. don't get their TeX definitions. This ignores all spaces in
8875 % #4, including (wrongly) those in the middle of the filename.
8878 % This (wrongly) does not take account of leading or trailing
8879 % spaces in #1, which should be ignored.
8880 \setpdfdestname{#1}%
8882 \ifx\pdfdestname\empty
8883 \def\pdfdestname{Top}% no empty targets
8887 \ifnum\filenamelength>0
8888 % With default settings,
8889 % XeTeX (xdvipdfmx) replaces link destination names with integers.
8890 % In this case, the replaced destination names of
8891 % remote PDFs are no longer known. In order to avoid a replacement,
8892 % you can use xdvipdfmx's command line option `-C 0x0010'.
8893 % If you use XeTeX 0.99996+ (TeX Live 2016+),
8894 % this command line option is no longer necessary
8895 % because we can use the `dvipdfmx:config' special.
8896 \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A
8897 << /S /GoToR /F (\the\filename.pdf) /D (\pdfdestname) >> >>}%
8899 \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A
8900 << /S /GoTo /D (\pdfdestname) >> >>}%
8903 \setcolor{\linkcolor}%
8907 % Have to otherify everything special to allow the \csname to
8908 % include an _ in the xref name, etc.
8912 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
8913 \csname XR#1-title\endcsname
8916 % Float references are printed completely differently: "Figure 1.2"
8917 % instead of "[somenode], p.3". \iffloat distinguishes them by
8918 % \Xthisreftitle being set to a magic string.
8919 \iffloat\Xthisreftitle
8920 % If the user specified the print name (third arg) to the ref,
8921 % print it instead of our usual "Figure 1.2".
8922 \ifdim\wd\printedrefnamebox = 0pt
8928 % If the user also gave the printed manual name (fifth arg), append
8930 \ifdim \wd\printedmanualbox > 0pt
8931 \space \putwordin{} \cite{\printedmanual}%
8934 % node/anchor (non-float) references.
8936 % If we use \unhbox to print the node names, TeX does not insert
8937 % empty discretionaries after hyphens, which means that it will not
8938 % find a line break at a hyphen in a node names. Since some manuals
8939 % are best written with fairly long node names, containing hyphens,
8940 % this is a loss. Therefore, we give the text of the node name
8941 % again, so it is as if TeX is seeing it for the first time.
8943 \ifdim \wd\printedmanualbox > 0pt
8944 % Cross-manual reference with a printed manual name.
8946 \crossmanualxref{\cite{\printedmanual\unskip}}%
8948 \else\ifdim \wd\infofilenamebox > 0pt
8949 % Cross-manual reference with only an info filename (arg 4), no
8950 % printed manual name (arg 5). This is essentially the same as
8951 % the case above; we output the filename, since we have nothing else.
8953 \crossmanualxref{\code{\infofilename\unskip}}%
8956 % Reference within this manual.
8958 % _ (for example) has to be the character _ for the purposes of the
8959 % control sequence corresponding to the node, but it has to expand
8960 % into the usual \leavevmode...\vrule stuff for purposes of
8961 % printing. So we \turnoffactive for the \refx-snt, back on for the
8962 % printing, back off for the \refx-pg.
8964 % Only output a following space if the -snt ref is nonempty; for
8965 % @unnumbered and @anchor, it won't be.
8966 \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
8967 \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
8969 % output the `[mynode]' via the macro below so it can be overridden.
8970 \xrefprintnodename\printedrefname
8972 % But we always want a comma and a space:
8975 % output the `page 3'.
8976 \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
8977 % Add a , if xref followed by a space
8978 \if\space\noexpand\tokenafterxref ,%
8979 \else\ifx\ \tokenafterxref ,% @TAB
8980 \else\ifx\*\tokenafterxref ,% @*
8981 \else\ifx\ \tokenafterxref ,% @SPACE
8983 \tokenafterxref ,% @NL
8984 \else\ifx\tie\tokenafterxref ,% @tie
8991 % Output a cross-manual xref to #1. Used just above (twice).
8993 % Only include the text "Section ``foo'' in" if the foo is neither
8994 % missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply
8995 % "see The Foo Manual", the idea being to refer to the whole manual.
8997 % But, this being TeX, we can't easily compare our node name against the
8998 % string "Top" while ignoring the possible spaces before and after in
8999 % the input. By adding the arbitrary 7sp below, we make it much less
9000 % likely that a real node name would have the same width as "Top" (e.g.,
9001 % in a monospaced font). Hopefully it will never happen in practice.
9003 % For the same basic reason, we retypeset the "Top" at every
9004 % reference, since the current font is indeterminate.
9006 \def\crossmanualxref#1{%
9007 \setbox\toprefbox = \hbox{Top\kern7sp}%
9008 \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
9009 \ifdim \wd2 > 7sp % nonempty?
9010 \ifdim \wd2 = \wd\toprefbox \else % same as Top?
9011 \putwordSection{} ``\printedrefname'' \putwordin{}\space
9017 % This macro is called from \xrefX for the `[nodename]' part of xref
9018 % output. It's a separate macro only so it can be changed more easily,
9019 % since square brackets don't work well in some documents. Particularly
9020 % one that Bob is working on :).
9022 \def\xrefprintnodename#1{[#1]}
9024 % Things referred to by \setref.
9030 \putwordChapter@tie \the\chapno
9031 \else \ifnum\subsecno=0
9032 \putwordSection@tie \the\chapno.\the\secno
9033 \else \ifnum\subsubsecno=0
9034 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
9036 \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
9041 \putwordAppendix@tie @char\the\appendixno{}%
9042 \else \ifnum\subsecno=0
9043 \putwordSection@tie @char\the\appendixno.\the\secno
9044 \else \ifnum\subsubsecno=0
9045 \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
9048 @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
9052 % \refx{NAME}{SUFFIX} - reference a cross-reference string named NAME. SUFFIX
9053 % is output afterwards if non-empty.
9060 \expandafter\global\expandafter\let\expandafter\thisrefX
9061 \csname XR#1\endcsname
9064 % If not defined, say something at least.
9065 \angleleft un\-de\-fined\angleright
9068 {\toks0 = {#1}% avoid expansion of possibly-complex value
9069 \message{\linenumber Undefined cross reference `\the\toks0'.}}%
9072 \global\warnedxrefstrue
9073 \message{Cross reference values unknown; you must run TeX again.}%
9078 % It's defined, so just use it.
9081 #2% Output the suffix in any case.
9084 % This is the macro invoked by entries in the aux file. Define a control
9085 % sequence for a cross-reference target (we prepend XR to the control sequence
9086 % name to avoid collisions). The value is the page number. If this is a float
9087 % type, we have more work to do.
9090 {% Expand the node or anchor name to remove control sequences.
9091 % \turnoffactive stops 8-bit characters being changed to commands
9092 % like @'e. \refx does the same to retrieve the value in the definition.
9096 \xdef\safexrefname{#1}%
9100 \expandafter\gdef\csname XR\safexrefname\endcsname{#2}%
9102 % We put the \gdef inside a group to avoid the definitions building up on
9103 % TeX's save stack, which can cause it to run out of space for aux files with
9104 % thousands of lines. \gdef doesn't use the save stack, but \csname does
9105 % when it defines an unknown control sequence as \relax.
9107 % Was that xref control sequence that we just defined for a float?
9108 \expandafter\iffloat\csname XR\safexrefname\endcsname
9109 % it was a float, and we have the (safe) float type in \iffloattype.
9110 \expandafter\let\expandafter\floatlist
9111 \csname floatlist\iffloattype\endcsname
9113 % Is this the first time we've seen this float type?
9114 \expandafter\ifx\floatlist\relax
9115 \toks0 = {\do}% yes, so just \do
9117 % had it before, so preserve previous elements in list.
9118 \toks0 = \expandafter{\floatlist\do}%
9121 % Remember this xref in the control sequence \floatlistFLOATTYPE,
9122 % for later use in \listoffloats.
9123 \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
9128 % If working on a large document in chapters, it is convenient to
9129 % be able to disable indexing, cross-referencing, and contents, for test runs.
9130 % This is done with @novalidate at the beginning of the file.
9132 \newif\iflinks \linkstrue % by default we want the aux files.
9133 \let\novalidate = \linksfalse
9135 % Used when writing to the aux file, or when using data from it.
9136 \def\requireauxfile{%
9139 % Open the new aux file. TeX will close it automatically at exit.
9140 \immediate\openout\auxfile=\jobname.aux
9142 \global\let\requireauxfile=\relax % Only do this once.
9145 % Read the last existing aux file, if any. No error if none exists.
9148 \openin 1 \jobname.aux
9151 \global\havexrefstrue
9156 \def\setupdatafile{%
9157 \catcode`\^^@=\other
9158 \catcode`\^^A=\other
9159 \catcode`\^^B=\other
9160 \catcode`\^^C=\other
9161 \catcode`\^^D=\other
9162 \catcode`\^^E=\other
9163 \catcode`\^^F=\other
9164 \catcode`\^^G=\other
9165 \catcode`\^^H=\other
9166 \catcode`\^^K=\other
9167 \catcode`\^^L=\other
9168 \catcode`\^^N=\other
9169 \catcode`\^^P=\other
9170 \catcode`\^^Q=\other
9171 \catcode`\^^R=\other
9172 \catcode`\^^S=\other
9173 \catcode`\^^T=\other
9174 \catcode`\^^U=\other
9175 \catcode`\^^V=\other
9176 \catcode`\^^W=\other
9177 \catcode`\^^X=\other
9178 \catcode`\^^Z=\other
9179 \catcode`\^^[=\other
9180 \catcode`\^^\=\other
9181 \catcode`\^^]=\other
9182 \catcode`\^^^=\other
9183 \catcode`\^^_=\other
9186 % Special characters. Should be turned off anyway, but...
9199 \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
9203 % @ is our escape character in .aux files, and we need braces.
9209 \def\readdatafile#1{%
9216 \message{insertions,}
9217 % including footnotes.
9219 \newcount \footnoteno
9221 % The trailing space in the following definition for supereject is
9222 % vital for proper filling; pages come out unaligned when you do a
9223 % pagealignmacro call if that space before the closing brace is
9224 % removed. (Generally, numeric constants should always be followed by a
9225 % space to prevent strange expansion errors.)
9226 \def\supereject{\par\penalty -20000\footnoteno =0 }
9228 % @footnotestyle is meaningful for Info output only.
9229 \let\footnotestyle=\comment
9233 % Auto-number footnotes. Otherwise like plain.
9235 \global\advance\footnoteno by \@ne
9236 \edef\thisfootno{$^{\the\footnoteno}$}%
9238 % In case the footnote comes at the end of a sentence, preserve the
9239 % extra spacing after we do the footnote number.
9241 \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
9243 % Remove inadvertent blank space before typesetting the footnote number.
9249 % Don't bother with the trickery in plain.tex to not require the
9250 % footnote text as a parameter. Our footnotes don't need to be so general.
9252 % Oh yes, they do; otherwise, @ifset (and anything else that uses
9253 % \parseargline) fails inside footnotes because the tokens are fixed when
9254 % the footnote is read. --karl, 16nov96.
9257 \insert\footins\bgroup
9259 % Nested footnotes are not supported in TeX, that would take a lot
9260 % more work. (\startsavinginserts does not suffice.)
9261 \let\footnote=\errfootnotenest
9263 % We want to typeset this text as a normal paragraph, even if the
9264 % footnote reference occurs in (for example) a display environment.
9265 % So reset some parameters.
9266 \hsize=\txipagewidth
9267 \interlinepenalty\interfootnotelinepenalty
9268 \splittopskip\ht\strutbox % top baseline for broken footnotes
9269 \splitmaxdepth\dp\strutbox
9270 \floatingpenalty\@MM
9275 \parindent\defaultparindent
9279 % Because we use hanging indentation in footnotes, a @noindent appears
9280 % to exdent this text, so make it be a no-op. makeinfo does not use
9281 % hanging indentation so @noindent can still be needed within footnote
9282 % text after an @example or the like (not that this is good style).
9283 \let\noindent = \relax
9285 % Hang the footnote text off the number. Use \everypar in case the
9286 % footnote extends for more than one paragraph.
9287 \everypar = {\hang}%
9288 \textindent{\thisfootno}%
9290 % Don't crash into the line above the footnote text. Since this
9291 % expands into a box, it must come within the paragraph, lest it
9292 % provide a place where TeX can split the footnote.
9295 % Invoke rest of plain TeX footnote routine.
9296 \futurelet\next\fo@t
9298 }%end \catcode `\@=11
9300 \def\errfootnotenest{%
9302 \errmessage{Nested footnotes not supported in texinfo.tex,
9303 even though they work in makeinfo; sorry}
9306 \def\errfootnoteheading{%
9308 \errmessage{Footnotes in chapters, sections, etc., are not supported}
9311 % In case a @footnote appears in a vbox, save the footnote text and create
9312 % the real \insert just after the vbox finished. Otherwise, the insertion
9314 % Similarly, if a @footnote appears inside an alignment, save the footnote
9315 % text to a box and make the \insert when a row of the table is finished.
9316 % And the same can be done for other insert classes. --kasal, 16nov03.
9318 % Replace the \insert primitive by a cheating macro.
9319 % Deeper inside, just make sure that the saved insertions are not spilled
9322 \def\startsavinginserts{%
9323 \ifx \insert\ptexinsert
9324 \let\insert\saveinsert
9326 \let\checkinserts\relax
9330 % This \insert replacement works for both \insert\footins{foo} and
9331 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
9334 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
9335 \afterassignment\next
9336 % swallow the left brace
9339 \def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
9340 \def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
9342 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
9344 \def\placesaveins#1{%
9345 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
9349 % eat @SAVE -- beware, all of them have catcode \other:
9351 \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
9352 \gdef\gobblesave @SAVE{}
9356 \def\newsaveins #1{%
9357 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
9360 \def\newsaveinsX #1{%
9361 \csname newbox\endcsname #1%
9362 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
9367 \let\checkinserts\empty
9372 % @image. We use the macros from epsf.tex to support this.
9373 % If epsf.tex is not installed and @image is used, we complain.
9375 % Check for and read epsf.tex up front. If we read it only at @image
9376 % time, we might be inside a group, and then its definitions would get
9377 % undone and the next image would fail.
9378 \openin 1 = epsf.tex
9380 % Do not bother showing banner with epsf.tex v2.7k (available in
9381 % doc/epsf.tex and on ctan).
9382 \def\epsfannounce{\toks0 = }%
9387 % We will only complain once about lack of epsf.tex.
9388 \newif\ifwarnednoepsf
9389 \newhelp\noepsfhelp{epsf.tex must be installed for images to
9390 work. It is also included in the Texinfo distribution, or you can get
9391 it from https://ctan.org/texarchive/macros/texinfo/texinfo/doc/epsf.tex.}
9394 \ifx\epsfbox\thisisundefined
9395 \ifwarnednoepsf \else
9396 \errhelp = \noepsfhelp
9397 \errmessage{epsf.tex not found, images will be ignored}%
9398 \global\warnednoepsftrue
9401 \imagexxx #1,,,,,\finish
9405 % Arguments to @image:
9406 % #1 is (mandatory) image filename; we tack on .eps extension.
9407 % #2 is (optional) width, #3 is (optional) height.
9408 % #4 is (ignored optional) html alt text.
9409 % #5 is (ignored optional) extension.
9410 % #6 is just the usual extra ignored arg for parsing stuff.
9412 \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
9413 \catcode`\^^M = 5 % in case we're inside an example
9414 \normalturnoffactive % allow _ et al. in names
9415 \def\xprocessmacroarg{\eatspaces}% in case we are being used via a macro
9416 % If the image is by itself, center it.
9419 \else \ifx\centersub\centerV
9420 % for @center @image, we need a vbox so we can have our vertical space
9422 \vbox\bgroup % vbox has better behavior than vtop herev
9427 % Usually we'll have text after the image which will insert
9428 % \parskip glue, so insert it here too to equalize the space
9430 \nobreak\vskip\parskip
9434 % Leave vertical mode so that indentation from an enclosing
9435 % environment such as @quotation is respected.
9436 % However, if we're at the top level, we don't want the
9437 % normal paragraph indentation.
9438 % On the other hand, if we are in the case of @center @image, we don't
9439 % want to start a paragraph, which will create a hsize-width box and
9440 % eradicate the centering.
9441 \ifx\centersub\centerV\else \noindent \fi
9445 % For pdfTeX and LuaTeX <= 0.80
9446 \dopdfimage{#1}{#2}{#3}%
9448 \ifx\XeTeXrevision\thisisundefined
9450 % \epsfbox itself resets \epsf?size at each figure.
9451 \setbox0 = \hbox{\ignorespaces #2}%
9452 \ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
9453 \setbox0 = \hbox{\ignorespaces #3}%
9454 \ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
9458 \doxeteximage{#1}{#2}{#3}%
9463 \medskip % space after a standalone image
9465 \ifx\centersub\centerV \egroup \fi
9469 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
9470 % etc. We don't actually implement floating yet, we always include the
9471 % float "here". But it seemed the best name for the future.
9473 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
9475 % There may be a space before second and/or third parameter; delete it.
9476 \def\eatcommaspace#1, {#1,}
9478 % #1 is the optional FLOATTYPE, the text label for this float, typically
9479 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
9480 % this float will not be numbered and cannot be referred to.
9482 % #2 is the optional xref label. Also must be present for the float to
9485 % #3 is the optional positioning argument; for now, it is ignored. It
9486 % will somehow specify the positions allowed to float to (here, top, bottom).
9488 % We keep a separate counter for each FLOATTYPE, which we reset at each
9489 % chapter-level command.
9490 \let\resetallfloatnos=\empty
9492 \def\dofloat#1,#2,#3,#4\finish{%
9493 \let\thiscaption=\empty
9494 \let\thisshortcaption=\empty
9496 % don't lose footnotes inside @float.
9498 % BEWARE: when the floats start float, we have to issue warning whenever an
9499 % insert appears inside a float which could possibly float. --kasal, 26may04
9503 % We can't be used inside a paragraph.
9508 \def\floatlabel{#2}%
9509 \def\floatloc{#3}% we do nothing with this yet.
9511 \ifx\floattype\empty
9512 \let\safefloattype=\empty
9515 % the floattype might have accents or other special characters,
9516 % but we need to use it in a control sequence name.
9519 \xdef\safefloattype{\floattype}%
9523 % If label is given but no type, we handle that as the empty type.
9524 \ifx\floatlabel\empty \else
9525 % We want each FLOATTYPE to be numbered separately (Figure 1,
9526 % Table 1, Figure 2, ...). (And if no label, no number.)
9528 \expandafter\getfloatno\csname\safefloattype floatno\endcsname
9529 \global\advance\floatno by 1
9532 % This magic value for \currentsection is output by \setref as the
9533 % XREFLABEL-title value. \xrefX uses it to distinguish float
9534 % labels (which have a completely different output format) from
9535 % node and anchor labels. And \xrdef uses it to construct the
9538 \edef\currentsection{\floatmagic=\safefloattype}%
9539 \setref{\floatlabel}{Yfloat}%
9543 % start with \parskip glue, I guess.
9546 % Don't suppress indentation if a float happens to start a section.
9547 \restorefirstparagraphindent
9550 % we have these possibilities:
9551 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
9552 % @float Foo,lbl & no caption: Foo 1.1
9553 % @float Foo & @caption{Cap}: Foo: Cap
9554 % @float Foo & no caption: Foo
9555 % @float ,lbl & Caption{Cap}: 1.1: Cap
9556 % @float ,lbl & no caption: 1.1
9557 % @float & @caption{Cap}: Cap
9558 % @float & no caption:
9561 \let\floatident = \empty
9563 % In all cases, if we have a float type, it comes first.
9564 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
9566 % If we have an xref label, the number comes next.
9567 \ifx\floatlabel\empty \else
9568 \ifx\floattype\empty \else % if also had float type, need tie first.
9569 \appendtomacro\floatident{\tie}%
9572 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
9575 % Start the printed caption with what we've constructed in
9576 % \floatident, but keep it separate; we need \floatident again.
9577 \let\captionline = \floatident
9579 \ifx\thiscaption\empty \else
9580 \ifx\floatident\empty \else
9581 \appendtomacro\captionline{: }% had ident, so need a colon between
9585 \appendtomacro\captionline{\scanexp\thiscaption}%
9588 % If we have anything to print, print it, with space before.
9589 % Eventually this needs to become an \insert.
9590 \ifx\captionline\empty \else
9594 % Space below caption.
9598 % If have an xref label, write the list of floats info. Do this
9599 % after the caption, to avoid chance of it being a breakpoint.
9600 \ifx\floatlabel\empty \else
9601 % Write the text that goes in the lof to the aux file as
9602 % \floatlabel-lof. Besides \floatident, we include the short
9603 % caption if specified, else the full caption if specified, else nothing.
9608 \ifx\thisshortcaption\empty
9609 \def\gtemp{\thiscaption}%
9611 \def\gtemp{\thisshortcaption}%
9613 \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
9614 \ifx\gtemp\empty \else : \gtemp \fi}}%
9617 \egroup % end of \vtop
9622 % Append the tokens #2 to the definition of macro #1, not expanding either.
9624 \def\appendtomacro#1#2{%
9625 \expandafter\def\expandafter#1\expandafter{#1#2}%
9628 % @caption, @shortcaption
9630 \def\caption{\docaption\thiscaption}
9631 \def\shortcaption{\docaption\thisshortcaption}
9632 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
9633 \def\defcaption#1#2{\egroup \def#1{#2}}
9635 % The parameter is the control sequence identifying the counter we are
9636 % going to use. Create it if it doesn't exist and assign it to \floatno.
9639 % Haven't seen this figure type before.
9640 \csname newcount\endcsname #1%
9642 % Remember to reset this floatno at the next chap.
9643 \expandafter\gdef\expandafter\resetallfloatnos
9644 \expandafter{\resetallfloatnos #1=0 }%
9649 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
9650 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
9651 % first read the @float command.
9653 \def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
9655 % Magic string used for the XREFLABEL-title value, so \xrefX can
9656 % distinguish floats from other xref types.
9657 \def\floatmagic{!!float!!}
9659 % #1 is the control sequence we are passed; we expand into a conditional
9660 % which is true if #1 represents a float ref. That is, the magic
9661 % \currentsection value which we \setref above.
9663 \def\iffloat#1{\expandafter\doiffloat#1==\finish}
9665 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
9666 % (safe) float type for this float. We set \iffloattype to #2.
9668 \def\doiffloat#1=#2=#3\finish{%
9670 \def\iffloattype{#2}%
9671 \ifx\temp\floatmagic
9674 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
9676 \parseargdef\listoffloats{%
9677 \def\floattype{#1}% floattype
9679 % the floattype might have accents or other special characters,
9680 % but we need to use it in a control sequence name.
9683 \xdef\safefloattype{\floattype}%
9686 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
9687 \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
9689 % if the user said @listoffloats foo but never @float foo.
9690 \message{\linenumber No `\safefloattype' floats to list.}%
9694 \leftskip=\tocindent % indent these entries like a toc
9695 \let\do=\listoffloatsdo
9696 \csname floatlist\safefloattype\endcsname
9701 % This is called on each entry in a list of floats. We're passed the
9702 % xref label, in the form LABEL-title, which is how we save it in the
9703 % aux file. We strip off the -title and look up \XRLABEL-lof, which
9704 % has the text we're supposed to typeset here.
9706 % Figures without xref labels will not be included in the list (since
9707 % they won't appear in the aux file).
9709 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
9710 \def\listoffloatsdoentry#1-title\finish{{%
9711 % Can't fully expand XR#1-lof because it can contain anything. Just
9712 % pass the control sequence. On the other hand, XR#1-pg is just the
9713 % page number, and we want to fully expand that so we can get a link
9715 \toksA = \expandafter{\csname XR#1-lof\endcsname}%
9717 % use the same \entry macro we use to generate the TOC and index.
9718 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
9723 \message{localization,}
9725 % For single-language documents, @documentlanguage is usually given very
9726 % early, just after @documentencoding. Single argument is the language
9727 % (de) or locale (de_DE) abbreviation.
9730 \catcode`\_ = \active
9732 \parseargdef\documentlanguage{%
9733 \tex % read txi-??.tex file in plain TeX.
9734 % Read the file by the name they passed if it exists.
9735 \let_ = \normalunderscore % normal _ character for filename test
9736 \openin 1 txi-#1.tex
9738 \documentlanguagetrywithoutunderscore #1_\finish
9740 \globaldefs = 1 % everything in the txi-LL files needs to persist
9744 \endgroup % end raw TeX
9747 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
9750 \gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
9751 \openin 1 txi-#1.tex
9753 \errhelp = \nolanghelp
9754 \errmessage{Cannot read language file txi-#1.tex}%
9756 \globaldefs = 1 % everything in the txi-LL files needs to persist
9761 }% end of special _ catcode
9763 \newhelp\nolanghelp{The given language definition file cannot be found or
9764 is empty. Maybe you need to install it? Putting it in the current
9765 directory should work if nowhere else does.}
9767 % This macro is called from txi-??.tex files; the first argument is the
9768 % \language name to set (without the "\lang@" prefix), the second and
9769 % third args are \{left,right}hyphenmin.
9771 % The language names to pass are determined when the format is built.
9772 % See the etex.log file created at that time, e.g.,
9773 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
9775 % With TeX Live 2008, etex now includes hyphenation patterns for all
9776 % available languages. This means we can support hyphenation in
9777 % Texinfo, at least to some extent. (This still doesn't solve the
9778 % accented characters problem.)
9781 \def\txisetlanguage#1#2#3{%
9782 % do not set the language if the name is undefined in the current TeX.
9783 \expandafter\ifx\csname lang@#1\endcsname \relax
9784 \message{no patterns for #1}%
9786 \global\language = \csname lang@#1\endcsname
9788 % but there is no harm in adjusting the hyphenmin values regardless.
9789 \global\lefthyphenmin = #2\relax
9790 \global\righthyphenmin = #3\relax
9793 % XeTeX and LuaTeX can handle Unicode natively.
9794 % Their default I/O uses UTF-8 sequences instead of a byte-wise operation.
9795 % Other TeX engines' I/O (pdfTeX, etc.) is byte-wise.
9797 \newif\iftxinativeunicodecapable
9798 \newif\iftxiusebytewiseio
9800 \ifx\XeTeXrevision\thisisundefined
9801 \ifx\luatexversion\thisisundefined
9802 \txinativeunicodecapablefalse
9803 \txiusebytewiseiotrue
9805 \txinativeunicodecapabletrue
9806 \txiusebytewiseiofalse
9809 \txinativeunicodecapabletrue
9810 \txiusebytewiseiofalse
9813 % Set I/O by bytes instead of UTF-8 sequence for XeTeX and LuaTex
9814 % for non-UTF-8 (byte-wise) encodings.
9816 \def\setbytewiseio{%
9817 \ifx\XeTeXrevision\thisisundefined
9819 \XeTeXdefaultencoding "bytes" % For subsequent files to be read
9820 \XeTeXinputencoding "bytes" % For document root file
9821 % Unfortunately, there seems to be no corresponding XeTeX command for
9822 % output encoding. This is a problem for auxiliary index and TOC files.
9823 % The only solution would be perhaps to write out @U{...} sequences in
9824 % place of non-ASCII characters.
9827 \ifx\luatexversion\thisisundefined
9830 local utf8_char, byte, gsub = unicode.utf8.char, string.byte, string.gsub
9831 local function convert_char (char)
9832 return utf8_char(byte(char))
9835 local function convert_line (line)
9836 return gsub(line, ".", convert_char)
9839 callback.register("process_input_buffer", convert_line)
9841 local function convert_line_out (line)
9843 for c in string.utfvalues(line) do
9844 line_out = line_out .. string.char(c)
9849 callback.register("process_output_buffer", convert_line_out)
9853 \txiusebytewiseiotrue
9857 % Helpers for encodings.
9858 % Set the catcode of characters 128 through 255 to the specified number.
9860 \def\setnonasciicharscatcode#1{%
9862 \loop\ifnum\count255<256
9863 \global\catcode\count255=#1\relax
9864 \advance\count255 by 1
9868 \def\setnonasciicharscatcodenonglobal#1{%
9870 \loop\ifnum\count255<256
9871 \catcode\count255=#1\relax
9872 \advance\count255 by 1
9876 % @documentencoding sets the definition of non-ASCII characters
9877 % according to the specified encoding.
9879 \def\documentencoding{\parseargusing\filenamecatcodes\documentencodingzzz}
9880 \def\documentencodingzzz#1{%
9882 % Encoding being declared for the document.
9883 \def\declaredencoding{\csname #1.enc\endcsname}%
9885 % Supported encodings: names converted to tokens in order to be able
9886 % to compare them with \ifx.
9887 \def\ascii{\csname US-ASCII.enc\endcsname}%
9888 \def\latnine{\csname ISO-8859-15.enc\endcsname}%
9889 \def\latone{\csname ISO-8859-1.enc\endcsname}%
9890 \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
9891 \def\utfeight{\csname UTF-8.enc\endcsname}%
9893 \ifx \declaredencoding \ascii
9896 \else \ifx \declaredencoding \lattwo
9897 \iftxinativeunicodecapable
9900 \setnonasciicharscatcode\active
9903 \else \ifx \declaredencoding \latone
9904 \iftxinativeunicodecapable
9907 \setnonasciicharscatcode\active
9910 \else \ifx \declaredencoding \latnine
9911 \iftxinativeunicodecapable
9914 \setnonasciicharscatcode\active
9917 \else \ifx \declaredencoding \utfeight
9918 \iftxinativeunicodecapable
9919 % For native Unicode handling (XeTeX and LuaTeX)
9920 \nativeunicodechardefs
9922 % For treating UTF-8 as byte sequences (TeX, eTeX and pdfTeX)
9923 \setnonasciicharscatcode\active
9924 % since we already invoked \utfeightchardefs at the top level
9925 % (below), do not re-invoke it, otherwise our check for duplicated
9926 % definitions gets triggered. Making non-ascii chars active is
9931 \message{Ignoring unknown document encoding: #1.}%
9939 \ifx\XeTeXrevision\thisisundefined
9941 \ifx \declaredencoding \utfeight
9943 \ifx \declaredencoding \ascii
9945 \message{Warning: XeTeX with non-UTF-8 encodings cannot handle %
9946 non-ASCII characters in auxiliary files.}%
9953 % A message to be logged when using a character that isn't available
9954 % the default font encoding (OT1).
9956 \def\missingcharmsg#1{\message{Character missing, sorry: #1.}}
9958 % Take account of \c (plain) vs. \, (Texinfo) difference.
9959 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
9961 % First, make active non-ASCII characters in order for them to be
9962 % correctly categorized when TeX reads the replacement text of
9963 % macros containing the character definitions.
9964 \setnonasciicharscatcode\active
9976 % Latin1 (ISO-8859-1) character definitions.
9977 \def\latonechardefs{%
9979 \gdefchar^^a1{\exclamdown}
9980 \gdefchar^^a2{{\tcfont \char162}} % cent
9981 \gdefchar^^a3{\pounds{}}
9982 \gdefchar^^a4{{\tcfont \char164}} % currency
9983 \gdefchar^^a5{{\tcfont \char165}} % yen
9984 \gdefchar^^a6{{\tcfont \char166}} % broken bar
9987 \gdefchar^^a9{\copyright{}}
9988 \gdefchar^^aa{\ordf}
9989 \gdefchar^^ab{\guillemetleft{}}
9990 \gdefchar^^ac{\ensuremath\lnot}
9992 \gdefchar^^ae{\registeredsymbol{}}
9995 \gdefchar^^b0{\textdegree}
9996 \gdefchar^^b1{$\pm$}
10000 \gdefchar^^b5{$\mu$}
10002 \gdefchar^^b7{\ensuremath\cdot}
10003 \gdefchar^^b8{\cedilla\ }
10004 \gdefchar^^b9{$^1$}
10005 \gdefchar^^ba{\ordm}
10006 \gdefchar^^bb{\guillemetright{}}
10007 \gdefchar^^bc{$1\over4$}
10008 \gdefchar^^bd{$1\over2$}
10009 \gdefchar^^be{$3\over4$}
10010 \gdefchar^^bf{\questiondown}
10017 \gdefchar^^c5{\ringaccent A}
10019 \gdefchar^^c7{\cedilla C}
10036 \gdefchar^^d7{$\times$}
10051 \gdefchar^^e5{\ringaccent a}
10053 \gdefchar^^e7{\cedilla c}
10058 \gdefchar^^ec{\`{\dotless i}}
10059 \gdefchar^^ed{\'{\dotless i}}
10060 \gdefchar^^ee{\^{\dotless i}}
10061 \gdefchar^^ef{\"{\dotless i}}
10070 \gdefchar^^f7{$\div$}
10081 % Latin9 (ISO-8859-15) encoding character definitions.
10082 \def\latninechardefs{%
10083 % Encoding is almost identical to Latin1.
10086 \gdefchar^^a4{\euro{}}
10087 \gdefchar^^a6{\v S}
10088 \gdefchar^^a8{\v s}
10089 \gdefchar^^b4{\v Z}
10090 \gdefchar^^b8{\v z}
10096 % Latin2 (ISO-8859-2) character definitions.
10097 \def\lattwochardefs{%
10098 \gdefchar^^a0{\tie}
10099 \gdefchar^^a1{\ogonek{A}}
10100 \gdefchar^^a2{\u{}}
10102 \gdefchar^^a4{\missingcharmsg{CURRENCY SIGN}}
10103 \gdefchar^^a5{\v L}
10106 \gdefchar^^a8{\"{}}
10107 \gdefchar^^a9{\v S}
10108 \gdefchar^^aa{\cedilla S}
10109 \gdefchar^^ab{\v T}
10112 \gdefchar^^ae{\v Z}
10113 \gdefchar^^af{\dotaccent Z}
10115 \gdefchar^^b0{\textdegree{}}
10116 \gdefchar^^b1{\ogonek{a}}
10117 \gdefchar^^b2{\ogonek{ }}
10119 \gdefchar^^b4{\'{}}
10120 \gdefchar^^b5{\v l}
10122 \gdefchar^^b7{\v{}}
10123 \gdefchar^^b8{\cedilla\ }
10124 \gdefchar^^b9{\v s}
10125 \gdefchar^^ba{\cedilla s}
10126 \gdefchar^^bb{\v t}
10128 \gdefchar^^bd{\H{}}
10129 \gdefchar^^be{\v z}
10130 \gdefchar^^bf{\dotaccent z}
10135 \gdefchar^^c3{\u A}
10139 \gdefchar^^c7{\cedilla C}
10140 \gdefchar^^c8{\v C}
10142 \gdefchar^^ca{\ogonek{E}}
10144 \gdefchar^^cc{\v E}
10147 \gdefchar^^cf{\v D}
10151 \gdefchar^^d2{\v N}
10154 \gdefchar^^d5{\H O}
10156 \gdefchar^^d7{$\times$}
10157 \gdefchar^^d8{\v R}
10158 \gdefchar^^d9{\ringaccent U}
10160 \gdefchar^^db{\H U}
10163 \gdefchar^^de{\cedilla T}
10169 \gdefchar^^e3{\u a}
10173 \gdefchar^^e7{\cedilla c}
10174 \gdefchar^^e8{\v c}
10176 \gdefchar^^ea{\ogonek{e}}
10178 \gdefchar^^ec{\v e}
10179 \gdefchar^^ed{\'{\dotless{i}}}
10180 \gdefchar^^ee{\^{\dotless{i}}}
10181 \gdefchar^^ef{\v d}
10185 \gdefchar^^f2{\v n}
10188 \gdefchar^^f5{\H o}
10190 \gdefchar^^f7{$\div$}
10191 \gdefchar^^f8{\v r}
10192 \gdefchar^^f9{\ringaccent u}
10194 \gdefchar^^fb{\H u}
10197 \gdefchar^^fe{\cedilla t}
10198 \gdefchar^^ff{\dotaccent{}}
10201 % UTF-8 character definitions.
10203 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
10204 % changes for Texinfo conventions. It is included here under the GPL by
10205 % permission from Frank Mittelbach and the LaTeX team.
10207 \newcount\countUTFx
10208 \newcount\countUTFy
10209 \newcount\countUTFz
10211 \gdef\UTFviiiTwoOctets#1#2{\expandafter
10212 \UTFviiiDefined\csname u8:#1\string #2\endcsname}
10214 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
10215 \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
10217 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
10218 \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
10220 \gdef\UTFviiiDefined#1{%
10222 \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
10228 % Give non-ASCII bytes the active definitions for processing UTF-8 sequences
10234 % Loop from \countUTFx to \countUTFy, performing \UTFviiiTmp
10235 % substituting ~ and $ with a character token of that value.
10237 \global\catcode\countUTFx\active
10238 \uccode`\~\countUTFx
10239 \uccode`\$\countUTFx
10240 \uppercase\expandafter{\UTFviiiTmp}%
10241 \advance\countUTFx by 1
10242 \ifnum\countUTFx < \countUTFy
10243 \expandafter\UTFviiiLoop
10246 % For bytes other than the first in a UTF-8 sequence. Not expected to
10247 % be expanded except when writing to auxiliary files.
10252 \ifpassthroughchars $\fi}}%
10259 \ifpassthroughchars $%
10260 \else\expandafter\UTFviiiTwoOctets\expandafter$\fi}}%
10267 \ifpassthroughchars $%
10268 \else\expandafter\UTFviiiThreeOctets\expandafter$\fi}}%
10275 \ifpassthroughchars $%
10276 \else\expandafter\UTFviiiFourOctets\expandafter$\fi
10281 \def\globallet{\global\let} % save some \expandafter's below
10283 % @U{xxxx} to produce U+xxxx, if we support it.
10285 \expandafter\ifx\csname uni:#1\endcsname \relax
10286 \iftxinativeunicodecapable
10287 % All Unicode characters can be used if native Unicode handling is
10288 % active. However, if the font does not have the glyph,
10289 % letters are missing.
10291 \uccode`\.="#1\relax
10295 \errhelp = \EMsimple
10296 \errmessage{Unicode character U+#1 not supported, sorry}%
10299 \csname uni:#1\endcsname
10303 % These macros are used here to construct the name of a control
10304 % sequence to be defined.
10305 \def\UTFviiiTwoOctetsName#1#2{%
10306 \csname u8:#1\string #2\endcsname}%
10307 \def\UTFviiiThreeOctetsName#1#2#3{%
10308 \csname u8:#1\string #2\string #3\endcsname}%
10309 \def\UTFviiiFourOctetsName#1#2#3#4{%
10310 \csname u8:#1\string #2\string #3\string #4\endcsname}%
10312 % For UTF-8 byte sequences (TeX, e-TeX and pdfTeX),
10313 % provide a definition macro to replace a Unicode character;
10314 % this gets used by the @U command
10324 \gdef\DeclareUnicodeCharacterUTFviii#1#2{%
10325 \countUTFz = "#1\relax
10329 % Give \u8:... its definition. The sequence of seven \expandafter's
10330 % expands after the \gdef three times, e.g.
10332 % 1. \UTFviiTwoOctetsName B1 B2
10333 % 2. \csname u8:B1 \string B2 \endcsname
10334 % 3. \u8: B1 B2 (a single control sequence token)
10336 \expandafter\expandafter
10337 \expandafter\expandafter
10338 \expandafter\expandafter
10339 \expandafter\gdef \UTFviiiTmp{#2}%
10341 \expandafter\ifx\csname uni:#1\endcsname \relax \else
10342 \message{Internal error, already defined: #1}%
10345 % define an additional control sequence for this code point.
10346 \expandafter\globallet\csname uni:#1\endcsname \UTFviiiTmp
10349 % Given the value in \countUTFz as a Unicode code point, set \UTFviiiTmp
10350 % to the corresponding UTF-8 sequence.
10351 \gdef\parseXMLCharref{%
10352 \ifnum\countUTFz < "A0\relax
10353 \errhelp = \EMsimple
10354 \errmessage{Cannot define Unicode char value < 00A0}%
10355 \else\ifnum\countUTFz < "800\relax
10357 \parseUTFviiiB C\UTFviiiTwoOctetsName.,%
10358 \else\ifnum\countUTFz < "10000\relax
10361 \parseUTFviiiB E\UTFviiiThreeOctetsName.{,;}%
10366 \parseUTFviiiB F\UTFviiiFourOctetsName.{!,;}%
10370 % Extract a byte from the end of the UTF-8 representation of \countUTFx.
10371 % It must be a non-initial byte in the sequence.
10372 % Change \uccode of #1 for it to be used in \parseUTFviiiB as one
10374 \gdef\parseUTFviiiA#1{%
10375 \countUTFx = \countUTFz
10376 \divide\countUTFz by 64
10377 \countUTFy = \countUTFz % Save to be the future value of \countUTFz.
10378 \multiply\countUTFz by 64
10380 % \countUTFz is now \countUTFx with the last 5 bits cleared. Subtract
10381 % in order to get the last five bits.
10382 \advance\countUTFx by -\countUTFz
10384 % Convert this to the byte in the UTF-8 sequence.
10385 \advance\countUTFx by 128
10386 \uccode `#1\countUTFx
10387 \countUTFz = \countUTFy}
10389 % Used to put a UTF-8 byte sequence into \UTFviiiTmp
10390 % #1 is the increment for \countUTFz to yield a the first byte of the UTF-8
10392 % #2 is one of the \UTFviii*OctetsName macros.
10393 % #3 is always a full stop (.)
10394 % #4 is a template for the other bytes in the sequence. The values for these
10395 % bytes is substituted in here with \uppercase using the \uccode's.
10396 \gdef\parseUTFviiiB#1#2#3#4{%
10397 \advance\countUTFz by "#10\relax
10398 \uccode `#3\countUTFz
10399 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
10402 % For native Unicode handling (XeTeX and LuaTeX),
10403 % provide a definition macro that sets a catcode to `other' non-globally
10405 \def\DeclareUnicodeCharacterNativeOther#1#2{%
10409 % https://en.wikipedia.org/wiki/Plane_(Unicode)#Basic_M
10410 % U+0000..U+007F = https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)
10411 % U+0080..U+00FF = https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)
10412 % U+0100..U+017F = https://en.wikipedia.org/wiki/Latin_Extended-A
10413 % U+0180..U+024F = https://en.wikipedia.org/wiki/Latin_Extended-B
10415 % Many of our renditions are less than wonderful, and all the missing
10416 % characters are available somewhere. Loading the necessary fonts
10417 % awaits user request. We can't truly support Unicode without
10418 % reimplementing everything that's been done in LaTeX for many years,
10419 % plus probably using luatex or xetex, and who knows what else.
10420 % We won't be doing that here in this simple file. But we can try to at
10421 % least make most of the characters not bomb out.
10423 \def\unicodechardefs{%
10424 \DeclareUnicodeCharacter{00A0}{\tie}%
10425 \DeclareUnicodeCharacter{00A1}{\exclamdown}%
10426 \DeclareUnicodeCharacter{00A2}{{\tcfont \char162}}% 0242=cent
10427 \DeclareUnicodeCharacter{00A3}{\pounds{}}%
10428 \DeclareUnicodeCharacter{00A4}{{\tcfont \char164}}% 0244=currency
10429 \DeclareUnicodeCharacter{00A5}{{\tcfont \char165}}% 0245=yen
10430 \DeclareUnicodeCharacter{00A6}{{\tcfont \char166}}% 0246=brokenbar
10431 \DeclareUnicodeCharacter{00A7}{\S}%
10432 \DeclareUnicodeCharacter{00A8}{\"{ }}%
10433 \DeclareUnicodeCharacter{00A9}{\copyright{}}%
10434 \DeclareUnicodeCharacter{00AA}{\ordf}%
10435 \DeclareUnicodeCharacter{00AB}{\guillemetleft{}}%
10436 \DeclareUnicodeCharacter{00AC}{\ensuremath\lnot}%
10437 \DeclareUnicodeCharacter{00AD}{\-}%
10438 \DeclareUnicodeCharacter{00AE}{\registeredsymbol{}}%
10439 \DeclareUnicodeCharacter{00AF}{\={ }}%
10441 \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}%
10442 \DeclareUnicodeCharacter{00B1}{\ensuremath\pm}%
10443 \DeclareUnicodeCharacter{00B2}{$^2$}%
10444 \DeclareUnicodeCharacter{00B3}{$^3$}%
10445 \DeclareUnicodeCharacter{00B4}{\'{ }}%
10446 \DeclareUnicodeCharacter{00B5}{$\mu$}%
10447 \DeclareUnicodeCharacter{00B6}{\P}%
10448 \DeclareUnicodeCharacter{00B7}{\ensuremath\cdot}%
10449 \DeclareUnicodeCharacter{00B8}{\cedilla{ }}%
10450 \DeclareUnicodeCharacter{00B9}{$^1$}%
10451 \DeclareUnicodeCharacter{00BA}{\ordm}%
10452 \DeclareUnicodeCharacter{00BB}{\guillemetright{}}%
10453 \DeclareUnicodeCharacter{00BC}{$1\over4$}%
10454 \DeclareUnicodeCharacter{00BD}{$1\over2$}%
10455 \DeclareUnicodeCharacter{00BE}{$3\over4$}%
10456 \DeclareUnicodeCharacter{00BF}{\questiondown}%
10458 \DeclareUnicodeCharacter{00C0}{\`A}%
10459 \DeclareUnicodeCharacter{00C1}{\'A}%
10460 \DeclareUnicodeCharacter{00C2}{\^A}%
10461 \DeclareUnicodeCharacter{00C3}{\~A}%
10462 \DeclareUnicodeCharacter{00C4}{\"A}%
10463 \DeclareUnicodeCharacter{00C5}{\AA}%
10464 \DeclareUnicodeCharacter{00C6}{\AE}%
10465 \DeclareUnicodeCharacter{00C7}{\cedilla{C}}%
10466 \DeclareUnicodeCharacter{00C8}{\`E}%
10467 \DeclareUnicodeCharacter{00C9}{\'E}%
10468 \DeclareUnicodeCharacter{00CA}{\^E}%
10469 \DeclareUnicodeCharacter{00CB}{\"E}%
10470 \DeclareUnicodeCharacter{00CC}{\`I}%
10471 \DeclareUnicodeCharacter{00CD}{\'I}%
10472 \DeclareUnicodeCharacter{00CE}{\^I}%
10473 \DeclareUnicodeCharacter{00CF}{\"I}%
10475 \DeclareUnicodeCharacter{00D0}{\DH}%
10476 \DeclareUnicodeCharacter{00D1}{\~N}%
10477 \DeclareUnicodeCharacter{00D2}{\`O}%
10478 \DeclareUnicodeCharacter{00D3}{\'O}%
10479 \DeclareUnicodeCharacter{00D4}{\^O}%
10480 \DeclareUnicodeCharacter{00D5}{\~O}%
10481 \DeclareUnicodeCharacter{00D6}{\"O}%
10482 \DeclareUnicodeCharacter{00D7}{\ensuremath\times}%
10483 \DeclareUnicodeCharacter{00D8}{\O}%
10484 \DeclareUnicodeCharacter{00D9}{\`U}%
10485 \DeclareUnicodeCharacter{00DA}{\'U}%
10486 \DeclareUnicodeCharacter{00DB}{\^U}%
10487 \DeclareUnicodeCharacter{00DC}{\"U}%
10488 \DeclareUnicodeCharacter{00DD}{\'Y}%
10489 \DeclareUnicodeCharacter{00DE}{\TH}%
10490 \DeclareUnicodeCharacter{00DF}{\ss}%
10492 \DeclareUnicodeCharacter{00E0}{\`a}%
10493 \DeclareUnicodeCharacter{00E1}{\'a}%
10494 \DeclareUnicodeCharacter{00E2}{\^a}%
10495 \DeclareUnicodeCharacter{00E3}{\~a}%
10496 \DeclareUnicodeCharacter{00E4}{\"a}%
10497 \DeclareUnicodeCharacter{00E5}{\aa}%
10498 \DeclareUnicodeCharacter{00E6}{\ae}%
10499 \DeclareUnicodeCharacter{00E7}{\cedilla{c}}%
10500 \DeclareUnicodeCharacter{00E8}{\`e}%
10501 \DeclareUnicodeCharacter{00E9}{\'e}%
10502 \DeclareUnicodeCharacter{00EA}{\^e}%
10503 \DeclareUnicodeCharacter{00EB}{\"e}%
10504 \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}%
10505 \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}%
10506 \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}%
10507 \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}%
10509 \DeclareUnicodeCharacter{00F0}{\dh}%
10510 \DeclareUnicodeCharacter{00F1}{\~n}%
10511 \DeclareUnicodeCharacter{00F2}{\`o}%
10512 \DeclareUnicodeCharacter{00F3}{\'o}%
10513 \DeclareUnicodeCharacter{00F4}{\^o}%
10514 \DeclareUnicodeCharacter{00F5}{\~o}%
10515 \DeclareUnicodeCharacter{00F6}{\"o}%
10516 \DeclareUnicodeCharacter{00F7}{\ensuremath\div}%
10517 \DeclareUnicodeCharacter{00F8}{\o}%
10518 \DeclareUnicodeCharacter{00F9}{\`u}%
10519 \DeclareUnicodeCharacter{00FA}{\'u}%
10520 \DeclareUnicodeCharacter{00FB}{\^u}%
10521 \DeclareUnicodeCharacter{00FC}{\"u}%
10522 \DeclareUnicodeCharacter{00FD}{\'y}%
10523 \DeclareUnicodeCharacter{00FE}{\th}%
10524 \DeclareUnicodeCharacter{00FF}{\"y}%
10526 \DeclareUnicodeCharacter{0100}{\=A}%
10527 \DeclareUnicodeCharacter{0101}{\=a}%
10528 \DeclareUnicodeCharacter{0102}{\u{A}}%
10529 \DeclareUnicodeCharacter{0103}{\u{a}}%
10530 \DeclareUnicodeCharacter{0104}{\ogonek{A}}%
10531 \DeclareUnicodeCharacter{0105}{\ogonek{a}}%
10532 \DeclareUnicodeCharacter{0106}{\'C}%
10533 \DeclareUnicodeCharacter{0107}{\'c}%
10534 \DeclareUnicodeCharacter{0108}{\^C}%
10535 \DeclareUnicodeCharacter{0109}{\^c}%
10536 \DeclareUnicodeCharacter{010A}{\dotaccent{C}}%
10537 \DeclareUnicodeCharacter{010B}{\dotaccent{c}}%
10538 \DeclareUnicodeCharacter{010C}{\v{C}}%
10539 \DeclareUnicodeCharacter{010D}{\v{c}}%
10540 \DeclareUnicodeCharacter{010E}{\v{D}}%
10541 \DeclareUnicodeCharacter{010F}{d'}%
10543 \DeclareUnicodeCharacter{0110}{\DH}%
10544 \DeclareUnicodeCharacter{0111}{\dh}%
10545 \DeclareUnicodeCharacter{0112}{\=E}%
10546 \DeclareUnicodeCharacter{0113}{\=e}%
10547 \DeclareUnicodeCharacter{0114}{\u{E}}%
10548 \DeclareUnicodeCharacter{0115}{\u{e}}%
10549 \DeclareUnicodeCharacter{0116}{\dotaccent{E}}%
10550 \DeclareUnicodeCharacter{0117}{\dotaccent{e}}%
10551 \DeclareUnicodeCharacter{0118}{\ogonek{E}}%
10552 \DeclareUnicodeCharacter{0119}{\ogonek{e}}%
10553 \DeclareUnicodeCharacter{011A}{\v{E}}%
10554 \DeclareUnicodeCharacter{011B}{\v{e}}%
10555 \DeclareUnicodeCharacter{011C}{\^G}%
10556 \DeclareUnicodeCharacter{011D}{\^g}%
10557 \DeclareUnicodeCharacter{011E}{\u{G}}%
10558 \DeclareUnicodeCharacter{011F}{\u{g}}%
10560 \DeclareUnicodeCharacter{0120}{\dotaccent{G}}%
10561 \DeclareUnicodeCharacter{0121}{\dotaccent{g}}%
10562 \DeclareUnicodeCharacter{0122}{\cedilla{G}}%
10563 \DeclareUnicodeCharacter{0123}{\cedilla{g}}%
10564 \DeclareUnicodeCharacter{0124}{\^H}%
10565 \DeclareUnicodeCharacter{0125}{\^h}%
10566 \DeclareUnicodeCharacter{0126}{\missingcharmsg{H WITH STROKE}}%
10567 \DeclareUnicodeCharacter{0127}{\missingcharmsg{h WITH STROKE}}%
10568 \DeclareUnicodeCharacter{0128}{\~I}%
10569 \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}%
10570 \DeclareUnicodeCharacter{012A}{\=I}%
10571 \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}%
10572 \DeclareUnicodeCharacter{012C}{\u{I}}%
10573 \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}%
10574 \DeclareUnicodeCharacter{012E}{\ogonek{I}}%
10575 \DeclareUnicodeCharacter{012F}{\ogonek{i}}%
10577 \DeclareUnicodeCharacter{0130}{\dotaccent{I}}%
10578 \DeclareUnicodeCharacter{0131}{\dotless{i}}%
10579 \DeclareUnicodeCharacter{0132}{IJ}%
10580 \DeclareUnicodeCharacter{0133}{ij}%
10581 \DeclareUnicodeCharacter{0134}{\^J}%
10582 \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}%
10583 \DeclareUnicodeCharacter{0136}{\cedilla{K}}%
10584 \DeclareUnicodeCharacter{0137}{\cedilla{k}}%
10585 \DeclareUnicodeCharacter{0138}{\ensuremath\kappa}%
10586 \DeclareUnicodeCharacter{0139}{\'L}%
10587 \DeclareUnicodeCharacter{013A}{\'l}%
10588 \DeclareUnicodeCharacter{013B}{\cedilla{L}}%
10589 \DeclareUnicodeCharacter{013C}{\cedilla{l}}%
10590 \DeclareUnicodeCharacter{013D}{L'}% should kern
10591 \DeclareUnicodeCharacter{013E}{l'}% should kern
10592 \DeclareUnicodeCharacter{013F}{L\U{00B7}}%
10594 \DeclareUnicodeCharacter{0140}{l\U{00B7}}%
10595 \DeclareUnicodeCharacter{0141}{\L}%
10596 \DeclareUnicodeCharacter{0142}{\l}%
10597 \DeclareUnicodeCharacter{0143}{\'N}%
10598 \DeclareUnicodeCharacter{0144}{\'n}%
10599 \DeclareUnicodeCharacter{0145}{\cedilla{N}}%
10600 \DeclareUnicodeCharacter{0146}{\cedilla{n}}%
10601 \DeclareUnicodeCharacter{0147}{\v{N}}%
10602 \DeclareUnicodeCharacter{0148}{\v{n}}%
10603 \DeclareUnicodeCharacter{0149}{'n}%
10604 \DeclareUnicodeCharacter{014A}{\missingcharmsg{ENG}}%
10605 \DeclareUnicodeCharacter{014B}{\missingcharmsg{eng}}%
10606 \DeclareUnicodeCharacter{014C}{\=O}%
10607 \DeclareUnicodeCharacter{014D}{\=o}%
10608 \DeclareUnicodeCharacter{014E}{\u{O}}%
10609 \DeclareUnicodeCharacter{014F}{\u{o}}%
10611 \DeclareUnicodeCharacter{0150}{\H{O}}%
10612 \DeclareUnicodeCharacter{0151}{\H{o}}%
10613 \DeclareUnicodeCharacter{0152}{\OE}%
10614 \DeclareUnicodeCharacter{0153}{\oe}%
10615 \DeclareUnicodeCharacter{0154}{\'R}%
10616 \DeclareUnicodeCharacter{0155}{\'r}%
10617 \DeclareUnicodeCharacter{0156}{\cedilla{R}}%
10618 \DeclareUnicodeCharacter{0157}{\cedilla{r}}%
10619 \DeclareUnicodeCharacter{0158}{\v{R}}%
10620 \DeclareUnicodeCharacter{0159}{\v{r}}%
10621 \DeclareUnicodeCharacter{015A}{\'S}%
10622 \DeclareUnicodeCharacter{015B}{\'s}%
10623 \DeclareUnicodeCharacter{015C}{\^S}%
10624 \DeclareUnicodeCharacter{015D}{\^s}%
10625 \DeclareUnicodeCharacter{015E}{\cedilla{S}}%
10626 \DeclareUnicodeCharacter{015F}{\cedilla{s}}%
10628 \DeclareUnicodeCharacter{0160}{\v{S}}%
10629 \DeclareUnicodeCharacter{0161}{\v{s}}%
10630 \DeclareUnicodeCharacter{0162}{\cedilla{T}}%
10631 \DeclareUnicodeCharacter{0163}{\cedilla{t}}%
10632 \DeclareUnicodeCharacter{0164}{\v{T}}%
10633 \DeclareUnicodeCharacter{0165}{\v{t}}%
10634 \DeclareUnicodeCharacter{0166}{\missingcharmsg{H WITH STROKE}}%
10635 \DeclareUnicodeCharacter{0167}{\missingcharmsg{h WITH STROKE}}%
10636 \DeclareUnicodeCharacter{0168}{\~U}%
10637 \DeclareUnicodeCharacter{0169}{\~u}%
10638 \DeclareUnicodeCharacter{016A}{\=U}%
10639 \DeclareUnicodeCharacter{016B}{\=u}%
10640 \DeclareUnicodeCharacter{016C}{\u{U}}%
10641 \DeclareUnicodeCharacter{016D}{\u{u}}%
10642 \DeclareUnicodeCharacter{016E}{\ringaccent{U}}%
10643 \DeclareUnicodeCharacter{016F}{\ringaccent{u}}%
10645 \DeclareUnicodeCharacter{0170}{\H{U}}%
10646 \DeclareUnicodeCharacter{0171}{\H{u}}%
10647 \DeclareUnicodeCharacter{0172}{\ogonek{U}}%
10648 \DeclareUnicodeCharacter{0173}{\ogonek{u}}%
10649 \DeclareUnicodeCharacter{0174}{\^W}%
10650 \DeclareUnicodeCharacter{0175}{\^w}%
10651 \DeclareUnicodeCharacter{0176}{\^Y}%
10652 \DeclareUnicodeCharacter{0177}{\^y}%
10653 \DeclareUnicodeCharacter{0178}{\"Y}%
10654 \DeclareUnicodeCharacter{0179}{\'Z}%
10655 \DeclareUnicodeCharacter{017A}{\'z}%
10656 \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}%
10657 \DeclareUnicodeCharacter{017C}{\dotaccent{z}}%
10658 \DeclareUnicodeCharacter{017D}{\v{Z}}%
10659 \DeclareUnicodeCharacter{017E}{\v{z}}%
10660 \DeclareUnicodeCharacter{017F}{\missingcharmsg{LONG S}}%
10662 \DeclareUnicodeCharacter{01C4}{D\v{Z}}%
10663 \DeclareUnicodeCharacter{01C5}{D\v{z}}%
10664 \DeclareUnicodeCharacter{01C6}{d\v{z}}%
10665 \DeclareUnicodeCharacter{01C7}{LJ}%
10666 \DeclareUnicodeCharacter{01C8}{Lj}%
10667 \DeclareUnicodeCharacter{01C9}{lj}%
10668 \DeclareUnicodeCharacter{01CA}{NJ}%
10669 \DeclareUnicodeCharacter{01CB}{Nj}%
10670 \DeclareUnicodeCharacter{01CC}{nj}%
10671 \DeclareUnicodeCharacter{01CD}{\v{A}}%
10672 \DeclareUnicodeCharacter{01CE}{\v{a}}%
10673 \DeclareUnicodeCharacter{01CF}{\v{I}}%
10675 \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}%
10676 \DeclareUnicodeCharacter{01D1}{\v{O}}%
10677 \DeclareUnicodeCharacter{01D2}{\v{o}}%
10678 \DeclareUnicodeCharacter{01D3}{\v{U}}%
10679 \DeclareUnicodeCharacter{01D4}{\v{u}}%
10681 \DeclareUnicodeCharacter{01E2}{\={\AE}}%
10682 \DeclareUnicodeCharacter{01E3}{\={\ae}}%
10683 \DeclareUnicodeCharacter{01E6}{\v{G}}%
10684 \DeclareUnicodeCharacter{01E7}{\v{g}}%
10685 \DeclareUnicodeCharacter{01E8}{\v{K}}%
10686 \DeclareUnicodeCharacter{01E9}{\v{k}}%
10688 \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}%
10689 \DeclareUnicodeCharacter{01F1}{DZ}%
10690 \DeclareUnicodeCharacter{01F2}{Dz}%
10691 \DeclareUnicodeCharacter{01F3}{dz}%
10692 \DeclareUnicodeCharacter{01F4}{\'G}%
10693 \DeclareUnicodeCharacter{01F5}{\'g}%
10694 \DeclareUnicodeCharacter{01F8}{\`N}%
10695 \DeclareUnicodeCharacter{01F9}{\`n}%
10696 \DeclareUnicodeCharacter{01FC}{\'{\AE}}%
10697 \DeclareUnicodeCharacter{01FD}{\'{\ae}}%
10698 \DeclareUnicodeCharacter{01FE}{\'{\O}}%
10699 \DeclareUnicodeCharacter{01FF}{\'{\o}}%
10701 \DeclareUnicodeCharacter{021E}{\v{H}}%
10702 \DeclareUnicodeCharacter{021F}{\v{h}}%
10704 \DeclareUnicodeCharacter{0226}{\dotaccent{A}}%
10705 \DeclareUnicodeCharacter{0227}{\dotaccent{a}}%
10706 \DeclareUnicodeCharacter{0228}{\cedilla{E}}%
10707 \DeclareUnicodeCharacter{0229}{\cedilla{e}}%
10708 \DeclareUnicodeCharacter{022E}{\dotaccent{O}}%
10709 \DeclareUnicodeCharacter{022F}{\dotaccent{o}}%
10711 \DeclareUnicodeCharacter{0232}{\=Y}%
10712 \DeclareUnicodeCharacter{0233}{\=y}%
10713 \DeclareUnicodeCharacter{0237}{\dotless{j}}%
10715 \DeclareUnicodeCharacter{02DB}{\ogonek{ }}%
10717 % Greek letters upper case
10718 \DeclareUnicodeCharacter{0391}{{\it A}}%
10719 \DeclareUnicodeCharacter{0392}{{\it B}}%
10720 \DeclareUnicodeCharacter{0393}{\ensuremath{\mit\Gamma}}%
10721 \DeclareUnicodeCharacter{0394}{\ensuremath{\mit\Delta}}%
10722 \DeclareUnicodeCharacter{0395}{{\it E}}%
10723 \DeclareUnicodeCharacter{0396}{{\it Z}}%
10724 \DeclareUnicodeCharacter{0397}{{\it H}}%
10725 \DeclareUnicodeCharacter{0398}{\ensuremath{\mit\Theta}}%
10726 \DeclareUnicodeCharacter{0399}{{\it I}}%
10727 \DeclareUnicodeCharacter{039A}{{\it K}}%
10728 \DeclareUnicodeCharacter{039B}{\ensuremath{\mit\Lambda}}%
10729 \DeclareUnicodeCharacter{039C}{{\it M}}%
10730 \DeclareUnicodeCharacter{039D}{{\it N}}%
10731 \DeclareUnicodeCharacter{039E}{\ensuremath{\mit\Xi}}%
10732 \DeclareUnicodeCharacter{039F}{{\it O}}%
10733 \DeclareUnicodeCharacter{03A0}{\ensuremath{\mit\Pi}}%
10734 \DeclareUnicodeCharacter{03A1}{{\it P}}%
10735 %\DeclareUnicodeCharacter{03A2}{} % none - corresponds to final sigma
10736 \DeclareUnicodeCharacter{03A3}{\ensuremath{\mit\Sigma}}%
10737 \DeclareUnicodeCharacter{03A4}{{\it T}}%
10738 \DeclareUnicodeCharacter{03A5}{\ensuremath{\mit\Upsilon}}%
10739 \DeclareUnicodeCharacter{03A6}{\ensuremath{\mit\Phi}}%
10740 \DeclareUnicodeCharacter{03A7}{{\it X}}%
10741 \DeclareUnicodeCharacter{03A8}{\ensuremath{\mit\Psi}}%
10742 \DeclareUnicodeCharacter{03A9}{\ensuremath{\mit\Omega}}%
10744 % Vowels with accents
10745 \DeclareUnicodeCharacter{0390}{\ensuremath{\ddot{\acute\iota}}}%
10746 \DeclareUnicodeCharacter{03AC}{\ensuremath{\acute\alpha}}%
10747 \DeclareUnicodeCharacter{03AD}{\ensuremath{\acute\epsilon}}%
10748 \DeclareUnicodeCharacter{03AE}{\ensuremath{\acute\eta}}%
10749 \DeclareUnicodeCharacter{03AF}{\ensuremath{\acute\iota}}%
10750 \DeclareUnicodeCharacter{03B0}{\ensuremath{\acute{\ddot\upsilon}}}%
10752 % Standalone accent
10753 \DeclareUnicodeCharacter{0384}{\ensuremath{\acute{\ }}}%
10755 % Greek letters lower case
10756 \DeclareUnicodeCharacter{03B1}{\ensuremath\alpha}%
10757 \DeclareUnicodeCharacter{03B2}{\ensuremath\beta}%
10758 \DeclareUnicodeCharacter{03B3}{\ensuremath\gamma}%
10759 \DeclareUnicodeCharacter{03B4}{\ensuremath\delta}%
10760 \DeclareUnicodeCharacter{03B5}{\ensuremath\epsilon}%
10761 \DeclareUnicodeCharacter{03B6}{\ensuremath\zeta}%
10762 \DeclareUnicodeCharacter{03B7}{\ensuremath\eta}%
10763 \DeclareUnicodeCharacter{03B8}{\ensuremath\theta}%
10764 \DeclareUnicodeCharacter{03B9}{\ensuremath\iota}%
10765 \DeclareUnicodeCharacter{03BA}{\ensuremath\kappa}%
10766 \DeclareUnicodeCharacter{03BB}{\ensuremath\lambda}%
10767 \DeclareUnicodeCharacter{03BC}{\ensuremath\mu}%
10768 \DeclareUnicodeCharacter{03BD}{\ensuremath\nu}%
10769 \DeclareUnicodeCharacter{03BE}{\ensuremath\xi}%
10770 \DeclareUnicodeCharacter{03BF}{{\it o}}% omicron
10771 \DeclareUnicodeCharacter{03C0}{\ensuremath\pi}%
10772 \DeclareUnicodeCharacter{03C1}{\ensuremath\rho}%
10773 \DeclareUnicodeCharacter{03C2}{\ensuremath\varsigma}%
10774 \DeclareUnicodeCharacter{03C3}{\ensuremath\sigma}%
10775 \DeclareUnicodeCharacter{03C4}{\ensuremath\tau}%
10776 \DeclareUnicodeCharacter{03C5}{\ensuremath\upsilon}%
10777 \DeclareUnicodeCharacter{03C6}{\ensuremath\phi}%
10778 \DeclareUnicodeCharacter{03C7}{\ensuremath\chi}%
10779 \DeclareUnicodeCharacter{03C8}{\ensuremath\psi}%
10780 \DeclareUnicodeCharacter{03C9}{\ensuremath\omega}%
10782 % More Greek vowels with accents
10783 \DeclareUnicodeCharacter{03CA}{\ensuremath{\ddot\iota}}%
10784 \DeclareUnicodeCharacter{03CB}{\ensuremath{\ddot\upsilon}}%
10785 \DeclareUnicodeCharacter{03CC}{\ensuremath{\acute o}}%
10786 \DeclareUnicodeCharacter{03CD}{\ensuremath{\acute\upsilon}}%
10787 \DeclareUnicodeCharacter{03CE}{\ensuremath{\acute\omega}}%
10789 % Variant Greek letters
10790 \DeclareUnicodeCharacter{03D1}{\ensuremath\vartheta}%
10791 \DeclareUnicodeCharacter{03D6}{\ensuremath\varpi}%
10792 \DeclareUnicodeCharacter{03F1}{\ensuremath\varrho}%
10794 \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}%
10795 \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}%
10796 \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}%
10797 \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}%
10798 \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}%
10799 \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}%
10800 \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}%
10801 \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}%
10802 \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}%
10803 \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}%
10804 \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}%
10805 \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}%
10807 \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}%
10808 \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}%
10810 \DeclareUnicodeCharacter{1E20}{\=G}%
10811 \DeclareUnicodeCharacter{1E21}{\=g}%
10812 \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}%
10813 \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}%
10814 \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}%
10815 \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}%
10816 \DeclareUnicodeCharacter{1E26}{\"H}%
10817 \DeclareUnicodeCharacter{1E27}{\"h}%
10819 \DeclareUnicodeCharacter{1E30}{\'K}%
10820 \DeclareUnicodeCharacter{1E31}{\'k}%
10821 \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}%
10822 \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}%
10823 \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}%
10824 \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}%
10825 \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}%
10826 \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}%
10827 \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}%
10828 \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}%
10829 \DeclareUnicodeCharacter{1E3E}{\'M}%
10830 \DeclareUnicodeCharacter{1E3F}{\'m}%
10832 \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}%
10833 \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}%
10834 \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}%
10835 \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}%
10836 \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}%
10837 \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}%
10838 \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}%
10839 \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}%
10840 \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}%
10841 \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}%
10843 \DeclareUnicodeCharacter{1E54}{\'P}%
10844 \DeclareUnicodeCharacter{1E55}{\'p}%
10845 \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}%
10846 \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}%
10847 \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}%
10848 \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}%
10849 \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}%
10850 \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}%
10851 \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}%
10852 \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}%
10854 \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}%
10855 \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}%
10856 \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}%
10857 \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}%
10858 \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}%
10859 \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}%
10860 \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}%
10861 \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}%
10862 \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}%
10863 \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}%
10865 \DeclareUnicodeCharacter{1E7C}{\~V}%
10866 \DeclareUnicodeCharacter{1E7D}{\~v}%
10867 \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}%
10868 \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}%
10870 \DeclareUnicodeCharacter{1E80}{\`W}%
10871 \DeclareUnicodeCharacter{1E81}{\`w}%
10872 \DeclareUnicodeCharacter{1E82}{\'W}%
10873 \DeclareUnicodeCharacter{1E83}{\'w}%
10874 \DeclareUnicodeCharacter{1E84}{\"W}%
10875 \DeclareUnicodeCharacter{1E85}{\"w}%
10876 \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}%
10877 \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}%
10878 \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}%
10879 \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}%
10880 \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}%
10881 \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}%
10882 \DeclareUnicodeCharacter{1E8C}{\"X}%
10883 \DeclareUnicodeCharacter{1E8D}{\"x}%
10884 \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}%
10885 \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}%
10887 \DeclareUnicodeCharacter{1E90}{\^Z}%
10888 \DeclareUnicodeCharacter{1E91}{\^z}%
10889 \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}%
10890 \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}%
10891 \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}%
10892 \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}%
10893 \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}%
10894 \DeclareUnicodeCharacter{1E97}{\"t}%
10895 \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}%
10896 \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}%
10898 \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}%
10899 \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}%
10901 \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}%
10902 \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}%
10903 \DeclareUnicodeCharacter{1EBC}{\~E}%
10904 \DeclareUnicodeCharacter{1EBD}{\~e}%
10906 \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}%
10907 \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}%
10908 \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}%
10909 \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}%
10911 \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}%
10912 \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}%
10914 \DeclareUnicodeCharacter{1EF2}{\`Y}%
10915 \DeclareUnicodeCharacter{1EF3}{\`y}%
10916 \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}%
10918 \DeclareUnicodeCharacter{1EF8}{\~Y}%
10919 \DeclareUnicodeCharacter{1EF9}{\~y}%
10922 \DeclareUnicodeCharacter{2013}{--}%
10923 \DeclareUnicodeCharacter{2014}{---}%
10924 \DeclareUnicodeCharacter{2018}{\quoteleft{}}%
10925 \DeclareUnicodeCharacter{2019}{\quoteright{}}%
10926 \DeclareUnicodeCharacter{201A}{\quotesinglbase{}}%
10927 \DeclareUnicodeCharacter{201C}{\quotedblleft{}}%
10928 \DeclareUnicodeCharacter{201D}{\quotedblright{}}%
10929 \DeclareUnicodeCharacter{201E}{\quotedblbase{}}%
10930 \DeclareUnicodeCharacter{2020}{\ensuremath\dagger}%
10931 \DeclareUnicodeCharacter{2021}{\ensuremath\ddagger}%
10932 \DeclareUnicodeCharacter{2022}{\bullet{}}%
10933 \DeclareUnicodeCharacter{202F}{\thinspace}%
10934 \DeclareUnicodeCharacter{2026}{\dots{}}%
10935 \DeclareUnicodeCharacter{2039}{\guilsinglleft{}}%
10936 \DeclareUnicodeCharacter{203A}{\guilsinglright{}}%
10938 \DeclareUnicodeCharacter{20AC}{\euro{}}%
10940 \DeclareUnicodeCharacter{2192}{\expansion{}}%
10941 \DeclareUnicodeCharacter{21D2}{\result{}}%
10943 % Mathematical symbols
10944 \DeclareUnicodeCharacter{2200}{\ensuremath\forall}%
10945 \DeclareUnicodeCharacter{2203}{\ensuremath\exists}%
10946 \DeclareUnicodeCharacter{2208}{\ensuremath\in}%
10947 \DeclareUnicodeCharacter{2212}{\minus{}}%
10948 \DeclareUnicodeCharacter{2217}{\ast}%
10949 \DeclareUnicodeCharacter{221E}{\ensuremath\infty}%
10950 \DeclareUnicodeCharacter{2225}{\ensuremath\parallel}%
10951 \DeclareUnicodeCharacter{2227}{\ensuremath\wedge}%
10952 \DeclareUnicodeCharacter{2229}{\ensuremath\cap}%
10953 \DeclareUnicodeCharacter{2261}{\equiv{}}%
10954 \DeclareUnicodeCharacter{2264}{\ensuremath\leq}%
10955 \DeclareUnicodeCharacter{2265}{\ensuremath\geq}%
10956 \DeclareUnicodeCharacter{2282}{\ensuremath\subset}%
10957 \DeclareUnicodeCharacter{2287}{\ensuremath\supseteq}%
10959 \DeclareUnicodeCharacter{2016}{\ensuremath\Vert}%
10960 \DeclareUnicodeCharacter{2032}{\ensuremath\prime}%
10961 \DeclareUnicodeCharacter{210F}{\ensuremath\hbar}%
10962 \DeclareUnicodeCharacter{2111}{\ensuremath\Im}%
10963 \DeclareUnicodeCharacter{2113}{\ensuremath\ell}%
10964 \DeclareUnicodeCharacter{2118}{\ensuremath\wp}%
10965 \DeclareUnicodeCharacter{211C}{\ensuremath\Re}%
10966 \DeclareUnicodeCharacter{2135}{\ensuremath\aleph}%
10967 \DeclareUnicodeCharacter{2190}{\ensuremath\leftarrow}%
10968 \DeclareUnicodeCharacter{2191}{\ensuremath\uparrow}%
10969 \DeclareUnicodeCharacter{2193}{\ensuremath\downarrow}%
10970 \DeclareUnicodeCharacter{2194}{\ensuremath\leftrightarrow}%
10971 \DeclareUnicodeCharacter{2195}{\ensuremath\updownarrow}%
10972 \DeclareUnicodeCharacter{2196}{\ensuremath\nwarrow}%
10973 \DeclareUnicodeCharacter{2197}{\ensuremath\nearrow}%
10974 \DeclareUnicodeCharacter{2198}{\ensuremath\searrow}%
10975 \DeclareUnicodeCharacter{2199}{\ensuremath\swarrow}%
10976 \DeclareUnicodeCharacter{21A6}{\ensuremath\mapsto}%
10977 \DeclareUnicodeCharacter{21A9}{\ensuremath\hookleftarrow}%
10978 \DeclareUnicodeCharacter{21AA}{\ensuremath\hookrightarrow}%
10979 \DeclareUnicodeCharacter{21BC}{\ensuremath\leftharpoonup}%
10980 \DeclareUnicodeCharacter{21BD}{\ensuremath\leftharpoondown}%
10981 \DeclareUnicodeCharacter{21C0}{\ensuremath\rightharpoonup}%
10982 \DeclareUnicodeCharacter{21C1}{\ensuremath\rightharpoondown}%
10983 \DeclareUnicodeCharacter{21CC}{\ensuremath\rightleftharpoons}%
10984 \DeclareUnicodeCharacter{21D0}{\ensuremath\Leftarrow}%
10985 \DeclareUnicodeCharacter{21D1}{\ensuremath\Uparrow}%
10986 \DeclareUnicodeCharacter{21D3}{\ensuremath\Downarrow}%
10987 \DeclareUnicodeCharacter{21D4}{\ensuremath\Leftrightarrow}%
10988 \DeclareUnicodeCharacter{21D5}{\ensuremath\Updownarrow}%
10989 \DeclareUnicodeCharacter{2202}{\ensuremath\partial}%
10990 \DeclareUnicodeCharacter{2205}{\ensuremath\emptyset}%
10991 \DeclareUnicodeCharacter{2207}{\ensuremath\nabla}%
10992 \DeclareUnicodeCharacter{2209}{\ensuremath\notin}%
10993 \DeclareUnicodeCharacter{220B}{\ensuremath\owns}%
10994 \DeclareUnicodeCharacter{220F}{\ensuremath\prod}%
10995 \DeclareUnicodeCharacter{2210}{\ensuremath\coprod}%
10996 \DeclareUnicodeCharacter{2211}{\ensuremath\sum}%
10997 \DeclareUnicodeCharacter{2213}{\ensuremath\mp}%
10998 \DeclareUnicodeCharacter{2218}{\ensuremath\circ}%
10999 \DeclareUnicodeCharacter{221A}{\ensuremath\surd}%
11000 \DeclareUnicodeCharacter{221D}{\ensuremath\propto}%
11001 \DeclareUnicodeCharacter{2220}{\ensuremath\angle}%
11002 \DeclareUnicodeCharacter{2223}{\ensuremath\mid}%
11003 \DeclareUnicodeCharacter{2228}{\ensuremath\vee}%
11004 \DeclareUnicodeCharacter{222A}{\ensuremath\cup}%
11005 \DeclareUnicodeCharacter{222B}{\ensuremath\smallint}%
11006 \DeclareUnicodeCharacter{222E}{\ensuremath\oint}%
11007 \DeclareUnicodeCharacter{223C}{\ensuremath\sim}%
11008 \DeclareUnicodeCharacter{2240}{\ensuremath\wr}%
11009 \DeclareUnicodeCharacter{2243}{\ensuremath\simeq}%
11010 \DeclareUnicodeCharacter{2245}{\ensuremath\cong}%
11011 \DeclareUnicodeCharacter{2248}{\ensuremath\approx}%
11012 \DeclareUnicodeCharacter{224D}{\ensuremath\asymp}%
11013 \DeclareUnicodeCharacter{2250}{\ensuremath\doteq}%
11014 \DeclareUnicodeCharacter{2260}{\ensuremath\neq}%
11015 \DeclareUnicodeCharacter{226A}{\ensuremath\ll}%
11016 \DeclareUnicodeCharacter{226B}{\ensuremath\gg}%
11017 \DeclareUnicodeCharacter{227A}{\ensuremath\prec}%
11018 \DeclareUnicodeCharacter{227B}{\ensuremath\succ}%
11019 \DeclareUnicodeCharacter{2283}{\ensuremath\supset}%
11020 \DeclareUnicodeCharacter{2286}{\ensuremath\subseteq}%
11021 \DeclareUnicodeCharacter{228E}{\ensuremath\uplus}%
11022 \DeclareUnicodeCharacter{2291}{\ensuremath\sqsubseteq}%
11023 \DeclareUnicodeCharacter{2292}{\ensuremath\sqsupseteq}%
11024 \DeclareUnicodeCharacter{2293}{\ensuremath\sqcap}%
11025 \DeclareUnicodeCharacter{2294}{\ensuremath\sqcup}%
11026 \DeclareUnicodeCharacter{2295}{\ensuremath\oplus}%
11027 \DeclareUnicodeCharacter{2296}{\ensuremath\ominus}%
11028 \DeclareUnicodeCharacter{2297}{\ensuremath\otimes}%
11029 \DeclareUnicodeCharacter{2298}{\ensuremath\oslash}%
11030 \DeclareUnicodeCharacter{2299}{\ensuremath\odot}%
11031 \DeclareUnicodeCharacter{22A2}{\ensuremath\vdash}%
11032 \DeclareUnicodeCharacter{22A3}{\ensuremath\dashv}%
11033 \DeclareUnicodeCharacter{22A4}{\ensuremath\ptextop}%
11034 \DeclareUnicodeCharacter{22A5}{\ensuremath\bot}%
11035 \DeclareUnicodeCharacter{22A8}{\ensuremath\models}%
11036 \DeclareUnicodeCharacter{22C0}{\ensuremath\bigwedge}%
11037 \DeclareUnicodeCharacter{22C1}{\ensuremath\bigvee}%
11038 \DeclareUnicodeCharacter{22C2}{\ensuremath\bigcap}%
11039 \DeclareUnicodeCharacter{22C3}{\ensuremath\bigcup}%
11040 \DeclareUnicodeCharacter{22C4}{\ensuremath\diamond}%
11041 \DeclareUnicodeCharacter{22C5}{\ensuremath\cdot}%
11042 \DeclareUnicodeCharacter{22C6}{\ensuremath\star}%
11043 \DeclareUnicodeCharacter{22C8}{\ensuremath\bowtie}%
11044 \DeclareUnicodeCharacter{2308}{\ensuremath\lceil}%
11045 \DeclareUnicodeCharacter{2309}{\ensuremath\rceil}%
11046 \DeclareUnicodeCharacter{230A}{\ensuremath\lfloor}%
11047 \DeclareUnicodeCharacter{230B}{\ensuremath\rfloor}%
11048 \DeclareUnicodeCharacter{2322}{\ensuremath\frown}%
11049 \DeclareUnicodeCharacter{2323}{\ensuremath\smile}%
11051 \DeclareUnicodeCharacter{25B3}{\ensuremath\triangle}%
11052 \DeclareUnicodeCharacter{25B7}{\ensuremath\triangleright}%
11053 \DeclareUnicodeCharacter{25BD}{\ensuremath\bigtriangledown}%
11054 \DeclareUnicodeCharacter{25C1}{\ensuremath\triangleleft}%
11055 \DeclareUnicodeCharacter{25C7}{\ensuremath\diamond}%
11056 \DeclareUnicodeCharacter{2660}{\ensuremath\spadesuit}%
11057 \DeclareUnicodeCharacter{2661}{\ensuremath\heartsuit}%
11058 \DeclareUnicodeCharacter{2662}{\ensuremath\diamondsuit}%
11059 \DeclareUnicodeCharacter{2663}{\ensuremath\clubsuit}%
11060 \DeclareUnicodeCharacter{266D}{\ensuremath\flat}%
11061 \DeclareUnicodeCharacter{266E}{\ensuremath\natural}%
11062 \DeclareUnicodeCharacter{266F}{\ensuremath\sharp}%
11063 \DeclareUnicodeCharacter{26AA}{\ensuremath\bigcirc}%
11064 \DeclareUnicodeCharacter{27B9}{\ensuremath\rangle}%
11065 \DeclareUnicodeCharacter{27C2}{\ensuremath\perp}%
11066 \DeclareUnicodeCharacter{27E8}{\ensuremath\langle}%
11067 \DeclareUnicodeCharacter{27F5}{\ensuremath\longleftarrow}%
11068 \DeclareUnicodeCharacter{27F6}{\ensuremath\longrightarrow}%
11069 \DeclareUnicodeCharacter{27F7}{\ensuremath\longleftrightarrow}%
11070 \DeclareUnicodeCharacter{27FC}{\ensuremath\longmapsto}%
11071 \DeclareUnicodeCharacter{29F5}{\ensuremath\setminus}%
11072 \DeclareUnicodeCharacter{2A00}{\ensuremath\bigodot}%
11073 \DeclareUnicodeCharacter{2A01}{\ensuremath\bigoplus}%
11074 \DeclareUnicodeCharacter{2A02}{\ensuremath\bigotimes}%
11075 \DeclareUnicodeCharacter{2A04}{\ensuremath\biguplus}%
11076 \DeclareUnicodeCharacter{2A06}{\ensuremath\bigsqcup}%
11077 \DeclareUnicodeCharacter{2A3F}{\ensuremath\amalg}%
11078 \DeclareUnicodeCharacter{2AAF}{\ensuremath\preceq}%
11079 \DeclareUnicodeCharacter{2AB0}{\ensuremath\succeq}%
11081 \global\mathchardef\checkmark="1370% actually the square root sign
11082 \DeclareUnicodeCharacter{2713}{\ensuremath\checkmark}%
11083 }% end of \unicodechardefs
11085 % UTF-8 byte sequence (pdfTeX) definitions (replacing and @U command)
11086 % It makes the setting that replace UTF-8 byte sequence.
11087 \def\utfeightchardefs{%
11088 \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterUTFviii
11092 % Whether the active definitions of non-ASCII characters expand to
11093 % non-active tokens with the same character code. This is used to
11094 % write characters literally, instead of using active definitions for
11095 % printing the correct glyphs.
11096 \newif\ifpassthroughchars
11097 \passthroughcharsfalse
11099 % For native Unicode handling (XeTeX and LuaTeX),
11100 % provide a definition macro to replace/pass-through a Unicode character
11102 \def\DeclareUnicodeCharacterNative#1#2{%
11103 \catcode"#1=\active
11104 \def\dodeclareunicodecharacternative##1##2##3{%
11106 \uccode`\~="##2\relax
11107 \uppercase{\gdef~}{%
11108 \ifpassthroughchars
11117 \uccode`\.="#1\relax
11118 \uppercase{\def\UTFNativeTmp{.}}%
11119 \expandafter\dodeclareunicodecharacternative\UTFNativeTmp{#1}{#2}%
11123 % Native Unicode handling (XeTeX and LuaTeX) character replacing definition.
11124 % It activates the setting that replaces Unicode characters.
11125 \def\nativeunicodechardefs{%
11126 \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNative
11130 % For native Unicode handling (XeTeX and LuaTeX),
11131 % make the character token expand
11132 % to the sequences given in \unicodechardefs for printing.
11133 \def\DeclareUnicodeCharacterNativeAtU#1#2{%
11135 \expandafter\globallet\csname uni:#1\endcsname \UTFAtUTmp
11138 % @U command definitions for native Unicode handling (XeTeX and LuaTeX).
11139 \def\nativeunicodechardefsatu{%
11140 \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNativeAtU
11144 % US-ASCII character definitions.
11145 \def\asciichardefs{% nothing need be done
11149 % Define all Unicode characters we know about. This makes UTF-8 the default
11150 % input encoding and allows @U to work.
11151 \iftxinativeunicodecapable
11152 \nativeunicodechardefsatu
11157 \message{formatting,}
11159 \newdimen\defaultparindent \defaultparindent = 15pt
11161 \chapheadingskip = 15pt plus 4pt minus 2pt
11162 \secheadingskip = 12pt plus 3pt minus 2pt
11163 \subsecheadingskip = 9pt plus 2pt minus 2pt
11165 % Prevent underfull vbox error messages.
11168 % Don't be very finicky about underfull hboxes, either.
11171 % Following George Bush, get rid of widows and orphans.
11172 \widowpenalty=10000
11175 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
11176 % using an old version of TeX, don't do anything. We want the amount of
11177 % stretch added to depend on the line length, hence the dependence on
11178 % \hsize. We call this whenever the paper size is set.
11180 \def\setemergencystretch{%
11181 \ifx\emergencystretch\thisisundefined
11182 % Allow us to assign to \emergencystretch anyway.
11183 \def\emergencystretch{\dimen0}%
11185 \emergencystretch = .15\hsize
11189 % Parameters in order: 1) textheight; 2) textwidth;
11190 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
11191 % 7) physical page height; 8) physical page width.
11193 % We also call \setleading{\textleading}, so the caller should define
11194 % \textleading. The caller should also set \parskip.
11196 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
11197 \voffset = #3\relax
11198 \topskip = #6\relax
11199 \splittopskip = \topskip
11202 \advance\vsize by \topskip
11203 \outervsize = \vsize
11204 \advance\outervsize by 2\topandbottommargin
11205 \txipageheight = \vsize
11208 \outerhsize = \hsize
11209 \advance\outerhsize by 0.5in
11210 \txipagewidth = \hsize
11212 \normaloffset = #4\relax
11213 \bindingoffset = #5\relax
11216 \pdfpageheight #7\relax
11217 \pdfpagewidth #8\relax
11218 % if we don't reset these, they will remain at "1 true in" of
11219 % whatever layout pdftex was dumped with.
11220 \pdfhorigin = 1 true in
11221 \pdfvorigin = 1 true in
11223 \ifx\XeTeXrevision\thisisundefined
11224 \special{papersize=#8,#7}%
11226 \pdfpageheight #7\relax
11227 \pdfpagewidth #8\relax
11228 % XeTeX does not have \pdfhorigin and \pdfvorigin.
11232 \setleading{\textleading}
11234 \parindent = \defaultparindent
11235 \setemergencystretch
11238 % @letterpaper (the default).
11239 \def\letterpaper{{\globaldefs = 1
11240 \parskip = 3pt plus 2pt minus 1pt
11241 \textleading = 13.2pt
11243 % If page is nothing but text, make it come out even.
11244 \internalpagesizes{607.2pt}{6in}% that's 46 lines
11246 {\bindingoffset}{36pt}%
11250 % Use @smallbook to reset parameters for 7x9.25 trim size.
11251 \def\smallbook{{\globaldefs = 1
11252 \parskip = 2pt plus 1pt
11253 \textleading = 12pt
11255 \internalpagesizes{7.5in}{5in}%
11257 {\bindingoffset}{16pt}%
11260 \lispnarrowing = 0.3in
11262 \contentsrightmargin = 0pt
11263 \defbodyindent = .5cm
11266 % Use @smallerbook to reset parameters for 6x9 trim size.
11267 % (Just testing, parameters still in flux.)
11268 \def\smallerbook{{\globaldefs = 1
11269 \parskip = 1.5pt plus 1pt
11270 \textleading = 12pt
11272 \internalpagesizes{7.4in}{4.8in}%
11277 \lispnarrowing = 0.25in
11279 \contentsrightmargin = 0pt
11280 \defbodyindent = .4cm
11283 % Use @afourpaper to print on European A4 paper.
11284 \def\afourpaper{{\globaldefs = 1
11285 \parskip = 3pt plus 2pt minus 1pt
11286 \textleading = 13.2pt
11288 % Double-side printing via postscript on Laserjet 4050
11289 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
11290 % To change the settings for a different printer or situation, adjust
11291 % \normaloffset until the front-side and back-side texts align. Then
11292 % do the same for \bindingoffset. You can set these for testing in
11293 % your texinfo source file like this:
11295 % \global\normaloffset = -6mm
11296 % \global\bindingoffset = 10mm
11298 \internalpagesizes{673.2pt}{160mm}% that's 51 lines
11299 {\voffset}{\hoffset}%
11300 {\bindingoffset}{44pt}%
11304 \contentsrightmargin = 0pt
11305 \defbodyindent = 5mm
11308 % Use @afivepaper to print on European A5 paper.
11309 % From romildo@urano.iceb.ufop.br, 2 July 2000.
11310 % He also recommends making @example and @lisp be small.
11311 \def\afivepaper{{\globaldefs = 1
11312 \parskip = 2pt plus 1pt minus 0.1pt
11313 \textleading = 12.5pt
11315 \internalpagesizes{160mm}{120mm}%
11316 {\voffset}{\hoffset}%
11317 {\bindingoffset}{8pt}%
11320 \lispnarrowing = 0.2in
11322 \contentsrightmargin = 0pt
11323 \defbodyindent = 2mm
11324 \tableindent = 12mm
11327 % A specific text layout, 24x15cm overall, intended for A4 paper.
11328 \def\afourlatex{{\globaldefs = 1
11330 \internalpagesizes{237mm}{150mm}%
11332 {\bindingoffset}{7mm}%
11335 % Must explicitly reset to 0 because we call \afourpaper.
11339 % Use @afourwide to print on A4 paper in landscape format.
11340 \def\afourwide{{\globaldefs = 1
11342 \internalpagesizes{241mm}{165mm}%
11343 {\voffset}{-2.95mm}%
11344 {\bindingoffset}{7mm}%
11349 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
11350 % Perhaps we should allow setting the margins, \topskip, \parskip,
11351 % and/or leading, also. Or perhaps we should compute them somehow.
11353 \parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
11354 \def\pagesizesyyy#1,#2,#3\finish{{%
11355 \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
11358 \parskip = 3pt plus 2pt minus 1pt
11359 \setleading{\textleading}%
11362 \advance\dimen0 by \voffset
11363 \advance\dimen0 by 1in % reference point for DVI is 1 inch from top of page
11366 \advance\dimen2 by \normaloffset
11367 \advance\dimen2 by 1in % reference point is 1 inch from left edge of page
11369 \internalpagesizes{#1}{\hsize}%
11370 {\voffset}{\normaloffset}%
11371 {\bindingoffset}{44pt}%
11372 {\dimen0}{\dimen2}%
11375 % Set default to letter.
11379 % Default value of \hfuzz, for suppressing warnings about overfull hboxes.
11383 \message{and turning on texinfo input format.}
11385 \def^^L{\par} % remove \outer, so ^L can appear in an @comment
11387 % DEL is a comment character, in case @c does not suffice.
11390 % Define macros to output various characters with catcode for normal text.
11391 \catcode`\"=\other \def\normaldoublequote{"}
11392 \catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
11393 \catcode`\+=\other \def\normalplus{+}
11394 \catcode`\<=\other \def\normalless{<}
11395 \catcode`\>=\other \def\normalgreater{>}
11396 \catcode`\^=\other \def\normalcaret{^}
11397 \catcode`\_=\other \def\normalunderscore{_}
11398 \catcode`\|=\other \def\normalverticalbar{|}
11399 \catcode`\~=\other \def\normaltilde{~}
11401 % This macro is used to make a character print one way in \tt
11402 % (where it can probably be output as-is), and another way in other fonts,
11403 % where something hairier probably needs to be done.
11405 % #1 is what to print if we are indeed using \tt; #2 is what to print
11406 % otherwise. Since all the Computer Modern typewriter fonts have zero
11407 % interword stretch (and shrink), and it is reasonable to expect all
11408 % typewriter fonts to have this, we can check that font parameter.
11410 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
11412 % Same as above, but check for italic font. Actually this also catches
11413 % non-italic slanted fonts since it is impossible to distinguish them from
11414 % italic fonts. But since this is only used by $ and it uses \sl anyway
11415 % this is not a problem.
11416 \def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
11418 % Set catcodes for Texinfo file
11420 % Active characters for printing the wanted glyph.
11421 % Most of these we simply print from the \tt font, but for some, we can
11422 % use math or other variants that look better in normal text.
11424 \catcode`\"=\active
11425 \def\activedoublequote{{\tt\char34}}
11426 \let"=\activedoublequote
11427 \catcode`\~=\active \def\activetilde{{\tt\char126}} \let~ = \activetilde
11428 \chardef\hatchar=`\^
11429 \catcode`\^=\active \def\activehat{{\tt \hatchar}} \let^ = \activehat
11431 \catcode`\_=\active
11432 \def_{\ifusingtt\normalunderscore\_}
11433 \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
11436 \catcode`\|=\active \def|{{\tt\char124}}
11439 \catcode`\<=\active \def\activeless{{\tt \less}}\let< = \activeless
11441 \catcode`\>=\active \def\activegtr{{\tt \gtr}}\let> = \activegtr
11442 \catcode`\+=\active \def+{{\tt \char 43}}
11443 \catcode`\$=\active \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
11444 \catcode`\-=\active \let-=\normaldash
11447 % used for headline/footline in the output routine, in case the page
11448 % breaks in the middle of an @tex block.
11449 \def\texinfochars{%
11450 \let< = \activeless
11452 \let~ = \activetilde
11454 \markupsetuplqdefault \markupsetuprqdefault
11456 \let\i = \smartitalic
11457 % in principle, all other definitions in \tex have to be undone too.
11460 % Used sometimes to turn off (effectively) the active characters even after
11462 \def\turnoffactive{%
11463 \normalturnoffactive
11469 % \backslashcurfont outputs one backslash character in current font,
11471 \global\chardef\backslashcurfont=`\\
11473 % \realbackslash is an actual character `\' with catcode other.
11474 {\catcode`\\=\other @gdef@realbackslash{\}}
11476 % In Texinfo, backslash is an active character; it prints the backslash
11477 % in fixed width font.
11478 \catcode`\\=\active % @ for escape char from now on.
11480 % Print a typewriter backslash. For math mode, we can't simply use
11481 % \backslashcurfont: the story here is that in math mode, the \char
11482 % of \backslashcurfont ends up printing the roman \ from the math symbol
11483 % font (because \char in math mode uses the \mathcode, and plain.tex
11484 % sets \mathcode`\\="026E). Hence we use an explicit \mathchar,
11485 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
11486 % ignored family value; char position "5C). We can't use " for the
11487 % usual hex value because it has already been made active.
11489 @def@ttbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
11490 @let@backslashchar = @ttbackslash % @backslashchar{} is for user documents.
11492 % \otherbackslash defines an active \ to be a literal `\' character with
11494 @gdef@otherbackslash{@let\=@realbackslash}
11496 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
11497 % the literal character `\'.
11499 {@catcode`- = @active
11500 @gdef@normalturnoffactive{%
11501 @passthroughcharstrue
11503 @let"=@normaldoublequote
11504 @let$=@normaldollar %$ font-lock fix
11507 @let>=@normalgreater
11509 @let_=@normalunderscore
11510 @let|=@normalverticalbar
11513 @markupsetuplqdefault
11514 @markupsetuprqdefault
11519 % If a .fmt file is being used, characters that might appear in a file
11520 % name cannot be active until we have parsed the command line.
11521 % So turn them off again, and have @fixbackslash turn them back on.
11522 @catcode`+=@other @catcode`@_=@other
11524 % \enablebackslashhack - allow file to begin `\input texinfo'
11526 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
11527 % That is what \eatinput is for; after that, the `\' should revert to printing
11529 % If the file did not have a `\input texinfo', then it is turned off after
11530 % the first line; otherwise the first `\' in the file would cause an error.
11531 % This is used on the very last line of this file, texinfo.tex.
11532 % We also use @c to call @fixbackslash, in case ends of lines are hidden.
11535 @catcode`@^^M=13@gdef@enablebackslashhack{%
11536 @global@let\ = @eatinput%
11538 @def@c{@fixbackslash@c}%
11539 % Definition for the newline at the end of this file.
11540 @def ^^M{@let^^M@secondlinenl}%
11541 % Definition for a newline in the main Texinfo file.
11542 @gdef @secondlinenl{@fixbackslash}%
11543 % In case the first line has a whole-line command on it
11544 @let@originalparsearg@parsearg
11545 @def@parsearg{@fixbackslash@originalparsearg}
11548 {@catcode`@^=7 @catcode`@^^M=13%
11549 @gdef@eatinput input texinfo#1^^M{@fixbackslash}}
11551 % Emergency active definition of newline, in case an active newline token
11552 % appears by mistake.
11553 {@catcode`@^=7 @catcode13=13%
11554 @gdef@enableemergencynewline{%
11557 %<warning: active newline>@par%
11561 @gdef@fixbackslash{%
11562 @ifx\@eatinput @let\ = @ttbackslash @fi
11563 @catcode13=5 % regular end of line
11564 @enableemergencynewline
11566 @let@parsearg@originalparsearg
11567 % Also turn back on active characters that might appear in the input
11568 % file name, in case not using a pre-dumped format.
11570 @catcode`@_=@active
11572 % If texinfo.cnf is present on the system, read it.
11573 % Useful for site-wide @afourpaper, etc. This macro, @fixbackslash, gets
11574 % called at the beginning of every Texinfo file. Not opening texinfo.cnf
11575 % directly in this file, texinfo.tex, makes it possible to make a format
11576 % file for Texinfo.
11578 @openin 1 texinfo.cnf
11579 @ifeof 1 @else @input texinfo.cnf @fi
11584 % Say @foo, not \foo, in error messages.
11587 % These (along with & and #) are made active for url-breaking, so need
11588 % active definitions as the normal characters.
11590 @def@normalquest{?}
11591 @def@normalslash{/}
11593 % These look ok in all fonts, so just make them not special.
11594 % @hashchar{} gets its own user-level command, because of #line.
11595 @catcode`@& = @other @def@normalamp{&}
11596 @catcode`@# = @other @def@normalhash{#}
11597 @catcode`@% = @other @def@normalpercent{%}
11599 @let @hashchar = @normalhash
11601 @c Finally, make ` and ' active, so that txicodequoteundirected and
11602 @c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
11603 @c don't make ` and ' active, @code will not get them as active chars.
11604 @c Do this last of all since we use ` in the previous @catcode assignments.
11605 @catcode`@'=@active
11606 @catcode`@`=@active
11607 @markupsetuplqdefault
11608 @markupsetuprqdefault
11610 @c Local variables:
11611 @c eval: (add-hook 'before-save-hook 'time-stamp)
11612 @c page-delimiter: "^\\\\message\\|emacs-page"
11613 @c time-stamp-start: "def\\\\texinfoversion{"
11614 @c time-stamp-format: "%:y-%02m-%02d.%02H"
11615 @c time-stamp-end: "}"
11620 @enablebackslashhack