1 % texinfo.tex -- TeX macros to handle Texinfo files.
3 % Load plain if necessary, i.e., if running under initex.
4 \expandafter\ifx\csname fmtname
\endcsname\relax\input plain
\fi
6 \def\texinfoversion{2015-
01-
31.10}
8 % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9 % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
10 % 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
11 % Free Software Foundation, Inc.
13 % This texinfo.tex file is free software: you can redistribute it and/or
14 % modify it under the terms of the GNU General Public License as
15 % published by the Free Software Foundation, either version 3 of the
16 % License, or (at your option) any later version.
18 % This texinfo.tex file is distributed in the hope that it will be
19 % useful, but WITHOUT ANY WARRANTY; without even the implied warranty
20 % of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 % General Public License for more details.
23 % You should have received a copy of the GNU General Public License
24 % along with this program. If not, see <http://www.gnu.org/licenses/>.
26 % As a special exception, when this file is read by TeX when processing
27 % a Texinfo source document, you may use the result without
28 % restriction. This Exception is an additional permission under section 7
29 % of the GNU General Public License, version 3 ("GPLv3").
31 % Please try the latest version of texinfo.tex before submitting bug
32 % reports; you can get the latest version from:
33 % http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
34 % http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
35 % http://www.gnu.org/software/texinfo/ (the Texinfo home page)
36 % The texinfo.tex in any given distribution could well be out
37 % of date, so if that's what you're using, please check.
39 % Send bug reports to bug-texinfo@gnu.org. Please include including a
40 % complete document in each bug report with which we can reproduce the
41 % problem. Patches are, of course, greatly appreciated.
43 % To process a Texinfo manual with TeX, it's most reliable to use the
44 % texi2dvi shell script that comes with the distribution. For a simple
45 % manual foo.texi, however, you can get away with this:
50 % dvips foo.dvi -o # or whatever; this makes foo.ps.
51 % The extra TeX runs get the cross-reference information correct.
52 % Sometimes one run after texindex suffices, and sometimes you need more
53 % than two; texi2dvi does it as many times as necessary.
55 % It is possible to adapt texinfo.tex for other languages, to some
56 % extent. You can get the existing language-specific files from the
57 % full Texinfo distribution.
59 % The GNU Texinfo home page is http://www.gnu.org/software/texinfo.
62 \message{Loading texinfo
[version
\texinfoversion]:
}
64 % If in a .fmt file, print the version number
65 % and turn on active characters that we couldn't do earlier because
66 % they might have appeared in the input file name.
67 \everyjob{\message{[Texinfo version
\texinfoversion]}%
68 \catcode`+=
\active \catcode`
\_=
\active}
72 % We never want plain's \outer definition of \+ in Texinfo.
73 % For @tex, we can use \tabalign.
76 % Save some plain tex macros whose names we will redefine.
78 \let\ptexbullet=
\bullet
86 \let\ptexfootnote=
\footnote
90 \let\ptexindent=
\indent
91 \let\ptexinsert=
\insert
94 \let\ptexnewwrite\newwrite
95 \let\ptexnoindent=
\noindent
97 \let\ptexraggedright=
\raggedright
105 {\catcode`\'=
\active \global\let\ptexquoteright'
}% active in plain's math mode
107 % If this character appears in an error message or help string, it
108 % starts a new line in the output.
111 % Use TeX 3.0's \inputlineno to get the line number, for better error
112 % messages, but if we're using an old version of TeX, don't do anything.
114 \ifx\inputlineno\thisisundefined
115 \let\linenumber =
\empty % Pre-3.0.
117 \def\linenumber{l.
\the\inputlineno:
\space}
120 % Set up fixed words for English if not already set.
121 \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix
}\fi
122 \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter
}\fi
123 \ifx\putworderror\undefined \gdef\putworderror{error
}\fi
124 \ifx\putwordfile\undefined \gdef\putwordfile{file
}\fi
125 \ifx\putwordin\undefined \gdef\putwordin{in
}\fi
126 \ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)
}\fi
127 \ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)
}\fi
128 \ifx\putwordInfo\undefined \gdef\putwordInfo{Info
}\fi
129 \ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of
}\fi
130 \ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on
}\fi
131 \ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title
}\fi
132 \ifx\putwordof\undefined \gdef\putwordof{of
}\fi
133 \ifx\putwordon\undefined \gdef\putwordon{on
}\fi
134 \ifx\putwordpage\undefined \gdef\putwordpage{page
}\fi
135 \ifx\putwordsection\undefined \gdef\putwordsection{section
}\fi
136 \ifx\putwordSection\undefined \gdef\putwordSection{Section
}\fi
137 \ifx\putwordsee\undefined \gdef\putwordsee{see
}\fi
138 \ifx\putwordSee\undefined \gdef\putwordSee{See
}\fi
139 \ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents
}\fi
140 \ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents
}\fi
142 \ifx\putwordMJan\undefined \gdef\putwordMJan{January
}\fi
143 \ifx\putwordMFeb\undefined \gdef\putwordMFeb{February
}\fi
144 \ifx\putwordMMar\undefined \gdef\putwordMMar{March
}\fi
145 \ifx\putwordMApr\undefined \gdef\putwordMApr{April
}\fi
146 \ifx\putwordMMay\undefined \gdef\putwordMMay{May
}\fi
147 \ifx\putwordMJun\undefined \gdef\putwordMJun{June
}\fi
148 \ifx\putwordMJul\undefined \gdef\putwordMJul{July
}\fi
149 \ifx\putwordMAug\undefined \gdef\putwordMAug{August
}\fi
150 \ifx\putwordMSep\undefined \gdef\putwordMSep{September
}\fi
151 \ifx\putwordMOct\undefined \gdef\putwordMOct{October
}\fi
152 \ifx\putwordMNov\undefined \gdef\putwordMNov{November
}\fi
153 \ifx\putwordMDec\undefined \gdef\putwordMDec{December
}\fi
155 \ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro
}\fi
156 \ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form
}\fi
157 \ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable
}\fi
158 \ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option
}\fi
159 \ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function
}\fi
161 % Since the category of space is not known, we have to be careful.
162 \chardef\spacecat =
10
163 \def\spaceisspace{\catcode`\ =
\spacecat}
165 % sometimes characters are active, so we need control sequences.
166 \chardef\ampChar = `\&
167 \chardef\colonChar = `\:
168 \chardef\commaChar = `\,
169 \chardef\dashChar = `\-
170 \chardef\dotChar = `\.
171 \chardef\exclamChar= `\!
172 \chardef\hashChar = `\#
173 \chardef\lquoteChar= `\`
174 \chardef\questChar = `\?
175 \chardef\rquoteChar= `\'
176 \chardef\semiChar = `\;
177 \chardef\slashChar = `\/
178 \chardef\underChar = `
\_
184 % The following is used inside several \edef's.
185 \def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
189 Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
190 ap-pen-dix bit-map bit-maps
191 data-base data-bases eshell fall-ing half-way long-est man-u-script
192 man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
193 par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
195 stand-alone strong-est time-stamp time-stamps which-ever white-space
196 wide-spread wrap-around
199 % Margin to add to right of even pages, to left of odd pages.
200 \newdimen\bindingoffset
201 \newdimen\normaloffset
202 \newdimen\pagewidth \newdimen\pageheight
204 % For a final copy, take out the rectangles
205 % that mark overfull boxes (in case you have decided
206 % that the text looks ok even though it passes the margin).
208 \def\finalout{\overfullrule=
0pt
}
210 % Sometimes it is convenient to have everything in the transcript file
211 % and nothing on the terminal. We don't just call \tracingall here,
212 % since that produces some useless output on the terminal. We also make
213 % some effort to order the tracing commands to reduce output in the log
214 % file; cf. trace.sty in LaTeX.
216 \def\gloggingall{\begingroup \globaldefs =
1 \loggingall \endgroup}%
220 \tracinglostchars2 % 2 gives us more in etex
225 \showboxbreadth\maxdimen \showboxdepth\maxdimen
226 \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
233 \tracingcommands3 % 3 gives us more in etex
237 % @errormsg{MSG}. Do the index-like expansions on MSG, but if things
238 % aren't perfect, it's not the end of the world, being an error message,
241 \def\errormsg{\begingroup \indexnofonts \doerrormsg}
242 \def\doerrormsg#1{\errmessage{#1}}
244 % add check for \lastpenalty to plain's definitions. If the last thing
245 % we did was a \nobreak, we don't want to insert more space.
247 \def\smallbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\smallskipamount
248 \removelastskip\penalty-
50\smallskip\fi\fi}
249 \def\medbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\medskipamount
250 \removelastskip\penalty-
100\medskip\fi\fi}
251 \def\bigbreak{\ifnum\lastpenalty<
10000\par\ifdim\lastskip<
\bigskipamount
252 \removelastskip\penalty-
200\bigskip\fi\fi}
254 % Do @cropmarks to get crop marks.
257 \let\cropmarks =
\cropmarkstrue
259 % Dimensions to add cropmarks at corners.
260 % Added by P. A. MacKay, 12 Nov. 1986
262 \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
263 \newdimen\cornerlong \cornerlong=
1pc
264 \newdimen\cornerthick \cornerthick=
.3pt
265 \newdimen\topandbottommargin \topandbottommargin=
.75in
267 % Output a mark which sets \thischapter, \thissection and \thiscolor.
268 % We dump everything together because we only have one kind of mark.
269 % This works because we only use \botmark / \topmark, not \firstmark.
271 % A mark contains a subexpression of the \ifcase ... \fi construct.
272 % \get*marks macros below extract the needed part using \ifcase.
274 % Another complication is to let the user choose whether \thischapter
275 % (\thissection) refers to the chapter (section) in effect at the top
276 % of a page, or that at the bottom of a page. The solution is
277 % described on page 260 of The TeXbook. It involves outputting two
278 % marks for the sectioning macros, one before the section break, and
279 % one after. I won't pretend I can describe this better than DEK...
281 \toks0=
\expandafter{\lastchapterdefs}%
282 \toks2=
\expandafter{\lastsectiondefs}%
283 \toks4=
\expandafter{\prevchapterdefs}%
284 \toks6=
\expandafter{\prevsectiondefs}%
285 \toks8=
\expandafter{\lastcolordefs}%
287 \the\toks0 \the\toks2 % 0: top marks (\last...)
288 \noexpand\or \the\toks4 \the\toks6 % 1: bottom marks (default, \prev...)
289 \noexpand\else \the\toks8 % 2: color marks
292 % \topmark doesn't work for the very first chapter (after the title
293 % page or the contents), so we use \firstmark there -- this gets us
294 % the mark with the chapter defs, unless the user sneaks in, e.g.,
295 % @setcolor (or @url, or @link, etc.) between @contents and the very
297 \def\gettopheadingmarks{%
299 \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
301 \def\getbottomheadingmarks{\ifcase1\botmark\fi}
302 \def\getcolormarks{\ifcase2\topmark\fi}
304 % Avoid "undefined control sequence" errors.
305 \def\lastchapterdefs{}
306 \def\lastsectiondefs{}
307 \def\prevchapterdefs{}
308 \def\prevsectiondefs{}
311 % Main output routine.
313 \output =
{\onepageout{\pagecontents\PAGE}}
318 % \onepageout takes a vbox as an argument. Note that \pagecontents
319 % does insertions, but you have to call it yourself.
321 \ifcropmarks \hoffset=
0pt
\else \hoffset=
\normaloffset \fi
323 \ifodd\pageno \advance\hoffset by
\bindingoffset
324 \else \advance\hoffset by -
\bindingoffset\fi
326 % Do this outside of the \shipout so @code etc. will be expanded in
327 % the headline as they should be, not taken literally (outputting ''code).
328 \def\commmonheadfootline{\let\hsize=
\pagewidth \texinfochars}
330 \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
331 \global\setbox\headlinebox =
\vbox{\commmonheadfootline \makeheadline}%
333 \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
334 \global\setbox\footlinebox =
\vbox{\commmonheadfootline \makefootline}%
337 % Have to do this stuff outside the \shipout because we want it to
338 % take effect in \write's, yet the group defined by the \vbox ends
339 % before the \shipout runs.
341 \indexdummies % don't expand commands in the output.
342 \normalturnoffactive % \ in index entries must not stay \, e.g., if
343 % the page break happens to be in the middle of an example.
344 % We don't want .vr (or whatever) entries like this:
345 % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}}
346 % "\acronym" won't work when it's read back in;
348 % {\code {{\tt \backslashcurfont }acronym}
350 % Do this early so pdf references go to the beginning of the page.
351 \ifpdfmakepagedest \pdfdest name
{\the\pageno} xyz
\fi
353 \ifcropmarks \vbox to
\outervsize\bgroup
355 \vskip-
\topandbottommargin
357 \line{\ewtop\hfil\ewtop}%
360 \vbox{\moveleft\cornerthick\nstop}%
362 \vbox{\moveright\cornerthick\nstop}%
365 \vskip\topandbottommargin
367 \hfil % center the page within the outer (page) hsize.
368 \ifodd\pageno\hskip\bindingoffset\fi
374 \ifdim\ht\footlinebox >
0pt
375 % Only leave this space if the footline is nonempty.
376 % (We lessened \vsize for it in \oddfootingyyy.)
377 % The \baselineskip=24pt in plain's \makefootline has no effect.
383 \egroup % end of \vbox\bgroup
384 \hfil\egroup % end of (centering) \line\bgroup
385 \vskip\topandbottommargin plus1fill minus1fill
386 \boxmaxdepth =
\cornerthick
389 \vbox{\moveleft\cornerthick\nsbot}%
391 \vbox{\moveright\cornerthick\nsbot}%
394 \line{\ewbot\hfil\ewbot}%
396 \egroup % \vbox from first cropmarks clause
398 }% end of \shipout\vbox
399 }% end of group with \indexdummies
401 \ifnum\outputpenalty>-
20000 \else\dosupereject\fi
404 \newinsert\margin \dimen\margin=
\maxdimen
406 \def\pagebody#1{\vbox to
\pageheight{\boxmaxdepth=
\maxdepth #1}}
408 \gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
409 % marginal hacks, juha@viisa.uucp (Juha Takala)
410 \ifvoid\margin\else % marginal info is present
411 \rlap{\kern\hsize\vbox to
\z@
{\kern1pt\box\margin \vss}}\fi
412 \dimen@=
\dp#1\relax \unvbox#1\relax
413 \ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
414 \ifr@ggedbottom
\kern-
\dimen@
\vfil \fi}
417 % Here are the rules for the cropmarks. Note that they are
418 % offset so that the space between them is truly \outerhsize or \outervsize
419 % (P. A. MacKay, 12 November, 1986)
421 \def\ewtop{\vrule height
\cornerthick depth0pt width
\cornerlong}
423 {\hrule height
\cornerthick depth
\cornerlong width
\cornerthick}}
424 \def\ewbot{\vrule height0pt depth
\cornerthick width
\cornerlong}
426 {\hrule height
\cornerlong depth
\cornerthick width
\cornerthick}}
428 % Parse an argument, then pass it to #1. The argument is the rest of
429 % the input line (except we remove a trailing comment). #1 should be a
430 % macro which expects an ordinary undelimited TeX argument.
432 \def\parsearg{\parseargusing{}}
433 \def\parseargusing#1#2{%
439 \parseargline\empty% Insert the \empty token, see \finishparsearg below.
443 \gdef\parseargline#1^^M
{%
444 \endgroup % End of the group started in \parsearg.
445 \argremovecomment #1\comment\ArgTerm%
449 % First remove any @comment, then any @c comment.
450 \def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
451 \def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M
\ArgTerm}
453 % Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
455 % \argremovec might leave us with trailing space, e.g.,
456 % @end itemize @c foo
457 % This space token undergoes the same procedure and is eventually removed
458 % by \finishparsearg.
460 \def\argcheckspaces#1\^^M
{\argcheckspacesX#1\^^M \^^M
}
461 \def\argcheckspacesX#1 \^^M
{\argcheckspacesY#1\^^M
}
462 \def\argcheckspacesY#1\^^M
#2\^^M
#3\ArgTerm{%
465 % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
466 \let\temp\finishparsearg
468 \let\temp\argcheckspaces
470 % Put the space token in:
474 % If a _delimited_ argument is enclosed in braces, they get stripped; so
475 % to get _exactly_ the rest of the line, we had to prevent such situation.
476 % We prepended an \empty token at the very beginning and we expand it now,
477 % just before passing the control to \argtorun.
478 % (Similarly, we have to think about #3 of \argcheckspacesY above: it is
479 % either the null string, or it ends with \^^M---thus there is no danger
480 % that a pair of braces would be stripped.
482 % But first, we have to remove the trailing space token.
484 \def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
486 % \parseargdef\foo{...}
487 % is roughly equivalent to
488 % \def\foo{\parsearg\Xfoo}
491 % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my
492 % favourite TeX trick. --kasal, 16nov03
495 \expandafter \doparseargdef \csname\string#1\endcsname #1%
497 \def\doparseargdef#1#2{%
502 % Several utility definitions with active space:
507 % Make each space character in the input produce a normal interword
508 % space in the output. Don't allow a line break at this space, as this
509 % is used only in environments like @example, where each line of input
510 % should produce a line of output anyway.
512 \gdef\sepspaces{\obeyspaces\let =
\tie}
514 % If an index command is used in an @example environment, any spaces
515 % therein should become regular spaces in the raw index file, not the
516 % expansion of \tie (\leavevmode \penalty \@M \ ).
517 \gdef\unsepspaces{\let =
\space}
521 \def\flushcr{\ifx\par\lisppar \def\next#
#1{}\else \let\next=
\relax \fi \next}
523 % Define the framework for environments in texinfo.tex. It's used like this:
528 % It's the responsibility of \envdef to insert \begingroup before the
529 % actual body; @end closes the group after calling \Efoo. \envdef also
530 % defines \thisenv, so the current environment is known; @end checks
531 % whether the environment name matches. The \checkenv macro can also be
532 % used to check whether the current environment is the one expected.
534 % Non-false conditionals (@iftex, @ifset) don't fit into this, so they
535 % are not treated as environments; they don't open a group. (The
536 % implementation of @end takes care not to call \endgroup in this
540 % At run-time, environments start with this:
541 \def\startenvironment#1{\begingroup\def\thisenv{#1}}
545 % ... but they get defined via ``\envdef\foo{...}'':
546 \long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
547 \def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
549 % Check whether we're in the right environment:
558 % Environment mismatch, #1 expected:
561 \errmessage{This command can appear only
\inenvironment\temp,
562 not
\inenvironment\thisenv}%
564 \def\inenvironment#1{%
566 outside of any environment
%
568 in environment
\expandafter\string#1%
572 % @end foo executes the definition of \Efoo.
573 % But first, it executes a specialized version of \checkenv
576 \if 1\csname iscond.
#1\endcsname
578 % The general wording of \badenverr may not be ideal.
579 \expandafter\checkenv\csname#1\endcsname
580 \csname E
#1\endcsname
585 \newhelp\EMsimple{Press RETURN to continue.
}
588 % Be sure we're in horizontal mode when doing a tie, since we make space
589 % equivalent to this in @example-like environments. Otherwise, a space
590 % at the beginning of a line will start with \penalty -- and
591 % since \penalty is valid in vertical mode, we'd end up putting the
592 % penalty on the vertical list instead of in the new paragraph.
594 % Avoid using \@M directly, because that causes trouble
595 % if the definition is written into an index file.
596 \global\let\tiepenalty = \@M
597 \gdef\tie{\leavevmode\penalty\tiepenalty\
}
600 % @: forces normal size whitespace following.
601 \def\:
{\spacefactor=
1000 }
603 % @* forces a line break.
604 \def\*
{\unskip\hfil\break\hbox{}\ignorespaces}
606 % @/ allows a line break.
609 % @. is an end-of-sentence period.
610 \def\.
{.
\spacefactor=
\endofsentencespacefactor\space}
612 % @! is an end-of-sentence bang.
613 \def\!
{!
\spacefactor=
\endofsentencespacefactor\space}
615 % @? is an end-of-sentence query.
616 \def\?
{?
\spacefactor=
\endofsentencespacefactor\space}
618 % @frenchspacing on|off says whether to put extra space after punctuation.
623 \parseargdef\frenchspacing{%
625 \ifx\temp\onword \plainfrenchspacing
626 \else\ifx\temp\offword \plainnonfrenchspacing
629 \errmessage{Unknown @frenchspacing option `
\temp', must be on|off
}%
633 % @w prevents a word break. Without the \leavevmode, @w at the
634 % beginning of a paragraph, when TeX is still in vertical mode, would
635 % produce a whole line of output instead of starting the paragraph.
636 \def\w#1{\leavevmode\hbox{#1}}
638 % @group ... @end group forces ... to be all on one page, by enclosing
639 % it in a TeX vbox. We use \vtop instead of \vbox to construct the box
640 % to keep its height that of a normal line. According to the rules for
641 % \topskip (p.114 of the TeXbook), the glue inserted is
642 % max (\topskip - \ht (first item), 0). If that height is large,
643 % therefore, no glue is inserted, and the space between the headline and
644 % the text is small, which looks bad.
646 % Another complication is that the group might be very large. This can
647 % cause the glue on the previous page to be unduly stretched, because it
648 % does not have much material. In this case, it's better to add an
649 % explicit \vfill so that the extra space is at the bottom. The
650 % threshold for doing this is if the group is more than \vfilllimit
651 % percent of a page (\vfilllimit can be changed inside of @tex).
657 \ifnum\catcode`\^^M=
\active \else
658 \errhelp =
\groupinvalidhelp
659 \errmessage{@group invalid in context where filling is enabled
}%
663 \setbox\groupbox =
\vtop\bgroup
664 % Do @comment since we are called inside an environment such as
665 % @example, where each end-of-line in the input causes an
666 % end-of-line in the output. We don't want the end-of-line after
667 % the `@group' to put extra space in the output. Since @group
668 % should appear on a line by itself (according to the Texinfo
669 % manual), we don't worry about eating any user text.
673 % The \vtop produces a box with normal height and large depth; thus, TeX puts
674 % \baselineskip glue before it, and (when the next line of text is done)
675 % \lineskip glue after it. Thus, space below is not quite equal to space
676 % above. But it's pretty close.
678 % To get correct interline space between the last line of the group
679 % and the first line afterwards, we have to propagate \prevdepth.
680 \endgraf % Not \par, as it may have been set to \lisppar.
681 \global\dimen1 =
\prevdepth
682 \egroup % End the \vtop.
683 % \dimen0 is the vertical size of the group's box.
684 \dimen0 =
\ht\groupbox \advance\dimen0 by
\dp\groupbox
685 % \dimen2 is how much space is left on the page (more or less).
686 \dimen2 =
\pageheight \advance\dimen2 by -
\pagetotal
687 % if the group doesn't fit on the current page, and it's a big big
688 % group, force a page break.
689 \ifdim \dimen0 >
\dimen2
690 \ifdim \pagetotal <
\vfilllimit\pageheight
699 % TeX puts in an \escapechar (i.e., `@') at the beginning of the help
700 % message, so this ends up printing `@group can only ...'.
702 \newhelp\groupinvalidhelp{%
703 group can only be used in environments such as @example,^^J
%
704 where each line of input produces a line of output.
}
706 % @need space-in-mils
707 % forces a page break if there is not space-in-mils remaining.
709 \newdimen\mil \mil=
0.001in
712 % Ensure vertical mode, so we don't make a big box in the middle of a
716 % If the @need value is less than one line space, it's useless.
718 \dimen2 =
\ht\strutbox
719 \advance\dimen2 by
\dp\strutbox
720 \ifdim\dimen0 >
\dimen2
722 % Do a \strut just to make the height of this box be normal, so the
723 % normal leading is inserted relative to the preceding line.
724 % And a page break here is fine.
725 \vtop to
#1\mil{\strut\vfil}%
727 % TeX does not even consider page breaks if a penalty added to the
728 % main vertical list is 10000 or more. But in order to see if the
729 % empty box we just added fits on the page, we must make it consider
730 % page breaks. On the other hand, we don't want to actually break the
731 % page after the empty box. So we use a penalty of 9999.
733 % There is an extremely small chance that TeX will actually break the
734 % page at this \penalty, if there are no other feasible breakpoints in
735 % sight. (If the user is using lots of big @group commands, which
736 % almost-but-not-quite fill up a page, TeX will have a hard time doing
737 % good page breaking, for example.) However, I could not construct an
738 % example where a page broke at this \penalty; if it happens in a real
739 % document, then we can reconsider our strategy.
742 % Back up by the size of the box, whether we did a page break or not.
745 % Do not allow a page break right after this kern.
750 % @br forces paragraph break (and is undocumented).
754 % @page forces the start of a new page.
756 \def\page{\par\vfill\supereject}
759 % outputs text on separate line in roman font, starting at standard page margin
761 % This records the amount of indent in the innermost environment.
762 % That's how much \exdent should take out.
763 \newskip\exdentamount
765 % This defn is used inside fill environments such as @defun.
766 \parseargdef\exdent{\hfil\break\hbox{\kern -
\exdentamount{\rm#1}}\hfil\break}
768 % This defn is used inside nofill environments such as @example.
769 \parseargdef\nofillexdent{{\advance \leftskip by -
\exdentamount
770 \leftline{\hskip\leftskip{\rm#1}}}}
772 % @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
773 % paragraph. For more general purposes, use the \margin insertion
774 % class. WHICH is `l' or `r'. Not documented, written for gawk manual.
776 \newskip\inmarginspacing \inmarginspacing=
1cm
777 \def\strutdepth{\dp\strutbox}
779 \def\doinmargin#1#2{\strut\vadjust{%
782 \vtop to
\strutdepth{%
783 \baselineskip=
\strutdepth
785 % if you have multiple lines of stuff to put here, you'll need to
786 % make the vbox yourself of the appropriate size.
788 \llap{\ignorespaces #2\hskip\inmarginspacing}%
790 \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
795 \def\inleftmargin{\doinmargin l
}
796 \def\inrightmargin{\doinmargin r
}
798 % @inmargin{TEXT [, RIGHT-TEXT]}
799 % (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
800 % else use TEXT for both).
802 \def\inmargin#1{\parseinmargin #1,,
\finish}
803 \def\parseinmargin#1,
#2,
#3\finish{% not perfect, but better than nothing.
804 \setbox0 =
\hbox{\ignorespaces #2}%
806 \def\lefttext{#1}% have both texts
809 \def\lefttext{#1}% have only one text
814 \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
816 \def\temp{\inleftmargin\lefttext}%
821 % @| inserts a changebar to the left of the current line. It should
822 % surround any changed text. This approach does *not* work if the
823 % change spans more than two lines of output. To handle that, we would
824 % have adopt a much more difficult approach (putting marks into the main
825 % vertical list for the beginning and end of each change). This command
826 % is not documented, not supported, and doesn't work.
829 % \vadjust can only be used in horizontal mode.
832 % Append this vertical mode material after the current line in the output.
834 % We want to insert a rule with the height and depth of the current
835 % leading; that is exactly what \strutbox is supposed to record.
838 % \vadjust-items are inserted at the left edge of the type. So
839 % the \llap here moves out into the left-hand margin.
842 % For a thicker or thinner bar, change the `1pt'.
843 \vrule height
\baselineskip width1pt
845 % This is the space between the bar and the text.
851 % @include FILE -- \input text of FILE.
853 \def\include{\parseargusing\filenamecatcodes\includezzz}
858 \makevalueexpandable % we want to expand any @value in FILE.
859 \turnoffactive % and allow special characters in the expansion
860 \indexnofonts % Allow `@@' and other weird things in file names.
861 \wlog{texinfo.tex: doing @include of
#1^^J
}%
862 \edef\temp{\noexpand\input #1 }%
864 % This trickery is to read FILE outside of a group, in case it makes
870 \def\filenamecatcodes{%
884 \def\pushthisfilestack{%
885 \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
887 \def\pushthisfilestackX{%
888 \expandafter\pushthisfilestackY\thisfile\StackTerm
890 \def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
891 \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
894 \def\popthisfilestack{\errthisfilestackempty}
895 \def\errthisfilestackempty{\errmessage{Internal error:
896 the stack of filenames is empty.
}}
901 % outputs that line, centered.
903 \parseargdef\center{%
905 \let\centersub\centerH
907 \let\centersub\centerV
909 \centersub{\hfil \ignorespaces#1\unskip \hfil}%
910 \let\centersub\relax % don't let the definition persist, just in case
914 \advance\hsize by -
\leftskip
915 \advance\hsize by -
\rightskip
920 \newcount\centerpenalty
922 % The idea here is the same as in \startdefun, \cartouche, etc.: if
923 % @center is the first thing after a section heading, we need to wipe
924 % out the negative parskip inserted by \sectionheading, but still
925 % prevent a page break here.
926 \centerpenalty =
\lastpenalty
927 \ifnum\centerpenalty>
10000 \vskip\parskip \fi
928 \ifnum\centerpenalty>
9999 \penalty\centerpenalty \fi
929 \line{\kern\leftskip #1\kern\rightskip}%
932 % @sp n outputs n lines of vertical space
934 \parseargdef\sp{\vskip #1\baselineskip}
936 % @comment ...line which is ignored...
937 % @c is the same as @comment
938 % @ignore ... @end ignore is another way to write a comment
940 \def\comment{\begingroup \catcode`\^^M=
\other%
941 \catcode`\@=
\other \catcode`\
{=
\other \catcode`\
}=
\other%
943 {\catcode`\^^M=
\other \gdef\commentxxx#1^^M
{\endgroup}}
947 % @paragraphindent NCHARS
948 % We'll use ems for NCHARS, close enough.
949 % NCHARS can also be the word `asis' or `none'.
950 % We cannot feasibly implement @paragraphindent asis, though.
952 \def\asisword{asis
} % no translation, these are keywords
955 \parseargdef\paragraphindent{%
960 \defaultparindent =
0pt
962 \defaultparindent =
#1em
965 \parindent =
\defaultparindent
968 % @exampleindent NCHARS
969 % We'll use ems for NCHARS like @paragraphindent.
970 % It seems @exampleindent asis isn't necessary, but
971 % I preserve it to make it similar to @paragraphindent.
972 \parseargdef\exampleindent{%
979 \lispnarrowing =
#1em
984 % @firstparagraphindent WORD
985 % If WORD is `none', then suppress indentation of the first paragraph
986 % after a section heading. If WORD is `insert', then do indent at such
989 % The paragraph indentation is suppressed or not by calling
990 % \suppressfirstparagraphindent, which the sectioning commands do.
991 % We switch the definition of this back and forth according to WORD.
992 % By default, we suppress indentation.
994 \def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
995 \def\insertword{insert
}
997 \parseargdef\firstparagraphindent{%
1000 \let\suppressfirstparagraphindent =
\dosuppressfirstparagraphindent
1001 \else\ifx\temp\insertword
1002 \let\suppressfirstparagraphindent =
\relax
1004 \errhelp =
\EMsimple
1005 \errmessage{Unknown @firstparagraphindent option `
\temp'
}%
1009 % Here is how we actually suppress indentation. Redefine \everypar to
1010 % \kern backwards by \parindent, and then reset itself to empty.
1012 % We also make \indent itself not actually do anything until the next
1015 \gdef\dosuppressfirstparagraphindent{%
1016 \gdef\indent {\restorefirstparagraphindent \indent}%
1017 \gdef\noindent{\restorefirstparagraphindent \noindent}%
1018 \global\everypar =
{\kern -
\parindent \restorefirstparagraphindent}%
1021 \gdef\restorefirstparagraphindent{%
1022 \global\let\indent =
\ptexindent
1023 \global\let\noindent =
\ptexnoindent
1024 \global\everypar =
{}%
1028 % @refill is a no-op.
1031 % If working on a large document in chapters, it is convenient to
1032 % be able to disable indexing, cross-referencing, and contents, for test runs.
1033 % This is done with @novalidate (before @setfilename).
1035 \newif\iflinks \linkstrue % by default we want the aux files.
1036 \let\novalidate =
\linksfalse
1038 % @setfilename is done at the beginning of every texinfo file.
1039 % So open here the files we need to have open while reading the input.
1040 % This makes it possible to make a .fmt file for texinfo.
1042 \fixbackslash % Turn off hack to swallow `\input texinfo'.
1045 % Open the new aux file. TeX will close it automatically at exit.
1046 \immediate\openout\auxfile=
\jobname.aux
1047 \fi % \openindices needs to do some work in any case.
1049 \let\setfilename=
\comment % Ignore extra @setfilename cmds.
1051 % If texinfo.cnf is present on the system, read it.
1052 % Useful for site-wide @afourpaper, etc.
1053 \openin 1 texinfo.cnf
1054 \ifeof 1 \else \input texinfo.cnf
\fi
1057 \comment % Ignore the actual filename.
1060 % Called from \setfilename.
1072 \outer\def\bye{\pagealignmacro\tracingstats=
1\ptexend}
1076 % adobe `portable' document format
1080 \newcount\filenamelength
1089 \newif\ifpdfmakepagedest
1091 % when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
1092 % can be set). So we test for \relax and 0 as well as being undefined.
1093 \ifx\pdfoutput\thisisundefined
1095 \ifx\pdfoutput\relax
1104 % PDF uses PostScript string constants for the names of xref targets,
1105 % for display in the outlines, and in other places. Thus, we have to
1106 % double any backslashes. Otherwise, a name like "\node" will be
1107 % interpreted as a newline (\n), followed by o, d, e. Not good.
1109 % See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
1110 % related messages. The final outcome is that it is up to the TeX user
1111 % to double the backslashes and otherwise make the string valid, so
1112 % that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
1113 % do this reliably, so we use it.
1115 % #1 is a control sequence in which to do the replacements,
1117 \def\txiescapepdf#1{%
1118 \ifx\pdfescapestring\thisisundefined
1119 % No primitive available; should we give a warning or log?
1120 % Many times it won't matter.
1122 % The expandable \pdfescapestring primitive escapes parentheses,
1123 % backslashes, and other special chars.
1124 \xdef#1{\pdfescapestring{#1}}%
1128 \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
1129 with PDF output, and none of those formats could be found. (.eps cannot
1130 be supported due to the design of the PDF format; use regular TeX (DVI
1135 % Color manipulation macros using ideas from pdfcolor.tex,
1136 % except using rgb instead of cmyk; the latter is said to render as a
1137 % very dark gray on-screen and a very dark halftone in print, instead
1138 % of actual black. The dark red here is dark enough to print on paper as
1139 % nearly black, but still distinguishable for online viewing. We use
1140 % black by default, though.
1141 \def\rgbDarkRed{0.50 0.09 0.12}
1142 \def\rgbBlack{0 0 0}
1144 % k sets the color for filling (usual text, etc.);
1145 % K sets the color for stroking (thin rules, e.g., normal _'s).
1146 \def\pdfsetcolor#1{\pdfliteral{#1 rg
#1 RG
}}
1148 % Set color, and create a mark which defines \thiscolor accordingly,
1149 % so that \makeheadline knows which color to restore.
1151 \xdef\lastcolordefs{\gdef\noexpand\thiscolor{#1}}%
1156 \def\maincolor{\rgbBlack}
1157 \pdfsetcolor{\maincolor}
1158 \edef\thiscolor{\maincolor}
1159 \def\lastcolordefs{}
1163 \line{\pdfsetcolor{\maincolor}\the\footline}%
1171 % Extract \thiscolor definition from the marks.
1173 % Typeset the headline with \maincolor, then restore the color.
1174 \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
1182 \pdfcatalog{/PageMode /UseOutlines
}
1184 % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
1185 \def\dopdfimage#1#2#3{%
1186 \def\pdfimagewidth{#2}\setbox0 =
\hbox{\ignorespaces #2}%
1187 \def\pdfimageheight{#3}\setbox2 =
\hbox{\ignorespaces #3}%
1189 % pdftex (and the PDF format) support .pdf, .png, .jpg (among
1190 % others). Let's try in that order, PDF first since if
1191 % someone has a scalable image, presumably better to use that than a
1193 \let\pdfimgext=
\empty
1195 \openin 1 #1.pdf
\ifeof 1
1196 \openin 1 #1.PDF
\ifeof 1
1197 \openin 1 #1.png
\ifeof 1
1198 \openin 1 #1.jpg
\ifeof 1
1199 \openin 1 #1.jpeg
\ifeof 1
1200 \openin 1 #1.JPG
\ifeof 1
1201 \errhelp =
\nopdfimagehelp
1202 \errmessage{Could not find image file
#1 for pdf
}%
1203 \else \gdef\pdfimgext{JPG
}%
1205 \else \gdef\pdfimgext{jpeg
}%
1207 \else \gdef\pdfimgext{jpg
}%
1209 \else \gdef\pdfimgext{png
}%
1211 \else \gdef\pdfimgext{PDF
}%
1213 \else \gdef\pdfimgext{pdf
}%
1218 % without \immediate, ancient pdftex seg faults when the same image is
1219 % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
1220 \ifnum\pdftexversion <
14
1223 \immediate\pdfximage
1225 \ifdim \wd0 >
0pt width
\pdfimagewidth \fi
1226 \ifdim \wd2 >
0pt height
\pdfimageheight \fi
1227 \ifnum\pdftexversion<
13
1232 \ifnum\pdftexversion <
14 \else
1233 \pdfrefximage \pdflastximage
1237 % We have to set dummies so commands such as @code, and characters
1238 % such as \, aren't expanded when present in a section title.
1241 \makevalueexpandable
1242 \def\pdfdestname{#1}%
1243 \txiescapepdf\pdfdestname
1244 \safewhatsit{\pdfdest name
{\pdfdestname} xyz
}%
1247 % used to mark target names; must be expandable.
1250 % by default, use black for everything.
1251 \def\urlcolor{\rgbBlack}
1252 \def\linkcolor{\rgbBlack}
1253 \def\endlink{\setcolor{\maincolor}\pdfendlink}
1255 % Adding outlines to PDF; macros for calculating structure of outlines
1256 % come from Petr Olsak
1257 \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
1258 \else \csname#1\endcsname \fi}
1259 \def\advancenumber#1{\tempnum=
\expnumber{#1}\relax
1260 \advance\tempnum by
1
1261 \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
1263 % #1 is the section text, which is what will be displayed in the
1264 % outline by the pdf viewer. #2 is the pdf expression for the number
1265 % of subentries (or empty, for subsubsections). #3 is the node text,
1266 % which might be empty if this toc entry had no corresponding node.
1267 % #4 is the page number
1269 \def\dopdfoutline#1#2#3#4{%
1270 % Generate a link to the node text if that exists; else, use the
1271 % page number. We could generate a destination for the section
1272 % text in the case where a section has no node, but it doesn't
1273 % seem worth the trouble, since most documents are normally structured.
1274 \edef\pdfoutlinedest{#3}%
1275 \ifx\pdfoutlinedest\empty
1276 \def\pdfoutlinedest{#4}%
1278 \txiescapepdf\pdfoutlinedest
1281 % Also escape PDF chars in the display string.
1282 \edef\pdfoutlinetext{#1}%
1283 \txiescapepdf\pdfoutlinetext
1285 \pdfoutline goto name
{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}%
1288 \def\pdfmakeoutlines{%
1290 % Read toc silently, to get counts of subentries for \pdfoutline.
1291 \def\partentry#
#1#
#2#
#3#
#4{}% ignore parts in the outlines
1292 \def\numchapentry#
#1#
#2#
#3#
#4{%
1293 \def\thischapnum{#
#2}%
1295 \def\thissubsecnum{0}%
1297 \def\numsecentry#
#1#
#2#
#3#
#4{%
1298 \advancenumber{chap
\thischapnum}%
1299 \def\thissecnum{#
#2}%
1300 \def\thissubsecnum{0}%
1302 \def\numsubsecentry#
#1#
#2#
#3#
#4{%
1303 \advancenumber{sec
\thissecnum}%
1304 \def\thissubsecnum{#
#2}%
1306 \def\numsubsubsecentry#
#1#
#2#
#3#
#4{%
1307 \advancenumber{subsec
\thissubsecnum}%
1309 \def\thischapnum{0}%
1311 \def\thissubsecnum{0}%
1313 % use \def rather than \let here because we redefine \chapentry et
1314 % al. a second time, below.
1315 \def\appentry{\numchapentry}%
1316 \def\appsecentry{\numsecentry}%
1317 \def\appsubsecentry{\numsubsecentry}%
1318 \def\appsubsubsecentry{\numsubsubsecentry}%
1319 \def\unnchapentry{\numchapentry}%
1320 \def\unnsecentry{\numsecentry}%
1321 \def\unnsubsecentry{\numsubsecentry}%
1322 \def\unnsubsubsecentry{\numsubsubsecentry}%
1325 % Read toc second time, this time actually producing the outlines.
1326 % The `-' means take the \expnumber as the absolute number of
1327 % subentries, which we calculated on our first read of the .toc above.
1329 % We use the node names as the destinations.
1330 \def\numchapentry#
#1#
#2#
#3#
#4{%
1331 \dopdfoutline{#
#1}{count-
\expnumber{chap#
#2}}{#
#3}{#
#4}}%
1332 \def\numsecentry#
#1#
#2#
#3#
#4{%
1333 \dopdfoutline{#
#1}{count-
\expnumber{sec#
#2}}{#
#3}{#
#4}}%
1334 \def\numsubsecentry#
#1#
#2#
#3#
#4{%
1335 \dopdfoutline{#
#1}{count-
\expnumber{subsec#
#2}}{#
#3}{#
#4}}%
1336 \def\numsubsubsecentry#
#1#
#2#
#3#
#4{% count is always zero
1337 \dopdfoutline{#
#1}{}{#
#3}{#
#4}}%
1339 % PDF outlines are displayed using system fonts, instead of
1340 % document fonts. Therefore we cannot use special characters,
1341 % since the encoding is unknown. For example, the eogonek from
1342 % Latin 2 (0xea) gets translated to a | character. Info from
1343 % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
1345 % TODO this right, we have to translate 8-bit characters to
1346 % their "best" equivalent, based on the @documentencoding. Too
1347 % much work for too little return. Just use the ASCII equivalents
1348 % we use for the index sort strings.
1352 % We can have normal brace characters in the PDF outlines, unlike
1353 % Texinfo index files. So set that up.
1354 \def\
{{\lbracecharliteral}%
1355 \def\
}{\rbracecharliteral}%
1356 \catcode`\\=
\active \otherbackslash
1357 \input \tocreadfilename
1360 {\catcode`
[=
1 \catcode`
]=
2
1361 \catcode`
{=
\other \catcode`
}=
\other
1362 \gdef\lbracecharliteral[{]%
1363 \gdef\rbracecharliteral[}]%
1366 \def\skipspaces#1{\def\PP{#1}\def\D{|
}%
1367 \ifx\PP\D\let\nextsp\relax
1368 \else\let\nextsp\skipspaces
1369 \addtokens{\filename}{\PP}%
1370 \advance\filenamelength by
1
1373 \def\getfilename#1{%
1375 % If we don't expand the argument now, \skipspaces will get
1376 % snagged on things like "@value{foo}".
1378 \expandafter\skipspaces\temp|
\relax
1380 \ifnum\pdftexversion <
14
1381 \let \startlink \pdfannotlink
1383 \let \startlink \pdfstartlink
1385 % make a live url in pdf output.
1388 % it seems we really need yet another set of dummies; have not
1389 % tried to figure out what each command should do in the context
1390 % of @url. for now, just make @/ a no-op, that's the only one
1391 % people have actually reported a problem with.
1393 \normalturnoffactive
1396 \makevalueexpandable
1397 % do we want to go so far as to use \indexnofonts instead of just
1398 % special-casing \var here?
1401 \leavevmode\setcolor{\urlcolor}%
1402 \startlink attr
{/Border
[0 0 0]}%
1403 user
{/Subtype /Link /A << /S /URI /URI (
#1) >>
}%
1405 \def\pdfgettoks#1.
{\setbox\boxA=
\hbox{\toksA=
{#1.
}\toksB=
{}\maketoks}}
1406 \def\addtokens#1#2{\edef\addtoks{\noexpand#1=
{\the#1#2}}\addtoks}
1407 \def\adn#1{\addtokens{\toksC}{#1}\global\countA=
1\let\next=
\maketoks}
1408 \def\poptoks#1#2|ENDTOKS|
{\let\first=
#1\toksD=
{#1}\toksA=
{#2}}
1410 \expandafter\poptoks\the\toksA|ENDTOKS|
\relax
1412 \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
1413 \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
1414 \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
1416 \ifnum0=
\countA\else\makelink\fi
1417 \ifx\first.
\let\next=
\done\else
1419 \addtokens{\toksB}{\the\toksD}
1420 \ifx\first,
\addtokens{\toksB}{\space}\fi
1422 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
1424 \def\makelink{\addtokens{\toksB}%
1425 {\noexpand\pdflink{\the\toksC}}\toksC=
{}\global\countA=
0}
1427 \startlink attr
{/Border
[0 0 0]} goto name
{\pdfmkpgn{#1}}
1428 \setcolor{\linkcolor}#1\endlink}
1429 \def\done{\edef\st{\global\noexpand\toksA=
{\the\toksB}}\st}
1432 \let\pdfmkdest =
\gobble
1433 \let\pdfurl =
\gobble
1434 \let\endlink =
\relax
1435 \let\setcolor =
\gobble
1436 \let\pdfsetcolor =
\gobble
1437 \let\pdfmakeoutlines =
\relax
1438 \fi % \ifx\pdfoutput
1443 % Change the current font style to #1, remembering it in \curfontstyle.
1444 % For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
1445 % italics, not bold italics.
1447 \def\setfontstyle#1{%
1448 \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
1449 \csname ten
#1\endcsname % change the current font
1452 % Select #1 fonts with the current style.
1454 \def\selectfonts#1{\csname #1fonts
\endcsname \csname\curfontstyle\endcsname}
1456 \def\rm{\fam=
0 \setfontstyle{rm
}}
1457 \def\it{\fam=
\itfam \setfontstyle{it
}}
1458 \def\sl{\fam=
\slfam \setfontstyle{sl
}}
1459 \def\bf{\fam=
\bffam \setfontstyle{bf
}}\def\bfstylename{bf
}
1460 \def\tt{\fam=
\ttfam \setfontstyle{tt
}}
1462 % Unfortunately, we have to override this for titles and the like, since
1463 % in those cases "rm" is bold. Sigh.
1464 \def\rmisbold{\rm\def\curfontstyle{bf
}}
1466 % Texinfo sort of supports the sans serif font style, which plain TeX does not.
1467 % So we set up a \sf.
1469 \def\sf{\fam=
\sffam \setfontstyle{sf
}}
1470 \let\li =
\sf % Sometimes we call it \li, not \sf.
1472 % We don't need math for this font style.
1473 \def\ttsl{\setfontstyle{ttsl
}}
1476 % Set the baselineskip to #1, and the lineskip and strut size
1477 % correspondingly. There is no deep meaning behind these magic numbers
1478 % used as factors; they just match (closely enough) what Knuth defined.
1480 \def\lineskipfactor{.08333}
1481 \def\strutheightpercent{.70833}
1482 \def\strutdepthpercent {.29167}
1484 % can get a sort of poor man's double spacing by redefining this.
1485 \def\baselinefactor{1}
1487 \newdimen\textleading
1490 \normalbaselineskip =
\baselinefactor\dimen0
1491 \normallineskip =
\lineskipfactor\normalbaselineskip
1493 \setbox\strutbox =
\hbox{%
1494 \vrule width0pt height
\strutheightpercent\baselineskip
1495 depth
\strutdepthpercent \baselineskip
1499 % PDF CMaps. See also LaTeX's t1.cmap.
1501 % do nothing with this by default.
1502 \expandafter\let\csname cmapOT1
\endcsname\gobble
1503 \expandafter\let\csname cmapOT1IT
\endcsname\gobble
1504 \expandafter\let\csname cmapOT1TT
\endcsname\gobble
1506 % if we are producing pdf, and we have \pdffontattr, then define cmaps.
1507 % (\pdffontattr was introduced many years ago, but people still run
1508 % older pdftex's; it's easy to conditionalize, so we do.)
1509 \ifpdf \ifx\pdffontattr\thisisundefined \else
1511 \catcode`\^^M=
\active \def^^M
{^^J
}% Output line endings as the ^^J char.
1512 \catcode`\%=
12 \immediate\pdfobj stream
{%!PS-Adobe-3.0 Resource-CMap
1513 %%DocumentNeededResources: ProcSet (CIDInit)
1514 %%IncludeResource: ProcSet (CIDInit)
1515 %%BeginResource: CMap (TeX-OT1-0)
1516 %%Title: (TeX-OT1-0 TeX OT1 0)
1519 /CIDInit /ProcSet findresource begin
1527 /CMapName /TeX-OT1-
0 def
1529 1 begincodespacerange
1585 CMapName currentdict /CMap defineresource pop
1591 \expandafter\edef\csname cmapOT1
\endcsname#1{%
1592 \pdffontattr#1{/ToUnicode
\the\pdflastobj\space 0 R
}%
1597 \catcode`\^^M=
\active \def^^M
{^^J
}% Output line endings as the ^^J char.
1598 \catcode`\%=
12 \immediate\pdfobj stream
{%!PS-Adobe-3.0 Resource-CMap
1599 %%DocumentNeededResources: ProcSet (CIDInit)
1600 %%IncludeResource: ProcSet (CIDInit)
1601 %%BeginResource: CMap (TeX-OT1IT-0)
1602 %%Title: (TeX-OT1IT-0 TeX OT1IT 0)
1605 /CIDInit /ProcSet findresource begin
1613 /CMapName /TeX-OT1IT-
0 def
1615 1 begincodespacerange
1673 CMapName currentdict /CMap defineresource pop
1679 \expandafter\edef\csname cmapOT1IT
\endcsname#1{%
1680 \pdffontattr#1{/ToUnicode
\the\pdflastobj\space 0 R
}%
1685 \catcode`\^^M=
\active \def^^M
{^^J
}% Output line endings as the ^^J char.
1686 \catcode`\%=
12 \immediate\pdfobj stream
{%!PS-Adobe-3.0 Resource-CMap
1687 %%DocumentNeededResources: ProcSet (CIDInit)
1688 %%IncludeResource: ProcSet (CIDInit)
1689 %%BeginResource: CMap (TeX-OT1TT-0)
1690 %%Title: (TeX-OT1TT-0 TeX OT1TT 0)
1693 /CIDInit /ProcSet findresource begin
1701 /CMapName /TeX-OT1TT-
0 def
1703 1 begincodespacerange
1748 CMapName currentdict /CMap defineresource pop
1754 \expandafter\edef\csname cmapOT1TT
\endcsname#1{%
1755 \pdffontattr#1{/ToUnicode
\the\pdflastobj\space 0 R
}%
1760 % Set the font macro #1 to the font named \fontprefix#2.
1761 % #3 is the font's design size, #4 is a scale factor, #5 is the CMap
1762 % encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
1770 \def\setfont#1#2#3#4#5{%
1771 \font#1=
\fontprefix#2#3 scaled
#4
1772 \csname cmap
#5\endcsname#1%
1774 % This is what gets called when #5 of \setfont is empty.
1779 % Use cm as the default font prefix.
1780 % To specify the font prefix, you must define \fontprefix
1781 % before you read in texinfo.tex.
1782 \ifx\fontprefix\thisisundefined
1785 % Support font families that don't use the same naming scheme as CM.
1787 \def\rmbshape{bx
} % where the normal face is bold
1792 \def\ttslshape{sltt
}
1802 % Definitions for a main text size of 11pt. (The default in Texinfo.)
1804 \def\definetextfontsizexi{%
1805 % Text fonts (11.2pt, magstep1).
1806 \def\textnominalsize{11pt
}
1807 \edef\mainmagstep{\magstephalf}
1808 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1
}
1809 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT
}
1810 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1
}
1811 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT
}
1812 \setfont\textsl\slshape{10}{\mainmagstep}{OT1
}
1813 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1
}
1814 \setfont\textsc\scshape{10}{\mainmagstep}{OT1
}
1815 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT
}
1816 \font\texti=cmmi10 scaled
\mainmagstep
1817 \font\textsy=cmsy10 scaled
\mainmagstep
1818 \def\textecsize{1095}
1820 % A few fonts for @defun names and args.
1821 \setfont\defbf\bfshape{10}{\magstep1}{OT1
}
1822 \setfont\deftt\ttshape{10}{\magstep1}{OT1TT
}
1823 \setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT
}
1824 \def\df{\let\tentt=
\deftt \let\tenbf =
\defbf \let\tenttsl=
\defttsl \bf}
1826 % Fonts for indices, footnotes, small examples (9pt).
1827 \def\smallnominalsize{9pt
}
1828 \setfont\smallrm\rmshape{9}{1000}{OT1
}
1829 \setfont\smalltt\ttshape{9}{1000}{OT1TT
}
1830 \setfont\smallbf\bfshape{10}{900}{OT1
}
1831 \setfont\smallit\itshape{9}{1000}{OT1IT
}
1832 \setfont\smallsl\slshape{9}{1000}{OT1
}
1833 \setfont\smallsf\sfshape{9}{1000}{OT1
}
1834 \setfont\smallsc\scshape{10}{900}{OT1
}
1835 \setfont\smallttsl\ttslshape{10}{900}{OT1TT
}
1838 \def\smallecsize{0900}
1840 % Fonts for small examples (8pt).
1841 \def\smallernominalsize{8pt
}
1842 \setfont\smallerrm\rmshape{8}{1000}{OT1
}
1843 \setfont\smallertt\ttshape{8}{1000}{OT1TT
}
1844 \setfont\smallerbf\bfshape{10}{800}{OT1
}
1845 \setfont\smallerit\itshape{8}{1000}{OT1IT
}
1846 \setfont\smallersl\slshape{8}{1000}{OT1
}
1847 \setfont\smallersf\sfshape{8}{1000}{OT1
}
1848 \setfont\smallersc\scshape{10}{800}{OT1
}
1849 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT
}
1850 \font\smalleri=cmmi8
1851 \font\smallersy=cmsy8
1852 \def\smallerecsize{0800}
1854 % Fonts for title page (20.4pt):
1855 \def\titlenominalsize{20pt
}
1856 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1
}
1857 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT
}
1858 \setfont\titlesl\slbshape{10}{\magstep4}{OT1
}
1859 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT
}
1860 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT
}
1861 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1
}
1862 \let\titlebf=
\titlerm
1863 \setfont\titlesc\scbshape{10}{\magstep4}{OT1
}
1864 \font\titlei=cmmi12 scaled
\magstep3
1865 \font\titlesy=cmsy10 scaled
\magstep4
1866 \def\titleecsize{2074}
1868 % Chapter (and unnumbered) fonts (17.28pt).
1869 \def\chapnominalsize{17pt
}
1870 \setfont\chaprm\rmbshape{12}{\magstep2}{OT1
}
1871 \setfont\chapit\itbshape{10}{\magstep3}{OT1IT
}
1872 \setfont\chapsl\slbshape{10}{\magstep3}{OT1
}
1873 \setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT
}
1874 \setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT
}
1875 \setfont\chapsf\sfbshape{17}{1000}{OT1
}
1877 \setfont\chapsc\scbshape{10}{\magstep3}{OT1
}
1878 \font\chapi=cmmi12 scaled
\magstep2
1879 \font\chapsy=cmsy10 scaled
\magstep3
1880 \def\chapecsize{1728}
1882 % Section fonts (14.4pt).
1883 \def\secnominalsize{14pt
}
1884 \setfont\secrm\rmbshape{12}{\magstep1}{OT1
}
1885 \setfont\secit\itbshape{10}{\magstep2}{OT1IT
}
1886 \setfont\secsl\slbshape{10}{\magstep2}{OT1
}
1887 \setfont\sectt\ttbshape{12}{\magstep1}{OT1TT
}
1888 \setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT
}
1889 \setfont\secsf\sfbshape{12}{\magstep1}{OT1
}
1891 \setfont\secsc\scbshape{10}{\magstep2}{OT1
}
1892 \font\seci=cmmi12 scaled
\magstep1
1893 \font\secsy=cmsy10 scaled
\magstep2
1894 \def\sececsize{1440}
1896 % Subsection fonts (13.15pt).
1897 \def\ssecnominalsize{13pt
}
1898 \setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1
}
1899 \setfont\ssecit\itbshape{10}{1315}{OT1IT
}
1900 \setfont\ssecsl\slbshape{10}{1315}{OT1
}
1901 \setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT
}
1902 \setfont\ssecttsl\ttslshape{10}{1315}{OT1TT
}
1903 \setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1
}
1905 \setfont\ssecsc\scbshape{10}{1315}{OT1
}
1906 \font\sseci=cmmi12 scaled
\magstephalf
1907 \font\ssecsy=cmsy10 scaled
1315
1908 \def\ssececsize{1200}
1910 % Reduced fonts for @acro in text (10pt).
1911 \def\reducednominalsize{10pt
}
1912 \setfont\reducedrm\rmshape{10}{1000}{OT1
}
1913 \setfont\reducedtt\ttshape{10}{1000}{OT1TT
}
1914 \setfont\reducedbf\bfshape{10}{1000}{OT1
}
1915 \setfont\reducedit\itshape{10}{1000}{OT1IT
}
1916 \setfont\reducedsl\slshape{10}{1000}{OT1
}
1917 \setfont\reducedsf\sfshape{10}{1000}{OT1
}
1918 \setfont\reducedsc\scshape{10}{1000}{OT1
}
1919 \setfont\reducedttsl\ttslshape{10}{1000}{OT1TT
}
1920 \font\reducedi=cmmi10
1921 \font\reducedsy=cmsy10
1922 \def\reducedecsize{1000}
1924 \textleading =
13.2pt
% line spacing for 11pt CM
1925 \textfonts % reset the current fonts
1927 } % end of 11pt text font size definitions, \definetextfontsizexi
1930 % Definitions to make the main text be 10pt Computer Modern, with
1931 % section, chapter, etc., sizes following suit. This is for the GNU
1932 % Press printing of the Emacs 22 manual. Maybe other manuals in the
1933 % future. Used with @smallbook, which sets the leading to 12pt.
1935 \def\definetextfontsizex{%
1936 % Text fonts (10pt).
1937 \def\textnominalsize{10pt
}
1938 \edef\mainmagstep{1000}
1939 \setfont\textrm\rmshape{10}{\mainmagstep}{OT1
}
1940 \setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT
}
1941 \setfont\textbf\bfshape{10}{\mainmagstep}{OT1
}
1942 \setfont\textit\itshape{10}{\mainmagstep}{OT1IT
}
1943 \setfont\textsl\slshape{10}{\mainmagstep}{OT1
}
1944 \setfont\textsf\sfshape{10}{\mainmagstep}{OT1
}
1945 \setfont\textsc\scshape{10}{\mainmagstep}{OT1
}
1946 \setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT
}
1947 \font\texti=cmmi10 scaled
\mainmagstep
1948 \font\textsy=cmsy10 scaled
\mainmagstep
1949 \def\textecsize{1000}
1951 % A few fonts for @defun names and args.
1952 \setfont\defbf\bfshape{10}{\magstephalf}{OT1
}
1953 \setfont\deftt\ttshape{10}{\magstephalf}{OT1TT
}
1954 \setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT
}
1955 \def\df{\let\tentt=
\deftt \let\tenbf =
\defbf \let\tenttsl=
\defttsl \bf}
1957 % Fonts for indices, footnotes, small examples (9pt).
1958 \def\smallnominalsize{9pt
}
1959 \setfont\smallrm\rmshape{9}{1000}{OT1
}
1960 \setfont\smalltt\ttshape{9}{1000}{OT1TT
}
1961 \setfont\smallbf\bfshape{10}{900}{OT1
}
1962 \setfont\smallit\itshape{9}{1000}{OT1IT
}
1963 \setfont\smallsl\slshape{9}{1000}{OT1
}
1964 \setfont\smallsf\sfshape{9}{1000}{OT1
}
1965 \setfont\smallsc\scshape{10}{900}{OT1
}
1966 \setfont\smallttsl\ttslshape{10}{900}{OT1TT
}
1969 \def\smallecsize{0900}
1971 % Fonts for small examples (8pt).
1972 \def\smallernominalsize{8pt
}
1973 \setfont\smallerrm\rmshape{8}{1000}{OT1
}
1974 \setfont\smallertt\ttshape{8}{1000}{OT1TT
}
1975 \setfont\smallerbf\bfshape{10}{800}{OT1
}
1976 \setfont\smallerit\itshape{8}{1000}{OT1IT
}
1977 \setfont\smallersl\slshape{8}{1000}{OT1
}
1978 \setfont\smallersf\sfshape{8}{1000}{OT1
}
1979 \setfont\smallersc\scshape{10}{800}{OT1
}
1980 \setfont\smallerttsl\ttslshape{10}{800}{OT1TT
}
1981 \font\smalleri=cmmi8
1982 \font\smallersy=cmsy8
1983 \def\smallerecsize{0800}
1985 % Fonts for title page (20.4pt):
1986 \def\titlenominalsize{20pt
}
1987 \setfont\titlerm\rmbshape{12}{\magstep3}{OT1
}
1988 \setfont\titleit\itbshape{10}{\magstep4}{OT1IT
}
1989 \setfont\titlesl\slbshape{10}{\magstep4}{OT1
}
1990 \setfont\titlett\ttbshape{12}{\magstep3}{OT1TT
}
1991 \setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT
}
1992 \setfont\titlesf\sfbshape{17}{\magstep1}{OT1
}
1993 \let\titlebf=
\titlerm
1994 \setfont\titlesc\scbshape{10}{\magstep4}{OT1
}
1995 \font\titlei=cmmi12 scaled
\magstep3
1996 \font\titlesy=cmsy10 scaled
\magstep4
1997 \def\titleecsize{2074}
1999 % Chapter fonts (14.4pt).
2000 \def\chapnominalsize{14pt
}
2001 \setfont\chaprm\rmbshape{12}{\magstep1}{OT1
}
2002 \setfont\chapit\itbshape{10}{\magstep2}{OT1IT
}
2003 \setfont\chapsl\slbshape{10}{\magstep2}{OT1
}
2004 \setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT
}
2005 \setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT
}
2006 \setfont\chapsf\sfbshape{12}{\magstep1}{OT1
}
2008 \setfont\chapsc\scbshape{10}{\magstep2}{OT1
}
2009 \font\chapi=cmmi12 scaled
\magstep1
2010 \font\chapsy=cmsy10 scaled
\magstep2
2011 \def\chapecsize{1440}
2013 % Section fonts (12pt).
2014 \def\secnominalsize{12pt
}
2015 \setfont\secrm\rmbshape{12}{1000}{OT1
}
2016 \setfont\secit\itbshape{10}{\magstep1}{OT1IT
}
2017 \setfont\secsl\slbshape{10}{\magstep1}{OT1
}
2018 \setfont\sectt\ttbshape{12}{1000}{OT1TT
}
2019 \setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT
}
2020 \setfont\secsf\sfbshape{12}{1000}{OT1
}
2022 \setfont\secsc\scbshape{10}{\magstep1}{OT1
}
2024 \font\secsy=cmsy10 scaled
\magstep1
2025 \def\sececsize{1200}
2027 % Subsection fonts (10pt).
2028 \def\ssecnominalsize{10pt
}
2029 \setfont\ssecrm\rmbshape{10}{1000}{OT1
}
2030 \setfont\ssecit\itbshape{10}{1000}{OT1IT
}
2031 \setfont\ssecsl\slbshape{10}{1000}{OT1
}
2032 \setfont\ssectt\ttbshape{10}{1000}{OT1TT
}
2033 \setfont\ssecttsl\ttslshape{10}{1000}{OT1TT
}
2034 \setfont\ssecsf\sfbshape{10}{1000}{OT1
}
2036 \setfont\ssecsc\scbshape{10}{1000}{OT1
}
2039 \def\ssececsize{1000}
2041 % Reduced fonts for @acro in text (9pt).
2042 \def\reducednominalsize{9pt
}
2043 \setfont\reducedrm\rmshape{9}{1000}{OT1
}
2044 \setfont\reducedtt\ttshape{9}{1000}{OT1TT
}
2045 \setfont\reducedbf\bfshape{10}{900}{OT1
}
2046 \setfont\reducedit\itshape{9}{1000}{OT1IT
}
2047 \setfont\reducedsl\slshape{9}{1000}{OT1
}
2048 \setfont\reducedsf\sfshape{9}{1000}{OT1
}
2049 \setfont\reducedsc\scshape{10}{900}{OT1
}
2050 \setfont\reducedttsl\ttslshape{10}{900}{OT1TT
}
2051 \font\reducedi=cmmi9
2052 \font\reducedsy=cmsy9
2053 \def\reducedecsize{0900}
2055 \divide\parskip by
2 % reduce space between paragraphs
2056 \textleading =
12pt
% line spacing for 10pt CM
2057 \textfonts % reset the current fonts
2059 } % end of 10pt text font size definitions, \definetextfontsizex
2062 % We provide the user-level command
2064 % (or 11) to redefine the text font size. pt is assumed.
2070 \parseargdef\fonttextsize{%
2071 \def\textsizearg{#1}%
2072 %\wlog{doing @fonttextsize \textsizearg}%
2074 % Set \globaldefs so that documents can use this inside @tex, since
2075 % makeinfo 4.8 does not support it, but we need it nonetheless.
2077 \begingroup \globaldefs=
1
2078 \ifx\textsizearg\xword \definetextfontsizex
2079 \else \ifx\textsizearg\xiword \definetextfontsizexi
2082 \errmessage{@fonttextsize only supports `
10' or `
11', not `
\textsizearg'
}
2087 % In order for the font changes to affect most math symbols and letters,
2088 % we have to define the \textfont of the standard families. We don't
2089 % bother to reset \scriptfont and \scriptscriptfont; awaiting user need.
2091 \def\resetmathfonts{%
2092 \textfont0=
\tenrm \textfont1=
\teni \textfont2=
\tensy
2093 \textfont\itfam=
\tenit \textfont\slfam=
\tensl \textfont\bffam=
\tenbf
2094 \textfont\ttfam=
\tentt \textfont\sffam=
\tensf
2097 % The font-changing commands redefine the meanings of \tenSTYLE, instead
2098 % of just \STYLE. We do this because \STYLE needs to also set the
2099 % current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire
2100 % \tenSTYLE to set the current font.
2102 % Each font-changing command also sets the names \lsize (one size lower)
2103 % and \lllsize (three sizes lower). These relative commands are used
2104 % in, e.g., the LaTeX logo and acronyms.
2106 % This all needs generalizing, badly.
2109 \let\tenrm=
\textrm \let\tenit=
\textit \let\tensl=
\textsl
2110 \let\tenbf=
\textbf \let\tentt=
\texttt \let\smallcaps=
\textsc
2111 \let\tensf=
\textsf \let\teni=
\texti \let\tensy=
\textsy
2112 \let\tenttsl=
\textttsl
2113 \def\curfontsize{text
}%
2114 \def\lsize{reduced
}\def\lllsize{smaller
}%
2115 \resetmathfonts \setleading{\textleading}}
2117 \let\tenrm=
\titlerm \let\tenit=
\titleit \let\tensl=
\titlesl
2118 \let\tenbf=
\titlebf \let\tentt=
\titlett \let\smallcaps=
\titlesc
2119 \let\tensf=
\titlesf \let\teni=
\titlei \let\tensy=
\titlesy
2120 \let\tenttsl=
\titlettsl
2121 \def\curfontsize{title
}%
2122 \def\lsize{chap
}\def\lllsize{subsec
}%
2123 \resetmathfonts \setleading{27pt
}}
2124 \def\titlefont#1{{\titlefonts\rmisbold #1}}
2126 \let\tenrm=
\chaprm \let\tenit=
\chapit \let\tensl=
\chapsl
2127 \let\tenbf=
\chapbf \let\tentt=
\chaptt \let\smallcaps=
\chapsc
2128 \let\tensf=
\chapsf \let\teni=
\chapi \let\tensy=
\chapsy
2129 \let\tenttsl=
\chapttsl
2130 \def\curfontsize{chap
}%
2131 \def\lsize{sec
}\def\lllsize{text
}%
2132 \resetmathfonts \setleading{19pt
}}
2134 \let\tenrm=
\secrm \let\tenit=
\secit \let\tensl=
\secsl
2135 \let\tenbf=
\secbf \let\tentt=
\sectt \let\smallcaps=
\secsc
2136 \let\tensf=
\secsf \let\teni=
\seci \let\tensy=
\secsy
2137 \let\tenttsl=
\secttsl
2138 \def\curfontsize{sec
}%
2139 \def\lsize{subsec
}\def\lllsize{reduced
}%
2140 \resetmathfonts \setleading{17pt
}}
2142 \let\tenrm=
\ssecrm \let\tenit=
\ssecit \let\tensl=
\ssecsl
2143 \let\tenbf=
\ssecbf \let\tentt=
\ssectt \let\smallcaps=
\ssecsc
2144 \let\tensf=
\ssecsf \let\teni=
\sseci \let\tensy=
\ssecsy
2145 \let\tenttsl=
\ssecttsl
2146 \def\curfontsize{ssec
}%
2147 \def\lsize{text
}\def\lllsize{small
}%
2148 \resetmathfonts \setleading{15pt
}}
2149 \let\subsubsecfonts =
\subsecfonts
2151 \let\tenrm=
\reducedrm \let\tenit=
\reducedit \let\tensl=
\reducedsl
2152 \let\tenbf=
\reducedbf \let\tentt=
\reducedtt \let\reducedcaps=
\reducedsc
2153 \let\tensf=
\reducedsf \let\teni=
\reducedi \let\tensy=
\reducedsy
2154 \let\tenttsl=
\reducedttsl
2155 \def\curfontsize{reduced
}%
2156 \def\lsize{small
}\def\lllsize{smaller
}%
2157 \resetmathfonts \setleading{10.5pt
}}
2159 \let\tenrm=
\smallrm \let\tenit=
\smallit \let\tensl=
\smallsl
2160 \let\tenbf=
\smallbf \let\tentt=
\smalltt \let\smallcaps=
\smallsc
2161 \let\tensf=
\smallsf \let\teni=
\smalli \let\tensy=
\smallsy
2162 \let\tenttsl=
\smallttsl
2163 \def\curfontsize{small
}%
2164 \def\lsize{smaller
}\def\lllsize{smaller
}%
2165 \resetmathfonts \setleading{10.5pt
}}
2167 \let\tenrm=
\smallerrm \let\tenit=
\smallerit \let\tensl=
\smallersl
2168 \let\tenbf=
\smallerbf \let\tentt=
\smallertt \let\smallcaps=
\smallersc
2169 \let\tensf=
\smallersf \let\teni=
\smalleri \let\tensy=
\smallersy
2170 \let\tenttsl=
\smallerttsl
2171 \def\curfontsize{smaller
}%
2172 \def\lsize{smaller
}\def\lllsize{smaller
}%
2173 \resetmathfonts \setleading{9.5pt
}}
2175 % Fonts for short table of contents.
2176 \setfont\shortcontrm\rmshape{12}{1000}{OT1
}
2177 \setfont\shortcontbf\bfshape{10}{\magstep1}{OT1
} % no cmb12
2178 \setfont\shortcontsl\slshape{12}{1000}{OT1
}
2179 \setfont\shortconttt\ttshape{12}{1000}{OT1TT
}
2181 % Define these just so they can be easily changed for other fonts.
2182 \def\angleleft{$
\langle$
}
2183 \def\angleright{$
\rangle$
}
2185 % Set the fonts to use with the @small... environments.
2186 \let\smallexamplefonts =
\smallfonts
2188 % About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
2189 % can fit this many characters:
2190 % 8.5x11=86 smallbook=72 a4=90 a5=69
2191 % If we use \scriptfonts (8pt), then we can fit this many characters:
2192 % 8.5x11=90+ smallbook=80 a4=90+ a5=77
2193 % For me, subjectively, the few extra characters that fit aren't worth
2194 % the additional smallness of 8pt. So I'm making the default 9pt.
2196 % By the way, for comparison, here's what fits with @example (10pt):
2197 % 8.5x11=71 smallbook=60 a4=75 a5=58
2200 % Set up the default fonts, so we can use them for creating boxes.
2202 \definetextfontsizexi
2207 % Check if we are currently using a typewriter font. Since all the
2208 % Computer Modern typewriter fonts have zero interword stretch (and
2209 % shrink), and it is reasonable to expect all typewriter fonts to have
2210 % this property, we can check that font parameter.
2212 \def\ifmonospace{\ifdim\fontdimen3\font=
0pt
}
2214 % Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
2215 % define and register \INITMACRO to be called on markup style changes.
2216 % \INITMACRO can check \currentmarkupstyle for the innermost
2217 % style and the set of \ifmarkupSTYLE switches for all styles
2218 % currently in effect.
2222 %\newif\ifmarkupfile % @file == @samp.
2223 %\newif\ifmarkupoption % @option == @samp.
2226 %\newif\ifmarkupenv % @env == @code.
2227 %\newif\ifmarkupcommand % @command == @code.
2228 \newif\ifmarkuptex % @tex (and part of @math, for now).
2229 \newif\ifmarkupexample
2231 \newif\ifmarkupverbatim
2233 \let\currentmarkupstyle\empty
2235 \def\setupmarkupstyle#1{%
2236 \csname markup
#1true
\endcsname
2237 \def\currentmarkupstyle{#1}%
2241 \let\markupstylesetup\empty
2243 \def\defmarkupstylesetup#1{%
2244 \expandafter\def\expandafter\markupstylesetup
2245 \expandafter{\markupstylesetup #1}%
2249 % Markup style setup for left and right quotes.
2250 \defmarkupstylesetup\markupsetuplq{%
2251 \expandafter\let\expandafter \temp
2252 \csname markupsetuplq
\currentmarkupstyle\endcsname
2253 \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
2256 \defmarkupstylesetup\markupsetuprq{%
2257 \expandafter\let\expandafter \temp
2258 \csname markupsetuprq
\currentmarkupstyle\endcsname
2259 \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
2266 \gdef\markupsetuplqdefault{\let`
\lq}
2267 \gdef\markupsetuprqdefault{\let'
\rq}
2269 \gdef\markupsetcodequoteleft{\let`
\codequoteleft}
2270 \gdef\markupsetcodequoteright{\let'
\codequoteright}
2273 \let\markupsetuplqcode \markupsetcodequoteleft
2274 \let\markupsetuprqcode \markupsetcodequoteright
2276 \let\markupsetuplqexample \markupsetcodequoteleft
2277 \let\markupsetuprqexample \markupsetcodequoteright
2279 \let\markupsetuplqkbd \markupsetcodequoteleft
2280 \let\markupsetuprqkbd \markupsetcodequoteright
2282 \let\markupsetuplqsamp \markupsetcodequoteleft
2283 \let\markupsetuprqsamp \markupsetcodequoteright
2285 \let\markupsetuplqverb \markupsetcodequoteleft
2286 \let\markupsetuprqverb \markupsetcodequoteright
2288 \let\markupsetuplqverbatim \markupsetcodequoteleft
2289 \let\markupsetuprqverbatim \markupsetcodequoteright
2291 % Allow an option to not use regular directed right quote/apostrophe
2292 % (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
2293 % The undirected quote is ugly, so don't make it the default, but it
2294 % works for pasting with more pdf viewers (at least evince), the
2295 % lilypond developers report. xpdf does work with the regular 0x27.
2297 \def\codequoteright{%
2298 \expandafter\ifx\csname SETtxicodequoteundirected
\endcsname\relax
2299 \expandafter\ifx\csname SETcodequoteundirected
\endcsname\relax
2305 % and a similar option for the left quote char vs. a grave accent.
2306 % Modern fonts display ASCII 0x60 as a grave accent, so some people like
2307 % the code environments to do likewise.
2309 \def\codequoteleft{%
2310 \expandafter\ifx\csname SETtxicodequotebacktick
\endcsname\relax
2311 \expandafter\ifx\csname SETcodequotebacktick
\endcsname\relax
2312 % [Knuth] pp. 380,381,391
2313 % \relax disables Spanish ligatures ?` and !` of \tt font.
2319 % Commands to set the quote options.
2321 \parseargdef\codequoteundirected{%
2324 \expandafter\let\csname SETtxicodequoteundirected
\endcsname
2326 \else\ifx\temp\offword
2327 \expandafter\let\csname SETtxicodequoteundirected
\endcsname
2330 \errhelp =
\EMsimple
2331 \errmessage{Unknown @codequoteundirected value `
\temp', must be on|off
}%
2335 \parseargdef\codequotebacktick{%
2338 \expandafter\let\csname SETtxicodequotebacktick
\endcsname
2340 \else\ifx\temp\offword
2341 \expandafter\let\csname SETtxicodequotebacktick
\endcsname
2344 \errhelp =
\EMsimple
2345 \errmessage{Unknown @codequotebacktick value `
\temp', must be on|off
}%
2349 % [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
2350 \def\noligaturesquoteleft{\relax\lq}
2352 % Count depth in font-changes, for error checks
2353 \newcount\fontdepth \fontdepth=
0
2357 % #1 is the font command (\sl or \it), #2 is the text to slant.
2358 % If we are in a monospaced environment, however, 1) always use \ttsl,
2359 % and 2) do not add an italic correction.
2360 \def\dosmartslant#1#2{%
2362 {{\ttsl #2}\let\next=
\relax}%
2363 {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
2366 \def\smartslanted{\dosmartslant\sl}
2367 \def\smartitalic{\dosmartslant\it}
2369 % Output an italic correction unless \next (presumed to be the following
2370 % character) is such as not to need one.
2371 \def\smartitaliccorrection{%
2376 \else\ifx\next\comma%
2382 % Unconditional use \ttsl, and no ic. @var is set to this for defuns.
2383 \def\ttslanted#1{{\ttsl #1}}
2385 % @cite is like \smartslanted except unconditionally use \sl. We never want
2386 % ttsl for book titles, do we?
2387 \def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
2391 \let\saveaftersmartic =
\aftersmartic
2392 \def\aftersmartic{\null\let\aftersmartic=
\saveaftersmartic}%
2397 \let\slanted=
\smartslanted
2398 \let\dfn=
\smartslanted
2399 \let\emph=
\smartitalic
2401 % Explicit font changes: @r, @sc, undocumented @ii.
2402 \def\r#1{{\rm #1}} % roman font
2403 \def\sc#1{{\smallcaps#1}} % smallcaps font
2404 \def\ii#1{{\it #1}} % italic font
2406 % @b, explicit bold. Also @strong.
2410 % @sansserif, explicit sans.
2411 \def\sansserif#1{{\sf #1}}
2413 % We can't just use \exhyphenpenalty, because that only has effect at
2414 % the end of a paragraph. Restore normal hyphenation at the end of the
2415 % group within which \nohyphenation is presumably called.
2417 \def\nohyphenation{\hyphenchar\font = -
1 \aftergroup\restorehyphenation}
2418 \def\restorehyphenation{\hyphenchar\font = `-
}
2420 % Set sfcode to normal for the chars that usually have another value.
2421 % Can't use plain's \frenchspacing because it uses the `\x notation, and
2422 % sometimes \x has an active definition that messes things up.
2425 \def\plainfrenchspacing{%
2426 \sfcode\dotChar =\@m
\sfcode\questChar=\@m
\sfcode\exclamChar=\@m
2427 \sfcode\colonChar=\@m
\sfcode\semiChar =\@m
\sfcode\commaChar =\@m
2428 \def\endofsentencespacefactor{1000}% for @. and friends
2430 \def\plainnonfrenchspacing{%
2431 \sfcode`\
.3000\sfcode`\?
3000\sfcode`\!
3000
2432 \sfcode`\:
2000\sfcode`\;
1500\sfcode`\,
1250
2433 \def\endofsentencespacefactor{3000}% for @. and friends
2436 \def\endofsentencespacefactor{3000}% default
2438 % @t, explicit typewriter.
2440 {\tt \rawbackslash \plainfrenchspacing #1}%
2445 \def\samp#1{{\setupmarkupstyle{samp
}\lq\tclose{#1}\rq\null}}
2447 % @indicateurl is \samp, that is, with quotes.
2448 \let\indicateurl=
\samp
2450 % @code (and similar) prints in typewriter, but with spaces the same
2451 % size as normal in the surrounding text, without hyphenation, etc.
2452 % This is a subroutine for that.
2455 % Change normal interword space to be same as for the current font.
2456 \spaceskip =
\fontdimen2\font
2458 % Switch to typewriter.
2461 % But `\ ' produces the large typewriter interword space.
2462 \def\
{{\spaceskip =
0pt
{} }}%
2464 % Turn off hyphenation.
2471 \null % reset spacefactor to 1000
2474 % We *must* turn on hyphenation at `-' and `_' in @code.
2475 % (But see \codedashfinish below.)
2476 % Otherwise, it is too hard to avoid overfull hboxes
2477 % in the Emacs manual, the Library manual, etc.
2479 % Unfortunately, TeX uses one parameter (\hyphenchar) to control
2480 % both hyphenation at - and hyphenation within words.
2481 % We must therefore turn them both off (\tclose does that)
2482 % and arrange explicitly to hyphenate at a dash. -- rms.
2484 \catcode`\-=
\active \catcode`
\_=
\active
2485 \catcode`\'=
\active \catcode`\`=
\active
2486 \global\let'=
\rq \global\let`=
\lq % default definitions
2488 \global\def\code{\begingroup
2489 \setupmarkupstyle{code
}%
2490 % The following should really be moved into \setupmarkupstyle handlers.
2491 \catcode\dashChar=
\active \catcode\underChar=
\active
2499 % Given -foo (with a single dash), we do not want to allow a break
2501 \global\let\codedashprev=
\codedash
2506 \gdef\codedash{\futurelet\next\codedashfinish}
2507 \gdef\codedashfinish{%
2508 \normaldash % always output the dash character itself.
2510 % Now, output a discretionary to allow a line break, unless
2511 % (a) the next character is a -, or
2512 % (b) the preceding character is a -.
2513 % E.g., given --posix, we do not want to allow a break after either -.
2514 % Given --foo-bar, we do want to allow a break between the - and the b.
2515 \ifx\next\codedash \else
2516 \ifx\codedashprev\codedash
2517 \else \discretionary{}{}{}\fi
2519 % we need the space after the = for the case when \next itself is a
2520 % space token; it would get swallowed otherwise. As in @code{- a}.
2521 \global\let\codedashprev=
\next
2526 \def\codex #1{\tclose{#1}\endgroup}
2529 % this is all so @math{@code{var_name}+1} can work. In math mode, _
2530 % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
2531 % will therefore expand the active definition of _, which is us
2532 % (inside @code that is), therefore an endless loop.
2534 \mathchar"
075F
% class 0=ordinary, family 7=ttfam, pos 0x5F=_.
2535 \else\normalunderscore \fi
2536 \discretionary{}{}{}}%
2540 % An additional complication: the above will allow breaks after, e.g.,
2541 % each of the four underscores in __typeof__. This is bad.
2542 % @allowcodebreaks provides a document-level way to turn breaking at -
2545 \newif\ifallowcodebreaks \allowcodebreakstrue
2547 \def\keywordtrue{true
}
2548 \def\keywordfalse{false
}
2550 \parseargdef\allowcodebreaks{%
2552 \ifx\txiarg\keywordtrue
2553 \allowcodebreakstrue
2554 \else\ifx\txiarg\keywordfalse
2555 \allowcodebreaksfalse
2557 \errhelp =
\EMsimple
2558 \errmessage{Unknown @allowcodebreaks option `
\txiarg', must be true|false
}%
2562 % For @command, @env, @file, @option quotes seem unnecessary,
2563 % so use \code rather than \samp.
2569 % @uref (abbreviation for `urlref') aka @url takes an optional
2570 % (comma-separated) second argument specifying the text to display and
2571 % an optional third arg as text to display instead of (rather than in
2572 % addition to) the url itself. First (mandatory) arg is the url.
2574 % TeX-only option to allow changing PDF output to show only the second
2575 % arg (if given), and not the url (which is then just the link target).
2576 \newif\ifurefurlonlylink
2578 % The main macro is \urefbreak, which allows breaking at expected
2579 % places within the url. (There used to be another version, which
2580 % didn't support automatic breaking.)
2581 \def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
2582 \let\uref=
\urefbreak
2584 \def\dourefbreak#1{\urefbreakfinish #1,,,
\finish}
2585 \def\urefbreakfinish#1,
#2,
#3,
#4\finish{% doesn't work in @example
2588 \setbox0 =
\hbox{\ignorespaces #3}%
2590 \unhbox0 % third arg given, show only that
2592 \setbox0 =
\hbox{\ignorespaces #2}% look for second arg
2596 % PDF plus option to not display url, show just arg
2599 % PDF, normally display both arg and url for consistency,
2600 % visibility, if the pdf is eventually used to print, etc.
2601 \unhbox0\ (
\urefcode{#1})
%
2604 \unhbox0\ (
\urefcode{#1})
% DVI, always show arg and url
2607 \urefcode{#1}% only url given, so show it
2613 % Allow line breaks around only a few characters (only).
2615 \catcode\ampChar=
\active \catcode\dotChar=
\active
2616 \catcode\hashChar=
\active \catcode\questChar=
\active
2617 \catcode\slashChar=
\active
2622 \global\def\urefcode{\begingroup
2623 \setupmarkupstyle{code
}%
2633 % By default, they are just regular characters.
2634 \global\def&
{\normalamp}
2635 \global\def.
{\normaldot}
2636 \global\def#
{\normalhash}
2637 \global\def?
{\normalquest}
2638 \global\def/
{\normalslash}
2641 % we put a little stretch before and after the breakable chars, to help
2642 % line breaking of long url's. The unequal skips make look better in
2643 % cmtt at least, especially for dots.
2644 \def\urefprestretchamount{.13em
}
2645 \def\urefpoststretchamount{.1em
}
2646 \def\urefprestretch{\urefprebreak \hskip0pt plus
\urefprestretchamount\relax}
2647 \def\urefpoststretch{\urefpostbreak \hskip0pt plus
\urefprestretchamount\relax}
2649 \def\urefcodeamp{\urefprestretch \&
\urefpoststretch}
2650 \def\urefcodedot{\urefprestretch .
\urefpoststretch}
2651 \def\urefcodehash{\urefprestretch \#
\urefpoststretch}
2652 \def\urefcodequest{\urefprestretch ?
\urefpoststretch}
2653 \def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
2656 \global\def\urefcodeslashfinish{%
2657 \urefprestretch \slashChar
2658 % Allow line break only after the final / in a sequence of
2659 % slashes, to avoid line break between the slashes in http://.
2660 \ifx\next/
\else \urefpoststretch \fi
2664 % One more complication: by default we'll break after the special
2665 % characters, but some people like to break before the special chars, so
2666 % allow that. Also allow no breaking at all, for manual control.
2668 \parseargdef\urefbreakstyle{%
2670 \ifx\txiarg\wordnone
2671 \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
2672 \else\ifx\txiarg\wordbefore
2673 \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak}
2674 \else\ifx\txiarg\wordafter
2675 \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak}
2677 \errhelp =
\EMsimple
2678 \errmessage{Unknown @urefbreakstyle setting `
\txiarg'
}%
2681 \def\wordafter{after
}
2682 \def\wordbefore{before
}
2685 \urefbreakstyle after
2687 % @url synonym for @uref, since that's how everyone uses it.
2691 % rms does not like angle brackets --karl, 17may97.
2692 % So now @email is just like @uref, unless we are pdf.
2694 %\def\email#1{\angleleft{\tt #1}\angleright}
2696 \def\email#1{\doemail#1,,
\finish}
2697 \def\doemail#1,
#2,
#3\finish{\begingroup
2700 \setbox0 =
\hbox{\ignorespaces #2}%
2701 \ifdim\wd0>
0pt
\unhbox0\else\code{#1}\fi
2708 % @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
2709 % `example' (@kbd uses ttsl only inside of @example and friends),
2710 % or `code' (@kbd uses normal tty font always).
2711 \parseargdef\kbdinputstyle{%
2713 \ifx\txiarg\worddistinct
2714 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
2715 \else\ifx\txiarg\wordexample
2716 \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
2717 \else\ifx\txiarg\wordcode
2718 \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
2720 \errhelp =
\EMsimple
2721 \errmessage{Unknown @kbdinputstyle setting `
\txiarg'
}%
2724 \def\worddistinct{distinct
}
2725 \def\wordexample{example
}
2728 % Default is `distinct'.
2729 \kbdinputstyle distinct
2731 % @kbd is like @code, except that if the argument is just one @key command,
2732 % then @kbd has no effect.
2733 \def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??
\par}}
2736 \def\kbdsub#1#2#3\par{%
2737 \def\one{#1}\def\three{#3}\def\threex{??
}%
2738 \ifx\one\xkey\ifx\threex\three \key{#2}%
2739 \else{\tclose{\kbdfont\setupmarkupstyle{kbd
}\look}}\fi
2740 \else{\tclose{\kbdfont\setupmarkupstyle{kbd
}\look}}\fi
2743 % definition of @key that produces a lozenge. Doesn't adjust to text size.
2744 %\setfont\keyrm\rmshape{8}{1000}{OT1}
2746 %\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
2747 % \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
2748 % \vbox{\hrule\kern-0.4pt
2749 % \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
2750 % \kern-0.4pt\hrule}%
2751 % \kern-.06em\raise0.4pt\hbox{\angleright}}}}
2753 % definition of @key with no lozenge. If the current font is already
2754 % monospace, don't change it; that way, we respect @kbdinputstyle. But
2755 % if it isn't monospace, then use \tt.
2757 \def\key#1{{\setupmarkupstyle{key
}%
2759 \ifmonospace\else\tt\fi
2762 % @clicksequence{File @click{} Open ...}
2763 \def\clicksequence#1{\begingroup #1\endgroup}
2765 % @clickstyle @arrow (by default)
2766 \parseargdef\clickstyle{\def\click{#1}}
2769 % Typeset a dimension, e.g., `in' or `pt'. The only reason for the
2770 % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
2772 \def\dmn#1{\thinspace #1}
2774 % @l was never documented to mean ``switch to the Lisp font'',
2775 % and it is not used as such in any manual I can find. We need it for
2776 % Polish suppressed-l. --karl, 22sep96.
2777 %\def\l#1{{\li #1}\null}
2779 % @acronym for "FBI", "NATO", and the like.
2780 % We print this one point size smaller, since it's intended for
2783 \def\acronym#1{\doacronym #1,,
\finish}
2784 \def\doacronym#1,
#2,
#3\finish{%
2785 {\selectfonts\lsize #1}%
2787 \ifx\temp\empty \else
2788 \space (
{\unsepspaces \ignorespaces \temp \unskip})
%
2790 \null % reset \spacefactor=1000
2793 % @abbr for "Comput. J." and the like.
2794 % No font change, but don't do end-of-sentence spacing.
2796 \def\abbr#1{\doabbr #1,,
\finish}
2797 \def\doabbr#1,
#2,
#3\finish{%
2798 {\plainfrenchspacing #1}%
2800 \ifx\temp\empty \else
2801 \space (
{\unsepspaces \ignorespaces \temp \unskip})
%
2803 \null % reset \spacefactor=1000
2806 % @asis just yields its argument. Used with @table, for example.
2810 % @math outputs its argument in math mode.
2812 % One complication: _ usually means subscripts, but it could also mean
2813 % an actual _ character, as in @math{@var{some_variable} + 1}. So make
2814 % _ active, and distinguish by seeing if the current family is \slfam,
2815 % which is what @var uses.
2817 \catcode`
\_ =
\active
2818 \gdef\mathunderscore{%
2820 \def_{\ifnum\fam=
\slfam \_\else\sb\fi}%
2823 % Another complication: we want \\ (and @\) to output a math (or tt) \.
2824 % FYI, plain.tex uses \\ as a temporary control sequence (for no
2825 % particular reason), but this is not advertised and we don't care.
2827 % The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
2828 \def\mathbackslash{\ifnum\fam=
\ttfam \mathchar"
075C
\else\backslash \fi}
2833 \let\\ =
\mathbackslash
2835 % make the texinfo accent commands work in math mode
2845 % have to provide another name for sup operator
2849 \def\finishmath#1{#1$
\endgroup} % Close the group opened by \tex.
2851 % Some active characters (such as <) are spaced differently in math.
2852 % We have to reset their definitions in case the @math was an argument
2853 % to a command which sets the catcodes (such as @item or @section).
2856 \catcode`^ =
\active
2857 \catcode`< =
\active
2858 \catcode`> =
\active
2859 \catcode`+ =
\active
2860 \catcode`' =
\active
2866 \let' =
\ptexquoteright
2870 % for @sub and @sup, if in math mode, just do a normal sub/superscript.
2871 % If in text, use math to place as sub/superscript, but switch
2872 % into text mode, with smaller fonts. This is a different font than the
2873 % one used for real math sub/superscripts (8pt vs. 7pt), but let's not
2874 % fix it (significant additions to font machinery) until someone notices.
2876 \def\sub{\ifmmode \expandafter\sb \else \expandafter\finishsub\fi}
2877 \def\finishsub#1{$
\sb{\hbox{\selectfonts\lllsize #1}}$
}%
2879 \def\sup{\ifmmode \expandafter\ptexsp \else \expandafter\finishsup\fi}
2880 \def\finishsup#1{$
\ptexsp{\hbox{\selectfonts\lllsize #1}}$
}%
2882 % ctrl is no longer a Texinfo command, but leave this definition for fun.
2883 \def\ctrl #1{{\tt \rawbackslash \hat}#1}
2885 % @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
2886 % Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
2887 % except specified as a normal braced arg, so no newlines to worry about.
2889 \def\outfmtnametex{tex
}
2891 \long\def\inlinefmt#1{\doinlinefmt #1,
\finish}
2892 \long\def\doinlinefmt#1,
#2,
\finish{%
2893 \def\inlinefmtname{#1}%
2894 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
2897 % @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
2898 % FMTNAME is tex, else ELSE-TEXT.
2899 \long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,
\finish}
2900 \long\def\doinlinefmtifelse#1,
#2,
#3,
#4,
\finish{%
2901 \def\inlinefmtname{#1}%
2902 \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
2905 % For raw, must switch into @tex before parsing the argument, to avoid
2906 % setting catcodes prematurely. Doing it this way means that, for
2907 % example, @inlineraw{html, foo{bar} gets a parse error instead of being
2908 % ignored. But this isn't important because if people want a literal
2909 % *right* brace they would have to use a command anyway, so they may as
2910 % well use a command to get a left brace too. We could re-use the
2911 % delimiter character idea from \verb, but it seems like overkill.
2913 \long\def\inlineraw{\tex \doinlineraw}
2914 \long\def\doinlineraw#1{\doinlinerawtwo #1,
\finish}
2915 \def\doinlinerawtwo#1,
#2,
\finish{%
2916 \def\inlinerawname{#1}%
2917 \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
2918 \endgroup % close group opened by \tex.
2921 % @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
2923 \long\def\inlineifset#1{\doinlineifset #1,
\finish}
2924 \long\def\doinlineifset#1,
#2,
\finish{%
2925 \def\inlinevarname{#1}%
2926 \expandafter\ifx\csname SET
\inlinevarname\endcsname\relax
2927 \else\ignorespaces#2\fi
2930 % @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
2932 \long\def\inlineifclear#1{\doinlineifclear #1,
\finish}
2933 \long\def\doinlineifclear#1,
#2,
\finish{%
2934 \def\inlinevarname{#1}%
2935 \expandafter\ifx\csname SET
\inlinevarname\endcsname\relax \ignorespaces#2\fi
2942 % @@ prints an @, as does @atchar{}.
2946 % @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
2947 % Unless we're in typewriter, use \ecfont because the CM text fonts do
2948 % not have braces, and we don't want to switch into math.
2949 \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}}
2950 \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}}
2951 \let\
{=
\mylbrace \let\lbracechar=\
{
2952 \let\
}=
\myrbrace \let\rbracechar=\
}
2954 % Definitions to produce \{ and \} commands for indices,
2955 % and @{ and @} for the aux/toc files.
2956 \catcode`\
{ =
\other \catcode`\
} =
\other
2957 \catcode`\
[ =
1 \catcode`\
] =
2
2958 \catcode`\! =
0 \catcode`\\ =
\other
2959 !gdef!lbracecmd
[\
{]%
2960 !gdef!rbracecmd
[\
}]%
2961 !gdef!lbraceatcmd
[@
{]%
2962 !gdef!rbraceatcmd
[@
}]%
2965 % @comma{} to avoid , parsing problems.
2968 % Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
2969 % Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
2971 \let\dotaccent =
\ptexdot
2972 \def\ringaccent#1{{\accent23 #1}}
2973 \let\tieaccent =
\ptext
2974 \let\ubaraccent =
\ptexb
2975 \let\udotaccent =
\d
2977 % Other special characters: @questiondown @exclamdown @ordf @ordm
2978 % Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
2979 \def\questiondown{?`
}
2981 \def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a
}}}
2982 \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o
}}}
2984 % Dotless i and dotless j, used for accents.
2989 \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
2990 \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
2991 \else \errmessage{@dotless can be used only with i or j
}%
2995 % The \TeX{} logo, as in plain, but resetting the spacing so that a
2996 % period following counts as ending a sentence. (Idea found in latex.)
2998 \edef\TeX{\TeX \spacefactor=
1000 }
3000 % @LaTeX{} logo. Not quite the same results as the definition in
3001 % latex.ltx, since we use a different font for the raised A; it's most
3002 % convenient for us to use an explicitly smaller font, rather than using
3003 % the \scriptstyle font (since we don't reset \scriptstyle and
3004 % \scriptscriptstyle).
3009 \vbox to
\ht0{\hbox{%
3010 \ifx\textnominalsize\xwordpt
3011 % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX.
3012 % Revert to plain's \scriptsize, which is 7pt.
3013 \count255=
\the\fam $
\fam\count255 \scriptstyle A$
%
3015 % For 11pt, we can use our lllsize.
3016 \selectfonts\lllsize A
%
3025 % Some math mode symbols.
3026 \def\bullet{$
\ptexbullet$
}
3027 \def\geq{\ifmmode \ge\else $
\ge$
\fi}
3028 \def\leq{\ifmmode \le\else $
\le$
\fi}
3029 \def\minus{\ifmmode -
\else $-$
\fi}
3031 % @dots{} outputs an ellipsis using the current font.
3032 % We do .5em per period so that it has the same spacing in the cm
3033 % typewriter fonts as three actual period characters; on the other hand,
3034 % in other typewriter fonts three periods are wider than 1.5em. So do
3035 % whichever is larger.
3039 \setbox0=
\hbox{...
}% get width of three periods
3046 \hskip 0pt plus
.25fil
3047 .
\hskip 0pt plus1fil
3048 .
\hskip 0pt plus1fil
3049 .
\hskip 0pt plus
.5fil
3053 % @enddots{} is an end-of-sentence ellipsis.
3057 \spacefactor=
\endofsentencespacefactor
3060 % @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
3062 % Since these characters are used in examples, they should be an even number of
3063 % \tt widths. Each \tt character is 1en, so two makes it 1em.
3066 \def\arrow{\leavevmode\raise.05ex
\hbox to
1em
{\hfil$
\rightarrow$
\hfil}}
3067 \def\result{\leavevmode\raise.05ex
\hbox to
1em
{\hfil$
\Rightarrow$
\hfil}}
3068 \def\expansion{\leavevmode\hbox to
1em
{\hfil$
\mapsto$
\hfil}}
3069 \def\print{\leavevmode\lower.1ex
\hbox to
1em
{\hfil$
\dashv$
\hfil}}
3070 \def\equiv{\leavevmode\hbox to
1em
{\hfil$
\ptexequiv$
\hfil}}
3072 % The @error{} command.
3073 % Adapted from the TeXbook's \boxit.
3077 {\tentt \global\dimen0 =
3em
}% Width of the box.
3078 \dimen2 =
.55pt
% Thickness of rules
3079 % The text. (`r' is open on the right, `e' somewhat less so on the left.)
3080 \setbox0 =
\hbox{\kern-
.75pt
\reducedsf \putworderror\kern-
1.5pt
}
3082 \setbox\errorbox=
\hbox to
\dimen0{\hfil
3083 \hsize =
\dimen0 \advance\hsize by -
5.8pt
% Space to left+right.
3084 \advance\hsize by -
2\dimen2 % Rules.
3086 \hrule height
\dimen2
3087 \hbox{\vrule width
\dimen2 \kern3pt % Space to left of text.
3088 \vtop{\kern2.4pt
\box0 \kern2.4pt
}% Space above/below.
3089 \kern3pt\vrule width
\dimen2}% Space to right.
3090 \hrule height
\dimen2}
3093 \def\error{\leavevmode\lower.7ex
\copy\errorbox}
3095 % @pounds{} is a sterling sign, which Knuth put in the CM italic font.
3097 \def\pounds{{\it\$
}}
3099 % @euro{} comes from a separate font, depending on the current style.
3100 % We use the free feym* fonts from the eurosym package by Henrik
3101 % Theiling, which support regular, slanted, bold and bold slanted (and
3102 % "outlined" (blackboard board, sort of) versions, which we don't need).
3103 % It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
3105 % Although only regular is the truly official Euro symbol, we ignore
3106 % that. The Euro is designed to be slightly taller than the regular
3112 % feybo - bold slanted
3114 % There is no good (free) typewriter version, to my knowledge.
3115 % A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
3118 % Also doesn't work in math. Do we need to do math with euro symbols?
3122 \def\euro{{\eurofont e
}}
3124 % We set the font at each command, rather than predefining it in
3125 % \textfonts and the other font-switching commands, so that
3126 % installations which never need the symbol don't have to have the
3129 % There is only one designed size (nominal 10pt), so we always scale
3130 % that to the current nominal size.
3132 % By the way, simply using "at 1em" works for cmr10 and the like, but
3133 % does not work for cmbx10 and other extended/shrunken fonts.
3135 \def\eurosize{\csname\curfontsize nominalsize
\endcsname}%
3137 \ifx\curfontstyle\bfstylename
3139 \font\thiseurofont =
\ifusingit{feybo10
}{feybr10
} at
\eurosize
3142 \font\thiseurofont =
\ifusingit{feymo10
}{feymr10
} at
\eurosize
3147 % Glyphs from the EC fonts. We don't use \let for the aliases, because
3148 % sometimes we redefine the original macro, and the alias should reflect
3151 % Use LaTeX names for the Icelandic letters.
3152 \def\DH{{\ecfont \char"D0
}} % Eth
3153 \def\dh{{\ecfont \char"F0
}} % eth
3154 \def\TH{{\ecfont \char"DE
}} % Thorn
3155 \def\th{{\ecfont \char"FE
}} % thorn
3157 \def\guillemetleft{{\ecfont \char"
13}}
3158 \def\guillemotleft{\guillemetleft}
3159 \def\guillemetright{{\ecfont \char"
14}}
3160 \def\guillemotright{\guillemetright}
3161 \def\guilsinglleft{{\ecfont \char"
0E
}}
3162 \def\guilsinglright{{\ecfont \char"
0F
}}
3163 \def\quotedblbase{{\ecfont \char"
12}}
3164 \def\quotesinglbase{{\ecfont \char"
0D
}}
3166 % This positioning is not perfect (see the ogonek LaTeX package), but
3167 % we have the precomposed glyphs for the most common cases. We put the
3168 % tests to use those glyphs in the single \ogonek macro so we have fewer
3169 % dummy definitions to worry about for index entries, etc.
3171 % ogonek is also used with other letters in Lithuanian (IOU), but using
3172 % the precomposed glyphs for those is not so easy since they aren't in
3176 \ifx\temp\macrocharA\Aogonek
3177 \else\ifx\temp\macrochara\aogonek
3178 \else\ifx\temp\macrocharE\Eogonek
3179 \else\ifx\temp\macrochare\eogonek
3181 \ecfont \setbox0=
\hbox{#1}%
3182 \ifdim\ht0=
1ex
\accent"
0C
#1%
3183 \else\ooalign{\unhbox0\crcr\hidewidth\char"
0C
\hidewidth}%
3188 \def\Aogonek{{\ecfont \char"
81}}\def\macrocharA{A
}
3189 \def\aogonek{{\ecfont \char"A1
}}\def\macrochara{a
}
3190 \def\Eogonek{{\ecfont \char"
86}}\def\macrocharE{E
}
3191 \def\eogonek{{\ecfont \char"A6
}}\def\macrochare{e
}
3193 % Use the ec* fonts (cm-super in outline format) for non-CM glyphs.
3195 % We can't distinguish serif/sans and italic/slanted, but this
3196 % is used for crude hacks anyway (like adding French and German
3197 % quotes to documents typeset with CM, where we lose kerning), so
3198 % hopefully nobody will notice/care.
3199 \edef\ecsize{\csname\curfontsize ecsize
\endcsname}%
3200 \edef\nominalsize{\csname\curfontsize nominalsize
\endcsname}%
3203 \font\thisecfont = ectt
\ecsize \space at
\nominalsize
3205 \ifx\curfontstyle\bfstylename
3207 \font\thisecfont = ecb
\ifusingit{i
}{x
}\ecsize \space at
\nominalsize
3210 \font\thisecfont = ec
\ifusingit{ti
}{rm
}\ecsize \space at
\nominalsize
3216 % @registeredsymbol - R in a circle. The font for the R should really
3217 % be smaller yet, but lllsize is the best we can do for now.
3218 % Adapted from the plain.tex definition of \copyright.
3220 \def\registeredsymbol{%
3221 $^
{{\ooalign{\hfil\raise.07ex
\hbox{\selectfonts\lllsize R
}%
3226 % @textdegree - the normal degrees sign.
3228 \def\textdegree{$^
\circ$
}
3230 % Laurent Siebenmann reports \Orb undefined with:
3231 % Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
3232 % so we'll define it if necessary.
3234 \ifx\Orb\thisisundefined
3235 \def\Orb{\mathhexbox20D}
3239 \chardef\quotedblleft="
5C
3240 \chardef\quotedblright=`\"
3241 \chardef\quoteleft=`\`
3242 \chardef\quoteright=`\'
3245 \message{page headings,
}
3247 \newskip\titlepagetopglue \titlepagetopglue =
1.5in
3248 \newskip\titlepagebottomglue \titlepagebottomglue =
2pc
3250 % First the title page. Must do @settitle before @titlepage.
3252 \newif\iffinishedtitlepage
3254 % Do an implicit @contents or @shortcontents after @end titlepage if the
3255 % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage.
3257 \newif\ifsetcontentsaftertitlepage
3258 \let\setcontentsaftertitlepage =
\setcontentsaftertitlepagetrue
3259 \newif\ifsetshortcontentsaftertitlepage
3260 \let\setshortcontentsaftertitlepage =
\setshortcontentsaftertitlepagetrue
3262 \parseargdef\shorttitlepage{%
3263 \begingroup \hbox{}\vskip 1.5in
\chaprm \centerline{#1}%
3264 \endgroup\page\hbox{}\page}
3267 % Open one extra group, as we want to close it in the middle of \Etitlepage.
3269 \parindent=
0pt
\textfonts
3270 % Leave some space at the very top of the page.
3271 \vglue\titlepagetopglue
3272 % No rule at page bottom unless we print one at the top with @title.
3273 \finishedtitlepagetrue
3275 % Most title ``pages'' are actually two pages long, with space
3276 % at the top of the second. We don't want the ragged left on the second.
3277 \let\oldpage =
\page
3279 \iffinishedtitlepage\else
3282 \let\page =
\oldpage
3289 \iffinishedtitlepage\else
3292 % It is important to do the page break before ending the group,
3293 % because the headline and footline are only empty inside the group.
3294 % If we use the new definition of \page, we always get a blank page
3295 % after the title page, which we certainly don't want.
3299 % Need this before the \...aftertitlepage checks so that if they are
3300 % in effect the toc pages will come out with page numbers.
3303 % If they want short, they certainly want long too.
3304 \ifsetshortcontentsaftertitlepage
3307 \global\let\shortcontents =
\relax
3308 \global\let\contents =
\relax
3311 \ifsetcontentsaftertitlepage
3313 \global\let\contents =
\relax
3314 \global\let\shortcontents =
\relax
3318 \def\finishtitlepage{%
3319 \vskip4pt \hrule height
2pt width
\hsize
3320 \vskip\titlepagebottomglue
3321 \finishedtitlepagetrue
3324 % Settings used for typesetting titles: no hyphenation, no indentation,
3325 % don't worry much about spacing, ragged right. This should be used
3326 % inside a \vbox, and fonts need to be set appropriately first. Because
3327 % it is always used for titles, nothing else, we call \rmisbold. \par
3328 % should be specified before the end of the \vbox, since a vbox is a group.
3330 \def\raggedtitlesettings{%
3332 \hyphenpenalty=
10000
3338 % Macros to be used within @titlepage:
3340 \let\subtitlerm=
\tenrm
3341 \def\subtitlefont{\subtitlerm \normalbaselineskip =
13pt
\normalbaselines}
3343 \parseargdef\title{%
3345 \vbox{\titlefonts \raggedtitlesettings #1\par}%
3346 % print a rule at the page bottom also.
3347 \finishedtitlepagefalse
3348 \vskip4pt \hrule height
4pt width
\hsize \vskip4pt
3351 \parseargdef\subtitle{%
3353 {\subtitlefont \rightline{#1}}%
3356 % @author should come last, but may come many times.
3357 % It can also be used inside @quotation.
3359 \parseargdef\author{%
3360 \def\temp{\quotation}%
3362 \def\quotationauthor{#1}% printed in \Equotation.
3365 \ifseenauthor\else \vskip 0pt plus
1filll
\seenauthortrue \fi
3366 {\secfonts\rmisbold \leftline{#1}}%
3371 % Set up page headings and footings.
3373 \let\thispage=
\folio
3375 \newtoks\evenheadline % headline on even pages
3376 \newtoks\oddheadline % headline on odd pages
3377 \newtoks\evenfootline % footline on even pages
3378 \newtoks\oddfootline % footline on odd pages
3380 % Now make TeX use those variables
3381 \headline=
{{\textfonts\rm \ifodd\pageno \the\oddheadline
3382 \else \the\evenheadline \fi}}
3383 \footline=
{{\textfonts\rm \ifodd\pageno \the\oddfootline
3384 \else \the\evenfootline \fi}\HEADINGShook}
3385 \let\HEADINGShook=
\relax
3387 % Commands to set those variables.
3388 % For example, this is what @headings on does
3389 % @evenheading @thistitle|@thispage|@thischapter
3390 % @oddheading @thischapter|@thispage|@thistitle
3391 % @evenfooting @thisfile||
3392 % @oddfooting ||@thisfile
3395 \def\evenheading{\parsearg\evenheadingxxx}
3396 \def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|
\finish}
3397 \def\evenheadingyyy #1\|
#2\|
#3\|
#4\finish{%
3398 \global\evenheadline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3400 \def\oddheading{\parsearg\oddheadingxxx}
3401 \def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|
\finish}
3402 \def\oddheadingyyy #1\|
#2\|
#3\|
#4\finish{%
3403 \global\oddheadline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3405 \parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
3407 \def\evenfooting{\parsearg\evenfootingxxx}
3408 \def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|
\finish}
3409 \def\evenfootingyyy #1\|
#2\|
#3\|
#4\finish{%
3410 \global\evenfootline=
{\rlap{\centerline{#2}}\line{#1\hfil#3}}}
3412 \def\oddfooting{\parsearg\oddfootingxxx}
3413 \def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|
\finish}
3414 \def\oddfootingyyy #1\|
#2\|
#3\|
#4\finish{%
3415 \global\oddfootline =
{\rlap{\centerline{#2}}\line{#1\hfil#3}}%
3417 % Leave some space for the footline. Hopefully ok to assume
3418 % @evenfooting will not be used by itself.
3419 \global\advance\pageheight by -
12pt
3420 \global\advance\vsize by -
12pt
3423 \parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
3425 % @evenheadingmarks top \thischapter <- chapter at the top of a page
3426 % @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
3428 % The same set of arguments for:
3433 % @everyheadingmarks
3434 % @everyfootingmarks
3436 \def\evenheadingmarks{\headingmarks{even
}{heading
}}
3437 \def\oddheadingmarks{\headingmarks{odd
}{heading
}}
3438 \def\evenfootingmarks{\headingmarks{even
}{footing
}}
3439 \def\oddfootingmarks{\headingmarks{odd
}{footing
}}
3440 \def\everyheadingmarks#1 {\headingmarks{even
}{heading
}{#1}
3441 \headingmarks{odd
}{heading
}{#1} }
3442 \def\everyfootingmarks#1 {\headingmarks{even
}{footing
}{#1}
3443 \headingmarks{odd
}{footing
}{#1} }
3444 % #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
3445 \def\headingmarks#1#2#3 {%
3446 \expandafter\let\expandafter\temp \csname get
#3headingmarks
\endcsname
3447 \global\expandafter\let\csname get
#1#2marks
\endcsname \temp
3450 \everyheadingmarks bottom
3451 \everyfootingmarks bottom
3453 % @headings double turns headings on for double-sided printing.
3454 % @headings single turns headings on for single-sided printing.
3455 % @headings off turns them off.
3456 % @headings on same as @headings double, retained for compatibility.
3457 % @headings after turns on double-sided headings after this page.
3458 % @headings doubleafter turns on double-sided headings after this page.
3459 % @headings singleafter turns on single-sided headings after this page.
3460 % By default, they are off at the start of a document,
3461 % and turned `on' after @end titlepage.
3463 \def\headings #1 {\csname HEADINGS
#1\endcsname}
3465 \def\headingsoff{% non-global headings elimination
3466 \evenheadline=
{\hfil}\evenfootline=
{\hfil}%
3467 \oddheadline=
{\hfil}\oddfootline=
{\hfil}%
3470 \def\HEADINGSoff{{\globaldefs=
1 \headingsoff}} % global setting
3471 \HEADINGSoff % it's the default
3473 % When we turn headings on, set the page number to 1.
3474 % For double-sided printing, put current file name in lower left corner,
3475 % chapter name on inside top of right hand pages, document
3476 % title on inside top of left hand pages, and page numbers on outside top
3477 % edge of all pages.
3478 \def\HEADINGSdouble{%
3480 \global\evenfootline=
{\hfil}
3481 \global\oddfootline=
{\hfil}
3482 \global\evenheadline=
{\line{\folio\hfil\thistitle}}
3483 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
3484 \global\let\contentsalignmacro =
\chapoddpage
3486 \let\contentsalignmacro =
\chappager
3488 % For single-sided printing, chapter title goes across top left of page,
3489 % page number on top right.
3490 \def\HEADINGSsingle{%
3492 \global\evenfootline=
{\hfil}
3493 \global\oddfootline=
{\hfil}
3494 \global\evenheadline=
{\line{\thischapter\hfil\folio}}
3495 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
3496 \global\let\contentsalignmacro =
\chappager
3498 \def\HEADINGSon{\HEADINGSdouble}
3500 \def\HEADINGSafter{\let\HEADINGShook=
\HEADINGSdoublex}
3501 \let\HEADINGSdoubleafter=
\HEADINGSafter
3502 \def\HEADINGSdoublex{%
3503 \global\evenfootline=
{\hfil}
3504 \global\oddfootline=
{\hfil}
3505 \global\evenheadline=
{\line{\folio\hfil\thistitle}}
3506 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
3507 \global\let\contentsalignmacro =
\chapoddpage
3510 \def\HEADINGSsingleafter{\let\HEADINGShook=
\HEADINGSsinglex}
3511 \def\HEADINGSsinglex{%
3512 \global\evenfootline=
{\hfil}
3513 \global\oddfootline=
{\hfil}
3514 \global\evenheadline=
{\line{\thischapter\hfil\folio}}
3515 \global\oddheadline=
{\line{\thischapter\hfil\folio}}
3516 \global\let\contentsalignmacro =
\chappager
3519 % Subroutines used in generating headings
3520 % This produces Day Month Year style of output.
3521 % Only define if not already defined, in case a txi-??.tex file has set
3522 % up a different format (e.g., txi-cs.tex does this).
3523 \ifx\today\thisisundefined
3527 \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
3528 \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
3529 \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
3534 % @settitle line... specifies the title of the document, for headings.
3535 % It generates no output of its own.
3536 \def\thistitle{\putwordNoTitle}
3537 \def\settitle{\parsearg{\gdef\thistitle}}
3541 % Tables -- @table, @ftable, @vtable, @item(x).
3543 % default indentation of table text
3544 \newdimen\tableindent \tableindent=
.8in
3545 % default indentation of @itemize and @enumerate text
3546 \newdimen\itemindent \itemindent=
.3in
3547 % margin between end of table item and start of table text.
3548 \newdimen\itemmargin \itemmargin=
.1in
3550 % used internally for \itemindent minus \itemmargin
3553 % Note @table, @ftable, and @vtable define @item, @itemx, etc., with
3555 % They also define \itemindex
3556 % to index the item name in whatever manner is desired (perhaps none).
3558 \newif\ifitemxneedsnegativevskip
3560 \def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-
\parskip\nobreak\fi}
3562 \def\internalBitem{\smallbreak \parsearg\itemzzz}
3563 \def\internalBitemx{\itemxpar \parsearg\itemzzz}
3565 \def\itemzzz #1{\begingroup %
3566 \advance\hsize by -
\rightskip
3567 \advance\hsize by -
\tableindent
3568 \setbox0=
\hbox{\itemindicate{#1}}%
3570 \nobreak % This prevents a break before @itemx.
3572 % If the item text does not fit in the space we have, put it on a line
3573 % by itself, and do not allow a page break either before or after that
3574 % line. We do not start a paragraph here because then if the next
3575 % command is, e.g., @kindex, the whatsit would get put into the
3576 % horizontal list on a line by itself, resulting in extra blank space.
3577 \ifdim \wd0>
\itemmax
3579 % Make this a paragraph so we get the \parskip glue and wrapping,
3580 % but leave it ragged-right.
3582 \advance\leftskip by-
\tableindent
3583 \advance\hsize by
\tableindent
3584 \advance\rightskip by0pt plus1fil
\relax
3585 \leavevmode\unhbox0\par
3588 % We're going to be starting a paragraph, but we don't want the
3589 % \parskip glue -- logically it's part of the @item we just started.
3590 \nobreak \vskip-
\parskip
3592 % Stop a page break at the \parskip glue coming up. However, if
3593 % what follows is an environment such as @example, there will be no
3594 % \parskip glue; then the negative vskip we just inserted would
3595 % cause the example and the item to crash together. So we use this
3596 % bizarre value of 10001 as a signal to \aboveenvbreak to insert
3597 % \parskip glue after all. Section titles are handled this way also.
3601 \itemxneedsnegativevskipfalse
3603 % The item text fits into the space. Start a paragraph, so that the
3604 % following text (if any) will end up on the same line.
3606 % Do this with kerns and \unhbox so that if there is a footnote in
3607 % the item text, it can migrate to the main vertical list and
3608 % eventually be printed.
3609 \nobreak\kern-
\tableindent
3610 \dimen0 =
\itemmax \advance\dimen0 by
\itemmargin \advance\dimen0 by -
\wd0
3612 \nobreak\kern\dimen0
3614 \itemxneedsnegativevskiptrue
3618 \def\item{\errmessage{@item while not in a list environment
}}
3619 \def\itemx{\errmessage{@itemx while not in a list environment
}}
3621 % @table, @ftable, @vtable.
3623 \let\itemindex\gobble
3627 \def\itemindex #
#1{\doind {fn
}{\code{#
#1}}}%
3628 \tablecheck{ftable
}%
3631 \def\itemindex #
#1{\doind {vr
}{\code{#
#1}}}%
3632 \tablecheck{vtable
}%
3635 \ifnum \the\catcode`\^^M=
\active
3637 \errmessage{This command won't work in this context; perhaps the problem is
3638 that we are
\inenvironment\thisenv}%
3639 \def\next{\doignore{#1}}%
3646 \def\itemindicate{#1}%
3651 \makevalueexpandable
3652 \edef\temp{\noexpand\tablez #1\space\space\space}%
3656 \def\tablez #1 #2 #3 #4\endtablez{%
3658 \ifnum 0#1>
0 \advance \leftskip by
#1\mil \fi
3659 \ifnum 0#2>
0 \tableindent=
#2\mil \fi
3660 \ifnum 0#3>
0 \advance \rightskip by
#3\mil \fi
3661 \itemmax=
\tableindent
3662 \advance \itemmax by -
\itemmargin
3663 \advance \leftskip by
\tableindent
3664 \exdentamount=
\tableindent
3666 \parskip =
\smallskipamount
3667 \ifdim \parskip=
0pt
\parskip=
2pt
\fi
3668 \let\item =
\internalBitem
3669 \let\itemx =
\internalBitemx
3671 \def\Etable{\endgraf\afterenvbreak}
3674 \let\Eitemize\Etable
3675 \let\Eenumerate\Etable
3677 % This is the counter used by @enumerate, which is really @itemize
3681 \envdef\itemize{\parsearg\doitemize}
3685 \itemmax=
\itemindent
3686 \advance\itemmax by -
\itemmargin
3687 \advance\leftskip by
\itemindent
3688 \exdentamount=
\itemindent
3690 \parskip=
\smallskipamount
3691 \ifdim\parskip=
0pt
\parskip=
2pt
\fi
3693 % Try typesetting the item mark so that if the document erroneously says
3694 % something like @itemize @samp (intending @table), there's an error
3695 % right away at the @itemize. It's not the best error message in the
3696 % world, but it's better than leaving it to the @item. This means if
3697 % the user wants an empty mark, they have to say @w{} not just @w.
3698 \def\itemcontents{#1}%
3699 \setbox0 =
\hbox{\itemcontents}%
3701 % @itemize with no arg is equivalent to @itemize @bullet.
3702 \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
3704 \let\item=
\itemizeitem
3707 % Definition of @item while inside @itemize and @enumerate.
3710 \advance\itemno by
1 % for enumerations
3711 {\let\par=
\endgraf \smallbreak}% reasonable place to break
3713 % If the document has an @itemize directly after a section title, a
3714 % \nobreak will be last on the list, and \sectionheading will have
3715 % done a \vskip-\parskip. In that case, we don't want to zero
3716 % parskip, or the item text will crash with the heading. On the
3717 % other hand, when there is normal text preceding the item (as there
3718 % usually is), we do want to zero parskip, or there would be too much
3719 % space. In that case, we won't have a \nobreak before. At least
3720 % that's the theory.
3721 \ifnum\lastpenalty<
10000 \parskip=
0in
\fi
3723 \hbox to
0pt
{\hss \itemcontents \kern\itemmargin}%
3725 \vadjust{\penalty 1200}}% not good to break after first line of item.
3729 % \splitoff TOKENS\endmark defines \first to be the first token in
3730 % TOKENS, and \rest to be the remainder.
3732 \def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
3734 % Allow an optional argument of an uppercase letter, lowercase letter,
3735 % or number, to specify the first label in the enumerated list. No
3736 % argument is the same as `1'.
3738 \envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
3739 \def\enumeratey #1 #2\endenumeratey{%
3740 % If we were given no argument, pretend we were given `1'.
3742 \ifx\thearg\empty \def\thearg{1}\fi
3744 % Detect if the argument is a single token. If so, it might be a
3745 % letter. Otherwise, the only valid thing it can be is a number.
3746 % (We will always have one token, because of the test we just made.
3747 % This is a good thing, since \splitoff doesn't work given nothing at
3748 % all -- the first parameter is undelimited.)
3749 \expandafter\splitoff\thearg\endmark
3751 % Only one token in the argument. It could still be anything.
3752 % A ``lowercase letter'' is one whose \lccode is nonzero.
3753 % An ``uppercase letter'' is one whose \lccode is both nonzero, and
3754 % not equal to itself.
3755 % Otherwise, we assume it's a number.
3757 % We need the \relax at the end of the \ifnum lines to stop TeX from
3758 % continuing to look for a <number>.
3760 \ifnum\lccode\expandafter`
\thearg=
0\relax
3761 \numericenumerate % a number (we hope)
3764 \ifnum\lccode\expandafter`
\thearg=
\expandafter`
\thearg\relax
3765 \lowercaseenumerate % lowercase letter
3767 \uppercaseenumerate % uppercase letter
3771 % Multiple tokens in the argument. We hope it's a number.
3776 % An @enumerate whose labels are integers. The starting integer is
3779 \def\numericenumerate{%
3781 \startenumeration{\the\itemno}%
3784 % The starting (lowercase) letter is in \thearg.
3785 \def\lowercaseenumerate{%
3786 \itemno =
\expandafter`
\thearg
3788 % Be sure we're not beyond the end of the alphabet.
3790 \errmessage{No more lowercase letters in @enumerate; get a bigger
3797 % The starting (uppercase) letter is in \thearg.
3798 \def\uppercaseenumerate{%
3799 \itemno =
\expandafter`
\thearg
3801 % Be sure we're not beyond the end of the alphabet.
3803 \errmessage{No more uppercase letters in @enumerate; get a bigger
3810 % Call \doitemize, adding a period to the first argument and supplying the
3811 % common last two arguments. Also subtract one from the initial value in
3812 % \itemno, since @item increments \itemno.
3814 \def\startenumeration#1{%
3815 \advance\itemno by -
1
3816 \doitemize{#1.
}\flushcr
3819 % @alphaenumerate and @capsenumerate are abbreviations for giving an arg
3822 \def\alphaenumerate{\enumerate{a
}}
3823 \def\capsenumerate{\enumerate{A
}}
3824 \def\Ealphaenumerate{\Eenumerate}
3825 \def\Ecapsenumerate{\Eenumerate}
3828 % @multitable macros
3829 % Amy Hendrickson, 8/18/94, 3/6/96
3831 % @multitable ... @end multitable will make as many columns as desired.
3832 % Contents of each column will wrap at width given in preamble. Width
3833 % can be specified either with sample text given in a template line,
3834 % or in percent of \hsize, the current width of text on page.
3836 % Table can continue over pages but will only break between lines.
3840 % Either define widths of columns in terms of percent of \hsize:
3841 % @multitable @columnfractions .25 .3 .45
3844 % Numbers following @columnfractions are the percent of the total
3845 % current hsize to be used for each column. You may use as many
3846 % columns as desired.
3849 % Or use a template:
3850 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3852 % using the widest term desired in each column.
3854 % Each new table line starts with @item, each subsequent new column
3855 % starts with @tab. Empty columns may be produced by supplying @tab's
3856 % with nothing between them for as many times as empty columns are needed,
3857 % ie, @tab@tab@tab will produce two empty columns.
3859 % @item, @tab do not need to be on their own lines, but it will not hurt
3862 % Sample multitable:
3864 % @multitable {Column 1 template} {Column 2 template} {Column 3 template}
3865 % @item first col stuff @tab second col stuff @tab third col
3872 % @item first col stuff @tab second col stuff
3873 % @tab Many paragraphs of text may be used in any column.
3875 % They will wrap at the width determined by the template.
3876 % @item@tab@tab This will be in third column.
3879 % Default dimensions may be reset by user.
3880 % @multitableparskip is vertical space between paragraphs in table.
3881 % @multitableparindent is paragraph indent in table.
3882 % @multitablecolmargin is horizontal space to be left between columns.
3883 % @multitablelinespace is space to leave between table items, baseline
3885 % 0pt means it depends on current normal line spacing.
3887 \newskip\multitableparskip
3888 \newskip\multitableparindent
3889 \newdimen\multitablecolspace
3890 \newskip\multitablelinespace
3891 \multitableparskip=
0pt
3892 \multitableparindent=
6pt
3893 \multitablecolspace=
12pt
3894 \multitablelinespace=
0pt
3896 % Macros used to set up halign preamble:
3898 \let\endsetuptable\relax
3899 \def\xendsetuptable{\endsetuptable}
3900 \let\columnfractions\relax
3901 \def\xcolumnfractions{\columnfractions}
3904 % #1 is the @columnfraction, usually a decimal number like .5, but might
3905 % be just 1. We just use it, whatever it is.
3907 \def\pickupwholefraction#1 {%
3908 \global\advance\colcount by
1
3909 \expandafter\xdef\csname col
\the\colcount\endcsname{#1\hsize}%
3916 \ifx\firstarg\xendsetuptable
3919 \ifx\firstarg\xcolumnfractions
3920 \global\setpercenttrue
3923 \let\go\pickupwholefraction
3925 \global\advance\colcount by
1
3926 \setbox0=
\hbox{#1\unskip\space}% Add a normal word space as a
3927 % separator; typically that is always in the input, anyway.
3928 \expandafter\xdef\csname col
\the\colcount\endcsname{\the\wd0}%
3931 \ifx\go\pickupwholefraction
3932 % Put the argument back for the \pickupwholefraction call, so
3933 % we'll always have a period there to be parsed.
3934 \def\go{\pickupwholefraction#1}%
3936 \let\go =
\setuptable
3942 % multitable-only commands.
3944 % @headitem starts a heading row, which we typeset in bold. Assignments
3945 % have to be global since we are inside the implicit group of an
3946 % alignment entry. \everycr below resets \everytab so we don't have to
3947 % undo it ourselves.
3948 \def\headitemfont{\b}% for people to use in the template row; not changeable
3950 \checkenv\multitable
3952 \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings
3953 \global\everytab=
{\bf}% can't use \headitemfont since the parsing differs
3954 \the\everytab % for the first item
3957 % default for tables with no headings.
3958 \let\headitemcrhook=
\relax
3960 % A \tab used to include \hskip1sp. But then the space in a template
3961 % line is not enough. That is bad. So let's go back to just `&' until
3962 % we again encounter the problem the 1sp was intended to solve.
3963 % --karl, nathan@acm.org, 20apr99.
3964 \def\tab{\checkenv\multitable &
\the\everytab}%
3966 % @multitable ... @end multitable definitions:
3968 \newtoks\everytab % insert after every tab.
3970 \envdef\multitable{%
3974 % @item within a multitable starts a normal row.
3975 % We use \def instead of \let so that if one of the multitable entries
3976 % contains an @itemize, we don't choke on the \item (seen as \crcr aka
3977 % \endtemplate) expanding \doitemize.
3982 \setmultitablespacing
3983 \parskip=
\multitableparskip
3984 \parindent=
\multitableparindent
3990 \global\everytab=
{}% Reset from possible headitem.
3991 \global\colcount=
0 % Reset the column counter.
3993 % Check for saved footnotes, etc.:
3996 % Perhaps a \nobreak, then reset:
3998 \global\let\headitemcrhook=
\relax
4002 \parsearg\domultitable
4004 \def\domultitable#1{%
4005 % To parse everything between @multitable and @item:
4006 \setuptable#1 \endsetuptable
4008 % This preamble sets up a generic column definition, which will
4009 % be used as many times as user calls for columns.
4010 % \vtop will set a single line and will also let text wrap and
4011 % continue for many paragraphs if desired.
4013 \global\advance\colcount by
1
4016 % Use the current \colcount to find the correct column width:
4017 \hsize=
\expandafter\csname col
\the\colcount\endcsname
4019 % In order to keep entries from bumping into each other
4020 % we will add a \leftskip of \multitablecolspace to all columns after
4023 % If a template has been used, we will add \multitablecolspace
4024 % to the width of each template entry.
4026 % If the user has set preamble in terms of percent of \hsize we will
4027 % use that dimension as the width of the column, and the \leftskip
4028 % will keep entries from bumping into each other. Table will start at
4029 % left margin and final column will justify at right margin.
4031 % Make sure we don't inherit \rightskip from the outer environment.
4034 % The first column will be indented with the surrounding text.
4035 \advance\hsize by
\leftskip
4038 % If user has not set preamble in terms of percent of \hsize
4039 % we will advance \hsize by \multitablecolspace.
4040 \advance\hsize by
\multitablecolspace
4042 % In either case we will make \leftskip=\multitablecolspace:
4043 \leftskip=
\multitablecolspace
4045 % Ignoring space at the beginning and end avoids an occasional spurious
4046 % blank line, when TeX decides to break the line at the space before the
4047 % box from the multistrut, so the strut ends up on a line by itself.
4049 % @multitable @columnfractions .11 .89
4051 % @tab Legal holiday which is valid in major parts of the whole country.
4052 % Is automatically provided with highlighting sequences respectively
4053 % marking characters.
4054 \noindent\ignorespaces##
\unskip\multistrut
4059 \egroup % end the \halign
4060 \global\setpercentfalse
4063 \def\setmultitablespacing{%
4064 \def\multistrut{\strut}% just use the standard line spacing
4066 % Compute \multitablelinespace (if not defined by user) for use in
4067 % \multitableparskip calculation. We used define \multistrut based on
4068 % this, but (ironically) that caused the spacing to be off.
4069 % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
4070 \ifdim\multitablelinespace=
0pt
4071 \setbox0=
\vbox{X
}\global\multitablelinespace=
\the\baselineskip
4072 \global\advance\multitablelinespace by-
\ht0
4074 % Test to see if parskip is larger than space between lines of
4075 % table. If not, do nothing.
4076 % If so, set to same dimension as multitablelinespace.
4077 \ifdim\multitableparskip>
\multitablelinespace
4078 \global\multitableparskip=
\multitablelinespace
4079 \global\advance\multitableparskip-
7pt
% to keep parskip somewhat smaller
4080 % than skip between lines in the table.
4082 \ifdim\multitableparskip=
0pt
4083 \global\multitableparskip=
\multitablelinespace
4084 \global\advance\multitableparskip-
7pt
% to keep parskip somewhat smaller
4085 % than skip between lines in the table.
4089 \message{conditionals,
}
4091 % @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
4092 % @ifnotxml always succeed. They currently do nothing; we don't
4093 % attempt to check whether the conditionals are properly nested. But we
4094 % have to remember that they are conditionals, so that @end doesn't
4095 % attempt to close an environment group.
4098 \expandafter\let\csname #1\endcsname =
\relax
4099 \expandafter\let\csname iscond.
#1\endcsname =
1
4102 \makecond{ifnotdocbook
}
4103 \makecond{ifnothtml
}
4104 \makecond{ifnotinfo
}
4105 \makecond{ifnotplaintext
}
4108 % Ignore @ignore, @ifhtml, @ifinfo, and the like.
4110 \def\direntry{\doignore{direntry
}}
4111 \def\documentdescription{\doignore{documentdescription
}}
4112 \def\docbook{\doignore{docbook
}}
4113 \def\html{\doignore{html
}}
4114 \def\ifdocbook{\doignore{ifdocbook
}}
4115 \def\ifhtml{\doignore{ifhtml
}}
4116 \def\ifinfo{\doignore{ifinfo
}}
4117 \def\ifnottex{\doignore{ifnottex
}}
4118 \def\ifplaintext{\doignore{ifplaintext
}}
4119 \def\ifxml{\doignore{ifxml
}}
4120 \def\ignore{\doignore{ignore
}}
4121 \def\menu{\doignore{menu
}}
4122 \def\xml{\doignore{xml
}}
4124 % Ignore text until a line `@end #1', keeping track of nested conditionals.
4126 % A count to remember the depth of nesting.
4127 \newcount\doignorecount
4129 \def\doignore#1{\begingroup
4130 % Scan in ``verbatim'' mode:
4132 \catcode`\@ =
\other
4133 \catcode`\
{ =
\other
4134 \catcode`\
} =
\other
4136 % Make sure that spaces turn into tokens that match what \doignoretext wants.
4139 % Count number of #1's that we've seen.
4142 % Swallow text until we reach the matching `@end #1'.
4146 { \catcode`_=
11 % We want to use \_STOP_ which cannot appear in texinfo source.
4149 \gdef\dodoignore#1{%
4150 % #1 contains the command name as a string, e.g., `ifinfo'.
4152 % Define a command to find the next `@end #1'.
4153 \long\def\doignoretext#
#1^^M@end
#1{%
4154 \doignoretextyyy#
#1^^M@
#1\_STOP_}%
4156 % And this command to find another #1 command, at the beginning of a
4157 % line. (Otherwise, we would consider a line `@c @ifset', for
4158 % example, to count as an @ifset for nesting.)
4159 \long\def\doignoretextyyy#
#1^^M@
#1#
#2\_STOP_{\doignoreyyy{#
#2}\_STOP_}%
4161 % And now expand that command.
4166 \def\doignoreyyy#1{%
4168 \ifx\temp\empty % Nothing found.
4169 \let\next\doignoretextzzz
4170 \else % Found a nested condition, ...
4171 \advance\doignorecount by
1
4172 \let\next\doignoretextyyy % ..., look for another.
4173 % If we're here, #1 ends with ^^M\ifinfo (for example).
4175 \next #1% the token \_STOP_ is present just after this macro.
4178 % We have to swallow the remaining "\_STOP_".
4180 \def\doignoretextzzz#1{%
4181 \ifnum\doignorecount =
0 % We have just found the outermost @end.
4182 \let\next\enddoignore
4183 \else % Still inside a nested condition.
4184 \advance\doignorecount by -
1
4185 \let\next\doignoretext % Look for the next @end.
4190 % Finish off ignored text.
4192 % Ignore anything after the last `@end #1'; this matters in verbatim
4193 % environments, where otherwise the newline after an ignored conditional
4194 % would result in a blank line in the output.
4195 \gdef\enddoignore#1^^M
{\endgroup\ignorespaces}%
4199 % @set VAR sets the variable VAR to an empty value.
4200 % @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
4202 % Since we want to separate VAR from REST-OF-LINE (which might be
4203 % empty), we can't just use \parsearg; we have to insert a space of our
4204 % own to delimit the rest of the line, and then take it out again if we
4206 % We rely on the fact that \parsearg sets \catcode`\ =10.
4208 \parseargdef\set{\setyyy#1 \endsetyyy}
4209 \def\setyyy#1 #2\endsetyyy{%
4211 \makevalueexpandable
4213 \edef\next{\gdef\makecsname{SET
#1}}%
4221 % Remove the trailing space \setxxx inserted.
4222 \def\setzzz#1 \endsetzzz{\next{#1}}
4224 % @clear VAR clears (i.e., unsets) the variable VAR.
4226 \parseargdef\clear{%
4228 \makevalueexpandable
4229 \global\expandafter\let\csname SET
#1\endcsname=
\relax
4233 % @value{foo} gets the text saved in variable foo.
4234 \def\value{\begingroup\makevalueexpandable\valuexxx}
4235 \def\valuexxx#1{\expandablevalue{#1}\endgroup}
4237 \catcode`\-=
\active \catcode`
\_=
\active
4239 \gdef\makevalueexpandable{%
4240 \let\value =
\expandablevalue
4241 % We don't want these characters active, ...
4242 \catcode`\-=
\other \catcode`
\_=
\other
4243 % ..., but we might end up with active ones in the argument if
4244 % we're called from @code, as @code{@value{foo-bar_}}, though.
4245 % So \let them to their normal equivalents.
4246 \let-
\normaldash \let_\normalunderscore
4250 % We have this subroutine so that we can handle at least some @value's
4251 % properly in indexes (we call \makevalueexpandable in \indexdummies).
4252 % The command has to be fully expandable (if the variable is set), since
4253 % the result winds up in the index file. This means that if the
4254 % variable's value contains other Texinfo commands, it's almost certain
4255 % it will fail (although perhaps we could fix that with sufficient work
4256 % to do a one-level expansion on the result, instead of complete).
4258 % Unfortunately, this has the consequence that when _ is in the *value*
4259 % of an @set, it does not print properly in the roman fonts (get the cmr
4260 % dot accent at position 126 instead). No fix comes to mind, and it's
4261 % been this way since 2003 or earlier, so just ignore it.
4263 \def\expandablevalue#1{%
4264 \expandafter\ifx\csname SET
#1\endcsname\relax
4265 {[No value for ``
#1''
]}%
4266 \message{Variable `
#1', used in @value, is not set.
}%
4268 \csname SET
#1\endcsname
4272 % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
4275 % To get the special treatment we need for `@end ifset,' we call
4276 % \makecond and then redefine.
4279 \def\ifset{\parsearg{\doifset{\let\next=
\ifsetfail}}}
4282 \makevalueexpandable
4284 \expandafter\ifx\csname SET
#2\endcsname\relax
4285 #1% If not set, redefine \next.
4290 \def\ifsetfail{\doignore{ifset
}}
4292 % @ifclear VAR ... @end executes the `...' iff VAR has never been
4293 % defined with @set, or has been undefined with @clear.
4295 % The `\else' inside the `\doifset' parameter is a trick to reuse the
4296 % above code: if the variable is not set, do nothing, if it is set,
4297 % then redefine \next to \ifclearfail.
4300 \def\ifclear{\parsearg{\doifset{\else \let\next=
\ifclearfail}}}
4301 \def\ifclearfail{\doignore{ifclear
}}
4303 % @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
4304 % without the @) is in fact defined. We can only feasibly check at the
4305 % TeX level, so something like `mathcode' is going to considered
4306 % defined even though it is not a Texinfo command.
4308 \makecond{ifcommanddefined
}
4309 \def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=
\ifcmddefinedfail}}}
4311 \def\doifcmddefined#1#2{{%
4312 \makevalueexpandable
4314 \expandafter\ifx\csname #2\endcsname\relax
4315 #1% If not defined, \let\next as above.
4320 \def\ifcmddefinedfail{\doignore{ifcommanddefined
}}
4322 % @ifcommandnotdefined CMD ... handled similar to @ifclear above.
4323 \makecond{ifcommandnotdefined
}
4324 \def\ifcommandnotdefined{%
4325 \parsearg{\doifcmddefined{\else \let\next=
\ifcmdnotdefinedfail}}}
4326 \def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined
}}
4328 % Set the `txicommandconditionals' variable, so documents have a way to
4329 % test if the @ifcommand...defined conditionals are available.
4330 \set txicommandconditionals
4332 % @dircategory CATEGORY -- specify a category of the dir file
4333 % which this file should belong to. Ignore this in TeX.
4334 \let\dircategory=
\comment
4336 % @defininfoenclose.
4337 \let\definfoenclose=
\comment
4341 % Index generation facilities
4343 % Define \newwrite to be identical to plain tex's \newwrite
4344 % except not \outer, so it can be used within macros and \if's.
4345 \edef\newwrite{\makecsname{ptexnewwrite
}}
4347 % \newindex {foo} defines an index named foo.
4348 % It automatically defines \fooindex such that
4349 % \fooindex ...rest of line... puts an entry in the index foo.
4350 % It also defines \fooindfile to be the number of the output channel for
4351 % the file that accumulates this index. The file's extension is foo.
4352 % The name of an index should be no more than 2 characters long
4353 % for the sake of vms.
4357 \expandafter\newwrite \csname#1indfile
\endcsname
4358 \openout \csname#1indfile
\endcsname \jobname.
#1 % Open the file
4360 \expandafter\xdef\csname#1index
\endcsname{% % Define @#1index
4361 \noexpand\doindex{#1}}
4364 % @defindex foo == \newindex{foo}
4366 \def\defindex{\parsearg\newindex}
4368 % Define @defcodeindex, like @defindex except put all entries in @code.
4370 \def\defcodeindex{\parsearg\newcodeindex}
4372 \def\newcodeindex#1{%
4374 \expandafter\newwrite \csname#1indfile
\endcsname
4375 \openout \csname#1indfile
\endcsname \jobname.
#1
4377 \expandafter\xdef\csname#1index
\endcsname{%
4378 \noexpand\docodeindex{#1}}%
4382 % @synindex foo bar makes index foo feed into index bar.
4383 % Do this instead of @defindex foo if you don't want it as a separate index.
4385 % @syncodeindex foo bar similar, but put all entries made for index foo
4388 \def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
4389 \def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
4391 % #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
4392 % #3 the target index (bar).
4393 \def\dosynindex#1#2#3{%
4394 % Only do \closeout if we haven't already done it, else we'll end up
4395 % closing the target index.
4396 \expandafter \ifx\csname donesynindex
#2\endcsname \relax
4397 % The \closeout helps reduce unnecessary open files; the limit on the
4398 % Acorn RISC OS is a mere 16 files.
4399 \expandafter\closeout\csname#2indfile
\endcsname
4400 \expandafter\let\csname donesynindex
#2\endcsname =
1
4402 % redefine \fooindfile:
4403 \expandafter\let\expandafter\temp\expandafter=
\csname#3indfile
\endcsname
4404 \expandafter\let\csname#2indfile
\endcsname=
\temp
4405 % redefine \fooindex:
4406 \expandafter\xdef\csname#2index
\endcsname{\noexpand#1{#3}}%
4409 % Define \doindex, the driver for all \fooindex macros.
4410 % Argument #1 is generated by the calling \fooindex macro,
4411 % and it is "foo", the name of the index.
4413 % \doindex just uses \parsearg; it calls \doind for the actual work.
4414 % This is because \doind is more useful to call from other macros.
4416 % There is also \dosubind {index}{topic}{subtopic}
4417 % which makes an entry in a two-level index such as the operation index.
4419 \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer}
4420 \def\singleindexer #1{\doind{\indexname}{#1}}
4422 % like the previous two, but they put @code around the argument.
4423 \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer}
4424 \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}}
4426 % Take care of Texinfo commands that can appear in an index entry.
4427 % Since there are some commands we want to expand, and others we don't,
4428 % we have to laboriously prevent expansion for those that we don't.
4431 \escapechar = `\\
% use backslash in output files.
4432 \def\@
{@
}% change to @@ when we switch to @ as escape char in index files.
4433 \def\
{\realbackslash\space }%
4435 % Need these unexpandable (because we define \tt as a dummy)
4436 % definitions when @{ or @} appear in index entry text. Also, more
4437 % complicated, when \tex is in effect and \{ is a \delimiter again.
4438 % We can't use \lbracecmd and \rbracecmd because texindex assumes
4439 % braces and backslashes are used only as delimiters. Perhaps we
4440 % should use @lbracechar and @rbracechar?
4441 \def\
{{{\tt\char123}}%
4442 \def\
}{{\tt\char125}}%
4444 % I don't entirely understand this, but when an index entry is
4445 % generated from a macro call, the \endinput which \scanmacro inserts
4446 % causes processing to be prematurely terminated. This is,
4447 % apparently, because \indexsorttmp is fully expanded, and \endinput
4448 % is an expandable command. The redefinition below makes \endinput
4449 % disappear altogether for that purpose -- although logging shows that
4450 % processing continues to some further point. On the other hand, it
4451 % seems \endinput does not hurt in the printed index arg, since that
4452 % is still getting written without apparent harm.
4454 % Sample source (mac-idx3.tex, reported by Graham Percival to
4455 % help-texinfo, 22may06):
4456 % @macro funindex {WORD}
4460 % @funindex commtest
4461 % This is not enough to reproduce the bug, but it gives the flavor.
4463 % Sample whatsit resulting:
4464 % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}}
4467 \let\endinput =
\empty
4469 % Do the redefinitions.
4473 % For the aux and toc files, @ is the escape character. So we want to
4474 % redefine everything using @ as the escape character (instead of
4475 % \realbackslash, still used for index files). When everything uses @,
4476 % this will be simpler.
4481 \let\
{ =
\lbraceatcmd
4482 \let\
} =
\rbraceatcmd
4484 % Do the redefinitions.
4489 % Called from \indexdummies and \atdummies.
4491 \def\commondummies{%
4493 % \definedummyword defines \#1 as \string\#1\space, thus effectively
4494 % preventing its expansion. This is used only for control words,
4495 % not control letters, because the \space would be incorrect for
4496 % control characters, but is needed to separate the control word
4497 % from whatever follows.
4499 % For control letters, we have \definedummyletter, which omits the
4502 % These can be used both for control words that take an argument and
4503 % those that do not. If it is followed by {arg} in the input, then
4504 % that will dutifully get written to the index (or wherever).
4506 \def\definedummyword #
#1{\def#
#1{\string#
#1\space}}%
4507 \def\definedummyletter#
#1{\def#
#1{\string#
#1}}%
4508 \let\definedummyaccent\definedummyletter
4510 \commondummiesnofonts
4512 \definedummyletter\_%
4513 \definedummyletter\-
%
4515 % Non-English letters.
4526 \definedummyword\exclamdown
4530 \definedummyword\ordf
4531 \definedummyword\ordm
4532 \definedummyword\questiondown
4536 % Although these internal commands shouldn't show up, sometimes they do.
4538 \definedummyword\gtr
4539 \definedummyword\hat
4540 \definedummyword\less
4543 \definedummyword\tclose
4546 \definedummyword\LaTeX
4547 \definedummyword\TeX
4549 % Assorted special characters.
4550 \definedummyword\arrow
4551 \definedummyword\bullet
4552 \definedummyword\comma
4553 \definedummyword\copyright
4554 \definedummyword\registeredsymbol
4555 \definedummyword\dots
4556 \definedummyword\enddots
4557 \definedummyword\entrybreak
4558 \definedummyword\equiv
4559 \definedummyword\error
4560 \definedummyword\euro
4561 \definedummyword\expansion
4562 \definedummyword\geq
4563 \definedummyword\guillemetleft
4564 \definedummyword\guillemetright
4565 \definedummyword\guilsinglleft
4566 \definedummyword\guilsinglright
4567 \definedummyword\lbracechar
4568 \definedummyword\leq
4569 \definedummyword\minus
4570 \definedummyword\ogonek
4571 \definedummyword\pounds
4572 \definedummyword\point
4573 \definedummyword\print
4574 \definedummyword\quotedblbase
4575 \definedummyword\quotedblleft
4576 \definedummyword\quotedblright
4577 \definedummyword\quoteleft
4578 \definedummyword\quoteright
4579 \definedummyword\quotesinglbase
4580 \definedummyword\rbracechar
4581 \definedummyword\result
4582 \definedummyword\textdegree
4584 % We want to disable all macros so that they are not expanded by \write.
4587 \normalturnoffactive
4589 % Handle some cases of @value -- where it does not contain any
4590 % (non-fully-expandable) commands.
4591 \makevalueexpandable
4594 % \commondummiesnofonts: common to \commondummies and \indexnofonts.
4596 \def\commondummiesnofonts{%
4597 % Control letters and accents.
4598 \definedummyletter\!
%
4599 \definedummyaccent\"
%
4600 \definedummyaccent\'
%
4601 \definedummyletter\*
%
4602 \definedummyaccent\,
%
4603 \definedummyletter\.
%
4604 \definedummyletter\/
%
4605 \definedummyletter\:
%
4606 \definedummyaccent\=
%
4607 \definedummyletter\?
%
4608 \definedummyaccent\^
%
4609 \definedummyaccent\`
%
4610 \definedummyaccent\~
%
4614 \definedummyword\dotaccent
4615 \definedummyword\ogonek
4616 \definedummyword\ringaccent
4617 \definedummyword\tieaccent
4618 \definedummyword\ubaraccent
4619 \definedummyword\udotaccent
4620 \definedummyword\dotless
4622 % Texinfo font commands.
4626 \definedummyword\sansserif
4628 \definedummyword\slanted
4631 % Commands that take arguments.
4632 \definedummyword\abbr
4633 \definedummyword\acronym
4634 \definedummyword\anchor
4635 \definedummyword\cite
4636 \definedummyword\code
4637 \definedummyword\command
4638 \definedummyword\dfn
4639 \definedummyword\dmn
4640 \definedummyword\email
4641 \definedummyword\emph
4642 \definedummyword\env
4643 \definedummyword\file
4644 \definedummyword\image
4645 \definedummyword\indicateurl
4646 \definedummyword\inforef
4647 \definedummyword\kbd
4648 \definedummyword\key
4649 \definedummyword\math
4650 \definedummyword\option
4651 \definedummyword\pxref
4652 \definedummyword\ref
4653 \definedummyword\samp
4654 \definedummyword\strong
4655 \definedummyword\tie
4656 \definedummyword\uref
4657 \definedummyword\url
4658 \definedummyword\var
4659 \definedummyword\verb
4661 \definedummyword\xref
4664 % @macro mkind{arg1,arg2}
4668 % The space after the comma will end up in the temporary definition
4669 % that we make for arg2 (see \parsemargdef ff.). We want all this to be
4670 % expanded for the sake of the index, so we end up just seeing "bar".
4671 \let\xeatspaces =
\eatspaces
4674 % For testing: output @{ and @} in index sort strings as \{ and \}.
4675 \newif\ifusebracesinindexes
4677 % \indexnofonts is used when outputting the strings to sort the index
4678 % by, and when constructing control sequence names. It eliminates all
4679 % control sequences and just writes whatever the best ASCII sort string
4680 % would be for a given command (usually its argument).
4683 % Accent commands should become @asis.
4684 \def\definedummyaccent#
#1{\let#
#1\asis}%
4685 % We can just ignore other control letters.
4686 \def\definedummyletter#
#1{\let#
#1\empty}%
4687 % All control words become @asis by default; overrides below.
4688 \let\definedummyword\definedummyaccent
4690 \commondummiesnofonts
4692 % Don't no-op \tt, since it isn't a user-level command
4693 % and is used in the definitions of the active chars like <, >, |, etc.
4694 % Likewise with the other plain tex font commands.
4699 \def\_{\normalunderscore}%
4700 \def\-
{}% @- shouldn't affect sorting
4702 % Unfortunately, texindex is not prepared to handle braces in the
4703 % content at all. So for index sorting, we map @{ and @} to strings
4704 % starting with |, since that ASCII character is between ASCII { and }.
4705 \ifusebracesinindexes
4706 \def\lbracechar{\lbracecmd}%
4707 \def\rbracechar{\rbracecmd}%
4709 \def\lbracechar{|a
}%
4710 \def\rbracechar{|b
}%
4716 % Non-English letters.
4733 \def\questiondown{?
}%
4740 % Assorted special characters.
4741 % (The following {} will end up in the sort string, but that's ok.)
4743 \def\bullet{bullet
}%
4745 \def\copyright{copyright
}%
4751 \def\expansion{==>
}%
4753 \def\guillemetleft{<<
}%
4754 \def\guillemetright{>>
}%
4755 \def\guilsinglleft{<
}%
4756 \def\guilsinglright{>
}%
4760 \def\pounds{pounds
}%
4762 \def\quotedblbase{"
}%
4763 \def\quotedblleft{"
}%
4764 \def\quotedblright{"
}%
4767 \def\quotesinglbase{,
}%
4768 \def\registeredsymbol{R
}%
4772 \expandafter\ifx\csname SETtxiindexlquoteignore
\endcsname\relax
4773 \else \indexlquoteignore \fi
4775 % We need to get rid of all macros, leaving only the arguments (if present).
4776 % Of course this is not nearly correct, but it is the best we can do for now.
4777 % makeinfo does not expand macros in the argument to @deffn, which ends up
4778 % writing an index entry, and texindex isn't prepared for an index sort entry
4779 % that starts with \.
4781 % Since macro invocations are followed by braces, we can just redefine them
4782 % to take a single TeX argument. The case of a macro invocation that
4783 % goes to end-of-line is not handled.
4788 % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us
4789 % ignore left quotes in the sort term.
4790 {\catcode`\`=
\active
4791 \gdef\indexlquoteignore{\let`=
\empty}}
4793 \let\indexbackslash=
0 %overridden during \printindex.
4794 \let\SETmarginindex=
\relax % put index entries in margin (undocumented)?
4796 % Most index entries go through here, but \dosubind is the general case.
4797 % #1 is the index name, #2 is the entry text.
4798 \def\doind#1#2{\dosubind{#1}{#2}{}}
4800 % Workhorse for all \fooindexes.
4801 % #1 is name of index, #2 is stuff to put there, #3 is subentry --
4802 % empty if called from \doind, as we usually are (the main exception
4803 % is with most defuns, which call us directly).
4805 \def\dosubind#1#2#3{%
4808 % Store the main index entry text (including the third arg).
4810 % If third arg is present, precede it with a space.
4812 \ifx\thirdarg\empty \else
4813 \toks0 =
\expandafter{\the\toks0 \space #3}%
4816 \edef\writeto{\csname#1indfile
\endcsname}%
4818 \safewhatsit\dosubindwrite
4823 % Write the entry in \toks0 to the index file:
4825 \def\dosubindwrite{%
4826 % Put the index entry in the margin if desired.
4827 \ifx\SETmarginindex\relax\else
4828 \insert\margin{\hbox{\vrule height8pt depth3pt width0pt
\the\toks0}}%
4831 % Remember, we are within a group.
4832 \indexdummies % Must do this here, since \bf, etc expand at this stage
4833 \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now
4834 % so it will be output as is; and it will print as backslash.
4836 % Process the index entry with all font commands turned off, to
4837 % get the string to sort by.
4839 \edef\temp{\the\toks0}% need full expansion
4840 \xdef\indexsorttmp{\temp}%
4843 % Set up the complete index entry, with both the sort key and
4844 % the original text, including any font commands. We write
4845 % three arguments to \entry to the .?? file (four in the
4846 % subentry case), texindex reduces to two when writing the .??s
4850 \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}%
4855 % Take care of unwanted page breaks/skips around a whatsit:
4857 % If a skip is the last thing on the list now, preserve it
4858 % by backing up by \lastskip, doing the \write, then inserting
4859 % the skip again. Otherwise, the whatsit generated by the
4860 % \write or \pdfdest will make \lastskip zero. The result is that
4861 % sequences like this:
4865 % will have extra space inserted, because the \medbreak in the
4866 % start of the @defun won't see the skip inserted by the @end of
4867 % the previous defun.
4869 % But don't do any of this if we're not in vertical mode. We
4870 % don't want to do a \vskip and prematurely end a paragraph.
4872 % Avoid page breaks due to these extra skips, too.
4874 % But wait, there is a catch there:
4875 % We'll have to check whether \lastskip is zero skip. \ifdim is not
4876 % sufficient for this purpose, as it ignores stretch and shrink parts
4877 % of the skip. The only way seems to be to check the textual
4878 % representation of the skip.
4880 % The following is almost like \def\zeroskipmacro{0.0pt} except that
4881 % the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
4883 \edef\zeroskipmacro{\expandafter\the\csname z@skip
\endcsname}
4885 \newskip\whatsitskip
4886 \newcount\whatsitpenalty
4890 \def\safewhatsit#1{\ifhmode
4893 % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
4894 \whatsitskip =
\lastskip
4895 \edef\lastskipmacro{\the\lastskip}%
4896 \whatsitpenalty =
\lastpenalty
4898 % If \lastskip is nonzero, that means the last item was a
4899 % skip. And since a skip is discardable, that means this
4900 % -\whatsitskip glue we're inserting is preceded by a
4901 % non-discardable item, therefore it is not a potential
4902 % breakpoint, therefore no \nobreak needed.
4903 \ifx\lastskipmacro\zeroskipmacro
4910 \ifx\lastskipmacro\zeroskipmacro
4911 % If \lastskip was zero, perhaps the last item was a penalty, and
4912 % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
4913 % to re-insert the same penalty (values >10000 are used for various
4914 % signals); since we just inserted a non-discardable item, any
4915 % following glue (such as a \parskip) would be a breakpoint. For example:
4916 % @deffn deffn-whatever
4917 % @vindex index-whatever
4919 % would allow a break between the index-whatever whatsit
4920 % and the "Description." paragraph.
4921 \ifnum\whatsitpenalty>
9999 \penalty\whatsitpenalty \fi
4923 % On the other hand, if we had a nonzero \lastskip,
4924 % this make-up glue would be preceded by a non-discardable item
4925 % (the whatsit from the \write), so we must insert a \nobreak.
4926 \nobreak\vskip\whatsitskip
4930 % The index entry written in the file actually looks like
4931 % \entry {sortstring}{page}{topic}
4933 % \entry {sortstring}{page}{topic}{subtopic}
4934 % The texindex program reads in these files and writes files
4935 % containing these kinds of lines:
4937 % before the first topic whose initial is c
4938 % \entry {topic}{pagelist}
4939 % for a topic that is used without subtopics
4941 % for the beginning of a topic that is used with subtopics
4942 % \secondary {subtopic}{pagelist}
4943 % for each subtopic.
4945 % Define the user-accessible indexing commands
4946 % @findex, @vindex, @kindex, @cindex.
4948 \def\findex {\fnindex}
4949 \def\kindex {\kyindex}
4950 \def\cindex {\cpindex}
4951 \def\vindex {\vrindex}
4952 \def\tindex {\tpindex}
4953 \def\pindex {\pgindex}
4955 \def\cindexsub {\begingroup\obeylines\cindexsub}
4957 \gdef\cindexsub "
#1"
#2^^M
{\endgroup %
4958 \dosubind{cp
}{#2}{#1}}}
4960 % Define the macros used in formatting output of the sorted index material.
4962 % @printindex causes a particular index (the ??s file) to get printed.
4963 % It does not print any chapter heading (usually an @unnumbered).
4965 \parseargdef\printindex{\begingroup
4966 \dobreak \chapheadingskip{10000}%
4971 \everypar =
{}% don't want the \kern\-parindent from indentation suppression.
4973 % See if the index file exists and is nonempty.
4974 % Change catcode of @ here so that if the index file contains
4976 % as its first line, TeX doesn't complain about mismatched braces
4977 % (because it thinks @} is a control sequence).
4979 \openin 1 \jobname.
#1s
4981 % \enddoublecolumns gets confused if there is no text in the index,
4982 % and it loses the chapter title and the aux file entries for the
4983 % index. The easiest way to prevent this problem is to make sure
4984 % there is some text.
4985 \putwordIndexNonexistent
4988 % If the index file exists but is empty, then \openin leaves \ifeof
4989 % false. We have to make TeX try to read something from the file, so
4990 % it can discover if there is anything in it.
4993 \putwordIndexIsEmpty
4995 % Index files are almost Texinfo source, but we use \ as the escape
4996 % character. It would be better to use @, but that's too big a change
4997 % to make right now.
4998 \def\indexbackslash{\backslashcurfont}%
5009 % These macros are used by the sorted index file itself.
5010 % Change them to control the appearance of the index.
5013 % Some minor font changes for the special characters.
5014 \let\tentt=
\sectt \let\tt=
\sectt \let\sf=
\sectt
5016 % Remove any glue we may have, we'll be inserting our own.
5019 % We like breaks before the index initials, so insert a bonus.
5021 \vskip 0pt plus
3\baselineskip
5023 \vskip 0pt plus -
3\baselineskip
5025 % Typeset the initial. Making this add up to a whole number of
5026 % baselineskips increases the chance of the dots lining up from column
5027 % to column. It still won't often be perfect, because of the stretch
5028 % we need before each entry, but it's better.
5030 % No shrink because it confuses \balancecolumns.
5031 \vskip 1.67\baselineskip plus
.5\baselineskip
5032 \leftline{\secbf #1}%
5033 % Do our best not to break after the initial.
5035 \vskip .33\baselineskip plus
.1\baselineskip
5038 % \entry typesets a paragraph consisting of the text (#1), dot leaders, and
5039 % then page number (#2) flushed to the right margin. It is used for index
5040 % and table of contents entries. The paragraph is indented by \leftskip.
5042 % A straightforward implementation would start like this:
5043 % \def\entry#1#2{...
5044 % But this freezes the catcodes in the argument, and can cause problems to
5045 % @code, which sets - active. This problem was fixed by a kludge---
5046 % ``-'' was active throughout whole index, but this isn't really right.
5047 % The right solution is to prevent \entry from swallowing the whole text.
5052 % Start a new paragraph if necessary, so our assignments below can't
5053 % affect previous text.
5056 % Do not fill out the last line with white space.
5059 % No extra space above this paragraph.
5062 % Do not prefer a separate line ending with a hyphen to fewer lines.
5063 \finalhyphendemerits =
0
5065 % \hangindent is only relevant when the entry text and page number
5066 % don't both fit on one line. In that case, bob suggests starting the
5067 % dots pretty far over on the line. Unfortunately, a large
5068 % indentation looks wrong when the entry text itself is broken across
5069 % lines. So we use a small indentation and put up with long leaders.
5071 % \hangafter is reset to 1 (which is the value we want) at the start
5072 % of each paragraph, so we need not do anything with that.
5075 % When the entry text needs to be broken, just fill out the first line
5077 \rightskip =
0pt plus1fil
5079 % A bit of stretch before each entry for the benefit of balancing
5083 % When reading the text of entry, convert explicit line breaks
5084 % from @* into spaces. The user might give these in long section
5085 % titles, for instance.
5086 \def\*
{\unskip\space\ignorespaces}%
5087 \def\entrybreak{\hfil\break}%
5089 % Swallow the left brace of the text (first parameter):
5090 \afterassignment\doentry
5093 \def\entrybreak{\unskip\space\ignorespaces}%
5095 \bgroup % Instead of the swallowed brace.
5097 \aftergroup\finishentry
5098 % And now comes the text of the entry.
5100 \def\finishentry#1{%
5101 % #1 is the page number.
5103 % The following is kludged to not output a line of dots in the index if
5104 % there are no page numbers. The next person who breaks this will be
5105 % cursed by a Unix daemon.
5106 \setbox\boxA =
\hbox{#1}%
5107 \ifdim\wd\boxA =
0pt
5111 % If we must, put the page number on a line of its own, and fill out
5112 % this line with blank space. (The \hfil is overwhelmed with the
5113 % fill leaders glue in \indexdotfill if the page number does fit.)
5115 \null\nobreak\indexdotfill % Have leaders before the page number.
5117 % The `\ ' here is removed by the implicit \unskip that TeX does as
5118 % part of (the primitive) \par. Without it, a spurious underfull
5131 % Like plain.tex's \dotfill, except uses up at least 1 em.
5132 \def\indexdotfill{\cleaders
5133 \hbox{$
\mathsurround=
0pt
\mkern1.5mu.
\mkern1.5mu$
}\hskip 1em plus
1fill
}
5135 \def\primary #1{\line{#1\hfil}}
5137 \newskip\secondaryindent \secondaryindent=
0.5cm
5138 \def\secondary#1#2{{%
5143 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill
5145 \pdfgettoks#2.\
\the\toksA % The page number ends the paragraph.
5152 % Define two-column mode, which we use to typeset indexes.
5153 % Adapted from the TeXbook, page 416, which is to say,
5154 % the manmac.tex format used to print the TeXbook itself.
5158 \newdimen\doublecolumnhsize
5160 \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
5161 % Grab any single-column material above us.
5164 % Here is a possibility not foreseen in manmac: if we accumulate a
5165 % whole lot of material, we might end up calling this \output
5166 % routine twice in a row (see the doublecol-lose test, which is
5167 % essentially a couple of indexes with @setchapternewpage off). In
5168 % that case we just ship out what is in \partialpage with the normal
5169 % output routine. Generally, \partialpage will be empty when this
5170 % runs and this will be a no-op. See the indexspread.tex test case.
5171 \ifvoid\partialpage \else
5172 \onepageout{\pagecontents\partialpage}%
5175 \global\setbox\partialpage =
\vbox{%
5176 % Unvbox the main output page.
5178 \kern-
\topskip \kern\baselineskip
5181 \eject % run that output routine to set \partialpage
5183 % Use the double-column output routine for subsequent pages.
5184 \output =
{\doublecolumnout}%
5186 % Change the page size parameters. We could do this once outside this
5187 % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
5188 % format, but then we repeat the same computation. Repeating a couple
5189 % of assignments once per index is clearly meaningless for the
5190 % execution time, so we may as well do it in one place.
5192 % First we halve the line length, less a little for the gutter between
5193 % the columns. We compute the gutter based on the line length, so it
5194 % changes automatically with the paper format. The magic constant
5195 % below is chosen so that the gutter has the same value (well, +-<1pt)
5196 % as it did when we hard-coded it.
5198 % We put the result in a separate register, \doublecolumhsize, so we
5199 % can restore it in \pagesofar, after \hsize itself has (potentially)
5202 \doublecolumnhsize =
\hsize
5203 \advance\doublecolumnhsize by -
.04154\hsize
5204 \divide\doublecolumnhsize by
2
5205 \hsize =
\doublecolumnhsize
5207 % Double the \vsize as well. (We don't need a separate register here,
5208 % since nobody clobbers \vsize.)
5212 % The double-column output routine for all double-column pages except
5215 \def\doublecolumnout{%
5216 \splittopskip=
\topskip \splitmaxdepth=
\maxdepth
5217 % Get the available space for the double columns -- the normal
5218 % (undoubled) page height minus any material left over from the
5222 \advance\dimen@ by -
\ht\partialpage
5224 % box0 will be the left-hand column, box2 the right.
5225 \setbox0=
\vsplit255 to
\dimen@
\setbox2=
\vsplit255 to
\dimen@
5226 \onepageout\pagesofar
5228 \penalty\outputpenalty
5231 % Re-output the contents of the output page -- any previous material,
5232 % followed by the two boxes we just split, in box0 and box2.
5236 \hsize =
\doublecolumnhsize
5237 \wd0=
\hsize \wd2=
\hsize
5238 \hbox to
\pagewidth{\box0\hfil\box2}%
5241 % All done with double columns.
5242 \def\enddoublecolumns{%
5243 % The following penalty ensures that the page builder is exercised
5244 % _before_ we change the output routine. This is necessary in the
5245 % following situation:
5247 % The last section of the index consists only of a single entry.
5248 % Before this section, \pagetotal is less than \pagegoal, so no
5249 % break occurs before the last section starts. However, the last
5250 % section, consisting of \initial and the single \entry, does not
5251 % fit on the page and has to be broken off. Without the following
5252 % penalty the page builder will not be exercised until \eject
5253 % below, and by that time we'll already have changed the output
5254 % routine to the \balancecolumns version, so the next-to-last
5255 % double-column page will be processed with \balancecolumns, which
5256 % is wrong: The two columns will go to the main vertical list, with
5257 % the broken-off section in the recent contributions. As soon as
5258 % the output routine finishes, TeX starts reconsidering the page
5259 % break. The two columns and the broken-off section both fit on the
5260 % page, because the two columns now take up only half of the page
5261 % goal. When TeX sees \eject from below which follows the final
5262 % section, it invokes the new output routine that we've set after
5263 % \balancecolumns below; \onepageout will try to fit the two columns
5264 % and the final section into the vbox of \pageheight (see
5265 % \pagebody), causing an overfull box.
5267 % Note that glue won't work here, because glue does not exercise the
5268 % page builder, unlike penalties (see The TeXbook, pp. 280-281).
5272 % Split the last of the double-column material. Leave it on the
5273 % current page, no automatic page break.
5276 % If we end up splitting too much material for the current page,
5277 % though, there will be another page break right after this \output
5278 % invocation ends. Having called \balancecolumns once, we do not
5279 % want to call it again. Therefore, reset \output to its normal
5280 % definition right away. (We hope \balancecolumns will never be
5281 % called on to balance too much material, but if it is, this makes
5282 % the output somewhat more palatable.)
5283 \global\output =
{\onepageout{\pagecontents\PAGE}}%
5286 \endgroup % started in \begindoublecolumns
5288 % \pagegoal was set to the doubled \vsize above, since we restarted
5289 % the current page. We're now back to normal single-column
5290 % typesetting, so reset \pagegoal to the normal \vsize (after the
5291 % \endgroup where \vsize got restored).
5295 % Called at the end of the double column material.
5296 \def\balancecolumns{%
5297 \setbox0 =
\vbox{\unvbox255}% like \box255 but more efficient, see p.120.
5299 \advance\dimen@ by
\topskip
5300 \advance\dimen@ by-
\baselineskip
5301 \divide\dimen@ by
2 % target to split to
5302 %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}%
5303 \splittopskip =
\topskip
5304 % Loop until we get a decent breakpoint.
5308 \global\setbox3 =
\copy0
5309 \global\setbox1 =
\vsplit3 to
\dimen@
5311 \global\advance\dimen@ by
1pt
5314 %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}%
5315 \setbox0=
\vbox to
\dimen@
{\unvbox1}%
5316 \setbox2=
\vbox to
\dimen@
{\unvbox3}%
5320 \catcode`\@ =
\other
5323 \message{sectioning,
}
5324 % Chapters, sections, etc.
5326 % Let's start with @part.
5327 \outer\parseargdef\part{\partzzz{#1}}
5331 \vskip.3\vsize % move it down on the page a bit
5333 \noindent \titlefonts\rmisbold #1\par % the text
5334 \let\lastnode=
\empty % no node to associate with
5335 \writetocentry{part
}{#1}{}% but put it in the toc
5336 \headingsoff % no headline or footline on the part page
5341 % \unnumberedno is an oxymoron. But we count the unnumbered
5342 % sections so that we can refer to them unambiguously in the pdf
5343 % outlines by their "section number". We avoid collisions with chapter
5344 % numbers by starting them at 10000. (If a document ever has 10000
5345 % chapters, we're in trouble anyway, I'm sure.)
5346 \newcount\unnumberedno \unnumberedno =
10000
5348 \newcount\secno \secno=
0
5349 \newcount\subsecno \subsecno=
0
5350 \newcount\subsubsecno \subsubsecno=
0
5352 % This counter is funny since it counts through charcodes of letters A, B, ...
5353 \newcount\appendixno \appendixno = `\@
5355 % \def\appendixletter{\char\the\appendixno}
5356 % We do the following ugly conditional instead of the above simple
5357 % construct for the sake of pdftex, which needs the actual
5358 % letter in the expansion, not just typeset.
5360 \def\appendixletter{%
5361 \ifnum\appendixno=`A A
%
5362 \else\ifnum\appendixno=`B B
%
5363 \else\ifnum\appendixno=`C C
%
5364 \else\ifnum\appendixno=`D D
%
5365 \else\ifnum\appendixno=`E E
%
5366 \else\ifnum\appendixno=`F F
%
5367 \else\ifnum\appendixno=`G G
%
5368 \else\ifnum\appendixno=`H H
%
5369 \else\ifnum\appendixno=`I I
%
5370 \else\ifnum\appendixno=`J J
%
5371 \else\ifnum\appendixno=`K K
%
5372 \else\ifnum\appendixno=`L L
%
5373 \else\ifnum\appendixno=`M M
%
5374 \else\ifnum\appendixno=`N N
%
5375 \else\ifnum\appendixno=`O O
%
5376 \else\ifnum\appendixno=`P P
%
5377 \else\ifnum\appendixno=`Q Q
%
5378 \else\ifnum\appendixno=`R R
%
5379 \else\ifnum\appendixno=`S S
%
5380 \else\ifnum\appendixno=`T T
%
5381 \else\ifnum\appendixno=`U U
%
5382 \else\ifnum\appendixno=`V V
%
5383 \else\ifnum\appendixno=`W W
%
5384 \else\ifnum\appendixno=`X X
%
5385 \else\ifnum\appendixno=`Y Y
%
5386 \else\ifnum\appendixno=`Z Z
%
5387 % The \the is necessary, despite appearances, because \appendixletter is
5388 % expanded while writing the .toc file. \char\appendixno is not
5389 % expandable, thus it is written literally, thus all appendixes come out
5390 % with the same letter (or @) in the toc without it.
5391 \else\char\the\appendixno
5392 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
5393 \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
5395 % Each @chapter defines these (using marks) as the number+name, number
5396 % and name of the chapter. Page headings and footings can use
5397 % these. @section does likewise.
5399 \def\thischapternum{}
5400 \def\thischaptername{}
5402 \def\thissectionnum{}
5403 \def\thissectionname{}
5405 \newcount\absseclevel % used to calculate proper heading level
5406 \newcount\secbase\secbase=
0 % @raisesections/@lowersections modify this count
5408 % @raisesections: treat @section as chapter, @subsection as section, etc.
5409 \def\raisesections{\global\advance\secbase by -
1}
5410 \let\up=
\raisesections % original BFox name
5412 % @lowersections: treat @chapter as section, @section as subsection, etc.
5413 \def\lowersections{\global\advance\secbase by
1}
5414 \let\down=
\lowersections % original BFox name
5416 % we only have subsub.
5417 \chardef\maxseclevel =
3
5419 % A numbered section within an unnumbered changes to unnumbered too.
5420 % To achieve this, remember the "biggest" unnum. sec. we are currently in:
5421 \chardef\unnlevel =
\maxseclevel
5423 % Trace whether the current chapter is an appendix or not:
5424 % \chapheadtype is "N" or "A", unnumbered chapters are ignored.
5425 \def\chapheadtype{N
}
5427 % Choose a heading macro
5428 % #1 is heading type
5429 % #2 is heading level
5430 % #3 is text for heading
5431 \def\genhead#1#2#3{%
5432 % Compute the abs. sec. level:
5434 \advance\absseclevel by
\secbase
5435 % Make sure \absseclevel doesn't fall outside the range:
5436 \ifnum \absseclevel <
0
5439 \ifnum \absseclevel >
3
5446 \ifnum \absseclevel <
\unnlevel
5447 \chardef\unnlevel =
\absseclevel
5450 % Check for appendix sections:
5451 \ifnum \absseclevel =
0
5452 \edef\chapheadtype{\headtype}%
5454 \if \headtype A
\if \chapheadtype N
%
5455 \errmessage{@appendix... within a non-appendix chapter
}%
5458 % Check for numbered within unnumbered:
5459 \ifnum \absseclevel >
\unnlevel
5462 \chardef\unnlevel =
3
5465 % Now print the heading:
5469 \or \unnumberedseczzz{#3}%
5470 \or \unnumberedsubseczzz{#3}%
5471 \or \unnumberedsubsubseczzz{#3}%
5477 \or \appendixsectionzzz{#3}%
5478 \or \appendixsubseczzz{#3}%
5479 \or \appendixsubsubseczzz{#3}%
5485 \or \numberedsubseczzz{#3}%
5486 \or \numberedsubsubseczzz{#3}%
5490 \suppressfirstparagraphindent
5494 \def\numhead{\genhead N
}
5495 \def\apphead{\genhead A
}
5496 \def\unnmhead{\genhead U
}
5498 % @chapter, @appendix, @unnumbered. Increment top-level counter, reset
5499 % all lower-level sectioning counters to zero.
5501 % Also set \chaplevelprefix, which we prepend to @float sequence numbers
5502 % (e.g., figures), q.v. By default (before any chapter), that is empty.
5503 \let\chaplevelprefix =
\empty
5505 \outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
5507 % section resetting is \global in case the chapter is in a group, such
5508 % as an @include file.
5509 \global\secno=
0 \global\subsecno=
0 \global\subsubsecno=
0
5510 \global\advance\chapno by
1
5513 \gdef\chaplevelprefix{\the\chapno.
}%
5516 % \putwordChapter can contain complex things in translations.
5517 \toks0=
\expandafter{\putwordChapter}%
5518 \message{\the\toks0 \space \the\chapno}%
5520 % Write the actual heading.
5521 \chapmacro{#1}{Ynumbered
}{\the\chapno}%
5523 % So @section and the like are numbered underneath this chapter.
5524 \global\let\section =
\numberedsec
5525 \global\let\subsection =
\numberedsubsec
5526 \global\let\subsubsection =
\numberedsubsubsec
5529 \outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
5531 \def\appendixzzz#1{%
5532 \global\secno=
0 \global\subsecno=
0 \global\subsubsecno=
0
5533 \global\advance\appendixno by
1
5534 \gdef\chaplevelprefix{\appendixletter.
}%
5537 % \putwordAppendix can contain complex things in translations.
5538 \toks0=
\expandafter{\putwordAppendix}%
5539 \message{\the\toks0 \space \appendixletter}%
5541 \chapmacro{#1}{Yappendix
}{\appendixletter}%
5543 \global\let\section =
\appendixsec
5544 \global\let\subsection =
\appendixsubsec
5545 \global\let\subsubsection =
\appendixsubsubsec
5548 % normally unnmhead0 calls unnumberedzzz:
5549 \outer\parseargdef\unnumbered{\unnmhead0{#1}}
5550 \def\unnumberedzzz#1{%
5551 \global\secno=
0 \global\subsecno=
0 \global\subsubsecno=
0
5552 \global\advance\unnumberedno by
1
5554 % Since an unnumbered has no number, no prefix for figures.
5555 \global\let\chaplevelprefix =
\empty
5558 % This used to be simply \message{#1}, but TeX fully expands the
5559 % argument to \message. Therefore, if #1 contained @-commands, TeX
5560 % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
5561 % expanded @cite (which turns out to cause errors because \cite is meant
5562 % to be executed, not expanded).
5564 % Anyway, we don't want the fully-expanded definition of @cite to appear
5565 % as a result of the \message, we just want `@cite' itself. We use
5566 % \the<toks register> to achieve this: TeX expands \the<toks> only once,
5567 % simply yielding the contents of <toks register>. (We also do this for
5570 \message{(
\the\toks0)
}%
5572 \chapmacro{#1}{Ynothing
}{\the\unnumberedno}%
5574 \global\let\section =
\unnumberedsec
5575 \global\let\subsection =
\unnumberedsubsec
5576 \global\let\subsubsection =
\unnumberedsubsubsec
5579 % @centerchap is like @unnumbered, but the heading is centered.
5580 \outer\parseargdef\centerchap{%
5581 % Well, we could do the following in a group, but that would break
5582 % an assumption that \chapmacro is called at the outermost level.
5583 % Thus we are safer this way: --kasal, 24feb04
5584 \let\centerparametersmaybe =
\centerparameters
5586 \let\centerparametersmaybe =
\relax
5589 % @top is like @unnumbered.
5594 \outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
5596 \global\subsecno=
0 \global\subsubsecno=
0 \global\advance\secno by
1
5597 \sectionheading{#1}{sec
}{Ynumbered
}{\the\chapno.
\the\secno}%
5600 % normally calls appendixsectionzzz:
5601 \outer\parseargdef\appendixsection{\apphead1{#1}}
5602 \def\appendixsectionzzz#1{%
5603 \global\subsecno=
0 \global\subsubsecno=
0 \global\advance\secno by
1
5604 \sectionheading{#1}{sec
}{Yappendix
}{\appendixletter.
\the\secno}%
5606 \let\appendixsec\appendixsection
5608 % normally calls unnumberedseczzz:
5609 \outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
5610 \def\unnumberedseczzz#1{%
5611 \global\subsecno=
0 \global\subsubsecno=
0 \global\advance\secno by
1
5612 \sectionheading{#1}{sec
}{Ynothing
}{\the\unnumberedno.
\the\secno}%
5617 % normally calls numberedsubseczzz:
5618 \outer\parseargdef\numberedsubsec{\numhead2{#1}}
5619 \def\numberedsubseczzz#1{%
5620 \global\subsubsecno=
0 \global\advance\subsecno by
1
5621 \sectionheading{#1}{subsec
}{Ynumbered
}{\the\chapno.
\the\secno.
\the\subsecno}%
5624 % normally calls appendixsubseczzz:
5625 \outer\parseargdef\appendixsubsec{\apphead2{#1}}
5626 \def\appendixsubseczzz#1{%
5627 \global\subsubsecno=
0 \global\advance\subsecno by
1
5628 \sectionheading{#1}{subsec
}{Yappendix
}%
5629 {\appendixletter.
\the\secno.
\the\subsecno}%
5632 % normally calls unnumberedsubseczzz:
5633 \outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
5634 \def\unnumberedsubseczzz#1{%
5635 \global\subsubsecno=
0 \global\advance\subsecno by
1
5636 \sectionheading{#1}{subsec
}{Ynothing
}%
5637 {\the\unnumberedno.
\the\secno.
\the\subsecno}%
5642 % normally numberedsubsubseczzz:
5643 \outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
5644 \def\numberedsubsubseczzz#1{%
5645 \global\advance\subsubsecno by
1
5646 \sectionheading{#1}{subsubsec
}{Ynumbered
}%
5647 {\the\chapno.
\the\secno.
\the\subsecno.
\the\subsubsecno}%
5650 % normally appendixsubsubseczzz:
5651 \outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
5652 \def\appendixsubsubseczzz#1{%
5653 \global\advance\subsubsecno by
1
5654 \sectionheading{#1}{subsubsec
}{Yappendix
}%
5655 {\appendixletter.
\the\secno.
\the\subsecno.
\the\subsubsecno}%
5658 % normally unnumberedsubsubseczzz:
5659 \outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
5660 \def\unnumberedsubsubseczzz#1{%
5661 \global\advance\subsubsecno by
1
5662 \sectionheading{#1}{subsubsec
}{Ynothing
}%
5663 {\the\unnumberedno.
\the\secno.
\the\subsecno.
\the\subsubsecno}%
5666 % These macros control what the section commands do, according
5667 % to what kind of chapter we are in (ordinary, appendix, or unnumbered).
5668 % Define them by default for a numbered chapter.
5669 \let\section =
\numberedsec
5670 \let\subsection =
\numberedsubsec
5671 \let\subsubsection =
\numberedsubsubsec
5673 % Define @majorheading, @heading and @subheading
5676 {\advance\chapheadingskip by
10pt
\chapbreak }%
5677 \parsearg\chapheadingzzz
5680 \def\chapheading{\chapbreak \parsearg\chapheadingzzz}
5681 \def\chapheadingzzz#1{%
5682 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5683 \nobreak\bigskip \nobreak
5684 \suppressfirstparagraphindent
5687 % @heading, @subheading, @subsubheading.
5688 \parseargdef\heading{\sectionheading{#1}{sec
}{Yomitfromtoc
}{}
5689 \suppressfirstparagraphindent}
5690 \parseargdef\subheading{\sectionheading{#1}{subsec
}{Yomitfromtoc
}{}
5691 \suppressfirstparagraphindent}
5692 \parseargdef\subsubheading{\sectionheading{#1}{subsubsec
}{Yomitfromtoc
}{}
5693 \suppressfirstparagraphindent}
5695 % These macros generate a chapter, section, etc. heading only
5696 % (including whitespace, linebreaking, etc. around it),
5697 % given all the information in convenient, parsed form.
5699 % Args are the skip and penalty (usually negative)
5700 \def\dobreak#1#2{\par\ifdim\lastskip<
#1\removelastskip\penalty#2\vskip#1\fi}
5702 % Parameter controlling skip before chapter headings (if needed)
5703 \newskip\chapheadingskip
5705 % Define plain chapter starts, and page on/off switching for it.
5706 \def\chapbreak{\dobreak \chapheadingskip {-
4000}}
5707 \def\chappager{\par\vfill\supereject}
5708 % Because \domark is called before \chapoddpage, the filler page will
5709 % get the headings for the next chapter, which is wrong. But we don't
5710 % care -- we just disable all headings on the filler page.
5722 \def\setchapternewpage #1 {\csname CHAPPAG
#1\endcsname}
5725 \global\let\contentsalignmacro =
\chappager
5726 \global\let\pchapsepmacro=
\chapbreak
5727 \global\let\pagealignmacro=
\chappager}
5730 \global\let\contentsalignmacro =
\chappager
5731 \global\let\pchapsepmacro=
\chappager
5732 \global\let\pagealignmacro=
\chappager
5733 \global\def\HEADINGSon{\HEADINGSsingle}}
5736 \global\let\contentsalignmacro =
\chapoddpage
5737 \global\let\pchapsepmacro=
\chapoddpage
5738 \global\let\pagealignmacro=
\chapoddpage
5739 \global\def\HEADINGSon{\HEADINGSdouble}}
5745 % #1 is the text, #2 is the section type (Ynumbered, Ynothing,
5746 % Yappendix, Yomitfromtoc), #3 the chapter number.
5747 % Not used for @heading series.
5749 % To test against our argument.
5750 \def\Ynothingkeyword{Ynothing
}
5751 \def\Yappendixkeyword{Yappendix
}
5752 \def\Yomitfromtockeyword{Yomitfromtoc
}
5754 \def\chapmacro#1#2#3{%
5755 \checkenv{}% chapters, etc., should not start inside an environment.
5757 % Insert the first mark before the heading break (see notes for \domark).
5758 \let\prevchapterdefs=
\lastchapterdefs
5759 \let\prevsectiondefs=
\lastsectiondefs
5760 \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
5761 \gdef\thissection{}}%
5764 \ifx\temptype\Ynothingkeyword
5765 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5766 \gdef\thischapter{\thischaptername}}%
5767 \else\ifx\temptype\Yomitfromtockeyword
5768 \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
5769 \gdef\thischapter{}}%
5770 \else\ifx\temptype\Yappendixkeyword
5772 \xdef\lastchapterdefs{%
5773 \gdef\noexpand\thischaptername{\the\toks0}%
5774 \gdef\noexpand\thischapternum{\appendixletter}%
5775 % \noexpand\putwordAppendix avoids expanding indigestible
5776 % commands in some of the translations.
5777 \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
5778 \noexpand\thischapternum:
5779 \noexpand\thischaptername}%
5783 \xdef\lastchapterdefs{%
5784 \gdef\noexpand\thischaptername{\the\toks0}%
5785 \gdef\noexpand\thischapternum{\the\chapno}%
5786 % \noexpand\putwordChapter avoids expanding indigestible
5787 % commands in some of the translations.
5788 \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
5789 \noexpand\thischapternum:
5790 \noexpand\thischaptername}%
5794 % Output the mark. Pass it through \safewhatsit, to take care of
5795 % the preceding space.
5798 % Insert the chapter heading break.
5801 % Now the second mark, after the heading break. No break points
5802 % between here and the heading.
5803 \let\prevchapterdefs=
\lastchapterdefs
5804 \let\prevsectiondefs=
\lastsectiondefs
5808 \chapfonts \rmisbold
5809 \let\footnote=
\errfootnoteheading % give better error message
5811 % Have to define \lastsection before calling \donoderef, because the
5812 % xref code eventually uses it. On the other hand, it has to be called
5813 % after \pchapsepmacro, or the headline will change too soon.
5814 \gdef\lastsection{#1}%
5816 % Only insert the separating space if we have a chapter/appendix
5817 % number, and don't print the unnumbered ``number''.
5818 \ifx\temptype\Ynothingkeyword
5820 \def\toctype{unnchap
}%
5821 \else\ifx\temptype\Yomitfromtockeyword
5822 \setbox0 =
\hbox{}% contents like unnumbered, but no toc entry
5824 \else\ifx\temptype\Yappendixkeyword
5825 \setbox0 =
\hbox{\putwordAppendix{} #3\enspace}%
5828 \setbox0 =
\hbox{#3\enspace}%
5829 \def\toctype{numchap
}%
5832 % Write the toc entry for this chapter. Must come before the
5833 % \donoderef, because we include the current node name in the toc
5834 % entry, and \donoderef resets it to empty.
5835 \writetocentry{\toctype}{#1}{#3}%
5837 % For pdftex, we have to write out the node definition (aka, make
5838 % the pdfdest) after any page break, but before the actual text has
5839 % been typeset. If the destination for the pdf outline is after the
5840 % text, then jumping from the outline may wind up with the text not
5841 % being visible, for instance under high magnification.
5844 % Typeset the actual heading.
5845 \nobreak % Avoid page breaks at the interline glue.
5846 \vbox{\raggedtitlesettings \hangindent=
\wd0 \centerparametersmaybe
5849 \nobreak\bigskip % no page break after a chapter title
5853 % @centerchap -- centered and unnumbered.
5854 \let\centerparametersmaybe =
\relax
5855 \def\centerparameters{%
5856 \advance\rightskip by
3\rightskip
5857 \leftskip =
\rightskip
5862 % I don't think this chapter style is supported any more, so I'm not
5863 % updating it with the new noderef stuff. We'll see. --karl, 11aug03.
5865 \def\setchapterstyle #1 {\csname CHAPF
#1\endcsname}
5867 \def\unnchfopen #1{%
5869 \vbox{\chapfonts \raggedtitlesettings #1\par}%
5870 \nobreak\bigskip\nobreak
5872 \def\chfopen #1#2{\chapoddpage {\chapfonts
5873 \vbox to
3in
{\vfil \hbox to
\hsize{\hfil #2} \hbox to
\hsize{\hfil #1} \vfil}}%
5876 \def\centerchfopen #1{%
5878 \vbox{\chapfonts \raggedtitlesettings \hfill #1\hfill}%
5879 \nobreak\bigskip \nobreak
5882 \global\let\chapmacro=
\chfopen
5883 \global\let\centerchapmacro=
\centerchfopen}
5886 % Section titles. These macros combine the section number parts and
5887 % call the generic \sectionheading to do the printing.
5889 \newskip\secheadingskip
5890 \def\secheadingbreak{\dobreak \secheadingskip{-
1000}}
5892 % Subsection titles.
5893 \newskip\subsecheadingskip
5894 \def\subsecheadingbreak{\dobreak \subsecheadingskip{-
500}}
5896 % Subsubsection titles.
5897 \def\subsubsecheadingskip{\subsecheadingskip}
5898 \def\subsubsecheadingbreak{\subsecheadingbreak}
5901 % Print any size, any type, section title.
5903 % #1 is the text of the title,
5904 % #2 is the section level (sec/subsec/subsubsec),
5905 % #3 is the section type (Ynumbered, Ynothing, Yappendix, Yomitfromtoc),
5906 % #4 is the section number.
5908 \def\seckeyword{sec
}
5910 \def\sectionheading#1#2#3#4{%
5912 \def\sectionlevel{#2}%
5915 % It is ok for the @heading series commands to appear inside an
5916 % environment (it's been historically allowed, though the logic is
5917 % dubious), but not the others.
5918 \ifx\temptype\Yomitfromtockeyword\else
5919 \checkenv{}% non-@*heading should not be in an environment.
5921 \let\footnote=
\errfootnoteheading
5923 % Switch to the right set of fonts.
5924 \csname #2fonts
\endcsname \rmisbold
5926 % Insert first mark before the heading break (see notes for \domark).
5927 \let\prevsectiondefs=
\lastsectiondefs
5928 \ifx\temptype\Ynothingkeyword
5929 \ifx\sectionlevel\seckeyword
5930 \gdef\lastsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
5931 \gdef\thissection{\thissectionname}}%
5933 \else\ifx\temptype\Yomitfromtockeyword
5934 % Don't redefine \thissection.
5935 \else\ifx\temptype\Yappendixkeyword
5936 \ifx\sectionlevel\seckeyword
5938 \xdef\lastsectiondefs{%
5939 \gdef\noexpand\thissectionname{\the\toks0}%
5940 \gdef\noexpand\thissectionnum{#4}%
5941 % \noexpand\putwordSection avoids expanding indigestible
5942 % commands in some of the translations.
5943 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5944 \noexpand\thissectionnum:
5945 \noexpand\thissectionname}%
5949 \ifx\sectionlevel\seckeyword
5951 \xdef\lastsectiondefs{%
5952 \gdef\noexpand\thissectionname{\the\toks0}%
5953 \gdef\noexpand\thissectionnum{#4}%
5954 % \noexpand\putwordSection avoids expanding indigestible
5955 % commands in some of the translations.
5956 \gdef\noexpand\thissection{\noexpand\putwordSection{}
5957 \noexpand\thissectionnum:
5958 \noexpand\thissectionname}%
5963 % Go into vertical mode. Usually we'll already be there, but we
5964 % don't want the following whatsit to end up in a preceding paragraph
5965 % if the document didn't happen to have a blank line.
5968 % Output the mark. Pass it through \safewhatsit, to take care of
5969 % the preceding space.
5972 % Insert space above the heading.
5973 \csname #2headingbreak
\endcsname
5975 % Now the second mark, after the heading break. No break points
5976 % between here and the heading.
5977 \global\let\prevsectiondefs=
\lastsectiondefs
5980 % Only insert the space after the number if we have a section number.
5981 \ifx\temptype\Ynothingkeyword
5984 \gdef\lastsection{#1}%
5985 \else\ifx\temptype\Yomitfromtockeyword
5986 % for @headings -- no section number, don't include in toc,
5987 % and don't redefine \lastsection.
5990 \let\sectionlevel=
\empty
5991 \else\ifx\temptype\Yappendixkeyword
5992 \setbox0 =
\hbox{#4\enspace}%
5994 \gdef\lastsection{#1}%
5996 \setbox0 =
\hbox{#4\enspace}%
5998 \gdef\lastsection{#1}%
6001 % Write the toc entry (before \donoderef). See comments in \chapmacro.
6002 \writetocentry{\toctype\sectionlevel}{#1}{#4}%
6004 % Write the node reference (= pdf destination for pdftex).
6005 % Again, see comments in \chapmacro.
6008 % Interline glue will be inserted when the vbox is completed.
6009 % That glue will be a valid breakpoint for the page, since it'll be
6010 % preceded by a whatsit (usually from the \donoderef, or from the
6011 % \writetocentry if there was no node). We don't want to allow that
6012 % break, since then the whatsits could end up on page n while the
6013 % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
6016 % Output the actual section heading.
6017 \vbox{\hyphenpenalty=
10000 \tolerance=
5000 \parindent=
0pt
\ptexraggedright
6018 \hangindent=
\wd0 % zero if no section number
6021 % Add extra space after the heading -- half of whatever came above it.
6022 % Don't allow stretch, though.
6023 \kern .5 \csname #2headingskip
\endcsname
6025 % Do not let the kern be a potential breakpoint, as it would be if it
6026 % was followed by glue.
6029 % We'll almost certainly start a paragraph next, so don't let that
6030 % glue accumulate. (Not a breakpoint because it's preceded by a
6031 % discardable item.) However, when a paragraph is not started next
6032 % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
6033 % or the negative glue will cause weirdly wrong output, typically
6034 % obscuring the section heading with something else.
6037 % This is so the last item on the main vertical list is a known
6038 % \penalty > 10000, so \startdefun, etc., can recognize the situation
6039 % and do the needful.
6045 % Table of contents.
6048 % Write an entry to the toc file, opening it if necessary.
6049 % Called from @chapter, etc.
6051 % Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
6052 % We append the current node name (if any) and page number as additional
6053 % arguments for the \{chap,sec,...}entry macros which will eventually
6054 % read this. The node name is used in the pdf outlines as the
6055 % destination to jump to.
6057 % We open the .toc file for writing here instead of at @setfilename (or
6058 % any other fixed time) so that @contents can be anywhere in the document.
6059 % But if #1 is `omit', then we don't do anything. This is used for the
6060 % table of contents chapter openings themselves.
6062 \newif\iftocfileopened
6063 \def\omitkeyword{omit
}%
6065 \def\writetocentry#1#2#3{%
6066 \edef\writetoctype{#1}%
6067 \ifx\writetoctype\omitkeyword \else
6068 \iftocfileopened\else
6069 \immediate\openout\tocfile =
\jobname.toc
6070 \global\tocfileopenedtrue
6076 \write\tocfile{@
#1entry
{#2}{#3}{\lastnode}{\noexpand\folio}}}%
6082 % Tell \shipout to create a pdf destination on each page, if we're
6083 % writing pdf. These are used in the table of contents. We can't
6084 % just write one on every page because the title pages are numbered
6085 % 1 and 2 (the page numbers aren't printed), and so are the first
6086 % two pages of the document. Thus, we'd have two destinations named
6087 % `1', and two named `2'.
6088 \ifpdf \global\pdfmakepagedesttrue \fi
6092 % These characters do not print properly in the Computer Modern roman
6093 % fonts, so we must take special care. This is more or less redundant
6094 % with the Texinfo input format setup at the end of this file.
6096 \def\activecatcodes{%
6109 % Read the toc file, which is essentially Texinfo input.
6113 \input \tocreadfilename
6116 \newskip\contentsrightmargin \contentsrightmargin=
1in
6117 \newcount\savepageno
6118 \newcount\lastnegativepageno \lastnegativepageno = -
1
6120 % Prepare to read what we've written to \tocfile.
6122 \def\startcontents#1{%
6123 % If @setchapternewpage on, and @headings double, the contents should
6124 % start on an odd page, unlike chapters. Thus, we maintain
6125 % \contentsalignmacro in parallel with \pagealignmacro.
6126 % From: Torbjorn Granlund <tege@matematik.su.se>
6128 \immediate\closeout\tocfile
6130 % Don't need to put `Contents' or `Short Contents' in the headline.
6131 % It is abundantly clear what they are.
6132 \chapmacro{#1}{Yomitfromtoc
}{}%
6134 \savepageno =
\pageno
6135 \begingroup % Set up to handle contents files properly.
6136 \raggedbottom % Worry more about breakpoints than the bottom.
6137 \advance\hsize by -
\contentsrightmargin % Don't use the full line length.
6139 % Roman numerals for page numbers.
6140 \ifnum \pageno>
0 \global\pageno =
\lastnegativepageno \fi
6143 % redefined for the two-volume lispref. We always output on
6144 % \jobname.toc even if this is redefined.
6146 \def\tocreadfilename{\jobname.toc
}
6148 % Normal (long) toc.
6151 \startcontents{\putwordTOC}%
6152 \openin 1 \tocreadfilename\space
6157 \contentsalignmacro % in case @setchapternewpage odd is in effect
6163 \lastnegativepageno =
\pageno
6164 \global\pageno =
\savepageno
6167 % And just the chapters.
6168 \def\summarycontents{%
6169 \startcontents{\putwordShortTOC}%
6171 \let\partentry =
\shortpartentry
6172 \let\numchapentry =
\shortchapentry
6173 \let\appentry =
\shortchapentry
6174 \let\unnchapentry =
\shortunnchapentry
6175 % We want a true roman here for the page numbers.
6177 \let\rm=
\shortcontrm \let\bf=
\shortcontbf
6178 \let\sl=
\shortcontsl \let\tt=
\shortconttt
6180 \hyphenpenalty =
10000
6181 \advance\baselineskip by
1pt
% Open it up a little.
6182 \def\numsecentry#
#1#
#2#
#3#
#4{}
6183 \let\appsecentry =
\numsecentry
6184 \let\unnsecentry =
\numsecentry
6185 \let\numsubsecentry =
\numsecentry
6186 \let\appsubsecentry =
\numsecentry
6187 \let\unnsubsecentry =
\numsecentry
6188 \let\numsubsubsecentry =
\numsecentry
6189 \let\appsubsubsecentry =
\numsecentry
6190 \let\unnsubsubsecentry =
\numsecentry
6191 \openin 1 \tocreadfilename\space
6197 \contentsalignmacro % in case @setchapternewpage odd is in effect
6199 \lastnegativepageno =
\pageno
6200 \global\pageno =
\savepageno
6202 \let\shortcontents =
\summarycontents
6204 % Typeset the label for a chapter or appendix for the short contents.
6205 % The arg is, e.g., `A' for an appendix, or `3' for a chapter.
6207 \def\shortchaplabel#1{%
6208 % This space should be enough, since a single number is .5em, and the
6209 % widest letter (M) is 1em, at least in the Computer Modern fonts.
6210 % But use \hss just in case.
6211 % (This space doesn't include the extra space that gets added after
6212 % the label; that gets put in by \shortchapentry above.)
6214 % We'd like to right-justify chapter numbers, but that looks strange
6215 % with appendix letters. And right-justifying numbers and
6216 % left-justifying letters looks strange when there is less than 10
6217 % chapters. Have to read the whole toc once to know how many chapters
6218 % there are before deciding ...
6219 \hbox to
1em
{#1\hss}%
6222 % These macros generate individual entries in the table of contents.
6223 % The first argument is the chapter or section name.
6224 % The last argument is the page number.
6225 % The arguments in between are the chapter number, section number, ...
6227 % Parts, in the main contents. Replace the part number, which doesn't
6228 % exist, with an empty box. Let's hope all the numbers have the same width.
6229 % Also ignore the page number, which is conventionally not printed.
6230 \def\numeralbox{\setbox0=
\hbox{8}\hbox to
\wd0{\hfil}}
6231 \def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}}
6233 % Parts, in the short toc.
6234 \def\shortpartentry#1#2#3#4{%
6236 \vskip.5\baselineskip plus
.15\baselineskip minus
.1\baselineskip
6237 \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
6240 % Chapters, in the main contents.
6241 \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
6243 % Chapters, in the short toc.
6244 % See comments in \dochapentry re vbox and related settings.
6245 \def\shortchapentry#1#2#3#4{%
6246 \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
6249 % Appendices, in the main contents.
6250 % Need the word Appendix, and a fixed-size box.
6252 \def\appendixbox#1{%
6253 % We use M since it's probably the widest letter.
6254 \setbox0 =
\hbox{\putwordAppendix{} M
}%
6255 \hbox to
\wd0{\putwordAppendix{} #1\hss}}
6257 \def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}}
6259 % Unnumbered chapters.
6260 \def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
6261 \def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
6264 \def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
6265 \let\appsecentry=
\numsecentry
6266 \def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
6269 \def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
6270 \let\appsubsecentry=
\numsubsecentry
6271 \def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
6273 % And subsubsections.
6274 \def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
6275 \let\appsubsubsecentry=
\numsubsubsecentry
6276 \def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
6278 % This parameter controls the indentation of the various levels.
6279 % Same as \defaultparindent.
6280 \newdimen\tocindent \tocindent =
15pt
6282 % Now for the actual typesetting. In all these, #1 is the text and #2 is the
6285 % If the toc has to be broken over pages, we want it to be at chapters
6286 % if at all possible; hence the \penalty.
6287 \def\dochapentry#1#2{%
6288 \penalty-
300 \vskip1\baselineskip plus
.33\baselineskip minus
.25\baselineskip
6291 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6293 \nobreak\vskip .25\baselineskip plus
.1\baselineskip
6296 \def\dosecentry#1#2{\begingroup
6297 \secentryfonts \leftskip=
\tocindent
6298 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6301 \def\dosubsecentry#1#2{\begingroup
6302 \subsecentryfonts \leftskip=
2\tocindent
6303 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6306 \def\dosubsubsecentry#1#2{\begingroup
6307 \subsubsecentryfonts \leftskip=
3\tocindent
6308 \tocentry{#1}{\dopageno\bgroup#2\egroup}%
6311 % We use the same \entry macro as for the index entries.
6312 \let\tocentry =
\entry
6314 % Space between chapter (or whatever) number and the title.
6315 \def\labelspace{\hskip1em \relax}
6317 \def\dopageno#1{{\rm #1}}
6318 \def\doshortpageno#1{{\rm #1}}
6320 \def\chapentryfonts{\secfonts \rm}
6321 \def\secentryfonts{\textfonts}
6322 \def\subsecentryfonts{\textfonts}
6323 \def\subsubsecentryfonts{\textfonts}
6326 \message{environments,
}
6327 % @foo ... @end foo.
6329 % @tex ... @end tex escapes into raw TeX temporarily.
6330 % One exception: @ is still an escape character, so that @end tex works.
6331 % But \@ or @@ will get a plain @ character.
6334 \setupmarkupstyle{tex
}%
6335 \catcode `\\=
0 \catcode `\
{=
1 \catcode `\
}=
2
6336 \catcode `\$=
3 \catcode `\&=
4 \catcode `\#=
6
6337 \catcode `\^=
7 \catcode `
\_=
8 \catcode `\~=
\active \let~=
\tie
6348 % ' is active in math mode (mathcode"8000). So reset it, and all our
6349 % other math active characters (just in case), to plain's definitions.
6352 % Inverse of the list at the beginning of the file.
6354 \let\bullet=
\ptexbullet
6359 \let\equiv=
\ptexequiv
6362 \let\indent=
\ptexindent
6363 \let\noindent=
\ptexnoindent
6370 %\let\sup=\ptexsup % do not redefine, we want @sup to work in math mode
6372 \expandafter \let\csname top
\endcsname=
\ptextop % we've made it outer
6373 \let\frenchspacing=
\plainfrenchspacing
6375 \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
6376 \def\enddots{\relax\ifmmode\endldots\else$
\mathsurround=
0pt
\endldots\,$
\fi}%
6379 % There is no need to define \Etex.
6381 % Define @lisp ... @end lisp.
6382 % @lisp environment forms a group so it can rebind things,
6383 % including the definition of @end lisp (which normally is erroneous).
6385 % Amount to narrow the margins by for @lisp.
6386 \newskip\lispnarrowing \lispnarrowing=
0.4in
6388 % This is the definition that ^^M gets inside @lisp, @example, and other
6389 % such environments. \null is better than a space, since it doesn't
6391 \def\lisppar{\null\endgraf}
6393 % This space is always present above and below environments.
6394 \newskip\envskipamount \envskipamount =
0pt
6396 % Make spacing and below environment symmetrical. We use \parskip here
6397 % to help in doing that, since in @example-like environments \parskip
6398 % is reset to zero; thus the \afterenvbreak inserts no space -- but the
6399 % start of the next paragraph will insert \parskip.
6401 \def\aboveenvbreak{{%
6402 % =10000 instead of <10000 because of a special case in \itemzzz and
6403 % \sectionheading, q.v.
6404 \ifnum \lastpenalty=
10000 \else
6405 \advance\envskipamount by
\parskip
6407 \ifdim\lastskip<
\envskipamount
6409 % it's not a good place to break if the last penalty was \nobreak
6411 \ifnum\lastpenalty<
10000 \penalty-
50 \fi
6412 \vskip\envskipamount
6417 \let\afterenvbreak =
\aboveenvbreak
6419 % \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
6420 % also clear it, so that its embedded environments do the narrowing again.
6421 \let\nonarrowing=
\relax
6423 % @cartouche ... @end cartouche: draw rectangle w/rounded corners around
6424 % environment contents.
6425 \font\circle=lcircle10
6427 \newdimen\cartouter\newdimen\cartinner
6428 \newskip\normbskip\newskip\normpskip\newskip\normlskip
6429 \circthick=
\fontdimen8\circle
6431 \def\ctl{{\circle\char'
013\hskip -
6pt
}}% 6pt from pl file: 1/2charwidth
6432 \def\ctr{{\hskip 6pt
\circle\char'
010}}
6433 \def\cbl{{\circle\char'
012\hskip -
6pt
}}
6434 \def\cbr{{\hskip 6pt
\circle\char'
011}}
6435 \def\carttop{\hbox to
\cartouter{\hskip\lskip
6436 \ctl\leaders\hrule height
\circthick\hfil\ctr
6438 \def\cartbot{\hbox to
\cartouter{\hskip\lskip
6439 \cbl\leaders\hrule height
\circthick\hfil\cbr
6442 \newskip\lskip\newskip\rskip
6445 \ifhmode\par\fi % can't be in the midst of a paragraph.
6447 \lskip=
\leftskip \rskip=
\rightskip
6448 \leftskip=
0pt
\rightskip=
0pt
% we want these *outside*.
6449 \cartinner=
\hsize \advance\cartinner by-
\lskip
6450 \advance\cartinner by-
\rskip
6452 \advance\cartouter by
18.4pt
% allow for 3pt kerns on either
6453 % side, and for 6pt waste from
6454 % each corner char, and rule thickness
6455 \normbskip=
\baselineskip \normpskip=
\parskip \normlskip=
\lineskip
6457 % If this cartouche directly follows a sectioning command, we need the
6458 % \parskip glue (backspaced over by default) or the cartouche can
6459 % collide with the section heading.
6460 \ifnum\lastpenalty>
10000 \vskip\parskip \penalty\lastpenalty \fi
6463 \baselineskip=
0pt
\parskip=
0pt
\lineskip=
0pt
6471 \baselineskip=
\normbskip
6472 \lineskip=
\normlskip
6475 \comment % For explanation, see the end of def\group.
6490 % This macro is called at the beginning of all the @example variants,
6492 \newdimen\nonfillparindent
6495 \ifdim\hfuzz <
12pt
\hfuzz =
12pt
\fi % Don't be fussy
6496 \sepspaces % Make spaces be word-separators rather than space tokens.
6497 \let\par =
\lisppar % don't ignore blank lines
6498 \obeylines % each line of input is a line of output
6500 % Turn off paragraph indentation but redefine \indent to emulate
6501 % the normal \indent.
6502 \nonfillparindent=
\parindent
6504 \let\indent\nonfillindent
6506 \emergencystretch =
0pt
% don't try to avoid overfull boxes
6507 \ifx\nonarrowing\relax
6508 \advance \leftskip by
\lispnarrowing
6509 \exdentamount=
\lispnarrowing
6511 \let\nonarrowing =
\relax
6513 \let\exdent=
\nofillexdent
6518 % We want to swallow spaces (but not other tokens) after the fake
6519 % @indent in our nonfill-environments, where spaces are normally
6520 % active and set to @tie, resulting in them not being ignored after
6522 \gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
6523 \gdef\nonfillindentcheck{%
6525 \expandafter\nonfillindentgobble%
6527 \leavevmode\nonfillindentbox%
6531 \def\nonfillindentgobble#1{\nonfillindent}
6532 \def\nonfillindentbox{\hbox to
\nonfillparindent{\hss}}
6534 % If you want all examples etc. small: @set dispenvsize small.
6535 % If you want even small examples the full size: @set dispenvsize nosmall.
6536 % This affects the following displayed environments:
6537 % @example, @display, @format, @lisp
6539 \def\smallword{small
}
6540 \def\nosmallword{nosmall
}
6541 \let\SETdispenvsize\relax
6542 \def\setnormaldispenv{%
6543 \ifx\SETdispenvsize\smallword
6544 % end paragraph for sake of leading, in case document has no blank
6545 % line. This is redundant with what happens in \aboveenvbreak, but
6546 % we need to do it before changing the fonts, and it's inconvenient
6547 % to change the fonts afterward.
6548 \ifnum \lastpenalty=
10000 \else \endgraf \fi
6549 \smallexamplefonts \rm
6552 \def\setsmalldispenv{%
6553 \ifx\SETdispenvsize\nosmallword
6555 \ifnum \lastpenalty=
10000 \else \endgraf \fi
6556 \smallexamplefonts \rm
6560 % We often define two environments, @foo and @smallfoo.
6561 % Let's do it in one command. #1 is the env name, #2 the definition.
6562 \def\makedispenvdef#1#2{%
6563 \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
6564 \expandafter\envdef\csname small
#1\endcsname {\setsmalldispenv #2}%
6565 \expandafter\let\csname E
#1\endcsname \afterenvbreak
6566 \expandafter\let\csname Esmall
#1\endcsname \afterenvbreak
6569 % Define two environment synonyms (#1 and #2) for an environment.
6570 \def\maketwodispenvdef#1#2#3{%
6571 \makedispenvdef{#1}{#3}%
6572 \makedispenvdef{#2}{#3}%
6575 % @lisp: indented, narrowed, typewriter font;
6576 % @example: same as @lisp.
6578 % @smallexample and @smalllisp: use smaller fonts.
6579 % Originally contributed by Pavel@xerox.
6581 \maketwodispenvdef{lisp
}{example
}{%
6583 \tt\setupmarkupstyle{example
}%
6584 \let\kbdfont =
\kbdexamplefont % Allow @kbd to do something special.
6585 \gobble % eat return
6587 % @display/@smalldisplay: same as @lisp except keep current font.
6589 \makedispenvdef{display
}{%
6594 % @format/@smallformat: same as @display except don't narrow margins.
6596 \makedispenvdef{format
}{%
6597 \let\nonarrowing = t
%
6602 % @flushleft: same as @format, but doesn't obey \SETdispenvsize.
6604 \let\nonarrowing = t
%
6608 \let\Eflushleft =
\afterenvbreak
6612 \envdef\flushright{%
6613 \let\nonarrowing = t
%
6615 \advance\leftskip by
0pt plus
1fill
\relax
6618 \let\Eflushright =
\afterenvbreak
6621 % @raggedright does more-or-less normal line breaking but no right
6622 % justification. From plain.tex. Don't stretch around special
6623 % characters in urls in this environment, since the stretch at the right
6625 \envdef\raggedright{%
6626 \rightskip0pt plus2.4em
\spaceskip.3333em
\xspaceskip.5em
\relax
6627 \def\urefprestretchamount{0pt
}%
6628 \def\urefpoststretchamount{0pt
}%
6630 \let\Eraggedright\par
6632 \envdef\raggedleft{%
6633 \parindent=
0pt
\leftskip0pt plus2em
6634 \spaceskip.3333em
\xspaceskip.5em
\parfillskip=
0pt
6635 \hbadness=
10000 % Last line will usually be underfull, so turn off
6636 % badness reporting.
6638 \let\Eraggedleft\par
6640 \envdef\raggedcenter{%
6641 \parindent=
0pt
\rightskip0pt plus1em
\leftskip0pt plus1em
6642 \spaceskip.3333em
\xspaceskip.5em
\parfillskip=
0pt
6643 \hbadness=
10000 % Last line will usually be underfull, so turn off
6644 % badness reporting.
6646 \let\Eraggedcenter\par
6649 % @quotation does normal linebreaking (hence we can't use \nonfillstart)
6650 % and narrows the margins. We keep \parskip nonzero in general, since
6651 % we're doing normal filling. So, when using \aboveenvbreak and
6652 % \afterenvbreak, temporarily make \parskip 0.
6654 \makedispenvdef{quotation
}{\quotationstart}
6656 \def\quotationstart{%
6657 \indentedblockstart % same as \indentedblock, but increase right margin too.
6658 \ifx\nonarrowing\relax
6659 \advance\rightskip by
\lispnarrowing
6661 \parsearg\quotationlabel
6664 % We have retained a nonzero parskip for the environment, since we're
6665 % doing normal filling.
6669 \ifx\quotationauthor\thisisundefined\else
6671 \leftline{\kern 2\leftskip \sl ---
\quotationauthor}%
6673 {\parskip=
0pt
\afterenvbreak}%
6675 \def\Esmallquotation{\Equotation}
6677 % If we're given an argument, typeset it in bold with a colon after.
6678 \def\quotationlabel#1{%
6680 \ifx\temp\empty \else
6685 % @indentedblock is like @quotation, but indents only on the left and
6686 % has no optional argument.
6688 \makedispenvdef{indentedblock
}{\indentedblockstart}
6690 \def\indentedblockstart{%
6691 {\parskip=
0pt
\aboveenvbreak}% because \aboveenvbreak inserts \parskip
6694 % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
6695 \ifx\nonarrowing\relax
6696 \advance\leftskip by
\lispnarrowing
6697 \exdentamount =
\lispnarrowing
6699 \let\nonarrowing =
\relax
6703 % Keep a nonzero parskip for the environment, since we're doing normal filling.
6705 \def\Eindentedblock{%
6707 {\parskip=
0pt
\afterenvbreak}%
6709 \def\Esmallindentedblock{\Eindentedblock}
6712 % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
6713 % If we want to allow any <char> as delimiter,
6714 % we need the curly braces so that makeinfo sees the @verb command, eg:
6715 % `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
6717 % [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
6719 % [Knuth] p.344; only we need to do the other characters Texinfo sets
6720 % active too. Otherwise, they get lost as the first character on a
6723 \do\
\do\\
\do\
{\do\
}\do\$
\do\&
%
6724 \do\#
\do\^
\do\^^K
\do\_\do\^^A
\do\%
\do\~
%
6725 \do\<
\do\>
\do\|
\do\@
\do+
\do\"
%
6726 % Don't do the quotes -- if we do, @set txicodequoteundirected and
6727 % @set txicodequotebacktick will not have effect on @verb and
6728 % @verbatim, and ?` and !` ligatures won't get disabled.
6733 \def\uncatcodespecials{%
6734 \def\do#
#1{\catcode`#
#1=
\other}\dospecials}
6736 % Setup for the @verb command.
6738 % Eight spaces for a tab
6740 \catcode`\^^I=
\active
6741 \gdef\tabeightspaces{\catcode`\^^I=
\active\def^^I
{\ \ \ \ \ \ \ \
}}
6745 \tt % easiest (and conventionally used) font for verbatim
6746 \def\par{\leavevmode\endgraf}%
6747 \setupmarkupstyle{verb
}%
6749 % Respect line breaks,
6750 % print special symbols as themselves, and
6751 % make each space count
6752 % must do in this order:
6753 \obeylines \uncatcodespecials \sepspaces
6756 % Setup for the @verbatim environment
6758 % Real tab expansion.
6759 \newdimen\tabw \setbox0=
\hbox{\tt\space} \tabw=
8\wd0 % tab amount
6761 % We typeset each line of the verbatim in an \hbox, so we can handle
6762 % tabs. The \global is in case the verbatim line starts with an accent,
6763 % or some other command that starts with a begin-group. Otherwise, the
6764 % entire \verbbox would disappear at the corresponding end-group, before
6765 % it is typeset. Meanwhile, we can't have nested verbatim commands
6766 % (can we?), so the \global won't be overwriting itself.
6768 \def\starttabbox{\global\setbox\verbbox=
\hbox\bgroup}
6771 \catcode`\^^I=
\active
6773 \catcode`\^^I=
\active
6774 \def^^I
{\leavevmode\egroup
6775 \dimen\verbbox=
\wd\verbbox % the width so far, or since the previous tab
6776 \divide\dimen\verbbox by
\tabw
6777 \multiply\dimen\verbbox by
\tabw % compute previous multiple of \tabw
6778 \advance\dimen\verbbox by
\tabw % advance to next multiple of \tabw
6779 \wd\verbbox=
\dimen\verbbox \box\verbbox \starttabbox
6784 % start the verbatim environment.
6785 \def\setupverbatim{%
6786 \let\nonarrowing = t
%
6788 \tt % easiest (and conventionally used) font for verbatim
6789 % The \leavevmode here is for blank lines. Otherwise, we would
6790 % never \starttabox and the \egroup would end verbatim mode.
6791 \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
6793 \setupmarkupstyle{verbatim
}%
6794 % Respect line breaks,
6795 % print special symbols as themselves, and
6796 % make each space count.
6797 % Must do in this order:
6798 \obeylines \uncatcodespecials \sepspaces
6799 \everypar{\starttabbox}%
6802 % Do the @verb magic: verbatim text is quoted by unique
6803 % delimiter characters. Before first delimiter expect a
6804 % right brace, after last delimiter expect closing brace:
6806 % \def\doverb'{'<char>#1<char>'}'{#1}
6808 % [Knuth] p. 382; only eat outer {}
6810 \catcode`
[=
1\catcode`
]=
2\catcode`\
{=
\other\catcode`\
}=
\other
6811 \gdef\doverb{#1[\def\next#
#1#1}[#
#1\endgroup]\next]
6814 \def\verb{\begingroup\setupverb\doverb}
6817 % Do the @verbatim magic: define the macro \doverbatim so that
6818 % the (first) argument ends when '@end verbatim' is reached, ie:
6820 % \def\doverbatim#1@end verbatim{#1}
6822 % For Texinfo it's a lot easier than for LaTeX,
6823 % because texinfo's \verbatim doesn't stop at '\end{verbatim}':
6824 % we need not redefine '\', '{' and '}'.
6826 % Inspired by LaTeX's verbatim command set [latex.ltx]
6831 % ignore everything up to the first ^^M, that's the newline at the end
6832 % of the @verbatim input line itself. Otherwise we get an extra blank
6833 % line in the output.
6834 \xdef\doverbatim#1^^M
#2@end verbatim
{#2\noexpand\end\gobble verbatim
}%
6835 % We really want {...\end verbatim} in the body of the macro, but
6836 % without the active space; thus we have to use \xdef and \gobble.
6840 \setupverbatim\doverbatim
6842 \let\Everbatim =
\afterenvbreak
6845 % @verbatiminclude FILE - insert text of file in verbatim environment.
6847 \def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
6849 \def\doverbatiminclude#1{%
6851 \makevalueexpandable
6853 \indexnofonts % Allow `@@' and other weird things in file names.
6854 \wlog{texinfo.tex: doing @verbatiminclude of
#1^^J
}%
6860 % @copying ... @end copying.
6861 % Save the text away for @insertcopying later.
6863 % We save the uninterpreted tokens, rather than creating a box.
6864 % Saving the text in a box would be much easier, but then all the
6865 % typesetting commands (@smallbook, font changes, etc.) have to be done
6866 % beforehand -- and a) we want @copying to be done first in the source
6867 % file; b) letting users define the frontmatter in as flexible order as
6868 % possible is very desirable.
6870 \def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
6871 \def\docopying#1@end copying
{\endgroup\def\copyingtext{#1}}
6873 \def\insertcopying{%
6875 \parindent =
0pt
% paragraph indentation looks wrong on title page
6876 \scanexp\copyingtext
6884 \newskip\defbodyindent \defbodyindent=
.4in
6885 \newskip\defargsindent \defargsindent=
50pt
6886 \newskip\deflastargmargin \deflastargmargin=
18pt
6887 \newcount\defunpenalty
6889 % Start the processing of @deffn:
6891 \ifnum\lastpenalty<
10000
6893 \defunpenalty=
10003 % Will keep this @deffn together with the
6894 % following @def command, see below.
6896 % If there are two @def commands in a row, we'll have a \nobreak,
6897 % which is there to keep the function description together with its
6898 % header. But if there's nothing but headers, we need to allow a
6899 % break somewhere. Check specifically for penalty 10002, inserted
6900 % by \printdefunline, instead of 10000, since the sectioning
6901 % commands also insert a nobreak penalty, and we don't want to allow
6902 % a break between a section heading and a defun.
6904 % As a further refinement, we avoid "club" headers by signalling
6905 % with penalty of 10003 after the very first @deffn in the
6906 % sequence (see above), and penalty of 10002 after any following
6908 \ifnum\lastpenalty=
10002 \penalty2000 \else \defunpenalty=
10002 \fi
6910 % Similarly, after a section heading, do not allow a break.
6911 % But do insert the glue.
6912 \medskip % preceded by discardable penalty, so not a breakpoint
6916 \advance\leftskip by
\defbodyindent
6917 \exdentamount=
\defbodyindent
6921 % First, check whether we are in the right environment:
6924 % As above, allow line break if we have multiple x headers in a row.
6925 % It's not a great place, though.
6926 \ifnum\lastpenalty=
10002 \penalty3000 \else \defunpenalty=
10002 \fi
6928 % And now, it's time to reuse the body of the original defun:
6929 \expandafter\gobbledefun#1%
6931 \def\gobbledefun#1\startdefun{}
6933 % \printdefunline \deffnheader{text}
6935 \def\printdefunline#1#2{%
6937 % call \deffnheader:
6940 \interlinepenalty =
10000
6941 \advance\rightskip by
0pt plus
1fil
\relax
6943 \nobreak\vskip -
\parskip
6944 \penalty\defunpenalty % signal to \startdefun and \dodefunx
6945 % Some of the @defun-type tags do not enable magic parentheses,
6946 % rendering the following check redundant. But we don't optimize.
6951 \def\Edefun{\endgraf\medbreak}
6953 % \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
6954 % the only thing remaining is to define \deffnheader.
6957 \expandafter\let\csname E
#1\endcsname =
\Edefun
6958 \edef\temp{\noexpand\domakedefun
6959 \makecsname{#1}\makecsname{#1x
}\makecsname{#1header
}}%
6963 % \domakedefun \deffn \deffnx \deffnheader
6965 % Define \deffn and \deffnx, without parameters.
6966 % \deffnheader has to be defined explicitly.
6968 \def\domakedefun#1#2#3{%
6971 \doingtypefnfalse % distinguish typed functions from all else
6972 \parseargusing\activeparens{\printdefunline#3}%
6974 \def#2{\dodefunx#1}%
6978 \newif\ifdoingtypefn % doing typed function?
6979 \newif\ifrettypeownline % typeset return type on its own line?
6981 % @deftypefnnewline on|off says whether the return type of typed functions
6982 % are printed on their own line. This affects @deftypefn, @deftypefun,
6983 % @deftypeop, and @deftypemethod.
6985 \parseargdef\deftypefnnewline{%
6988 \expandafter\let\csname SETtxideftypefnnl
\endcsname
6990 \else\ifx\temp\offword
6991 \expandafter\let\csname SETtxideftypefnnl
\endcsname
6994 \errhelp =
\EMsimple
6995 \errmessage{Unknown @txideftypefnnl value `
\temp',
7000 % Untyped functions:
7002 % @deffn category name args
7003 \makedefun{deffn
}{\deffngeneral{}}
7005 % @deffn category class name args
7006 \makedefun{defop
}#1 {\defopon{#1\
\putwordon}}
7008 % \defopon {category on}class name args
7009 \def\defopon#1#2 {\deffngeneral{\putwordon\
\code{#2}}{#1\
\code{#2}} }
7011 % \deffngeneral {subind}category name args
7013 \def\deffngeneral#1#2 #3 #4\endheader{%
7014 % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}.
7015 \dosubind{fn
}{\code{#3}}{#1}%
7016 \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
7021 % @deftypefn category type name args
7022 \makedefun{deftypefn
}{\deftypefngeneral{}}
7024 % @deftypeop category class type name args
7025 \makedefun{deftypeop
}#1 {\deftypeopon{#1\
\putwordon}}
7027 % \deftypeopon {category on}class type name args
7028 \def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\
\code{#2}}{#1\
\code{#2}} }
7030 % \deftypefngeneral {subind}category type name args
7032 \def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
7033 \dosubind{fn
}{\code{#4}}{#1}%
7035 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7040 % @deftypevr category type var args
7041 \makedefun{deftypevr
}{\deftypecvgeneral{}}
7043 % @deftypecv category class type var args
7044 \makedefun{deftypecv
}#1 {\deftypecvof{#1\
\putwordof}}
7046 % \deftypecvof {category of}class type var args
7047 \def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\
\code{#2}}{#1\
\code{#2}} }
7049 % \deftypecvgeneral {subind}category type var args
7051 \def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
7052 \dosubind{vr
}{\code{#4}}{#1}%
7053 \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
7056 % Untyped variables:
7058 % @defvr category var args
7059 \makedefun{defvr
}#1 {\deftypevrheader{#1} {} }
7061 % @defcv category class var args
7062 \makedefun{defcv
}#1 {\defcvof{#1\
\putwordof}}
7064 % \defcvof {category of}class var args
7065 \def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
7069 % @deftp category name args
7070 \makedefun{deftp
}#1 #2 #3\endheader{%
7071 \doind{tp
}{\code{#2}}%
7072 \defname{#1}{}{#2}\defunargs{#3\unskip}%
7075 % Remaining @defun-like shortcuts:
7076 \makedefun{defun
}{\deffnheader{\putwordDeffunc} }
7077 \makedefun{defmac
}{\deffnheader{\putwordDefmac} }
7078 \makedefun{defspec
}{\deffnheader{\putwordDefspec} }
7079 \makedefun{deftypefun
}{\deftypefnheader{\putwordDeffunc} }
7080 \makedefun{defvar
}{\defvrheader{\putwordDefvar} }
7081 \makedefun{defopt
}{\defvrheader{\putwordDefopt} }
7082 \makedefun{deftypevar
}{\deftypevrheader{\putwordDefvar} }
7083 \makedefun{defmethod
}{\defopon\putwordMethodon}
7084 \makedefun{deftypemethod
}{\deftypeopon\putwordMethodon}
7085 \makedefun{defivar
}{\defcvof\putwordInstanceVariableof}
7086 \makedefun{deftypeivar
}{\deftypecvof\putwordInstanceVariableof}
7088 % \defname, which formats the name of the @def (not the args).
7089 % #1 is the category, such as "Function".
7090 % #2 is the return type, if any.
7091 % #3 is the function name.
7093 % We are followed by (but not passed) the arguments, if any.
7095 \def\defname#1#2#3{%
7097 % Get the values of \leftskip and \rightskip as they were outside the @def...
7098 \advance\leftskip by -
\defbodyindent
7100 % Determine if we are typesetting the return type of a typed function
7101 % on a line by itself.
7102 \rettypeownlinefalse
7103 \ifdoingtypefn % doing a typed function specifically?
7104 % then check user option for putting return type on its own line:
7105 \expandafter\ifx\csname SETtxideftypefnnl
\endcsname\relax \else
7110 % How we'll format the category name. Putting it in brackets helps
7111 % distinguish it from the body text that may end up on the next line
7114 \setbox0=
\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
7116 % Figure out line sizes for the paragraph shape. We'll always have at
7120 % The first line needs space for \box0; but if \rightskip is nonzero,
7121 % we need only space for the part of \box0 which exceeds it:
7122 \dimen0=
\hsize \advance\dimen0 by -
\wd0 \advance\dimen0 by
\rightskip
7124 % If doing a return type on its own line, we'll have another line.
7126 \advance\tempnum by
1
7127 \def\maybeshapeline{0in
\hsize}%
7129 \def\maybeshapeline{}%
7132 % The continuations:
7133 \dimen2=
\hsize \advance\dimen2 by -
\defargsindent
7135 % The final paragraph shape:
7136 \parshape \tempnum 0in
\dimen0 \maybeshapeline \defargsindent \dimen2
7138 % Put the category name at the right margin.
7141 \hfil\box0 \kern-
\hsize
7142 % \hsize has to be shortened this way:
7144 % Intentionally do not respect \rightskip, since we need the space.
7147 % Allow all lines to be underfull without complaint:
7148 \tolerance=
10000 \hbadness=
10000
7149 \exdentamount=
\defbodyindent
7151 % defun fonts. We use typewriter by default (used to be bold) because:
7152 % . we're printing identifiers, they should be in tt in principle.
7153 % . in languages with many accents, such as Czech or French, it's
7154 % common to leave accents off identifiers. The result looks ok in
7155 % tt, but exceedingly strange in rm.
7156 % . we don't want -- and --- to be treated as ligatures.
7157 % . this still does not fix the ?` and !` ligatures, but so far no
7158 % one has made identifiers using them :).
7160 \def\temp{#2}% text of the return type
7161 \ifx\temp\empty\else
7162 \tclose{\temp}% typeset the return type
7164 % put return type on its own line; prohibit line break following:
7165 \hfil\vadjust{\nobreak}\break
7167 \space % type on same line, so just followed by a space
7169 \fi % no return type
7170 #3% output function name
7172 {\rm\enskip}% hskip 0.5 em of \tenrm
7175 % arguments will be output next, if any.
7178 % Print arguments in slanted roman (not ttsl), inconsistently with using
7179 % tt for the name. This is because literal text is sometimes needed in
7180 % the argument list (groff manual), and ttsl and tt are not very
7181 % distinguishable. Prevent hyphenation at `-' chars.
7184 % use sl by default (not ttsl),
7186 \df \sl \hyphenchar\font=
0
7188 % On the other hand, if an argument has two dashes (for instance), we
7189 % want a way to get ttsl. We used to recommend @var for that, so
7190 % leave the code in, but it's strange for @var to lead to typewriter.
7191 % Nowadays we recommend @code, since the difference between a ttsl hyphen
7192 % and a tt hyphen is pretty tiny. @code also disables ?` !`.
7193 \def\var#
#1{{\setupmarkupstyle{var
}\ttslanted{#
#1}}}%
7195 \sl\hyphenchar\font=
45
7198 % We want ()&[] to print specially on the defun line.
7201 \catcode`\(=
\active \catcode`\)=
\active
7202 \catcode`\
[=
\active \catcode`\
]=
\active
7206 % Make control sequences which act like normal parenthesis chars.
7207 \let\lparen = (
\let\rparen = )
7209 % Be sure that we always have a definition for `(', etc. For example,
7210 % if the fn name has parens in it, \boldbrax will not be in effect yet,
7211 % so TeX would otherwise complain about undefined control sequence.
7214 \global\let(=
\lparen \global\let)=
\rparen
7215 \global\let[=
\lbrack \global\let]=
\rbrack
7218 \gdef\boldbrax{\let(=
\opnr\let)=
\clnr\let[=
\lbrb\let]=
\rbrb}
7219 \gdef\magicamp{\let&=
\amprm}
7222 \newcount\parencount
7224 % If we encounter &foo, then turn on ()-hacking afterwards
7226 \def\amprm#1 {\ampseentrue{\bf\&
#1 }}
7230 % At the first level, print parens in roman,
7231 % otherwise use the default font.
7232 \ifnum \parencount=
1 \rm \fi
7234 % The \sf parens (in \boldbrax) actually are a little bolder than
7235 % the contained text. This is especially needed for [ and ] .
7239 \def\infirstlevel#1{%
7246 \def\bfafterword#1 {#1 \bf}
7249 \global\advance\parencount by
1
7251 \infirstlevel \bfafterword
7256 \global\advance\parencount by -
1
7259 \newcount\brackcount
7261 \global\advance\brackcount by
1
7266 \global\advance\brackcount by -
1
7269 \def\checkparencounts{%
7270 \ifnum\parencount=
0 \else \badparencount \fi
7271 \ifnum\brackcount=
0 \else \badbrackcount \fi
7273 % these should not use \errmessage; the glibc manual, at least, actually
7274 % has such constructs (when documenting function pointers).
7275 \def\badparencount{%
7276 \message{Warning: unbalanced parentheses in @def...
}%
7277 \global\parencount=
0
7279 \def\badbrackcount{%
7280 \message{Warning: unbalanced square brackets in @def...
}%
7281 \global\brackcount=
0
7288 % To do this right we need a feature of e-TeX, \scantokens,
7289 % which we arrange to emulate with a temporary file in ordinary TeX.
7290 \ifx\eTeXversion\thisisundefined
7291 \newwrite\macscribble
7294 \immediate\openout\macscribble=
\jobname.tmp
7295 \immediate\write\macscribble{\the\toks0}%
7296 \immediate\closeout\macscribble
7301 \def\scanmacro#1{\begingroup
7303 \let\xeatspaces\eatspaces
7305 % Undo catcode changes of \startcontents and \doprintindex
7306 % When called from @insertcopying or (short)caption, we need active
7307 % backslash to get it printed correctly. Previously, we had
7308 % \catcode`\\=\other instead. We'll see whether a problem appears
7309 % with macro expansion. --kasal, 19aug04
7310 \catcode`\@=
0 \catcode`\\=
\active \escapechar=`\@
7312 % ... and for \example:
7315 % The \empty here causes a following catcode 5 newline to be eaten as
7316 % part of reading whitespace after a control sequence. It does not
7317 % eat a catcode 13 newline. There's no good way to handle the two
7318 % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX
7319 % would then have different behavior). See the Macro Details node in
7320 % the manual for the workaround we recommend for macros and
7321 % line-oriented commands.
7323 \scantokens{#1\empty}%
7327 \edef\temp{\noexpand\scanmacro{#1}}%
7331 \newcount\paramno % Count of parameters
7332 \newtoks\macname % Macro name
7333 \newif\ifrecursive % Is it recursive?
7335 % List of all defined macros in the form
7336 % \definedummyword\macro1\definedummyword\macro2...
7337 % Currently is also contains all @aliases; the list can be split
7338 % if there is a need.
7341 % Add the macro to \macrolist
7342 \def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
7343 \def\addtomacrolistxxx#1{%
7344 \toks0 =
\expandafter{\macrolist\definedummyword#1}%
7345 \xdef\macrolist{\the\toks0}%
7349 % This does \let #1 = #2, with \csnames; that is,
7350 % \let \csname#1\endcsname = \csname#2\endcsname
7351 % (except of course we have to play expansion games).
7355 \csname#1\expandafter\endcsname
7359 % Trim leading and trailing spaces off a string.
7360 % Concepts from aro-bend problem 15 (see CTAN).
7362 \gdef\eatspaces #1{\expandafter\trim@
\expandafter{#1 }}
7363 \gdef\trim@
#1{\trim@@ @
#1 @
#1 @ @@
}
7364 \gdef\trim@@
#1@
#2@
#3@@
{\trim@@@
\empty #2 @
}
7366 \unbrace{\gdef\trim@@@
#1 } #2@
{#1}
7369 % Trim a single trailing ^^M off a string.
7370 {\catcode`\^^M=
\other \catcode`
\Q=
3%
7371 \gdef\eatcr #1{\eatcra #1Q^^MQ
}%
7372 \gdef\eatcra#1^^MQ
{\eatcrb#1Q
}%
7373 \gdef\eatcrb#1Q
#2Q
{#1}%
7376 % Macro bodies are absorbed as an argument in a context where
7377 % all characters are catcode 10, 11 or 12, except \ which is active
7378 % (as in normal texinfo). It is necessary to change the definition of \
7379 % to recognize macro arguments; this is the job of \mbodybackslash.
7381 % Non-ASCII encodings make 8-bit characters active, so un-activate
7382 % them to avoid their expansion. Must do this non-globally, to
7383 % confine the change to the current group.
7385 % It's necessary to have hard CRs when the macro is executed. This is
7386 % done by making ^^M (\endlinechar) catcode 12 when reading the macro
7387 % body, and then making it the \newlinechar in \scanmacro.
7389 \def\scanctxt{% used as subroutine
7399 \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi
7402 \def\scanargctxt{% used for copying and captions, not macros.
7405 \catcode`\^^M=
\other
7408 \def\macrobodyctxt{% used for @macro definitions
7412 \catcode`\^^M=
\other
7416 \def\macroargctxt{% used when scanning invocations
7420 % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes"
7421 % for the single characters \ { }. Thus, we end up with the "commands"
7422 % that would be written @\ @{ @} in a Texinfo document.
7424 % We already have @{ and @}. For @\, we define it here, and only for
7425 % this purpose, to produce a typewriter backslash (so, the @\ that we
7426 % define for @math can't be used with @macro calls):
7428 \def\\
{\normalbackslash}%
7430 % We would like to do this for \, too, since that is what makeinfo does.
7431 % But it is not possible, because Texinfo already has a command @, for a
7432 % cedilla accent. Documents must use @comma{} instead.
7434 % \anythingelse will almost certainly be an error of some kind.
7436 % \mbodybackslash is the definition of \ in @macro bodies.
7437 % It maps \foo\ => \csname macarg.foo\endcsname => #N
7438 % where N is the macro parameter number.
7439 % We define \csname macarg.\endcsname to be \realbackslash, so
7440 % \\ in macro replacement text gets you a backslash.
7442 {\catcode`@=
0 @catcode`@\=@active
7443 @gdef@usembodybackslash
{@let\=@mbodybackslash
}
7444 @gdef@mbodybackslash
#1\
{@csname macarg.
#1@endcsname
}
7446 \expandafter\def\csname macarg.
\endcsname{\realbackslash}
7448 \def\margbackslash#1{\char`\
#1 }
7450 \def\macro{\recursivefalse\parsearg\macroxxx}
7451 \def\rmacro{\recursivetrue\parsearg\macroxxx}
7454 \getargs{#1}% now \macname is the macname and \argl the arglist
7455 \ifx\argl\empty % no arguments
7458 \expandafter\parsemargdef \argl;
%
7459 \if\paramno>
256\relax
7460 \ifx\eTeXversion\thisisundefined
7461 \errhelp =
\EMsimple
7462 \errmessage{You need eTeX to compile a file with macros with more than
256 arguments
}
7466 \if1\csname ismacro.
\the\macname\endcsname
7467 \message{Warning: redefining
\the\macname}%
7469 \expandafter\ifx\csname \the\macname\endcsname \relax
7470 \else \errmessage{Macro name
\the\macname\space already defined
}\fi
7471 \global\cslet{macsave.
\the\macname}{\the\macname}%
7472 \global\expandafter\let\csname ismacro.
\the\macname\endcsname=
1%
7473 \addtomacrolist{\the\macname}%
7475 \begingroup \macrobodyctxt
7476 \ifrecursive \expandafter\parsermacbody
7477 \else \expandafter\parsemacbody
7480 \parseargdef\unmacro{%
7481 \if1\csname ismacro.
#1\endcsname
7482 \global\cslet{#1}{macsave.
#1}%
7483 \global\expandafter\let \csname ismacro.
#1\endcsname=
0%
7484 % Remove the macro name from \macrolist:
7486 \expandafter\let\csname#1\endcsname \relax
7487 \let\definedummyword\unmacrodo
7488 \xdef\macrolist{\macrolist}%
7491 \errmessage{Macro
#1 not defined
}%
7495 % Called by \do from \dounmacro on each macro. The idea is to omit any
7496 % macro definitions that have been changed to \relax.
7502 \noexpand\definedummyword \noexpand#1%
7506 % This makes use of the obscure feature that if the last token of a
7507 % <parameter list> is #, then the preceding argument is delimited by
7508 % an opening brace, and that opening brace is not consumed.
7509 \def\getargs#1{\getargsxxx#1{}}
7510 \def\getargsxxx#1#
{\getmacname #1 \relax\getmacargs}
7511 \def\getmacname#1 #2\relax{\macname=
{#1}}
7512 \def\getmacargs#1{\def\argl{#1}}
7514 % For macro processing make @ a letter so that we can make Texinfo private macro names.
7515 \edef\texiatcatcode{\the\catcode`\@
}
7516 \catcode `@=
11\relax
7518 % Parse the optional {params} list. Set up \paramno and \paramlist
7519 % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH
7520 % in the params list to some hook where the argument is to be expanded. If
7521 % there are less than 10 arguments that hook is to be replaced by ##N where N
7522 % is the position in that list, that is to say the macro arguments are to be
7523 % defined `a la TeX in the macro body.
7525 % That gets used by \mbodybackslash (above).
7527 % We need to get `macro parameter char #' into several definitions.
7528 % The technique used is stolen from LaTeX: let \hash be something
7529 % unexpandable, insert that wherever you need a #, and then redefine
7530 % it to # just before using the token list produced.
7532 % The same technique is used to protect \eatspaces till just before
7533 % the macro is used.
7535 % If there are 10 or more arguments, a different technique is used, where the
7536 % hook remains in the body, and when macro is to be expanded the body is
7537 % processed again to replace the arguments.
7539 % In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
7540 % argument N value and then \edef the body (nothing else will expand because of
7541 % the catcode regime underwhich the body was input).
7543 % If you compile with TeX (not eTeX), and you have macros with 10 or more
7544 % arguments, no macro can have more than 256 arguments (else error).
7545 \def\parsemargdef#1;
{%
7546 \paramno=
0\def\paramlist{}%
7548 \let\xeatspaces\relax
7549 \parsemargdefxxx#1,;,
%
7550 % In case that there are 10 or more arguments we parse again the arguments
7551 % list to set new definitions for the \macarg.BLAH macros corresponding to
7552 % each BLAH argument. It was anyhow needed to parse already once this list
7553 % in order to count the arguments, and as macros with at most 9 arguments
7554 % are by far more frequent than macro with 10 or more arguments, defining
7555 % twice the \macarg.BLAH macros does not cost too much processing power.
7556 \ifnum\paramno<
10\relax\else
7558 \parsemmanyargdef@@
#1,;,
% 10 or more arguments
7561 \def\parsemargdefxxx#1,
{%
7562 \if#1;
\let\next=
\relax
7563 \else \let\next=
\parsemargdefxxx
7564 \advance\paramno by
1
7565 \expandafter\edef\csname macarg.
\eatspaces{#1}\endcsname
7566 {\xeatspaces{\hash\the\paramno}}%
7567 \edef\paramlist{\paramlist\hash\the\paramno,
}%
7570 \def\parsemmanyargdef@@
#1,
{%
7571 \if#1;
\let\next=
\relax
7573 \let\next=
\parsemmanyargdef@@
7574 \edef\tempb{\eatspaces{#1}}%
7575 \expandafter\def\expandafter\tempa
7576 \expandafter{\csname macarg.
\tempb\endcsname}%
7577 % Note that we need some extra \noexpand\noexpand, this is because we
7578 % don't want \the to be expanded in the \parsermacbody as it uses an
7580 \expandafter\edef\tempa
7581 {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
7582 \advance\paramno by
1\relax
7585 % These two commands read recursive and nonrecursive macro bodies.
7586 % (They're different since rec and nonrec macros end differently.)
7589 \catcode `\@
\texiatcatcode
7590 \long\def\parsemacbody#1@end macro
%
7591 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7592 \long\def\parsermacbody#1@end rmacro
%
7593 {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}%
7594 \catcode `\@=
11\relax
7599 \long\def\nillm@
{\nil@
}%
7601 % This macro is expanded during the Texinfo macro expansion, not during its
7602 % definition. It gets all the arguments values and assigns them to macros
7605 % #1 is the macro name
7606 % #2 is the list of argument names
7607 % #3 is the list of argument values
7608 \def\getargvals@
#1#2#3{%
7609 \def\macargdeflist@
{}%
7610 \def\saveparamlist@
{#2}% Need to keep a copy for parameter expansion.
7611 \def\paramlist{#2,
\nil@
}%
7615 \def\argvaluelist{#3,
\nil@
}%
7626 \ifx\paramlist\nilm@
7627 % Some sanity check needed here that \argvaluelist is also empty.
7628 \ifx\argvaluelist\nillm@
7630 \errhelp =
\EMsimple
7631 \errmessage{Too many arguments in macro `
\macroname'!
}%
7633 \let\next\macargexpandinbody@
7635 \ifx\argvaluelist\nillm@
7636 % No more arguments values passed to macro. Set remaining named-arg
7638 \let\next\setemptyargvalues@
7640 % pop current arg name into \@tempb
7641 \def\@tempa#
#1{\pop@
{\@tempb
}{\paramlist}#
#1\endargs@
}%
7642 \expandafter\@tempa
\expandafter{\paramlist}%
7643 % pop current argument value into \@tempc
7644 \def\@tempa#
#1{\longpop@
{\@tempc
}{\argvaluelist}#
#1\endargs@
}%
7645 \expandafter\@tempa
\expandafter{\argvaluelist}%
7646 % Here \@tempb is the current arg name and \@tempc is the current arg value.
7647 % First place the new argument macro definition into \@tempd
7648 \expandafter\macname\expandafter{\@tempc
}%
7649 \expandafter\let\csname macarg.\@tempb
\endcsname\relax
7650 \expandafter\def\expandafter\@tempe
\expandafter{%
7651 \csname macarg.\@tempb
\endcsname}%
7652 \edef\@tempd
{\long\def\@tempe
{\the\macname}}%
7653 \push@\@tempd
\macargdeflist@
7654 \let\next\getargvals@@
7661 \expandafter\expandafter\expandafter\def
7662 \expandafter\expandafter\expandafter#2%
7663 \expandafter\expandafter\expandafter{%
7667 % Replace arguments by their values in the macro body, and place the result
7669 \def\macvalstoargs@
{%
7670 % To do this we use the property that token registers that are \the'ed
7671 % within an \edef expand only once. So we are going to place all argument
7672 % values into respective token registers.
7674 % First we save the token context, and initialize argument numbering.
7677 % Then, for each argument number #N, we place the corresponding argument
7678 % value into a new token list register \toks#N
7679 \expandafter\putargsintokens@
\saveparamlist@,;,
%
7680 % Then, we expand the body so that argument are replaced by their
7681 % values. The trick for values not to be expanded themselves is that they
7682 % are within tokens and that tokens expand only once in an \edef .
7683 \edef\@tempc
{\csname mac.
\macroname .body
\endcsname}%
7684 % Now we restore the token stack pointer to free the token list registers
7685 % which we have used, but we make sure that expanded body is saved after
7689 \expandafter\def\expandafter\@tempa
\expandafter{\@tempc
}%
7692 \def\macargexpandinbody@
{%
7693 %% Define the named-macro outside of this group and then close this group.
7697 % First the replace in body the macro arguments by their values, the result
7700 % Then we point at the \norecurse or \gobble (for recursive) macro value
7702 \expandafter\let\expandafter\@tempb
\csname mac.
\macroname .recurse
\endcsname
7703 % Depending on whether it is recursive or not, we need some tailing
7710 % And now we do the real job:
7711 \edef\@tempd
{\noexpand\@tempb
{\macroname}\noexpand\scanmacro{\@tempa
}\@tempc
}%
7715 \def\putargsintokens@
#1,
{%
7716 \if#1;
\let\next\relax
7718 \let\next\putargsintokens@
7719 % First we allocate the new token list register, and give it a temporary
7721 \toksdef\@tempb
\the\paramno
7722 % Then we place the argument value into that token list register.
7723 \expandafter\let\expandafter\@tempa
\csname macarg.
#1\endcsname
7724 \expandafter\@tempb
\expandafter{\@tempa
}%
7725 \advance\paramno by
1\relax
7730 % Save the token stack pointer into macro #1
7731 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi
}}
7732 % Restore the token stack pointer from number in macro #1
7733 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi
#1\relax}
7734 % newtoks that can be used non \outer .
7735 \def\texinonouternewtoks{\alloc@
5\toks \toksdef \@cclvi
}
7737 % Tailing missing arguments are set to empty
7738 \def\setemptyargvalues@
{%
7739 \ifx\paramlist\nilm@
7740 \let\next\macargexpandinbody@
7742 \expandafter\setemptyargvaluesparser@
\paramlist\endargs@
7743 \let\next\setemptyargvalues@
7748 \def\setemptyargvaluesparser@
#1,
#2\endargs@
{%
7749 \expandafter\def\expandafter\@tempa
\expandafter{%
7750 \expandafter\def\csname macarg.
#1\endcsname{}}%
7751 \push@\@tempa
\macargdeflist@
7755 % #1 is the element target macro
7756 % #2 is the list macro
7757 % #3,#4\endargs@ is the list value
7758 \def\pop@
#1#2#3,
#4\endargs@
{%
7762 \long\def\longpop@
#1#2#3,
#4\endargs@
{%
7767 % This defines a Texinfo @macro. There are eight cases: recursive and
7768 % nonrecursive macros of zero, one, up to nine, and many arguments.
7769 % Much magic with \expandafter here.
7770 % \xdef is used so that macro definitions will survive the file
7771 % they're defined in; @include reads the file inside a group.
7774 \let\hash=##
% convert placeholders to macro parameter chars
7778 \expandafter\xdef\csname\the\macname\endcsname{%
7779 \noexpand\scanmacro{\temp}}%
7781 \expandafter\xdef\csname\the\macname\endcsname{%
7782 \bgroup\noexpand\macroargctxt
7783 \noexpand\braceorline
7784 \expandafter\noexpand\csname\the\macname xxx
\endcsname}%
7785 \expandafter\xdef\csname\the\macname xxx
\endcsname#
#1{%
7786 \egroup\noexpand\scanmacro{\temp}}%
7788 \ifnum\paramno<
10\relax % at most 9
7789 \expandafter\xdef\csname\the\macname\endcsname{%
7790 \bgroup\noexpand\macroargctxt
7791 \noexpand\csname\the\macname xx
\endcsname}%
7792 \expandafter\xdef\csname\the\macname xx
\endcsname#
#1{%
7793 \expandafter\noexpand\csname\the\macname xxx
\endcsname #
#1,
}%
7794 \expandafter\expandafter
7796 \expandafter\expandafter
7797 \csname\the\macname xxx
\endcsname
7798 \paramlist{\egroup\noexpand\scanmacro{\temp}}%
7800 \expandafter\xdef\csname\the\macname\endcsname{%
7801 \noexpand\getargvals@
{\the\macname}{\argl}%
7803 \global\expandafter\let\csname mac.
\the\macname .body
\endcsname\temp
7804 \global\expandafter\let\csname mac.
\the\macname .recurse
\endcsname\gobble
7810 \expandafter\xdef\csname\the\macname\endcsname{%
7811 \noexpand\norecurse{\the\macname}%
7812 \noexpand\scanmacro{\temp}\egroup}%
7814 \expandafter\xdef\csname\the\macname\endcsname{%
7815 \bgroup\noexpand\macroargctxt
7816 \noexpand\braceorline
7817 \expandafter\noexpand\csname\the\macname xxx
\endcsname}%
7818 \expandafter\xdef\csname\the\macname xxx
\endcsname#
#1{%
7820 \noexpand\norecurse{\the\macname}%
7821 \noexpand\scanmacro{\temp}\egroup}%
7823 \ifnum\paramno<
10\relax
7824 \expandafter\xdef\csname\the\macname\endcsname{%
7825 \bgroup\noexpand\macroargctxt
7826 \expandafter\noexpand\csname\the\macname xx
\endcsname}%
7827 \expandafter\xdef\csname\the\macname xx
\endcsname#
#1{%
7828 \expandafter\noexpand\csname\the\macname xxx
\endcsname #
#1,
}%
7829 \expandafter\expandafter
7831 \expandafter\expandafter
7832 \csname\the\macname xxx
\endcsname
7835 \noexpand\norecurse{\the\macname}%
7836 \noexpand\scanmacro{\temp}\egroup}%
7838 \expandafter\xdef\csname\the\macname\endcsname{%
7839 \noexpand\getargvals@
{\the\macname}{\argl}%
7841 \global\expandafter\let\csname mac.
\the\macname .body
\endcsname\temp
7842 \global\expandafter\let\csname mac.
\the\macname .recurse
\endcsname\norecurse
7847 \catcode `\@
\texiatcatcode\relax
7849 \def\norecurse#1{\bgroup\cslet{#1}{macsave.
#1}}
7851 % \braceorline decides whether the next nonwhitespace character is a
7852 % {. If so it reads up to the closing }, if not, it reads the whole
7853 % line. Whatever was read is then fed to the next control sequence
7854 % as an argument (by \parsebrace or \parsearg).
7856 \def\braceorline#1{\let\macnamexxx=
#1\futurelet\nchar\braceorlinexxx}
7857 \def\braceorlinexxx{%
7858 \ifx\nchar\bgroup\else
7859 \expandafter\parsearg
7864 % We need some trickery to remove the optional spaces around the equal
7865 % sign. Make them active and then expand them all to nothing.
7867 \def\alias{\parseargusing\obeyspaces\aliasxxx}
7868 \def\aliasxxx #1{\aliasyyy#1\relax}
7869 \def\aliasyyy #1=
#2\relax{%
7871 \expandafter\let\obeyedspace=
\empty
7872 \addtomacrolist{#1}%
7873 \xdef\next{\global\let\makecsname{#1}=
\makecsname{#2}}%
7879 \message{cross references,
}
7882 \newif\ifhavexrefs % True if xref values are known.
7883 \newif\ifwarnedxrefs % True if we warned once that they aren't known.
7885 % @inforef is relatively simple.
7886 \def\inforef #1{\inforefzzz #1,,,,**
}
7887 \def\inforefzzz #1,
#2,
#3,
#4**
{%
7888 \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
7889 node
\samp{\ignorespaces#1{}}}
7891 % @node's only job in TeX is to define \lastnode, which is used in
7892 % cross-references. The @node line might or might not have commas, and
7893 % might or might not have spaces before the first comma, like:
7894 % @node foo , bar , ...
7895 % We don't want such trailing spaces in the node name.
7897 \parseargdef\node{\checkenv{}\donode #1 ,
\finishnodeparse}
7899 % also remove a trailing comma, in case of something like this:
7900 % @node Help-Cross, , , Cross-refs
7901 \def\donode#1 ,
#2\finishnodeparse{\dodonode #1,
\finishnodeparse}
7902 \def\dodonode#1,
#2\finishnodeparse{\gdef\lastnode{#1}}
7905 \let\lastnode=
\empty
7907 % Write a cross-reference definition for the current node. #1 is the
7908 % type (Ynumbered, Yappendix, Ynothing).
7911 \ifx\lastnode\empty\else
7912 \setref{\lastnode}{#1}%
7913 \global\let\lastnode=
\empty
7917 % @anchor{NAME} -- define xref target at arbitrary point.
7919 \newcount\savesfregister
7921 \def\savesf{\relax \ifhmode \savesfregister=
\spacefactor \fi}
7922 \def\restoresf{\relax \ifhmode \spacefactor=
\savesfregister \fi}
7923 \def\anchor#1{\savesf \setref{#1}{Ynothing
}\restoresf \ignorespaces}
7925 % \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
7926 % anchor), which consists of three parts:
7927 % 1) NAME-title - the current sectioning name taken from \lastsection,
7928 % or the anchor name.
7929 % 2) NAME-snt - section number and type, passed as the SNT arg, or
7930 % empty for anchors.
7931 % 3) NAME-pg - the page number.
7933 % This is called from \donoderef, \anchor, and \dofloat. In the case of
7934 % floats, there is an additional part, which is not written here:
7935 % 4) NAME-lof - the text as it should appear in a @listoffloats.
7941 \atdummies % preserve commands, but don't expand them
7942 \edef\writexrdef#
#1#
#2{%
7943 \write\auxfile{@xrdef
{#1-
% #1 of \setref, expanded by the \edef
7944 #
#1}{#
#2}}% these are parameters of \writexrdef
7946 \toks0 =
\expandafter{\lastsection}%
7947 \immediate \writexrdef{title
}{\the\toks0 }%
7948 \immediate \writexrdef{snt
}{\csname #2\endcsname}% \Ynumbered etc.
7949 \safewhatsit{\writexrdef{pg
}{\folio}}% will be written later, at \shipout
7954 % @xrefautosectiontitle on|off says whether @section(ing) names are used
7955 % automatically in xrefs, if the third arg is not explicitly specified.
7956 % This was provided as a "secret" @set xref-automatic-section-title
7957 % variable, now it's official.
7959 \parseargdef\xrefautomaticsectiontitle{%
7962 \expandafter\let\csname SETxref-automatic-section-title
\endcsname
7964 \else\ifx\temp\offword
7965 \expandafter\let\csname SETxref-automatic-section-title
\endcsname
7968 \errhelp =
\EMsimple
7969 \errmessage{Unknown @xrefautomaticsectiontitle value `
\temp',
7975 % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
7976 % the node name, #2 the name of the Info cross-reference, #3 the printed
7977 % node name, #4 the name of the Info file, #5 the name of the printed
7978 % manual. All but the node name can be omitted.
7980 \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,
]}
7981 \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,
]}
7982 \def\ref#1{\xrefX[#1,,,,,,,
]}
7985 \newbox\printedrefnamebox
7986 \newbox\infofilenamebox
7987 \newbox\printedmanualbox
7989 \def\xrefX[#1,
#2,
#3,
#4,
#5,
#6]{\begingroup
7992 % Get args without leading/trailing spaces.
7993 \def\printedrefname{\ignorespaces #3}%
7994 \setbox\printedrefnamebox =
\hbox{\printedrefname\unskip}%
7996 \def\infofilename{\ignorespaces #4}%
7997 \setbox\infofilenamebox =
\hbox{\infofilename\unskip}%
7999 \def\printedmanual{\ignorespaces #5}%
8000 \setbox\printedmanualbox =
\hbox{\printedmanual\unskip}%
8002 % If the printed reference name (arg #3) was not explicitly given in
8003 % the @xref, figure out what we want to use.
8004 \ifdim \wd\printedrefnamebox =
0pt
8005 % No printed node name was explicitly given.
8006 \expandafter\ifx\csname SETxref-automatic-section-title
\endcsname \relax
8007 % Not auto section-title: use node name inside the square brackets.
8008 \def\printedrefname{\ignorespaces #1}%
8010 % Auto section-title: use chapter/section title inside
8011 % the square brackets if we have it.
8012 \ifdim \wd\printedmanualbox >
0pt
8013 % It is in another manual, so we don't have it; use node name.
8014 \def\printedrefname{\ignorespaces #1}%
8017 % We (should) know the real title if we have the xref values.
8018 \def\printedrefname{\refx{#1-title
}{}}%
8020 % Otherwise just copy the Info node name.
8021 \def\printedrefname{\ignorespaces #1}%
8027 % Make link in pdf output.
8031 \makevalueexpandable
8032 % This expands tokens, so do it after making catcode changes, so _
8033 % etc. don't get their TeX definitions. This ignores all spaces in
8034 % #4, including (wrongly) those in the middle of the filename.
8037 % This (wrongly) does not take account of leading or trailing
8038 % spaces in #1, which should be ignored.
8039 \edef\pdfxrefdest{#1}%
8040 \ifx\pdfxrefdest\empty
8041 \def\pdfxrefdest{Top
}% no empty targets
8043 \txiescapepdf\pdfxrefdest % escape PDF special chars
8047 \startlink attr
{/Border
[0 0 0]}%
8048 \ifnum\filenamelength>
0
8049 goto file
{\the\filename.pdf
} name
{\pdfxrefdest}%
8051 goto name
{\pdfmkpgn{\pdfxrefdest}}%
8054 \setcolor{\linkcolor}%
8057 % Float references are printed completely differently: "Figure 1.2"
8058 % instead of "[somenode], p.3". We distinguish them by the
8059 % LABEL-title being set to a magic string.
8061 % Have to otherify everything special to allow the \csname to
8062 % include an _ in the xref name, etc.
8065 \expandafter\global\expandafter\let\expandafter\Xthisreftitle
8066 \csname XR
#1-title
\endcsname
8068 \iffloat\Xthisreftitle
8069 % If the user specified the print name (third arg) to the ref,
8070 % print it instead of our usual "Figure 1.2".
8071 \ifdim\wd\printedrefnamebox =
0pt
8077 % If the user also gave the printed manual name (fifth arg), append
8079 \ifdim \wd\printedmanualbox >
0pt
8080 \space \putwordin{} \cite{\printedmanual}%
8083 % node/anchor (non-float) references.
8085 % If we use \unhbox to print the node names, TeX does not insert
8086 % empty discretionaries after hyphens, which means that it will not
8087 % find a line break at a hyphen in a node names. Since some manuals
8088 % are best written with fairly long node names, containing hyphens,
8089 % this is a loss. Therefore, we give the text of the node name
8090 % again, so it is as if TeX is seeing it for the first time.
8092 \ifdim \wd\printedmanualbox >
0pt
8093 % Cross-manual reference with a printed manual name.
8095 \crossmanualxref{\cite{\printedmanual\unskip}}%
8097 \else\ifdim \wd\infofilenamebox >
0pt
8098 % Cross-manual reference with only an info filename (arg 4), no
8099 % printed manual name (arg 5). This is essentially the same as
8100 % the case above; we output the filename, since we have nothing else.
8102 \crossmanualxref{\code{\infofilename\unskip}}%
8105 % Reference within this manual.
8107 % _ (for example) has to be the character _ for the purposes of the
8108 % control sequence corresponding to the node, but it has to expand
8109 % into the usual \leavevmode...\vrule stuff for purposes of
8110 % printing. So we \turnoffactive for the \refx-snt, back on for the
8111 % printing, back off for the \refx-pg.
8113 % Only output a following space if the -snt ref is nonempty; for
8114 % @unnumbered and @anchor, it won't be.
8115 \setbox2 =
\hbox{\ignorespaces \refx{#1-snt
}{}}%
8116 \ifdim \wd2 >
0pt
\refx{#1-snt
}\space\fi
8118 % output the `[mynode]' via the macro below so it can be overridden.
8119 \xrefprintnodename\printedrefname
8121 % But we always want a comma and a space:
8124 % output the `page 3'.
8125 \turnoffactive \putwordpage\tie\refx{#1-pg
}{}%
8131 % Output a cross-manual xref to #1. Used just above (twice).
8133 % Only include the text "Section ``foo'' in" if the foo is neither
8134 % missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply
8135 % "see The Foo Manual", the idea being to refer to the whole manual.
8137 % But, this being TeX, we can't easily compare our node name against the
8138 % string "Top" while ignoring the possible spaces before and after in
8139 % the input. By adding the arbitrary 7sp below, we make it much less
8140 % likely that a real node name would have the same width as "Top" (e.g.,
8141 % in a monospaced font). Hopefully it will never happen in practice.
8143 % For the same basic reason, we retypeset the "Top" at every
8144 % reference, since the current font is indeterminate.
8146 \def\crossmanualxref#1{%
8147 \setbox\toprefbox =
\hbox{Top
\kern7sp}%
8148 \setbox2 =
\hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
8149 \ifdim \wd2 >
7sp
% nonempty?
8150 \ifdim \wd2 =
\wd\toprefbox \else % same as Top?
8151 \putwordSection{} ``
\printedrefname''
\putwordin{}\space
8157 % This macro is called from \xrefX for the `[nodename]' part of xref
8158 % output. It's a separate macro only so it can be changed more easily,
8159 % since square brackets don't work well in some documents. Particularly
8160 % one that Bob is working on :).
8162 \def\xrefprintnodename#1{[#1]}
8164 % Things referred to by \setref.
8170 \putwordChapter@tie
\the\chapno
8171 \else \ifnum\subsecno=
0
8172 \putwordSection@tie
\the\chapno.
\the\secno
8173 \else \ifnum\subsubsecno=
0
8174 \putwordSection@tie
\the\chapno.
\the\secno.
\the\subsecno
8176 \putwordSection@tie
\the\chapno.
\the\secno.
\the\subsecno.
\the\subsubsecno
8181 \putwordAppendix@tie @char
\the\appendixno{}%
8182 \else \ifnum\subsecno=
0
8183 \putwordSection@tie @char
\the\appendixno.
\the\secno
8184 \else \ifnum\subsubsecno=
0
8185 \putwordSection@tie @char
\the\appendixno.
\the\secno.
\the\subsecno
8188 @char
\the\appendixno.
\the\secno.
\the\subsecno.
\the\subsubsecno
8192 % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME.
8193 % If its value is nonempty, SUFFIX is output afterward.
8199 \expandafter\global\expandafter\let\expandafter\thisrefX
8200 \csname XR
#1\endcsname
8203 % If not defined, say something at least.
8204 \angleleft un\-de\-fined
\angleright
8207 {\toks0 =
{#1}% avoid expansion of possibly-complex value
8208 \message{\linenumber Undefined cross reference `
\the\toks0'.
}}%
8211 \global\warnedxrefstrue
8212 \message{Cross reference values unknown; you must run TeX again.
}%
8217 % It's defined, so just use it.
8220 #2% Output the suffix in any case.
8223 % This is the macro invoked by entries in the aux file. Usually it's
8224 % just a \def (we prepend XR to the control sequence name to avoid
8225 % collisions). But if this is a float type, we have more work to do.
8228 {% The node name might contain 8-bit characters, which in our current
8229 % implementation are changed to commands like @'e. Don't let these
8230 % mess up the control sequence name.
8233 \xdef\safexrefname{#1}%
8236 \expandafter\gdef\csname XR
\safexrefname\endcsname{#2}% remember this xref
8238 % Was that xref control sequence that we just defined for a float?
8239 \expandafter\iffloat\csname XR
\safexrefname\endcsname
8240 % it was a float, and we have the (safe) float type in \iffloattype.
8241 \expandafter\let\expandafter\floatlist
8242 \csname floatlist
\iffloattype\endcsname
8244 % Is this the first time we've seen this float type?
8245 \expandafter\ifx\floatlist\relax
8246 \toks0 =
{\do}% yes, so just \do
8248 % had it before, so preserve previous elements in list.
8249 \toks0 =
\expandafter{\floatlist\do}%
8252 % Remember this xref in the control sequence \floatlistFLOATTYPE,
8253 % for later use in \listoffloats.
8254 \expandafter\xdef\csname floatlist
\iffloattype\endcsname{\the\toks0
8259 % Read the last existing aux file, if any. No error if none exists.
8262 \openin 1 \jobname.aux
8265 \global\havexrefstrue
8270 \def\setupdatafile{%
8271 \catcode`\^^@=
\other
8272 \catcode`\^^A=
\other
8273 \catcode`\^^B=
\other
8274 \catcode`\^^C=
\other
8275 \catcode`\^^D=
\other
8276 \catcode`\^^E=
\other
8277 \catcode`\^^F=
\other
8278 \catcode`\^^G=
\other
8279 \catcode`\^^H=
\other
8280 \catcode`\^^K=
\other
8281 \catcode`\^^L=
\other
8282 \catcode`\^^N=
\other
8283 \catcode`\^^P=
\other
8284 \catcode`\^^Q=
\other
8285 \catcode`\^^R=
\other
8286 \catcode`\^^S=
\other
8287 \catcode`\^^T=
\other
8288 \catcode`\^^U=
\other
8289 \catcode`\^^V=
\other
8290 \catcode`\^^W=
\other
8291 \catcode`\^^X=
\other
8292 \catcode`\^^Z=
\other
8293 \catcode`\^^
[=
\other
8294 \catcode`\^^\=
\other
8295 \catcode`\^^
]=
\other
8296 \catcode`\^^^=
\other
8297 \catcode`\^^_=
\other
8298 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc.
8299 % in xref tags, i.e., node names. But since ^^e4 notation isn't
8300 % supported in the main text, it doesn't seem desirable. Furthermore,
8301 % that is not enough: for node names that actually contain a ^
8302 % character, we would end up writing a line like this: 'xrdef {'hat
8303 % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first
8304 % argument, and \hat is not an expandable control sequence. It could
8305 % all be worked out, but why? Either we support ^^ or we don't.
8307 % The other change necessary for this was to define \auxhat:
8308 % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter
8309 % and then to call \auxhat in \setq.
8313 % Special characters. Should be turned off anyway, but...
8326 \catcode`+=
\other % avoid \+ for paranoia even though we've turned it off
8328 % This is to support \ in node names and titles, since the \
8329 % characters end up in a \csname. It's easier than
8330 % leaving it active and making its active definition an actual \
8331 % character. What I don't understand is why it works in the *value*
8332 % of the xrdef. Seems like it should be a catcode12 \, and that
8333 % should not typeset properly. But it works, so I'm moving on for
8334 % now. --karl, 15jan04.
8337 % Make the characters 128-255 be printing characters.
8341 \catcode\count1=
\other
8342 \advance\count1 by
1
8343 \ifnum \count1<
256 \loop \fi
8347 % @ is our escape character in .aux files, and we need braces.
8353 \def\readdatafile#1{%
8360 \message{insertions,
}
8361 % including footnotes.
8363 \newcount \footnoteno
8365 % The trailing space in the following definition for supereject is
8366 % vital for proper filling; pages come out unaligned when you do a
8367 % pagealignmacro call if that space before the closing brace is
8368 % removed. (Generally, numeric constants should always be followed by a
8369 % space to prevent strange expansion errors.)
8370 \def\supereject{\par\penalty -
20000\footnoteno =
0 }
8372 % @footnotestyle is meaningful for Info output only.
8373 \let\footnotestyle=
\comment
8377 % Auto-number footnotes. Otherwise like plain.
8379 \global\advance\footnoteno by \@ne
8380 \edef\thisfootno{$^
{\the\footnoteno}$
}%
8382 % In case the footnote comes at the end of a sentence, preserve the
8383 % extra spacing after we do the footnote number.
8385 \ifhmode\edef\@sf
{\spacefactor\the\spacefactor}\ptexslash\fi
8387 % Remove inadvertent blank space before typesetting the footnote number.
8393 % Don't bother with the trickery in plain.tex to not require the
8394 % footnote text as a parameter. Our footnotes don't need to be so general.
8396 % Oh yes, they do; otherwise, @ifset (and anything else that uses
8397 % \parseargline) fails inside footnotes because the tokens are fixed when
8398 % the footnote is read. --karl, 16nov96.
8401 \insert\footins\bgroup
8403 % Nested footnotes are not supported in TeX, that would take a lot
8404 % more work. (\startsavinginserts does not suffice.)
8405 \let\footnote=
\errfootnotenest
8407 % We want to typeset this text as a normal paragraph, even if the
8408 % footnote reference occurs in (for example) a display environment.
8409 % So reset some parameters.
8411 \interlinepenalty\interfootnotelinepenalty
8412 \splittopskip\ht\strutbox % top baseline for broken footnotes
8413 \splitmaxdepth\dp\strutbox
8414 \floatingpenalty\@MM
8419 \parindent\defaultparindent
8423 % Because we use hanging indentation in footnotes, a @noindent appears
8424 % to exdent this text, so make it be a no-op. makeinfo does not use
8425 % hanging indentation so @noindent can still be needed within footnote
8426 % text after an @example or the like (not that this is good style).
8427 \let\noindent =
\relax
8429 % Hang the footnote text off the number. Use \everypar in case the
8430 % footnote extends for more than one paragraph.
8431 \everypar =
{\hang}%
8432 \textindent{\thisfootno}%
8434 % Don't crash into the line above the footnote text. Since this
8435 % expands into a box, it must come within the paragraph, lest it
8436 % provide a place where TeX can split the footnote.
8439 % Invoke rest of plain TeX footnote routine.
8440 \futurelet\next\fo@t
8442 }%end \catcode `\@=11
8444 \def\errfootnotenest{%
8446 \errmessage{Nested footnotes not supported in texinfo.tex,
8447 even though they work in makeinfo; sorry
}
8450 \def\errfootnoteheading{%
8452 \errmessage{Footnotes in chapters, sections, etc., are not supported
}
8455 % In case a @footnote appears in a vbox, save the footnote text and create
8456 % the real \insert just after the vbox finished. Otherwise, the insertion
8458 % Similarly, if a @footnote appears inside an alignment, save the footnote
8459 % text to a box and make the \insert when a row of the table is finished.
8460 % And the same can be done for other insert classes. --kasal, 16nov03.
8462 % Replace the \insert primitive by a cheating macro.
8463 % Deeper inside, just make sure that the saved insertions are not spilled
8466 \def\startsavinginserts{%
8467 \ifx \insert\ptexinsert
8468 \let\insert\saveinsert
8470 \let\checkinserts\relax
8474 % This \insert replacement works for both \insert\footins{foo} and
8475 % \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
8478 \edef\next{\noexpand\savetobox \makeSAVEname#1}%
8479 \afterassignment\next
8480 % swallow the left brace
8483 \def\makeSAVEname#1{\makecsname{SAVE
\expandafter\gobble\string#1}}
8484 \def\savetobox#1{\global\setbox#1 =
\vbox\bgroup \unvbox#1}
8486 \def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
8488 \def\placesaveins#1{%
8489 \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
8493 % eat @SAVE -- beware, all of them have catcode \other:
8495 \def\dospecials{\do S
\do A
\do V
\do E
} \uncatcodespecials % ;-)
8496 \gdef\gobblesave @SAVE
{}
8500 \def\newsaveins #1{%
8501 \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
8504 \def\newsaveinsX #1{%
8505 \csname newbox
\endcsname #1%
8506 \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
8511 \let\checkinserts\empty
8516 % @image. We use the macros from epsf.tex to support this.
8517 % If epsf.tex is not installed and @image is used, we complain.
8519 % Check for and read epsf.tex up front. If we read it only at @image
8520 % time, we might be inside a group, and then its definitions would get
8521 % undone and the next image would fail.
8522 \openin 1 = epsf.tex
8524 % Do not bother showing banner with epsf.tex v2.7k (available in
8525 % doc/epsf.tex and on ctan).
8526 \def\epsfannounce{\toks0 =
}%
8531 % We will only complain once about lack of epsf.tex.
8532 \newif\ifwarnednoepsf
8533 \newhelp\noepsfhelp{epsf.tex must be installed for images to
8534 work. It is also included in the Texinfo distribution, or you can get
8535 it from ftp://tug.org/tex/epsf.tex.
}
8538 \ifx\epsfbox\thisisundefined
8539 \ifwarnednoepsf \else
8540 \errhelp =
\noepsfhelp
8541 \errmessage{epsf.tex not found, images will be ignored
}%
8542 \global\warnednoepsftrue
8545 \imagexxx #1,,,,,
\finish
8549 % Arguments to @image:
8550 % #1 is (mandatory) image filename; we tack on .eps extension.
8551 % #2 is (optional) width, #3 is (optional) height.
8552 % #4 is (ignored optional) html alt text.
8553 % #5 is (ignored optional) extension.
8554 % #6 is just the usual extra ignored arg for parsing stuff.
8556 \def\imagexxx#1,
#2,
#3,
#4,
#5,
#6\finish{\begingroup
8557 \catcode`\^^M =
5 % in case we're inside an example
8558 \normalturnoffactive % allow _ et al. in names
8559 % If the image is by itself, center it.
8562 \else \ifx\centersub\centerV
8563 % for @center @image, we need a vbox so we can have our vertical space
8565 \vbox\bgroup % vbox has better behavior than vtop herev
8570 % Usually we'll have text after the image which will insert
8571 % \parskip glue, so insert it here too to equalize the space
8573 \nobreak\vskip\parskip
8577 % Leave vertical mode so that indentation from an enclosing
8578 % environment such as @quotation is respected.
8579 % However, if we're at the top level, we don't want the
8580 % normal paragraph indentation.
8581 % On the other hand, if we are in the case of @center @image, we don't
8582 % want to start a paragraph, which will create a hsize-width box and
8583 % eradicate the centering.
8584 \ifx\centersub\centerV\else \noindent \fi
8588 \dopdfimage{#1}{#2}{#3}%
8590 % \epsfbox itself resets \epsf?size at each figure.
8591 \setbox0 =
\hbox{\ignorespaces #2}\ifdim\wd0 >
0pt
\epsfxsize=
#2\relax \fi
8592 \setbox0 =
\hbox{\ignorespaces #3}\ifdim\wd0 >
0pt
\epsfysize=
#3\relax \fi
8597 \medskip % space after a standalone image
8599 \ifx\centersub\centerV \egroup \fi
8603 % @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
8604 % etc. We don't actually implement floating yet, we always include the
8605 % float "here". But it seemed the best name for the future.
8607 \envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,
\finish}
8609 % There may be a space before second and/or third parameter; delete it.
8610 \def\eatcommaspace#1,
{#1,
}
8612 % #1 is the optional FLOATTYPE, the text label for this float, typically
8613 % "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
8614 % this float will not be numbered and cannot be referred to.
8616 % #2 is the optional xref label. Also must be present for the float to
8619 % #3 is the optional positioning argument; for now, it is ignored. It
8620 % will somehow specify the positions allowed to float to (here, top, bottom).
8622 % We keep a separate counter for each FLOATTYPE, which we reset at each
8623 % chapter-level command.
8624 \let\resetallfloatnos=
\empty
8626 \def\dofloat#1,
#2,
#3,
#4\finish{%
8627 \let\thiscaption=
\empty
8628 \let\thisshortcaption=
\empty
8630 % don't lose footnotes inside @float.
8632 % BEWARE: when the floats start float, we have to issue warning whenever an
8633 % insert appears inside a float which could possibly float. --kasal, 26may04
8637 % We can't be used inside a paragraph.
8642 \def\floatlabel{#2}%
8643 \def\floatloc{#3}% we do nothing with this yet.
8645 \ifx\floattype\empty
8646 \let\safefloattype=
\empty
8649 % the floattype might have accents or other special characters,
8650 % but we need to use it in a control sequence name.
8653 \xdef\safefloattype{\floattype}%
8657 % If label is given but no type, we handle that as the empty type.
8658 \ifx\floatlabel\empty \else
8659 % We want each FLOATTYPE to be numbered separately (Figure 1,
8660 % Table 1, Figure 2, ...). (And if no label, no number.)
8662 \expandafter\getfloatno\csname\safefloattype floatno
\endcsname
8663 \global\advance\floatno by
1
8666 % This magic value for \lastsection is output by \setref as the
8667 % XREFLABEL-title value. \xrefX uses it to distinguish float
8668 % labels (which have a completely different output format) from
8669 % node and anchor labels. And \xrdef uses it to construct the
8672 \edef\lastsection{\floatmagic=
\safefloattype}%
8673 \setref{\floatlabel}{Yfloat
}%
8677 % start with \parskip glue, I guess.
8680 % Don't suppress indentation if a float happens to start a section.
8681 \restorefirstparagraphindent
8684 % we have these possibilities:
8685 % @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
8686 % @float Foo,lbl & no caption: Foo 1.1
8687 % @float Foo & @caption{Cap}: Foo: Cap
8688 % @float Foo & no caption: Foo
8689 % @float ,lbl & Caption{Cap}: 1.1: Cap
8690 % @float ,lbl & no caption: 1.1
8691 % @float & @caption{Cap}: Cap
8692 % @float & no caption:
8695 \let\floatident =
\empty
8697 % In all cases, if we have a float type, it comes first.
8698 \ifx\floattype\empty \else \def\floatident{\floattype}\fi
8700 % If we have an xref label, the number comes next.
8701 \ifx\floatlabel\empty \else
8702 \ifx\floattype\empty \else % if also had float type, need tie first.
8703 \appendtomacro\floatident{\tie}%
8706 \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
8709 % Start the printed caption with what we've constructed in
8710 % \floatident, but keep it separate; we need \floatident again.
8711 \let\captionline =
\floatident
8713 \ifx\thiscaption\empty \else
8714 \ifx\floatident\empty \else
8715 \appendtomacro\captionline{:
}% had ident, so need a colon between
8719 \appendtomacro\captionline{\scanexp\thiscaption}%
8722 % If we have anything to print, print it, with space before.
8723 % Eventually this needs to become an \insert.
8724 \ifx\captionline\empty \else
8728 % Space below caption.
8732 % If have an xref label, write the list of floats info. Do this
8733 % after the caption, to avoid chance of it being a breakpoint.
8734 \ifx\floatlabel\empty \else
8735 % Write the text that goes in the lof to the aux file as
8736 % \floatlabel-lof. Besides \floatident, we include the short
8737 % caption if specified, else the full caption if specified, else nothing.
8741 % since we read the caption text in the macro world, where ^^M
8742 % is turned into a normal character, we have to scan it back, so
8743 % we don't write the literal three characters "^^M" into the aux file.
8745 \xdef\noexpand\gtemp{%
8746 \ifx\thisshortcaption\empty
8753 \immediate\write\auxfile{@xrdef
{\floatlabel-lof
}{\floatident
8754 \ifx\gtemp\empty \else :
\gtemp \fi}}%
8757 \egroup % end of \vtop
8759 % place the captured inserts
8761 % BEWARE: when the floats start floating, we have to issue warning
8762 % whenever an insert appears inside a float which could possibly
8763 % float. --kasal, 26may04
8768 % Append the tokens #2 to the definition of macro #1, not expanding either.
8770 \def\appendtomacro#1#2{%
8771 \expandafter\def\expandafter#1\expandafter{#1#2}%
8774 % @caption, @shortcaption
8776 \def\caption{\docaption\thiscaption}
8777 \def\shortcaption{\docaption\thisshortcaption}
8778 \def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
8779 \def\defcaption#1#2{\egroup \def#1{#2}}
8781 % The parameter is the control sequence identifying the counter we are
8782 % going to use. Create it if it doesn't exist and assign it to \floatno.
8785 % Haven't seen this figure type before.
8786 \csname newcount
\endcsname #1%
8788 % Remember to reset this floatno at the next chap.
8789 \expandafter\gdef\expandafter\resetallfloatnos
8790 \expandafter{\resetallfloatnos #1=
0 }%
8795 % \setref calls this to get the XREFLABEL-snt value. We want an @xref
8796 % to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
8797 % first read the @float command.
8799 \def\Yfloat{\floattype@tie
\chaplevelprefix\the\floatno}%
8801 % Magic string used for the XREFLABEL-title value, so \xrefX can
8802 % distinguish floats from other xref types.
8803 \def\floatmagic{!!float!!
}
8805 % #1 is the control sequence we are passed; we expand into a conditional
8806 % which is true if #1 represents a float ref. That is, the magic
8807 % \lastsection value which we \setref above.
8809 \def\iffloat#1{\expandafter\doiffloat#1==
\finish}
8811 % #1 is (maybe) the \floatmagic string. If so, #2 will be the
8812 % (safe) float type for this float. We set \iffloattype to #2.
8814 \def\doiffloat#1=
#2=
#3\finish{%
8816 \def\iffloattype{#2}%
8817 \ifx\temp\floatmagic
8820 % @listoffloats FLOATTYPE - print a list of floats like a table of contents.
8822 \parseargdef\listoffloats{%
8823 \def\floattype{#1}% floattype
8825 % the floattype might have accents or other special characters,
8826 % but we need to use it in a control sequence name.
8829 \xdef\safefloattype{\floattype}%
8832 % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
8833 \expandafter\ifx\csname floatlist
\safefloattype\endcsname \relax
8835 % if the user said @listoffloats foo but never @float foo.
8836 \message{\linenumber No `
\safefloattype' floats to list.
}%
8840 \leftskip=
\tocindent % indent these entries like a toc
8841 \let\do=
\listoffloatsdo
8842 \csname floatlist
\safefloattype\endcsname
8847 % This is called on each entry in a list of floats. We're passed the
8848 % xref label, in the form LABEL-title, which is how we save it in the
8849 % aux file. We strip off the -title and look up \XRLABEL-lof, which
8850 % has the text we're supposed to typeset here.
8852 % Figures without xref labels will not be included in the list (since
8853 % they won't appear in the aux file).
8855 \def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
8856 \def\listoffloatsdoentry#1-title
\finish{{%
8857 % Can't fully expand XR#1-lof because it can contain anything. Just
8858 % pass the control sequence. On the other hand, XR#1-pg is just the
8859 % page number, and we want to fully expand that so we can get a link
8861 \toksA =
\expandafter{\csname XR
#1-lof
\endcsname}%
8863 % use the same \entry macro we use to generate the TOC and index.
8864 \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR
#1-pg
\endcsname}}%
8869 \message{localization,
}
8871 % For single-language documents, @documentlanguage is usually given very
8872 % early, just after @documentencoding. Single argument is the language
8873 % (de) or locale (de_DE) abbreviation.
8876 \catcode`
\_ =
\active
8878 \parseargdef\documentlanguage{%
8879 \tex % read txi-??.tex file in plain TeX.
8880 % Read the file by the name they passed if it exists.
8881 \let_ =
\normalunderscore % normal _ character for filename test
8882 \openin 1 txi-
#1.tex
8884 \documentlanguagetrywithoutunderscore #1_
\finish
8886 \globaldefs =
1 % everything in the txi-LL files needs to persist
8890 \endgroup % end raw TeX
8893 % If they passed de_DE, and txi-de_DE.tex doesn't exist,
8896 \gdef\documentlanguagetrywithoutunderscore#1_
#2\finish{%
8897 \openin 1 txi-
#1.tex
8899 \errhelp =
\nolanghelp
8900 \errmessage{Cannot read language file txi-
#1.tex
}%
8902 \globaldefs =
1 % everything in the txi-LL files needs to persist
8907 }% end of special _ catcode
8909 \newhelp\nolanghelp{The given language definition file cannot be found or
8910 is empty. Maybe you need to install it? Putting it in the current
8911 directory should work if nowhere else does.
}
8913 % This macro is called from txi-??.tex files; the first argument is the
8914 % \language name to set (without the "\lang@" prefix), the second and
8915 % third args are \{left,right}hyphenmin.
8917 % The language names to pass are determined when the format is built.
8918 % See the etex.log file created at that time, e.g.,
8919 % /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
8921 % With TeX Live 2008, etex now includes hyphenation patterns for all
8922 % available languages. This means we can support hyphenation in
8923 % Texinfo, at least to some extent. (This still doesn't solve the
8924 % accented characters problem.)
8927 \def\txisetlanguage#1#2#3{%
8928 % do not set the language if the name is undefined in the current TeX.
8929 \expandafter\ifx\csname lang@
#1\endcsname \relax
8930 \message{no patterns for
#1}%
8932 \global\language =
\csname lang@
#1\endcsname
8934 % but there is no harm in adjusting the hyphenmin values regardless.
8935 \global\lefthyphenmin =
#2\relax
8936 \global\righthyphenmin =
#3\relax
8939 % Helpers for encodings.
8940 % Set the catcode of characters 128 through 255 to the specified number.
8942 \def\setnonasciicharscatcode#1{%
8944 \loop\ifnum\count255<
256
8945 \global\catcode\count255=
#1\relax
8946 \advance\count255 by
1
8950 \def\setnonasciicharscatcodenonglobal#1{%
8952 \loop\ifnum\count255<
256
8953 \catcode\count255=
#1\relax
8954 \advance\count255 by
1
8959 % @documentencoding sets the definition of non-ASCII characters
8960 % according to the specified encoding.
8962 \parseargdef\documentencoding{%
8963 % Encoding being declared for the document.
8964 \def\declaredencoding{\csname #1.enc
\endcsname}%
8966 % Supported encodings: names converted to tokens in order to be able
8967 % to compare them with \ifx.
8968 \def\ascii{\csname US-ASCII.enc
\endcsname}%
8969 \def\latnine{\csname ISO-
8859-
15.enc
\endcsname}%
8970 \def\latone{\csname ISO-
8859-
1.enc
\endcsname}%
8971 \def\lattwo{\csname ISO-
8859-
2.enc
\endcsname}%
8972 \def\utfeight{\csname UTF-
8.enc
\endcsname}%
8974 \ifx \declaredencoding \ascii
8977 \else \ifx \declaredencoding \lattwo
8978 \setnonasciicharscatcode\active
8981 \else \ifx \declaredencoding \latone
8982 \setnonasciicharscatcode\active
8985 \else \ifx \declaredencoding \latnine
8986 \setnonasciicharscatcode\active
8989 \else \ifx \declaredencoding \utfeight
8990 \setnonasciicharscatcode\active
8991 % since we already invoked \utfeightchardefs at the top level
8992 % (below), do not re-invoke it, then our check for duplicated
8993 % definitions triggers. Making non-ascii chars active is enough.
8996 \message{Ignoring unknown
document encoding:
#1.
}%
9006 % A message to be logged when using a character that isn't available
9007 % the default font encoding (OT1).
9009 \def\missingcharmsg#1{\message{Character missing, sorry:
#1.
}}
9011 % Take account of \c (plain) vs. \, (Texinfo) difference.
9012 \def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,
{#1}\fi}
9014 % First, make active non-ASCII characters in order for them to be
9015 % correctly categorized when TeX reads the replacement text of
9016 % macros containing the character definitions.
9017 \setnonasciicharscatcode\active
9019 % Latin1 (ISO-8859-1) character definitions.
9020 \def\latonechardefs{%
9022 \gdef^^a1
{\exclamdown}
9023 \gdef^^a2
{\missingcharmsg{CENT SIGN
}}
9024 \gdef^^a3
{{\pounds}}
9025 \gdef^^a4
{\missingcharmsg{CURRENCY SIGN
}}
9026 \gdef^^a5
{\missingcharmsg{YEN SIGN
}}
9027 \gdef^^a6
{\missingcharmsg{BROKEN BAR
}}
9030 \gdef^^a9
{\copyright}
9032 \gdef^^ab
{\guillemetleft}
9035 \gdef^^ae
{\registeredsymbol}
9038 \gdef^^b0
{\textdegree}
9045 \gdef^^b7
{\ifmmode\cdot\else $
\cdot$
\fi}
9046 \gdef^^b8
{\cedilla\
}
9049 \gdef^^bb
{\guillemetright}
9050 \gdef^^bc
{$
1\over4$
}
9051 \gdef^^bd
{$
1\over2$
}
9052 \gdef^^be
{$
3\over4$
}
9053 \gdef^^bf
{\questiondown}
9060 \gdef^^c5
{\ringaccent A
}
9062 \gdef^^c7
{\cedilla C
}
9094 \gdef^^e5
{\ringaccent a
}
9096 \gdef^^e7
{\cedilla c
}
9101 \gdef^^ec
{\`
{\dotless i
}}
9102 \gdef^^ed
{\'
{\dotless i
}}
9103 \gdef^^ee
{\^
{\dotless i
}}
9104 \gdef^^ef
{\"
{\dotless i
}}
9124 % Latin9 (ISO-8859-15) encoding character definitions.
9125 \def\latninechardefs{%
9126 % Encoding is almost identical to Latin1.
9139 % Latin2 (ISO-8859-2) character definitions.
9140 \def\lattwochardefs{%
9142 \gdef^^a1
{\ogonek{A
}}
9145 \gdef^^a4
{\missingcharmsg{CURRENCY SIGN
}}
9151 \gdef^^aa
{\cedilla S
}
9156 \gdef^^af
{\dotaccent Z
}
9158 \gdef^^b0
{\textdegree}
9159 \gdef^^b1
{\ogonek{a
}}
9160 \gdef^^b2
{\ogonek{ }}
9166 \gdef^^b8
{\cedilla\
}
9168 \gdef^^ba
{\cedilla s
}
9173 \gdef^^bf
{\dotaccent z
}
9182 \gdef^^c7
{\cedilla C
}
9185 \gdef^^ca
{\ogonek{E
}}
9201 \gdef^^d9
{\ringaccent U
}
9206 \gdef^^de
{\cedilla T
}
9216 \gdef^^e7
{\cedilla c
}
9219 \gdef^^ea
{\ogonek{e
}}
9222 \gdef^^ed
{\'
{\dotless{i
}}}
9223 \gdef^^ee
{\^
{\dotless{i
}}}
9235 \gdef^^f9
{\ringaccent u
}
9240 \gdef^^fe
{\cedilla t
}
9241 \gdef^^ff
{\dotaccent{}}
9244 % UTF-8 character definitions.
9246 % This code to support UTF-8 is based on LaTeX's utf8.def, with some
9247 % changes for Texinfo conventions. It is included here under the GPL by
9248 % permission from Frank Mittelbach and the LaTeX team.
9254 \gdef\UTFviiiTwoOctets#1#2{\expandafter
9255 \UTFviiiDefined\csname u8:
#1\string #2\endcsname}
9257 \gdef\UTFviiiThreeOctets#1#2#3{\expandafter
9258 \UTFviiiDefined\csname u8:
#1\string #2\string #3\endcsname}
9260 \gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
9261 \UTFviiiDefined\csname u8:
#1\string #2\string #3\string #4\endcsname}
9263 \gdef\UTFviiiDefined#1{%
9265 \message{\linenumber Unicode char
\string #1 not defined for Texinfo
}%
9276 \global\catcode\countUTFx\active
9277 \uccode`\~
\countUTFx
9278 \uppercase\expandafter{\UTFviiiTmp}%
9279 \advance\countUTFx by
1
9280 \ifnum\countUTFx <
\countUTFy
9281 \expandafter\UTFviiiLoop
9287 \xdef~
{\noexpand\UTFviiiTwoOctets\string~
}}
9293 \xdef~
{\noexpand\UTFviiiThreeOctets\string~
}}
9299 \xdef~
{\noexpand\UTFviiiFourOctets\string~
}}
9303 \def\globallet{\global\let} % save some \expandafter's below
9305 % @U{xxxx} to produce U+xxxx, if we support it.
9307 \expandafter\ifx\csname uni:
#1\endcsname \relax
9308 \errhelp =
\EMsimple
9309 \errmessage{Unicode character U+
#1 not supported, sorry
}%
9311 \csname uni:
#1\endcsname
9323 \gdef\DeclareUnicodeCharacter#1#2{%
9324 \countUTFz = "
#1\relax
9325 %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}%
9328 \def\UTFviiiTwoOctets#
#1#
#2{%
9329 \csname u8:#
#1\string #
#2\endcsname}%
9330 \def\UTFviiiThreeOctets#
#1#
#2#
#3{%
9331 \csname u8:#
#1\string #
#2\string #
#3\endcsname}%
9332 \def\UTFviiiFourOctets#
#1#
#2#
#3#
#4{%
9333 \csname u8:#
#1\string #
#2\string #
#3\string #
#4\endcsname}%
9334 \expandafter\expandafter\expandafter\expandafter
9335 \expandafter\expandafter\expandafter
9336 \gdef\UTFviiiTmp{#2}%
9338 \expandafter\ifx\csname uni:
#1\endcsname \relax \else
9339 \errmessage{Internal error, already defined:
#1}%
9342 % define an additional control sequence for this code point.
9343 \expandafter\globallet\csname uni:
#1\endcsname \UTFviiiTmp
9346 \gdef\parseXMLCharref{%
9347 \ifnum\countUTFz < "A0
\relax
9348 \errhelp =
\EMsimple
9349 \errmessage{Cannot define Unicode char value <
00A0
}%
9350 \else\ifnum\countUTFz < "
800\relax
9352 \parseUTFviiiB C
\UTFviiiTwoOctets.,
%
9353 \else\ifnum\countUTFz < "
10000\relax
9356 \parseUTFviiiB E
\UTFviiiThreeOctets.
{,;
}%
9361 \parseUTFviiiB F
\UTFviiiFourOctets.
{!,;
}%
9365 \gdef\parseUTFviiiA#1{%
9366 \countUTFx =
\countUTFz
9367 \divide\countUTFz by
64
9368 \countUTFy =
\countUTFz
9369 \multiply\countUTFz by
64
9370 \advance\countUTFx by -
\countUTFz
9371 \advance\countUTFx by
128
9372 \uccode `
#1\countUTFx
9373 \countUTFz =
\countUTFy}
9375 \gdef\parseUTFviiiB#1#2#3#4{%
9376 \advance\countUTFz by "
#10\relax
9377 \uccode `
#3\countUTFz
9378 \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
9381 % https://en.wikipedia.org/wiki/Plane_(Unicode)#Basic_M
9382 % U+0000..U+007F = https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)
9383 % U+0080..U+00FF = https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)
9384 % U+0100..U+017F = https://en.wikipedia.org/wiki/Latin_Extended-A
9385 % U+0180..U+024F = https://en.wikipedia.org/wiki/Latin_Extended-B
9387 % Many of our renditions are less than wonderful, and all the missing
9388 % characters are available somewhere. Loading the necessary fonts
9389 % awaits user request. We can't truly support Unicode without
9390 % reimplementing everything that's been done in LaTeX for many years,
9391 % plus probably using luatex or xetex, and who knows what else.
9392 % We won't be doing that here in this simple file. But we can try to at
9393 % least make most of the characters not bomb out.
9395 \def\utfeightchardefs{%
9396 \DeclareUnicodeCharacter{00A0
}{\tie}
9397 \DeclareUnicodeCharacter{00A1
}{\exclamdown}
9398 \DeclareUnicodeCharacter{00A3
}{\pounds}
9399 \DeclareUnicodeCharacter{00A7
}{\S}
9400 \DeclareUnicodeCharacter{00A8
}{\"
{ }}
9401 \DeclareUnicodeCharacter{00A9
}{\copyright}
9402 \DeclareUnicodeCharacter{00AA
}{\ordf}
9403 \DeclareUnicodeCharacter{00AB
}{\guillemetleft}
9404 \DeclareUnicodeCharacter{00AC
}{\ifmmode\lnot\else $
\lnot$
\fi}
9405 \DeclareUnicodeCharacter{00AD
}{\-
}
9406 \DeclareUnicodeCharacter{00AE
}{\registeredsymbol}
9407 \DeclareUnicodeCharacter{00AF
}{\=
{ }}
9409 \DeclareUnicodeCharacter{00B0
}{\ringaccent{ }}
9410 \DeclareUnicodeCharacter{00B1
}{\ifmmode\pm\else $
\pm$
\fi}
9411 \DeclareUnicodeCharacter{00B2
}{$^
2$
}
9412 \DeclareUnicodeCharacter{00B3
}{$^
3$
}
9413 \DeclareUnicodeCharacter{00B4
}{\'
{ }}
9414 \DeclareUnicodeCharacter{00B5
}{$
\mu$
}
9415 \DeclareUnicodeCharacter{00B6
}{\P}
9416 \DeclareUnicodeCharacter{00B7
}{\ifmmode\cdot\else $
\cdot$
\fi}
9417 \DeclareUnicodeCharacter{00B8
}{\cedilla{ }}
9418 \DeclareUnicodeCharacter{00B9
}{$^
1$
}
9419 \DeclareUnicodeCharacter{00BA
}{\ordm}
9420 \DeclareUnicodeCharacter{00BB
}{\guillemetright}
9421 \DeclareUnicodeCharacter{00BC
}{$
1\over4$
}
9422 \DeclareUnicodeCharacter{00BD
}{$
1\over2$
}
9423 \DeclareUnicodeCharacter{00BE
}{$
3\over4$
}
9424 \DeclareUnicodeCharacter{00BF
}{\questiondown}
9426 \DeclareUnicodeCharacter{00C0
}{\`A
}
9427 \DeclareUnicodeCharacter{00C1
}{\'A
}
9428 \DeclareUnicodeCharacter{00C2
}{\^A
}
9429 \DeclareUnicodeCharacter{00C3
}{\~A
}
9430 \DeclareUnicodeCharacter{00C4
}{\"A
}
9431 \DeclareUnicodeCharacter{00C5
}{\AA}
9432 \DeclareUnicodeCharacter{00C6
}{\AE}
9433 \DeclareUnicodeCharacter{00C7
}{\cedilla{C
}}
9434 \DeclareUnicodeCharacter{00C8
}{\`E
}
9435 \DeclareUnicodeCharacter{00C9
}{\'E
}
9436 \DeclareUnicodeCharacter{00CA
}{\^E
}
9437 \DeclareUnicodeCharacter{00CB
}{\"E
}
9438 \DeclareUnicodeCharacter{00CC
}{\`I
}
9439 \DeclareUnicodeCharacter{00CD
}{\'I
}
9440 \DeclareUnicodeCharacter{00CE
}{\^I
}
9441 \DeclareUnicodeCharacter{00CF
}{\"I
}
9443 \DeclareUnicodeCharacter{00D0
}{\DH}
9444 \DeclareUnicodeCharacter{00D1
}{\~N
}
9445 \DeclareUnicodeCharacter{00D2
}{\`O
}
9446 \DeclareUnicodeCharacter{00D3
}{\'O
}
9447 \DeclareUnicodeCharacter{00D4
}{\^O
}
9448 \DeclareUnicodeCharacter{00D5
}{\~O
}
9449 \DeclareUnicodeCharacter{00D6
}{\"O
}
9450 \DeclareUnicodeCharacter{00D7
}{\ifmmode\times\else $
\times$
\fi}
9451 \DeclareUnicodeCharacter{00D8
}{\O}
9452 \DeclareUnicodeCharacter{00D9
}{\`U
}
9453 \DeclareUnicodeCharacter{00DA
}{\'U
}
9454 \DeclareUnicodeCharacter{00DB
}{\^U
}
9455 \DeclareUnicodeCharacter{00DC
}{\"U
}
9456 \DeclareUnicodeCharacter{00DD
}{\'Y
}
9457 \DeclareUnicodeCharacter{00DE
}{\TH}
9458 \DeclareUnicodeCharacter{00DF
}{\ss}
9460 \DeclareUnicodeCharacter{00E0
}{\`a
}
9461 \DeclareUnicodeCharacter{00E1
}{\'a
}
9462 \DeclareUnicodeCharacter{00E2
}{\^a
}
9463 \DeclareUnicodeCharacter{00E3
}{\~a
}
9464 \DeclareUnicodeCharacter{00E4
}{\"a
}
9465 \DeclareUnicodeCharacter{00E5
}{\aa}
9466 \DeclareUnicodeCharacter{00E6
}{\ae}
9467 \DeclareUnicodeCharacter{00E7
}{\cedilla{c
}}
9468 \DeclareUnicodeCharacter{00E8
}{\`e
}
9469 \DeclareUnicodeCharacter{00E9
}{\'e
}
9470 \DeclareUnicodeCharacter{00EA
}{\^e
}
9471 \DeclareUnicodeCharacter{00EB
}{\"e
}
9472 \DeclareUnicodeCharacter{00EC
}{\`
{\dotless{i
}}}
9473 \DeclareUnicodeCharacter{00ED
}{\'
{\dotless{i
}}}
9474 \DeclareUnicodeCharacter{00EE
}{\^
{\dotless{i
}}}
9475 \DeclareUnicodeCharacter{00EF
}{\"
{\dotless{i
}}}
9477 \DeclareUnicodeCharacter{00F0
}{\dh}
9478 \DeclareUnicodeCharacter{00F1
}{\~n
}
9479 \DeclareUnicodeCharacter{00F2
}{\`o
}
9480 \DeclareUnicodeCharacter{00F3
}{\'o
}
9481 \DeclareUnicodeCharacter{00F4
}{\^o
}
9482 \DeclareUnicodeCharacter{00F5
}{\~o
}
9483 \DeclareUnicodeCharacter{00F6
}{\"o
}
9484 \DeclareUnicodeCharacter{00F7
}{\ifmmode\div\else $
\div$
\fi}
9485 \DeclareUnicodeCharacter{00F8
}{\o}
9486 \DeclareUnicodeCharacter{00F9
}{\`u
}
9487 \DeclareUnicodeCharacter{00FA
}{\'u
}
9488 \DeclareUnicodeCharacter{00FB
}{\^u
}
9489 \DeclareUnicodeCharacter{00FC
}{\"u
}
9490 \DeclareUnicodeCharacter{00FD
}{\'y
}
9491 \DeclareUnicodeCharacter{00FE
}{\th}
9492 \DeclareUnicodeCharacter{00FF
}{\"y
}
9494 \DeclareUnicodeCharacter{0100}{\=A
}
9495 \DeclareUnicodeCharacter{0101}{\=a
}
9496 \DeclareUnicodeCharacter{0102}{\u{A
}}
9497 \DeclareUnicodeCharacter{0103}{\u{a
}}
9498 \DeclareUnicodeCharacter{0104}{\ogonek{A
}}
9499 \DeclareUnicodeCharacter{0105}{\ogonek{a
}}
9500 \DeclareUnicodeCharacter{0106}{\'C
}
9501 \DeclareUnicodeCharacter{0107}{\'c
}
9502 \DeclareUnicodeCharacter{0108}{\^C
}
9503 \DeclareUnicodeCharacter{0109}{\^c
}
9504 \DeclareUnicodeCharacter{010A
}{\dotaccent{C
}}
9505 \DeclareUnicodeCharacter{010B
}{\dotaccent{c
}}
9506 \DeclareUnicodeCharacter{010C
}{\v{C
}}
9507 \DeclareUnicodeCharacter{010D
}{\v{c
}}
9508 \DeclareUnicodeCharacter{010E
}{\v{D
}}
9509 \DeclareUnicodeCharacter{010F
}{d'
}
9511 \DeclareUnicodeCharacter{0110}{\DH}
9512 \DeclareUnicodeCharacter{0111}{\dh}
9513 \DeclareUnicodeCharacter{0112}{\=E
}
9514 \DeclareUnicodeCharacter{0113}{\=e
}
9515 \DeclareUnicodeCharacter{0114}{\u{E
}}
9516 \DeclareUnicodeCharacter{0115}{\u{e
}}
9517 \DeclareUnicodeCharacter{0116}{\dotaccent{E
}}
9518 \DeclareUnicodeCharacter{0117}{\dotaccent{e
}}
9519 \DeclareUnicodeCharacter{0118}{\ogonek{E
}}
9520 \DeclareUnicodeCharacter{0119}{\ogonek{e
}}
9521 \DeclareUnicodeCharacter{011A
}{\v{E
}}
9522 \DeclareUnicodeCharacter{011B
}{\v{e
}}
9523 \DeclareUnicodeCharacter{011C
}{\^G
}
9524 \DeclareUnicodeCharacter{011D
}{\^g
}
9525 \DeclareUnicodeCharacter{011E
}{\u{G
}}
9526 \DeclareUnicodeCharacter{011F
}{\u{g
}}
9528 \DeclareUnicodeCharacter{0120}{\dotaccent{G
}}
9529 \DeclareUnicodeCharacter{0121}{\dotaccent{g
}}
9530 \DeclareUnicodeCharacter{0122}{\cedilla{G
}}
9531 \DeclareUnicodeCharacter{0123}{\cedilla{g
}}
9532 \DeclareUnicodeCharacter{0124}{\^H
}
9533 \DeclareUnicodeCharacter{0125}{\^h
}
9534 \DeclareUnicodeCharacter{0126}{\missingcharmsg{H WITH STROKE
}}
9535 \DeclareUnicodeCharacter{0127}{\missingcharmsg{h WITH STROKE
}}
9536 \DeclareUnicodeCharacter{0128}{\~I
}
9537 \DeclareUnicodeCharacter{0129}{\~
{\dotless{i
}}}
9538 \DeclareUnicodeCharacter{012A
}{\=I
}
9539 \DeclareUnicodeCharacter{012B
}{\=
{\dotless{i
}}}
9540 \DeclareUnicodeCharacter{012C
}{\u{I
}}
9541 \DeclareUnicodeCharacter{012D
}{\u{\dotless{i
}}}
9542 \DeclareUnicodeCharacter{012E
}{\ogonek{I
}}
9543 \DeclareUnicodeCharacter{012F
}{\ogonek{i
}}
9545 \DeclareUnicodeCharacter{0130}{\dotaccent{I
}}
9546 \DeclareUnicodeCharacter{0131}{\dotless{i
}}
9547 \DeclareUnicodeCharacter{0132}{IJ
}
9548 \DeclareUnicodeCharacter{0133}{ij
}
9549 \DeclareUnicodeCharacter{0134}{\^J
}
9550 \DeclareUnicodeCharacter{0135}{\^
{\dotless{j
}}}
9551 \DeclareUnicodeCharacter{0136}{\cedilla{K
}}
9552 \DeclareUnicodeCharacter{0137}{\cedilla{k
}}
9553 \DeclareUnicodeCharacter{0138}{\ifmmode\kappa\else $
\kappa$
\fi}
9554 \DeclareUnicodeCharacter{0139}{\'L
}
9555 \DeclareUnicodeCharacter{013A
}{\'l
}
9556 \DeclareUnicodeCharacter{013B
}{\cedilla{L
}}
9557 \DeclareUnicodeCharacter{013C
}{\cedilla{l
}}
9558 \DeclareUnicodeCharacter{013D
}{L'
}% should kern
9559 \DeclareUnicodeCharacter{013E
}{l'
}% should kern
9560 \DeclareUnicodeCharacter{013F
}{L
\U{00B7
}}
9562 \DeclareUnicodeCharacter{0140}{l
\U{00B7
}}
9563 \DeclareUnicodeCharacter{0141}{\L}
9564 \DeclareUnicodeCharacter{0142}{\l}
9565 \DeclareUnicodeCharacter{0143}{\'N
}
9566 \DeclareUnicodeCharacter{0144}{\'n
}
9567 \DeclareUnicodeCharacter{0145}{\cedilla{N
}}
9568 \DeclareUnicodeCharacter{0146}{\cedilla{n
}}
9569 \DeclareUnicodeCharacter{0147}{\v{N
}}
9570 \DeclareUnicodeCharacter{0148}{\v{n
}}
9571 \DeclareUnicodeCharacter{0149}{'n
}
9572 \DeclareUnicodeCharacter{014A
}{\missingcharmsg{ENG
}}
9573 \DeclareUnicodeCharacter{014B
}{\missingcharmsg{eng
}}
9574 \DeclareUnicodeCharacter{014C
}{\=O
}
9575 \DeclareUnicodeCharacter{014D
}{\=o
}
9576 \DeclareUnicodeCharacter{014E
}{\u{O
}}
9577 \DeclareUnicodeCharacter{014F
}{\u{o
}}
9579 \DeclareUnicodeCharacter{0150}{\H{O
}}
9580 \DeclareUnicodeCharacter{0151}{\H{o
}}
9581 \DeclareUnicodeCharacter{0152}{\OE}
9582 \DeclareUnicodeCharacter{0153}{\oe}
9583 \DeclareUnicodeCharacter{0154}{\'R
}
9584 \DeclareUnicodeCharacter{0155}{\'r
}
9585 \DeclareUnicodeCharacter{0156}{\cedilla{R
}}
9586 \DeclareUnicodeCharacter{0157}{\cedilla{r
}}
9587 \DeclareUnicodeCharacter{0158}{\v{R
}}
9588 \DeclareUnicodeCharacter{0159}{\v{r
}}
9589 \DeclareUnicodeCharacter{015A
}{\'S
}
9590 \DeclareUnicodeCharacter{015B
}{\'s
}
9591 \DeclareUnicodeCharacter{015C
}{\^S
}
9592 \DeclareUnicodeCharacter{015D
}{\^s
}
9593 \DeclareUnicodeCharacter{015E
}{\cedilla{S
}}
9594 \DeclareUnicodeCharacter{015F
}{\cedilla{s
}}
9596 \DeclareUnicodeCharacter{0160}{\v{S
}}
9597 \DeclareUnicodeCharacter{0161}{\v{s
}}
9598 \DeclareUnicodeCharacter{0162}{\cedilla{T
}}
9599 \DeclareUnicodeCharacter{0163}{\cedilla{t
}}
9600 \DeclareUnicodeCharacter{0164}{\v{T
}}
9601 \DeclareUnicodeCharacter{0165}{\v{t
}}
9602 \DeclareUnicodeCharacter{0166}{\missingcharmsg{H WITH STROKE
}}
9603 \DeclareUnicodeCharacter{0167}{\missingcharmsg{h WITH STROKE
}}
9604 \DeclareUnicodeCharacter{0168}{\~U
}
9605 \DeclareUnicodeCharacter{0169}{\~u
}
9606 \DeclareUnicodeCharacter{016A
}{\=U
}
9607 \DeclareUnicodeCharacter{016B
}{\=u
}
9608 \DeclareUnicodeCharacter{016C
}{\u{U
}}
9609 \DeclareUnicodeCharacter{016D
}{\u{u
}}
9610 \DeclareUnicodeCharacter{016E
}{\ringaccent{U
}}
9611 \DeclareUnicodeCharacter{016F
}{\ringaccent{u
}}
9613 \DeclareUnicodeCharacter{0170}{\H{U
}}
9614 \DeclareUnicodeCharacter{0171}{\H{u
}}
9615 \DeclareUnicodeCharacter{0172}{\ogonek{U
}}
9616 \DeclareUnicodeCharacter{0173}{\ogonek{u
}}
9617 \DeclareUnicodeCharacter{0174}{\^W
}
9618 \DeclareUnicodeCharacter{0175}{\^w
}
9619 \DeclareUnicodeCharacter{0176}{\^Y
}
9620 \DeclareUnicodeCharacter{0177}{\^y
}
9621 \DeclareUnicodeCharacter{0178}{\"Y
}
9622 \DeclareUnicodeCharacter{0179}{\'Z
}
9623 \DeclareUnicodeCharacter{017A
}{\'z
}
9624 \DeclareUnicodeCharacter{017B
}{\dotaccent{Z
}}
9625 \DeclareUnicodeCharacter{017C
}{\dotaccent{z
}}
9626 \DeclareUnicodeCharacter{017D
}{\v{Z
}}
9627 \DeclareUnicodeCharacter{017E
}{\v{z
}}
9628 \DeclareUnicodeCharacter{017F
}{\missingcharmsg{LONG S
}}
9630 \DeclareUnicodeCharacter{01C4
}{D
\v{Z
}}
9631 \DeclareUnicodeCharacter{01C5
}{D
\v{z
}}
9632 \DeclareUnicodeCharacter{01C6
}{d
\v{z
}}
9633 \DeclareUnicodeCharacter{01C7
}{LJ
}
9634 \DeclareUnicodeCharacter{01C8
}{Lj
}
9635 \DeclareUnicodeCharacter{01C9
}{lj
}
9636 \DeclareUnicodeCharacter{01CA
}{NJ
}
9637 \DeclareUnicodeCharacter{01CB
}{Nj
}
9638 \DeclareUnicodeCharacter{01CC
}{nj
}
9639 \DeclareUnicodeCharacter{01CD
}{\v{A
}}
9640 \DeclareUnicodeCharacter{01CE
}{\v{a
}}
9641 \DeclareUnicodeCharacter{01CF
}{\v{I
}}
9643 \DeclareUnicodeCharacter{01D0
}{\v{\dotless{i
}}}
9644 \DeclareUnicodeCharacter{01D1
}{\v{O
}}
9645 \DeclareUnicodeCharacter{01D2
}{\v{o
}}
9646 \DeclareUnicodeCharacter{01D3
}{\v{U
}}
9647 \DeclareUnicodeCharacter{01D4
}{\v{u
}}
9649 \DeclareUnicodeCharacter{01E2
}{\=
{\AE}}
9650 \DeclareUnicodeCharacter{01E3
}{\=
{\ae}}
9651 \DeclareUnicodeCharacter{01E6
}{\v{G
}}
9652 \DeclareUnicodeCharacter{01E7
}{\v{g
}}
9653 \DeclareUnicodeCharacter{01E8
}{\v{K
}}
9654 \DeclareUnicodeCharacter{01E9
}{\v{k
}}
9656 \DeclareUnicodeCharacter{01F0
}{\v{\dotless{j
}}}
9657 \DeclareUnicodeCharacter{01F1
}{DZ
}
9658 \DeclareUnicodeCharacter{01F2
}{Dz
}
9659 \DeclareUnicodeCharacter{01F3
}{dz
}
9660 \DeclareUnicodeCharacter{01F4
}{\'G
}
9661 \DeclareUnicodeCharacter{01F5
}{\'g
}
9662 \DeclareUnicodeCharacter{01F8
}{\`N
}
9663 \DeclareUnicodeCharacter{01F9
}{\`n
}
9664 \DeclareUnicodeCharacter{01FC
}{\'
{\AE}}
9665 \DeclareUnicodeCharacter{01FD
}{\'
{\ae}}
9666 \DeclareUnicodeCharacter{01FE
}{\'
{\O}}
9667 \DeclareUnicodeCharacter{01FF
}{\'
{\o}}
9669 \DeclareUnicodeCharacter{021E
}{\v{H
}}
9670 \DeclareUnicodeCharacter{021F
}{\v{h
}}
9672 \DeclareUnicodeCharacter{0226}{\dotaccent{A
}}
9673 \DeclareUnicodeCharacter{0227}{\dotaccent{a
}}
9674 \DeclareUnicodeCharacter{0228}{\cedilla{E
}}
9675 \DeclareUnicodeCharacter{0229}{\cedilla{e
}}
9676 \DeclareUnicodeCharacter{022E
}{\dotaccent{O
}}
9677 \DeclareUnicodeCharacter{022F
}{\dotaccent{o
}}
9679 \DeclareUnicodeCharacter{0232}{\=Y
}
9680 \DeclareUnicodeCharacter{0233}{\=y
}
9681 \DeclareUnicodeCharacter{0237}{\dotless{j
}}
9683 \DeclareUnicodeCharacter{02DB
}{\ogonek{ }}
9685 \DeclareUnicodeCharacter{1E02
}{\dotaccent{B
}}
9686 \DeclareUnicodeCharacter{1E03
}{\dotaccent{b
}}
9687 \DeclareUnicodeCharacter{1E04
}{\udotaccent{B
}}
9688 \DeclareUnicodeCharacter{1E05
}{\udotaccent{b
}}
9689 \DeclareUnicodeCharacter{1E06
}{\ubaraccent{B
}}
9690 \DeclareUnicodeCharacter{1E07
}{\ubaraccent{b
}}
9691 \DeclareUnicodeCharacter{1E0A
}{\dotaccent{D
}}
9692 \DeclareUnicodeCharacter{1E0B
}{\dotaccent{d
}}
9693 \DeclareUnicodeCharacter{1E0C
}{\udotaccent{D
}}
9694 \DeclareUnicodeCharacter{1E0D
}{\udotaccent{d
}}
9695 \DeclareUnicodeCharacter{1E0E
}{\ubaraccent{D
}}
9696 \DeclareUnicodeCharacter{1E0F
}{\ubaraccent{d
}}
9698 \DeclareUnicodeCharacter{1E1E
}{\dotaccent{F
}}
9699 \DeclareUnicodeCharacter{1E1F
}{\dotaccent{f
}}
9701 \DeclareUnicodeCharacter{1E20
}{\=G
}
9702 \DeclareUnicodeCharacter{1E21
}{\=g
}
9703 \DeclareUnicodeCharacter{1E22
}{\dotaccent{H
}}
9704 \DeclareUnicodeCharacter{1E23
}{\dotaccent{h
}}
9705 \DeclareUnicodeCharacter{1E24
}{\udotaccent{H
}}
9706 \DeclareUnicodeCharacter{1E25
}{\udotaccent{h
}}
9707 \DeclareUnicodeCharacter{1E26
}{\"H
}
9708 \DeclareUnicodeCharacter{1E27
}{\"h
}
9710 \DeclareUnicodeCharacter{1E30
}{\'K
}
9711 \DeclareUnicodeCharacter{1E31
}{\'k
}
9712 \DeclareUnicodeCharacter{1E32
}{\udotaccent{K
}}
9713 \DeclareUnicodeCharacter{1E33
}{\udotaccent{k
}}
9714 \DeclareUnicodeCharacter{1E34
}{\ubaraccent{K
}}
9715 \DeclareUnicodeCharacter{1E35
}{\ubaraccent{k
}}
9716 \DeclareUnicodeCharacter{1E36
}{\udotaccent{L
}}
9717 \DeclareUnicodeCharacter{1E37
}{\udotaccent{l
}}
9718 \DeclareUnicodeCharacter{1E3A
}{\ubaraccent{L
}}
9719 \DeclareUnicodeCharacter{1E3B
}{\ubaraccent{l
}}
9720 \DeclareUnicodeCharacter{1E3E
}{\'M
}
9721 \DeclareUnicodeCharacter{1E3F
}{\'m
}
9723 \DeclareUnicodeCharacter{1E40
}{\dotaccent{M
}}
9724 \DeclareUnicodeCharacter{1E41
}{\dotaccent{m
}}
9725 \DeclareUnicodeCharacter{1E42
}{\udotaccent{M
}}
9726 \DeclareUnicodeCharacter{1E43
}{\udotaccent{m
}}
9727 \DeclareUnicodeCharacter{1E44
}{\dotaccent{N
}}
9728 \DeclareUnicodeCharacter{1E45
}{\dotaccent{n
}}
9729 \DeclareUnicodeCharacter{1E46
}{\udotaccent{N
}}
9730 \DeclareUnicodeCharacter{1E47
}{\udotaccent{n
}}
9731 \DeclareUnicodeCharacter{1E48
}{\ubaraccent{N
}}
9732 \DeclareUnicodeCharacter{1E49
}{\ubaraccent{n
}}
9734 \DeclareUnicodeCharacter{1E54
}{\'P
}
9735 \DeclareUnicodeCharacter{1E55
}{\'p
}
9736 \DeclareUnicodeCharacter{1E56
}{\dotaccent{P
}}
9737 \DeclareUnicodeCharacter{1E57
}{\dotaccent{p
}}
9738 \DeclareUnicodeCharacter{1E58
}{\dotaccent{R
}}
9739 \DeclareUnicodeCharacter{1E59
}{\dotaccent{r
}}
9740 \DeclareUnicodeCharacter{1E5A
}{\udotaccent{R
}}
9741 \DeclareUnicodeCharacter{1E5B
}{\udotaccent{r
}}
9742 \DeclareUnicodeCharacter{1E5E
}{\ubaraccent{R
}}
9743 \DeclareUnicodeCharacter{1E5F
}{\ubaraccent{r
}}
9745 \DeclareUnicodeCharacter{1E60
}{\dotaccent{S
}}
9746 \DeclareUnicodeCharacter{1E61
}{\dotaccent{s
}}
9747 \DeclareUnicodeCharacter{1E62
}{\udotaccent{S
}}
9748 \DeclareUnicodeCharacter{1E63
}{\udotaccent{s
}}
9749 \DeclareUnicodeCharacter{1E6A
}{\dotaccent{T
}}
9750 \DeclareUnicodeCharacter{1E6B
}{\dotaccent{t
}}
9751 \DeclareUnicodeCharacter{1E6C
}{\udotaccent{T
}}
9752 \DeclareUnicodeCharacter{1E6D
}{\udotaccent{t
}}
9753 \DeclareUnicodeCharacter{1E6E
}{\ubaraccent{T
}}
9754 \DeclareUnicodeCharacter{1E6F
}{\ubaraccent{t
}}
9756 \DeclareUnicodeCharacter{1E7C
}{\~V
}
9757 \DeclareUnicodeCharacter{1E7D
}{\~v
}
9758 \DeclareUnicodeCharacter{1E7E
}{\udotaccent{V
}}
9759 \DeclareUnicodeCharacter{1E7F
}{\udotaccent{v
}}
9761 \DeclareUnicodeCharacter{1E80
}{\`W
}
9762 \DeclareUnicodeCharacter{1E81
}{\`w
}
9763 \DeclareUnicodeCharacter{1E82
}{\'W
}
9764 \DeclareUnicodeCharacter{1E83
}{\'w
}
9765 \DeclareUnicodeCharacter{1E84
}{\"W
}
9766 \DeclareUnicodeCharacter{1E85
}{\"w
}
9767 \DeclareUnicodeCharacter{1E86
}{\dotaccent{W
}}
9768 \DeclareUnicodeCharacter{1E87
}{\dotaccent{w
}}
9769 \DeclareUnicodeCharacter{1E88
}{\udotaccent{W
}}
9770 \DeclareUnicodeCharacter{1E89
}{\udotaccent{w
}}
9771 \DeclareUnicodeCharacter{1E8A
}{\dotaccent{X
}}
9772 \DeclareUnicodeCharacter{1E8B
}{\dotaccent{x
}}
9773 \DeclareUnicodeCharacter{1E8C
}{\"X
}
9774 \DeclareUnicodeCharacter{1E8D
}{\"x
}
9775 \DeclareUnicodeCharacter{1E8E
}{\dotaccent{Y
}}
9776 \DeclareUnicodeCharacter{1E8F
}{\dotaccent{y
}}
9778 \DeclareUnicodeCharacter{1E90
}{\^Z
}
9779 \DeclareUnicodeCharacter{1E91
}{\^z
}
9780 \DeclareUnicodeCharacter{1E92
}{\udotaccent{Z
}}
9781 \DeclareUnicodeCharacter{1E93
}{\udotaccent{z
}}
9782 \DeclareUnicodeCharacter{1E94
}{\ubaraccent{Z
}}
9783 \DeclareUnicodeCharacter{1E95
}{\ubaraccent{z
}}
9784 \DeclareUnicodeCharacter{1E96
}{\ubaraccent{h
}}
9785 \DeclareUnicodeCharacter{1E97
}{\"t
}
9786 \DeclareUnicodeCharacter{1E98
}{\ringaccent{w
}}
9787 \DeclareUnicodeCharacter{1E99
}{\ringaccent{y
}}
9789 \DeclareUnicodeCharacter{1EA0
}{\udotaccent{A
}}
9790 \DeclareUnicodeCharacter{1EA1
}{\udotaccent{a
}}
9792 \DeclareUnicodeCharacter{1EB8
}{\udotaccent{E
}}
9793 \DeclareUnicodeCharacter{1EB9
}{\udotaccent{e
}}
9794 \DeclareUnicodeCharacter{1EBC
}{\~E
}
9795 \DeclareUnicodeCharacter{1EBD
}{\~e
}
9797 \DeclareUnicodeCharacter{1ECA
}{\udotaccent{I
}}
9798 \DeclareUnicodeCharacter{1ECB
}{\udotaccent{i
}}
9799 \DeclareUnicodeCharacter{1ECC
}{\udotaccent{O
}}
9800 \DeclareUnicodeCharacter{1ECD
}{\udotaccent{o
}}
9802 \DeclareUnicodeCharacter{1EE4
}{\udotaccent{U
}}
9803 \DeclareUnicodeCharacter{1EE5
}{\udotaccent{u
}}
9805 \DeclareUnicodeCharacter{1EF2
}{\`Y
}
9806 \DeclareUnicodeCharacter{1EF3
}{\`y
}
9807 \DeclareUnicodeCharacter{1EF4
}{\udotaccent{Y
}}
9809 \DeclareUnicodeCharacter{1EF8
}{\~Y
}
9810 \DeclareUnicodeCharacter{1EF9
}{\~y
}
9812 \DeclareUnicodeCharacter{2013}{--
}
9813 \DeclareUnicodeCharacter{2014}{---
}
9814 \DeclareUnicodeCharacter{2018}{\quoteleft}
9815 \DeclareUnicodeCharacter{2019}{\quoteright}
9816 \DeclareUnicodeCharacter{201A
}{\quotesinglbase}
9817 \DeclareUnicodeCharacter{201C
}{\quotedblleft}
9818 \DeclareUnicodeCharacter{201D
}{\quotedblright}
9819 \DeclareUnicodeCharacter{201E
}{\quotedblbase}
9820 \DeclareUnicodeCharacter{2022}{\bullet}
9821 \DeclareUnicodeCharacter{2026}{\dots}
9822 \DeclareUnicodeCharacter{2039}{\guilsinglleft}
9823 \DeclareUnicodeCharacter{203A
}{\guilsinglright}
9824 \DeclareUnicodeCharacter{20AC
}{\euro}
9826 \DeclareUnicodeCharacter{2192}{\expansion}
9827 \DeclareUnicodeCharacter{21D2
}{\result}
9829 \DeclareUnicodeCharacter{2212}{\minus}
9830 \DeclareUnicodeCharacter{2217}{\point}
9831 \DeclareUnicodeCharacter{2261}{\equiv}
9832 }% end of \utfeightchardefs
9835 % US-ASCII character definitions.
9836 \def\asciichardefs{% nothing need be done
9840 % define all the unicode characters we know about, for the sake of @U.
9843 % Make non-ASCII characters printable again for compatibility with
9844 % existing Texinfo documents that may use them, even without declaring a
9845 % document encoding.
9847 \setnonasciicharscatcode \other
9850 \message{formatting,
}
9852 \newdimen\defaultparindent \defaultparindent =
15pt
9854 \chapheadingskip =
15pt plus
4pt minus
2pt
9855 \secheadingskip =
12pt plus
3pt minus
2pt
9856 \subsecheadingskip =
9pt plus
2pt minus
2pt
9858 % Prevent underfull vbox error messages.
9861 % Don't be very finicky about underfull hboxes, either.
9864 % Following George Bush, get rid of widows and orphans.
9868 % Use TeX 3.0's \emergencystretch to help line breaking, but if we're
9869 % using an old version of TeX, don't do anything. We want the amount of
9870 % stretch added to depend on the line length, hence the dependence on
9871 % \hsize. We call this whenever the paper size is set.
9873 \def\setemergencystretch{%
9874 \ifx\emergencystretch\thisisundefined
9875 % Allow us to assign to \emergencystretch anyway.
9876 \def\emergencystretch{\dimen0}%
9878 \emergencystretch =
.15\hsize
9882 % Parameters in order: 1) textheight; 2) textwidth;
9883 % 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
9884 % 7) physical page height; 8) physical page width.
9886 % We also call \setleading{\textleading}, so the caller should define
9887 % \textleading. The caller should also set \parskip.
9889 \def\internalpagesizes#1#2#3#4#5#6#7#8{%
9892 \splittopskip =
\topskip
9895 \advance\vsize by
\topskip
9896 \outervsize =
\vsize
9897 \advance\outervsize by
2\topandbottommargin
9898 \pageheight =
\vsize
9901 \outerhsize =
\hsize
9902 \advance\outerhsize by
0.5in
9905 \normaloffset =
#4\relax
9906 \bindingoffset =
#5\relax
9909 \pdfpageheight #7\relax
9910 \pdfpagewidth #8\relax
9911 % if we don't reset these, they will remain at "1 true in" of
9912 % whatever layout pdftex was dumped with.
9913 \pdfhorigin =
1 true in
9914 \pdfvorigin =
1 true in
9917 \setleading{\textleading}
9919 \parindent =
\defaultparindent
9920 \setemergencystretch
9923 % @letterpaper (the default).
9924 \def\letterpaper{{\globaldefs =
1
9925 \parskip =
3pt plus
2pt minus
1pt
9926 \textleading =
13.2pt
9928 % If page is nothing but text, make it come out even.
9929 \internalpagesizes{607.2pt
}{6in
}% that's 46 lines
9931 {\bindingoffset}{36pt
}%
9935 % Use @smallbook to reset parameters for 7x9.25 trim size.
9936 \def\smallbook{{\globaldefs =
1
9937 \parskip =
2pt plus
1pt
9940 \internalpagesizes{7.5in
}{5in
}%
9942 {\bindingoffset}{16pt
}%
9945 \lispnarrowing =
0.3in
9948 \contentsrightmargin =
0pt
9949 \defbodyindent =
.5cm
9952 % Use @smallerbook to reset parameters for 6x9 trim size.
9953 % (Just testing, parameters still in flux.)
9954 \def\smallerbook{{\globaldefs =
1
9955 \parskip =
1.5pt plus
1pt
9958 \internalpagesizes{7.4in
}{4.8in
}%
9963 \lispnarrowing =
0.25in
9966 \contentsrightmargin =
0pt
9967 \defbodyindent =
.4cm
9970 % Use @afourpaper to print on European A4 paper.
9971 \def\afourpaper{{\globaldefs =
1
9972 \parskip =
3pt plus
2pt minus
1pt
9973 \textleading =
13.2pt
9975 % Double-side printing via postscript on Laserjet 4050
9976 % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
9977 % To change the settings for a different printer or situation, adjust
9978 % \normaloffset until the front-side and back-side texts align. Then
9979 % do the same for \bindingoffset. You can set these for testing in
9980 % your texinfo source file like this:
9982 % \global\normaloffset = -6mm
9983 % \global\bindingoffset = 10mm
9985 \internalpagesizes{673.2pt
}{160mm
}% that's 51 lines
9986 {\voffset}{\hoffset}%
9987 {\bindingoffset}{44pt
}%
9992 \contentsrightmargin =
0pt
9993 \defbodyindent =
5mm
9996 % Use @afivepaper to print on European A5 paper.
9997 % From romildo@urano.iceb.ufop.br, 2 July 2000.
9998 % He also recommends making @example and @lisp be small.
9999 \def\afivepaper{{\globaldefs =
1
10000 \parskip =
2pt plus
1pt minus
0.1pt
10001 \textleading =
12.5pt
10003 \internalpagesizes{160mm
}{120mm
}%
10004 {\voffset}{\hoffset}%
10005 {\bindingoffset}{8pt
}%
10008 \lispnarrowing =
0.2in
10011 \contentsrightmargin =
0pt
10012 \defbodyindent =
2mm
10013 \tableindent =
12mm
10016 % A specific text layout, 24x15cm overall, intended for A4 paper.
10017 \def\afourlatex{{\globaldefs =
1
10019 \internalpagesizes{237mm
}{150mm
}%
10021 {\bindingoffset}{7mm
}%
10024 % Must explicitly reset to 0 because we call \afourpaper.
10028 % Use @afourwide to print on A4 paper in landscape format.
10029 \def\afourwide{{\globaldefs =
1
10031 \internalpagesizes{241mm
}{165mm
}%
10032 {\voffset}{-
2.95mm
}%
10033 {\bindingoffset}{7mm
}%
10038 % @pagesizes TEXTHEIGHT[,TEXTWIDTH]
10039 % Perhaps we should allow setting the margins, \topskip, \parskip,
10040 % and/or leading, also. Or perhaps we should compute them somehow.
10042 \parseargdef\pagesizes{\pagesizesyyy #1,,
\finish}
10043 \def\pagesizesyyy#1,
#2,
#3\finish{{%
10044 \setbox0 =
\hbox{\ignorespaces #2}\ifdim\wd0 >
0pt
\hsize=
#2\relax \fi
10047 \parskip =
3pt plus
2pt minus
1pt
10048 \setleading{\textleading}%
10051 \advance\dimen0 by
\voffset
10054 \advance\dimen2 by
\normaloffset
10056 \internalpagesizes{#1}{\hsize}%
10057 {\voffset}{\normaloffset}%
10058 {\bindingoffset}{44pt
}%
10059 {\dimen0}{\dimen2}%
10062 % Set default to letter.
10067 \message{and turning on texinfo input format.
}
10069 \def^^L
{\par} % remove \outer, so ^L can appear in an @comment
10071 % DEL is a comment character, in case @c does not suffice.
10074 % Define macros to output various characters with catcode for normal text.
10075 \catcode`\"=
\other \def\normaldoublequote{"
}
10076 \catcode`\$=
\other \def\normaldollar{$
}%$ font-lock fix
10077 \catcode`\+=
\other \def\normalplus{+
}
10078 \catcode`\<=
\other \def\normalless{<
}
10079 \catcode`\>=
\other \def\normalgreater{>
}
10080 \catcode`\^=
\other \def\normalcaret{^
}
10081 \catcode`
\_=
\other \def\normalunderscore{_
}
10082 \catcode`\|=
\other \def\normalverticalbar{|
}
10083 \catcode`\~=
\other \def\normaltilde{~
}
10085 % This macro is used to make a character print one way in \tt
10086 % (where it can probably be output as-is), and another way in other fonts,
10087 % where something hairier probably needs to be done.
10089 % #1 is what to print if we are indeed using \tt; #2 is what to print
10090 % otherwise. Since all the Computer Modern typewriter fonts have zero
10091 % interword stretch (and shrink), and it is reasonable to expect all
10092 % typewriter fonts to have this, we can check that font parameter.
10094 \def\ifusingtt#1#2{\ifdim \fontdimen3\font=
0pt
#1\else #2\fi}
10096 % Same as above, but check for italic font. Actually this also catches
10097 % non-italic slanted fonts since it is impossible to distinguish them from
10098 % italic fonts. But since this is only used by $ and it uses \sl anyway
10099 % this is not a problem.
10100 \def\ifusingit#1#2{\ifdim \fontdimen1\font>
0pt
#1\else #2\fi}
10102 % Turn off all special characters except @
10103 % (and those which the user can use as if they were ordinary).
10104 % Most of these we simply print from the \tt font, but for some, we can
10105 % use math or other variants that look better in normal text.
10107 \catcode`\"=
\active
10108 \def\activedoublequote{{\tt\char34}}
10109 \let"=
\activedoublequote
10110 \catcode`\~=
\active \def\activetilde{{\tt\char126}} \let~ =
\activetilde
10112 \catcode`\^=
\active \def\activehat{{\tt \hat}} \let^ =
\activehat
10114 \catcode`
\_=
\active
10115 \def_{\ifusingtt\normalunderscore\_}
10117 % Subroutine for the previous macro.
10118 \def\_{\leavevmode \kern.07em
\vbox{\hrule width
.3em height
.1ex
}\kern .07em
}
10120 \catcode`\|=
\active
10121 \def|
{{\tt\char124}}
10124 \catcode`\<=
\active \def\activeless{{\tt \less}}\let< =
\activeless
10126 \catcode`\>=
\active \def\activegtr{{\tt \gtr}}\let> =
\activegtr
10127 \catcode`\+=
\active \def+
{{\tt \char 43}}
10128 \catcode`\$=
\active \def$
{\ifusingit{{\sl\$
}}\normaldollar}%$ font-lock fix
10130 % used for headline/footline in the output routine, in case the page
10131 % breaks in the middle of an @tex block.
10132 \def\texinfochars{%
10133 \let< =
\activeless
10135 \let~ =
\activetilde
10137 \markupsetuplqdefault \markupsetuprqdefault
10139 \let\i =
\smartitalic
10140 % in principle, all other definitions in \tex have to be undone too.
10143 % If a .fmt file is being used, characters that might appear in a file
10144 % name cannot be active until we have parsed the command line.
10145 % So turn them off again, and have \everyjob (or @setfilename) turn them on.
10146 % \otherifyactive is called near the end of this file.
10147 \def\otherifyactive{\catcode`+=
\other \catcode`
\_=
\other}
10149 % Used sometimes to turn off (effectively) the active characters even after
10151 \def\turnoffactive{%
10152 \normalturnoffactive
10158 % \backslashcurfont outputs one backslash character in current font,
10160 \global\chardef\backslashcurfont=`\\
10161 \global\let\rawbackslashxx=
\backslashcurfont % let existing .??s files work
10163 % \realbackslash is an actual character `\' with catcode other, and
10164 % \doublebackslash is two of them (for the pdf outlines).
10165 {\catcode`\\=
\other @gdef@realbackslash
{\
} @gdef@doublebackslash
{\\
}}
10167 % In texinfo, backslash is an active character; it prints the backslash
10168 % in fixed width font.
10169 \catcode`\\=
\active % @ for escape char from now on.
10171 % The story here is that in math mode, the \char of \backslashcurfont
10172 % ends up printing the roman \ from the math symbol font (because \char
10173 % in math mode uses the \mathcode, and plain.tex sets
10174 % \mathcode`\\="026E). It seems better for @backslashchar{} to always
10175 % print a typewriter backslash, hence we use an explicit \mathchar,
10176 % which is the decimal equivalent of "715c (class 7, e.g., use \fam;
10177 % ignored family value; char position "5C). We can't use " for the
10178 % usual hex value because it has already been made active.
10179 @def@normalbackslash
{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi
}}
10180 @let@backslashchar = @normalbackslash
% @backslashchar{} is for user documents.
10182 % On startup, @fixbackslash assigns:
10183 % @let \ = @normalbackslash
10184 % \rawbackslash defines an active \ to do \backslashcurfont.
10185 % \otherbackslash defines an active \ to be a literal `\' character with
10186 % catcode other. We switch back and forth between these.
10187 @gdef@rawbackslash
{@let\=@backslashcurfont
}
10188 @gdef@otherbackslash
{@let\=@realbackslash
}
10190 % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
10191 % the literal character `\'. Also revert - to its normal character, in
10192 % case the active - from code has slipped in.
10194 {@catcode`- = @active
10195 @gdef@normalturnoffactive
{%
10197 @let"=@normaldoublequote
10198 @let$=@normaldollar
%$ font-lock fix
10201 @let>=@normalgreater
10202 @let\=@normalbackslash
10204 @let_=@normalunderscore
10205 @let|=@normalverticalbar
10207 @markupsetuplqdefault
10208 @markupsetuprqdefault
10213 % Make _ and + \other characters, temporarily.
10214 % This is canceled by @fixbackslash.
10217 % If a .fmt file is being used, we don't want the `\input texinfo' to show up.
10218 % That is what \eatinput is for; after that, the `\' should revert to printing
10221 @gdef@eatinput input texinfo
{@fixbackslash
}
10222 @global@let\ = @eatinput
10224 % On the other hand, perhaps the file did not have a `\input texinfo'. Then
10225 % the first `\' in the file would cause an error. This macro tries to fix
10226 % that, assuming it is called before the first `\' could plausibly occur.
10227 % Also turn back on active characters that might appear in the input
10228 % file name, in case not using a pre-dumped format.
10230 @gdef@fixbackslash
{%
10231 @ifx\@eatinput @let\ = @normalbackslash @fi
10233 @catcode`@_=@active
10236 % Say @foo, not \foo, in error messages.
10239 % These (along with & and #) are made active for url-breaking, so need
10240 % active definitions as the normal characters.
10242 @def@normalquest
{?
}
10243 @def@normalslash
{/
}
10245 % These look ok in all fonts, so just make them not special.
10246 % @hashchar{} gets its own user-level command, because of #line.
10247 @catcode`@& = @other @def@normalamp
{&
}
10248 @catcode`@# = @other @def@normalhash
{#
}
10249 @catcode`@
% = @other @def@normalpercent{%}
10251 @let @hashchar = @normalhash
10253 @c Finally, make ` and ' active, so that txicodequoteundirected and
10254 @c txicodequotebacktick work right in, e.g., @w
{@code
{`foo'
}}. If we
10255 @c don't make ` and ' active, @code will not get them as active chars.
10256 @c Do this last of all since we use ` in the previous @catcode assignments.
10257 @catcode`@'=@active
10258 @catcode`@`=@active
10259 @markupsetuplqdefault
10260 @markupsetuprqdefault
10262 @c Local variables:
10263 @c eval: (add-hook 'write-file-hooks 'time-stamp)
10264 @c page-delimiter: "^\\\
\message\\|emacs-page"
10265 @c time-stamp-start: "def\\\
\texinfoversion{"
10266 @c time-stamp-format: "
%:y-%02m-%02d.%02H"
10267 @c time-stamp-end: "
}"
10273 arch-tag: e1b36e32-c96e-4135-a41a-
0b2efa2ea115